Version 6 of XML Configuration class. More...

#include <XmlConf.h>

Public Member Functions
	XmlConfV6 (const std::string &path={}, const std::string &schema={})
	~XmlConfV6 () 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::vector< X509Cert >	TSCerts () const override
std::string	TSUrl () const override
std::string	TSUrlArchive () const override
std::vector< X509Cert >	TSCertsArchive () 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	setTSUrlArchive (const std::string &url)
virtual void	setVerifyServiceUri (const std::string &url)
Public Member Functions inherited from digidoc::ConfV6
	ConfV6 ()
	~ConfV6 () override
Public Member Functions inherited from digidoc::ConfV5
	ConfV5 ()
	~ConfV5 () override
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 XmlConfV6 *	instance ()
Static Public Member Functions inherited from digidoc::ConfV6
static ConfV6 *	instance ()
Static Public Member Functions inherited from digidoc::ConfV5
static ConfV5 *	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 6 of XML Configuration class.

Since: 4.6.0

See also: digidoc::ConfV6

Constructor & Destructor Documentation

◆ XmlConfV6()

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

explicit

Initialize xml conf from path

References digidoc::Conf::xsdPath().

Referenced by instance(), setVerifyServiceUri(), TSUrlArchive(), and ~XmlConfV6().

◆ ~XmlConfV6()

XmlConfV6::~XmlConfV6 ( )

overridedefault

References instance(), and XmlConfV6().

Member Function Documentation

◆ digestUri()

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

overridevirtual

Return default digest type as URI

Reimplemented from digidoc::Conf.

◆ instance()

XmlConfV6 * XmlConfV6::instance ( )

static

Return global config instance object

References digidoc::Conf::instance(), and XmlConfV6().

Referenced by ~XmlConfV6().

◆ logFile()

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

overridevirtual

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

Reimplemented from digidoc::Conf.

◆ logLevel()

int digidoc::XmlConfV6::logLevel ( ) const

overridevirtual

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

Reimplemented from digidoc::Conf.

◆ ocsp()

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

overridevirtual

Since: 4.6.0

Reimplemented from digidoc::Conf.

References digidoc::Conf::ocsp().

Referenced by signatureDigestUri().

◆ OCSPTMProfiles()

set< string > XmlConfV6::OCSPTMProfiles ( ) const

overridevirtual

Since: 4.6.0

Reimplemented from digidoc::ConfV3.

References digidoc::ConfV3::OCSPTMProfiles().

Referenced by signatureDigestUri().

◆ PKCS11Driver()

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

overridevirtual

Returns PKCS11 driver file path

Reimplemented from digidoc::Conf.

◆ PKCS12Cert()

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

overridevirtual

Gets PKCS12 certificate file location.

Used for signing OCSP request

Deprecated: Since 3.16.0

Reimplemented from digidoc::Conf.

◆ PKCS12Disable()

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

overridevirtual

Gets PKCS12 usage.

Deprecated: Since 3.16.0

See also: digidoc::Conf::PKCS12Cert

Reimplemented from digidoc::Conf.

◆ PKCS12Pass()

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

overridevirtual

Gets PKCS12 password.

Deprecated: Since 3.16.0

See also: digidoc::Conf::PKCS12Cert

Reimplemented from digidoc::Conf.

◆ proxyForceSSL()

bool digidoc::XmlConfV6::proxyForceSSL ( ) const

overridevirtual

Redirect SSL traffic over proxy server Default: false

Reimplemented from digidoc::Conf.

◆ proxyHost()

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

overridevirtual

Gets proxy host address.

Reimplemented from digidoc::Conf.

◆ proxyPass()

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

overridevirtual

Gets proxy login password.

Reimplemented from digidoc::Conf.

◆ proxyPort()

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

overridevirtual

Gets proxy port number.

Reimplemented from digidoc::Conf.

◆ proxyTunnelSSL()

bool digidoc::XmlConfV6::proxyTunnelSSL ( ) const

overridevirtual

Tunnel SSL traffic over proxy server Default: false

Reimplemented from digidoc::Conf.

◆ proxyUser()

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

overridevirtual

Gets proxy user name.

Reimplemented from digidoc::Conf.

◆ setPKCS12Cert()

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

virtual

◆ setPKCS12Disable()

virtual DIGIDOCPP_DEPRECATED void digidoc::XmlConfV6::setPKCS12Disable ( bool disable )

virtual

◆ setPKCS12Pass()

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

virtual

◆ setProxyHost()

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

virtual

◆ setProxyPass()

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

virtual

◆ setProxyPort()

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

virtual

◆ setProxyTunnelSSL()

virtual void digidoc::XmlConfV6::setProxyTunnelSSL ( bool enable )

virtual

◆ setProxyUser()

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

virtual

◆ setTSLOnlineDigest()

virtual void digidoc::XmlConfV6::setTSLOnlineDigest ( bool enable )

virtual

◆ setTSLTimeOut()

virtual void digidoc::XmlConfV6::setTSLTimeOut ( int timeOut )

virtual

◆ setTSUrl()

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

virtual

References setTSUrlArchive().

◆ setTSUrlArchive()

void XmlConfV6::setTSUrlArchive ( const std::string & url )

virtual

Sets an archive (LTA) TSA service URL. Also adds or replaces the archive TSA service URL in the user configuration file.

Parameters

url	Target URL to connect archive TSA service.

Exceptions

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

Since: 4.6.0

Referenced by setTSUrl().

◆ setVerifyServiceUri()

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

virtual

References XmlConfV6().

◆ signatureDigestUri()

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

overridevirtual

Gets signature digest URI

Reimplemented from digidoc::Conf.

References ocsp(), OCSPTMProfiles(), and TSCerts().

◆ TSCerts()

vector< X509Cert > XmlConfV6::TSCerts ( ) const

overridevirtual

Since: 4.6.0

Reimplemented from digidoc::ConfV5.

References digidoc::ConfV5::TSCerts().

Referenced by signatureDigestUri().

◆ TSCertsArchive()

vector< X509Cert > XmlConfV6::TSCertsArchive ( ) const

overridevirtual

Since: 4.6.0

Reimplemented from digidoc::ConfV6.

References digidoc::ConfV6::TSCertsArchive().

Referenced by TSUrl().

◆ TSLAutoUpdate()

bool digidoc::XmlConfV6::TSLAutoUpdate ( ) const

overridevirtual

Download new TSL list when it is expired or invalid

Reimplemented from digidoc::Conf.

◆ TSLCache()

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

overridevirtual

TSL cache path in local file system

Reimplemented from digidoc::Conf.

◆ TSLOnlineDigest()

bool digidoc::XmlConfV6::TSLOnlineDigest ( ) const

overridevirtual

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

Reimplemented from digidoc::Conf.

◆ TSLTimeOut()

int digidoc::XmlConfV6::TSLTimeOut ( ) const

overridevirtual

Gets TSL downloading connection's current timeout value

Reimplemented from digidoc::Conf.

◆ TSUrl()

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

overridevirtual

Returns default time-stamp server URL

Reimplemented from digidoc::Conf.

References TSCertsArchive(), TSUrlArchive(), verifyServiceCert(), and verifyServiceCerts().

Referenced by TSUrlArchive().

◆ TSUrlArchive()

string XmlConfV6::TSUrlArchive ( ) const

overridevirtual

Gets time-stamp service URL used for archive (LTA) time-stamps. Falls back to TSUrl() when "ts.url.archive" is not configured.

Since: 4.6.0

Reimplemented from digidoc::ConfV6.

References TSUrl(), TSUrlArchive(), and XmlConfV6().

Referenced by TSUrl(), and TSUrlArchive().

◆ verifyServiceCert()

X509Cert XmlConfV6::verifyServiceCert ( ) const

overridevirtual

Since: 4.6.0

Reimplemented from digidoc::ConfV2.

References digidoc::ConfV2::verifyServiceCert().

Referenced by TSUrl().

◆ verifyServiceCerts()

vector< X509Cert > XmlConfV6::verifyServiceCerts ( ) const

overridevirtual

Since: 4.6.0

Reimplemented from digidoc::ConfV4.

References digidoc::ConfV4::verifyServiceCerts().

Referenced by TSUrl().

◆ verifyServiceUri()

std::string digidoc::XmlConfV6::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

◆ XmlConfV6()

◆ ~XmlConfV6()

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()

◆ setTSUrlArchive()

◆ setVerifyServiceUri()

◆ signatureDigestUri()

◆ TSCerts()

◆ TSCertsArchive()

◆ TSLAutoUpdate()

◆ TSLCache()

◆ TSLOnlineDigest()

◆ TSLTimeOut()

◆ TSUrl()

◆ TSUrlArchive()

◆ verifyServiceCert()

◆ verifyServiceCerts()

◆ verifyServiceUri()