#include <src/main/decaf/net/ssl/SSLParameters.h>
|
| SSLParameters () |
| Creates a new SSLParameters instance with empty vectors for the protocols and the cipherSuites, the wantClientAuth and needClientAuth flags are set to false.
|
|
| SSLParameters (const std::vector< std::string > &cipherSuites) |
| Creates a new SSLParameters instance with the given cipherSuites value, the protocols vector is empty and the wantClientAuth and needClientAuth flags are set to false.
|
|
| SSLParameters (const std::vector< std::string > &cipherSuites, const std::vector< std::string > &protocols) |
| Creates a new SSLParameters instance with the given cipherSuites value and protocols value, the wantClientAuth and needClientAuth flags are set to false.
|
|
virtual | ~SSLParameters () |
|
std::vector< std::string > | getCipherSuites () const |
|
void | setCipherSuites (const std::vector< std::string > &cipherSuites) |
| Sets the vector of ciphersuites.
|
|
std::vector< std::string > | getProtocols () const |
|
void | setProtocols (const std::vector< std::string > &protocols) |
| Sets the vector of protocols.
|
|
bool | getWantClientAuth () const |
|
void | setWantClientAuth (bool wantClientAuth) |
| Sets whether client authentication should be requested.
|
|
bool | getNeedClientAuth () const |
|
void | setNeedClientAuth (bool needClientAuth) |
| Sets whether client authentication should be required.
|
|
void | setServerNames (const std::vector< std::string > &serverNames) |
| Sets the Server Names that this client wants to encode for use during the SSL Handshaking phase.
|
|
std::vector< std::string > | getServerNames () const |
| Gets the currently set list of server names used.
|
|
◆ SSLParameters() [1/3]
decaf::net::ssl::SSLParameters::SSLParameters |
( |
| ) |
|
Creates a new SSLParameters instance with empty vectors for the protocols and the cipherSuites, the wantClientAuth and needClientAuth flags are set to false.
◆ SSLParameters() [2/3]
decaf::net::ssl::SSLParameters::SSLParameters |
( |
const std::vector< std::string > & | cipherSuites | ) |
|
Creates a new SSLParameters instance with the given cipherSuites value, the protocols vector is empty and the wantClientAuth and needClientAuth flags are set to false.
- Parameters
-
cipherSuites | The vector of cipherSuites for this SSLParameters instance (can be empty). |
◆ SSLParameters() [3/3]
decaf::net::ssl::SSLParameters::SSLParameters |
( |
const std::vector< std::string > & | cipherSuites, |
|
|
const std::vector< std::string > & | protocols ) |
Creates a new SSLParameters instance with the given cipherSuites value and protocols value, the wantClientAuth and needClientAuth flags are set to false.
- Parameters
-
cipherSuites | The vector of cipherSuites for this SSLParameters instance (can be empty). |
protocols | The vector of protocols for this SSLParameters instance (can be empty). |
◆ ~SSLParameters()
virtual decaf::net::ssl::SSLParameters::~SSLParameters |
( |
| ) |
|
|
virtual |
◆ getCipherSuites()
std::vector< std::string > decaf::net::ssl::SSLParameters::getCipherSuites |
( |
| ) |
const |
|
inline |
- Returns
- a copy of the vector of ciphersuites or an empty vector if none have been set.
◆ getNeedClientAuth()
bool decaf::net::ssl::SSLParameters::getNeedClientAuth |
( |
| ) |
const |
|
inline |
- Returns
- whether client authentication should be required.
◆ getProtocols()
std::vector< std::string > decaf::net::ssl::SSLParameters::getProtocols |
( |
| ) |
const |
|
inline |
- Returns
- a copy of the vector of protocols or an empty vector if none have been set.
◆ getServerNames()
std::vector< std::string > decaf::net::ssl::SSLParameters::getServerNames |
( |
| ) |
const |
|
inline |
Gets the currently set list of server names used.
This method returns a copy of the list so that it cannot be modified. If updates are needed a new list must be set via {setServerNames}.
- Returns
- a list of server names if any were previously configured.
◆ getWantClientAuth()
bool decaf::net::ssl::SSLParameters::getWantClientAuth |
( |
| ) |
const |
|
inline |
- Returns
- whether client authentication should be requested.
◆ setCipherSuites()
void decaf::net::ssl::SSLParameters::setCipherSuites |
( |
const std::vector< std::string > & | cipherSuites | ) |
|
|
inline |
Sets the vector of ciphersuites.
- Parameters
-
cipherSuites | The vector of cipherSuites (can be an empty vector). |
◆ setNeedClientAuth()
void decaf::net::ssl::SSLParameters::setNeedClientAuth |
( |
bool | needClientAuth | ) |
|
|
inline |
Sets whether client authentication should be required.
Calling this method clears the wantClientAuth flag.
- Parameters
-
needClientAuth | whether client authentication should be required. |
◆ setProtocols()
void decaf::net::ssl::SSLParameters::setProtocols |
( |
const std::vector< std::string > & | protocols | ) |
|
|
inline |
Sets the vector of protocols.
- Parameters
-
protocols | the vector of protocols (or an empty vector) |
◆ setServerNames()
void decaf::net::ssl::SSLParameters::setServerNames |
( |
const std::vector< std::string > & | serverNames | ) |
|
|
inline |
Sets the Server Names that this client wants to encode for use during the SSL Handshaking phase.
The list is copied so the values cannot be changed later.
- Parameters
-
serverNames | The server name to encode into the SSL handshake. |
◆ setWantClientAuth()
void decaf::net::ssl::SSLParameters::setWantClientAuth |
( |
bool | wantClientAuth | ) |
|
|
inline |
Sets whether client authentication should be requested.
Calling this method clears the needClientAuth flag.
- Parameters
-
wantClientAuth | whether client authentication should be requested. |
The documentation for this class was generated from the following file: