blake2s256.h
Go to the documentation of this file.
1 /**
2  * @file blake2s256.h
3  * @brief BLAKE2s-256 hash function
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 _BLAKE2S256_H
32 #define _BLAKE2S256_H
33 
34 //Dependencies
35 #include "core/crypto.h"
36 #include "hash/blake2s.h"
37 
38 //BLAKE2s-256 block size
39 #define BLAKE2S256_BLOCK_SIZE 64
40 //BLAKE2s-256 digest size
41 #define BLAKE2S256_DIGEST_SIZE 32
42 //Minimum length of the padding string
43 #define BLAKE2S256_MIN_PAD_SIZE 0
44 //Common interface for hash algorithms
45 #define BLAKE2S256_HASH_ALGO (&blake2s256HashAlgo)
46 
47 //C++ guard
48 #ifdef __cplusplus
49 extern "C" {
50 #endif
51 
52 
53 /**
54  * @brief BLAKE2s-256 algorithm context
55  **/
56 
57 typedef Blake2sContext Blake2s256Context;
58 
59 
60 //BLAKE2s-256 related constants
61 extern const uint8_t BLAKE2S256_OID[11];
62 extern const HashAlgo blake2s256HashAlgo;
63 
64 //BLAKE2s-256 related functions
65 error_t blake2s256Compute(const void *data, size_t length, uint8_t *digest);
66 void blake2s256Init(Blake2s256Context *context);
67 void blake2s256Update(Blake2s256Context *context, const void *data, size_t length);
68 void blake2s256Final(Blake2s256Context *context, uint8_t *digest);
69 
70 //C++ guard
71 #ifdef __cplusplus
72 }
73 #endif
74 
75 #endif
BLAKE2S256_OID
const uint8_t BLAKE2S256_OID[11]
Definition: blake2s256.c:42
blake2s256Init
void blake2s256Init(Blake2s256Context *context)
Initialize BLAKE2s-256 hash computation.
Definition: blake2s256.c:83
data
uint8_t data[]
Definition: ethernet.h:222
blake2s.h
BLAKE2 cryptographic hash and MAC (BLAKE2s variant)
blake2s256Final
void blake2s256Final(Blake2s256Context *context, uint8_t *digest)
Finish BLAKE2s-256 hash computation.
Definition: blake2s256.c:110
Blake2s256Context
Blake2sContext Blake2s256Context
BLAKE2s-256 algorithm context.
Definition: blake2s256.h:57
blake2s256Update
void blake2s256Update(Blake2s256Context *context, const void *data, size_t length)
Update BLAKE2s-256 hash computation.
Definition: blake2s256.c:97
error_t
error_t
Error codes.
Definition: error.h:43
blake2s256HashAlgo
const HashAlgo blake2s256HashAlgo
Definition: blake2s256.c:45
crypto.h
General definitions for cryptographic algorithms.
Blake2sContext
BLAKE2s algorithm context.
Definition: blake2s.h:51
length
uint8_t length
Definition: tcp.h:368
blake2s256Compute
error_t blake2s256Compute(const void *data, size_t length, uint8_t *digest)
Digest a message using BLAKE2s-256.
Definition: blake2s256.c:71
HashAlgo
Common interface for hash algorithms.
Definition: crypto.h:1046