whirlpool.h
Go to the documentation of this file.
1 /**
2  * @file whirlpool.h
3  * @brief Whirlpool 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.0
29  **/
30 
31 #ifndef _WHIRLPOOL_H
32 #define _WHIRLPOOL_H
33 
34 //Dependencies
35 #include "core/crypto.h"
36 
37 //Whirlpool block size
38 #define WHIRLPOOL_BLOCK_SIZE 64
39 //Whirlpool digest size
40 #define WHIRLPOOL_DIGEST_SIZE 64
41 //Minimum length of the padding string
42 #define WHIRLPOOL_MIN_PAD_SIZE 33
43 //Common interface for hash algorithms
44 #define WHIRLPOOL_HASH_ALGO (&whirlpoolHashAlgo)
45 
46 //C++ guard
47 #ifdef __cplusplus
48 extern "C" {
49 #endif
50 
51 
52 /**
53  * @brief Whirlpool algorithm context
54  **/
55 
56 typedef struct
57 {
58  union
59  {
60  uint64_t h[8];
61  uint8_t digest[64];
62  };
63  union
64  {
65  uint64_t x[8];
66  uint8_t buffer[64];
67  };
68 
69  uint64_t k[8];
70  uint64_t l[8];
71  uint64_t state[8];
72 
73  size_t size;
74  uint64_t totalSize;
75 } WhirlpoolContext;
76 
77 
78 //Whirlpool related constants
79 extern const uint8_t WHIRLPOOL_OID[6];
80 extern const HashAlgo whirlpoolHashAlgo;
81 
82 //Whirlpool related functions
83 error_t whirlpoolCompute(const void *data, size_t length, uint8_t *digest);
84 void whirlpoolInit(WhirlpoolContext *context);
85 void whirlpoolUpdate(WhirlpoolContext *context, const void *data, size_t length);
86 void whirlpoolFinal(WhirlpoolContext *context, uint8_t *digest);
87 void whirlpoolProcessBlock(WhirlpoolContext *context);
88 
89 //C++ guard
90 #ifdef __cplusplus
91 }
92 #endif
93 
94 #endif
crypto.h
General definitions for cryptographic algorithms.
error_t
error_t
Error codes.
Definition: error.h:43
data
uint8_t data[]
Definition: ethernet.h:222
x
uint8_t x
Definition: lldp_ext_med.h:211
h
uint8_t h
Definition: ndp.h:302
l
uint8_t l
Definition: ndp.h:412
HashAlgo
Common interface for hash algorithms.
Definition: crypto.h:1014
WhirlpoolContext
Whirlpool algorithm context.
Definition: whirlpool.h:57
WhirlpoolContext::totalSize
uint64_t totalSize
Definition: whirlpool.h:74
length
uint8_t length
Definition: tcp.h:368
whirlpoolHashAlgo
const HashAlgo whirlpoolHashAlgo
Definition: whirlpool.c:157
whirlpoolCompute
error_t whirlpoolCompute(const void *data, size_t length, uint8_t *digest)
Digest a message using Whirlpool.
Definition: whirlpool.c:183
whirlpoolInit
void whirlpoolInit(WhirlpoolContext *context)
Initialize Whirlpool message digest context.
Definition: whirlpool.c:228
whirlpoolFinal
void whirlpoolFinal(WhirlpoolContext *context, uint8_t *digest)
Finish the Whirlpool message digest.
Definition: whirlpool.c:291
whirlpoolProcessBlock
void whirlpoolProcessBlock(WhirlpoolContext *context)
Process message in 16-word blocks.
Definition: whirlpool.c:341
whirlpoolUpdate
void whirlpoolUpdate(WhirlpoolContext *context, const void *data, size_t length)
Update the Whirlpool context with a portion of the message being hashed.
Definition: whirlpool.c:252
WHIRLPOOL_OID
const uint8_t WHIRLPOOL_OID[6]
Definition: whirlpool.c:154