mbed TLS v2.24.0
md.h
Go to the documentation of this file.
1 
8 /*
9  * Copyright The Mbed TLS Contributors
10  * SPDX-License-Identifier: Apache-2.0
11  *
12  * Licensed under the Apache License, Version 2.0 (the "License"); you may
13  * not use this file except in compliance with the License.
14  * You may obtain a copy of the License at
15  *
16  * http://www.apache.org/licenses/LICENSE-2.0
17  *
18  * Unless required by applicable law or agreed to in writing, software
19  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
20  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
21  * See the License for the specific language governing permissions and
22  * limitations under the License.
23  */
24 
25 #ifndef MBEDTLS_MD_H
26 #define MBEDTLS_MD_H
27 
28 #include <stddef.h>
29 
30 #if !defined(MBEDTLS_CONFIG_FILE)
31 #include "mbedtls/config.h"
32 #else
33 #include MBEDTLS_CONFIG_FILE
34 #endif
35 
36 #define MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE -0x5080
37 #define MBEDTLS_ERR_MD_BAD_INPUT_DATA -0x5100
38 #define MBEDTLS_ERR_MD_ALLOC_FAILED -0x5180
39 #define MBEDTLS_ERR_MD_FILE_IO_ERROR -0x5200
41 /* MBEDTLS_ERR_MD_HW_ACCEL_FAILED is deprecated and should not be used. */
42 #define MBEDTLS_ERR_MD_HW_ACCEL_FAILED -0x5280
44 #ifdef __cplusplus
45 extern "C" {
46 #endif
47 
56 typedef enum {
68 
69 #if defined(MBEDTLS_SHA512_C)
70 #define MBEDTLS_MD_MAX_SIZE 64 /* longest known is SHA512 */
71 #else
72 #define MBEDTLS_MD_MAX_SIZE 32 /* longest known is SHA256 or less */
73 #endif
74 
75 #if defined(MBEDTLS_SHA512_C)
76 #define MBEDTLS_MD_MAX_BLOCK_SIZE 128
77 #else
78 #define MBEDTLS_MD_MAX_BLOCK_SIZE 64
79 #endif
80 
85 
89 typedef struct mbedtls_md_context_t
90 {
93 
95  void *md_ctx;
96 
98  void *hmac_ctx;
100 
112 const int *mbedtls_md_list( void );
113 
123 const mbedtls_md_info_t *mbedtls_md_info_from_string( const char *md_name );
124 
135 
145 
160 
161 #if ! defined(MBEDTLS_DEPRECATED_REMOVED)
162 #if defined(MBEDTLS_DEPRECATED_WARNING)
163 #define MBEDTLS_DEPRECATED __attribute__((deprecated))
164 #else
165 #define MBEDTLS_DEPRECATED
166 #endif
167 
185 int mbedtls_md_init_ctx( mbedtls_md_context_t *ctx, const mbedtls_md_info_t *md_info ) MBEDTLS_DEPRECATED;
186 #undef MBEDTLS_DEPRECATED
187 #endif /* MBEDTLS_DEPRECATED_REMOVED */
188 
208 int mbedtls_md_setup( mbedtls_md_context_t *ctx, const mbedtls_md_info_t *md_info, int hmac );
209 
230  const mbedtls_md_context_t *src );
231 
241 unsigned char mbedtls_md_get_size( const mbedtls_md_info_t *md_info );
242 
253 
263 const char *mbedtls_md_get_name( const mbedtls_md_info_t *md_info );
264 
279 
296 int mbedtls_md_update( mbedtls_md_context_t *ctx, const unsigned char *input, size_t ilen );
297 
316 int mbedtls_md_finish( mbedtls_md_context_t *ctx, unsigned char *output );
317 
336 int mbedtls_md( const mbedtls_md_info_t *md_info, const unsigned char *input, size_t ilen,
337  unsigned char *output );
338 
339 #if defined(MBEDTLS_FS_IO)
340 
357 int mbedtls_md_file( const mbedtls_md_info_t *md_info, const char *path,
358  unsigned char *output );
359 #endif /* MBEDTLS_FS_IO */
360 
379 int mbedtls_md_hmac_starts( mbedtls_md_context_t *ctx, const unsigned char *key,
380  size_t keylen );
381 
401 int mbedtls_md_hmac_update( mbedtls_md_context_t *ctx, const unsigned char *input,
402  size_t ilen );
403 
422 int mbedtls_md_hmac_finish( mbedtls_md_context_t *ctx, unsigned char *output);
423 
440 
463 int mbedtls_md_hmac( const mbedtls_md_info_t *md_info, const unsigned char *key, size_t keylen,
464  const unsigned char *input, size_t ilen,
465  unsigned char *output );
466 
467 /* Internal use */
468 int mbedtls_md_process( mbedtls_md_context_t *ctx, const unsigned char *data );
469 
470 #ifdef __cplusplus
471 }
472 #endif
473 
474 #endif /* MBEDTLS_MD_H */
int mbedtls_md_hmac_reset(mbedtls_md_context_t *ctx)
This function prepares to authenticate a new message with the same key as the previous HMAC operation...
mbedtls_md_type_t mbedtls_md_get_type(const mbedtls_md_info_t *md_info)
This function extracts the message-digest type from the message-digest information structure...
int mbedtls_md_starts(mbedtls_md_context_t *ctx)
This function starts a message-digest computation.
void * hmac_ctx
Definition: md.h:98
int mbedtls_md_hmac_update(mbedtls_md_context_t *ctx, const unsigned char *input, size_t ilen)
This function feeds an input buffer into an ongoing HMAC computation.
void mbedtls_md_free(mbedtls_md_context_t *ctx)
This function clears the internal structure of ctx and frees any embedded internal structure...
void mbedtls_md_init(mbedtls_md_context_t *ctx)
This function initializes a message-digest context without binding it to a particular message-digest ...
int mbedtls_md_clone(mbedtls_md_context_t *dst, const mbedtls_md_context_t *src)
This function clones the state of an message-digest context.
void * md_ctx
Definition: md.h:95
Configuration options (set of defines)
#define MBEDTLS_DEPRECATED
Definition: pkcs11.h:60
int mbedtls_md_process(mbedtls_md_context_t *ctx, const unsigned char *data)
unsigned char mbedtls_md_get_size(const mbedtls_md_info_t *md_info)
This function extracts the message-digest size from the message-digest information structure...
int mbedtls_md_hmac_finish(mbedtls_md_context_t *ctx, unsigned char *output)
This function finishes the HMAC operation, and writes the result to the output buffer.
int mbedtls_md_setup(mbedtls_md_context_t *ctx, const mbedtls_md_info_t *md_info, int hmac)
This function selects the message digest algorithm to use, and allocates internal structures...
int mbedtls_md_hmac(const mbedtls_md_info_t *md_info, const unsigned char *key, size_t keylen, const unsigned char *input, size_t ilen, unsigned char *output)
This function calculates the full generic HMAC on the input buffer with the provided key...
int mbedtls_md(const mbedtls_md_info_t *md_info, const unsigned char *input, size_t ilen, unsigned char *output)
This function calculates the message-digest of a buffer, with respect to a configurable message-diges...
int mbedtls_md_finish(mbedtls_md_context_t *ctx, unsigned char *output)
This function finishes the digest operation, and writes the result to the output buffer.
const char * mbedtls_md_get_name(const mbedtls_md_info_t *md_info)
This function extracts the message-digest name from the message-digest information structure...
struct mbedtls_md_context_t mbedtls_md_context_t
const int * mbedtls_md_list(void)
This function returns the list of digests supported by the generic digest module. ...
const mbedtls_md_info_t * mbedtls_md_info_from_type(mbedtls_md_type_t md_type)
This function returns the message-digest information associated with the given digest type...
int mbedtls_md_file(const mbedtls_md_info_t *md_info, const char *path, unsigned char *output)
This function calculates the message-digest checksum result of the contents of the provided file...
struct mbedtls_md_info_t mbedtls_md_info_t
Definition: md.h:84
int mbedtls_md_hmac_starts(mbedtls_md_context_t *ctx, const unsigned char *key, size_t keylen)
This function sets the HMAC key and prepares to authenticate a new message.
mbedtls_md_type_t
Supported message digests.
Definition: md.h:56
const mbedtls_md_info_t * mbedtls_md_info_from_string(const char *md_name)
This function returns the message-digest information associated with the given digest name...
const mbedtls_md_info_t * md_info
Definition: md.h:92
int mbedtls_md_update(mbedtls_md_context_t *ctx, const unsigned char *input, size_t ilen)
This function feeds an input buffer into an ongoing message-digest computation.