Pdftools SDK
Loading...
Searching...
No Matches
PdfTools_PdfToolsCryptoProvidersPkcs11.h
Go to the documentation of this file.
1/******************************************************************************
2 *
3 * File: PdfTools_PdfToolsCryptoProvidersPkcs11.h
4 *
5 * Description: Sub Header file for Pdftools SDK
6 *
7 * Author: PDF Tools AG
8 *
9 * Copyright: Copyright (C) 2023 - 2024 PDF Tools AG, Switzerland
10 * All rights reserved.
11 *
12 *****************************************************************************/
13
14#ifndef PDFTOOLS_PDFTOOLSCRYPTOPROVIDERSPKCS11_H__
15#define PDFTOOLS_PDFTOOLSCRYPTOPROVIDERSPKCS11_H__
16
17#ifndef PDFTOOLS_CALL
18#if defined(WIN32)
19#define PDFTOOLS_CALL __stdcall
20#else
21#define PDFTOOLS_CALL
22#endif
23#endif
24
25#include "PdfTools_Types.h"
26#include "PdfTools_PdfToolsSys.h"
27
28#ifdef __cplusplus
29extern "C"
30{
31#endif
32
33#ifdef _UNICODE
34#define PdfToolsCryptoProvidersPkcs11_Module_Load PdfToolsCryptoProvidersPkcs11_Module_LoadW
35
36#define PdfToolsCryptoProvidersPkcs11_Device_CreateSession PdfToolsCryptoProvidersPkcs11_Device_CreateSessionW
37
38#define PdfToolsCryptoProvidersPkcs11_Device_GetDescription PdfToolsCryptoProvidersPkcs11_Device_GetDescriptionW
39
40#define PdfToolsCryptoProvidersPkcs11_Device_GetManufacturerID PdfToolsCryptoProvidersPkcs11_Device_GetManufacturerIDW
41
42#define PdfToolsCryptoProvidersPkcs11_Session_Login PdfToolsCryptoProvidersPkcs11_Session_LoginW
43#define PdfToolsCryptoProvidersPkcs11_Session_CreateSignatureFromName \
44 PdfToolsCryptoProvidersPkcs11_Session_CreateSignatureFromNameW
45#define PdfToolsCryptoProvidersPkcs11_Session_CreateSignatureFromKeyLabel \
46 PdfToolsCryptoProvidersPkcs11_Session_CreateSignatureFromKeyLabelW
47
48#define PdfToolsCryptoProvidersPkcs11_Session_GetTimestampUrl PdfToolsCryptoProvidersPkcs11_Session_GetTimestampUrlW
49#define PdfToolsCryptoProvidersPkcs11_Session_SetTimestampUrl PdfToolsCryptoProvidersPkcs11_Session_SetTimestampUrlW
50
51#else
52#define PdfToolsCryptoProvidersPkcs11_Module_Load PdfToolsCryptoProvidersPkcs11_Module_LoadA
53
54#define PdfToolsCryptoProvidersPkcs11_Device_CreateSession PdfToolsCryptoProvidersPkcs11_Device_CreateSessionA
55
56#define PdfToolsCryptoProvidersPkcs11_Device_GetDescription PdfToolsCryptoProvidersPkcs11_Device_GetDescriptionA
57
58#define PdfToolsCryptoProvidersPkcs11_Device_GetManufacturerID PdfToolsCryptoProvidersPkcs11_Device_GetManufacturerIDA
59
60#define PdfToolsCryptoProvidersPkcs11_Session_Login PdfToolsCryptoProvidersPkcs11_Session_LoginA
61#define PdfToolsCryptoProvidersPkcs11_Session_CreateSignatureFromName \
62 PdfToolsCryptoProvidersPkcs11_Session_CreateSignatureFromNameA
63#define PdfToolsCryptoProvidersPkcs11_Session_CreateSignatureFromKeyLabel \
64 PdfToolsCryptoProvidersPkcs11_Session_CreateSignatureFromKeyLabelA
65
66#define PdfToolsCryptoProvidersPkcs11_Session_GetTimestampUrl PdfToolsCryptoProvidersPkcs11_Session_GetTimestampUrlA
67#define PdfToolsCryptoProvidersPkcs11_Session_SetTimestampUrl PdfToolsCryptoProvidersPkcs11_Session_SetTimestampUrlA
68
69#endif
70
71/******************************************************************************
72 * SignatureConfiguration
73 *****************************************************************************/
97PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_SignatureConfiguration_AddCertificate(
98 TPdfToolsCryptoProvidersPkcs11_SignatureConfiguration* pSignatureConfiguration,
99 const TPdfToolsSys_StreamDescriptor* pCertificate);
100
123PDFTOOLS_EXPORT TPdfToolsCrypto_HashAlgorithm PDFTOOLS_CALL
124PdfToolsCryptoProvidersPkcs11_SignatureConfiguration_GetHashAlgorithm(
125 TPdfToolsCryptoProvidersPkcs11_SignatureConfiguration* pSignatureConfiguration);
148PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_SignatureConfiguration_SetHashAlgorithm(
149 TPdfToolsCryptoProvidersPkcs11_SignatureConfiguration* pSignatureConfiguration,
150 TPdfToolsCrypto_HashAlgorithm iHashAlgorithm);
171PDFTOOLS_EXPORT TPdfToolsCrypto_SignaturePaddingType PDFTOOLS_CALL
172PdfToolsCryptoProvidersPkcs11_SignatureConfiguration_GetSignaturePaddingType(
173 TPdfToolsCryptoProvidersPkcs11_SignatureConfiguration* pSignatureConfiguration);
194PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_SignatureConfiguration_SetSignaturePaddingType(
195 TPdfToolsCryptoProvidersPkcs11_SignatureConfiguration* pSignatureConfiguration,
196 TPdfToolsCrypto_SignaturePaddingType iSignaturePaddingType);
213PDFTOOLS_EXPORT TPdfToolsCrypto_SignatureFormat PDFTOOLS_CALL
214PdfToolsCryptoProvidersPkcs11_SignatureConfiguration_GetSignatureFormat(
215 TPdfToolsCryptoProvidersPkcs11_SignatureConfiguration* pSignatureConfiguration);
232PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_SignatureConfiguration_SetSignatureFormat(
233 TPdfToolsCryptoProvidersPkcs11_SignatureConfiguration* pSignatureConfiguration,
234 TPdfToolsCrypto_SignatureFormat iSignatureFormat);
254PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_SignatureConfiguration_GetAddTimestamp(
255 TPdfToolsCryptoProvidersPkcs11_SignatureConfiguration* pSignatureConfiguration);
275PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_SignatureConfiguration_SetAddTimestamp(
276 TPdfToolsCryptoProvidersPkcs11_SignatureConfiguration* pSignatureConfiguration, BOOL bAddTimestamp);
302PDFTOOLS_EXPORT TPdfToolsCrypto_ValidationInformation PDFTOOLS_CALL
303PdfToolsCryptoProvidersPkcs11_SignatureConfiguration_GetValidationInformation(
304 TPdfToolsCryptoProvidersPkcs11_SignatureConfiguration* pSignatureConfiguration);
330PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_SignatureConfiguration_SetValidationInformation(
331 TPdfToolsCryptoProvidersPkcs11_SignatureConfiguration* pSignatureConfiguration,
332 TPdfToolsCrypto_ValidationInformation iValidationInformation);
333
334/******************************************************************************
335 * TimestampConfiguration
336 *****************************************************************************/
361PDFTOOLS_EXPORT TPdfToolsCrypto_HashAlgorithm PDFTOOLS_CALL
362PdfToolsCryptoProvidersPkcs11_TimestampConfiguration_GetHashAlgorithm(
363 TPdfToolsCryptoProvidersPkcs11_TimestampConfiguration* pTimestampConfiguration);
388PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_TimestampConfiguration_SetHashAlgorithm(
389 TPdfToolsCryptoProvidersPkcs11_TimestampConfiguration* pTimestampConfiguration,
390 TPdfToolsCrypto_HashAlgorithm iHashAlgorithm);
391
392/******************************************************************************
393 * Module
394 *****************************************************************************/
423PDFTOOLS_EXPORT TPdfToolsCryptoProvidersPkcs11_Module* PDFTOOLS_CALL
424PdfToolsCryptoProvidersPkcs11_Module_LoadA(const char* szLibrary);
453PDFTOOLS_EXPORT TPdfToolsCryptoProvidersPkcs11_Module* PDFTOOLS_CALL
454PdfToolsCryptoProvidersPkcs11_Module_LoadW(const WCHAR* szLibrary);
455
478PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL
479PdfToolsCryptoProvidersPkcs11_Module_GetEnableFullParallelization(TPdfToolsCryptoProvidersPkcs11_Module* pModule);
502PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_Module_SetEnableFullParallelization(
503 TPdfToolsCryptoProvidersPkcs11_Module* pModule, BOOL bEnableFullParallelization);
520PDFTOOLS_EXPORT TPdfToolsCryptoProvidersPkcs11_DeviceList* PDFTOOLS_CALL
521PdfToolsCryptoProvidersPkcs11_Module_GetDevices(TPdfToolsCryptoProvidersPkcs11_Module* pModule);
522
533PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL
534PdfToolsCryptoProvidersPkcs11_Module_Close(TPdfToolsCryptoProvidersPkcs11_Module* pObject);
535/******************************************************************************
536 * Device
537 *****************************************************************************/
552PDFTOOLS_EXPORT TPdfToolsCryptoProvidersPkcs11_Session* PDFTOOLS_CALL
553PdfToolsCryptoProvidersPkcs11_Device_CreateSessionA(TPdfToolsCryptoProvidersPkcs11_Device* pDevice,
554 const char* szPassword);
569PDFTOOLS_EXPORT TPdfToolsCryptoProvidersPkcs11_Session* PDFTOOLS_CALL
570PdfToolsCryptoProvidersPkcs11_Device_CreateSessionW(TPdfToolsCryptoProvidersPkcs11_Device* pDevice,
571 const WCHAR* szPassword);
572
592PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_Device_GetDescriptionA(
593 TPdfToolsCryptoProvidersPkcs11_Device* pDevice, char* pBuffer, size_t nBufferSize);
613PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_Device_GetDescriptionW(
614 TPdfToolsCryptoProvidersPkcs11_Device* pDevice, WCHAR* pBuffer, size_t nBufferSize);
634PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_Device_GetManufacturerIDA(
635 TPdfToolsCryptoProvidersPkcs11_Device* pDevice, char* pBuffer, size_t nBufferSize);
655PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_Device_GetManufacturerIDW(
656 TPdfToolsCryptoProvidersPkcs11_Device* pDevice, WCHAR* pBuffer, size_t nBufferSize);
657
658/******************************************************************************
659 * Session
660 *****************************************************************************/
688PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL
689PdfToolsCryptoProvidersPkcs11_Session_LoginA(TPdfToolsCryptoProvidersPkcs11_Session* pSession, const char* szPassword);
717PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL
718PdfToolsCryptoProvidersPkcs11_Session_LoginW(TPdfToolsCryptoProvidersPkcs11_Session* pSession, const WCHAR* szPassword);
737PDFTOOLS_EXPORT TPdfToolsCryptoProvidersPkcs11_SignatureConfiguration* PDFTOOLS_CALL
738PdfToolsCryptoProvidersPkcs11_Session_CreateSignature(TPdfToolsCryptoProvidersPkcs11_Session* pSession,
739 TPdfToolsCryptoProviders_Certificate* pCertificate);
759PDFTOOLS_EXPORT TPdfToolsCryptoProvidersPkcs11_SignatureConfiguration* PDFTOOLS_CALL
760PdfToolsCryptoProvidersPkcs11_Session_CreateSignatureFromNameA(TPdfToolsCryptoProvidersPkcs11_Session* pSession,
761 const char* szName);
781PDFTOOLS_EXPORT TPdfToolsCryptoProvidersPkcs11_SignatureConfiguration* PDFTOOLS_CALL
782PdfToolsCryptoProvidersPkcs11_Session_CreateSignatureFromNameW(TPdfToolsCryptoProvidersPkcs11_Session* pSession,
783 const WCHAR* szName);
819PDFTOOLS_EXPORT TPdfToolsCryptoProvidersPkcs11_SignatureConfiguration* PDFTOOLS_CALL
820PdfToolsCryptoProvidersPkcs11_Session_CreateSignatureFromKeyId(TPdfToolsCryptoProvidersPkcs11_Session* pSession,
821 const unsigned char* pId, size_t nIds,
822 const TPdfToolsSys_StreamDescriptor* pCertificate);
856PDFTOOLS_EXPORT TPdfToolsCryptoProvidersPkcs11_SignatureConfiguration* PDFTOOLS_CALL
857PdfToolsCryptoProvidersPkcs11_Session_CreateSignatureFromKeyLabelA(TPdfToolsCryptoProvidersPkcs11_Session* pSession,
858 const char* szLabel,
859 const TPdfToolsSys_StreamDescriptor* pCertificate);
893PDFTOOLS_EXPORT TPdfToolsCryptoProvidersPkcs11_SignatureConfiguration* PDFTOOLS_CALL
894PdfToolsCryptoProvidersPkcs11_Session_CreateSignatureFromKeyLabelW(TPdfToolsCryptoProvidersPkcs11_Session* pSession,
895 const WCHAR* szLabel,
896 const TPdfToolsSys_StreamDescriptor* pCertificate);
910PDFTOOLS_EXPORT TPdfToolsCryptoProvidersPkcs11_TimestampConfiguration* PDFTOOLS_CALL
911PdfToolsCryptoProvidersPkcs11_Session_CreateTimestamp(TPdfToolsCryptoProvidersPkcs11_Session* pSession);
912
951PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_Session_GetTimestampUrlA(
952 TPdfToolsCryptoProvidersPkcs11_Session* pSession, char* pBuffer, size_t nBufferSize);
991PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_Session_GetTimestampUrlW(
992 TPdfToolsCryptoProvidersPkcs11_Session* pSession, WCHAR* pBuffer, size_t nBufferSize);
1025PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_Session_SetTimestampUrlA(
1026 TPdfToolsCryptoProvidersPkcs11_Session* pSession, const char* szTimestampUrl);
1059PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_Session_SetTimestampUrlW(
1060 TPdfToolsCryptoProvidersPkcs11_Session* pSession, const WCHAR* szTimestampUrl);
1078PDFTOOLS_EXPORT TPdfToolsCryptoProviders_CertificateList* PDFTOOLS_CALL
1079PdfToolsCryptoProvidersPkcs11_Session_GetCertificates(TPdfToolsCryptoProvidersPkcs11_Session* pSession);
1080
1081/******************************************************************************
1082 * DeviceList
1083 *****************************************************************************/
1104PDFTOOLS_EXPORT TPdfToolsCryptoProvidersPkcs11_Device* PDFTOOLS_CALL
1105PdfToolsCryptoProvidersPkcs11_DeviceList_GetSingle(TPdfToolsCryptoProvidersPkcs11_DeviceList* pDeviceList);
1120PDFTOOLS_EXPORT int PDFTOOLS_CALL
1121PdfToolsCryptoProvidersPkcs11_DeviceList_GetCount(TPdfToolsCryptoProvidersPkcs11_DeviceList* pDeviceList);
1139PDFTOOLS_EXPORT TPdfToolsCryptoProvidersPkcs11_Device* PDFTOOLS_CALL
1140PdfToolsCryptoProvidersPkcs11_DeviceList_Get(TPdfToolsCryptoProvidersPkcs11_DeviceList* pDeviceList, int iIndex);
1141
1142#ifdef __cplusplus
1143}
1144#endif
1145
1146#endif /* PDFTOOLS_PDFTOOLSCRYPTOPROVIDERSPKCS11_H__ */
PdfToolsCryptoProvidersPkcs11_SignatureConfiguration_SetSignaturePaddingType
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_SignatureConfiguration_SetSignaturePaddingType(TPdfToolsCryptoProvidersPkcs11_SignatureConfiguration *pSignatureConfiguration, TPdfToolsCrypto_SignaturePaddingType iSignaturePaddingType)
The padding type of the cryptographic signature Default: ePdfToolsCrypto_SignaturePaddingType_RsaSsaP...
PdfToolsCryptoProvidersPkcs11_SignatureConfiguration_GetSignatureFormat
PDFTOOLS_EXPORT TPdfToolsCrypto_SignatureFormat PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_SignatureConfiguration_GetSignatureFormat(TPdfToolsCryptoProvidersPkcs11_SignatureConfiguration *pSignatureConfiguration)
The format (encoding) of the cryptographic signature Default: ePdfToolsCrypto_SignatureFormat_EtsiCad...
PdfToolsCryptoProvidersPkcs11_SignatureConfiguration_SetAddTimestamp
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_SignatureConfiguration_SetAddTimestamp(TPdfToolsCryptoProvidersPkcs11_SignatureConfiguration *pSignatureConfiguration, BOOL bAddTimestamp)
Whether to add a trusted time-stamp to the signature.
PdfToolsCryptoProvidersPkcs11_Module_GetDevices
PDFTOOLS_EXPORT TPdfToolsCryptoProvidersPkcs11_DeviceList *PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_Module_GetDevices(TPdfToolsCryptoProvidersPkcs11_Module *pModule)
The list of devices managed by this module Most often there is only a single device,...
PdfToolsCryptoProvidersPkcs11_Session_SetTimestampUrlA
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_Session_SetTimestampUrlA(TPdfToolsCryptoProvidersPkcs11_Session *pSession, const char *szTimestampUrl)
The URL of the trusted time-stamp authority (TSA) from which time-stamps shall be acquired.
PdfToolsCryptoProvidersPkcs11_Session_LoginA
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_Session_LoginA(TPdfToolsCryptoProvidersPkcs11_Session *pSession, const char *szPassword)
Log in user into the cryptographic device.
PdfToolsCryptoProvidersPkcs11_Module_LoadA
PDFTOOLS_EXPORT TPdfToolsCryptoProvidersPkcs11_Module *PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_Module_LoadA(const char *szLibrary)
Load a PKCS#11 driver module.
PdfToolsCryptoProvidersPkcs11_Session_CreateSignatureFromKeyLabelA
PDFTOOLS_EXPORT TPdfToolsCryptoProvidersPkcs11_SignatureConfiguration *PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_Session_CreateSignatureFromKeyLabelA(TPdfToolsCryptoProvidersPkcs11_Session *pSession, const char *szLabel, const TPdfToolsSys_StreamDescriptor *pCertificate)
Create a signature configuration based on the private key's label (name) and an external certificate.
PdfToolsCryptoProvidersPkcs11_SignatureConfiguration_SetValidationInformation
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_SignatureConfiguration_SetValidationInformation(TPdfToolsCryptoProvidersPkcs11_SignatureConfiguration *pSignatureConfiguration, TPdfToolsCrypto_ValidationInformation iValidationInformation)
Whether to add validation information (LTV)
PdfToolsCryptoProvidersPkcs11_Device_CreateSessionA
PDFTOOLS_EXPORT TPdfToolsCryptoProvidersPkcs11_Session *PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_Device_CreateSessionA(TPdfToolsCryptoProvidersPkcs11_Device *pDevice, const char *szPassword)
Create a session.
PdfToolsCryptoProvidersPkcs11_Session_CreateSignatureFromNameA
PDFTOOLS_EXPORT TPdfToolsCryptoProvidersPkcs11_SignatureConfiguration *PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_Session_CreateSignatureFromNameA(TPdfToolsCryptoProvidersPkcs11_Session *pSession, const char *szName)
Create a signature configuration based on certificate name.
PdfToolsCryptoProvidersPkcs11_Module_SetEnableFullParallelization
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_Module_SetEnableFullParallelization(TPdfToolsCryptoProvidersPkcs11_Module *pModule, BOOL bEnableFullParallelization)
Enable full parallelization.
PdfToolsCryptoProvidersPkcs11_Device_GetManufacturerIDA
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_Device_GetManufacturerIDA(TPdfToolsCryptoProvidersPkcs11_Device *pDevice, char *pBuffer, size_t nBufferSize)
ID of the device's manufacturer.
PdfToolsCryptoProvidersPkcs11_Session_CreateSignatureFromNameW
PDFTOOLS_EXPORT TPdfToolsCryptoProvidersPkcs11_SignatureConfiguration *PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_Session_CreateSignatureFromNameW(TPdfToolsCryptoProvidersPkcs11_Session *pSession, const WCHAR *szName)
Create a signature configuration based on certificate name.
PdfToolsCryptoProvidersPkcs11_TimestampConfiguration_SetHashAlgorithm
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_TimestampConfiguration_SetHashAlgorithm(TPdfToolsCryptoProvidersPkcs11_TimestampConfiguration *pTimestampConfiguration, TPdfToolsCrypto_HashAlgorithm iHashAlgorithm)
The message digest algorithm.
PdfToolsCryptoProvidersPkcs11_Session_CreateSignatureFromKeyLabelW
PDFTOOLS_EXPORT TPdfToolsCryptoProvidersPkcs11_SignatureConfiguration *PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_Session_CreateSignatureFromKeyLabelW(TPdfToolsCryptoProvidersPkcs11_Session *pSession, const WCHAR *szLabel, const TPdfToolsSys_StreamDescriptor *pCertificate)
Create a signature configuration based on the private key's label (name) and an external certificate.
PdfToolsCryptoProvidersPkcs11_Session_LoginW
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_Session_LoginW(TPdfToolsCryptoProvidersPkcs11_Session *pSession, const WCHAR *szPassword)
Log in user into the cryptographic device.
PdfToolsCryptoProvidersPkcs11_DeviceList_GetSingle
PDFTOOLS_EXPORT TPdfToolsCryptoProvidersPkcs11_Device *PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_DeviceList_GetSingle(TPdfToolsCryptoProvidersPkcs11_DeviceList *pDeviceList)
Get the single device.
PdfToolsCryptoProvidersPkcs11_DeviceList_Get
PDFTOOLS_EXPORT TPdfToolsCryptoProvidersPkcs11_Device *PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_DeviceList_Get(TPdfToolsCryptoProvidersPkcs11_DeviceList *pDeviceList, int iIndex)
Returns the element at the specified position in the given list.
PdfToolsCryptoProvidersPkcs11_Module_Close
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_Module_Close(TPdfToolsCryptoProvidersPkcs11_Module *pObject)
Close object.
PdfToolsCryptoProvidersPkcs11_Session_CreateSignatureFromKeyId
PDFTOOLS_EXPORT TPdfToolsCryptoProvidersPkcs11_SignatureConfiguration *PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_Session_CreateSignatureFromKeyId(TPdfToolsCryptoProvidersPkcs11_Session *pSession, const unsigned char *pId, size_t nIds, const TPdfToolsSys_StreamDescriptor *pCertificate)
Create a signature configuration based on the private key's ID and an external certificate.
PdfToolsCryptoProvidersPkcs11_SignatureConfiguration_GetSignaturePaddingType
PDFTOOLS_EXPORT TPdfToolsCrypto_SignaturePaddingType PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_SignatureConfiguration_GetSignaturePaddingType(TPdfToolsCryptoProvidersPkcs11_SignatureConfiguration *pSignatureConfiguration)
The padding type of the cryptographic signature Default: ePdfToolsCrypto_SignaturePaddingType_RsaSsaP...
PdfToolsCryptoProvidersPkcs11_SignatureConfiguration_GetAddTimestamp
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_SignatureConfiguration_GetAddTimestamp(TPdfToolsCryptoProvidersPkcs11_SignatureConfiguration *pSignatureConfiguration)
Whether to add a trusted time-stamp to the signature.
PdfToolsCryptoProvidersPkcs11_DeviceList_GetCount
PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_DeviceList_GetCount(TPdfToolsCryptoProvidersPkcs11_DeviceList *pDeviceList)
Get the number of elements in the list.
PdfToolsCryptoProvidersPkcs11_SignatureConfiguration_SetHashAlgorithm
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_SignatureConfiguration_SetHashAlgorithm(TPdfToolsCryptoProvidersPkcs11_SignatureConfiguration *pSignatureConfiguration, TPdfToolsCrypto_HashAlgorithm iHashAlgorithm)
The message digest algorithm.
PdfToolsCryptoProvidersPkcs11_Session_CreateSignature
PDFTOOLS_EXPORT TPdfToolsCryptoProvidersPkcs11_SignatureConfiguration *PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_Session_CreateSignature(TPdfToolsCryptoProvidersPkcs11_Session *pSession, TPdfToolsCryptoProviders_Certificate *pCertificate)
Create a signature configuration based on signing certificate.
PdfToolsCryptoProvidersPkcs11_Module_LoadW
PDFTOOLS_EXPORT TPdfToolsCryptoProvidersPkcs11_Module *PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_Module_LoadW(const WCHAR *szLibrary)
Load a PKCS#11 driver module.
PdfToolsCryptoProvidersPkcs11_Device_GetManufacturerIDW
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_Device_GetManufacturerIDW(TPdfToolsCryptoProvidersPkcs11_Device *pDevice, WCHAR *pBuffer, size_t nBufferSize)
ID of the device's manufacturer.
PdfToolsCryptoProvidersPkcs11_SignatureConfiguration_GetValidationInformation
PDFTOOLS_EXPORT TPdfToolsCrypto_ValidationInformation PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_SignatureConfiguration_GetValidationInformation(TPdfToolsCryptoProvidersPkcs11_SignatureConfiguration *pSignatureConfiguration)
Whether to add validation information (LTV)
PdfToolsCryptoProvidersPkcs11_Device_CreateSessionW
PDFTOOLS_EXPORT TPdfToolsCryptoProvidersPkcs11_Session *PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_Device_CreateSessionW(TPdfToolsCryptoProvidersPkcs11_Device *pDevice, const WCHAR *szPassword)
Create a session.
PdfToolsCryptoProvidersPkcs11_Session_GetTimestampUrlW
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_Session_GetTimestampUrlW(TPdfToolsCryptoProvidersPkcs11_Session *pSession, WCHAR *pBuffer, size_t nBufferSize)
The URL of the trusted time-stamp authority (TSA) from which time-stamps shall be acquired.
PdfToolsCryptoProvidersPkcs11_SignatureConfiguration_AddCertificate
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_SignatureConfiguration_AddCertificate(TPdfToolsCryptoProvidersPkcs11_SignatureConfiguration *pSignatureConfiguration, const TPdfToolsSys_StreamDescriptor *pCertificate)
Add a certificate Add a certificate to the signature configuration. Adding certificates of the trust ...
PdfToolsCryptoProvidersPkcs11_Session_CreateTimestamp
PDFTOOLS_EXPORT TPdfToolsCryptoProvidersPkcs11_TimestampConfiguration *PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_Session_CreateTimestamp(TPdfToolsCryptoProvidersPkcs11_Session *pSession)
Create a time-stamp configuration Note that to create time-stamps, the PdfToolsCryptoProvidersPkcs11_...
PdfToolsCryptoProvidersPkcs11_SignatureConfiguration_GetHashAlgorithm
PDFTOOLS_EXPORT TPdfToolsCrypto_HashAlgorithm PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_SignatureConfiguration_GetHashAlgorithm(TPdfToolsCryptoProvidersPkcs11_SignatureConfiguration *pSignatureConfiguration)
The message digest algorithm.
PdfToolsCryptoProvidersPkcs11_Device_GetDescriptionW
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_Device_GetDescriptionW(TPdfToolsCryptoProvidersPkcs11_Device *pDevice, WCHAR *pBuffer, size_t nBufferSize)
Description of the device.
PdfToolsCryptoProvidersPkcs11_Session_GetTimestampUrlA
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_Session_GetTimestampUrlA(TPdfToolsCryptoProvidersPkcs11_Session *pSession, char *pBuffer, size_t nBufferSize)
The URL of the trusted time-stamp authority (TSA) from which time-stamps shall be acquired.
PDFTOOLS_CALL
#define PDFTOOLS_CALL
Definition PdfTools_PdfToolsCryptoProvidersPkcs11.h:21
PdfToolsCryptoProvidersPkcs11_Session_GetCertificates
PDFTOOLS_EXPORT TPdfToolsCryptoProviders_CertificateList *PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_Session_GetCertificates(TPdfToolsCryptoProvidersPkcs11_Session *pSession)
The cerfificates of the device The certificates available in this device. Note that some certificates...
PdfToolsCryptoProvidersPkcs11_Device_GetDescriptionA
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_Device_GetDescriptionA(TPdfToolsCryptoProvidersPkcs11_Device *pDevice, char *pBuffer, size_t nBufferSize)
Description of the device.
PdfToolsCryptoProvidersPkcs11_Session_SetTimestampUrlW
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_Session_SetTimestampUrlW(TPdfToolsCryptoProvidersPkcs11_Session *pSession, const WCHAR *szTimestampUrl)
The URL of the trusted time-stamp authority (TSA) from which time-stamps shall be acquired.
PdfToolsCryptoProvidersPkcs11_SignatureConfiguration_SetSignatureFormat
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_SignatureConfiguration_SetSignatureFormat(TPdfToolsCryptoProvidersPkcs11_SignatureConfiguration *pSignatureConfiguration, TPdfToolsCrypto_SignatureFormat iSignatureFormat)
The format (encoding) of the cryptographic signature Default: ePdfToolsCrypto_SignatureFormat_EtsiCad...
PdfToolsCryptoProvidersPkcs11_TimestampConfiguration_GetHashAlgorithm
PDFTOOLS_EXPORT TPdfToolsCrypto_HashAlgorithm PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_TimestampConfiguration_GetHashAlgorithm(TPdfToolsCryptoProvidersPkcs11_TimestampConfiguration *pTimestampConfiguration)
The message digest algorithm.
PdfToolsCryptoProvidersPkcs11_Module_GetEnableFullParallelization
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersPkcs11_Module_GetEnableFullParallelization(TPdfToolsCryptoProvidersPkcs11_Module *pModule)
Enable full parallelization.
PdfTools_PdfToolsSys.h
PDFTOOLS_EXPORT
#define PDFTOOLS_EXPORT
Definition PdfTools_Platform.h:138
WCHAR
unsigned short WCHAR
Definition PdfTools_Platform.h:90
PdfTools_Types.h
TPdfToolsCryptoProvidersPkcs11_DeviceList
struct TPdfToolsCryptoProvidersPkcs11_DeviceList TPdfToolsCryptoProvidersPkcs11_DeviceList
The list of devices managed by a PKCS#11 module.
Definition PdfTools_Types.h:2978
TPdfToolsCrypto_ValidationInformation
TPdfToolsCrypto_ValidationInformation
Whether to embed validation information to enable the long-term validation (LTV) of the signature.
Definition PdfTools_Types.h:1373
TPdfToolsCryptoProvidersPkcs11_TimestampConfiguration
struct TPdfToolsCryptoProvidersPkcs11_TimestampConfiguration TPdfToolsCryptoProvidersPkcs11_TimestampConfiguration
The time-stamp configuration.
Definition PdfTools_Types.h:2942
TPdfToolsCryptoProviders_Certificate
struct TPdfToolsCryptoProviders_Certificate TPdfToolsCryptoProviders_Certificate
A X.509 certificate.
Definition PdfTools_Types.h:2870
TPdfToolsCryptoProviders_CertificateList
struct TPdfToolsCryptoProviders_CertificateList TPdfToolsCryptoProviders_CertificateList
Definition PdfTools_Types.h:2873
TPdfToolsCrypto_SignaturePaddingType
TPdfToolsCrypto_SignaturePaddingType
Padding scheme of the cryptographic signature algorithm The signature algorithm is defined by the sig...
Definition PdfTools_Types.h:1301
TPdfToolsCryptoProvidersPkcs11_Session
struct TPdfToolsCryptoProvidersPkcs11_Session TPdfToolsCryptoProvidersPkcs11_Session
A session to a cryptographic device (HSM, USB token, etc.) to perform cryptographic operations.
Definition PdfTools_Types.h:2974
TPdfToolsCryptoProvidersPkcs11_Device
struct TPdfToolsCryptoProvidersPkcs11_Device TPdfToolsCryptoProvidersPkcs11_Device
The cryptographic device (HSM, USB token, etc.)
Definition PdfTools_Types.h:2960
TPdfToolsCryptoProvidersPkcs11_SignatureConfiguration
struct TPdfToolsCryptoProvidersPkcs11_SignatureConfiguration TPdfToolsCryptoProvidersPkcs11_SignatureConfiguration
The signature configuration.
Definition PdfTools_Types.h:2937
TPdfToolsCryptoProvidersPkcs11_Module
struct TPdfToolsCryptoProvidersPkcs11_Module TPdfToolsCryptoProvidersPkcs11_Module
The PKCS#11 driver module.
Definition PdfTools_Types.h:2956
BOOL
#define BOOL
Definition PdfTools_Types.h:18
TPdfToolsCrypto_SignatureFormat
TPdfToolsCrypto_SignatureFormat
Definition PdfTools_Types.h:1328
TPdfToolsCrypto_HashAlgorithm
TPdfToolsCrypto_HashAlgorithm
Definition PdfTools_Types.h:1211
TPdfToolsSys_StreamDescriptor
Structure that groups a set of callbacks that model streams.
Definition PdfTools_PdfToolsSys.h:44
Generated by doxygen 1.10.0