security.h File Reference

Security interface header file. More...

#include "mcl_core/mcl_core_common.h"

Include dependency graph for security.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
MCL_LOCAL mcl_error_t	security_initialize (void)
MCL_LOCAL mcl_error_t	security_hash_sha256 (const mcl_uint8_t *data, mcl_size_t data_size, mcl_uint8_t **hash, mcl_size_t *hash_size)
MCL_LOCAL mcl_error_t	security_rsa_sign (char *rsa_key, char *data, mcl_size_t data_size, mcl_uint8_t **signature, mcl_size_t *signature_size)
MCL_LOCAL mcl_error_t	security_generate_rsa_key (char **public_key, char **private_key)
MCL_LOCAL mcl_error_t	security_rsa_get_modulus_and_exponent (char *public_key, char **modulus, char **exponent)
MCL_LOCAL mcl_error_t	security_generate_random_bytes (unsigned char *buffer, mcl_size_t size)

Detailed Description

Security interface header file.

This module contains security related functions like hashing, public/private key generation. Implementation file might change depending on the platform and will be in security_XXX.c format.

Copyright

Copyright (C) 2019 Siemens Aktiengesellschaft.
All rights reserved.

Definition in file security.h.

Function Documentation

MCL_LOCAL mcl_error_t security_generate_random_bytes	(	unsigned char *	buffer,
		mcl_size_t	size
	)

This function is used to generate random bytes.

Parameters

[out]	buffer	Buffer which will be filled with random bytes.
[in]	size	Size of the buffer.

Returns

• MCL_OK in case of success.
• MCL_FAIL in case of an internal error in MCL.

Definition at line 88 of file security_mbedtls.c.

References ctr_drbg, is_initialized, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FAIL, and MCL_OK.

Referenced by _generate_correlation_id_string(), mcl_random_generate_bytes(), random_generate_guid(), and random_generate_number().

Here is the caller graph for this function:

MCL_LOCAL mcl_error_t security_generate_rsa_key	(	char **	public_key,
		char **	private_key
	)

This function is used to generate the RSA public/private keys.

Generated keys will be returned as out parameters.

Parameters

[out]	public_key	Generated public key. New memory space will be allocated for this parameter.
[out]	private_key	Generated private key. New memory space will be allocated for this parameter.

Returns

• MCL_OK in case of success.
• MCL_OUT_OF_MEMORY in case there is not enough memory in the system to proceed.
• MCL_FAIL in case of an internal error in MCL.

Definition at line 78 of file security_mbedtls.c.

References _get_rsa_private_key(), _get_rsa_public_key(), KEY_LENGTH_BITS, MCL_ASSERT_CODE_MESSAGE, MCL_ASSERT_STATEMENT_CODE_MESSAGE, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FAIL, MCL_FREE, MCL_NULL, MCL_OK, and MCL_OUT_OF_MEMORY.

Referenced by security_handler_generate_rsa_key().

Here is the call graph for this function:

Here is the caller graph for this function:

MCL_LOCAL mcl_error_t security_hash_sha256	(	const mcl_uint8_t *	data,
		mcl_size_t	data_size,
		mcl_uint8_t **	hash,
		mcl_size_t *	hash_size
	)

This function is used to generate the sha256 hash of the given data.

See also

security_handler_hash_sha256.

Definition at line 45 of file security_mbedtls.c.

References MCL_ASSERT_CODE_MESSAGE, MCL_CALLOC, MCL_DEBUG, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_NULL, MCL_OK, MCL_OUT_OF_MEMORY, and SHA256_DIGEST_LENGTH.

Referenced by hmac_sha256(), security_handler_hash_sha256(), and security_rsa_sign().

Here is the caller graph for this function:

MCL_LOCAL mcl_error_t security_initialize

(

void

)

This function is used to initialize security implementation.

Returns

• MCL_OK in case of success.
• MCL_FAIL in case of an internal error in MCL.

Definition at line 27 of file security_mbedtls.c.

References _libcrypto_free(), _libcrypto_malloc(), _libcrypto_realloc(), ctr_drbg, entropy, is_initialized, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FAIL, MCL_NULL, MCL_OK, and MCL_TRUE.

Referenced by core_processor_initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

MCL_LOCAL mcl_error_t security_rsa_get_modulus_and_exponent	(	char *	public_key,
		char **	modulus,
		char **	exponent
	)

This function is used to get the modulus (n) and public exponent (e) parameters of RSA key in base64 format.

Parameters

public_key	Public key in PEM format.
modulus	Base64 encoded modulus of RSA key.
exponent	Base64 encoded public exponent of RSA key.

Returns

• MCL_OK in case of success.
• MCL_OUT_OF_MEMORY in case there is not enough memory in the system to proceed.
• MCL_FAIL in case of an internal error in MCL.

Definition at line 83 of file security_mbedtls.c.

References _base64_encode_big_number(), MCL_ASSERT_CODE_MESSAGE, MCL_ASSERT_STATEMENT_CODE_MESSAGE, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FAIL, MCL_FREE, MCL_NULL, MCL_OK, MCL_OUT_OF_MEMORY, and string_util_strlen().

Referenced by _add_jwks().

Here is the call graph for this function:

Here is the caller graph for this function:

MCL_LOCAL mcl_error_t security_rsa_sign	(	char *	rsa_key,
		char *	data,
		mcl_size_t	data_size,
		mcl_uint8_t **	signature,
		mcl_size_t *	signature_size
	)

This function is used to sign data with RSA key.

Received key will be used to sign.

Parameters

[in]	rsa_key	Private key to be used in signing.
[in]	data	The data to be signed.
[in]	data_size	Size of the data.
[out]	signature	Generated signature.
[out]	signature_size	Size of signature.

Returns

• MCL_OK in case of success.
• MCL_OUT_OF_MEMORY in case there is not enough memory in the system to proceed.
• MCL_FAIL in case of an internal error in MCL.

Definition at line 73 of file security_mbedtls.c.

References MCL_ASSERT_CODE_MESSAGE, MCL_ASSERT_STATEMENT_CODE_MESSAGE, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FAIL, MCL_FALSE, MCL_FREE, MCL_MALLOC, MCL_NULL, MCL_OK, MCL_OUT_OF_MEMORY, MCL_TRUE, security_hash_sha256(), and string_util_strlen().

Referenced by security_handler_rsa_sign().

Here is the call graph for this function:

Here is the caller graph for this function: