Version 4 of XML Configuration class. More...

#include <XmlConf.h>

Public Member Functions
	XmlConfV4 (const std::string &path={}, const std::string &schema={})

	~XmlConfV4 () override

int	logLevel () const override

std::string	logFile () const override

std::string	PKCS11Driver () const override

std::string	proxyHost () const override

std::string	proxyPort () const override

std::string	proxyUser () const override

std::string	proxyPass () const override

bool	proxyForceSSL () const override

bool	proxyTunnelSSL () const override

std::string	digestUri () const override

std::string	signatureDigestUri () const override

std::string	ocsp (const std::string &issuer) const override

std::set< std::string >	OCSPTMProfiles () const override

std::string	TSUrl () const override

X509Cert	verifyServiceCert () const override

std::vector< X509Cert >	verifyServiceCerts () const override

std::string	verifyServiceUri () const override

DIGIDOCPP_DEPRECATED std::string	PKCS12Cert () const override

DIGIDOCPP_DEPRECATED std::string	PKCS12Pass () const override

DIGIDOCPP_DEPRECATED bool	PKCS12Disable () const override

bool	TSLAutoUpdate () const override

std::string	TSLCache () const override

bool	TSLOnlineDigest () const override

int	TSLTimeOut () const override

virtual void	setProxyHost (const std::string &host)

virtual void	setProxyPort (const std::string &port)

virtual void	setProxyUser (const std::string &user)

virtual void	setProxyPass (const std::string &pass)

virtual void	setProxyTunnelSSL (bool enable)

virtual DIGIDOCPP_DEPRECATED void	setPKCS12Cert (const std::string &cert)

virtual DIGIDOCPP_DEPRECATED void	setPKCS12Pass (const std::string &pass)

virtual DIGIDOCPP_DEPRECATED void	setPKCS12Disable (bool disable)

virtual void	setTSLOnlineDigest (bool enable)

virtual void	setTSLTimeOut (int timeOut)

virtual void	setTSUrl (const std::string &url)

virtual void	setVerifyServiceUri (const std::string &url)

Public Member Functions inherited from digidoc::ConfV4
	ConfV4 ()

	~ConfV4 () override

Public Member Functions inherited from digidoc::ConfV3
	ConfV3 ()

	~ConfV3 () override

Public Member Functions inherited from digidoc::ConfV2
	ConfV2 ()

	~ConfV2 () override

Public Member Functions inherited from digidoc::Conf
	Conf ()

virtual	~Conf ()

virtual DIGIDOCPP_DEPRECATED std::string	libdigidocConf () const

virtual DIGIDOCPP_DEPRECATED std::string	certsPath () const

virtual std::string	xsdPath () const

virtual bool	TSLAllowExpired () const

virtual std::vector< X509Cert >	TSLCerts () const

virtual std::string	TSLUrl () const

Static Public Member Functions
static XmlConfV4 *	instance ()

Static Public Member Functions inherited from digidoc::ConfV4
static ConfV4 *	instance ()

Static Public Member Functions inherited from digidoc::ConfV3
static ConfV3 *	instance ()

Static Public Member Functions inherited from digidoc::ConfV2
static ConfV2 *	instance ()

Static Public Member Functions inherited from digidoc::Conf
static void	init (Conf *conf)

static Conf *	instance ()

Detailed Description

Version 4 of XML Configuration class.

Deprecated:: Use digidoc::XmlConfV5

See also: digidoc::ConfV4

Constructor & Destructor Documentation

◆ XmlConfV4()

XmlConfV4::XmlConfV4	(	const std::string &	path = `{}`,
		const std::string &	schema = `{}`
	)

explicit

Initialize xml conf from path

◆ ~XmlConfV4()

XmlConfV4::~XmlConfV4 ( )

overridedefault

Member Function Documentation

◆ digestUri()

std::string digidoc::XmlConfV4::digestUri ( ) const

overridevirtual

Return default digest type as URI

Reimplemented from digidoc::Conf.

◆ instance()

XmlConfV4 * XmlConfV4::instance ( )

static

Return global config instance object

References digidoc::Conf::instance().

◆ logFile()

std::string digidoc::XmlConfV4::logFile ( ) const

overridevirtual

Gets log file location. Default log goes to standard out stream

Reimplemented from digidoc::Conf.

◆ logLevel()

int digidoc::XmlConfV4::logLevel ( ) const

overridevirtual

Returns log level. 0 = Error 1 = Warn 2 = Info 3 = Debug

Reimplemented from digidoc::Conf.

◆ ocsp()

string XmlConfV4::ocsp ( const std::string & issuer ) const

overridevirtual

Return OCSP request URL

Parameters

issuer OCSP issuer.

Reimplemented from digidoc::Conf.

References digidoc::Conf::ocsp().

◆ OCSPTMProfiles()

set< string > XmlConfV4::OCSPTMProfiles ( ) const

overridevirtual

Gets OCSP TM Profile OID-s

OCSP responder certificate policies that are used to identify if OCSP response is given with TM profile

Reimplemented from digidoc::ConfV3.

References digidoc::ConfV3::OCSPTMProfiles().

◆ PKCS11Driver()

std::string digidoc::XmlConfV4::PKCS11Driver ( ) const

overridevirtual

Returns PKCS11 driver file path

Reimplemented from digidoc::Conf.

◆ PKCS12Cert()

DIGIDOCPP_DEPRECATED std::string digidoc::XmlConfV4::PKCS12Cert ( ) const

overridevirtual

Gets PKCS12 certificate file location.

Used for signing OCSP request

Reimplemented from digidoc::Conf.

◆ PKCS12Disable()

DIGIDOCPP_DEPRECATED bool digidoc::XmlConfV4::PKCS12Disable ( ) const

overridevirtual

Gets PKCS12 usage.

See also: digidoc::Conf::PKCS12Cert

Reimplemented from digidoc::Conf.

◆ PKCS12Pass()

DIGIDOCPP_DEPRECATED std::string digidoc::XmlConfV4::PKCS12Pass ( ) const

overridevirtual

Gets PKCS12 password.

See also: digidoc::Conf::PKCS12Cert

Reimplemented from digidoc::Conf.

◆ proxyForceSSL()

bool digidoc::XmlConfV4::proxyForceSSL ( ) const

overridevirtual

Redirect SSL traffic over proxy server Default: false

Reimplemented from digidoc::Conf.

◆ proxyHost()

std::string digidoc::XmlConfV4::proxyHost ( ) const

overridevirtual

Gets proxy host address.

Reimplemented from digidoc::Conf.

◆ proxyPass()

std::string digidoc::XmlConfV4::proxyPass ( ) const

overridevirtual

Gets proxy login password.

Reimplemented from digidoc::Conf.

◆ proxyPort()

std::string digidoc::XmlConfV4::proxyPort ( ) const

overridevirtual

Gets proxy port number.

Reimplemented from digidoc::Conf.

◆ proxyTunnelSSL()

bool digidoc::XmlConfV4::proxyTunnelSSL ( ) const

overridevirtual

Tunnel SSL traffic over proxy server Default: false

Reimplemented from digidoc::Conf.

◆ proxyUser()

std::string digidoc::XmlConfV4::proxyUser ( ) const

overridevirtual

Gets proxy user name.

Reimplemented from digidoc::Conf.

◆ setPKCS12Cert()

void digidoc::XmlConfV4::setPKCS12Cert ( const std::string & cert )

virtual

Sets a PKCS#12 certficate path. Also adds or replaces PKCS#12 certificate path in the user configuration file. By default the PKCS#12 certificate file should be located at default path, given by getUserConfDir() function.

Parameters

cert	PKCS#12 certificate location path.

Exceptions

Exception exception is thrown if saving a PKCS#12 certificate path into a user configuration file fails.

◆ setPKCS12Disable()

void digidoc::XmlConfV4::setPKCS12Disable ( bool disable )

virtual

Sets a PKCS#12 certificate usage. Also adds or replaces PKCS#12 certificate usage in the user configuration file.

Parameters

disable PKCS#12 certificate usage.

Exceptions

Exception exception is thrown if saving a PKCS#12 certificate usage into a user configuration file fails.

◆ setPKCS12Pass()

void digidoc::XmlConfV4::setPKCS12Pass ( const std::string & pass )

virtual

Sets a PKCS#12 certificate password. Also adds or replaces PKCS#12 certificate password in the user configuration file.

Parameters

pass	PKCS#12 certificate password.

Exceptions

Exception exception is thrown if saving a PKCS#12 certificate password into a user configuration file fails.

◆ setProxyHost()

void digidoc::XmlConfV4::setProxyHost ( const std::string & host )

virtual

Sets a Proxy host address. Also adds or replaces proxy host data in the user configuration file.

Parameters

host	proxy host address.

Exceptions

Exception exception is thrown if saving a proxy host address into a user configuration file fails.

◆ setProxyPass()

void digidoc::XmlConfV4::setProxyPass ( const std::string & pass )

virtual

Sets a Proxy password. Also adds or replaces proxy password in the user configuration file.

Parameters

pass	proxy password.

Exceptions

Exception exception is thrown if saving a proxy password into a user configuration file fails.

◆ setProxyPort()

void digidoc::XmlConfV4::setProxyPort ( const std::string & port )

virtual

Sets a Proxy port number. Also adds or replaces proxy port data in the user configuration file.

Parameters

port	proxy port number.

Exceptions

Exception exception is thrown if saving a proxy port number into a user configuration file fails.

◆ setProxyTunnelSSL()

void digidoc::XmlConfV4::setProxyTunnelSSL ( bool enable )

virtual

Enables SSL proxy connections

Exceptions

Exception exception is thrown if saving into a user configuration file fails.

◆ setProxyUser()

void digidoc::XmlConfV4::setProxyUser ( const std::string & user )

virtual

Sets a Proxy user name. Also adds or replaces proxy user name in the user configuration file.

Parameters

user	proxy user name.

Exceptions

Exception exception is thrown if saving a proxy user name into a user configuration file fails.

◆ setTSLOnlineDigest()

void digidoc::XmlConfV4::setTSLOnlineDigest ( bool enable )

virtual

Enables/Disables online digest check

Exceptions

Exception exception is thrown if saving a TSL online digest into a user configuration file fails.

◆ setTSLTimeOut()

void digidoc::XmlConfV4::setTSLTimeOut ( int timeOut )

virtual

Sets TSL connection timeout

Parameters

timeOut Time out in seconds

Exceptions

Exception exception is thrown if saving a TSL timeout into a user configuration file fails.

◆ setTSUrl()

void digidoc::XmlConfV4::setTSUrl ( const std::string & url )

virtual

Sets a TSA service URL. Also adds or replaces TSA service URL in the user configuration file.

Parameters

url	Target URL to connect TSA service.

Exceptions

Exception exception is thrown if saving a TS service URL into a user configuration file fails.

◆ setVerifyServiceUri()

void digidoc::XmlConfV4::setVerifyServiceUri ( const std::string & url )

virtual

Sets a Verify service URL. Also adds or replaces Verify service URL in the user configuration file.

Parameters

url	Target URL to connect Verify service.

Exceptions

Exception exception is thrown if saving a Verify service URL into a user configuration file fails.

◆ signatureDigestUri()

std::string digidoc::XmlConfV4::signatureDigestUri ( ) const

overridevirtual

Gets signature digest URI

Reimplemented from digidoc::Conf.

◆ TSLAutoUpdate()

bool digidoc::XmlConfV4::TSLAutoUpdate ( ) const

overridevirtual

Download new TSL list when it is expired or invalid

Reimplemented from digidoc::Conf.

◆ TSLCache()

std::string digidoc::XmlConfV4::TSLCache ( ) const

overridevirtual

TSL cache path in local file system

Reimplemented from digidoc::Conf.

◆ TSLOnlineDigest()

bool digidoc::XmlConfV4::TSLOnlineDigest ( ) const

overridevirtual

Compare local TSL digest with digest published online to check for newer version

Reimplemented from digidoc::Conf.

◆ TSLTimeOut()

int digidoc::XmlConfV4::TSLTimeOut ( ) const

overridevirtual

Gets TSL downloading connection's current timeout value

Reimplemented from digidoc::Conf.

◆ TSUrl()

std::string digidoc::XmlConfV4::TSUrl ( ) const

overridevirtual

Returns default time-stamp server URL

Reimplemented from digidoc::Conf.

◆ verifyServiceCert()

X509Cert XmlConfV4::verifyServiceCert ( ) const

overridevirtual

Gets verify service Cert

Reimplemented from digidoc::ConfV2.

References digidoc::ConfV2::verifyServiceCert().

◆ verifyServiceCerts()

vector< X509Cert > XmlConfV4::verifyServiceCerts ( ) const

overridevirtual

Gets verify service Certs

Reimplemented from digidoc::ConfV4.

References digidoc::ConfV4::verifyServiceCerts().

◆ verifyServiceUri()

std::string digidoc::XmlConfV4::verifyServiceUri ( ) const

overridevirtual

Gets verify service URI

Reimplemented from digidoc::Conf.

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

XmlConf.h
XmlConf.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ XmlConfV4()

◆ ~XmlConfV4()

Member Function Documentation

◆ digestUri()

◆ instance()

◆ logFile()

◆ logLevel()

◆ ocsp()

◆ OCSPTMProfiles()

◆ PKCS11Driver()

◆ PKCS12Cert()

◆ PKCS12Disable()

◆ PKCS12Pass()

◆ proxyForceSSL()

◆ proxyHost()

◆ proxyPass()

◆ proxyPort()

◆ proxyTunnelSSL()

◆ proxyUser()

◆ setPKCS12Cert()

◆ setPKCS12Disable()

◆ setPKCS12Pass()

◆ setProxyHost()

◆ setProxyPass()

◆ setProxyPort()

◆ setProxyTunnelSSL()

◆ setProxyUser()

◆ setTSLOnlineDigest()

◆ setTSLTimeOut()

◆ setTSUrl()

◆ setVerifyServiceUri()

◆ signatureDigestUri()

◆ TSLAutoUpdate()

◆ TSLCache()

◆ TSLOnlineDigest()

◆ TSLTimeOut()

◆ TSUrl()

◆ verifyServiceCert()

◆ verifyServiceCerts()

◆ verifyServiceUri()