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-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 _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 //MD5 algorithm object identifier
49 #define MD5_OID md5Oid
50 //Common interface for hash algorithms
51 #define MD5_HASH_ALGO (&md5HashAlgo)
52 
53 //C++ guard
54 #ifdef __cplusplus
55 extern "C" {
56 #endif
57 
58 
59 /**
60  * @brief MD5 algorithm context
61  **/
62 
63 typedef struct
64 {
65  union
66  {
67  uint32_t h[4];
68  uint8_t digest[16];
69  };
70  union
71  {
72  uint32_t x[16];
73  uint8_t buffer[64];
74  };
75  size_t size;
76  uint64_t totalSize;
78 } Md5Context;
79 
80 
81 //MD5 related constants
82 extern const uint8_t md5Oid[8];
83 extern const HashAlgo md5HashAlgo;
84 
85 //MD5 related functions
86 error_t md5Compute(const void *data, size_t length, uint8_t *digest);
87 void md5Init(Md5Context *context);
88 void md5Update(Md5Context *context, const void *data, size_t length);
89 void md5Final(Md5Context *context, uint8_t *digest);
90 void md5FinalRaw(Md5Context *context, uint8_t *digest);
91 void md5ProcessBlock(Md5Context *context);
92 
93 //C++ guard
94 #ifdef __cplusplus
95 }
96 #endif
97 
98 #endif
error_t md5Compute(const void *data, size_t length, uint8_t *digest)
Digest a message using MD5.
uint8_t length
Definition: coap_common.h:193
void md5ProcessBlock(Md5Context *context)
Process message in 16-word blocks.
const uint8_t md5Oid[8]
Definition: md5.c:80
uint8_t data[]
Definition: ethernet.h:220
void md5Init(Md5Context *context)
Initialize MD5 message digest context.
uint8_t x
Definition: lldp_ext_med.h:209
void md5Final(Md5Context *context, uint8_t *digest)
Finish the MD5 message digest.
const HashAlgo md5HashAlgo
Definition: md5.c:83
uint8_t h
Definition: ndp.h:300
void md5FinalRaw(Md5Context *context, uint8_t *digest)
Finish the MD5 message digest (no padding added)
error_t
Error codes.
Definition: error.h:43
General definitions for cryptographic algorithms.
MD5 algorithm context.
Definition: md5.h:64
void md5Update(Md5Context *context, const void *data, size_t length)
Update the MD5 context with a portion of the message being hashed.
uint64_t totalSize
Definition: md5.h:76
#define MD5_PRIVATE_CONTEXT
Definition: md5.h:39
size_t size
Definition: md5.h:75
Common interface for hash algorithms.
Definition: crypto.h:958