Hazelcast C++ Client
|
Contains configuration parameters for client network related behaviour. More...
#include <ssl_config.h>
Public Member Functions | |
ssl_config () | |
Default protocol is tlsv12 and ssl is disabled by default. | |
bool | is_enabled () const |
Returns if this configuration is enabled. More... | |
ssl_config & | set_enabled (bool is_enabled) |
Enables and disables this configuration. More... | |
ssl_config & | set_protocol (ssl_protocol protocol) |
Sets the ssl protocol to be used for this SSL socket. More... | |
ssl_protocol | get_protocol () const |
const std::vector< std::string > & | get_verify_files () const |
ssl_config & | add_verify_file (const std::string &filename) |
This API calls the OpenSSL SSL_CTX_load_verify_locations method underneath while starting the client with this configuration. More... | |
const std::string & | get_cipher_list () const |
ssl_config & | set_cipher_list (const std::string &ciphers) |
Contains configuration parameters for client network related behaviour.
ssl_config & hazelcast::client::config::ssl_config::add_verify_file | ( | const std::string & | filename | ) |
This API calls the OpenSSL SSL_CTX_load_verify_locations method underneath while starting the client with this configuration.
The validity of the files are checked only when the client starts. Hence, this call will not do any error checking. Error checking is performed only when the certificates are actually loaded during client start.
filename | the name of a file containing certification authority certificates in PEM format. |
const std::string & hazelcast::client::config::ssl_config::get_cipher_list | ( | ) | const |
ssl_protocol hazelcast::client::config::ssl_config::get_protocol | ( | ) | const |
const std::vector< std::string > & hazelcast::client::config::ssl_config::get_verify_files | ( | ) | const |
bool hazelcast::client::config::ssl_config::is_enabled | ( | ) | const |
Returns if this configuration is enabled.
ssl_config & hazelcast::client::config::ssl_config::set_cipher_list | ( | const std::string & | ciphers | ) |
ciphers | The list of ciphers to be used. During client start, if this API was set then the SSL_CTX_set_cipher_list (https://www.openssl.org/docs/man1.0.2/ssl/SSL_set_cipher_list.html) is called with the provided ciphers string. The values and the format of the ciphers are described here: https://www.openssl.org/docs/man1.0.2/apps/ciphers.html Some examples values for the string are: "HIGH", "MEDIUM", "LOW", etc. |
If non of the provided ciphers could be selected the client initialization will fail.
ssl_config & hazelcast::client::config::ssl_config::set_enabled | ( | bool | is_enabled | ) |
Enables and disables this configuration.
isEnabled | true to enable, false to disable |
ssl_config & hazelcast::client::config::ssl_config::set_protocol | ( | ssl_protocol | protocol | ) |
Sets the ssl protocol to be used for this SSL socket.
protocol | One of the supported protocols |