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

#include <authcreds.hpp>

Inheritance diagram for openvpn::AuthCreds:
[legend]
Collaboration diagram for openvpn::AuthCreds:
[legend]

Public Types

typedef RCPtr< AuthCredsPtr
 
- Public Types inherited from openvpn::RC< thread_unsafe_refcount >
typedef RCPtr< RCPtr
 

Public Member Functions

 AuthCreds (std::string &&username_arg, SafeString &&password_arg, const std::string &peer_info_str)
 
 AuthCreds (std::string username_arg, SafeString password_arg, OptionList peer_info_arg)
 
bool defined () const
 
bool is_valid_user_pass (const bool strict) const
 
bool is_valid (const bool strict) const
 
void wipe_password ()
 
std::string to_string () const
 
- Public Member Functions inherited from openvpn::RC< thread_unsafe_refcount >
 RC () noexcept=default
 
 RC (const RC &)=delete
 
virtual ~RC ()=default
 
RCoperator= (const RC &)=delete
 
olong use_count () const noexcept
 Delegates call to RCImpl and returns the result.
 

Public Attributes

std::string username
 
SafeString password
 
OptionList peer_info
 

Additional Inherited Members

- Static Public Member Functions inherited from openvpn::RC< thread_unsafe_refcount >
static constexpr bool is_thread_safe ()
 Delegates call to RCImpl and returns the result.
 

Detailed Description

Definition at line 28 of file authcreds.hpp.

Member Typedef Documentation

◆ Ptr

Definition at line 31 of file authcreds.hpp.

Constructor & Destructor Documentation

◆ AuthCreds() [1/2]

openvpn::AuthCreds::AuthCreds ( std::string &&  username_arg,
SafeString &&  password_arg,
const std::string &  peer_info_str 
)
inline

Definition at line 33 of file authcreds.hpp.

◆ AuthCreds() [2/2]

openvpn::AuthCreds::AuthCreds ( std::string  username_arg,
SafeString  password_arg,
OptionList  peer_info_arg 
)
inline

Definition at line 44 of file authcreds.hpp.

Member Function Documentation

◆ defined()

bool openvpn::AuthCreds::defined ( ) const
inline

Definition at line 53 of file authcreds.hpp.

Here is the caller graph for this function:

◆ is_valid()

bool openvpn::AuthCreds::is_valid ( const bool  strict) const
inline

Definition at line 64 of file authcreds.hpp.

Here is the caller graph for this function:

◆ is_valid_user_pass()

bool openvpn::AuthCreds::is_valid_user_pass ( const bool  strict) const
inline

Definition at line 58 of file authcreds.hpp.

Here is the caller graph for this function:

◆ to_string()

std::string openvpn::AuthCreds::to_string ( ) const
inline

Definition at line 74 of file authcreds.hpp.

◆ wipe_password()

void openvpn::AuthCreds::wipe_password ( )
inline

Definition at line 69 of file authcreds.hpp.

Member Data Documentation

◆ password

SafeString openvpn::AuthCreds::password

Definition at line 93 of file authcreds.hpp.

◆ peer_info

OptionList openvpn::AuthCreds::peer_info

Definition at line 94 of file authcreds.hpp.

◆ username

std::string openvpn::AuthCreds::username

Definition at line 92 of file authcreds.hpp.


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