OpenVPN 3 Core Library
Loading...
Searching...
No Matches
Classes | Public Member Functions | Static Public Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
openvpn::ParseClientConfig Class Reference

#include <cliopthelper.hpp>

Collaboration diagram for openvpn::ParseClientConfig:
[legend]

Classes

struct  RemoteItem
 
struct  ServerEntry
 
struct  ServerList
 

Public Member Functions

 ParseClientConfig ()
 
 ParseClientConfig (const OptionList &options)
 
bool error () const
 
const std::string & message () const
 
const std::string & userlockedUsername () const
 
const std::string & profileName () const
 
const std::string & friendlyName () const
 
bool autologin () const
 
bool hasEmbeddedPassword () const
 
const std::string & embeddedPassword () const
 
bool clientCertEnabled () const
 
bool externalPki () const
 
std::string vpnCa () const
 
const std::string & staticChallenge () const
 
bool staticChallengeEcho () const
 
bool privateKeyPasswordRequired () const
 
bool allowPasswordSave () const
 
bool pushPeerInfo () const
 
const PeerInfo::Set * peerInfoUV () const
 
const ServerList & serverList () const
 
const RemoteItem & firstRemoteListItem () const
 
const std::string & windowsDriver () const
 
std::string to_string () const
 
std::string to_string_config () const
 

Static Public Member Functions

static ParseClientConfig parse (const std::string &content)
 
static ParseClientConfig parse (const std::string &content, OptionList::KeyValueList *content_list)
 
static ParseClientConfig parse (const std::string &content, OptionList::KeyValueList *content_list, OptionList &options)
 

Private Member Functions

void reset_pod ()
 
bool parse_bool (const Option &o, const std::string &title, const size_t index)
 

Static Private Member Functions

static void print_pem (std::ostream &os, std::string label, std::string pem)
 
static bool parse_auth_user_pass (const OptionList &options, std::vector< std::string > *user_pass)
 
static void process_setenv_opt (OptionList &options)
 
static bool is_autologin (const OptionList &options, const bool auth_user_pass, const std::vector< std::string > &user_pass)
 
static bool is_external_pki (const OptionList &options)
 

Private Attributes

bool error_
 
std::string message_
 
std::string userlockedUsername_
 
std::string profileName_
 
std::string friendlyName_
 
bool autologin_
 
bool clientCertEnabled_
 
bool externalPki_
 
std::string vpnCa_
 
bool pushPeerInfo_
 
std::string staticChallenge_
 
bool staticChallengeEcho_
 
bool privateKeyPasswordRequired_
 
bool allowPasswordSave_
 
ServerList serverList_
 
bool hasEmbeddedPassword_
 
std::string embeddedPassword_
 
RemoteList::Ptr remoteList
 
RemoteItem firstRemoteListItem_
 
PeerInfo::Set::Ptr peerInfoUV_
 
ProtoContext::ProtoConfig::Ptr protoConfig
 
SSLLib::SSLAPI::Config::Ptr sslConfig
 
std::string dev
 
std::string windowsDriver_
 

Detailed Description

Definition at line 41 of file cliopthelper.hpp.

Constructor & Destructor Documentation

◆ ParseClientConfig() [1/2]

openvpn::ParseClientConfig::ParseClientConfig ( )
inline

Definition at line 61 of file cliopthelper.hpp.

Here is the caller graph for this function:

◆ ParseClientConfig() [2/2]

openvpn::ParseClientConfig::ParseClientConfig ( const OptionList &  options)
inline

Definition at line 66 of file cliopthelper.hpp.

Member Function Documentation

◆ allowPasswordSave()

bool openvpn::ParseClientConfig::allowPasswordSave ( ) const
inline

Definition at line 484 of file cliopthelper.hpp.

Here is the caller graph for this function:

◆ autologin()

bool openvpn::ParseClientConfig::autologin ( ) const
inline

Definition at line 433 of file cliopthelper.hpp.

Here is the caller graph for this function:

◆ clientCertEnabled()

bool openvpn::ParseClientConfig::clientCertEnabled ( ) const
inline

Definition at line 449 of file cliopthelper.hpp.

Here is the caller graph for this function:

◆ embeddedPassword()

const std::string & openvpn::ParseClientConfig::embeddedPassword ( ) const
inline

Definition at line 443 of file cliopthelper.hpp.

Here is the caller graph for this function:

◆ error()

bool openvpn::ParseClientConfig::error ( ) const
inline

Definition at line 403 of file cliopthelper.hpp.

Here is the caller graph for this function:

◆ externalPki()

bool openvpn::ParseClientConfig::externalPki ( ) const
inline

Definition at line 455 of file cliopthelper.hpp.

Here is the caller graph for this function:

◆ firstRemoteListItem()

const RemoteItem & openvpn::ParseClientConfig::firstRemoteListItem ( ) const
inline

Definition at line 508 of file cliopthelper.hpp.

Here is the caller graph for this function:

◆ friendlyName()

const std::string & openvpn::ParseClientConfig::friendlyName ( ) const
inline

Definition at line 427 of file cliopthelper.hpp.

Here is the caller graph for this function:

◆ hasEmbeddedPassword()

bool openvpn::ParseClientConfig::hasEmbeddedPassword ( ) const
inline

Definition at line 439 of file cliopthelper.hpp.

Here is the caller graph for this function:

◆ is_autologin()

static bool openvpn::ParseClientConfig::is_autologin ( const OptionList &  options,
const bool  auth_user_pass,
const std::vector< std::string > &  user_pass 
)
inlinestaticprivate

Definition at line 720 of file cliopthelper.hpp.

Here is the caller graph for this function:

◆ is_external_pki()

static bool openvpn::ParseClientConfig::is_external_pki ( const OptionList &  options)
inlinestaticprivate

Definition at line 750 of file cliopthelper.hpp.

Here is the caller graph for this function:

◆ message()

const std::string & openvpn::ParseClientConfig::message ( ) const
inline

Definition at line 409 of file cliopthelper.hpp.

Here is the caller graph for this function:

◆ parse() [1/3]

static ParseClientConfig openvpn::ParseClientConfig::parse ( const std::string &  content)
inlinestatic

Definition at line 329 of file cliopthelper.hpp.

Here is the caller graph for this function:

◆ parse() [2/3]

static ParseClientConfig openvpn::ParseClientConfig::parse ( const std::string &  content,
OptionList::KeyValueList *  content_list 
)
inlinestatic

Definition at line 334 of file cliopthelper.hpp.

◆ parse() [3/3]

static ParseClientConfig openvpn::ParseClientConfig::parse ( const std::string &  content,
OptionList::KeyValueList *  content_list,
OptionList &  options 
)
inlinestatic

Definition at line 340 of file cliopthelper.hpp.

◆ parse_auth_user_pass()

static bool openvpn::ParseClientConfig::parse_auth_user_pass ( const OptionList &  options,
std::vector< std::string > *  user_pass 
)
inlinestaticprivate

Definition at line 702 of file cliopthelper.hpp.

Here is the caller graph for this function:

◆ parse_bool()

bool openvpn::ParseClientConfig::parse_bool ( const Option &  o,
const std::string &  title,
const size_t  index 
)
inlineprivate

Definition at line 771 of file cliopthelper.hpp.

Here is the caller graph for this function:

◆ peerInfoUV()

const PeerInfo::Set * openvpn::ParseClientConfig::peerInfoUV ( ) const
inline

Definition at line 496 of file cliopthelper.hpp.

Here is the caller graph for this function:

◆ print_pem()

static void openvpn::ParseClientConfig::print_pem ( std::ostream &  os,
std::string  label,
std::string  pem 
)
inlinestaticprivate

Definition at line 683 of file cliopthelper.hpp.

Here is the caller graph for this function:

◆ privateKeyPasswordRequired()

bool openvpn::ParseClientConfig::privateKeyPasswordRequired ( ) const
inline

Definition at line 478 of file cliopthelper.hpp.

Here is the caller graph for this function:

◆ process_setenv_opt()

static void openvpn::ParseClientConfig::process_setenv_opt ( OptionList &  options)
inlinestaticprivate

Definition at line 707 of file cliopthelper.hpp.

Here is the caller graph for this function:

◆ profileName()

const std::string & openvpn::ParseClientConfig::profileName ( ) const
inline

Definition at line 421 of file cliopthelper.hpp.

Here is the caller graph for this function:

◆ pushPeerInfo()

bool openvpn::ParseClientConfig::pushPeerInfo ( ) const
inline

Definition at line 490 of file cliopthelper.hpp.

Here is the caller graph for this function:

◆ reset_pod()

void openvpn::ParseClientConfig::reset_pod ( )
inlineprivate

Definition at line 763 of file cliopthelper.hpp.

Here is the caller graph for this function:

◆ serverList()

const ServerList & openvpn::ParseClientConfig::serverList ( ) const
inline

Definition at line 502 of file cliopthelper.hpp.

Here is the caller graph for this function:

◆ staticChallenge()

const std::string & openvpn::ParseClientConfig::staticChallenge ( ) const
inline

Definition at line 466 of file cliopthelper.hpp.

Here is the caller graph for this function:

◆ staticChallengeEcho()

bool openvpn::ParseClientConfig::staticChallengeEcho ( ) const
inline

Definition at line 472 of file cliopthelper.hpp.

Here is the caller graph for this function:

◆ to_string()

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

Definition at line 518 of file cliopthelper.hpp.

◆ to_string_config()

std::string openvpn::ParseClientConfig::to_string_config ( ) const
inline

Definition at line 532 of file cliopthelper.hpp.

◆ userlockedUsername()

const std::string & openvpn::ParseClientConfig::userlockedUsername ( ) const
inline

Definition at line 415 of file cliopthelper.hpp.

Here is the caller graph for this function:

◆ vpnCa()

std::string openvpn::ParseClientConfig::vpnCa ( ) const
inline

Definition at line 460 of file cliopthelper.hpp.

Here is the caller graph for this function:

◆ windowsDriver()

const std::string & openvpn::ParseClientConfig::windowsDriver ( ) const
inline

Definition at line 513 of file cliopthelper.hpp.

Here is the caller graph for this function:

Member Data Documentation

◆ allowPasswordSave_

bool openvpn::ParseClientConfig::allowPasswordSave_
private

Definition at line 795 of file cliopthelper.hpp.

◆ autologin_

bool openvpn::ParseClientConfig::autologin_
private

Definition at line 787 of file cliopthelper.hpp.

◆ clientCertEnabled_

bool openvpn::ParseClientConfig::clientCertEnabled_
private

Definition at line 788 of file cliopthelper.hpp.

◆ dev

std::string openvpn::ParseClientConfig::dev
private

Definition at line 804 of file cliopthelper.hpp.

◆ embeddedPassword_

std::string openvpn::ParseClientConfig::embeddedPassword_
private

Definition at line 798 of file cliopthelper.hpp.

◆ error_

bool openvpn::ParseClientConfig::error_
private

Definition at line 782 of file cliopthelper.hpp.

◆ externalPki_

bool openvpn::ParseClientConfig::externalPki_
private

Definition at line 789 of file cliopthelper.hpp.

◆ firstRemoteListItem_

RemoteItem openvpn::ParseClientConfig::firstRemoteListItem_
private

Definition at line 800 of file cliopthelper.hpp.

◆ friendlyName_

std::string openvpn::ParseClientConfig::friendlyName_
private

Definition at line 786 of file cliopthelper.hpp.

◆ hasEmbeddedPassword_

bool openvpn::ParseClientConfig::hasEmbeddedPassword_
private

Definition at line 797 of file cliopthelper.hpp.

◆ message_

std::string openvpn::ParseClientConfig::message_
private

Definition at line 783 of file cliopthelper.hpp.

◆ peerInfoUV_

PeerInfo::Set::Ptr openvpn::ParseClientConfig::peerInfoUV_
private

Definition at line 801 of file cliopthelper.hpp.

◆ privateKeyPasswordRequired_

bool openvpn::ParseClientConfig::privateKeyPasswordRequired_
private

Definition at line 794 of file cliopthelper.hpp.

◆ profileName_

std::string openvpn::ParseClientConfig::profileName_
private

Definition at line 785 of file cliopthelper.hpp.

◆ protoConfig

ProtoContext::ProtoConfig::Ptr openvpn::ParseClientConfig::protoConfig
private

Definition at line 802 of file cliopthelper.hpp.

◆ pushPeerInfo_

bool openvpn::ParseClientConfig::pushPeerInfo_
private

Definition at line 791 of file cliopthelper.hpp.

◆ remoteList

RemoteList::Ptr openvpn::ParseClientConfig::remoteList
private

Definition at line 799 of file cliopthelper.hpp.

◆ serverList_

ServerList openvpn::ParseClientConfig::serverList_
private

Definition at line 796 of file cliopthelper.hpp.

◆ sslConfig

SSLLib::SSLAPI::Config::Ptr openvpn::ParseClientConfig::sslConfig
private

Definition at line 803 of file cliopthelper.hpp.

◆ staticChallenge_

std::string openvpn::ParseClientConfig::staticChallenge_
private

Definition at line 792 of file cliopthelper.hpp.

◆ staticChallengeEcho_

bool openvpn::ParseClientConfig::staticChallengeEcho_
private

Definition at line 793 of file cliopthelper.hpp.

◆ userlockedUsername_

std::string openvpn::ParseClientConfig::userlockedUsername_
private

Definition at line 784 of file cliopthelper.hpp.

◆ vpnCa_

std::string openvpn::ParseClientConfig::vpnCa_
private

Definition at line 790 of file cliopthelper.hpp.

◆ windowsDriver_

std::string openvpn::ParseClientConfig::windowsDriver_
private

Definition at line 805 of file cliopthelper.hpp.

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