sha3_256.h
Go to the documentation of this file.
1 /**
2  * @file sha3_256.h
3  * @brief SHA3-256 hash function (SHA-3 with 256-bit output)
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2024 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneCRYPTO Open.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26  *
27  * @author Oryx Embedded SARL (www.oryx-embedded.com)
28  * @version 2.4.4
29  **/
30 
31 #ifndef _SHA3_256_H
32 #define _SHA3_256_H
33 
34 //Dependencies
35 #include "core/crypto.h"
36 #include "xof/keccak.h"
37 
38 //SHA3-256 block size
39 #define SHA3_256_BLOCK_SIZE 136
40 //SHA3-256 digest size
41 #define SHA3_256_DIGEST_SIZE 32
42 //Minimum length of the padding string
43 #define SHA3_256_MIN_PAD_SIZE 1
44 //Common interface for hash algorithms
45 #define SHA3_256_HASH_ALGO (&sha3_256HashAlgo)
46 
47 //C++ guard
48 #ifdef __cplusplus
49 extern "C" {
50 #endif
51 
52 
53 /**
54  * @brief SHA3-256 algorithm context
55  **/
56 
57 typedef KeccakContext Sha3_256Context;
58 
59 
60 //SHA3-256 related constants
61 extern const uint8_t SHA3_256_OID[9];
62 extern const HashAlgo sha3_256HashAlgo;
63 
64 //SHA3-256 related functions
65 error_t sha3_256Compute(const void *data, size_t length, uint8_t *digest);
66 void sha3_256Init(Sha3_256Context *context);
67 void sha3_256Update(Sha3_256Context *context, const void *data, size_t length);
68 void sha3_256Final(Sha3_256Context *context, uint8_t *digest);
69 
70 //C++ guard
71 #ifdef __cplusplus
72 }
73 #endif
74 
75 #endif
data
uint8_t data[]
Definition: ethernet.h:222
KeccakContext
Keccak context.
Definition: keccak.h:110
sha3_256Init
void sha3_256Init(Sha3_256Context *context)
Initialize SHA3-256 message digest context.
Definition: sha3_256.c:121
sha3_256HashAlgo
const HashAlgo sha3_256HashAlgo
Definition: sha3_256.c:50
error_t
error_t
Error codes.
Definition: error.h:43
Sha3_256Context
KeccakContext Sha3_256Context
SHA3-256 algorithm context.
Definition: sha3_256.h:57
crypto.h
General definitions for cryptographic algorithms.
sha3_256Compute
error_t sha3_256Compute(const void *data, size_t length, uint8_t *digest)
Digest a message using SHA3-256.
Definition: sha3_256.c:76
length
uint8_t length
Definition: tcp.h:368
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.
Definition: sha3_256.c:135
keccak.h
Keccak sponge function.
sha3_256Final
void sha3_256Final(Sha3_256Context *context, uint8_t *digest)
Finish the SHA3-256 message digest.
Definition: sha3_256.c:148
SHA3_256_OID
const uint8_t SHA3_256_OID[9]
Definition: sha3_256.c:47
HashAlgo
Common interface for hash algorithms.
Definition: crypto.h:1046