#include <eidlib.h>

Public Member Functions
virtual PTEIDSDK_API PTEID_ByteArray	Sign (const PTEID_ByteArray &data, bool signatureKey=false)=0

virtual PTEIDSDK_API PTEID_ByteArray	SignSHA256 (const PTEID_ByteArray &data, bool signatureKey=false)=0

virtual PTEIDSDK_API PTEID_ByteArray	SignXades (const char output_path, const char const *paths, unsigned int n_paths, PTEID_SignatureLevel level=PTEID_LEVEL_BASIC)=0

virtual PTEIDSDK_API PTEID_ByteArray	SignXadesT (const char output_path, const char const *paths, unsigned int n_paths)=0

virtual PTEIDSDK_API PTEID_ByteArray	SignXadesA (const char output_path, const char const *paths, unsigned int n_paths)=0

virtual PTEIDSDK_API void	SignXadesIndividual (const char output_path, const char const *paths, unsigned int n_paths)=0

virtual PTEIDSDK_API void	SignXadesTIndividual (const char output_path, const char const *paths, unsigned int n_paths)=0

virtual PTEIDSDK_API void	SignXadesAIndividual (const char output_path, const char const *paths, unsigned int n_paths)=0

virtual PTEIDSDK_API int	SignPDF (PTEID_PDFSignature &sig_handler, int page, int page_sector, bool is_landscape, const char location, const char reason, const char *outfile_path)=0

virtual PTEIDSDK_API int	SignPDF (PTEID_PDFSignature &sig_handler, int page, double coord_x, double coord_y, const char location, const char reason, const char *outfile_path)=0

virtual PTEIDSDK_API PTEID_Certificates &	getCertificates ()=0

virtual PTEIDSDK_API PTEID_Certificate &	getCert (PTEID_CertifType type)=0

virtual PTEIDSDK_API PTEID_Certificate &	getRoot ()=0

virtual PTEIDSDK_API PTEID_Certificate &	getCA ()=0

virtual PTEIDSDK_API PTEID_Certificate &	getSignature ()=0

virtual PTEIDSDK_API PTEID_Certificate &	getAuthentication ()=0

virtual PTEIDSDK_API PTEID_SigningDeviceType	getDeviceType ()=0

Detailed Description

Interface class for objects with Signing capabilities.

Since: 3.8.0

Member Function Documentation

◆ getAuthentication()

virtual PTEIDSDK_API PTEID_Certificate& eIDMW::PTEID_SigningDevice::getAuthentication ( )

pure virtual

Deprecated:: Use getCertificates() to obtain the certificates and obtain the desired certificate/build the chain manually.

Implemented in eIDMW::PTEID_CMDSignatureClient, and eIDMW::PTEID_Card.

◆ getCA()

virtual PTEIDSDK_API PTEID_Certificate& eIDMW::PTEID_SigningDevice::getCA ( )

pure virtual

Deprecated:: Use getCertificates() to obtain the certificates and obtain the desired certificate/build the chain manually.

Implemented in eIDMW::PTEID_CMDSignatureClient, and eIDMW::PTEID_Card.

◆ getCert()

virtual PTEIDSDK_API PTEID_Certificate& eIDMW::PTEID_SigningDevice::getCert ( PTEID_CertifType type )

pure virtual

Deprecated:: Use getCertificates() to obtain the certificates and obtain the desired certificate/build the chain manually.

Implemented in eIDMW::PTEID_CMDSignatureClient, and eIDMW::PTEID_Card.

◆ getCertificates()

virtual PTEIDSDK_API PTEID_Certificates& eIDMW::PTEID_SigningDevice::getCertificates ( )

pure virtual

Deprecated:: Use getCertificates() to obtain the certificates and obtain the desired certificate/build the chain manually.

Implemented in eIDMW::PTEID_CMDSignatureClient, and eIDMW::PTEID_Card.

◆ getDeviceType()

virtual PTEIDSDK_API PTEID_SigningDeviceType eIDMW::PTEID_SigningDevice::getDeviceType ( )

pure virtual

Get type of SigningDeviceType.

Implemented in eIDMW::PTEID_CMDSignatureClient, and eIDMW::PTEID_Card.

◆ getRoot()

virtual PTEIDSDK_API PTEID_Certificate& eIDMW::PTEID_SigningDevice::getRoot ( )

pure virtual

Deprecated:: Use getCertificates() to obtain the certificates and obtain the desired certificate/build the chain manually.

Implemented in eIDMW::PTEID_CMDSignatureClient, and eIDMW::PTEID_Card.

◆ getSignature()

virtual PTEIDSDK_API PTEID_Certificate& eIDMW::PTEID_SigningDevice::getSignature ( )

pure virtual

Deprecated:: Use getCertificates() to obtain the certificates and obtain the desired certificate/build the chain manually.

Implemented in eIDMW::PTEID_CMDSignatureClient, and eIDMW::PTEID_Card.

◆ Sign()

virtual PTEIDSDK_API PTEID_ByteArray eIDMW::PTEID_SigningDevice::Sign	(	const PTEID_ByteArray &	data,
		bool	signatureKey = `false`
	)

pure virtual

Raw RSA signature with PCKS #1 padding.

Parameters

data	holds the data to be signed, at most 32 bytes. This data should be hashed using sha256.
signatureKey	whether to use the 'Signature key'. By default, it uses the 'Authentication private key'. To sign with the 'Signature private key' set the parameter signatureKey to true.

Returns: A PTEID_ByteArray containing the signed data.

Implemented in eIDMW::PTEID_CMDSignatureClient, and eIDMW::PTEID_Card.

◆ SignPDF() [1/2]

virtual PTEIDSDK_API int eIDMW::PTEID_SigningDevice::SignPDF	(	PTEID_PDFSignature &	sig_handler,
		int	page,
		int	page_sector,
		bool	is_landscape,
		const char *	location,
		const char *	reason,
		const char *	outfile_path
	)

pure virtual

PDF Signature with location by page sector (the portrait A4 page is split into 18 cells: 6 lines and 3 columns) If PTEID_Exception(EIDMW_TIMESTAMP_ERROR) is thrown, the resulting file is a PAdES-B signature. If PTEID_Exception(EIDMW_LTV_ERROR) is thrown, the resulting file is a PAdES-LT or PAdES-LTA depending where the timestamping fails.

Parameters

sig_handler	this defines the input file and some signature options
page	in case of visible signature it defines the page where the signature will appear
page_sector	position in the signature grid, between 1 to 18 for Portrait documents and 1 to 20 for Landscape ones
is_landscape	is unused parameter, the SDK now detects document orientation automatically
location	Signature metadata field
reason	Signature metadata field
outfile_path	Native Filesystem path of the ouput file

Deprecated:: use the SignPDF function with location coordinates instead

Implemented in eIDMW::PTEID_CMDSignatureClient, and eIDMW::PTEID_Card.

◆ SignPDF() [2/2]

virtual PTEIDSDK_API int eIDMW::PTEID_SigningDevice::SignPDF	(	PTEID_PDFSignature &	sig_handler,
		int	page,
		double	coord_x,
		double	coord_y,
		const char *	location,
		const char *	reason,
		const char *	outfile_path
	)

pure virtual

PDF Signature with location by coordinates (expressed in percentage of page height/width). The coordinate system has its origin in the top left corner of the page If PTEID_Exception(EIDMW_TIMESTAMP_ERROR) is thrown, the resulting file is a PAdES-B signature. If PTEID_Exception(EIDMW_LTV_ERROR) is thrown, the resulting file is a PAdES-LT or PAdES-LTA depending where the timestamping fails.

Parameters

sig_handler	this defines the input file and some signature options
page	in case of visible signature it defines the page where the signature will appear
coord_x	X coordinate of the signature location (percentage of page width)
coord_y	Y coordinate of the signature location (percentage of page height)
location	Location field in the added signature metadata
reason	Signature metadata field
outfile_path	Native Filesystem path of the ouput file

Implemented in eIDMW::PTEID_CMDSignatureClient, and eIDMW::PTEID_Card.

◆ SignSHA256()

virtual PTEIDSDK_API PTEID_ByteArray eIDMW::PTEID_SigningDevice::SignSHA256	(	const PTEID_ByteArray &	data,
		bool	signatureKey = `false`
	)

pure virtual

Raw RSA signature with PCKS #1 padding (applied to a SHA256 hash).

Parameters

data	holds the data to be signed, it should be 32 bytes.
signatureKey	whether to use the 'Signature key'. By default, it uses the 'Authentication private key'. To sign with the 'Signature private key' set the parameter signatureKey to true.

Returns: A PTEID_ByteArray containing the signed data.

Deprecated:: This method is now deprecated. Use PTEID_SigningDevice::Sign method instead, which already supports SHA256.

Implemented in eIDMW::PTEID_CMDSignatureClient, and eIDMW::PTEID_Card.

◆ SignXades()

virtual PTEIDSDK_API PTEID_ByteArray eIDMW::PTEID_SigningDevice::SignXades	(	const char *	output_path,
		const char const	paths,
		unsigned int	n_paths,
		PTEID_SignatureLevel	level = `PTEID_LEVEL_BASIC`
	)

pure virtual

Produce a XAdES Signature of the files indicated by the parameter paths and stores the results in one ASiC container in a zip format. The location of the resulting ASiC container is indicated by the parameter output_path.

Parameters

paths	is an array of null-terminated strings representing absolute paths in the local filesystem. Those files content (hashed with SHA-256 algorithm) will be the input data for the RSA signature
n_paths	is the number of elements in the paths array
output_path	points to the resulting container
level	is an enum used to set the XAdES signature level/profile: XAdES-B (PTEID_LEVEL_BASIC), XAdES-T (PTEID_LEVEL_T), XAdES-LTA (PTEID_LEVEL_LTV). Note: Setting parameter level to PTEID_LEVEL_LT will throw PTEID_Exception(EIDMW_ERR_PARAM_BAD), as it is not supported yet.

Implemented in eIDMW::PTEID_CMDSignatureClient, and eIDMW::PTEID_Card.

◆ SignXadesA()

virtual PTEIDSDK_API PTEID_ByteArray eIDMW::PTEID_SigningDevice::SignXadesA	(	const char *	output_path,
		const char const	paths,
		unsigned int	n_paths
	)

pure virtual

Produce a XAdES-LTA Signature of the files indicated by the parameter paths and stores the results in one ASiC container in a zip format. The location of the resulting ASiC container is indicated by the parameter output_path. If PTEID_Exception(EIDMW_TIMESTAMP_ERROR) is thrown, the resulting file is a XAdES-B signature. If PTEID_Exception(EIDMW_LTV_ERROR) is thrown, the resulting file is a XAdES-LT or XAdES-LTA depending where the timestamping fails.

Parameters

paths	is an array of null-terminated strings representing absolute paths in the local filesystem. Those files content (hashed with SHA-256 algorithm) will be the input data for the RSA signature
n_paths	is the number of elements in the paths array
output_path	points to the resulting container

Deprecated:: use the SignXades function and set signature level with level (PTEID_SignatureLevel) parameter instead

Implemented in eIDMW::PTEID_CMDSignatureClient, and eIDMW::PTEID_Card.

◆ SignXadesAIndividual()

virtual PTEIDSDK_API void eIDMW::PTEID_SigningDevice::SignXadesAIndividual	(	const char *	output_path,
		const char const	paths,
		unsigned int	n_paths
	)

pure virtual

Produce XAdES-A Signatures of the files indicated by the parameter paths and stores each of the results in an individual ASiC container in a zip format. If PTEID_Exception(EIDMW_TIMESTAMP_ERROR) is thrown, the resulting file is a XAdES-B signature. If PTEID_Exception(EIDMW_LTV_ERROR) is thrown, the resulting file is a XAdES-LT or XAdES-LTA depending where the timestamping fails.

Parameters

paths	is an array of null-terminated strings representing absolute paths in the local filesystem. Those files content (hashed with SHA-256 algorithm) will be the input data for the RSA signature
n_paths	is the number of elements in the paths array
output_path	directory of the created ASiC containers

Implemented in eIDMW::PTEID_CMDSignatureClient, and eIDMW::PTEID_Card.

◆ SignXadesIndividual()

virtual PTEIDSDK_API void eIDMW::PTEID_SigningDevice::SignXadesIndividual	(	const char *	output_path,
		const char const	paths,
		unsigned int	n_paths
	)

pure virtual

Produce XAdES-B Signatures of the files indicated by the parameter paths and stores each of the results in an individual ASiC container in a zip format.

Parameters

paths	is an array of null-terminated strings representing absolute paths in the local filesystem. Those files content (hashed with SHA-256 algorithm) will be the input data for the RSA signature
n_paths	is the number of elements in the paths array
output_path	directory of the created ASiC containers

Implemented in eIDMW::PTEID_CMDSignatureClient, and eIDMW::PTEID_Card.

◆ SignXadesT()

virtual PTEIDSDK_API PTEID_ByteArray eIDMW::PTEID_SigningDevice::SignXadesT	(	const char *	output_path,
		const char const	paths,
		unsigned int	n_paths
	)

pure virtual

Produce a XAdES-T Signature of the files indicated by the parameter paths and stores the results in one ASiC container in a zip format. The location of the resulting ASiC container is indicated by the parameter output_path. If PTEID_Exception(EIDMW_TIMESTAMP_ERROR) is thrown, the resulting file is a XAdES-B signature.

Parameters

paths	is an array of null-terminated strings representing absolute paths in the local filesystem. Those files content (hashed with SHA-256 algorithm) will be the input data for the RSA signature
n_paths	is the number of elements in the paths array
output_path	points to the resulting container

Deprecated:: use the SignXades function and set signature level with level (PTEID_SignatureLevel) parameter instead

Implemented in eIDMW::PTEID_CMDSignatureClient, and eIDMW::PTEID_Card.

◆ SignXadesTIndividual()

virtual PTEIDSDK_API void eIDMW::PTEID_SigningDevice::SignXadesTIndividual	(	const char *	output_path,
		const char const	paths,
		unsigned int	n_paths
	)

pure virtual

Produce XAdES-T Signatures of the files indicated by the parameter paths and stores each of the results in an individual ASiC container in a zip format. If PTEID_Exception(EIDMW_TIMESTAMP_ERROR) is thrown, the resulting file is a XAdES-B signature.

Parameters

paths	is an array of null-terminated strings representing absolute paths in the local filesystem. Those files content (hashed with SHA-256 algorithm) will be the input data for the RSA signature
n_paths	is the number of elements in the paths array
output_path	directory of the created ASiC containers

Implemented in eIDMW::PTEID_CMDSignatureClient, and eIDMW::PTEID_Card.

Public Member Functions

Detailed Description

Member Function Documentation

◆ getAuthentication()

◆ getCA()

◆ getCert()

◆ getCertificates()

◆ getDeviceType()

◆ getRoot()

◆ getSignature()

◆ Sign()

◆ SignPDF() [1/2]

◆ SignPDF() [2/2]

◆ SignSHA256()

◆ SignXades()

◆ SignXadesA()

◆ SignXadesAIndividual()

◆ SignXadesIndividual()

◆ SignXadesT()

◆ SignXadesTIndividual()