Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1 | /** |
Simon Butcher | 5b331b9 | 2016-01-03 16:14:14 +0000 | [diff] [blame] | 2 | * \file md5.h |
Paul Bakker | e0ccd0a | 2009-01-04 16:27:10 +0000 | [diff] [blame] | 3 | * |
Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 4 | * \brief MD5 message digest algorithm (hash function) |
Hanno Becker | bbca8c5 | 2017-09-25 14:53:51 +0100 | [diff] [blame] | 5 | * |
| 6 | * \warning MD5 is considered a weak message digest and its use constitutes a |
| 7 | * security risk. We recommend considering stronger message |
| 8 | * digests instead. |
Darryl Green | a40a101 | 2018-01-05 15:33:17 +0000 | [diff] [blame] | 9 | */ |
| 10 | /* |
Bence Szépkúti | 1e14827 | 2020-08-07 13:07:28 +0200 | [diff] [blame] | 11 | * Copyright The Mbed TLS Contributors |
Manuel Pégourié-Gonnard | 37ff140 | 2015-09-04 14:21:07 +0200 | [diff] [blame] | 12 | * SPDX-License-Identifier: Apache-2.0 |
| 13 | * |
| 14 | * Licensed under the Apache License, Version 2.0 (the "License"); you may |
| 15 | * not use this file except in compliance with the License. |
| 16 | * You may obtain a copy of the License at |
| 17 | * |
| 18 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 19 | * |
| 20 | * Unless required by applicable law or agreed to in writing, software |
| 21 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| 22 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 23 | * See the License for the specific language governing permissions and |
| 24 | * limitations under the License. |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 25 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 26 | #ifndef MBEDTLS_MD5_H |
| 27 | #define MBEDTLS_MD5_H |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 28 | #include "mbedtls/private_access.h" |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 29 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 30 | #if !defined(MBEDTLS_CONFIG_FILE) |
Jaeden Amero | c49fbbf | 2019-07-04 20:01:14 +0100 | [diff] [blame] | 31 | #include "mbedtls/config.h" |
Manuel Pégourié-Gonnard | cef4ad2 | 2014-04-29 12:39:06 +0200 | [diff] [blame] | 32 | #else |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 33 | #include MBEDTLS_CONFIG_FILE |
Manuel Pégourié-Gonnard | cef4ad2 | 2014-04-29 12:39:06 +0200 | [diff] [blame] | 34 | #endif |
Paul Bakker | 90995b5 | 2013-06-24 19:20:35 +0200 | [diff] [blame] | 35 | |
Rich Evans | 00ab470 | 2015-02-06 13:43:58 +0000 | [diff] [blame] | 36 | #include <stddef.h> |
Manuel Pégourié-Gonnard | ab22910 | 2015-04-15 11:53:16 +0200 | [diff] [blame] | 37 | #include <stdint.h> |
Paul Bakker | 5c2364c | 2012-10-01 14:41:15 +0000 | [diff] [blame] | 38 | |
Paul Bakker | 407a0da | 2013-06-27 14:29:21 +0200 | [diff] [blame] | 39 | #ifdef __cplusplus |
| 40 | extern "C" { |
| 41 | #endif |
| 42 | |
Ron Eldor | b2aacec | 2017-05-18 16:53:08 +0300 | [diff] [blame] | 43 | #if !defined(MBEDTLS_MD5_ALT) |
| 44 | // Regular implementation |
| 45 | // |
| 46 | |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 47 | /** |
| 48 | * \brief MD5 context structure |
Hanno Becker | bbca8c5 | 2017-09-25 14:53:51 +0100 | [diff] [blame] | 49 | * |
| 50 | * \warning MD5 is considered a weak message digest and its use |
| 51 | * constitutes a security risk. We recommend considering |
| 52 | * stronger message digests instead. |
| 53 | * |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 54 | */ |
Dawid Drozd | 428cc52 | 2018-07-24 10:02:47 +0200 | [diff] [blame] | 55 | typedef struct mbedtls_md5_context |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 56 | { |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 57 | uint32_t MBEDTLS_PRIVATE(total)[2]; /*!< number of bytes processed */ |
| 58 | uint32_t MBEDTLS_PRIVATE(state)[4]; /*!< intermediate digest state */ |
| 59 | unsigned char MBEDTLS_PRIVATE(buffer)[64]; /*!< data block being processed */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 60 | } |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 61 | mbedtls_md5_context; |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 62 | |
Ron Eldor | b2aacec | 2017-05-18 16:53:08 +0300 | [diff] [blame] | 63 | #else /* MBEDTLS_MD5_ALT */ |
| 64 | #include "md5_alt.h" |
| 65 | #endif /* MBEDTLS_MD5_ALT */ |
| 66 | |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 67 | /** |
Paul Bakker | 5b4af39 | 2014-06-26 12:09:34 +0200 | [diff] [blame] | 68 | * \brief Initialize MD5 context |
| 69 | * |
| 70 | * \param ctx MD5 context to be initialized |
Hanno Becker | bbca8c5 | 2017-09-25 14:53:51 +0100 | [diff] [blame] | 71 | * |
| 72 | * \warning MD5 is considered a weak message digest and its use |
| 73 | * constitutes a security risk. We recommend considering |
| 74 | * stronger message digests instead. |
| 75 | * |
Paul Bakker | 5b4af39 | 2014-06-26 12:09:34 +0200 | [diff] [blame] | 76 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 77 | void mbedtls_md5_init( mbedtls_md5_context *ctx ); |
Paul Bakker | 5b4af39 | 2014-06-26 12:09:34 +0200 | [diff] [blame] | 78 | |
| 79 | /** |
| 80 | * \brief Clear MD5 context |
| 81 | * |
| 82 | * \param ctx MD5 context to be cleared |
Hanno Becker | bbca8c5 | 2017-09-25 14:53:51 +0100 | [diff] [blame] | 83 | * |
| 84 | * \warning MD5 is considered a weak message digest and its use |
| 85 | * constitutes a security risk. We recommend considering |
| 86 | * stronger message digests instead. |
| 87 | * |
Paul Bakker | 5b4af39 | 2014-06-26 12:09:34 +0200 | [diff] [blame] | 88 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 89 | void mbedtls_md5_free( mbedtls_md5_context *ctx ); |
Paul Bakker | 5b4af39 | 2014-06-26 12:09:34 +0200 | [diff] [blame] | 90 | |
| 91 | /** |
Manuel Pégourié-Gonnard | 16d412f | 2015-07-06 15:26:26 +0200 | [diff] [blame] | 92 | * \brief Clone (the state of) an MD5 context |
| 93 | * |
| 94 | * \param dst The destination context |
| 95 | * \param src The context to be cloned |
Hanno Becker | bbca8c5 | 2017-09-25 14:53:51 +0100 | [diff] [blame] | 96 | * |
| 97 | * \warning MD5 is considered a weak message digest and its use |
| 98 | * constitutes a security risk. We recommend considering |
| 99 | * stronger message digests instead. |
| 100 | * |
Manuel Pégourié-Gonnard | 16d412f | 2015-07-06 15:26:26 +0200 | [diff] [blame] | 101 | */ |
| 102 | void mbedtls_md5_clone( mbedtls_md5_context *dst, |
| 103 | const mbedtls_md5_context *src ); |
| 104 | |
| 105 | /** |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 106 | * \brief MD5 context setup |
| 107 | * |
| 108 | * \param ctx context to be initialized |
Andres Amaya Garcia | 2cfd7a9 | 2017-05-02 10:19:27 +0100 | [diff] [blame] | 109 | * |
| 110 | * \return 0 if successful |
Hanno Becker | bbca8c5 | 2017-09-25 14:53:51 +0100 | [diff] [blame] | 111 | * |
| 112 | * \warning MD5 is considered a weak message digest and its use |
| 113 | * constitutes a security risk. We recommend considering |
| 114 | * stronger message digests instead. |
| 115 | * |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 116 | */ |
TRodziewicz | 26371e4 | 2021-06-08 16:45:41 +0200 | [diff] [blame] | 117 | int mbedtls_md5_starts( mbedtls_md5_context *ctx ); |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 118 | |
| 119 | /** |
| 120 | * \brief MD5 process buffer |
| 121 | * |
| 122 | * \param ctx MD5 context |
Andres Amaya Garcia | a21247e | 2017-07-20 14:01:08 +0100 | [diff] [blame] | 123 | * \param input buffer holding the data |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 124 | * \param ilen length of the input data |
Andres Amaya Garcia | 2cfd7a9 | 2017-05-02 10:19:27 +0100 | [diff] [blame] | 125 | * |
| 126 | * \return 0 if successful |
Hanno Becker | bbca8c5 | 2017-09-25 14:53:51 +0100 | [diff] [blame] | 127 | * |
| 128 | * \warning MD5 is considered a weak message digest and its use |
| 129 | * constitutes a security risk. We recommend considering |
| 130 | * stronger message digests instead. |
| 131 | * |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 132 | */ |
TRodziewicz | 26371e4 | 2021-06-08 16:45:41 +0200 | [diff] [blame] | 133 | int mbedtls_md5_update( mbedtls_md5_context *ctx, |
| 134 | const unsigned char *input, |
| 135 | size_t ilen ); |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 136 | |
| 137 | /** |
| 138 | * \brief MD5 final digest |
| 139 | * |
| 140 | * \param ctx MD5 context |
| 141 | * \param output MD5 checksum result |
Andres Amaya Garcia | 2cfd7a9 | 2017-05-02 10:19:27 +0100 | [diff] [blame] | 142 | * |
| 143 | * \return 0 if successful |
Hanno Becker | bbca8c5 | 2017-09-25 14:53:51 +0100 | [diff] [blame] | 144 | * |
| 145 | * \warning MD5 is considered a weak message digest and its use |
| 146 | * constitutes a security risk. We recommend considering |
| 147 | * stronger message digests instead. |
| 148 | * |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 149 | */ |
TRodziewicz | 26371e4 | 2021-06-08 16:45:41 +0200 | [diff] [blame] | 150 | int mbedtls_md5_finish( mbedtls_md5_context *ctx, |
| 151 | unsigned char output[16] ); |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 152 | |
Andres Amaya Garcia | 2cfd7a9 | 2017-05-02 10:19:27 +0100 | [diff] [blame] | 153 | /** |
| 154 | * \brief MD5 process data block (internal use only) |
| 155 | * |
| 156 | * \param ctx MD5 context |
| 157 | * \param data buffer holding one block of data |
| 158 | * |
| 159 | * \return 0 if successful |
Hanno Becker | bbca8c5 | 2017-09-25 14:53:51 +0100 | [diff] [blame] | 160 | * |
| 161 | * \warning MD5 is considered a weak message digest and its use |
| 162 | * constitutes a security risk. We recommend considering |
| 163 | * stronger message digests instead. |
| 164 | * |
Andres Amaya Garcia | 2cfd7a9 | 2017-05-02 10:19:27 +0100 | [diff] [blame] | 165 | */ |
Andres Amaya Garcia | cccfe08 | 2017-06-28 10:36:39 +0100 | [diff] [blame] | 166 | int mbedtls_internal_md5_process( mbedtls_md5_context *ctx, |
| 167 | const unsigned char data[64] ); |
Andres Amaya Garcia | 2cfd7a9 | 2017-05-02 10:19:27 +0100 | [diff] [blame] | 168 | |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 169 | /** |
| 170 | * \brief Output = MD5( input buffer ) |
| 171 | * |
Andres Amaya Garcia | a21247e | 2017-07-20 14:01:08 +0100 | [diff] [blame] | 172 | * \param input buffer holding the data |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 173 | * \param ilen length of the input data |
| 174 | * \param output MD5 checksum result |
Andres Amaya Garcia | 2cfd7a9 | 2017-05-02 10:19:27 +0100 | [diff] [blame] | 175 | * |
| 176 | * \return 0 if successful |
Hanno Becker | bbca8c5 | 2017-09-25 14:53:51 +0100 | [diff] [blame] | 177 | * |
| 178 | * \warning MD5 is considered a weak message digest and its use |
| 179 | * constitutes a security risk. We recommend considering |
| 180 | * stronger message digests instead. |
| 181 | * |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 182 | */ |
TRodziewicz | 26371e4 | 2021-06-08 16:45:41 +0200 | [diff] [blame] | 183 | int mbedtls_md5( const unsigned char *input, |
| 184 | size_t ilen, |
| 185 | unsigned char output[16] ); |
Andres Amaya Garcia | 2cfd7a9 | 2017-05-02 10:19:27 +0100 | [diff] [blame] | 186 | |
Andrzej Kurek | c470b6b | 2019-01-31 08:20:20 -0500 | [diff] [blame] | 187 | #if defined(MBEDTLS_SELF_TEST) |
| 188 | |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 189 | /** |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 190 | * \brief Checkup routine |
| 191 | * |
| 192 | * \return 0 if successful, or 1 if the test failed |
Hanno Becker | bbca8c5 | 2017-09-25 14:53:51 +0100 | [diff] [blame] | 193 | * |
| 194 | * \warning MD5 is considered a weak message digest and its use |
| 195 | * constitutes a security risk. We recommend considering |
| 196 | * stronger message digests instead. |
| 197 | * |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 198 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 199 | int mbedtls_md5_self_test( int verbose ); |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 200 | |
Andrzej Kurek | c470b6b | 2019-01-31 08:20:20 -0500 | [diff] [blame] | 201 | #endif /* MBEDTLS_SELF_TEST */ |
| 202 | |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 203 | #ifdef __cplusplus |
| 204 | } |
| 205 | #endif |
| 206 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 207 | #endif /* mbedtls_md5.h */ |