md5.h
Go to the documentation of this file.
1 /**
2  * @file md5.h
3  * @brief MD5 (Message-Digest Algorithm)
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 _MD5_H
32 #define _MD5_H
33 
34 //Dependencies
35 #include "core/crypto.h"
36 
37 //Application specific context
38 #ifndef MD5_PRIVATE_CONTEXT
39  #define MD5_PRIVATE_CONTEXT
40 #endif
41 
42 //MD5 block size
43 #define MD5_BLOCK_SIZE 64
44 //MD5 digest size
45 #define MD5_DIGEST_SIZE 16
46 //Minimum length of the padding string
47 #define MD5_MIN_PAD_SIZE 9
48 //Common interface for hash algorithms
49 #define MD5_HASH_ALGO (&md5HashAlgo)
50 
51 //C++ guard
52 #ifdef __cplusplus
53 extern "C" {
54 #endif
55 
56 
57 /**
58  * @brief MD5 algorithm context
59  **/
60 
61 typedef struct
62 {
63  union
64  {
65  uint32_t h[4];
66  uint8_t digest[16];
67  };
68  union
69  {
70  uint32_t x[16];
71  uint8_t buffer[64];
72  };
73  size_t size;
74  uint64_t totalSize;
75  MD5_PRIVATE_CONTEXT
76 } Md5Context;
77 
78 
79 //MD5 related constants
80 extern const uint8_t MD5_OID[8];
81 extern const HashAlgo md5HashAlgo;
82 
83 //MD5 related functions
84 error_t md5Compute(const void *data, size_t length, uint8_t *digest);
85 void md5Init(Md5Context *context);
86 void md5Update(Md5Context *context, const void *data, size_t length);
87 void md5Final(Md5Context *context, uint8_t *digest);
88 void md5FinalRaw(Md5Context *context, uint8_t *digest);
89 void md5ProcessBlock(Md5Context *context);
90 
91 //C++ guard
92 #ifdef __cplusplus
93 }
94 #endif
95 
96 #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
md5HashAlgo
const HashAlgo md5HashAlgo
Definition: md5.c:83
md5FinalRaw
void md5FinalRaw(Md5Context *context, uint8_t *digest)
Finish the MD5 message digest (no padding added)
Definition: msp432e4_crypto_hash.c:333
MD5_OID
const uint8_t MD5_OID[8]
Definition: md5.c:80
md5ProcessBlock
void md5ProcessBlock(Md5Context *context)
Process message in 16-word blocks.
Definition: apm32f4xx_crypto_hash.c:213
md5Update
void md5Update(Md5Context *context, const void *data, size_t length)
Update the MD5 context with a portion of the message being hashed.
Definition: apm32f4xx_crypto_hash.c:153
md5Compute
error_t md5Compute(const void *data, size_t length, uint8_t *digest)
Digest a message using MD5.
Definition: gd32f2xx_crypto_hash.c:72
md5Init
void md5Init(Md5Context *context)
Initialize MD5 message digest context.
Definition: msp432e4_crypto_hash.c:189
md5Final
void md5Final(Md5Context *context, uint8_t *digest)
Finish the MD5 message digest.
Definition: msp432e4_crypto_hash.c:292
MD5_PRIVATE_CONTEXT
#define MD5_PRIVATE_CONTEXT
Definition: md5.h:39
h
uint8_t h
Definition: ndp.h:302
HashAlgo
Common interface for hash algorithms.
Definition: crypto.h:1014
Md5Context
MD5 algorithm context.
Definition: md5.h:62
Md5Context::totalSize
uint64_t totalSize
Definition: md5.h:74
Md5Context::size
size_t size
Definition: md5.h:73
length
uint8_t length
Definition: tcp.h:368