package core:crypto/sha3
Source

⌘K
Ctrl+K
or
/

    Overview

    package sha3 implements the SHA3 hash algorithm family.

    The SHAKE XOF can be found in crypto/shake. While discouraged if the pre-standardization Keccak algorithm is required, it can be found in crypto/legacy/keccak.

    See: https://nvlpubs.nist.gov/nistpubs/fips/nist.fips.202.pdf

    Index

    Types (1)
    Variables (0)

    This section is empty.

    Procedure Groups (0)

    This section is empty.

    Types

    Context ¶
    Source

    Context :: struct {
	st:             struct #raw_union {
		b: [200]u8,
		q: [25]u64,
	},
	pt:             int,
	rsiz:           int,
	mdlen:          int,
	dsbyte:         u8,
	is_initialized: bool,
	is_finalized:   bool,
}
     

    Context is a SHA3 instance.

    Related Procedures With Parameters

    Constants

    BLOCK_SIZE_224 ¶
    Source

    BLOCK_SIZE_224 :: _sha3.RATE_224
     

    BLOCK_SIZE_224 is the SHA3-224 block size in bytes.

    BLOCK_SIZE_256 ¶
    Source

    BLOCK_SIZE_256 :: _sha3.RATE_256
     

    BLOCK_SIZE_256 is the SHA3-256 block size in bytes.

    BLOCK_SIZE_384 ¶
    Source

    BLOCK_SIZE_384 :: _sha3.RATE_384
     

    BLOCK_SIZE_384 is the SHA3-384 block size in bytes.

    BLOCK_SIZE_512 ¶
    Source

    BLOCK_SIZE_512 :: _sha3.RATE_512
     

    BLOCK_SIZE_512 is the SHA3-512 block size in bytes.

    DIGEST_SIZE_224 ¶
    Source

    DIGEST_SIZE_224 :: 28
     

    DIGEST_SIZE_224 is the SHA3-224 digest size.

    DIGEST_SIZE_256 ¶
    Source

    DIGEST_SIZE_256 :: 32
     

    DIGEST_SIZE_256 is the SHA3-256 digest size.

    DIGEST_SIZE_384 ¶
    Source

    DIGEST_SIZE_384 :: 48
     

    DIGEST_SIZE_384 is the SHA3-384 digest size.

    DIGEST_SIZE_512 ¶
    Source

    DIGEST_SIZE_512 :: 64
     

    DIGEST_SIZE_512 is the SHA3-512 digest size.

    Variables

    This section is empty.

    Procedures

    clone ¶
    Source

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

    clone clones the Context other into ctx.

    final ¶
    Source

    final :: proc(ctx: ^Context, hash: []u8, finalize_clone: bool = false) {…}
     

    final finalizes the Context, writes the digest to hash, and calls reset on the Context.

    Iff finalize_clone is set, final will work on a copy of the Context, which is useful for for calculating rolling digests.

    init_224 ¶
    Source

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

    init_224 initializes a Context for SHA3-224.

    init_256 ¶
    Source

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

    init_256 initializes a Context for SHA3-256.

    init_384 ¶
    Source

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

    init_384 initializes a Context for SHA3-384.

    init_512 ¶
    Source

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

    init_512 initializes a Context for SHA3-512.

    reset ¶
    Source

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

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

    update ¶
    Source

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

    update adds more data to the Context.

    Procedure Groups

    This section is empty.

    Source Files

    Generation Information

    Generated with odin version dev-2024-12 (vendor "odin") Windows_amd64 @ 2024-12-17 21:11:00.947194700 +0000 UTC