MongoDB C++ Driver  mongocxx-3.4.0
Public Member Functions | List of all members
mongocxx::options::ssl Class Reference

Class representing the optional arguments to a MongoDB driver client (SSL) More...

#include <ssl.hpp>

Public Member Functions

sslpem_file (bsoncxx::string::view_or_value pem_file)
 The path to the .pem file containing a public key certificate and its associated private key. More...
 
const stdx::optional< bsoncxx::string::view_or_value > & pem_file () const
 Retrieves the current path to the .pem file. More...
 
sslpem_password (bsoncxx::string::view_or_value pem_password)
 The pass phrase used to decrypt an encrypted PEM file. More...
 
const stdx::optional< bsoncxx::string::view_or_value > & pem_password () const
 Retrieves the current decryption pass phrase. More...
 
sslca_file (bsoncxx::string::view_or_value ca_file)
 The path to the .pem file that contains the root certificate chain from the Certificate Authority. More...
 
const stdx::optional< bsoncxx::string::view_or_value > & ca_file () const
 Retrieves the current path to the CA file. More...
 
sslca_dir (bsoncxx::string::view_or_value ca_dir)
 The path to the Certificate Authority directory. More...
 
const stdx::optional< bsoncxx::string::view_or_value > & ca_dir () const
 Retrieves the current path to the CA directory. More...
 
sslcrl_file (bsoncxx::string::view_or_value crl_file)
 The path to the .pem file that contains revoked certificates. More...
 
const stdx::optional< bsoncxx::string::view_or_value > & crl_file () const
 Retrieves the current path to the .pem file that contains revoked certificates. More...
 
sslallow_invalid_certificates (bool allow_invalid_certificates)
 If true, the driver will not verify the server's CA file. More...
 
const stdx::optional< bool > & allow_invalid_certificates () const
 Retrieves whether or not the driver will check the server's CA file. More...
 

Detailed Description

Class representing the optional arguments to a MongoDB driver client (SSL)

Member Function Documentation

◆ allow_invalid_certificates() [1/2]

ssl& mongocxx::options::ssl::allow_invalid_certificates ( bool  allow_invalid_certificates)

If true, the driver will not verify the server's CA file.

Parameters
allow_invalid_certificatesWhether or not to check the server's CA file.
Returns
A reference to the object on which this member function is being called. This facilitates method chaining.

◆ allow_invalid_certificates() [2/2]

const stdx::optional<bool>& mongocxx::options::ssl::allow_invalid_certificates ( ) const

Retrieves whether or not the driver will check the server's CA file.

Returns
Whether or not the driver will check the server's CA file.

◆ ca_dir() [1/2]

ssl& mongocxx::options::ssl::ca_dir ( bsoncxx::string::view_or_value  ca_dir)

The path to the Certificate Authority directory.

Parameters
ca_dirThe path to the CA directory.
Returns
A reference to the object on which this member function is being called. This facilitates method chaining.

◆ ca_dir() [2/2]

const stdx::optional<bsoncxx::string::view_or_value>& mongocxx::options::ssl::ca_dir ( ) const

Retrieves the current path to the CA directory.

Returns
The path to the CA directory.

◆ ca_file() [1/2]

ssl& mongocxx::options::ssl::ca_file ( bsoncxx::string::view_or_value  ca_file)

The path to the .pem file that contains the root certificate chain from the Certificate Authority.

Parameters
ca_fileThe path to the CA file.
Returns
A reference to the object on which this member function is being called. This facilitates method chaining.

◆ ca_file() [2/2]

const stdx::optional<bsoncxx::string::view_or_value>& mongocxx::options::ssl::ca_file ( ) const

Retrieves the current path to the CA file.

Returns
The path to the CA file.

◆ crl_file() [1/2]

ssl& mongocxx::options::ssl::crl_file ( bsoncxx::string::view_or_value  crl_file)

The path to the .pem file that contains revoked certificates.

Parameters
crl_fileThe path to the PEM file.
Returns
A reference to the object on which this member function is being called. This facilitates method chaining.

◆ crl_file() [2/2]

const stdx::optional<bsoncxx::string::view_or_value>& mongocxx::options::ssl::crl_file ( ) const

Retrieves the current path to the .pem file that contains revoked certificates.

Returns
The path to the revoked certificates file.

◆ pem_file() [1/2]

ssl& mongocxx::options::ssl::pem_file ( bsoncxx::string::view_or_value  pem_file)

The path to the .pem file containing a public key certificate and its associated private key.

Parameters
pem_fileThe path to the .pem file.
Returns
A reference to the object on which this member function is being called. This facilitates method chaining.

◆ pem_file() [2/2]

const stdx::optional<bsoncxx::string::view_or_value>& mongocxx::options::ssl::pem_file ( ) const

Retrieves the current path to the .pem file.

Returns
The path to the .pem file.

◆ pem_password() [1/2]

ssl& mongocxx::options::ssl::pem_password ( bsoncxx::string::view_or_value  pem_password)

The pass phrase used to decrypt an encrypted PEM file.

Parameters
pem_passwordThe pass phrase.
Returns
A reference to the object on which this member function is being called. This facilitates method chaining.

◆ pem_password() [2/2]

const stdx::optional<bsoncxx::string::view_or_value>& mongocxx::options::ssl::pem_password ( ) const

Retrieves the current decryption pass phrase.

Returns
The pass phrase.

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