All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Data Fields
as_config_tls Struct Reference

Detailed Description

TLS module config

Definition at line 123 of file as_config.h.

#include "as_config.h"

+ Collaboration diagram for as_config_tls:

Data Fields

char * cafile
 
char * capath
 
char * cert_blacklist
 
char * certfile
 
char * cipher_suite
 
bool crl_check
 
bool crl_check_all
 
bool enable
 
bool encrypt_only
 
char * keyfile
 
bool log_session_info
 
uint32_t max_socket_idle
 
char * protocols
 

Field Documentation

char* as_config_tls::cafile

Path to a trusted CA certificate file. By default TLS will use system standard trusted CA certificates. Use as_config_tls_set_cafile() to set this field.

Definition at line 142 of file as_config.h.

char* as_config_tls::capath

Path to a directory of trusted certificates. See the OpenSSL SSL_CTX_load_verify_locations manual page for more information about the format of the directory. Use as_config_tls_set_capath() to set this field.

Definition at line 150 of file as_config.h.

char* as_config_tls::cert_blacklist

Path to a certificate blacklist file. The file should contain one line for each blacklisted certificate. Each line starts with the certificate serial number expressed in hex. Each entry may optionally specify the issuer name of the certificate (serial numbers are only required to be unique per issuer). Example records: 867EC87482B2 /C=US/ST=CA/O=Acme/OU=Engineering/CN=Test Chain CA E2D4B0E570F9EF8E885C065899886461

Use as_config_tls_set_cert_blacklist() to set this field.

Definition at line 209 of file as_config.h.

char* as_config_tls::certfile

Path to the client's certificate chain file for mutual authentication. By default mutual authentication is disabled.

Use as_config_tls_set_certfile() to set this field.

Definition at line 230 of file as_config.h.

char* as_config_tls::cipher_suite

Specifies enabled cipher suites.

The format is the same as OpenSSL's Cipher List Format documented at https://www.openssl.org/docs/manmaster/apps/ciphers.html

If not specified the OpenSSL default cipher suite described in the ciphers documentation will be used.

If you are not sure what cipher suite to select this option is best left unspecified (NULL).

Use as_config_tls_set_cipher_suite() to set this field.

Definition at line 181 of file as_config.h.

bool as_config_tls::crl_check

Enable CRL checking for the certificate chain leaf certificate. An error occurs if a suitable CRL cannot be found. By default CRL checking is disabled.

Definition at line 188 of file as_config.h.

bool as_config_tls::crl_check_all

Enable CRL checking for the entire certificate chain. An error occurs if a suitable CRL cannot be found. By default CRL checking is disabled.

Definition at line 195 of file as_config.h.

bool as_config_tls::enable

Enable TLS on connections. By default TLS is disabled.

Definition at line 129 of file as_config.h.

bool as_config_tls::encrypt_only

Only encrypt connections; do not verify certificates. By default TLS will verify certificates.

Definition at line 135 of file as_config.h.

char* as_config_tls::keyfile

Path to the client's key for mutual authentication. By default mutual authentication is disabled.

Use as_config_tls_set_keyfile() to set this field.

Definition at line 222 of file as_config.h.

bool as_config_tls::log_session_info

Log session information for each connection.

Definition at line 214 of file as_config.h.

uint32_t as_config_tls::max_socket_idle

Maximum socket idle in seconds for TLS connections. TLS Socket connection pools will discard sockets that have been idle longer than the maximum. The value is limited to 24 hours (86400).

It's important to set this value to a few seconds less than the server's proto-fd-idle-ms (default 60000 milliseconds or 1 minute), so the client does not attempt to use a socket that has already been reaped by the server.

Default: 55 seconds

Definition at line 243 of file as_config.h.

char* as_config_tls::protocols

Specifies enabled protocols.

This format is the same as Apache's SSLProtocol documented at https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslprotocol

If not specified (NULL) the client will use "-all +TLSv1.2".

If you are not sure what protocols to select this option is best left unspecified (NULL).

Use as_config_tls_set_protocols() to set this field.

Definition at line 165 of file as_config.h.


The documentation for this struct was generated from the following file: