digidoc Namespace Reference

Classes
class	Conf
	Configuration class which can reimplemented and virtual methods overloaded. More...
class	ConfV2
	Verison 2 of configuration class to add additonial parameters. More...
class	ConfV3
	Verison 3 of configuration class to add additonial parameters. More...
class	ConfV4
	Verison 4 of configuration class to add additonial parameters. More...
class	ConfV5
	Verison 5 of configuration class to add additonial parameters. More...
struct	ContainerOpenCB
	Used on container open to provide additional info. More...
class	Container
	Offers functionality for handling data files and signatures in a container. More...
class	PKCS11Signer
	Implements Signer interface for ID-Cards, which support PKCS#11 protocol. More...
class	PKCS12Signer
	Implements Signer interface for PKCS#12 files. More...
class	Signer
	Signer interface. Provides interface for signing documents. More...
class	WinSigner
	Implements Signer interface for Windows Crypto backends. More...
class	X509Cert
	Wrapper for OpenSSL X509 certificate structure. More...
class	DataFile
	Data file wrapper providing methods for handling signed files or files to be signed in Container. More...
class	DataFilePrivate
class	Exception
	Base exception class of the digidoc implementation. More...
class	Signature
	Signature interface. Provides interface for handling a signature and the corresponding OCSP response properties. More...
class	XmlConf
	XML Configuration class. More...
class	XmlConfV2
	Version 2 of XML Configuration class. More...
class	XmlConfV3
	Version 3 of XML Configuration class. More...
class	XmlConfV4
	Version 4 of XML Configuration class. More...
class	XmlConfV5
	Version 5 of XML Configuration class. More...
struct	unique_xml
struct	unique_xml< void(T *)>
struct	XMLElem
struct	XMLName
struct	XMLNode
struct	XMLDocument

Typedefs
using	ConfCurrent = ConfV5
using	initCallBack = void(*)(const Exception *e)
using	XmlConfCurrent = XmlConfV5
template<typename T >
using	unique_xml_t = typename unique_xml< T >::type

Functions
DIGIDOCPP_EXPORT std::string	appInfo ()
DIGIDOCPP_EXPORT void	initialize (const std::string &appInfo="libdigidocpp", initCallBack callBack=nullptr)
DIGIDOCPP_EXPORT void	initialize (const std::string &appInfo, const std::string &userAgent, initCallBack callBack=nullptr)
DIGIDOCPP_EXPORT void	terminate ()
DIGIDOCPP_EXPORT std::string	userAgent ()
DIGIDOCPP_EXPORT std::string	version ()
template<class T , typename D >
constexpr std::unique_ptr< T, D >	make_unique_ptr (T *p, D d) noexcept
static std::string	to_base64 (const std::vector< unsigned char > &data)

Variables
static xsltSecurityPrefsPtr	xsltSecPrefs {}

Typedef Documentation

ConfCurrent

digidoc::ConfCurrent

Reference to latest ConfV5 class.

initCallBack

initCallBack

Parameters

e	digidoc::Exception that occured on initialization

Used in digidoc::initialize to notfiy if the initalization has completed

unique_xml_t

template<typename T >

using digidoc::unique_xml_t = typedef typename unique_xml<T>::type

XmlConfCurrent

digidoc::XmlConfCurrent

Reference to latest XmlConfV5 class

Function Documentation

appInfo()

string digidoc::appInfo

(

)

Returns registered application name

Referenced by initialize().

initialize() [1/2]

void digidoc::initialize	(	const std::string &	appInfo,
		const std::string &	userAgent,
		initCallBack	callBack = nullptr
	)

Libdigidocpp’s initialization method: initializes dependent libraries, loads configuration settings from default configuration files (see Configuring Libdigidocpp) and initializes certificate store using TSL lists

Parameters

appInfo	Application name for container comments
userAgent	Application info for user agent string
callBack	Callback when background thread TSL loading is completed

References appInfo(), digidoc::Conf::init(), digidoc::Conf::instance(), userAgent(), and xsltSecPrefs.

initialize() [2/2]

void digidoc::initialize	(	const std::string &	appInfo = "libdigidocpp",
		initCallBack	callBack = nullptr
	)

Libdigidocpp’s initialization method: initializes dependent libraries, loads configuration settings from default configuration files (see Configuring Libdigidocpp) and initializes certificate store using TSL lists

Parameters

appInfo	Application name for user agent string and container comments
callBack	Callback when background thread TSL loading is completed

References appInfo().

make_unique_ptr()

template<class T , typename D >

constexpr std::unique_ptr<T, D> digidoc::make_unique_ptr ( T *  p, D  d  )

constexprnoexcept

Referenced by to_base64(), digidoc::XMLDocument::validateSchema(), and digidoc::XMLDocument::verifySignature().

terminate()

void digidoc::terminate

(

)

The termination method closes libraries used in Libdigidocpp implementation and deletes temporary files that may have been written to disk when working with the library.

References digidoc::Conf::init(), and xsltSecPrefs.

to_base64()

static std::string digidoc::to_base64 ( const std::vector< unsigned char > &  data )

static

References make_unique_ptr().

userAgent()

string digidoc::userAgent

(

)

Returns user-agent info

Referenced by initialize().

version()

string digidoc::version

(

)

Returns libdigidocpp library version

Variable Documentation

xsltSecPrefs

xsltSecurityPrefsPtr digidoc::xsltSecPrefs {}

static

Referenced by initialize(), and terminate().