sha256.h
Go to the documentation of this file.
1 /**
2  * @file sha256.h
3  * @brief SHA-256 (Secure Hash Algorithm 256)
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2023 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.2.4
29  **/
30 
31 #ifndef _SHA256_H
32 #define _SHA256_H
33 
34 //Dependencies
35 #include "core/crypto.h"
36 
37 //Application specific context
38 #ifndef SHA256_PRIVATE_CONTEXT
39  #define SHA256_PRIVATE_CONTEXT
40 #endif
41 
42 //SHA-256 block size
43 #define SHA256_BLOCK_SIZE 64
44 //SHA-256 digest size
45 #define SHA256_DIGEST_SIZE 32
46 //Minimum length of the padding string
47 #define SHA256_MIN_PAD_SIZE 9
48 //SHA-256 algorithm object identifier
49 #define SHA256_OID sha256Oid
50 //Common interface for hash algorithms
51 #define SHA256_HASH_ALGO (&sha256HashAlgo)
52 
53 //C++ guard
54 #ifdef __cplusplus
55 extern "C" {
56 #endif
57 
58 
59 /**
60  * @brief SHA-256 algorithm context
61  **/
62 
63 typedef struct
64 {
65  union
66  {
67  uint32_t h[8];
68  uint8_t digest[32];
69  };
70  union
71  {
72  uint32_t w[16];
73  uint8_t buffer[64];
74  };
75  size_t size;
76  uint64_t totalSize;
79 
80 
81 //SHA-256 related constants
82 extern const uint8_t sha256Oid[9];
83 extern const HashAlgo sha256HashAlgo;
84 
85 //SHA-256 related functions
86 error_t sha256Compute(const void *data, size_t length, uint8_t *digest);
87 void sha256Init(Sha256Context *context);
88 void sha256Update(Sha256Context *context, const void *data, size_t length);
89 void sha256Final(Sha256Context *context, uint8_t *digest);
90 void sha256FinalRaw(Sha256Context *context, uint8_t *digest);
91 void sha256ProcessBlock(Sha256Context *context);
92 
93 //C++ guard
94 #ifdef __cplusplus
95 }
96 #endif
97 
98 #endif
const uint8_t sha256Oid[9]
Definition: sha256.c:80
uint8_t length
Definition: coap_common.h:193
void sha256FinalRaw(Sha256Context *context, uint8_t *digest)
Finish the SHA-256 message digest (no padding added)
uint8_t data[]
Definition: ethernet.h:220
SHA-256 algorithm context.
Definition: sha256.h:64
void sha256Update(Sha256Context *context, const void *data, size_t length)
Update the SHA-256 context with a portion of the message being hashed.
const HashAlgo sha256HashAlgo
Definition: sha256.c:83
size_t size
Definition: sha256.h:75
uint16_t w[3]
Definition: ethernet.h:191
uint8_t h
Definition: ndp.h:300
void sha256Final(Sha256Context *context, uint8_t *digest)
Finish the SHA-256 message digest.
error_t
Error codes.
Definition: error.h:43
General definitions for cryptographic algorithms.
#define SHA256_PRIVATE_CONTEXT
Definition: sha256.h:39
Common interface for hash algorithms.
Definition: crypto.h:958
void sha256Init(Sha256Context *context)
Initialize SHA-256 message digest context.
uint64_t totalSize
Definition: sha256.h:76
error_t sha256Compute(const void *data, size_t length, uint8_t *digest)
Digest a message using SHA-256.
void sha256ProcessBlock(Sha256Context *context)
Process message in 16-word blocks.