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 * Notice: By downloading and using this artifact, you accept PDF Tools AG's
13 * [license agreement](https://www.pdf-tools.com/license-agreement/),
14 * [privacy policy](https://www.pdf-tools.com/privacy-policy/),
15 * and allow PDF Tools AG to track your usage data.
16 *
17 *****************************************************************************/
18
19#ifndef PDFTOOLS_PDFTOOLSCRYPTOPROVIDERSGLOBALSIGNDSS_H__
20#define PDFTOOLS_PDFTOOLSCRYPTOPROVIDERSGLOBALSIGNDSS_H__
21
22#ifndef PDFTOOLS_CALL
23#if defined(WIN32)
24#define PDFTOOLS_CALL __stdcall
25#else
26#define PDFTOOLS_CALL
27#endif
28#endif
29
30#include "PdfTools_Types.h"
32
33#ifdef __cplusplus
34extern "C"
35{
36#endif
37
38#ifdef _UNICODE
39#define PdfToolsCryptoProvidersGlobalSignDss_Session_New PdfToolsCryptoProvidersGlobalSignDss_Session_NewW
40#define PdfToolsCryptoProvidersGlobalSignDss_Session_CreateSignatureForDynamicIdentity \
41 PdfToolsCryptoProvidersGlobalSignDss_Session_CreateSignatureForDynamicIdentityW
42
43#else
44#define PdfToolsCryptoProvidersGlobalSignDss_Session_New PdfToolsCryptoProvidersGlobalSignDss_Session_NewA
45#define PdfToolsCryptoProvidersGlobalSignDss_Session_CreateSignatureForDynamicIdentity \
46 PdfToolsCryptoProvidersGlobalSignDss_Session_CreateSignatureForDynamicIdentityA
47
48#endif
49
50/******************************************************************************
51 * SignatureConfiguration
52 *****************************************************************************/
128 TPdfToolsCrypto_SignatureFormat iSignatureFormat);
164 TPdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration* pSignatureConfiguration, BOOL bAddTimestamp);
207 TPdfToolsCrypto_ValidationInformation iValidationInformation);
208
209/******************************************************************************
210 * TimestampConfiguration
211 *****************************************************************************/
233
234/******************************************************************************
235 * Session
236 *****************************************************************************/
267PdfToolsCryptoProvidersGlobalSignDss_Session_NewA(const char* szUrl, const char* szApi_key, const char* szApi_secret,
268 TPdfTools_HttpClientHandler* pHttpClientHandler);
299PdfToolsCryptoProvidersGlobalSignDss_Session_NewW(const WCHAR* szUrl, const WCHAR* szApi_key, const WCHAR* szApi_secret,
300 TPdfTools_HttpClientHandler* pHttpClientHandler);
301
349 TPdfToolsCryptoProvidersGlobalSignDss_Session* pSession, const char* szIdentity);
374 TPdfToolsCryptoProvidersGlobalSignDss_Session* pSession, const WCHAR* szIdentity);
388
389#ifdef __cplusplus
390}
391#endif
392
393#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:26
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:143
unsigned short WCHAR
Definition PdfTools_Platform.h:95
TPdfToolsCrypto_ValidationInformation
Whether to embed validation information to enable the long-term validation (LTV) of the signature.
Definition PdfTools_Types.h:1378
TPdfToolsCrypto_SignaturePaddingType
Padding scheme of the cryptographic signature algorithm The signature algorithm is defined by the sig...
Definition PdfTools_Types.h:1306
#define BOOL
Definition PdfTools_Types.h:23
TPdfToolsCrypto_SignatureFormat
Definition PdfTools_Types.h:1333
TPdfToolsCrypto_HashAlgorithm
Definition PdfTools_Types.h:1216
The handler and options for communication to remote server.
GlobalSign Digital Signing Service.