Pdftools SDK
Loading...
Searching...
No Matches
PdfTools_PdfToolsCryptoProvidersGlobalSignDss.h
Go to the documentation of this file.
1/******************************************************************************
2 *
3 * File: PdfTools_PdfToolsCryptoProvidersGlobalSignDss.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_PDFTOOLSCRYPTOPROVIDERSGLOBALSIGNDSS_H__
15#define PDFTOOLS_PDFTOOLSCRYPTOPROVIDERSGLOBALSIGNDSS_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"
27
28#ifdef __cplusplus
29extern "C"
30{
31#endif
32
33#ifdef _UNICODE
34#define PdfToolsCryptoProvidersGlobalSignDss_Session_New PdfToolsCryptoProvidersGlobalSignDss_Session_NewW
35#define PdfToolsCryptoProvidersGlobalSignDss_Session_CreateSignatureForDynamicIdentity \
36 PdfToolsCryptoProvidersGlobalSignDss_Session_CreateSignatureForDynamicIdentityW
37
38#else
39#define PdfToolsCryptoProvidersGlobalSignDss_Session_New PdfToolsCryptoProvidersGlobalSignDss_Session_NewA
40#define PdfToolsCryptoProvidersGlobalSignDss_Session_CreateSignatureForDynamicIdentity \
41 PdfToolsCryptoProvidersGlobalSignDss_Session_CreateSignatureForDynamicIdentityA
42
43#endif
44
45/******************************************************************************
46 * SignatureConfiguration
47 *****************************************************************************/
126 TPdfToolsCrypto_SignatureFormat iSignatureFormat);
162 TPdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration* pSignatureConfiguration, BOOL bAddTimestamp);
206 TPdfToolsCrypto_ValidationInformation iValidationInformation);
207
208/******************************************************************************
209 * TimestampConfiguration
210 *****************************************************************************/
233
234/******************************************************************************
235 * Session
236 *****************************************************************************/
268PdfToolsCryptoProvidersGlobalSignDss_Session_NewA(const char* szUrl, const char* szApi_key, const char* szApi_secret,
269 TPdfTools_HttpClientHandler* pHttpClientHandler);
301PdfToolsCryptoProvidersGlobalSignDss_Session_NewW(const WCHAR* szUrl, const WCHAR* szApi_key, const WCHAR* szApi_secret,
302 TPdfTools_HttpClientHandler* pHttpClientHandler);
303
353 TPdfToolsCryptoProvidersGlobalSignDss_Session* pSession, const char* szIdentity);
379 TPdfToolsCryptoProvidersGlobalSignDss_Session* pSession, const WCHAR* szIdentity);
394
395#ifdef __cplusplus
396}
397#endif
398
399#endif /* PDFTOOLS_PDFTOOLSCRYPTOPROVIDERSGLOBALSIGNDSS_H__ */
PDFTOOLS_EXPORT TPdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration *PDFTOOLS_CALL PdfToolsCryptoProvidersGlobalSignDss_Session_CreateSignatureForDynamicIdentityW(TPdfToolsCryptoProvidersGlobalSignDss_Session *pSession, const WCHAR *szIdentity)
Create a signing certificate for an account with a dynamic identity.
PDFTOOLS_EXPORT TPdfToolsCrypto_SignatureFormat PDFTOOLS_CALL PdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration_GetSignatureFormat(TPdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration *pSignatureConfiguration)
The format (encoding) of the cryptographic signature Default: ePdfToolsCrypto_SignatureFormat_EtsiCad...
PDFTOOLS_EXPORT TPdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration *PDFTOOLS_CALL PdfToolsCryptoProvidersGlobalSignDss_Session_CreateSignatureForStaticIdentity(TPdfToolsCryptoProvidersGlobalSignDss_Session *pSession)
Create a signing certificate for an account with a static identity The returned signature configurati...
PDFTOOLS_EXPORT TPdfToolsCrypto_HashAlgorithm PDFTOOLS_CALL PdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration_GetHashAlgorithm(TPdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration *pSignatureConfiguration)
The message digest algorithm.
PDFTOOLS_EXPORT TPdfToolsCryptoProvidersGlobalSignDss_Session *PDFTOOLS_CALL PdfToolsCryptoProvidersGlobalSignDss_Session_NewA(const char *szUrl, const char *szApi_key, const char *szApi_secret, TPdfTools_HttpClientHandler *pHttpClientHandler)
Establish a session to the service.
PDFTOOLS_EXPORT TPdfToolsCrypto_ValidationInformation PDFTOOLS_CALL PdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration_GetValidationInformation(TPdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration *pSignatureConfiguration)
Whether to add validation information (LTV)
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration_SetAddTimestamp(TPdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration *pSignatureConfiguration, BOOL bAddTimestamp)
Whether to add a trusted time-stamp to the signature Default: FALSE.
PDFTOOLS_EXPORT TPdfToolsCryptoProvidersGlobalSignDss_Session *PDFTOOLS_CALL PdfToolsCryptoProvidersGlobalSignDss_Session_NewW(const WCHAR *szUrl, const WCHAR *szApi_key, const WCHAR *szApi_secret, TPdfTools_HttpClientHandler *pHttpClientHandler)
Establish a session to the service.
PDFTOOLS_EXPORT TPdfToolsCrypto_SignaturePaddingType PDFTOOLS_CALL PdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration_GetSignaturePaddingType(TPdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration *pSignatureConfiguration)
The padding type of the cryptographic signature Value: ePdfToolsCrypto_SignaturePaddingType_RsaRsa.
PDFTOOLS_EXPORT TPdfToolsCrypto_HashAlgorithm PDFTOOLS_CALL PdfToolsCryptoProvidersGlobalSignDss_TimestampConfiguration_GetHashAlgorithm(TPdfToolsCryptoProvidersGlobalSignDss_TimestampConfiguration *pTimestampConfiguration)
The message digest algorithm.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration_SetSignatureFormat(TPdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration *pSignatureConfiguration, TPdfToolsCrypto_SignatureFormat iSignatureFormat)
The format (encoding) of the cryptographic signature Default: ePdfToolsCrypto_SignatureFormat_EtsiCad...
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration_GetAddTimestamp(TPdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration *pSignatureConfiguration)
Whether to add a trusted time-stamp to the signature Default: FALSE.
#define PDFTOOLS_CALL
Definition PdfTools_PdfToolsCryptoProvidersGlobalSignDss.h:21
PDFTOOLS_EXPORT TPdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration *PDFTOOLS_CALL PdfToolsCryptoProvidersGlobalSignDss_Session_CreateSignatureForDynamicIdentityA(TPdfToolsCryptoProvidersGlobalSignDss_Session *pSession, const char *szIdentity)
Create a signing certificate for an account with a dynamic identity.
PDFTOOLS_EXPORT TPdfToolsCryptoProvidersGlobalSignDss_TimestampConfiguration *PDFTOOLS_CALL PdfToolsCryptoProvidersGlobalSignDss_Session_CreateTimestamp(TPdfToolsCryptoProvidersGlobalSignDss_Session *pSession)
Create a time-stamp configuration.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration_SetValidationInformation(TPdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration *pSignatureConfiguration, TPdfToolsCrypto_ValidationInformation iValidationInformation)
Whether to add validation information (LTV)
#define PDFTOOLS_EXPORT
Definition PdfTools_Platform.h:138
unsigned short WCHAR
Definition PdfTools_Platform.h:90
struct TPdfToolsCryptoProvidersGlobalSignDss_TimestampConfiguration TPdfToolsCryptoProvidersGlobalSignDss_TimestampConfiguration
Definition PdfTools_Types.h:2881
struct TPdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration TPdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration
The signature configuration.
Definition PdfTools_Types.h:2877
TPdfToolsCrypto_ValidationInformation
Whether to embed validation information to enable the long-term validation (LTV) of the signature.
Definition PdfTools_Types.h:1373
struct TPdfToolsCryptoProvidersGlobalSignDss_Session TPdfToolsCryptoProvidersGlobalSignDss_Session
GlobalSign Digital Signing Service.
Definition PdfTools_Types.h:2899
struct TPdfTools_HttpClientHandler TPdfTools_HttpClientHandler
The handler and options for communication to remote server.
Definition PdfTools_Types.h:2172
TPdfToolsCrypto_SignaturePaddingType
Padding scheme of the cryptographic signature algorithm The signature algorithm is defined by the sig...
Definition PdfTools_Types.h:1301
#define BOOL
Definition PdfTools_Types.h:18
TPdfToolsCrypto_SignatureFormat
Definition PdfTools_Types.h:1328
TPdfToolsCrypto_HashAlgorithm
Definition PdfTools_Types.h:1211