1.4/cdoc/_pdf_tools___pdf_tools_signature_validation_8h_source.html

/******************************************************************************

 *

 * File:            PdfTools_PdfToolsSignatureValidation.h

 *

 * Description:     Sub Header file for Pdftools SDK

 *

 * Author:          PDF Tools AG

 *

 * Copyright:       Copyright (C) 2023 - 2024 PDF Tools AG, Switzerland

 *                  All rights reserved.

 *

 * Notice:          By downloading and using this artifact, you accept PDF Tools AG's

 *                  [license agreement](https://www.pdf-tools.com/license-agreement/),

 *                  [privacy policy](https://www.pdf-tools.com/privacy-policy/),

 *                  and allow PDF Tools AG to track your usage data.

 *

 *****************************************************************************/


#ifndef PDFTOOLS_PDFTOOLSSIGNATUREVALIDATION_H__

#define PDFTOOLS_PDFTOOLSSIGNATUREVALIDATION_H__


#ifndef PDFTOOLS_CALL

#if defined(WIN32)

#define PDFTOOLS_CALL __stdcall

#else

#define PDFTOOLS_CALL

#endif

#endif


#include "PdfTools_Types.h"

#include "PdfTools_PdfToolsSys.h"


#ifdef __cplusplus

extern "C"

{

#endif


#ifdef _UNICODE

#define PdfToolsSignatureValidation_ConstraintResult_GetMessage PdfToolsSignatureValidation_ConstraintResult_GetMessageW


#define TPdfToolsSignatureValidation_Validator_Constraint TPdfToolsSignatureValidation_Validator_ConstraintW

#define PdfToolsSignatureValidation_Validator_AddConstraintHandler \

    PdfToolsSignatureValidation_Validator_AddConstraintHandlerW

#define PdfToolsSignatureValidation_Validator_RemoveConstraintHandler \

    PdfToolsSignatureValidation_Validator_RemoveConstraintHandlerW


#define PdfToolsSignatureValidation_Certificate_GetSubjectName PdfToolsSignatureValidation_Certificate_GetSubjectNameW


#define PdfToolsSignatureValidation_Certificate_GetSubject PdfToolsSignatureValidation_Certificate_GetSubjectW


#define PdfToolsSignatureValidation_Certificate_GetIssuerName PdfToolsSignatureValidation_Certificate_GetIssuerNameW


#define PdfToolsSignatureValidation_Certificate_GetFingerprint PdfToolsSignatureValidation_Certificate_GetFingerprintW


#define PdfToolsSignatureValidation_CustomTrustList_AddArchive PdfToolsSignatureValidation_CustomTrustList_AddArchiveW


#else

#define PdfToolsSignatureValidation_ConstraintResult_GetMessage PdfToolsSignatureValidation_ConstraintResult_GetMessageA


#define TPdfToolsSignatureValidation_Validator_Constraint TPdfToolsSignatureValidation_Validator_ConstraintA


#define PdfToolsSignatureValidation_Validator_AddConstraintHandler \

    PdfToolsSignatureValidation_Validator_AddConstraintHandlerA


#define PdfToolsSignatureValidation_Validator_RemoveConstraintHandler \

    PdfToolsSignatureValidation_Validator_RemoveConstraintHandlerA


#define PdfToolsSignatureValidation_Certificate_GetSubjectName PdfToolsSignatureValidation_Certificate_GetSubjectNameA


#define PdfToolsSignatureValidation_Certificate_GetSubject PdfToolsSignatureValidation_Certificate_GetSubjectA


#define PdfToolsSignatureValidation_Certificate_GetIssuerName PdfToolsSignatureValidation_Certificate_GetIssuerNameA


#define PdfToolsSignatureValidation_Certificate_GetFingerprint PdfToolsSignatureValidation_Certificate_GetFingerprintA


#define PdfToolsSignatureValidation_CustomTrustList_AddArchive PdfToolsSignatureValidation_CustomTrustList_AddArchiveA


#endif


typedef void(PDFTOOLS_CALL* TPdfToolsSignatureValidation_Validator_ConstraintA)(

    void* pContext, const char* szMessage, TPdfToolsSignatureValidation_Indication iIndication,

    TPdfToolsSignatureValidation_SubIndication iSubIndication, TPdfToolsPdf_SignedSignatureField* pSignature,

    const char* szDataPart);

typedef void(PDFTOOLS_CALL* TPdfToolsSignatureValidation_Validator_ConstraintW)(

    void* pContext, const WCHAR* szMessage, TPdfToolsSignatureValidation_Indication iIndication,

    TPdfToolsSignatureValidation_SubIndication iSubIndication, TPdfToolsPdf_SignedSignatureField* pSignature,

    const WCHAR* szDataPart);


/******************************************************************************

 * ConstraintResult

 *****************************************************************************/

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSignatureValidation_ConstraintResult_GetMessageA(

    TPdfToolsSignatureValidation_ConstraintResult* pConstraintResult, char* pBuffer, size_t nBufferSize);

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSignatureValidation_ConstraintResult_GetMessageW(

    TPdfToolsSignatureValidation_ConstraintResult* pConstraintResult, WCHAR* pBuffer, size_t nBufferSize);

PDFTOOLS_EXPORT TPdfToolsSignatureValidation_Indication PDFTOOLS_CALL

PdfToolsSignatureValidation_ConstraintResult_GetIndication(

    TPdfToolsSignatureValidation_ConstraintResult* pConstraintResult);

PDFTOOLS_EXPORT TPdfToolsSignatureValidation_SubIndication PDFTOOLS_CALL

PdfToolsSignatureValidation_ConstraintResult_GetSubIndication(

    TPdfToolsSignatureValidation_ConstraintResult* pConstraintResult);


/******************************************************************************

 * Validator

 *****************************************************************************/

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSignatureValidation_Validator_AddConstraintHandlerA(

    TPdfToolsSignatureValidation_Validator* pValidator, void* pContext,

    TPdfToolsSignatureValidation_Validator_ConstraintA pFunction);

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSignatureValidation_Validator_AddConstraintHandlerW(

    TPdfToolsSignatureValidation_Validator* pValidator, void* pContext,

    TPdfToolsSignatureValidation_Validator_ConstraintW pFunction);

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSignatureValidation_Validator_RemoveConstraintHandlerA(

    TPdfToolsSignatureValidation_Validator* pValidator, void* pContext,

    TPdfToolsSignatureValidation_Validator_ConstraintA pFunction);

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSignatureValidation_Validator_RemoveConstraintHandlerW(

    TPdfToolsSignatureValidation_Validator* pValidator, void* pContext,

    TPdfToolsSignatureValidation_Validator_ConstraintW pFunction);


PDFTOOLS_EXPORT TPdfToolsSignatureValidation_Validator* PDFTOOLS_CALL PdfToolsSignatureValidation_Validator_New(void);


PDFTOOLS_EXPORT TPdfToolsSignatureValidation_ValidationResults* PDFTOOLS_CALL

PdfToolsSignatureValidation_Validator_Validate(TPdfToolsSignatureValidation_Validator*        pValidator,

                                               TPdfToolsPdf_Document*                         pDocument,

                                               TPdfToolsSignatureValidationProfiles_Profile*  pProfile,

                                               TPdfToolsSignatureValidation_SignatureSelector iSelector);


/******************************************************************************

 * Certificate

 *****************************************************************************/

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSignatureValidation_Certificate_GetSubjectNameA(

    TPdfToolsSignatureValidation_Certificate* pCertificate, char* pBuffer, size_t nBufferSize);

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSignatureValidation_Certificate_GetSubjectNameW(

    TPdfToolsSignatureValidation_Certificate* pCertificate, WCHAR* pBuffer, size_t nBufferSize);

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSignatureValidation_Certificate_GetSubjectA(

    TPdfToolsSignatureValidation_Certificate* pCertificate, char* pBuffer, size_t nBufferSize);

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSignatureValidation_Certificate_GetSubjectW(

    TPdfToolsSignatureValidation_Certificate* pCertificate, WCHAR* pBuffer, size_t nBufferSize);

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSignatureValidation_Certificate_GetIssuerNameA(

    TPdfToolsSignatureValidation_Certificate* pCertificate, char* pBuffer, size_t nBufferSize);

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSignatureValidation_Certificate_GetIssuerNameW(

    TPdfToolsSignatureValidation_Certificate* pCertificate, WCHAR* pBuffer, size_t nBufferSize);

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSignatureValidation_Certificate_GetNotAfter(

    TPdfToolsSignatureValidation_Certificate* pCertificate, TPdfToolsSys_Date* pNotAfter);

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSignatureValidation_Certificate_GetNotBefore(

    TPdfToolsSignatureValidation_Certificate* pCertificate, TPdfToolsSys_Date* pNotBefore);

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSignatureValidation_Certificate_GetFingerprintA(

    TPdfToolsSignatureValidation_Certificate* pCertificate, char* pBuffer, size_t nBufferSize);

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSignatureValidation_Certificate_GetFingerprintW(

    TPdfToolsSignatureValidation_Certificate* pCertificate, WCHAR* pBuffer, size_t nBufferSize);

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSignatureValidation_Certificate_GetRawData(

    TPdfToolsSignatureValidation_Certificate* pCertificate, unsigned char* pBuffer, size_t nBufferSize);

PDFTOOLS_EXPORT TPdfToolsSignatureValidation_DataSource PDFTOOLS_CALL

PdfToolsSignatureValidation_Certificate_GetSource(TPdfToolsSignatureValidation_Certificate* pCertificate);

PDFTOOLS_EXPORT TPdfToolsSignatureValidation_ConstraintResult* PDFTOOLS_CALL

PdfToolsSignatureValidation_Certificate_GetValidity(TPdfToolsSignatureValidation_Certificate* pCertificate);


/******************************************************************************

 * CertificateChain

 *****************************************************************************/

PDFTOOLS_EXPORT int PDFTOOLS_CALL

PdfToolsSignatureValidation_CertificateChain_GetCount(TPdfToolsSignatureValidation_CertificateChain* pCertificateChain);

PDFTOOLS_EXPORT TPdfToolsSignatureValidation_Certificate* PDFTOOLS_CALL

PdfToolsSignatureValidation_CertificateChain_Get(TPdfToolsSignatureValidation_CertificateChain* pCertificateChain,

                                                 int                                            iIndex);


PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSignatureValidation_CertificateChain_IsComplete(

    TPdfToolsSignatureValidation_CertificateChain* pCertificateChain);


/******************************************************************************

 * ValidationResults

 *****************************************************************************/

PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfToolsSignatureValidation_ValidationResults_GetCount(

    TPdfToolsSignatureValidation_ValidationResults* pValidationResults);

PDFTOOLS_EXPORT TPdfToolsSignatureValidation_ValidationResult* PDFTOOLS_CALL

PdfToolsSignatureValidation_ValidationResults_Get(TPdfToolsSignatureValidation_ValidationResults* pValidationResults,

                                                  int                                             iIndex);


/******************************************************************************

 * ValidationResult

 *****************************************************************************/

PDFTOOLS_EXPORT TPdfToolsPdf_SignedSignatureField* PDFTOOLS_CALL

PdfToolsSignatureValidation_ValidationResult_GetSignatureField(

    TPdfToolsSignatureValidation_ValidationResult* pValidationResult);

PDFTOOLS_EXPORT TPdfToolsSignatureValidation_SignatureContent* PDFTOOLS_CALL

PdfToolsSignatureValidation_ValidationResult_GetSignatureContent(

    TPdfToolsSignatureValidation_ValidationResult* pValidationResult);


/******************************************************************************

 * SignatureContent

 *****************************************************************************/

PDFTOOLS_EXPORT TPdfToolsSignatureValidation_ConstraintResult* PDFTOOLS_CALL

PdfToolsSignatureValidation_SignatureContent_GetValidity(

    TPdfToolsSignatureValidation_SignatureContent* pSignatureContent);


PDFTOOLS_EXPORT TPdfToolsSignatureValidation_SignatureContentType PDFTOOLS_CALL

PdfToolsSignatureValidation_SignatureContent_GetType(TPdfToolsSignatureValidation_SignatureContent* pSignatureContent);

/******************************************************************************

 * CmsSignatureContent

 *****************************************************************************/

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSignatureValidation_CmsSignatureContent_GetValidationTime(

    TPdfToolsSignatureValidation_CmsSignatureContent* pCmsSignatureContent, TPdfToolsSys_Date* pValidationTime);

PDFTOOLS_EXPORT TPdfToolsSignatureValidation_TimeSource PDFTOOLS_CALL

PdfToolsSignatureValidation_CmsSignatureContent_GetValidationTimeSource(

    TPdfToolsSignatureValidation_CmsSignatureContent* pCmsSignatureContent);

PDFTOOLS_EXPORT TPdfToolsCrypto_HashAlgorithm PDFTOOLS_CALL

PdfToolsSignatureValidation_CmsSignatureContent_GetHashAlgorithm(

    TPdfToolsSignatureValidation_CmsSignatureContent* pCmsSignatureContent);

PDFTOOLS_EXPORT TPdfToolsSignatureValidation_TimeStampContent* PDFTOOLS_CALL

PdfToolsSignatureValidation_CmsSignatureContent_GetTimeStamp(

    TPdfToolsSignatureValidation_CmsSignatureContent* pCmsSignatureContent);

PDFTOOLS_EXPORT TPdfToolsSignatureValidation_Certificate* PDFTOOLS_CALL

PdfToolsSignatureValidation_CmsSignatureContent_GetSigningCertificate(

    TPdfToolsSignatureValidation_CmsSignatureContent* pCmsSignatureContent);

PDFTOOLS_EXPORT TPdfToolsSignatureValidation_CertificateChain* PDFTOOLS_CALL

PdfToolsSignatureValidation_CmsSignatureContent_GetCertificateChain(

    TPdfToolsSignatureValidation_CmsSignatureContent* pCmsSignatureContent);


/******************************************************************************

 * TimeStampContent

 *****************************************************************************/

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSignatureValidation_TimeStampContent_GetValidationTime(

    TPdfToolsSignatureValidation_TimeStampContent* pTimeStampContent, TPdfToolsSys_Date* pValidationTime);

PDFTOOLS_EXPORT TPdfToolsSignatureValidation_TimeSource PDFTOOLS_CALL

PdfToolsSignatureValidation_TimeStampContent_GetValidationTimeSource(

    TPdfToolsSignatureValidation_TimeStampContent* pTimeStampContent);

PDFTOOLS_EXPORT TPdfToolsCrypto_HashAlgorithm PDFTOOLS_CALL

PdfToolsSignatureValidation_TimeStampContent_GetHashAlgorithm(

    TPdfToolsSignatureValidation_TimeStampContent* pTimeStampContent);

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSignatureValidation_TimeStampContent_GetDate(

    TPdfToolsSignatureValidation_TimeStampContent* pTimeStampContent, TPdfToolsSys_Date* pDate);

PDFTOOLS_EXPORT TPdfToolsSignatureValidation_Certificate* PDFTOOLS_CALL

PdfToolsSignatureValidation_TimeStampContent_GetSigningCertificate(

    TPdfToolsSignatureValidation_TimeStampContent* pTimeStampContent);

PDFTOOLS_EXPORT TPdfToolsSignatureValidation_CertificateChain* PDFTOOLS_CALL

PdfToolsSignatureValidation_TimeStampContent_GetCertificateChain(

    TPdfToolsSignatureValidation_TimeStampContent* pTimeStampContent);


/******************************************************************************

 * CustomTrustList

 *****************************************************************************/

PDFTOOLS_EXPORT TPdfToolsSignatureValidation_CustomTrustList* PDFTOOLS_CALL

PdfToolsSignatureValidation_CustomTrustList_New(void);


PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSignatureValidation_CustomTrustList_AddCertificates(

    TPdfToolsSignatureValidation_CustomTrustList* pCustomTrustList, const TPdfToolsSys_StreamDescriptor* pCertificate);

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSignatureValidation_CustomTrustList_AddArchiveA(

    TPdfToolsSignatureValidation_CustomTrustList* pCustomTrustList, const TPdfToolsSys_StreamDescriptor* pStreamDesc,

    const char* szPassword);

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSignatureValidation_CustomTrustList_AddArchiveW(

    TPdfToolsSignatureValidation_CustomTrustList* pCustomTrustList, const TPdfToolsSys_StreamDescriptor* pStreamDesc,

    const WCHAR* szPassword);


#ifdef __cplusplus

}

#endif


#endif /* PDFTOOLS_PDFTOOLSSIGNATUREVALIDATION_H__ */

PdfToolsSignatureValidation_Certificate_GetSubjectNameA
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSignatureValidation_Certificate_GetSubjectNameA(TPdfToolsSignatureValidation_Certificate *pCertificate, char *pBuffer, size_t nBufferSize)
The name (subject) of the certificate The common name (CN) of the person or authority that owns the c...

PdfToolsSignatureValidation_Validator_RemoveConstraintHandlerA
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSignatureValidation_Validator_RemoveConstraintHandlerA(TPdfToolsSignatureValidation_Validator *pValidator, void *pContext, TPdfToolsSignatureValidation_Validator_ConstraintA pFunction)
Removes event handler.

PdfToolsSignatureValidation_TimeStampContent_GetSigningCertificate
PDFTOOLS_EXPORT TPdfToolsSignatureValidation_Certificate *PDFTOOLS_CALL PdfToolsSignatureValidation_TimeStampContent_GetSigningCertificate(TPdfToolsSignatureValidation_TimeStampContent *pTimeStampContent)
The signing certificate.

PdfToolsSignatureValidation_Certificate_GetFingerprintA
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSignatureValidation_Certificate_GetFingerprintA(TPdfToolsSignatureValidation_Certificate *pCertificate, char *pBuffer, size_t nBufferSize)
The certificate's fingerprint The hex string representation of the certificate’s SHA-1 digest.

PdfToolsSignatureValidation_CmsSignatureContent_GetTimeStamp
PDFTOOLS_EXPORT TPdfToolsSignatureValidation_TimeStampContent *PDFTOOLS_CALL PdfToolsSignatureValidation_CmsSignatureContent_GetTimeStamp(TPdfToolsSignatureValidation_CmsSignatureContent *pCmsSignatureContent)
The data and validation result of the embedded time-stamp.

PdfToolsSignatureValidation_TimeStampContent_GetValidationTime
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSignatureValidation_TimeStampContent_GetValidationTime(TPdfToolsSignatureValidation_TimeStampContent *pTimeStampContent, TPdfToolsSys_Date *pValidationTime)
The time at which the signature has been validated.

PdfToolsSignatureValidation_ConstraintResult_GetSubIndication
PDFTOOLS_EXPORT TPdfToolsSignatureValidation_SubIndication PDFTOOLS_CALL PdfToolsSignatureValidation_ConstraintResult_GetSubIndication(TPdfToolsSignatureValidation_ConstraintResult *pConstraintResult)
The sub indication.

PdfToolsSignatureValidation_ValidationResult_GetSignatureField
PDFTOOLS_EXPORT TPdfToolsPdf_SignedSignatureField *PDFTOOLS_CALL PdfToolsSignatureValidation_ValidationResult_GetSignatureField(TPdfToolsSignatureValidation_ValidationResult *pValidationResult)
The signature field.

PdfToolsSignatureValidation_Certificate_GetRawData
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSignatureValidation_Certificate_GetRawData(TPdfToolsSignatureValidation_Certificate *pCertificate, unsigned char *pBuffer, size_t nBufferSize)
The raw data of the certificate as a byte array.

PdfToolsSignatureValidation_ConstraintResult_GetIndication
PDFTOOLS_EXPORT TPdfToolsSignatureValidation_Indication PDFTOOLS_CALL PdfToolsSignatureValidation_ConstraintResult_GetIndication(TPdfToolsSignatureValidation_ConstraintResult *pConstraintResult)
The main indication.

PdfToolsSignatureValidation_Validator_Validate
PDFTOOLS_EXPORT TPdfToolsSignatureValidation_ValidationResults *PDFTOOLS_CALL PdfToolsSignatureValidation_Validator_Validate(TPdfToolsSignatureValidation_Validator *pValidator, TPdfToolsPdf_Document *pDocument, TPdfToolsSignatureValidationProfiles_Profile *pProfile, TPdfToolsSignatureValidation_SignatureSelector iSelector)
Validate the signatures of a PDF document.

PdfToolsSignatureValidation_Validator_AddConstraintHandlerA
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSignatureValidation_Validator_AddConstraintHandlerA(TPdfToolsSignatureValidation_Validator *pValidator, void *pContext, TPdfToolsSignatureValidation_Validator_ConstraintA pFunction)
Adds event handler.

PdfToolsSignatureValidation_CustomTrustList_AddCertificates
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSignatureValidation_CustomTrustList_AddCertificates(TPdfToolsSignatureValidation_CustomTrustList *pCustomTrustList, const TPdfToolsSys_StreamDescriptor *pCertificate)
Add one or more certificates Add certificates to the trust list.

PdfToolsSignatureValidation_CmsSignatureContent_GetValidationTimeSource
PDFTOOLS_EXPORT TPdfToolsSignatureValidation_TimeSource PDFTOOLS_CALL PdfToolsSignatureValidation_CmsSignatureContent_GetValidationTimeSource(TPdfToolsSignatureValidation_CmsSignatureContent *pCmsSignatureContent)
The source for the validation time.

PdfToolsSignatureValidation_TimeStampContent_GetCertificateChain
PDFTOOLS_EXPORT TPdfToolsSignatureValidation_CertificateChain *PDFTOOLS_CALL PdfToolsSignatureValidation_TimeStampContent_GetCertificateChain(TPdfToolsSignatureValidation_TimeStampContent *pTimeStampContent)
The certificate chain of the signing certificate.

PdfToolsSignatureValidation_Certificate_GetIssuerNameW
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSignatureValidation_Certificate_GetIssuerNameW(TPdfToolsSignatureValidation_Certificate *pCertificate, WCHAR *pBuffer, size_t nBufferSize)
The name of the certificate's issuer (CA) The common name (CN) of the certificate authority (CA) that...

PdfToolsSignatureValidation_ValidationResult_GetSignatureContent
PDFTOOLS_EXPORT TPdfToolsSignatureValidation_SignatureContent *PDFTOOLS_CALL PdfToolsSignatureValidation_ValidationResult_GetSignatureContent(TPdfToolsSignatureValidation_ValidationResult *pValidationResult)
The data and validation result of the cryptographic signature.

PdfToolsSignatureValidation_CmsSignatureContent_GetSigningCertificate
PDFTOOLS_EXPORT TPdfToolsSignatureValidation_Certificate *PDFTOOLS_CALL PdfToolsSignatureValidation_CmsSignatureContent_GetSigningCertificate(TPdfToolsSignatureValidation_CmsSignatureContent *pCmsSignatureContent)
The signing certificate.

PdfToolsSignatureValidation_CertificateChain_Get
PDFTOOLS_EXPORT TPdfToolsSignatureValidation_Certificate *PDFTOOLS_CALL PdfToolsSignatureValidation_CertificateChain_Get(TPdfToolsSignatureValidation_CertificateChain *pCertificateChain, int iIndex)
Returns the element at the specified position in the given list.

PdfToolsSignatureValidation_CmsSignatureContent_GetValidationTime
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSignatureValidation_CmsSignatureContent_GetValidationTime(TPdfToolsSignatureValidation_CmsSignatureContent *pCmsSignatureContent, TPdfToolsSys_Date *pValidationTime)
The time at which the signature has been validated.

PdfToolsSignatureValidation_Certificate_GetSubjectW
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSignatureValidation_Certificate_GetSubjectW(TPdfToolsSignatureValidation_Certificate *pCertificate, WCHAR *pBuffer, size_t nBufferSize)
The subject of the certificate The distinguished name (DN) of the person or authority that owns the c...

PdfToolsSignatureValidation_Certificate_GetNotBefore
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSignatureValidation_Certificate_GetNotBefore(TPdfToolsSignatureValidation_Certificate *pCertificate, TPdfToolsSys_Date *pNotBefore)
The date on which the certificate becomes valid.

PdfToolsSignatureValidation_TimeStampContent_GetHashAlgorithm
PDFTOOLS_EXPORT TPdfToolsCrypto_HashAlgorithm PDFTOOLS_CALL PdfToolsSignatureValidation_TimeStampContent_GetHashAlgorithm(TPdfToolsSignatureValidation_TimeStampContent *pTimeStampContent)
The hash algorithm used to calculate the signature's message digest.

PdfToolsSignatureValidation_CustomTrustList_AddArchiveA
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSignatureValidation_CustomTrustList_AddArchiveA(TPdfToolsSignatureValidation_CustomTrustList *pCustomTrustList, const TPdfToolsSys_StreamDescriptor *pStreamDesc, const char *szPassword)
Add certificates from a PFX (PKCS#12) archive Add certificates to the trust list.

PdfToolsSignatureValidation_CertificateChain_GetCount
PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfToolsSignatureValidation_CertificateChain_GetCount(TPdfToolsSignatureValidation_CertificateChain *pCertificateChain)
Get the number of elements in the list.

PdfToolsSignatureValidation_SignatureContent_GetValidity
PDFTOOLS_EXPORT TPdfToolsSignatureValidation_ConstraintResult *PDFTOOLS_CALL PdfToolsSignatureValidation_SignatureContent_GetValidity(TPdfToolsSignatureValidation_SignatureContent *pSignatureContent)
Whether the cryptographic signature is valid according to the validation profile used.

PdfToolsSignatureValidation_Certificate_GetIssuerNameA
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSignatureValidation_Certificate_GetIssuerNameA(TPdfToolsSignatureValidation_Certificate *pCertificate, char *pBuffer, size_t nBufferSize)
The name of the certificate's issuer (CA) The common name (CN) of the certificate authority (CA) that...

PdfToolsSignatureValidation_CertificateChain_IsComplete
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSignatureValidation_CertificateChain_IsComplete(TPdfToolsSignatureValidation_CertificateChain *pCertificateChain)
Whether all certificates of the chain are available.

PdfToolsSignatureValidation_ValidationResults_GetCount
PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfToolsSignatureValidation_ValidationResults_GetCount(TPdfToolsSignatureValidation_ValidationResults *pValidationResults)
Get the number of elements in the list.

PdfToolsSignatureValidation_TimeStampContent_GetDate
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSignatureValidation_TimeStampContent_GetDate(TPdfToolsSignatureValidation_TimeStampContent *pTimeStampContent, TPdfToolsSys_Date *pDate)
The time-stamp time.

TPdfToolsSignatureValidation_Validator_ConstraintW
void(PDFTOOLS_CALL * TPdfToolsSignatureValidation_Validator_ConstraintW)(void *pContext, const WCHAR *szMessage, TPdfToolsSignatureValidation_Indication iIndication, TPdfToolsSignatureValidation_SubIndication iSubIndication, TPdfToolsPdf_SignedSignatureField *pSignature, const WCHAR *szDataPart)
Definition PdfTools_PdfToolsSignatureValidation.h:124

PdfToolsSignatureValidation_Validator_AddConstraintHandlerW
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSignatureValidation_Validator_AddConstraintHandlerW(TPdfToolsSignatureValidation_Validator *pValidator, void *pContext, TPdfToolsSignatureValidation_Validator_ConstraintW pFunction)
Adds event handler.

PdfToolsSignatureValidation_TimeStampContent_GetValidationTimeSource
PDFTOOLS_EXPORT TPdfToolsSignatureValidation_TimeSource PDFTOOLS_CALL PdfToolsSignatureValidation_TimeStampContent_GetValidationTimeSource(TPdfToolsSignatureValidation_TimeStampContent *pTimeStampContent)
The source for the validation time.

PdfToolsSignatureValidation_Certificate_GetSource
PDFTOOLS_EXPORT TPdfToolsSignatureValidation_DataSource PDFTOOLS_CALL PdfToolsSignatureValidation_Certificate_GetSource(TPdfToolsSignatureValidation_Certificate *pCertificate)
Source of the certificate.

PdfToolsSignatureValidation_CmsSignatureContent_GetHashAlgorithm
PDFTOOLS_EXPORT TPdfToolsCrypto_HashAlgorithm PDFTOOLS_CALL PdfToolsSignatureValidation_CmsSignatureContent_GetHashAlgorithm(TPdfToolsSignatureValidation_CmsSignatureContent *pCmsSignatureContent)
The hash algorithm used to calculate the signature's message digest.

PdfToolsSignatureValidation_SignatureContent_GetType
PDFTOOLS_EXPORT TPdfToolsSignatureValidation_SignatureContentType PDFTOOLS_CALL PdfToolsSignatureValidation_SignatureContent_GetType(TPdfToolsSignatureValidation_SignatureContent *pSignatureContent)
Get actual derived type of base type TPdfToolsSignatureValidation_SignatureContent.

PdfToolsSignatureValidation_CmsSignatureContent_GetCertificateChain
PDFTOOLS_EXPORT TPdfToolsSignatureValidation_CertificateChain *PDFTOOLS_CALL PdfToolsSignatureValidation_CmsSignatureContent_GetCertificateChain(TPdfToolsSignatureValidation_CmsSignatureContent *pCmsSignatureContent)
The certificate chain of the signing certificate.

PdfToolsSignatureValidation_Certificate_GetSubjectNameW
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSignatureValidation_Certificate_GetSubjectNameW(TPdfToolsSignatureValidation_Certificate *pCertificate, WCHAR *pBuffer, size_t nBufferSize)
The name (subject) of the certificate The common name (CN) of the person or authority that owns the c...

PdfToolsSignatureValidation_Certificate_GetValidity
PDFTOOLS_EXPORT TPdfToolsSignatureValidation_ConstraintResult *PDFTOOLS_CALL PdfToolsSignatureValidation_Certificate_GetValidity(TPdfToolsSignatureValidation_Certificate *pCertificate)
Whether the certificate is valid according to the validation profile used.

PdfToolsSignatureValidation_Validator_RemoveConstraintHandlerW
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSignatureValidation_Validator_RemoveConstraintHandlerW(TPdfToolsSignatureValidation_Validator *pValidator, void *pContext, TPdfToolsSignatureValidation_Validator_ConstraintW pFunction)
Removes event handler.

TPdfToolsSignatureValidation_Validator_ConstraintA
void(PDFTOOLS_CALL * TPdfToolsSignatureValidation_Validator_ConstraintA)(void *pContext, const char *szMessage, TPdfToolsSignatureValidation_Indication iIndication, TPdfToolsSignatureValidation_SubIndication iSubIndication, TPdfToolsPdf_SignedSignatureField *pSignature, const char *szDataPart)
Definition PdfTools_PdfToolsSignatureValidation.h:99

PDFTOOLS_CALL
#define PDFTOOLS_CALL
Definition PdfTools_PdfToolsSignatureValidation.h:26

PdfToolsSignatureValidation_Certificate_GetNotAfter
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSignatureValidation_Certificate_GetNotAfter(TPdfToolsSignatureValidation_Certificate *pCertificate, TPdfToolsSys_Date *pNotAfter)
The date after which the certificate is no longer valid.

PdfToolsSignatureValidation_CustomTrustList_New
PDFTOOLS_EXPORT TPdfToolsSignatureValidation_CustomTrustList *PDFTOOLS_CALL PdfToolsSignatureValidation_CustomTrustList_New(void)

PdfToolsSignatureValidation_Validator_New
PDFTOOLS_EXPORT TPdfToolsSignatureValidation_Validator *PDFTOOLS_CALL PdfToolsSignatureValidation_Validator_New(void)

PdfToolsSignatureValidation_Certificate_GetSubjectA
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSignatureValidation_Certificate_GetSubjectA(TPdfToolsSignatureValidation_Certificate *pCertificate, char *pBuffer, size_t nBufferSize)
The subject of the certificate The distinguished name (DN) of the person or authority that owns the c...

PdfToolsSignatureValidation_Certificate_GetFingerprintW
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSignatureValidation_Certificate_GetFingerprintW(TPdfToolsSignatureValidation_Certificate *pCertificate, WCHAR *pBuffer, size_t nBufferSize)
The certificate's fingerprint The hex string representation of the certificate’s SHA-1 digest.

PdfToolsSignatureValidation_CustomTrustList_AddArchiveW
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSignatureValidation_CustomTrustList_AddArchiveW(TPdfToolsSignatureValidation_CustomTrustList *pCustomTrustList, const TPdfToolsSys_StreamDescriptor *pStreamDesc, const WCHAR *szPassword)
Add certificates from a PFX (PKCS#12) archive Add certificates to the trust list.

PdfToolsSignatureValidation_ConstraintResult_GetMessageW
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSignatureValidation_ConstraintResult_GetMessageW(TPdfToolsSignatureValidation_ConstraintResult *pConstraintResult, WCHAR *pBuffer, size_t nBufferSize)
The validation message.

PdfToolsSignatureValidation_ConstraintResult_GetMessageA
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSignatureValidation_ConstraintResult_GetMessageA(TPdfToolsSignatureValidation_ConstraintResult *pConstraintResult, char *pBuffer, size_t nBufferSize)
The validation message.

PdfToolsSignatureValidation_ValidationResults_Get
PDFTOOLS_EXPORT TPdfToolsSignatureValidation_ValidationResult *PDFTOOLS_CALL PdfToolsSignatureValidation_ValidationResults_Get(TPdfToolsSignatureValidation_ValidationResults *pValidationResults, int iIndex)
Returns the element at the specified position in the given list.

PdfTools_PdfToolsSys.h

PDFTOOLS_EXPORT
#define PDFTOOLS_EXPORT
Definition PdfTools_Platform.h:143

WCHAR
unsigned short WCHAR
Definition PdfTools_Platform.h:95

PdfTools_Types.h

TPdfToolsSignatureValidation_DataSource
TPdfToolsSignatureValidation_DataSource
The source of data such as certificates, OCRPs or CRLs.
Definition PdfTools_Types.h:1615

TPdfToolsSignatureValidation_SignatureSelector
TPdfToolsSignatureValidation_SignatureSelector
Select the signatures.
Definition PdfTools_Types.h:1571

TPdfToolsSignatureValidation_SubIndication
TPdfToolsSignatureValidation_SubIndication
Sub-status indication of the signature validation process See ETSI TS 102 853 and ETSI EN 319 102-1.
Definition PdfTools_Types.h:1431

TPdfToolsSignatureValidation_TimeSource
TPdfToolsSignatureValidation_TimeSource
The source of the validation time.
Definition PdfTools_Types.h:1586

TPdfToolsSignatureValidation_Indication
TPdfToolsSignatureValidation_Indication
Main status indication of the signature validation process See ETSI TS 102 853 and ETSI EN 319 102-1.
Definition PdfTools_Types.h:1410

TPdfToolsSignatureValidation_SignatureContentType
TPdfToolsSignatureValidation_SignatureContentType
Type and subtype enumeration of TPdfToolsSignatureValidation_SignatureContent.
Definition PdfTools_Types.h:2082

BOOL
#define BOOL
Definition PdfTools_Types.h:23

TPdfToolsCrypto_HashAlgorithm
TPdfToolsCrypto_HashAlgorithm
Definition PdfTools_Types.h:1216

TPdfToolsPdf_Document
The PDF document PDF documents are either opened using PdfToolsPdf_Document_Open or the result of an ...

TPdfToolsPdf_SignedSignatureField
A base class for signature fields that have been signed The existence of a signed signature field doe...

TPdfToolsSignatureValidation_CertificateChain

TPdfToolsSignatureValidation_Certificate
A X.509 certificate.

TPdfToolsSignatureValidation_CmsSignatureContent
The data and validation result of the cryptographic signature.

TPdfToolsSignatureValidation_ConstraintResult
The result of a constraint validation.

TPdfToolsSignatureValidation_CustomTrustList
The custom collection of trusted certificates This class defines a custom collection of trusted certi...

TPdfToolsSignatureValidation_SignatureContent
The data and validation result of the cryptographic signature.

TPdfToolsSignatureValidation_TimeStampContent
The data and validation result of the cryptographic time-stamp.

TPdfToolsSignatureValidation_ValidationResult
The result of a signature validation.

TPdfToolsSignatureValidation_ValidationResults

TPdfToolsSignatureValidation_Validator
The class to check the validity of signatures.

TPdfToolsSignatureValidationProfiles_Profile
The base class for signature validation profiles The profile defines the validation constraints.

TPdfToolsSys_Date
Definition PdfTools_Types.h:3322

TPdfToolsSys_StreamDescriptor
Structure that groups a set of callbacks that model streams.
Definition PdfTools_PdfToolsSys.h:49