OpenVPN 3 Core Library
Loading...
Searching...
No Matches
openvpn::CryptoDCSettingsData Class Reference

#include <cryptodc.hpp>

Inheritance diagram for openvpn::CryptoDCSettingsData:
[legend]

Public Member Functions

 OPENVPN_SIMPLE_EXCEPTION (no_data_channel_factory)
 
 CryptoDCSettingsData ()=default
 
void set_cipher (CryptoAlgs::Type cipher)
 
void set_digest (CryptoAlgs::Type digest)
 
void set_use_epoch_keys (bool use_epoch)
 
CryptoAlgs::Type cipher () const
 
CryptoAlgs::Type digest () const
 
bool useEpochKeys () const
 
void set_key_derivation (CryptoAlgs::KeyDerivation method)
 
CryptoAlgs::KeyDerivation key_derivation () const
 

Private Attributes

CryptoAlgs::Type cipher_ = CryptoAlgs::NONE
 
CryptoAlgs::Type digest_ = CryptoAlgs::NONE
 
CryptoAlgs::KeyDerivation key_derivation_ = CryptoAlgs::KeyDerivation::OPENVPN_PRF
 
bool use_epoch_keys = false
 

Detailed Description

class that holds settings for a data channel encryption

Definition at line 98 of file cryptodc.hpp.

Constructor & Destructor Documentation

◆ CryptoDCSettingsData()

openvpn::CryptoDCSettingsData::CryptoDCSettingsData ( )
default

Member Function Documentation

◆ cipher()

CryptoAlgs::Type openvpn::CryptoDCSettingsData::cipher ( ) const
inline

Definition at line 120 of file cryptodc.hpp.

Here is the caller graph for this function:

◆ digest()

CryptoAlgs::Type openvpn::CryptoDCSettingsData::digest ( ) const
inline

Retrieve the digest configured for the data channel. If the configured data channel cipher does not use any additional digest, CryptoAlgs::NONE is returned.

Returns
Returns the cipher digest in use

Definition at line 132 of file cryptodc.hpp.

Here is the caller graph for this function:

◆ key_derivation()

CryptoAlgs::KeyDerivation openvpn::CryptoDCSettingsData::key_derivation ( ) const
inline

Definition at line 147 of file cryptodc.hpp.

Here is the caller graph for this function:

◆ OPENVPN_SIMPLE_EXCEPTION()

openvpn::CryptoDCSettingsData::OPENVPN_SIMPLE_EXCEPTION ( no_data_channel_factory  )

◆ set_cipher()

void openvpn::CryptoDCSettingsData::set_cipher ( CryptoAlgs::Type  cipher)
inline

Definition at line 105 of file cryptodc.hpp.

Here is the caller graph for this function:

◆ set_digest()

void openvpn::CryptoDCSettingsData::set_digest ( CryptoAlgs::Type  digest)
inline

Definition at line 110 of file cryptodc.hpp.

Here is the caller graph for this function:

◆ set_key_derivation()

void openvpn::CryptoDCSettingsData::set_key_derivation ( CryptoAlgs::KeyDerivation  method)
inline

Definition at line 142 of file cryptodc.hpp.

Here is the caller graph for this function:

◆ set_use_epoch_keys()

void openvpn::CryptoDCSettingsData::set_use_epoch_keys ( bool  use_epoch)
inline

Definition at line 115 of file cryptodc.hpp.

Here is the caller graph for this function:

◆ useEpochKeys()

bool openvpn::CryptoDCSettingsData::useEpochKeys ( ) const
inline

Definition at line 137 of file cryptodc.hpp.

Here is the caller graph for this function:

Member Data Documentation

◆ cipher_

CryptoAlgs::Type openvpn::CryptoDCSettingsData::cipher_ = CryptoAlgs::NONE
private

Definition at line 154 of file cryptodc.hpp.

◆ digest_

CryptoAlgs::Type openvpn::CryptoDCSettingsData::digest_ = CryptoAlgs::NONE
private

Definition at line 155 of file cryptodc.hpp.

◆ key_derivation_

CryptoAlgs::KeyDerivation openvpn::CryptoDCSettingsData::key_derivation_ = CryptoAlgs::KeyDerivation::OPENVPN_PRF
private

Definition at line 156 of file cryptodc.hpp.

◆ use_epoch_keys

bool openvpn::CryptoDCSettingsData::use_epoch_keys = false
private

Definition at line 157 of file cryptodc.hpp.


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