Additional features that does not correspond directly with PDF. More...

Classes
class	BufferHandle
	Represents memory stored data. More...

class	BufferArrayHandle
	Represents a list of BufferHandle. More...

class	EncryptionKeyHandle
	Represents encryption key other than password. More...

class	Errors
	This class contains additional informations about last error occurred. More...

class	InputOutputStreamHandle
	Input stream can read and interpret input from sequences of characters. More...

class	InputStreamHandle
	Input stream can read and interpret input from sequences of characters. More...

class	LibraryInfo
	Informations about library version and author. More...

class	LicenseInfo
	Licensing utilities, determining whether this library is running in trial mode. More...

class	Logging
	The library can provide some additional debug and error messages. More...

class	MemoryBufferOutputStreamHandle
	An output stream that writes data to an internal memory buffer. More...

class	MiscUtils
	Static utility class for OpenSSL initialization and cleanup. More...

class	ObjectDiagnostics
	Provides runtime introspection of the object lifecycle. More...

class	OutputStreamHandle
	Output stream can write sequences of characters and represent other kinds of data. More...

class	PKCS12KeyHandle
	PKCS#12 container is often used in cryptography to store asymmetric key pair. More...

class	SignatureVerificationSettingsHandle
	Configuration settings for signature verification. More...

class	TrustedCertificateStoreHandle
	Collection of trusted certificates for signature verification. More...

class	SignatureVerificationResultHandle
	Result of signature verification operation. More...

class	SignatureVerifier
	Static utility class for PKCS#7 signature verification. More...

class	SigningKeyHandle
	Used for document signing. More...

class	IUnknownHandle
	Base class for reference counting. More...

Enumerations
enum	IOStrategyType { IOStrategy_Undefined = 0 , IOStrategy_Memory , IOStrategy_MemoryMapped , IOStrategy_FileStream }
	Specifies the I/O strategy used for file access. More...

enum	MessageDigestAlgorithmType { MessageDigestAlgorithmType_Undefined = 0 , MessageDigestAlgorithmType_MDNULL , MessageDigestAlgorithmType_MD2 , MessageDigestAlgorithmType_MD4 , MessageDigestAlgorithmType_MD5 , MessageDigestAlgorithmType_SHA1 , MessageDigestAlgorithmType_SHA224 , MessageDigestAlgorithmType_SHA256 , MessageDigestAlgorithmType_SHA384 , MessageDigestAlgorithmType_SHA512 , MessageDigestAlgorithmType_MDC2 , MessageDigestAlgorithmType_RIPEMD160 , MessageDigestAlgorithmType_WHIRLPOOL }
	Supported digest algorithms used as hash functions. More...

enum	PDFVersion { PDFVersion_Undefined = 0 , PDFVersion_10 , PDFVersion_11 , PDFVersion_12 , PDFVersion_13 , PDFVersion_14 , PDFVersion_15 , PDFVersion_16 , PDFVersion_17 , PDFVersion_20 }
	Range of available PDF versions. More...

enum	SignatureVerificationStatusType { SignatureStatus_Undefined = 0 , SignatureStatus_Valid , SignatureStatus_Invalid , SignatureStatus_CertificateExpired , SignatureStatus_CertificateNotYetValid , SignatureStatus_CertificateRevoked , SignatureStatus_CertificateUntrusted , SignatureStatus_DocumentModified , SignatureStatus_WeakAlgorithm , SignatureStatus_MissingCertificate , SignatureStatus_Unknown }
	Overall status of signature verification. More...

Functions
error_type CALLING_CONVENTION	TextStringEncoding_Detect (string_type data, size_type size, TextStringEncodingType *result)
	Detect the encoding of a PDF text string from its raw bytes.

error_type CALLING_CONVENTION	TextStringEncoding_PDFDocEncodingByteToUnicode (uint8_t byte, uint32_t *codepoint)
	Map a single PDFDocEncoding byte to its Unicode code point.

Detailed Description

Additional features that does not correspond directly with PDF.

Enumeration Type Documentation

◆ IOStrategyType

enum IOStrategyType

Specifies the I/O strategy used for file access.

Controls how the library accesses file data:

IOStrategy_Undefined: Uses the default implementation (currently fstream)
IOStrategy_Memory: Loads entire file into memory (not yet supported)
IOStrategy_MemoryMapped: Uses memory-mapped file access (not yet supported)
IOStrategy_FileStream: Uses FILE*-based streaming I/O

Enumerator
IOStrategy_Undefined	Uses the default implementation (currently fstream).
IOStrategy_Memory	Loads entire file into memory. Not yet supported, returns NotSupported error.
IOStrategy_MemoryMapped	Uses memory-mapped file access. Not yet supported, returns NotSupported error.
IOStrategy_FileStream	Uses FILE*-based streaming I/O.

◆ MessageDigestAlgorithmType

enum MessageDigestAlgorithmType

Supported digest algorithms used as hash functions.

Enumerator
MessageDigestAlgorithmType_Undefined	Undefined unitialized default value, triggers error when used.
MessageDigestAlgorithmType_MDNULL	"null" message digest that does nothing: i.e. the hash it returns is of zero length.
MessageDigestAlgorithmType_MD2	The MD2 Message - Digest Algorithm is a cryptographic hash function developed by Ronald Rivest in 1989.
MessageDigestAlgorithmType_MD4	The MD4 Message - Digest Algorithm is a cryptographic hash function developed by Ronald Rivest in 1990.
MessageDigestAlgorithmType_MD5	MD5 is one in a series of message digest algorithms designed by Professor Ronald Rivest of MIT (Rivest, 1992).
MessageDigestAlgorithmType_SHA1	A 160-bit hash function which resembles the earlier MD5 algorithm.
MessageDigestAlgorithmType_SHA224	SHA-2 (Secure Hash Algorithm 2) is a set of cryptographic hash functions designed by the United States National Security Agency (NSA).
MessageDigestAlgorithmType_SHA256	SHA-2 (Secure Hash Algorithm 2) is a set of cryptographic hash functions designed by the United States National Security Agency (NSA).
MessageDigestAlgorithmType_SHA384	SHA-2 (Secure Hash Algorithm 2) is a set of cryptographic hash functions designed by the United States National Security Agency (NSA).
MessageDigestAlgorithmType_SHA512	SHA-2 (Secure Hash Algorithm 2) is a set of cryptographic hash functions designed by the United States National Security Agency (NSA).
MessageDigestAlgorithmType_MDC2	MDC - 2 (Modification Detection Code 2, sometimes called Meyer - Schilling) is a cryptographic hash function.
MessageDigestAlgorithmType_RIPEMD160	RIPEMD (RACE Integrity Primitives Evaluation Message Digest) is an improved, 160-bit version of the original RIPEMD, and the most common version in the family.
MessageDigestAlgorithmType_WHIRLPOOL	WHIRLPOOL is a cryptographic hash function designed by Vincent Rijmen.

◆ PDFVersion

enum PDFVersion

Range of available PDF versions.

Enumerator
PDFVersion_10	PDF version 1.0.
PDFVersion_11	PDF version 1.1.
PDFVersion_12	PDF version 1.2.
PDFVersion_13	PDF version 1.3.
PDFVersion_14	PDF version 1.4.
PDFVersion_15	PDF version 1.5.
PDFVersion_16	PDF version 1.6.
PDFVersion_17	PDF version 1.7.
PDFVersion_20	PDF version 2.0.

◆ SignatureVerificationStatusType

enum SignatureVerificationStatusType

Overall status of signature verification.

Enumerator
SignatureStatus_Undefined	Status not set (uninitialized)
SignatureStatus_Valid	Signature is cryptographically valid
SignatureStatus_Invalid	Signature verification failed
SignatureStatus_CertificateExpired	Certificate has expired
SignatureStatus_CertificateNotYetValid	Certificate not yet valid
SignatureStatus_CertificateRevoked	Certificate has been revoked
SignatureStatus_CertificateUntrusted	Certificate chain not trusted
SignatureStatus_DocumentModified	Document modified after signing
SignatureStatus_WeakAlgorithm	Weak digest algorithm (MD5, SHA1)
SignatureStatus_MissingCertificate	Signature missing certificate
SignatureStatus_Unknown	Unable to determine status

Function Documentation

◆ TextStringEncoding_Detect()

error_type CALLING_CONVENTION TextStringEncoding_Detect	(	string_type	data,
		size_type	size,
		TextStringEncodingType *	result
	)

Detect the encoding of a PDF text string from its raw bytes.

Parameters

[in]	data	Pointer to the raw PDF text string bytes.
[in]	size	Number of bytes in `data`.
[out]	result	The detected encoding type.

◆ TextStringEncoding_PDFDocEncodingByteToUnicode()

error_type CALLING_CONVENTION TextStringEncoding_PDFDocEncodingByteToUnicode	(	uint8_t	byte,
		uint32_t *	codepoint
	)

Map a single PDFDocEncoding byte to its Unicode code point.