sha3_256.h File Reference

SHA3-256 hash function (SHA-3 with 256-bit output) More...

#include "core/crypto.h"
#include "xof/keccak.h"

Go to the source code of this file.

Macros

#define SHA3_256_BLOCK_SIZE   136
 
#define SHA3_256_DIGEST_SIZE   32
 
#define SHA3_256_OID   sha3_256Oid
 
#define SHA3_256_HASH_ALGO   (&sha3_256HashAlgo)
 

Typedefs

typedef KeccakContext Sha3_256Context
 SHA3-256 algorithm context. More...
 

Functions

error_t sha3_256Compute (const void *data, size_t length, uint8_t *digest)
 Digest a message using SHA3-256. More...
 
void sha3_256Init (Sha3_256Context *context)
 Initialize SHA3-256 message digest context. More...
 
void sha3_256Update (Sha3_256Context *context, const void *data, size_t length)
 Update the SHA3-256 context with a portion of the message being hashed. More...
 
void sha3_256Final (Sha3_256Context *context, uint8_t *digest)
 Finish the SHA3-256 message digest. More...
 

Variables

const uint8_t sha3_256Oid [9]
 
const HashAlgo sha3_256HashAlgo
 

Detailed Description

SHA3-256 hash function (SHA-3 with 256-bit output)

License

Copyright (C) 2010-2018 Oryx Embedded SARL. All rights reserved.

This file is part of CycloneCrypto Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author
Oryx Embedded SARL (www.oryx-embedded.com)
Version
1.9.0

Definition in file sha3_256.h.

Macro Definition Documentation

◆ SHA3_256_BLOCK_SIZE

#define SHA3_256_BLOCK_SIZE   136

Definition at line 37 of file sha3_256.h.

◆ SHA3_256_DIGEST_SIZE

#define SHA3_256_DIGEST_SIZE   32

Definition at line 39 of file sha3_256.h.

◆ SHA3_256_HASH_ALGO

#define SHA3_256_HASH_ALGO   (&sha3_256HashAlgo)

Definition at line 43 of file sha3_256.h.

◆ SHA3_256_OID

#define SHA3_256_OID   sha3_256Oid

Definition at line 41 of file sha3_256.h.

Typedef Documentation

◆ Sha3_256Context

SHA3-256 algorithm context.

Definition at line 55 of file sha3_256.h.

Function Documentation

◆ sha3_256Compute()

error_t sha3_256Compute ( const void *  data,
size_t  length,
uint8_t *  digest 
)

Digest a message using SHA3-256.

Parameters
[in]dataPointer to the message being hashed
[in]lengthLength of the message
[out]digestPointer to the calculated digest
Returns
Error code

Definition at line 71 of file sha3_256.c.

◆ sha3_256Final()

void sha3_256Final ( Sha3_256Context context,
uint8_t *  digest 
)

Finish the SHA3-256 message digest.

Parameters
[in]contextPointer to the SHA3-256 context
[out]digestCalculated digest (optional parameter)

Definition at line 127 of file sha3_256.c.

◆ sha3_256Init()

void sha3_256Init ( Sha3_256Context context)

Initialize SHA3-256 message digest context.

Parameters
[in]contextPointer to the SHA3-256 context to initialize

Definition at line 100 of file sha3_256.c.

◆ sha3_256Update()

void sha3_256Update ( Sha3_256Context context,
const void *  data,
size_t  length 
)

Update the SHA3-256 context with a portion of the message being hashed.

Parameters
[in]contextPointer to the SHA3-256 context
[in]dataPointer to the buffer being hashed
[in]lengthLength of the buffer

Definition at line 114 of file sha3_256.c.

Variable Documentation

◆ sha3_256HashAlgo

const HashAlgo sha3_256HashAlgo

Definition at line 48 of file sha3_256.c.

◆ sha3_256Oid

const uint8_t sha3_256Oid[9]

Definition at line 45 of file sha3_256.c.