1.4/cdoc/_pdf_tools___pdf_tools_crypto_providers_built_in_8h_source.html

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

 *

 * File:            PdfTools_PdfToolsCryptoProvidersBuiltIn.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_PDFTOOLSCRYPTOPROVIDERSBUILTIN_H__

#define PDFTOOLS_PDFTOOLSCRYPTOPROVIDERSBUILTIN_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 PdfToolsCryptoProvidersBuiltIn_Provider_CreateSignatureFromCertificate \

    PdfToolsCryptoProvidersBuiltIn_Provider_CreateSignatureFromCertificateW

#define PdfToolsCryptoProvidersBuiltIn_Provider_CreatePreparedSignature \

    PdfToolsCryptoProvidersBuiltIn_Provider_CreatePreparedSignatureW


#define PdfToolsCryptoProvidersBuiltIn_Provider_GetTimestampUrl PdfToolsCryptoProvidersBuiltIn_Provider_GetTimestampUrlW

#define PdfToolsCryptoProvidersBuiltIn_Provider_SetTimestampUrl PdfToolsCryptoProvidersBuiltIn_Provider_SetTimestampUrlW


#else


#define PdfToolsCryptoProvidersBuiltIn_Provider_CreateSignatureFromCertificate \

    PdfToolsCryptoProvidersBuiltIn_Provider_CreateSignatureFromCertificateA


#define PdfToolsCryptoProvidersBuiltIn_Provider_CreatePreparedSignature \

    PdfToolsCryptoProvidersBuiltIn_Provider_CreatePreparedSignatureA


#define PdfToolsCryptoProvidersBuiltIn_Provider_GetTimestampUrl PdfToolsCryptoProvidersBuiltIn_Provider_GetTimestampUrlA

#define PdfToolsCryptoProvidersBuiltIn_Provider_SetTimestampUrl PdfToolsCryptoProvidersBuiltIn_Provider_SetTimestampUrlA


#endif


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

 * SignatureConfiguration

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

PDFTOOLS_EXPORT TPdfToolsCrypto_HashAlgorithm PDFTOOLS_CALL

PdfToolsCryptoProvidersBuiltIn_SignatureConfiguration_GetHashAlgorithm(

    TPdfToolsCryptoProvidersBuiltIn_SignatureConfiguration* pSignatureConfiguration);

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersBuiltIn_SignatureConfiguration_SetHashAlgorithm(

    TPdfToolsCryptoProvidersBuiltIn_SignatureConfiguration* pSignatureConfiguration,

    TPdfToolsCrypto_HashAlgorithm                           iHashAlgorithm);

PDFTOOLS_EXPORT TPdfToolsCrypto_SignaturePaddingType PDFTOOLS_CALL

PdfToolsCryptoProvidersBuiltIn_SignatureConfiguration_GetSignaturePaddingType(

    TPdfToolsCryptoProvidersBuiltIn_SignatureConfiguration* pSignatureConfiguration);

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersBuiltIn_SignatureConfiguration_SetSignaturePaddingType(

    TPdfToolsCryptoProvidersBuiltIn_SignatureConfiguration* pSignatureConfiguration,

    TPdfToolsCrypto_SignaturePaddingType                    iSignaturePaddingType);

PDFTOOLS_EXPORT TPdfToolsCrypto_SignatureFormat PDFTOOLS_CALL

PdfToolsCryptoProvidersBuiltIn_SignatureConfiguration_GetSignatureFormat(

    TPdfToolsCryptoProvidersBuiltIn_SignatureConfiguration* pSignatureConfiguration);

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersBuiltIn_SignatureConfiguration_SetSignatureFormat(

    TPdfToolsCryptoProvidersBuiltIn_SignatureConfiguration* pSignatureConfiguration,

    TPdfToolsCrypto_SignatureFormat                         iSignatureFormat);

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersBuiltIn_SignatureConfiguration_GetAddTimestamp(

    TPdfToolsCryptoProvidersBuiltIn_SignatureConfiguration* pSignatureConfiguration);

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersBuiltIn_SignatureConfiguration_SetAddTimestamp(

    TPdfToolsCryptoProvidersBuiltIn_SignatureConfiguration* pSignatureConfiguration, BOOL bAddTimestamp);

PDFTOOLS_EXPORT TPdfToolsCrypto_ValidationInformation PDFTOOLS_CALL

PdfToolsCryptoProvidersBuiltIn_SignatureConfiguration_GetValidationInformation(

    TPdfToolsCryptoProvidersBuiltIn_SignatureConfiguration* pSignatureConfiguration);

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersBuiltIn_SignatureConfiguration_SetValidationInformation(

    TPdfToolsCryptoProvidersBuiltIn_SignatureConfiguration* pSignatureConfiguration,

    TPdfToolsCrypto_ValidationInformation                   iValidationInformation);


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

 * TimestampConfiguration

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

PDFTOOLS_EXPORT TPdfToolsCrypto_HashAlgorithm PDFTOOLS_CALL

PdfToolsCryptoProvidersBuiltIn_TimestampConfiguration_GetHashAlgorithm(

    TPdfToolsCryptoProvidersBuiltIn_TimestampConfiguration* pTimestampConfiguration);

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersBuiltIn_TimestampConfiguration_SetHashAlgorithm(

    TPdfToolsCryptoProvidersBuiltIn_TimestampConfiguration* pTimestampConfiguration,

    TPdfToolsCrypto_HashAlgorithm                           iHashAlgorithm);


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

 * Provider

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

PDFTOOLS_EXPORT TPdfToolsCryptoProvidersBuiltIn_Provider* PDFTOOLS_CALL

PdfToolsCryptoProvidersBuiltIn_Provider_New(void);


PDFTOOLS_EXPORT TPdfToolsCryptoProvidersBuiltIn_SignatureConfiguration* PDFTOOLS_CALL

PdfToolsCryptoProvidersBuiltIn_Provider_CreateSignatureFromCertificateA(

    TPdfToolsCryptoProvidersBuiltIn_Provider* pProvider, const TPdfToolsSys_StreamDescriptor* pStreamDesc,

    const char* szPassword);

PDFTOOLS_EXPORT TPdfToolsCryptoProvidersBuiltIn_SignatureConfiguration* PDFTOOLS_CALL

PdfToolsCryptoProvidersBuiltIn_Provider_CreateSignatureFromCertificateW(

    TPdfToolsCryptoProvidersBuiltIn_Provider* pProvider, const TPdfToolsSys_StreamDescriptor* pStreamDesc,

    const WCHAR* szPassword);

PDFTOOLS_EXPORT TPdfToolsCryptoProvidersBuiltIn_TimestampConfiguration* PDFTOOLS_CALL

PdfToolsCryptoProvidersBuiltIn_Provider_CreateTimestamp(TPdfToolsCryptoProvidersBuiltIn_Provider* pProvider);

PDFTOOLS_EXPORT TPdfToolsSign_SignatureConfiguration* PDFTOOLS_CALL

PdfToolsCryptoProvidersBuiltIn_Provider_CreatePreparedSignatureA(TPdfToolsCryptoProvidersBuiltIn_Provider* pProvider,

                                                                 int iSize, const char* szFormat, const char* szName);

PDFTOOLS_EXPORT TPdfToolsSign_SignatureConfiguration* PDFTOOLS_CALL

PdfToolsCryptoProvidersBuiltIn_Provider_CreatePreparedSignatureW(TPdfToolsCryptoProvidersBuiltIn_Provider* pProvider,

                                                                 int iSize, const WCHAR* szFormat, const WCHAR* szName);

PDFTOOLS_EXPORT TPdfToolsSign_SignatureConfiguration* PDFTOOLS_CALL

PdfToolsCryptoProvidersBuiltIn_Provider_ReadExternalSignature(TPdfToolsCryptoProvidersBuiltIn_Provider* pProvider,

                                                              const unsigned char* pSignature, size_t nSignatures);


PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsCryptoProvidersBuiltIn_Provider_GetTimestampUrlA(

    TPdfToolsCryptoProvidersBuiltIn_Provider* pProvider, char* pBuffer, size_t nBufferSize);

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsCryptoProvidersBuiltIn_Provider_GetTimestampUrlW(

    TPdfToolsCryptoProvidersBuiltIn_Provider* pProvider, WCHAR* pBuffer, size_t nBufferSize);

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersBuiltIn_Provider_SetTimestampUrlA(

    TPdfToolsCryptoProvidersBuiltIn_Provider* pProvider, const char* szTimestampUrl);

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersBuiltIn_Provider_SetTimestampUrlW(

    TPdfToolsCryptoProvidersBuiltIn_Provider* pProvider, const WCHAR* szTimestampUrl);


#ifdef __cplusplus

}

#endif


#endif /* PDFTOOLS_PDFTOOLSCRYPTOPROVIDERSBUILTIN_H__ */

PdfToolsCryptoProvidersBuiltIn_Provider_SetTimestampUrlA
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersBuiltIn_Provider_SetTimestampUrlA(TPdfToolsCryptoProvidersBuiltIn_Provider *pProvider, const char *szTimestampUrl)
The URL of the trusted time-stamp authority (TSA) from which time-stamps shall be acquired.

PdfToolsCryptoProvidersBuiltIn_TimestampConfiguration_SetHashAlgorithm
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersBuiltIn_TimestampConfiguration_SetHashAlgorithm(TPdfToolsCryptoProvidersBuiltIn_TimestampConfiguration *pTimestampConfiguration, TPdfToolsCrypto_HashAlgorithm iHashAlgorithm)
The message digest algorithm.

PdfToolsCryptoProvidersBuiltIn_Provider_SetTimestampUrlW
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersBuiltIn_Provider_SetTimestampUrlW(TPdfToolsCryptoProvidersBuiltIn_Provider *pProvider, const WCHAR *szTimestampUrl)
The URL of the trusted time-stamp authority (TSA) from which time-stamps shall be acquired.

PdfToolsCryptoProvidersBuiltIn_SignatureConfiguration_SetSignaturePaddingType
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersBuiltIn_SignatureConfiguration_SetSignaturePaddingType(TPdfToolsCryptoProvidersBuiltIn_SignatureConfiguration *pSignatureConfiguration, TPdfToolsCrypto_SignaturePaddingType iSignaturePaddingType)
The padding type of the cryptographic signature Default: ePdfToolsCrypto_SignaturePaddingType_RsaSsaP...

PdfToolsCryptoProvidersBuiltIn_SignatureConfiguration_GetHashAlgorithm
PDFTOOLS_EXPORT TPdfToolsCrypto_HashAlgorithm PDFTOOLS_CALL PdfToolsCryptoProvidersBuiltIn_SignatureConfiguration_GetHashAlgorithm(TPdfToolsCryptoProvidersBuiltIn_SignatureConfiguration *pSignatureConfiguration)
The message digest algorithm.

PdfToolsCryptoProvidersBuiltIn_SignatureConfiguration_SetAddTimestamp
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersBuiltIn_SignatureConfiguration_SetAddTimestamp(TPdfToolsCryptoProvidersBuiltIn_SignatureConfiguration *pSignatureConfiguration, BOOL bAddTimestamp)
Whether to add a trusted time-stamp to the signature.

PdfToolsCryptoProvidersBuiltIn_SignatureConfiguration_SetSignatureFormat
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersBuiltIn_SignatureConfiguration_SetSignatureFormat(TPdfToolsCryptoProvidersBuiltIn_SignatureConfiguration *pSignatureConfiguration, TPdfToolsCrypto_SignatureFormat iSignatureFormat)
The format (encoding) of the cryptographic signature Default: ePdfToolsCrypto_SignatureFormat_EtsiCad...

PdfToolsCryptoProvidersBuiltIn_Provider_GetTimestampUrlW
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsCryptoProvidersBuiltIn_Provider_GetTimestampUrlW(TPdfToolsCryptoProvidersBuiltIn_Provider *pProvider, WCHAR *pBuffer, size_t nBufferSize)
The URL of the trusted time-stamp authority (TSA) from which time-stamps shall be acquired.

PdfToolsCryptoProvidersBuiltIn_SignatureConfiguration_GetValidationInformation
PDFTOOLS_EXPORT TPdfToolsCrypto_ValidationInformation PDFTOOLS_CALL PdfToolsCryptoProvidersBuiltIn_SignatureConfiguration_GetValidationInformation(TPdfToolsCryptoProvidersBuiltIn_SignatureConfiguration *pSignatureConfiguration)
Whether to add validation information (LTV)

PdfToolsCryptoProvidersBuiltIn_SignatureConfiguration_GetSignatureFormat
PDFTOOLS_EXPORT TPdfToolsCrypto_SignatureFormat PDFTOOLS_CALL PdfToolsCryptoProvidersBuiltIn_SignatureConfiguration_GetSignatureFormat(TPdfToolsCryptoProvidersBuiltIn_SignatureConfiguration *pSignatureConfiguration)
The format (encoding) of the cryptographic signature Default: ePdfToolsCrypto_SignatureFormat_EtsiCad...

PdfToolsCryptoProvidersBuiltIn_Provider_CreateSignatureFromCertificateA
PDFTOOLS_EXPORT TPdfToolsCryptoProvidersBuiltIn_SignatureConfiguration *PDFTOOLS_CALL PdfToolsCryptoProvidersBuiltIn_Provider_CreateSignatureFromCertificateA(TPdfToolsCryptoProvidersBuiltIn_Provider *pProvider, const TPdfToolsSys_StreamDescriptor *pStreamDesc, const char *szPassword)
Create a configuration to sign with a PFX (PKCS#12) soft certificate The file must contain the certif...

PdfToolsCryptoProvidersBuiltIn_Provider_New
PDFTOOLS_EXPORT TPdfToolsCryptoProvidersBuiltIn_Provider *PDFTOOLS_CALL PdfToolsCryptoProvidersBuiltIn_Provider_New(void)

PdfToolsCryptoProvidersBuiltIn_SignatureConfiguration_SetHashAlgorithm
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersBuiltIn_SignatureConfiguration_SetHashAlgorithm(TPdfToolsCryptoProvidersBuiltIn_SignatureConfiguration *pSignatureConfiguration, TPdfToolsCrypto_HashAlgorithm iHashAlgorithm)
The message digest algorithm.

PdfToolsCryptoProvidersBuiltIn_SignatureConfiguration_GetAddTimestamp
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersBuiltIn_SignatureConfiguration_GetAddTimestamp(TPdfToolsCryptoProvidersBuiltIn_SignatureConfiguration *pSignatureConfiguration)
Whether to add a trusted time-stamp to the signature.

PdfToolsCryptoProvidersBuiltIn_Provider_CreateTimestamp
PDFTOOLS_EXPORT TPdfToolsCryptoProvidersBuiltIn_TimestampConfiguration *PDFTOOLS_CALL PdfToolsCryptoProvidersBuiltIn_Provider_CreateTimestamp(TPdfToolsCryptoProvidersBuiltIn_Provider *pProvider)
Create a time-stamp configuration Note that to create time-stamps, the PdfToolsCryptoProvidersBuiltIn...

PdfToolsCryptoProvidersBuiltIn_TimestampConfiguration_GetHashAlgorithm
PDFTOOLS_EXPORT TPdfToolsCrypto_HashAlgorithm PDFTOOLS_CALL PdfToolsCryptoProvidersBuiltIn_TimestampConfiguration_GetHashAlgorithm(TPdfToolsCryptoProvidersBuiltIn_TimestampConfiguration *pTimestampConfiguration)
The message digest algorithm.

PdfToolsCryptoProvidersBuiltIn_Provider_CreateSignatureFromCertificateW
PDFTOOLS_EXPORT TPdfToolsCryptoProvidersBuiltIn_SignatureConfiguration *PDFTOOLS_CALL PdfToolsCryptoProvidersBuiltIn_Provider_CreateSignatureFromCertificateW(TPdfToolsCryptoProvidersBuiltIn_Provider *pProvider, const TPdfToolsSys_StreamDescriptor *pStreamDesc, const WCHAR *szPassword)
Create a configuration to sign with a PFX (PKCS#12) soft certificate The file must contain the certif...

PdfToolsCryptoProvidersBuiltIn_SignatureConfiguration_SetValidationInformation
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersBuiltIn_SignatureConfiguration_SetValidationInformation(TPdfToolsCryptoProvidersBuiltIn_SignatureConfiguration *pSignatureConfiguration, TPdfToolsCrypto_ValidationInformation iValidationInformation)
Whether to add validation information (LTV)

PdfToolsCryptoProvidersBuiltIn_SignatureConfiguration_GetSignaturePaddingType
PDFTOOLS_EXPORT TPdfToolsCrypto_SignaturePaddingType PDFTOOLS_CALL PdfToolsCryptoProvidersBuiltIn_SignatureConfiguration_GetSignaturePaddingType(TPdfToolsCryptoProvidersBuiltIn_SignatureConfiguration *pSignatureConfiguration)
The padding type of the cryptographic signature Default: ePdfToolsCrypto_SignaturePaddingType_RsaSsaP...

PDFTOOLS_CALL
#define PDFTOOLS_CALL
Definition PdfTools_PdfToolsCryptoProvidersBuiltIn.h:26

PdfToolsCryptoProvidersBuiltIn_Provider_GetTimestampUrlA
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsCryptoProvidersBuiltIn_Provider_GetTimestampUrlA(TPdfToolsCryptoProvidersBuiltIn_Provider *pProvider, char *pBuffer, size_t nBufferSize)
The URL of the trusted time-stamp authority (TSA) from which time-stamps shall be acquired.

PdfToolsCryptoProvidersBuiltIn_Provider_ReadExternalSignature
PDFTOOLS_EXPORT TPdfToolsSign_SignatureConfiguration *PDFTOOLS_CALL PdfToolsCryptoProvidersBuiltIn_Provider_ReadExternalSignature(TPdfToolsCryptoProvidersBuiltIn_Provider *pProvider, const unsigned char *pSignature, size_t nSignatures)
Read signature created by an external signature handler See PdfToolsCryptoProvidersBuiltIn_Provider_C...

PdfToolsCryptoProvidersBuiltIn_Provider_CreatePreparedSignatureW
PDFTOOLS_EXPORT TPdfToolsSign_SignatureConfiguration *PDFTOOLS_CALL PdfToolsCryptoProvidersBuiltIn_Provider_CreatePreparedSignatureW(TPdfToolsCryptoProvidersBuiltIn_Provider *pProvider, int iSize, const WCHAR *szFormat, const WCHAR *szName)
Create a configuration to prepare a signature for an external signature handler This method is part o...

PdfToolsCryptoProvidersBuiltIn_Provider_CreatePreparedSignatureA
PDFTOOLS_EXPORT TPdfToolsSign_SignatureConfiguration *PDFTOOLS_CALL PdfToolsCryptoProvidersBuiltIn_Provider_CreatePreparedSignatureA(TPdfToolsCryptoProvidersBuiltIn_Provider *pProvider, int iSize, const char *szFormat, const char *szName)
Create a configuration to prepare a signature for an external signature handler This method is part o...

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

TPdfToolsCrypto_ValidationInformation
TPdfToolsCrypto_ValidationInformation
Whether to embed validation information to enable the long-term validation (LTV) of the signature.
Definition PdfTools_Types.h:1378

TPdfToolsCrypto_SignaturePaddingType
TPdfToolsCrypto_SignaturePaddingType
Padding scheme of the cryptographic signature algorithm The signature algorithm is defined by the sig...
Definition PdfTools_Types.h:1306

BOOL
#define BOOL
Definition PdfTools_Types.h:23

TPdfToolsCrypto_SignatureFormat
TPdfToolsCrypto_SignatureFormat
Definition PdfTools_Types.h:1333

TPdfToolsCrypto_HashAlgorithm
TPdfToolsCrypto_HashAlgorithm
Definition PdfTools_Types.h:1216

TPdfToolsCryptoProvidersBuiltIn_Provider
The built-in cryptographic provider.

TPdfToolsCryptoProvidersBuiltIn_SignatureConfiguration
The signature configuration.

TPdfToolsCryptoProvidersBuiltIn_TimestampConfiguration
The time-stamp configuration.

TPdfToolsSign_SignatureConfiguration
Configuration for signature creation.

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