Data Channel Cryptography SSL library-specific backend interface. More...

#include "crypto_openssl.h"
#include "basic.h"
#include "buffer.h"

Include dependency graph for crypto_backend.h:

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

Data Structures
struct	cipher_name_pair
	Struct used in cipher name translation table. More...

Macros
#define	OPENVPN_AEAD_TAG_LENGTH 16

#define	OPENVPN_MAX_CIPHER_BLOCK_SIZE 32

#define	OPENVPN_MAX_HMAC_SIZE 64

#define	MAX_CIPHER_KEY_LENGTH 64

#define	MAX_HMAC_KEY_LENGTH 64

Enumerations
enum	hash_algo_type { MD_SHA1 , MD_SHA256 }
	Types referencing specific message digest hashing algorithms. More...

Functions
void	crypto_init_lib (void)

void	crypto_uninit_lib (void)

void	crypto_clear_error (void)

void	crypto_init_lib_engine (const char *engine_name)

provider_t *	crypto_load_provider (const char *provider)
	Load the given (OpenSSL) providers.

void	crypto_unload_provider (const char provname, provider_t provider)
	Unloads the given (OpenSSL) provider.

void	show_available_ciphers (void)

void	show_available_digests (void)

void	show_available_engines (void)

bool	crypto_pem_encode (const char name, struct buffer dst, const struct buffer src, struct gc_arena gc)
	Encode binary data as PEM.

bool	crypto_pem_decode (const char name, struct buffer dst, const struct buffer *src)
	Decode a PEM buffer to binary data.

int	rand_bytes (uint8_t *output, int len)
	Wrapper for secure random number generator.

bool	cipher_valid_reason (const char ciphername, const char *reason)
	Returns if the cipher is valid, based on the given cipher name and provides a reason if invalid.

static bool	cipher_valid (const char *ciphername)
	Returns if the cipher is valid, based on the given cipher name.

static bool	cipher_defined (const char *ciphername)
	Checks if the cipher is defined and is not the null (none) cipher.

const char *	cipher_kt_name (const char *ciphername)
	Retrieve a normalised string describing the cipher (e.g.

int	cipher_kt_key_size (const char *ciphername)
	Returns the size of keys used by the cipher, in bytes.

int	cipher_kt_iv_size (const char *ciphername)
	Returns the size of the IV used by the cipher, in bytes, or 0 if no IV is used.

int	cipher_kt_block_size (const char *ciphername)
	Returns the block size of the cipher, in bytes.

int	cipher_kt_tag_size (const char *ciphername)
	Returns the MAC tag size of the cipher, in bytes.

bool	cipher_kt_insecure (const char *ciphername)
	Returns true if we consider this cipher to be insecure.

bool	cipher_kt_mode_cbc (const char *ciphername)
	Check if the supplied cipher is a supported CBC mode cipher.

bool	cipher_kt_mode_ofb_cfb (const char *ciphername)
	Check if the supplied cipher is a supported OFB or CFB mode cipher.

bool	cipher_kt_mode_aead (const char *ciphername)
	Check if the supplied cipher is a supported AEAD mode cipher.

cipher_ctx_t *	cipher_ctx_new (void)
	Generic cipher functions.

void	cipher_ctx_free (cipher_ctx_t *ctx)
	Cleanup and free a cipher context.

void	cipher_ctx_init (cipher_ctx_t ctx, const uint8_t key, const char *ciphername, crypto_operation_t enc)
	Initialise a cipher context, based on the given key and key type.

int	cipher_ctx_iv_length (const cipher_ctx_t *ctx)
	Returns the size of the IV used by the cipher, in bytes, or 0 if no IV is used.

int	cipher_ctx_get_tag (cipher_ctx_t ctx, uint8_t tag, int tag_len)
	Gets the computed message authenticated code (MAC) tag for this cipher.

int	cipher_ctx_block_size (const cipher_ctx_t *ctx)
	Returns the block size of the cipher, in bytes.

int	cipher_ctx_mode (const cipher_ctx_t *ctx)
	Returns the mode that the cipher runs in.

bool	cipher_ctx_mode_cbc (const cipher_ctx_t *ctx)
	Check if the supplied cipher is a supported CBC mode cipher.

bool	cipher_ctx_mode_ofb_cfb (const cipher_ctx_t *ctx)
	Check if the supplied cipher is a supported OFB or CFB mode cipher.

bool	cipher_ctx_mode_aead (const cipher_ctx_t *ctx)
	Check if the supplied cipher is a supported AEAD mode cipher.

int	cipher_ctx_reset (cipher_ctx_t ctx, const uint8_t iv_buf)
	Resets the given cipher context, setting the IV to the specified value.

int	cipher_ctx_update_ad (cipher_ctx_t ctx, const uint8_t src, int src_len)
	Updates the given cipher context, providing additional data (AD) for authenticated encryption with additional data (AEAD) cipher modes.

int	cipher_ctx_update (cipher_ctx_t ctx, uint8_t dst, int dst_len, uint8_t src, int src_len)
	Updates the given cipher context, encrypting data in the source buffer, and placing any complete blocks in the destination buffer.

int	cipher_ctx_final (cipher_ctx_t ctx, uint8_t dst, int *dst_len)
	Pads the final cipher block using PKCS padding, and output to the destination buffer.

int	cipher_ctx_final_check_tag (cipher_ctx_t ctx, uint8_t dst, int dst_len, uint8_t tag, size_t tag_len)
	Like `cipher_ctx_final`, but check the computed authentication tag against the supplied (expected) tag.

static bool	md_defined (const char *mdname)
	Checks if the cipher is defined and is not the null (none) cipher.

bool	md_valid (const char *digest)
	Return if a message digest parameters is valid given the name of the digest.

const char *	md_kt_name (const char *mdname)
	Retrieve a string describing the digest digest (e.g.

unsigned char	md_kt_size (const char *mdname)
	Returns the size of the message digest, in bytes.

int	md_full (const char mdname, const uint8_t src, int src_len, uint8_t *dst)
	Calculates the message digest for the given buffer.

md_ctx_t *	md_ctx_new (void)

void	md_ctx_free (md_ctx_t *ctx)

void	md_ctx_init (md_ctx_t ctx, const char mdname)
	Initialises the given message digest context.

void	md_ctx_cleanup (md_ctx_t *ctx)

int	md_ctx_size (const md_ctx_t *ctx)

void	md_ctx_update (md_ctx_t ctx, const uint8_t src, int src_len)

void	md_ctx_final (md_ctx_t ctx, uint8_t dst)

hmac_ctx_t *	hmac_ctx_new (void)

void	hmac_ctx_free (hmac_ctx_t *ctx)

void	hmac_ctx_init (hmac_ctx_t ctx, const uint8_t key, const char *mdname)

void	hmac_ctx_cleanup (hmac_ctx_t *ctx)

int	hmac_ctx_size (hmac_ctx_t *ctx)

void	hmac_ctx_reset (hmac_ctx_t *ctx)

void	hmac_ctx_update (hmac_ctx_t ctx, const uint8_t src, int src_len)

void	hmac_ctx_final (hmac_ctx_t ctx, uint8_t dst)

const char *	translate_cipher_name_from_openvpn (const char *cipher_name)
	Translate an OpenVPN cipher name to a crypto library cipher name.

const char *	translate_cipher_name_to_openvpn (const char *cipher_name)
	Translate a crypto library cipher name to an OpenVPN cipher name.

bool	ssl_tls1_PRF (const uint8_t seed, int seed_len, const uint8_t secret, int secret_len, uint8_t *output, int output_len)
	Calculates the TLS 1.0-1.1 PRF function.

Variables
const cipher_name_pair	cipher_name_translation_table []
	Cipher name translation table.

const size_t	cipher_name_translation_table_count

Detailed Description

Data Channel Cryptography SSL library-specific backend interface.

Definition in file crypto_backend.h.

Macro Definition Documentation

◆ MAX_CIPHER_KEY_LENGTH

#define MAX_CIPHER_KEY_LENGTH 64

Definition at line 178 of file crypto_backend.h.

◆ MAX_HMAC_KEY_LENGTH

#define MAX_HMAC_KEY_LENGTH 64

Definition at line 496 of file crypto_backend.h.

◆ OPENVPN_AEAD_TAG_LENGTH

#define OPENVPN_AEAD_TAG_LENGTH 16

Definition at line 43 of file crypto_backend.h.

◆ OPENVPN_MAX_CIPHER_BLOCK_SIZE

#define OPENVPN_MAX_CIPHER_BLOCK_SIZE 32

Definition at line 46 of file crypto_backend.h.

◆ OPENVPN_MAX_HMAC_SIZE

#define OPENVPN_MAX_HMAC_SIZE 64

Definition at line 49 of file crypto_backend.h.

Enumeration Type Documentation

◆ hash_algo_type

enum hash_algo_type

Types referencing specific message digest hashing algorithms.

Enumerator
MD_SHA1
MD_SHA256

Definition at line 52 of file crypto_backend.h.

Function Documentation

◆ cipher_ctx_block_size()

int cipher_ctx_block_size ( const cipher_ctx_t * ctx )

Returns the block size of the cipher, in bytes.

Parameters

ctx	The cipher's context

Returns: Block size, in bytes, or 0 if ctx was NULL.

Referenced by openvpn_decrypt_aead(), openvpn_decrypt_v1(), openvpn_encrypt_aead(), openvpn_encrypt_v1(), and tls_crypt_v2_wrap_client_key().

◆ cipher_ctx_final()

int cipher_ctx_final	(	cipher_ctx_t *	ctx,
		uint8_t *	dst,
		int *	dst_len
	)

Pads the final cipher block using PKCS padding, and output to the destination buffer.

Parameters

ctx	Cipher's context. May not be NULL.
dst	Destination buffer
dst_len	Length of the destination buffer, in bytes

Returns: 0 on failure, 1 on success.

Referenced by openvpn_decrypt_v1(), openvpn_encrypt_aead(), openvpn_encrypt_v1(), tls_crypt_unwrap(), tls_crypt_v2_unwrap_client_key(), tls_crypt_v2_wrap_client_key(), and tls_crypt_wrap().

◆ cipher_ctx_final_check_tag()

int cipher_ctx_final_check_tag	(	cipher_ctx_t *	ctx,
		uint8_t *	dst,
		int *	dst_len,
		uint8_t *	tag,
		size_t	tag_len
	)

Like cipher_ctx_final, but check the computed authentication tag against the supplied (expected) tag.

This function reports failure when the tags don't match.

Parameters

ctx	Cipher's context. May not be NULL.
dst	Destination buffer.
dst_len	Length of the destination buffer, in bytes.
tag	The expected authentication tag.
tag_len	The length of tag, in bytes.

Returns: 0 on failure, 1 on success.

Referenced by openvpn_decrypt_aead().

◆ cipher_ctx_free()

void cipher_ctx_free ( cipher_ctx_t * ctx )

Cleanup and free a cipher context.

Parameters

ctx	Cipher context.

Referenced by free_key_ctx().

◆ cipher_ctx_get_tag()

int cipher_ctx_get_tag	(	cipher_ctx_t *	ctx,
		uint8_t *	tag,
		int	tag_len
	)

Gets the computed message authenticated code (MAC) tag for this cipher.

Parameters

ctx	The cipher's context
tag	The buffer to write computed tag in.
tag_len	The tag buffer size, in bytes.

Referenced by openvpn_encrypt_aead().

◆ cipher_ctx_init()

void cipher_ctx_init	(	cipher_ctx_t *	ctx,
		const uint8_t *	key,
		const char *	ciphername,
		crypto_operation_t	enc
	)

Initialise a cipher context, based on the given key and key type.

Parameters

ctx	Cipher context. May not be NULL
key	Buffer containing the key to use
ciphername	Ciphername of the cipher to use
enc	Whether to encrypt or decrypt (either `OPENVPN_OP_ENCRYPT` or `OPENVPN_OP_DECRYPT`).

Referenced by init_key_ctx().

◆ cipher_ctx_iv_length()

int cipher_ctx_iv_length ( const cipher_ctx_t * ctx )

Returns the size of the IV used by the cipher, in bytes, or 0 if no IV is used.

Parameters

ctx	The cipher's context

Returns: Size of the IV, in bytes, or 0 if the cipher does not use an IV.

Referenced by key_ctx_update_implicit_iv(), openvpn_decrypt_aead(), openvpn_decrypt_v1(), openvpn_encrypt_aead(), openvpn_encrypt_v1(), and test_crypto().

◆ cipher_ctx_mode()

int cipher_ctx_mode ( const cipher_ctx_t * ctx )

Returns the mode that the cipher runs in.

Parameters

ctx	Cipher's context. May not be NULL.

Returns: Cipher mode, either OPENVPN_MODE_CBC, OPENVPN_MODE_OFB or OPENVPN_MODE_CFB

Referenced by openvpn_encrypt_v1().

◆ cipher_ctx_mode_aead()

bool cipher_ctx_mode_aead ( const cipher_ctx_t * ctx )

Check if the supplied cipher is a supported AEAD mode cipher.

Parameters

ctx	Cipher's context. May not be NULL.

Returns: true iff the cipher is a AEAD mode cipher.

Definition at line 940 of file crypto_openssl.c.

Referenced by key_ctx_update_implicit_iv(), openvpn_decrypt(), openvpn_encrypt(), and test_crypto().

◆ cipher_ctx_mode_cbc()

bool cipher_ctx_mode_cbc ( const cipher_ctx_t * ctx )

Check if the supplied cipher is a supported CBC mode cipher.

Parameters

ctx	Cipher's context. May not be NULL.

Returns: true iff the cipher is a CBC mode cipher.

Definition at line 906 of file crypto_openssl.c.

Referenced by openvpn_decrypt_v1(), and openvpn_encrypt_v1().

◆ cipher_ctx_mode_ofb_cfb()

bool cipher_ctx_mode_ofb_cfb ( const cipher_ctx_t * ctx )

Check if the supplied cipher is a supported OFB or CFB mode cipher.

Parameters

ctx	Cipher's context. May not be NULL.

Returns: true iff the cipher is a OFB or CFB mode cipher.

Definition at line 925 of file crypto_openssl.c.

References EVP_CIPHER_CTX_get_mode.

Referenced by openvpn_decrypt_v1(), and openvpn_encrypt_v1().

◆ cipher_ctx_new()

cipher_ctx_t * cipher_ctx_new ( void )

Generic cipher functions.

Allocate a new cipher context

Returns: a new cipher context

Definition at line 849 of file crypto_openssl.c.

References check_malloc_return().

Referenced by init_key_ctx().

◆ cipher_ctx_reset()

int cipher_ctx_reset	(	cipher_ctx_t *	ctx,
		const uint8_t *	iv_buf
	)

Resets the given cipher context, setting the IV to the specified value.

Preserves the associated key information.

Parameters

ctx	Cipher's context. May not be NULL.
iv_buf	The IV to use.

Returns: 0 on failure, 1 on success.

Referenced by openvpn_decrypt_aead(), openvpn_decrypt_v1(), openvpn_encrypt_aead(), openvpn_encrypt_v1(), tls_crypt_unwrap(), tls_crypt_v2_unwrap_client_key(), tls_crypt_v2_wrap_client_key(), and tls_crypt_wrap().

◆ cipher_ctx_update()

int cipher_ctx_update	(	cipher_ctx_t *	ctx,
		uint8_t *	dst,
		int *	dst_len,
		uint8_t *	src,
		int	src_len
	)

Updates the given cipher context, encrypting data in the source buffer, and placing any complete blocks in the destination buffer.

Note that if a complete block cannot be written, data is cached in the context, and emitted at a later call to cipher_ctx_update, or by a call to cipher_ctx_final(). This implies that dst should have enough room for src_len + cipher_ctx_block_size().

Parameters

ctx	Cipher's context. May not be NULL.
dst	Destination buffer
dst_len	Length of the destination buffer, in bytes
src	Source buffer
src_len	Length of the source buffer, in bytes

Returns: 0 on failure, 1 on success.

Referenced by openvpn_decrypt_aead(), openvpn_decrypt_v1(), openvpn_encrypt_aead(), openvpn_encrypt_v1(), tls_crypt_unwrap(), tls_crypt_v2_unwrap_client_key(), tls_crypt_v2_wrap_client_key(), and tls_crypt_wrap().

◆ cipher_ctx_update_ad()

int cipher_ctx_update_ad	(	cipher_ctx_t *	ctx,
		const uint8_t *	src,
		int	src_len
	)

Updates the given cipher context, providing additional data (AD) for authenticated encryption with additional data (AEAD) cipher modes.

Parameters

ctx	Cipher's context. May not be NULL.
src	Source buffer
src_len	Length of the source buffer, in bytes

Returns: 0 on failure, 1 on success.

Referenced by openvpn_decrypt_aead(), and openvpn_encrypt_aead().

◆ cipher_defined()

static bool cipher_defined ( const char * ciphername )

inlinestatic

Checks if the cipher is defined and is not the null (none) cipher.

Parameters

ciphername Name of the cipher to check if it is defined, may not be NULL

Returns: The cipher is defined and not the null (none) cipher

Definition at line 219 of file crypto_backend.h.

References ASSERT.

Referenced by calculate_crypto_overhead(), check_key(), create_kt(), init_key_ctx(), options_string(), and p2p_mode_ncp().

◆ cipher_kt_block_size()

int cipher_kt_block_size ( const char * ciphername )

Returns the block size of the cipher, in bytes.

Parameters

ciphername cipher name

Returns: Block size, in bytes.

Definition at line 698 of file crypto_openssl.c.

References cipher_get(), cleanup(), EVP_CIPHER_fetch(), EVP_CIPHER_free(), string_alloc(), translate_cipher_name_from_openvpn(), and translate_cipher_name_to_openvpn().

Referenced by adjust_payload_max_cbc(), calculate_crypto_overhead(), cipher_kt_insecure(), init_key_ctx(), init_key_type(), print_cipher(), and warn_insecure_key_type().

◆ cipher_kt_insecure()

bool cipher_kt_insecure ( const char * ciphername )

Returns true if we consider this cipher to be insecure.

Definition at line 760 of file crypto_openssl.c.

References cipher_get(), cipher_kt_block_size(), and EVP_CIPHER_free().

Referenced by show_available_ciphers(), tls_limit_reneg_bytes(), and warn_insecure_key_type().

◆ cipher_kt_iv_size()

int cipher_kt_iv_size ( const char * ciphername )

Returns the size of the IV used by the cipher, in bytes, or 0 if no IV is used.

Parameters

ciphername cipher name to lookup

Returns: Size of the IV, in bytes, or 0 if the cipher does not use an IV.

Definition at line 689 of file crypto_openssl.c.

References cipher_get(), and EVP_CIPHER_free().

Referenced by calculate_crypto_overhead(), epoch_data_key_derive(), and init_key_ctx().

◆ cipher_kt_key_size()

int cipher_kt_key_size ( const char * ciphername )

Returns the size of keys used by the cipher, in bytes.

If the cipher has a variable key size, return the default key size.

Parameters

ciphername Cipher name to lookup

Returns: (Default) size of keys used by the cipher, in bytes.

Definition at line 680 of file crypto_openssl.c.

References cipher_get(), and EVP_CIPHER_free().

Referenced by dco_new_key(), epoch_data_key_derive(), init_key_ctx(), key_is_zero(), key_print(), options_string(), and print_cipher().

◆ cipher_kt_mode_aead()

bool cipher_kt_mode_aead ( const char * ciphername )

Check if the supplied cipher is a supported AEAD mode cipher.

Parameters

ciphername name of the cipher

Returns: true iff the cipher is a AEAD mode cipher.

Definition at line 817 of file crypto_openssl.c.

References cipher_get(), EVP_CIPHER_free(), and OPENVPN_MODE_GCM.

Referenced by calculate_crypto_overhead(), cipher_get_aead_limits(), cipher_kt_tag_size(), collect_ciphers(), init_key_contexts(), init_key_type(), multi_client_set_protocol_options(), mutate_ncp_cipher_list(), p2p_ncp_set_options(), and tls_print_deferred_options_results().

◆ cipher_kt_mode_cbc()

bool cipher_kt_mode_cbc ( const char * ciphername )

Check if the supplied cipher is a supported CBC mode cipher.

Parameters

ciphername cipher name

Returns: true iff the cipher is a CBC mode cipher.

Definition at line 790 of file crypto_openssl.c.

References cipher_get(), cipher_kt_mode(), EVP_CIPHER_free(), and OPENVPN_MODE_CBC.

Referenced by adjust_payload_max_cbc(), calculate_crypto_overhead(), collect_ciphers(), frame_calculate_fragment(), frame_calculate_payload_overhead(), init_key_type(), mutate_ncp_cipher_list(), and print_cipher().

◆ cipher_kt_mode_ofb_cfb()

bool cipher_kt_mode_ofb_cfb ( const char * ciphername )

Check if the supplied cipher is a supported OFB or CFB mode cipher.

Parameters

ciphername cipher name

Returns: true iff the cipher is a OFB or CFB mode cipher.

Definition at line 805 of file crypto_openssl.c.

References cipher_get(), cipher_kt_mode(), EVP_CIPHER_free(), OPENVPN_MODE_CFB, and OPENVPN_MODE_OFB.

Referenced by calc_packet_id_size_dc(), collect_ciphers(), do_init_crypto_tls(), init_key_type(), mutate_ncp_cipher_list(), and tls_session_update_crypto_params_do_work().

◆ cipher_kt_name()

const char * cipher_kt_name ( const char * ciphername )

Retrieve a normalised string describing the cipher (e.g.

AES-128-CBC). The returned name is normalised to the OpenVPN config name in case the name differs from the name used by the crypto library.

Returns [null-cipher] in case the ciphername is none. NULL if the cipher is not valid.

Parameters

ciphername Name of the cipher

Returns: a statically allocated string describing the cipher.

Definition at line 660 of file crypto_openssl.c.

References ASSERT, cipher_get(), EVP_CIPHER_free(), and translate_cipher_name_to_openvpn().

Referenced by cipher_get_aead_limits(), init_key_contexts(), init_key_ctx(), key_print(), mutate_ncp_cipher_list(), options_string(), p2p_mode_ncp(), print_cipher(), test_translate_cipher(), and tls_print_deferred_options_results().

◆ cipher_kt_tag_size()

int cipher_kt_tag_size ( const char * ciphername )

Returns the MAC tag size of the cipher, in bytes.

Parameters

ciphername Name of the cipher

Returns: Tag size in bytes, or 0 if the tag size could not be determined.

Definition at line 747 of file crypto_openssl.c.

References cipher_kt_mode_aead(), and OPENVPN_AEAD_TAG_LENGTH.

Referenced by calculate_crypto_overhead().

◆ cipher_valid()

static bool cipher_valid ( const char * ciphername )

inlinestatic

Returns if the cipher is valid, based on the given cipher name.

Parameters

ciphername Name of the cipher to check for validity (e.g. AES-128-CBC). Will be translated to the library name from the openvpn config name if needed.

Returns: if the cipher is valid

Definition at line 205 of file crypto_backend.h.

References cipher_valid_reason().

Referenced by create_kt(), init_key_type(), mutate_ncp_cipher_list(), options_postprocess_setdefault_ncpciphers(), test_check_ncp_ciphers_list(), test_data_channel_roundtrip_bf_cbc(), test_data_channel_roundtrip_chacha20_poly1305(), test_data_channel_roundtrip_chacha20_poly1305_epoch(), test_ncp_default(), test_ncp_expand(), and test_translate_cipher().

◆ cipher_valid_reason()

bool cipher_valid_reason	(	const char *	ciphername,
		const char **	reason
	)

Returns if the cipher is valid, based on the given cipher name and provides a reason if invalid.

Parameters

ciphername	Name of the cipher to check for validity (e.g. `AES-128-CBC`). Will be translated to the library name from the openvpn config name if needed.
reason	Pointer where a static string indicating the reason for rejecting the cipher should be stored. It is set to NULL if the cipher is valid.

Returns: if the cipher is valid

Definition at line 619 of file crypto_openssl.c.

References cipher_get(), crypto_msg, D_LOW, EVP_CIPHER_free(), MAX_CIPHER_KEY_LENGTH, msg, and PACKAGE_NAME.

Referenced by cipher_valid(), and print_cipher().

◆ crypto_clear_error()

void crypto_clear_error ( void )

Definition at line 230 of file crypto_openssl.c.

Referenced by openvpn_decrypt_aead(), openvpn_decrypt_v1(), openvpn_encrypt_aead(), openvpn_encrypt_v1(), tls_crypt_unwrap(), and tls_crypt_wrap().

◆ crypto_init_lib()

void crypto_init_lib ( void )

Definition at line 195 of file crypto_openssl.c.

Referenced by init_ssl_lib().

◆ crypto_init_lib_engine()

void crypto_init_lib_engine ( const char * engine_name )

Definition at line 145 of file crypto_openssl.c.

References ASSERT, M_WARN, and msg.

Referenced by init_crypto_pre().

◆ crypto_load_provider()

provider_t * crypto_load_provider ( const char * provider )

Load the given (OpenSSL) providers.

Parameters

provider name of providers to load

Returns: reference to the loaded provider

Definition at line 161 of file crypto_openssl.c.

References crypto_msg, M_FATAL, M_WARN, and msg.

Referenced by init_early(), and main().

◆ crypto_pem_decode()

bool crypto_pem_decode	(	const char *	name,
		struct buffer *	dst,
		const struct buffer *	src
	)

Decode a PEM buffer to binary data.

Parameters

name	The name expected in the PEM header/footer.
dst	Destination buffer for decoded data.
src	Source buffer (PEM data).

Returns: true iff PEM decode succeeded.

Definition at line 531 of file crypto_openssl.c.

References BCAP, BLEN, BPTR, buf_write_alloc(), cleanup(), crypto_msg, D_CRYPT_ERRORS, dmsg, and M_FATAL.

Referenced by crypto_pem_encode_decode_loopback(), and read_pem_key_file().

◆ crypto_pem_encode()

bool crypto_pem_encode	(	const char *	name,
		struct buffer *	dst,
		const struct buffer *	src,
		struct gc_arena *	gc
	)

Encode binary data as PEM.

Parameters

name	The name to use in the PEM header/footer.
dst	Destination buffer for PEM-encoded data. Must be a valid pointer to an uninitialized buffer structure. Iff this function returns true, the buffer will contain memory allocated through the supplied gc.
src	Source buffer.
gc	The garbage collector to use when allocating memory for dst.

Returns: true iff PEM encode succeeded.

Definition at line 503 of file crypto_openssl.c.

References alloc_buf_gc(), ASSERT, BLEN, BPTR, buf_write(), cleanup(), buffer::data, and gc.

Referenced by crypto_pem_encode_decode_loopback(), tls_crypt_v2_write_client_key_file(), and write_pem_key_file().

◆ crypto_uninit_lib()

void crypto_uninit_lib ( void )

Definition at line 210 of file crypto_openssl.c.

References ASSERT.

Referenced by free_ssl_lib().

◆ crypto_unload_provider()

void crypto_unload_provider	(	const char *	provname,
		provider_t *	provider
	)

Unloads the given (OpenSSL) provider.

Parameters

provname	name of the provider to unload
provider	pointer to the provider to unload

Definition at line 178 of file crypto_openssl.c.

References crypto_msg, and M_FATAL.

Referenced by main(), and uninit_early().

◆ hmac_ctx_cleanup()

void hmac_ctx_cleanup ( hmac_ctx_t * ctx )

Referenced by crypto_test_hmac(), free_key_ctx(), gen_hmac_md5(), ovpn_hkdf_expand(), test_calc_session_id_hmac_static(), test_verify_hmac_none(), and test_verify_hmac_tls_auth().

◆ hmac_ctx_final()

void hmac_ctx_final	(	hmac_ctx_t *	ctx,
		uint8_t *	dst
	)

Referenced by calculate_session_id_hmac(), check_hmac_token(), crypto_test_hmac(), gen_hmac_md5(), generate_auth_token(), openvpn_decrypt_v1(), openvpn_encrypt_v1(), ovpn_hkdf_expand(), tls_crypt_unwrap(), tls_crypt_v2_unwrap_client_key(), tls_crypt_v2_wrap_client_key(), and tls_crypt_wrap().

◆ hmac_ctx_free()

void hmac_ctx_free ( hmac_ctx_t * ctx )

Referenced by crypto_test_hmac(), free_key_ctx(), gen_hmac_md5(), ovpn_hkdf_expand(), test_calc_session_id_hmac_static(), test_verify_hmac_none(), and test_verify_hmac_tls_auth().

◆ hmac_ctx_init()

void hmac_ctx_init	(	hmac_ctx_t *	ctx,
		const uint8_t *	key,
		const char *	mdname
	)

Referenced by crypto_test_hmac(), gen_hmac_md5(), init_key_ctx(), init_static_hmac(), ovpn_hkdf_expand(), and session_id_hmac_init().

◆ hmac_ctx_new()

hmac_ctx_t * hmac_ctx_new ( void )

Definition at line 1187 of file crypto_openssl.c.

References check_malloc_return().

Referenced by crypto_test_hmac(), gen_hmac_md5(), init_key_ctx(), init_static_hmac(), ovpn_hkdf_expand(), and session_id_hmac_init().

◆ hmac_ctx_reset()

void hmac_ctx_reset ( hmac_ctx_t * ctx )

Referenced by calculate_session_id_hmac(), check_hmac_token(), crypto_test_hmac(), generate_auth_token(), openvpn_decrypt_v1(), openvpn_encrypt_v1(), ovpn_hkdf_expand(), tls_crypt_unwrap(), tls_crypt_v2_unwrap_client_key(), tls_crypt_v2_wrap_client_key(), and tls_crypt_wrap().

◆ hmac_ctx_size()

int hmac_ctx_size ( hmac_ctx_t * ctx )

Referenced by calc_control_channel_frame_overhead(), check_hmac_token(), generate_auth_token(), init_key_ctx(), openvpn_decrypt_v1(), openvpn_encrypt_v1(), swap_hmac(), and tls_crypt_wrap().

◆ hmac_ctx_update()

void hmac_ctx_update	(	hmac_ctx_t *	ctx,
		const uint8_t *	src,
		int	src_len
	)

Referenced by calculate_session_id_hmac(), check_hmac_token(), crypto_test_hmac(), gen_hmac_md5(), generate_auth_token(), openvpn_decrypt_v1(), openvpn_encrypt_v1(), ovpn_hkdf_expand(), tls_crypt_unwrap(), tls_crypt_v2_unwrap_client_key(), tls_crypt_v2_wrap_client_key(), and tls_crypt_wrap().

◆ md_ctx_cleanup()

void md_ctx_cleanup ( md_ctx_t * ctx )

Referenced by DigestCalcHA1(), DigestCalcResponse(), do_close_tls(), and process_incoming_push_reply().

◆ md_ctx_final()

void md_ctx_final	(	md_ctx_t *	ctx,
		uint8_t *	dst
	)

Referenced by DigestCalcHA1(), DigestCalcResponse(), and process_incoming_push_reply().

◆ md_ctx_free()

void md_ctx_free ( md_ctx_t * ctx )

Referenced by DigestCalcHA1(), DigestCalcResponse(), do_close_tls(), and process_incoming_push_reply().

◆ md_ctx_init()

void md_ctx_init	(	md_ctx_t *	ctx,
		const char *	mdname
	)

Initialises the given message digest context.

Parameters

ctx	Message digest context
mdname	Message digest name

Referenced by DigestCalcHA1(), DigestCalcResponse(), and process_incoming_push_reply().

◆ md_ctx_new()

md_ctx_t * md_ctx_new ( void )

Definition at line 1126 of file crypto_openssl.c.

References check_malloc_return().

Referenced by DigestCalcHA1(), DigestCalcResponse(), and process_incoming_push_reply().

◆ md_ctx_size()

int md_ctx_size ( const md_ctx_t * ctx )

◆ md_ctx_update()

void md_ctx_update	(	md_ctx_t *	ctx,
		const uint8_t *	src,
		int	src_len
	)

Referenced by DigestCalcHA1(), DigestCalcResponse(), and push_update_digest().

◆ md_defined()

static bool md_defined ( const char * mdname )

inlinestatic

Checks if the cipher is defined and is not the null (none) cipher.

Parameters

mdname Name of the digest

Returns

Definition at line 505 of file crypto_backend.h.

Referenced by calculate_crypto_overhead(), create_kt(), and init_key_ctx().

◆ md_full()

int md_full	(	const char *	mdname,
		const uint8_t *	src,
		int	src_len,
		uint8_t *	dst
	)

Calculates the message digest for the given buffer.

Parameters

mdname	message digest name
src	Buffer to digest. May not be NULL.
src_len	The length of the incoming buffer.
dst	Buffer to write the message digest to. May not be NULL.

Returns: 1 on success, 0 on failure

Definition at line 1115 of file crypto_openssl.c.

References EVP_MD_free(), and md_get().

Referenced by gen_md4_hash().

◆ md_kt_name()

const char * md_kt_name ( const char * mdname )

Retrieve a string describing the digest digest (e.g.

SHA1).

Parameters

mdname Message digest name

Returns: Statically allocated string describing the message digest.

Definition at line 1071 of file crypto_openssl.c.

References digest_name_translation_table, digest_name_translation_table_count, EVP_MD_free(), EVP_MD_get0_name, cipher_name_pair::lib_name, md_get(), and cipher_name_pair::openvpn_name.

Referenced by init_key_ctx(), key_print(), options_string(), print_digest(), and tls_print_deferred_options_results().

◆ md_kt_size()

unsigned char md_kt_size ( const char * mdname )

Returns the size of the message digest, in bytes.

Parameters

mdname Message digest name

Returns: Message digest size, in bytes, or 0 if ctx was NULL.

Definition at line 1095 of file crypto_openssl.c.

References EVP_MD_free(), and md_get().

Referenced by calculate_crypto_overhead(), crypto_test_hmac(), init_key_ctx(), init_key_type(), and key_print().

◆ md_valid()

bool md_valid ( const char * digest )

Return if a message digest parameters is valid given the name of the digest.

Parameters

digest Name of the digest to verify, e.g. MD5).

Returns: Whether a digest of the given name is available

Definition at line 1039 of file crypto_openssl.c.

References EVP_MD_fetch(), and EVP_MD_free().

Referenced by create_kt(), do_init_tls_wrap_key(), init_static_hmac(), main(), and session_id_hmac_init().

◆ rand_bytes()

int rand_bytes	(	uint8_t *	output,
		int	len
	)

Wrapper for secure random number generator.

Retrieves len bytes of random data, and places it in output.

Parameters

output	Output buffer
len	Length of the output buffer, in bytes

Returns: 1 on success, 0 on failure

Definition at line 593 of file crypto_openssl.c.

References crypto_msg, D_CRYPT_ERRORS, and unlikely.

Referenced by do_data_channel_round_trip(), encrypt_one_packet(), establish_http_proxy_passthru(), generate_auth_token(), generate_ephemeral_key(), generate_key_random(), init_crypto_options(), prng_bytes(), random_bytes_to_buf(), session_id_hmac_init(), test_crypto(), test_tls_crypt_v2_setup(), tls_crypt_v2_wrap_unwrap_dst_too_small(), tls_crypt_v2_wrap_unwrap_max_metadata(), tls_crypt_v2_write_client_key_file(), and write_pem_key_file().

◆ show_available_ciphers()

void show_available_ciphers ( void )

Definition at line 370 of file crypto_openssl.c.

References cipher_kt_insecure(), cipher_name_cmp(), EVP_CIPHER_get0_name, collect_ciphers::list, collect_ciphers::num, PACKAGE_NAME, and print_cipher().

Referenced by print_openssl_info().

◆ show_available_digests()

void show_available_digests ( void )

Definition at line 437 of file crypto_openssl.c.

References PACKAGE_NAME, and print_digest().

Referenced by print_openssl_info().

◆ show_available_engines()

void show_available_engines ( void )

Definition at line 478 of file crypto_openssl.c.

Referenced by print_openssl_info().

◆ ssl_tls1_PRF()

bool ssl_tls1_PRF	(	const uint8_t *	seed,
		int	seed_len,
		const uint8_t *	secret,
		int	secret_len,
		uint8_t *	output,
		int	output_len
	)

Calculates the TLS 1.0-1.1 PRF function.

For the exact specification of the function definition see the TLS RFCs like RFC 4346.

Parameters

seed	seed to use
seed_len	length of the seed
secret	secret to use
secret_len	length of the secret
output	output destination
output_len	length of output/number of bytes to generate

Returns: true if successful, false on any error

Definition at line 1410 of file crypto_openssl.c.

Referenced by check_tls_prf_working(), crypto_test_tls_prf(), and openvpn_PRF().

◆ translate_cipher_name_from_openvpn()

const char * translate_cipher_name_from_openvpn ( const char * cipher_name )

Translate an OpenVPN cipher name to a crypto library cipher name.

Parameters

cipher_name An OpenVPN cipher name

Returns: The corresponding crypto library cipher name, or NULL if no matching cipher name was found.

Definition at line 1820 of file crypto.c.

References get_cipher_name_pair(), and cipher_name_pair::lib_name.

Referenced by cipher_get(), and cipher_kt_block_size().

◆ translate_cipher_name_to_openvpn()

const char * translate_cipher_name_to_openvpn ( const char * cipher_name )

Translate a crypto library cipher name to an OpenVPN cipher name.

Parameters

cipher_name A crypto library cipher name

Returns: The corresponding OpenVPN cipher name, or NULL if no matching cipher name was found.

Definition at line 1833 of file crypto.c.

References get_cipher_name_pair(), and cipher_name_pair::openvpn_name.

Referenced by cipher_kt_block_size(), cipher_kt_name(), and multi_print_status().

Variable Documentation

◆ cipher_name_translation_table

const cipher_name_pair cipher_name_translation_table[]

extern

Cipher name translation table.

Definition at line 317 of file crypto_openssl.c.

Referenced by get_cipher_name_pair().

◆ cipher_name_translation_table_count

const size_t cipher_name_translation_table_count

extern

Definition at line 323 of file crypto_openssl.c.

Referenced by get_cipher_name_pair().

Data Structures

Macros

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ MAX_CIPHER_KEY_LENGTH

◆ MAX_HMAC_KEY_LENGTH

◆ OPENVPN_AEAD_TAG_LENGTH

◆ OPENVPN_MAX_CIPHER_BLOCK_SIZE

◆ OPENVPN_MAX_HMAC_SIZE

Enumeration Type Documentation

◆ hash_algo_type

Function Documentation

◆ cipher_ctx_block_size()

◆ cipher_ctx_final()

◆ cipher_ctx_final_check_tag()

◆ cipher_ctx_free()

◆ cipher_ctx_get_tag()

◆ cipher_ctx_init()

◆ cipher_ctx_iv_length()

◆ cipher_ctx_mode()

◆ cipher_ctx_mode_aead()

◆ cipher_ctx_mode_cbc()

◆ cipher_ctx_mode_ofb_cfb()

◆ cipher_ctx_new()

◆ cipher_ctx_reset()

◆ cipher_ctx_update()

◆ cipher_ctx_update_ad()

◆ cipher_defined()

◆ cipher_kt_block_size()

◆ cipher_kt_insecure()

◆ cipher_kt_iv_size()

◆ cipher_kt_key_size()

◆ cipher_kt_mode_aead()

◆ cipher_kt_mode_cbc()

◆ cipher_kt_mode_ofb_cfb()

◆ cipher_kt_name()

◆ cipher_kt_tag_size()

◆ cipher_valid()

◆ cipher_valid_reason()

◆ crypto_clear_error()

◆ crypto_init_lib()

◆ crypto_init_lib_engine()

◆ crypto_load_provider()

◆ crypto_pem_decode()

◆ crypto_pem_encode()

◆ crypto_uninit_lib()

◆ crypto_unload_provider()

◆ hmac_ctx_cleanup()

◆ hmac_ctx_final()

◆ hmac_ctx_free()

◆ hmac_ctx_init()

◆ hmac_ctx_new()

◆ hmac_ctx_reset()

◆ hmac_ctx_size()

◆ hmac_ctx_update()

◆ md_ctx_cleanup()

◆ md_ctx_final()

◆ md_ctx_free()

◆ md_ctx_init()

◆ md_ctx_new()

◆ md_ctx_size()

◆ md_ctx_update()

◆ md_defined()

◆ md_full()

◆ md_kt_name()

◆ md_kt_size()

◆ md_valid()

◆ rand_bytes()

◆ show_available_ciphers()

◆ show_available_digests()

◆ show_available_engines()

◆ ssl_tls1_PRF()

◆ translate_cipher_name_from_openvpn()

◆ translate_cipher_name_to_openvpn()

Variable Documentation

◆ cipher_name_translation_table

◆ cipher_name_translation_table_count