Control Channel SSL library backend module. More...

#include "buffer.h"
#include "ssl_openssl.h"
#include "ssl_verify_openssl.h"

Include dependency graph for ssl_backend.h:

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

Macros
#define	SSLAPI SSLAPI_OPENSSL

#define	TLS_VER_BAD -1
	Parse a TLS version specifier.

#define	TLS_VER_UNSPEC 0 /* default */

#define	TLS_VER_1_0 1

#define	TLS_VER_1_1 2

#define	TLS_VER_1_2 3

#define	TLS_VER_1_3 4

#define	EXPORT_KEY_DATA_LABEL "EXPORTER-OpenVPN-datakeys"

#define	EXPORT_P2P_PEERID_LABEL "EXPORTER-OpenVPN-p2p-peerid"

#define	EXPORT_DYNAMIC_TLS_CRYPT_LABEL "EXPORTER-OpenVPN-dynamic-tls-crypt"

Functions
int	pem_password_callback (char buf, int size, int rwflag, void u)
	Callback to retrieve the user's password.

void	tls_init_lib (void)
	Perform any static initialisation necessary by the library.

void	tls_free_lib (void)
	Free any global SSL library-specific data structures.

void	tls_clear_error (void)
	Clear the underlying SSL library's error state.

int	tls_version_parse (const char vstr, const char extra)

int	tls_version_max (void)
	Return the maximum TLS version (as a TLS_VER_x constant) supported by current SSL implementation.

void	tls_ctx_server_new (struct tls_root_ctx *ctx)
	Initialise a library-specific TLS context for a server.

void	tls_ctx_client_new (struct tls_root_ctx *ctx)
	Initialises a library-specific TLS context for a client.

void	tls_ctx_free (struct tls_root_ctx *ctx)
	Frees the library-specific TLSv1 context.

bool	tls_ctx_initialised (struct tls_root_ctx *ctx)
	Checks whether the given TLS context is initialised.

bool	tls_ctx_set_options (struct tls_root_ctx *ctx, unsigned int ssl_flags)
	Set any library specific options.

void	tls_ctx_restrict_ciphers (struct tls_root_ctx ctx, const char ciphers)
	Restrict the list of ciphers that can be used within the TLS context for TLS 1.2 and below.

void	tls_ctx_restrict_ciphers_tls13 (struct tls_root_ctx ctx, const char ciphers)
	Restrict the list of ciphers that can be used within the TLS context for TLS 1.3 and higher.

void	tls_ctx_set_cert_profile (struct tls_root_ctx ctx, const char profile)
	Set the TLS certificate profile.

void	tls_ctx_set_tls_groups (struct tls_root_ctx ctx, const char groups)
	Set the (elliptic curve) group allowed for signatures and key exchange.

void	tls_ctx_check_cert_time (const struct tls_root_ctx *ctx)
	Check our certificate notBefore and notAfter fields, and warn if the cert is either not yet valid or has expired.

void	tls_ctx_load_dh_params (struct tls_root_ctx ctx, const char dh_file, bool dh_file_inline)
	Load Diffie Hellman Parameters, and load them into the library-specific TLS context.

void	tls_ctx_load_ecdh_params (struct tls_root_ctx ctx, const char curve_name)
	Load Elliptic Curve Parameters, and load them into the library-specific TLS context.

int	tls_ctx_load_pkcs12 (struct tls_root_ctx ctx, const char pkcs12_file, bool pkcs12_file_inline, bool load_ca_file)
	Load PKCS #12 file for key, cert and (optionally) CA certs, and add to library-specific TLS context.

void	tls_ctx_load_cryptoapi (struct tls_root_ctx ctx, const char cryptoapi_cert)
	Use Windows cryptoapi for key and cert, and add to library-specific TLS context.

void	tls_ctx_load_cert_file (struct tls_root_ctx ctx, const char cert_file, bool cert_file_inline)
	Load certificate file into the given TLS context.

int	tls_ctx_load_priv_file (struct tls_root_ctx ctx, const char priv_key_file, bool priv_key_file_inline)
	Load private key file into the given TLS context.

int	tls_ctx_use_management_external_key (struct tls_root_ctx *ctx)
	Tell the management interface to load the given certificate and the external private key matching the given certificate.

void	tls_ctx_load_ca (struct tls_root_ctx ctx, const char ca_file, bool ca_file_inline, const char *ca_path, bool tls_server)
	Load certificate authority certificates from the given file or path.

void	tls_ctx_load_extra_certs (struct tls_root_ctx ctx, const char extra_certs_file, bool extra_certs_file_inline)
	Load extra certificate authority certificates from the given file or path.

void	key_state_ssl_init (struct key_state_ssl ks_ssl, const struct tls_root_ctx ssl_ctx, bool is_server, struct tls_session *session)
	Initialise the SSL channel part of the given key state.

void	key_state_ssl_shutdown (struct key_state_ssl *ks_ssl)
	Sets a TLS session to be shutdown state, so the TLS library will generate a shutdown alert.

void	key_state_ssl_free (struct key_state_ssl *ks_ssl)
	Free the SSL channel part of the given key state.

void	backend_tls_ctx_reload_crl (struct tls_root_ctx ssl_ctx, const char crl_file, bool crl_inline)
	Reload the Certificate Revocation List for the SSL channel.

bool	key_state_export_keying_material (struct tls_session session, const char label, size_t label_size, void *ekm, size_t ekm_size)
	Keying Material Exporters [RFC 5705] allows additional keying material to be derived from existing TLS channel.

void	print_details (struct key_state_ssl ks_ssl, const char prefix)
	Print a one line summary of SSL/TLS session handshake.

void	show_available_tls_ciphers_list (const char cipher_list, const char tls_cert_profile, bool tls13)
	Show the TLS ciphers that are available for us to use in the library depending on the TLS version.

void	show_available_curves (void)
	Show the available elliptic curves in the crypto library.

const char *	get_ssl_library_version (void)
	return a pointer to a static memory area containing the name and version number of the SSL library in use

Functions for packets to be sent to a remote OpenVPN peer
int	key_state_write_plaintext (struct key_state_ssl ks_ssl, struct buffer buf)
	Insert a plaintext buffer into the TLS module.

int	key_state_write_plaintext_const (struct key_state_ssl ks_ssl, const uint8_t data, int len)
	Insert plaintext data into the TLS module.

int	key_state_read_ciphertext (struct key_state_ssl ks_ssl, struct buffer buf)
	Extract ciphertext data from the TLS module.

Functions for packets received from a remote OpenVPN peer
int	key_state_write_ciphertext (struct key_state_ssl ks_ssl, struct buffer buf)
	Insert a ciphertext buffer into the TLS module.

int	key_state_read_plaintext (struct key_state_ssl ks_ssl, struct buffer buf)
	Extract plaintext data from the TLS module.

Detailed Description

Control Channel SSL library backend module.

Definition in file ssl_backend.h.

Macro Definition Documentation

◆ EXPORT_DYNAMIC_TLS_CRYPT_LABEL

#define EXPORT_DYNAMIC_TLS_CRYPT_LABEL "EXPORTER-OpenVPN-dynamic-tls-crypt"

Definition at line 398 of file ssl_backend.h.

◆ EXPORT_KEY_DATA_LABEL

#define EXPORT_KEY_DATA_LABEL "EXPORTER-OpenVPN-datakeys"

Definition at line 396 of file ssl_backend.h.

◆ EXPORT_P2P_PEERID_LABEL

#define EXPORT_P2P_PEERID_LABEL "EXPORTER-OpenVPN-p2p-peerid"

Definition at line 397 of file ssl_backend.h.

◆ SSLAPI

#define SSLAPI SSLAPI_OPENSSL

Definition at line 39 of file ssl_backend.h.

◆ TLS_VER_1_0

#define TLS_VER_1_0 1

Definition at line 106 of file ssl_backend.h.

◆ TLS_VER_1_1

#define TLS_VER_1_1 2

Definition at line 107 of file ssl_backend.h.

◆ TLS_VER_1_2

#define TLS_VER_1_2 3

Definition at line 108 of file ssl_backend.h.

◆ TLS_VER_1_3

#define TLS_VER_1_3 4

Definition at line 109 of file ssl_backend.h.

◆ TLS_VER_BAD

#define TLS_VER_BAD -1

Parse a TLS version specifier.

Parameters

vstr	The TLS version string
extra	An optional extra parameter, may be NULL

Returns: One of the TLS_VER_x constants or TLS_VER_BAD if a parse error should be flagged.

Definition at line 104 of file ssl_backend.h.

◆ TLS_VER_UNSPEC

#define TLS_VER_UNSPEC 0 /* default */

Definition at line 105 of file ssl_backend.h.

Function Documentation

◆ backend_tls_ctx_reload_crl()

void backend_tls_ctx_reload_crl	(	struct tls_root_ctx *	ssl_ctx,
		const char *	crl_file,
		bool	crl_inline
	)

Reload the Certificate Revocation List for the SSL channel.

Parameters

ssl_ctx	The TLS context to use when reloading the CRL
crl_file	The file name to load the CRL from, or an array containing the inline CRL.
crl_inline	True if crl_file is an inline CRL.

Definition at line 1328 of file ssl_openssl.c.

References ASSERT, crypto_msg, tls_root_ctx::ctx, M_FATAL, M_INFO, M_WARN, msg, and print_key_filename().

Referenced by tls_ctx_reload_crl().

◆ get_ssl_library_version()

const char * get_ssl_library_version ( void )

return a pointer to a static memory area containing the name and version number of the SSL library in use

Definition at line 2663 of file ssl_openssl.c.

Referenced by push_peer_info(), and show_library_versions().

◆ key_state_export_keying_material()

bool key_state_export_keying_material	(	struct tls_session *	session,
		const char *	label,
		size_t	label_size,
		void *	ekm,
		size_t	ekm_size
	)

Keying Material Exporters [RFC 5705] allows additional keying material to be derived from existing TLS channel.

This exported keying material can then be used for a variety of purposes.

Parameters

session	The session associated with the given key_state
label	The label to use when exporting the key
label_size	The size of the label to use when exporting the key
ekm	Buffer to return the exported key material in
ekm_size	The size of ekm, in bytes

Returns: true if exporting succeeded, false otherwise

Definition at line 156 of file ssl_openssl.c.

References ASSERT, session::key, KS_PRIMARY, and secure_memzero().

Referenced by export_user_keying_material(), generate_key_expansion_tls_export(), p2p_ncp_set_options(), and tls_session_generate_dynamic_tls_crypt_key().

◆ key_state_ssl_free()

void key_state_ssl_free ( struct key_state_ssl * ks_ssl )

Free the SSL channel part of the given key state.

Parameters

ks_ssl The SSL channel's state info to free

Definition at line 2214 of file ssl_openssl.c.

References key_state_ssl::ct_in, key_state_ssl::ct_out, key_state_ssl::ssl, and key_state_ssl::ssl_bio.

Referenced by key_state_free().

◆ key_state_ssl_init()

void key_state_ssl_init	(	struct key_state_ssl *	ks_ssl,
		const struct tls_root_ctx *	ssl_ctx,
		bool	is_server,
		struct tls_session *	session
	)

Initialise the SSL channel part of the given key state.

Settings will be loaded from a previously initialised TLS context.

Parameters

ks_ssl	The SSL channel's state info to initialise
ssl_ctx	The TLS context to use when initialising the channel.
is_server	Initialise a server?
session	The session associated with the given key_state

Definition at line 2168 of file ssl_openssl.c.

References ASSERT, CLEAR, crypto_msg, key_state_ssl::ct_in, key_state_ssl::ct_out, tls_root_ctx::ctx, M_FATAL, mydata_index, key_state_ssl::ssl, and key_state_ssl::ssl_bio.

Referenced by key_state_init().

◆ key_state_ssl_shutdown()

void key_state_ssl_shutdown ( struct key_state_ssl * ks_ssl )

Sets a TLS session to be shutdown state, so the TLS library will generate a shutdown alert.

Definition at line 2208 of file ssl_openssl.c.

References key_state_ssl::ssl.

Referenced by tls_multi_process(), and tls_process_state().

◆ pem_password_callback()

int pem_password_callback	(	char *	buf,
		int	size,
		int	rwflag,
		void *	u
	)

Callback to retrieve the user's password.

Parameters

buf	Buffer to return the password in
size	Size of the buffer
rwflag	Unused, needed for OpenSSL compatibility
u	Unused, needed for OpenSSL compatibility

Definition at line 261 of file ssl.c.

References ASSERT, passbuf, user_pass::password, pem_password_setup(), user_pass::protected, purge_user_pass(), and strncpynt().

Referenced by tls_ctx_load_pkcs12(), and tls_ctx_set_options().

◆ print_details()

void print_details	(	struct key_state_ssl *	ks_ssl,
		const char *	prefix
	)

Print a one line summary of SSL/TLS session handshake.

Definition at line 2515 of file ssl_openssl.c.

References D_HANDSHAKE, msg, print_cert_details(), print_peer_signature(), print_server_tempkey(), and key_state_ssl::ssl.

Referenced by session_move_active().

◆ show_available_curves()

void show_available_curves ( void )

Show the available elliptic curves in the crypto library.

Definition at line 2623 of file ssl_openssl.c.

References ALLOC_ARRAY, crypto_msg, M_FATAL, M_WARN, and msg.

Referenced by print_openssl_info().

◆ show_available_tls_ciphers_list()

void show_available_tls_ciphers_list	(	const char *	cipher_list,
		const char *	tls_cert_profile,
		bool	tls13
	)

Show the TLS ciphers that are available for us to use in the library depending on the TLS version.

This function prints a list of ciphers without headers/footers.

Parameters

cipher_list	list of allowed TLS cipher, or NULL.
tls_cert_profile	TLS certificate crypto profile name.
tls13	Select if <=TLS1.2 or TLS1.3+ ciphers should be shown

Definition at line 2548 of file ssl_openssl.c.

References crypto_msg, tls_root_ctx::ctx, tls_cipher_name_pair::iana_name, M_FATAL, openssl_tls_version(), tls_ctx_restrict_ciphers(), tls_ctx_restrict_ciphers_tls13(), tls_ctx_set_cert_profile(), tls_get_cipher_name_pair(), and TLS_VER_1_3.

Referenced by show_available_tls_ciphers().

◆ tls_clear_error()

void tls_clear_error ( void )

Clear the underlying SSL library's error state.

Referenced by handle_data_channel_packet(), init_ssl(), tls_multi_process(), tls_pre_decrypt(), tls_pre_decrypt_lite(), tls_process_state(), tls_rec_payload(), tls_send_payload(), and verify_cert().

◆ tls_ctx_check_cert_time()

void tls_ctx_check_cert_time ( const struct tls_root_ctx * ctx )

Check our certificate notBefore and notAfter fields, and warn if the cert is either not yet valid or has expired.

Note that this is a non-fatal error, since we compare against the system time, which might be incorrect.

Parameters

ctx	TLS context to get our certificate from.

Definition at line 620 of file ssl_openssl.c.

References ASSERT, tls_root_ctx::ctx, D_TLS_DEBUG_MED, M_WARN, and msg.

Referenced by init_ssl().

◆ tls_ctx_client_new()

void tls_ctx_client_new ( struct tls_root_ctx * ctx )

Initialises a library-specific TLS context for a client.

Parameters

ctx	TLS context to initialise

Definition at line 122 of file ssl_openssl.c.

References ASSERT, crypto_msg, tls_root_ctx::ctx, M_FATAL, M_WARN, SSL_CTX_new_ex, and tls_libctx.

Referenced by crypto_pem_encode_certificate(), init_ssl(), test_load_certificate_and_key(), and test_load_certificate_and_key_uri().

◆ tls_ctx_free()

void tls_ctx_free ( struct tls_root_ctx * ctx )

Frees the library-specific TLSv1 context.

Parameters

ctx	TLS context to free

Definition at line 140 of file ssl_openssl.c.

References ASSERT, tls_root_ctx::ctx, and unload_xkey_provider().

Referenced by crypto_pem_encode_certificate(), init_ssl(), key_schedule_free(), test_load_certificate_and_key(), and test_load_certificate_and_key_uri().

◆ tls_ctx_initialised()

bool tls_ctx_initialised ( struct tls_root_ctx * ctx )

Checks whether the given TLS context is initialised.

Parameters

ctx	TLS context to check

Returns: true if the context is initialised, false if not.

Definition at line 149 of file ssl_openssl.c.

References ASSERT, and tls_root_ctx::ctx.

Referenced by do_init_crypto_tls_c1(), and key_schedule_free().

◆ tls_ctx_load_ca()

void tls_ctx_load_ca	(	struct tls_root_ctx *	ctx,
		const char *	ca_file,
		bool	ca_file_inline,
		const char *	ca_path,
		bool	tls_server
	)

Load certificate authority certificates from the given file or path.

Note that not all SSL libraries support loading from a path.

Parameters

ctx	TLS context to use
ca_file	The file name to load the CAs from, or a string containing the CAs in the case of inline files.
ca_file_inline	True if ca_file is an inline file
ca_path	The path to load the CAs from
tls_server	True if we are the server side of the TLS connection and should use the CA for verifying client certificates

Definition at line 1800 of file ssl_openssl.c.

References ASSERT, crypto_msg, tls_root_ctx::ctx, M_FATAL, M_WARN, msg, print_key_filename(), and sk_x509_name_cmp().

Referenced by init_ssl().

◆ tls_ctx_load_cert_file()

void tls_ctx_load_cert_file	(	struct tls_root_ctx *	ctx,
		const char *	cert_file,
		bool	cert_file_inline
	)

Load certificate file into the given TLS context.

If the given certificate file contains a certificate chain, load the whole chain.

Parameters

ctx	TLS context to use
cert_file	The file name to load the certificate from, or a string containing the certificate in the case of inline files.
cert_file_inline	True if cert_file is an inline file.

Definition at line 1259 of file ssl_openssl.c.

References cert_uri_supported(), tls_ctx_load_cert_pem_file(), and tls_ctx_load_cert_uri().

Referenced by crypto_pem_encode_certificate(), init_ssl(), test_load_certificate_and_key(), and test_load_certificate_and_key_uri().

◆ tls_ctx_load_cryptoapi()

void tls_ctx_load_cryptoapi	(	struct tls_root_ctx *	ctx,
		const char *	cryptoapi_cert
	)

Use Windows cryptoapi for key and cert, and add to library-specific TLS context.

Parameters

ctx	TLS context to use
cryptoapi_cert	String representing the certificate to load.

Definition at line 1038 of file ssl_openssl.c.

References ASSERT, crypto_msg, tls_root_ctx::ctx, M_FATAL, and SSL_CTX_use_CryptoAPI_certificate().

Referenced by init_ssl().

◆ tls_ctx_load_dh_params()

void tls_ctx_load_dh_params	(	struct tls_root_ctx *	ctx,
		const char *	dh_file,
		bool	dh_file_inline
	)

Load Diffie Hellman Parameters, and load them into the library-specific TLS context.

Parameters

ctx	TLS context to use
dh_file	The file name to load the parameters from, or a string containing the parameters in the case of inline files.
dh_file_inline	True if dh_file is an inline file.

Definition at line 656 of file ssl_openssl.c.

References ASSERT, crypto_msg, tls_root_ctx::ctx, D_TLS_DEBUG_LOW, M_FATAL, msg, and print_key_filename().

Referenced by init_ssl().

◆ tls_ctx_load_ecdh_params()

void tls_ctx_load_ecdh_params	(	struct tls_root_ctx *	ctx,
		const char *	curve_name
	)

Load Elliptic Curve Parameters, and load them into the library-specific TLS context.

Parameters

ctx	TLS context to use
curve_name	The name of the elliptic curve to load.

Definition at line 717 of file ssl_openssl.c.

References crypto_msg, tls_root_ctx::ctx, D_LOW, D_TLS_DEBUG, D_TLS_DEBUG_LOW, M_FATAL, M_WARN, and msg.

Referenced by init_ssl().

◆ tls_ctx_load_extra_certs()

void tls_ctx_load_extra_certs	(	struct tls_root_ctx *	ctx,
		const char *	extra_certs_file,
		bool	extra_certs_file_inline
	)

Load extra certificate authority certificates from the given file or path.

These Load extra certificates that are part of our own certificate chain but shouldn't be included in the verify chain.

Parameters

ctx	TLS context to use
extra_certs_file	The file name to load the certs from, or a string containing the certs in the case of inline files.
extra_certs_file_inline	True if extra_certs_file is an inline file.

Definition at line 1949 of file ssl_openssl.c.

References crypto_msg, M_FATAL, print_key_filename(), and tls_ctx_add_extra_certs().

Referenced by init_ssl().

◆ tls_ctx_load_pkcs12()

int tls_ctx_load_pkcs12	(	struct tls_root_ctx *	ctx,
		const char *	pkcs12_file,
		bool	pkcs12_file_inline,
		bool	load_ca_file
	)

Load PKCS #12 file for key, cert and (optionally) CA certs, and add to library-specific TLS context.

Parameters

ctx	TLS context to use
pkcs12_file	The file name to load the information from, or a string containing the information in the case of inline files.
pkcs12_file_inline	True if pkcs12_file is an inline file.
load_ca_file	True if CAs from the file should be added to the cert store and be trusted.

Returns: 1 if an error occurred, 0 if parsing was successful.

Definition at line 908 of file ssl_openssl.c.

References ASSERT, crypto_msg, crypto_print_openssl_errors(), tls_root_ctx::ctx, M_FATAL, M_WARN, management_auth_failure(), user_pass::password, pem_password_callback(), platform_fopen(), and UP_TYPE_PRIVATE_KEY.

Referenced by init_ssl().

◆ tls_ctx_load_priv_file()

int tls_ctx_load_priv_file	(	struct tls_root_ctx *	ctx,
		const char *	priv_key_file,
		bool	priv_key_file_inline
	)

Load private key file into the given TLS context.

Parameters

ctx	TLS context to use
priv_key_file	The file name to load the private key from, or a string containing the private key in the case of inline files.
priv_key_file_inline	True if priv_key_file is an inline file

Returns: 1 if an error occurred, 0 if parsing was successful.

Definition at line 1273 of file ssl_openssl.c.

References ASSERT, crypto_msg, tls_root_ctx::ctx, load_pkey_from_uri(), M_FATAL, M_WARN, management_auth_failure(), print_key_filename(), and UP_TYPE_PRIVATE_KEY.

Referenced by init_ssl(), test_load_certificate_and_key(), and test_load_certificate_and_key_uri().

◆ tls_ctx_restrict_ciphers()

void tls_ctx_restrict_ciphers	(	struct tls_root_ctx *	ctx,
		const char *	ciphers
	)

Restrict the list of ciphers that can be used within the TLS context for TLS 1.2 and below.

Parameters

ctx	TLS context to restrict, must be valid.
ciphers	String containing : delimited cipher names, or NULL to use sane defaults.

Definition at line 430 of file ssl_openssl.c.

References ASSERT, convert_tls_list_to_openssl(), crypto_msg, tls_root_ctx::ctx, and M_FATAL.

Referenced by init_ssl(), and show_available_tls_ciphers_list().

◆ tls_ctx_restrict_ciphers_tls13()

void tls_ctx_restrict_ciphers_tls13	(	struct tls_root_ctx *	ctx,
		const char *	ciphers
	)

Restrict the list of ciphers that can be used within the TLS context for TLS 1.3 and higher.

Parameters

ctx	TLS context to restrict, must be valid.
ciphers	String containing : delimited cipher names, or NULL to use sane defaults.

Definition at line 492 of file ssl_openssl.c.

References ASSERT, convert_tls13_list_to_openssl(), crypto_msg, tls_root_ctx::ctx, M_FATAL, and M_WARN.

Referenced by init_ssl(), and show_available_tls_ciphers_list().

◆ tls_ctx_server_new()

void tls_ctx_server_new ( struct tls_root_ctx * ctx )

Initialise a library-specific TLS context for a server.

Parameters

ctx	TLS context to initialise

Definition at line 104 of file ssl_openssl.c.

References ASSERT, crypto_msg, tls_root_ctx::ctx, M_FATAL, M_WARN, SSL_CTX_new_ex, and tls_libctx.

Referenced by init_ssl().

◆ tls_ctx_set_cert_profile()

void tls_ctx_set_cert_profile	(	struct tls_root_ctx *	ctx,
		const char *	profile
	)

Set the TLS certificate profile.

The profile defines which crypto algorithms may be used in the supplied certificate.

Parameters

ctx	TLS context to restrict, must be valid.
profile	The profile name ('preferred', 'legacy' or 'suiteb'). Defaults to 'preferred' if NULL.

Definition at line 521 of file ssl_openssl.c.

References tls_root_ctx::ctx, M_FATAL, M_WARN, and msg.

Referenced by init_ssl(), and show_available_tls_ciphers_list().

◆ tls_ctx_set_options()

bool tls_ctx_set_options	(	struct tls_root_ctx *	ctx,
		unsigned int	ssl_flags
	)

Set any library specific options.

Examples include disabling session caching, the password callback to use, and session verification parameters.

Parameters

ctx	TLS context to set options on
ssl_flags	SSL flags to set

Returns: true on success, false otherwise.

Definition at line 310 of file ssl_openssl.c.

References ASSERT, tls_root_ctx::ctx, info_callback(), pem_password_callback(), SSLF_CLIENT_CERT_NOT_REQUIRED, SSLF_CLIENT_CERT_OPTIONAL, tls_ctx_set_tls_versions(), and verify_callback().

Referenced by init_ssl().

◆ tls_ctx_set_tls_groups()

void tls_ctx_set_tls_groups	(	struct tls_root_ctx *	ctx,
		const char *	groups
	)

Set the (elliptic curve) group allowed for signatures and key exchange.

Parameters

ctx	TLS context to restrict, must be valid.
groups	List of groups that will be allowed, in priority, separated by :

Definition at line 560 of file ssl_openssl.c.

References ALLOC_ARRAY_CLEAR_GC, ASSERT, crypto_msg, tls_root_ctx::ctx, gc, gc_free(), gc_new(), get_num_elements(), M_FATAL, M_WARN, msg, SSL_CTX_set1_groups, streq, string_alloc(), and strsep().

Referenced by init_ssl().

◆ tls_ctx_use_management_external_key()

int tls_ctx_use_management_external_key ( struct tls_root_ctx * ctx )

Tell the management interface to load the given certificate and the external private key matching the given certificate.

Parameters

ctx	TLS context to use

Returns: 1 if an error occurred, 0 if successful.

Definition at line 1720 of file ssl_openssl.c.

References ASSERT, cleanup(), crypto_msg, tls_root_ctx::ctx, M_FATAL, M_WARN, tls_ctx_use_external_ec_key(), tls_ctx_use_external_rsa_key(), and tls_libctx.

Referenced by init_ssl().

◆ tls_free_lib()

void tls_free_lib ( void )

Free any global SSL library-specific data structures.

Definition at line 99 of file ssl_openssl.c.

Referenced by free_ssl_lib(), and main().

◆ tls_init_lib()

void tls_init_lib ( void )

Perform any static initialisation necessary by the library.

Called on OpenVPN initialisation

Definition at line 92 of file ssl_openssl.c.

References ASSERT, and mydata_index.

Referenced by init_ssl_lib(), and main().

◆ tls_version_max()

int tls_version_max ( void )

Return the maximum TLS version (as a TLS_VER_x constant) supported by current SSL implementation.

Returns: One of the TLS_VER_x constants (but not TLS_VER_BAD).

Definition at line 207 of file ssl_openssl.c.

References TLS_VER_1_0, TLS_VER_1_1, TLS_VER_1_2, and TLS_VER_1_3.

Referenced by options_postprocess_verify_ce(), show_available_tls_ciphers(), and tls_version_parse().

◆ tls_version_parse()

int tls_version_parse	(	const char *	vstr,
		const char *	extra
	)

Definition at line 431 of file ssl.c.

References TLS_VER_1_0, TLS_VER_1_1, TLS_VER_1_2, TLS_VER_1_3, TLS_VER_BAD, and tls_version_max().

Referenced by add_option().

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ EXPORT_DYNAMIC_TLS_CRYPT_LABEL

◆ EXPORT_KEY_DATA_LABEL

◆ EXPORT_P2P_PEERID_LABEL

◆ SSLAPI

◆ TLS_VER_1_0

◆ TLS_VER_1_1

◆ TLS_VER_1_2

◆ TLS_VER_1_3

◆ TLS_VER_BAD

◆ TLS_VER_UNSPEC

Function Documentation

◆ backend_tls_ctx_reload_crl()

◆ get_ssl_library_version()

◆ key_state_export_keying_material()

◆ key_state_ssl_free()

◆ key_state_ssl_init()

◆ key_state_ssl_shutdown()

◆ pem_password_callback()

◆ print_details()

◆ show_available_curves()

◆ show_available_tls_ciphers_list()

◆ tls_clear_error()

◆ tls_ctx_check_cert_time()

◆ tls_ctx_client_new()

◆ tls_ctx_free()

◆ tls_ctx_initialised()

◆ tls_ctx_load_ca()

◆ tls_ctx_load_cert_file()

◆ tls_ctx_load_cryptoapi()

◆ tls_ctx_load_dh_params()

◆ tls_ctx_load_ecdh_params()

◆ tls_ctx_load_extra_certs()

◆ tls_ctx_load_pkcs12()

◆ tls_ctx_load_priv_file()

◆ tls_ctx_restrict_ciphers()

◆ tls_ctx_restrict_ciphers_tls13()

◆ tls_ctx_server_new()

◆ tls_ctx_set_cert_profile()

◆ tls_ctx_set_options()

◆ tls_ctx_set_tls_groups()

◆ tls_ctx_use_management_external_key()

◆ tls_free_lib()

◆ tls_init_lib()

◆ tls_version_max()

◆ tls_version_parse()