core/crypto/hmac package | Odin Programming Language

`HMAC` message authentication code (`MAC`) algorithm. See: - [[ https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.198-1.pdf ]]

Collection Info

View Source

Collection: core
Path: crypto/hmac
Entries: 10

Constants 0

Types 1

Jump to Types

Context

Procedures 9

Jump to Procedures

algorithm clone final init reset sum tag_size update verify

Procedure Groups 0

Variables 0

Source Files

hmac.odin

Types

Context #

Source

Context :: Context

Context is a concrete instantiation of HMAC with a specific hash algorithm.

Procedures

algorithm #

Source

algorithm :: proc(ctx: ^Context) -> Algorithm {…}

algorithm returns the Algorithm used by a Context instance.

clone #

Source

clone :: proc(ctx, other: ^Context) {…}

clone clones the Context other into ctx.

final #

Source

final :: proc(ctx: ^Context, dst: []u8) {…}

final finalizes the Context, writes the tag to dst, and calls reset on the Context.

init #

Source

init :: proc(ctx: ^Context, algorithm: Algorithm, key: []u8) {…}

init initializes a Context with a specific hash Algorithm and key.

reset #

Source

reset :: proc(ctx: ^Context) {…}

reset sanitizes the Context. The Context must be re-initialized to be used again.

sum #

Source

sum :: proc(algorithm: Algorithm, dst, msg, key: []u8) {…}

sum will compute the HMAC with the specified algorithm and key over msg, and write the computed tag to dst. It requires that the dst buffer is the tag size.

tag_size #

Source

tag_size :: proc(ctx: ^Context) -> int {…}

tag_size returns the tag size of a Context instance in bytes.

update #

Source

update :: proc(ctx: ^Context, data: []u8) {…}

update adds more data to the Context.

verify #

Source

verify :: proc(algorithm: Algorithm, tag, msg, key: []u8) -> bool {…}

verify will verify the HMAC tag computed with the specified algorithm and key over msg and return true if and only if (⟺) the tag is valid. It requires that the tag is correctly sized.