4 * \brief MD5 message digest algorithm (hash function)
\r
6 * \warning MD5 is considered a weak message digest and its use constitutes a
\r
7 * security risk. We recommend considering stronger message
\r
11 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
\r
12 * SPDX-License-Identifier: Apache-2.0
\r
14 * Licensed under the Apache License, Version 2.0 (the "License"); you may
\r
15 * not use this file except in compliance with the License.
\r
16 * You may obtain a copy of the License at
\r
18 * http://www.apache.org/licenses/LICENSE-2.0
\r
20 * Unless required by applicable law or agreed to in writing, software
\r
21 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
\r
22 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
\r
23 * See the License for the specific language governing permissions and
\r
24 * limitations under the License.
\r
26 * This file is part of mbed TLS (https://tls.mbed.org)
\r
28 #ifndef MBEDTLS_MD5_H
\r
29 #define MBEDTLS_MD5_H
\r
31 #if !defined(MBEDTLS_CONFIG_FILE)
\r
34 #include MBEDTLS_CONFIG_FILE
\r
40 /* MBEDTLS_ERR_MD5_HW_ACCEL_FAILED is deprecated and should not be used. */
\r
41 #define MBEDTLS_ERR_MD5_HW_ACCEL_FAILED -0x002F /**< MD5 hardware accelerator failed */
\r
47 #if !defined(MBEDTLS_MD5_ALT)
\r
48 // Regular implementation
\r
52 * \brief MD5 context structure
\r
54 * \warning MD5 is considered a weak message digest and its use
\r
55 * constitutes a security risk. We recommend considering
\r
56 * stronger message digests instead.
\r
59 typedef struct mbedtls_md5_context
\r
61 uint32_t total[2]; /*!< number of bytes processed */
\r
62 uint32_t state[4]; /*!< intermediate digest state */
\r
63 unsigned char buffer[64]; /*!< data block being processed */
\r
65 mbedtls_md5_context;
\r
67 #else /* MBEDTLS_MD5_ALT */
\r
68 #include "md5_alt.h"
\r
69 #endif /* MBEDTLS_MD5_ALT */
\r
72 * \brief Initialize MD5 context
\r
74 * \param ctx MD5 context to be initialized
\r
76 * \warning MD5 is considered a weak message digest and its use
\r
77 * constitutes a security risk. We recommend considering
\r
78 * stronger message digests instead.
\r
81 void mbedtls_md5_init( mbedtls_md5_context *ctx );
\r
84 * \brief Clear MD5 context
\r
86 * \param ctx MD5 context to be cleared
\r
88 * \warning MD5 is considered a weak message digest and its use
\r
89 * constitutes a security risk. We recommend considering
\r
90 * stronger message digests instead.
\r
93 void mbedtls_md5_free( mbedtls_md5_context *ctx );
\r
96 * \brief Clone (the state of) an MD5 context
\r
98 * \param dst The destination context
\r
99 * \param src The context to be cloned
\r
101 * \warning MD5 is considered a weak message digest and its use
\r
102 * constitutes a security risk. We recommend considering
\r
103 * stronger message digests instead.
\r
106 void mbedtls_md5_clone( mbedtls_md5_context *dst,
\r
107 const mbedtls_md5_context *src );
\r
110 * \brief MD5 context setup
\r
112 * \param ctx context to be initialized
\r
114 * \return 0 if successful
\r
116 * \warning MD5 is considered a weak message digest and its use
\r
117 * constitutes a security risk. We recommend considering
\r
118 * stronger message digests instead.
\r
121 int mbedtls_md5_starts_ret( mbedtls_md5_context *ctx );
\r
124 * \brief MD5 process buffer
\r
126 * \param ctx MD5 context
\r
127 * \param input buffer holding the data
\r
128 * \param ilen length of the input data
\r
130 * \return 0 if successful
\r
132 * \warning MD5 is considered a weak message digest and its use
\r
133 * constitutes a security risk. We recommend considering
\r
134 * stronger message digests instead.
\r
137 int mbedtls_md5_update_ret( mbedtls_md5_context *ctx,
\r
138 const unsigned char *input,
\r
142 * \brief MD5 final digest
\r
144 * \param ctx MD5 context
\r
145 * \param output MD5 checksum result
\r
147 * \return 0 if successful
\r
149 * \warning MD5 is considered a weak message digest and its use
\r
150 * constitutes a security risk. We recommend considering
\r
151 * stronger message digests instead.
\r
154 int mbedtls_md5_finish_ret( mbedtls_md5_context *ctx,
\r
155 unsigned char output[16] );
\r
158 * \brief MD5 process data block (internal use only)
\r
160 * \param ctx MD5 context
\r
161 * \param data buffer holding one block of data
\r
163 * \return 0 if successful
\r
165 * \warning MD5 is considered a weak message digest and its use
\r
166 * constitutes a security risk. We recommend considering
\r
167 * stronger message digests instead.
\r
170 int mbedtls_internal_md5_process( mbedtls_md5_context *ctx,
\r
171 const unsigned char data[64] );
\r
173 #if !defined(MBEDTLS_DEPRECATED_REMOVED)
\r
174 #if defined(MBEDTLS_DEPRECATED_WARNING)
\r
175 #define MBEDTLS_DEPRECATED __attribute__((deprecated))
\r
177 #define MBEDTLS_DEPRECATED
\r
180 * \brief MD5 context setup
\r
182 * \deprecated Superseded by mbedtls_md5_starts_ret() in 2.7.0
\r
184 * \param ctx context to be initialized
\r
186 * \warning MD5 is considered a weak message digest and its use
\r
187 * constitutes a security risk. We recommend considering
\r
188 * stronger message digests instead.
\r
191 MBEDTLS_DEPRECATED void mbedtls_md5_starts( mbedtls_md5_context *ctx );
\r
194 * \brief MD5 process buffer
\r
196 * \deprecated Superseded by mbedtls_md5_update_ret() in 2.7.0
\r
198 * \param ctx MD5 context
\r
199 * \param input buffer holding the data
\r
200 * \param ilen length of the input data
\r
202 * \warning MD5 is considered a weak message digest and its use
\r
203 * constitutes a security risk. We recommend considering
\r
204 * stronger message digests instead.
\r
207 MBEDTLS_DEPRECATED void mbedtls_md5_update( mbedtls_md5_context *ctx,
\r
208 const unsigned char *input,
\r
212 * \brief MD5 final digest
\r
214 * \deprecated Superseded by mbedtls_md5_finish_ret() in 2.7.0
\r
216 * \param ctx MD5 context
\r
217 * \param output MD5 checksum result
\r
219 * \warning MD5 is considered a weak message digest and its use
\r
220 * constitutes a security risk. We recommend considering
\r
221 * stronger message digests instead.
\r
224 MBEDTLS_DEPRECATED void mbedtls_md5_finish( mbedtls_md5_context *ctx,
\r
225 unsigned char output[16] );
\r
228 * \brief MD5 process data block (internal use only)
\r
230 * \deprecated Superseded by mbedtls_internal_md5_process() in 2.7.0
\r
232 * \param ctx MD5 context
\r
233 * \param data buffer holding one block of data
\r
235 * \warning MD5 is considered a weak message digest and its use
\r
236 * constitutes a security risk. We recommend considering
\r
237 * stronger message digests instead.
\r
240 MBEDTLS_DEPRECATED void mbedtls_md5_process( mbedtls_md5_context *ctx,
\r
241 const unsigned char data[64] );
\r
243 #undef MBEDTLS_DEPRECATED
\r
244 #endif /* !MBEDTLS_DEPRECATED_REMOVED */
\r
247 * \brief Output = MD5( input buffer )
\r
249 * \param input buffer holding the data
\r
250 * \param ilen length of the input data
\r
251 * \param output MD5 checksum result
\r
253 * \return 0 if successful
\r
255 * \warning MD5 is considered a weak message digest and its use
\r
256 * constitutes a security risk. We recommend considering
\r
257 * stronger message digests instead.
\r
260 int mbedtls_md5_ret( const unsigned char *input,
\r
262 unsigned char output[16] );
\r
264 #if !defined(MBEDTLS_DEPRECATED_REMOVED)
\r
265 #if defined(MBEDTLS_DEPRECATED_WARNING)
\r
266 #define MBEDTLS_DEPRECATED __attribute__((deprecated))
\r
268 #define MBEDTLS_DEPRECATED
\r
271 * \brief Output = MD5( input buffer )
\r
273 * \deprecated Superseded by mbedtls_md5_ret() in 2.7.0
\r
275 * \param input buffer holding the data
\r
276 * \param ilen length of the input data
\r
277 * \param output MD5 checksum result
\r
279 * \warning MD5 is considered a weak message digest and its use
\r
280 * constitutes a security risk. We recommend considering
\r
281 * stronger message digests instead.
\r
284 MBEDTLS_DEPRECATED void mbedtls_md5( const unsigned char *input,
\r
286 unsigned char output[16] );
\r
288 #undef MBEDTLS_DEPRECATED
\r
289 #endif /* !MBEDTLS_DEPRECATED_REMOVED */
\r
291 #if defined(MBEDTLS_SELF_TEST)
\r
294 * \brief Checkup routine
\r
296 * \return 0 if successful, or 1 if the test failed
\r
298 * \warning MD5 is considered a weak message digest and its use
\r
299 * constitutes a security risk. We recommend considering
\r
300 * stronger message digests instead.
\r
303 int mbedtls_md5_self_test( int verbose );
\r
305 #endif /* MBEDTLS_SELF_TEST */
\r
311 #endif /* mbedtls_md5.h */
\r