Rtos API example
md.h File Reference
Generic message digest wrapper. More...
Go to the source code of this file.
Data Structures | |
struct | mbedtls_md_context_t |
Generic message digest context. More... | |
Typedefs | |
typedef struct mbedtls_md_info_t | mbedtls_md_info_t |
Opaque struct defined in md_internal.h. | |
Functions | |
const int * | mbedtls_md_list (void) |
Returns the list of digests supported by the generic digest module. | |
const mbedtls_md_info_t * | mbedtls_md_info_from_string (const char *md_name) |
Returns the message digest information associated with the given digest name. | |
const mbedtls_md_info_t * | mbedtls_md_info_from_type (mbedtls_md_type_t md_type) |
Returns the message digest information associated with the given digest type. | |
void | mbedtls_md_init (mbedtls_md_context_t *ctx) |
Initialize a md_context (as NONE) This should always be called first. | |
void | mbedtls_md_free (mbedtls_md_context_t *ctx) |
Free and clear the internal structures of ctx. | |
int | mbedtls_md_init_ctx (mbedtls_md_context_t *ctx, const mbedtls_md_info_t *md_info) MBEDTLS_DEPRECATED |
Select MD to use and allocate internal structures. | |
int | mbedtls_md_setup (mbedtls_md_context_t *ctx, const mbedtls_md_info_t *md_info, int hmac) |
Select MD to use and allocate internal structures. | |
int | mbedtls_md_clone (mbedtls_md_context_t *dst, const mbedtls_md_context_t *src) |
Clone the state of an MD context. | |
unsigned char | mbedtls_md_get_size (const mbedtls_md_info_t *md_info) |
Returns the size of the message digest output. | |
mbedtls_md_type_t | mbedtls_md_get_type (const mbedtls_md_info_t *md_info) |
Returns the type of the message digest output. | |
const char * | mbedtls_md_get_name (const mbedtls_md_info_t *md_info) |
Returns the name of the message digest output. | |
int | mbedtls_md_starts (mbedtls_md_context_t *ctx) |
Prepare the context to digest a new message. | |
int | mbedtls_md_update (mbedtls_md_context_t *ctx, const unsigned char *input, size_t ilen) |
Generic message digest process buffer Called between mbedtls_md_starts() and mbedtls_md_finish(). | |
int | mbedtls_md_finish (mbedtls_md_context_t *ctx, unsigned char *output) |
Generic message digest final digest Called after mbedtls_md_update(). | |
int | mbedtls_md (const mbedtls_md_info_t *md_info, const unsigned char *input, size_t ilen, unsigned char *output) |
Output = message_digest( input buffer ) | |
int | mbedtls_md_file (const mbedtls_md_info_t *md_info, const char *path, unsigned char *output) |
Output = message_digest( file contents ) | |
int | mbedtls_md_hmac_starts (mbedtls_md_context_t *ctx, const unsigned char *key, size_t keylen) |
Set HMAC key and prepare to authenticate a new message. | |
int | mbedtls_md_hmac_update (mbedtls_md_context_t *ctx, const unsigned char *input, size_t ilen) |
Generic HMAC process buffer. | |
int | mbedtls_md_hmac_finish (mbedtls_md_context_t *ctx, unsigned char *output) |
Output HMAC. | |
int | mbedtls_md_hmac_reset (mbedtls_md_context_t *ctx) |
Prepare to authenticate a new message with the same key. | |
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) |
Output = Generic_HMAC( hmac key, input buffer ) |
Detailed Description
Generic message digest wrapper.
Copyright (C) 2006-2015, ARM Limited, All Rights Reserved SPDX-License-Identifier: Apache-2.0
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
This file is part of mbed TLS (https://tls.mbed.org)
Definition in file md.h.
Typedef Documentation
typedef struct mbedtls_md_info_t mbedtls_md_info_t |
Opaque struct defined in md_internal.h.
Function Documentation
int mbedtls_md | ( | const mbedtls_md_info_t * | md_info, |
const unsigned char * | input, | ||
size_t | ilen, | ||
unsigned char * | output | ||
) |
Output = message_digest( input buffer )
- Parameters:
-
md_info message digest info input buffer holding the data ilen length of the input data output Generic message digest checksum result
- Returns:
- 0 on success, MBEDTLS_ERR_MD_BAD_INPUT_DATA if parameter verification fails.
int mbedtls_md_clone | ( | mbedtls_md_context_t * | dst, |
const mbedtls_md_context_t * | src | ||
) |
Clone the state of an MD context.
- Note:
- The two contexts must have been setup to the same type (cloning from SHA-256 to SHA-512 make no sense).
- Warning:
- Only clones the MD state, not the HMAC state! (for now)
- Parameters:
-
dst The destination context src The context to be cloned
- Returns:
0
on success,MBEDTLS_ERR_MD_BAD_INPUT_DATA
on parameter failure.
int mbedtls_md_file | ( | const mbedtls_md_info_t * | md_info, |
const char * | path, | ||
unsigned char * | output | ||
) |
Output = message_digest( file contents )
- Parameters:
-
md_info message digest info path input file name output generic message digest checksum result
- Returns:
- 0 if successful, MBEDTLS_ERR_MD_FILE_IO_ERROR if file input failed, MBEDTLS_ERR_MD_BAD_INPUT_DATA if md_info was NULL.
int mbedtls_md_finish | ( | mbedtls_md_context_t * | ctx, |
unsigned char * | output | ||
) |
Generic message digest final digest Called after mbedtls_md_update().
Usually followed by mbedtls_md_free() or mbedtls_md_starts().
- Parameters:
-
ctx Generic message digest context output Generic message digest checksum result
- Returns:
- 0 on success, MBEDTLS_ERR_MD_BAD_INPUT_DATA if parameter verification fails.
void mbedtls_md_free | ( | mbedtls_md_context_t * | ctx ) |
Free and clear the internal structures of ctx.
Can be called at any time after mbedtls_md_init(). Mandatory once mbedtls_md_setup() has been called.
const char* mbedtls_md_get_name | ( | const mbedtls_md_info_t * | md_info ) |
unsigned char mbedtls_md_get_size | ( | const mbedtls_md_info_t * | md_info ) |
mbedtls_md_type_t mbedtls_md_get_type | ( | const mbedtls_md_info_t * | md_info ) |
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 | ||
) |
Output = Generic_HMAC( hmac key, input buffer )
- Parameters:
-
md_info message digest info key HMAC secret key keylen length of the HMAC key in bytes input buffer holding the data ilen length of the input data output Generic HMAC-result
- Returns:
- 0 on success, MBEDTLS_ERR_MD_BAD_INPUT_DATA if parameter verification fails.
int mbedtls_md_hmac_finish | ( | mbedtls_md_context_t * | ctx, |
unsigned char * | output | ||
) |
Output HMAC.
Called after mbedtls_md_hmac_update(). Usually followed by mbedtls_md_hmac_reset(), mbedtls_md_hmac_starts(), or mbedtls_md_free().
- Parameters:
-
ctx HMAC context output Generic HMAC checksum result
- Returns:
- 0 on success, MBEDTLS_ERR_MD_BAD_INPUT_DATA if parameter verification fails.
int mbedtls_md_hmac_reset | ( | mbedtls_md_context_t * | ctx ) |
Prepare to authenticate a new message with the same key.
Called after mbedtls_md_hmac_finish() and before mbedtls_md_hmac_update().
- Parameters:
-
ctx HMAC context to be reset
- Returns:
- 0 on success, MBEDTLS_ERR_MD_BAD_INPUT_DATA if parameter verification fails.
int mbedtls_md_hmac_starts | ( | mbedtls_md_context_t * | ctx, |
const unsigned char * | key, | ||
size_t | keylen | ||
) |
Set HMAC key and prepare to authenticate a new message.
Usually called after mbedtls_md_setup() or mbedtls_md_hmac_finish().
- Parameters:
-
ctx HMAC context key HMAC secret key keylen length of the HMAC key in bytes
- Returns:
- 0 on success, MBEDTLS_ERR_MD_BAD_INPUT_DATA if parameter verification fails.
int mbedtls_md_hmac_update | ( | mbedtls_md_context_t * | ctx, |
const unsigned char * | input, | ||
size_t | ilen | ||
) |
Generic HMAC process buffer.
Called between mbedtls_md_hmac_starts() or mbedtls_md_hmac_reset() and mbedtls_md_hmac_finish(). May be called repeatedly.
- Parameters:
-
ctx HMAC context input buffer holding the data ilen length of the input data
- Returns:
- 0 on success, MBEDTLS_ERR_MD_BAD_INPUT_DATA if parameter verification fails.
const mbedtls_md_info_t* mbedtls_md_info_from_string | ( | const char * | md_name ) |
const mbedtls_md_info_t* mbedtls_md_info_from_type | ( | mbedtls_md_type_t | md_type ) |
void mbedtls_md_init | ( | mbedtls_md_context_t * | ctx ) |
Initialize a md_context (as NONE) This should always be called first.
Prepares the context for mbedtls_md_setup() or mbedtls_md_free().
int mbedtls_md_init_ctx | ( | mbedtls_md_context_t * | ctx, |
const mbedtls_md_info_t * | md_info | ||
) |
Select MD to use and allocate internal structures.
Should be called after mbedtls_md_init() or mbedtls_md_free(). Makes it necessary to call mbedtls_md_free() later.
- Parameters:
-
ctx Context to set up. md_info Message digest to use.
- Returns:
0
on success,MBEDTLS_ERR_MD_BAD_INPUT_DATA
on parameter failure,MBEDTLS_ERR_MD_ALLOC_FAILED
memory allocation failure.
const int* mbedtls_md_list | ( | void | ) |
int mbedtls_md_setup | ( | mbedtls_md_context_t * | ctx, |
const mbedtls_md_info_t * | md_info, | ||
int | hmac | ||
) |
Select MD to use and allocate internal structures.
Should be called after mbedtls_md_init() or mbedtls_md_free(). Makes it necessary to call mbedtls_md_free() later.
- Parameters:
-
ctx Context to set up. md_info Message digest to use. hmac 0 to save some memory if HMAC will not be used, non-zero is HMAC is going to be used with this context.
- Returns:
0
on success,MBEDTLS_ERR_MD_BAD_INPUT_DATA
on parameter failure,MBEDTLS_ERR_MD_ALLOC_FAILED
memory allocation failure.
int mbedtls_md_starts | ( | mbedtls_md_context_t * | ctx ) |
Prepare the context to digest a new message.
Generally called after mbedtls_md_setup() or mbedtls_md_finish(). Followed by mbedtls_md_update().
- Parameters:
-
ctx generic message digest context.
- Returns:
- 0 on success, MBEDTLS_ERR_MD_BAD_INPUT_DATA if parameter verification fails.
int mbedtls_md_update | ( | mbedtls_md_context_t * | ctx, |
const unsigned char * | input, | ||
size_t | ilen | ||
) |
Generic message digest process buffer Called between mbedtls_md_starts() and mbedtls_md_finish().
May be called repeatedly.
- Parameters:
-
ctx Generic message digest context input buffer holding the datal ilen length of the input data
- Returns:
- 0 on success, MBEDTLS_ERR_MD_BAD_INPUT_DATA if parameter verification fails.
Generated on Sun Jul 17 2022 08:25:35 by 1.7.2