openvpn::ClientCreds Class Reference

#include <clicreds.hpp>

Inheritance diagram for openvpn::ClientCreds:

Collaboration diagram for openvpn::ClientCreds:

Public Types
typedef RCPtr< ClientCreds >	Ptr
Public Types inherited from openvpn::RC< thread_unsafe_refcount >
typedef RCPtr< RC >	Ptr

Public Member Functions
	ClientCreds ()=default
void	set_username (const std::string &username_arg)
void	set_password (const std::string &password_arg)
void	set_http_proxy_username (const std::string &username)
void	set_http_proxy_password (const std::string &password)
void	set_response (const std::string &response_arg)
void	set_dynamic_challenge_cookie (const std::string &cookie, const std::string &username)
void	set_session_id (const std::string &user, const std::string &sess_id)
std::string	get_username () const
std::string	get_password () const
std::string	get_http_proxy_username () const
std::string	get_http_proxy_password () const
bool	username_defined () const
bool	password_defined () const
bool	http_proxy_username_defined () const
bool	http_proxy_password_defined () const
bool	session_id_defined () const
void	purge_session_id ()
void	purge_user_pass ()
void	save_username_for_session_id ()
void	set_need_user_interaction ()
bool	need_user_interaction () const
bool	password_needed () const
std::string	auth_info () const
Public Member Functions inherited from openvpn::RC< thread_unsafe_refcount >
	RC () noexcept=default
	RC (const RC &)=delete
virtual	~RC ()=default
RC &	operator= (const RC &)=delete
olong	use_count () const noexcept
	Delegates call to RCImpl and returns the result.

Private Attributes
std::string	username
std::string	password
std::string	http_proxy_user
std::string	http_proxy_pass
std::string	session_id
std::string	session_id_username
std::string	response
bool	need_user_interaction_ = false
bool	password_needed_ = false
ChallengeResponse::Ptr	dynamic_challenge

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 30 of file clicreds.hpp.

Member Typedef Documentation

Ptr

typedef RCPtr<ClientCreds> openvpn::ClientCreds::Ptr

Definition at line 33 of file clicreds.hpp.

Constructor & Destructor Documentation

ClientCreds()

openvpn::ClientCreds::ClientCreds ( )

default

Member Function Documentation

auth_info()

std::string openvpn::ClientCreds::auth_info ( ) const

inline

Definition at line 192 of file clicreds.hpp.

Here is the caller graph for this function:

get_http_proxy_password()

std::string openvpn::ClientCreds::get_http_proxy_password ( ) const

inline

Definition at line 125 of file clicreds.hpp.

Here is the caller graph for this function:

get_http_proxy_username()

std::string openvpn::ClientCreds::get_http_proxy_username ( ) const

inline

Definition at line 120 of file clicreds.hpp.

Here is the caller graph for this function:

get_password()

std::string openvpn::ClientCreds::get_password ( ) const

inline

Definition at line 105 of file clicreds.hpp.

Here is the caller graph for this function:

get_username()

std::string openvpn::ClientCreds::get_username ( ) const

inline

Definition at line 95 of file clicreds.hpp.

Here is the caller graph for this function:

http_proxy_password_defined()

bool openvpn::ClientCreds::http_proxy_password_defined ( ) const

inline

Definition at line 145 of file clicreds.hpp.

Here is the caller graph for this function:

http_proxy_username_defined()

bool openvpn::ClientCreds::http_proxy_username_defined ( ) const

inline

Definition at line 140 of file clicreds.hpp.

Here is the caller graph for this function:

need_user_interaction()

bool openvpn::ClientCreds::need_user_interaction ( ) const

inline

Definition at line 182 of file clicreds.hpp.

Here is the caller graph for this function:

password_defined()

bool openvpn::ClientCreds::password_defined ( ) const

inline

Definition at line 135 of file clicreds.hpp.

Here is the caller graph for this function:

password_needed()

bool openvpn::ClientCreds::password_needed ( ) const

inline

Definition at line 187 of file clicreds.hpp.

Here is the caller graph for this function:

purge_session_id()

void openvpn::ClientCreds::purge_session_id ( )

inline

Definition at line 155 of file clicreds.hpp.

Here is the caller graph for this function:

purge_user_pass()

void openvpn::ClientCreds::purge_user_pass ( )

inline

Definition at line 162 of file clicreds.hpp.

Here is the caller graph for this function:

save_username_for_session_id()

void openvpn::ClientCreds::save_username_for_session_id ( )

inline

Definition at line 169 of file clicreds.hpp.

Here is the caller graph for this function:

session_id_defined()

bool openvpn::ClientCreds::session_id_defined ( ) const

inline

Definition at line 150 of file clicreds.hpp.

Here is the caller graph for this function:

set_dynamic_challenge_cookie()

void openvpn::ClientCreds::set_dynamic_challenge_cookie ( const std::string &  cookie, const std::string &  username  )

inline

Definition at line 70 of file clicreds.hpp.

Here is the caller graph for this function:

set_http_proxy_password()

void openvpn::ClientCreds::set_http_proxy_password ( const std::string &  password )

inline

Definition at line 56 of file clicreds.hpp.

Here is the caller graph for this function:

set_http_proxy_username()

void openvpn::ClientCreds::set_http_proxy_username ( const std::string &  username )

inline

Definition at line 51 of file clicreds.hpp.

Here is the caller graph for this function:

set_need_user_interaction()

void openvpn::ClientCreds::set_need_user_interaction ( )

inline

Definition at line 177 of file clicreds.hpp.

Here is the caller graph for this function:

set_password()

void openvpn::ClientCreds::set_password ( const std::string &  password_arg )

inline

Definition at line 42 of file clicreds.hpp.

Here is the caller graph for this function:

set_response()

void openvpn::ClientCreds::set_response ( const std::string &  response_arg )

inline

Definition at line 61 of file clicreds.hpp.

Here is the caller graph for this function:

set_session_id()

void openvpn::ClientCreds::set_session_id ( const std::string &  user, const std::string &  sess_id  )

inline

Definition at line 76 of file clicreds.hpp.

Here is the caller graph for this function:

set_username()

void openvpn::ClientCreds::set_username ( const std::string &  username_arg )

inline

Definition at line 37 of file clicreds.hpp.

Here is the caller graph for this function:

username_defined()

bool openvpn::ClientCreds::username_defined ( ) const

inline

Definition at line 130 of file clicreds.hpp.

Here is the caller graph for this function:

Member Data Documentation

dynamic_challenge

ChallengeResponse::Ptr openvpn::ClientCreds::dynamic_challenge

private

Definition at line 256 of file clicreds.hpp.

http_proxy_pass

std::string openvpn::ClientCreds::http_proxy_pass

private

Definition at line 241 of file clicreds.hpp.

http_proxy_user

std::string openvpn::ClientCreds::http_proxy_user

private

Definition at line 240 of file clicreds.hpp.

need_user_interaction_

bool openvpn::ClientCreds::need_user_interaction_ = false

private

Definition at line 250 of file clicreds.hpp.

password

std::string openvpn::ClientCreds::password

private

Definition at line 237 of file clicreds.hpp.

password_needed_

bool openvpn::ClientCreds::password_needed_ = false

private

Definition at line 253 of file clicreds.hpp.

response

std::string openvpn::ClientCreds::response

private

Definition at line 247 of file clicreds.hpp.

session_id

std::string openvpn::ClientCreds::session_id

private

Definition at line 243 of file clicreds.hpp.

session_id_username

std::string openvpn::ClientCreds::session_id_username

private

Definition at line 244 of file clicreds.hpp.

username

std::string openvpn::ClientCreds::username

private

Definition at line 236 of file clicreds.hpp.

---

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

• openvpn/client/clicreds.hpp