Pdftools SDK
Loading...
Searching...
No Matches
Macros | Functions
PdfTools_PdfToolsCryptoProvidersGlobalSignDss.h File Reference
#include "PdfTools_Types.h"
#include "PdfTools_PdfToolsSys.h"

Go to the source code of this file.

Macros

#define PDFTOOLS_CALL
 
#define PdfToolsCryptoProvidersGlobalSignDss_Session_New   PdfToolsCryptoProvidersGlobalSignDss_Session_NewA
 
#define PdfToolsCryptoProvidersGlobalSignDss_Session_CreateSignatureForDynamicIdentity    PdfToolsCryptoProvidersGlobalSignDss_Session_CreateSignatureForDynamicIdentityA
 

Functions

PDFTOOLS_EXPORT TPdfToolsCrypto_HashAlgorithm PDFTOOLS_CALL PdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration_GetHashAlgorithm (TPdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration *pSignatureConfiguration)
 The message digest algorithm.
 
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_SignatureFormat PDFTOOLS_CALL PdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration_GetSignatureFormat (TPdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration *pSignatureConfiguration)
 The format (encoding) of the cryptographic signature Default: ePdfToolsCrypto_SignatureFormat_EtsiCadesDetached.
 
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration_SetSignatureFormat (TPdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration *pSignatureConfiguration, TPdfToolsCrypto_SignatureFormat iSignatureFormat)
 The format (encoding) of the cryptographic signature Default: ePdfToolsCrypto_SignatureFormat_EtsiCadesDetached.
 
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration_GetAddTimestamp (TPdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration *pSignatureConfiguration)
 Whether to add a trusted time-stamp to the signature Default: FALSE.
 
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 TPdfToolsCrypto_ValidationInformation PDFTOOLS_CALL PdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration_GetValidationInformation (TPdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration *pSignatureConfiguration)
 Whether to add validation information (LTV)
 
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration_SetValidationInformation (TPdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration *pSignatureConfiguration, TPdfToolsCrypto_ValidationInformation iValidationInformation)
 Whether to add validation information (LTV)
 
PDFTOOLS_EXPORT TPdfToolsCrypto_HashAlgorithm PDFTOOLS_CALL PdfToolsCryptoProvidersGlobalSignDss_TimestampConfiguration_GetHashAlgorithm (TPdfToolsCryptoProvidersGlobalSignDss_TimestampConfiguration *pTimestampConfiguration)
 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 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 TPdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration *PDFTOOLS_CALL PdfToolsCryptoProvidersGlobalSignDss_Session_CreateSignatureForStaticIdentity (TPdfToolsCryptoProvidersGlobalSignDss_Session *pSession)
 Create a signing certificate for an account with a static identity The returned signature configuration can be used for multiple signature operations.
 
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_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 TPdfToolsCryptoProvidersGlobalSignDss_TimestampConfiguration *PDFTOOLS_CALL PdfToolsCryptoProvidersGlobalSignDss_Session_CreateTimestamp (TPdfToolsCryptoProvidersGlobalSignDss_Session *pSession)
 Create a time-stamp configuration.
 

Macro Definition Documentation

◆ PDFTOOLS_CALL

#define PDFTOOLS_CALL

◆ PdfToolsCryptoProvidersGlobalSignDss_Session_CreateSignatureForDynamicIdentity

#define PdfToolsCryptoProvidersGlobalSignDss_Session_CreateSignatureForDynamicIdentity    PdfToolsCryptoProvidersGlobalSignDss_Session_CreateSignatureForDynamicIdentityA

◆ PdfToolsCryptoProvidersGlobalSignDss_Session_New

#define PdfToolsCryptoProvidersGlobalSignDss_Session_New   PdfToolsCryptoProvidersGlobalSignDss_Session_NewA

Function Documentation

◆ PdfToolsCryptoProvidersGlobalSignDss_Session_CreateSignatureForDynamicIdentityA()

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.

Parameters
[in,out]pSessionActs as a handle to the native object of type TPdfToolsCryptoProvidersGlobalSignDss_Session.
[in]szIdentityThe dynamic identity as JSON string. Example: { "subject_dn": {"common_name": "John Doe" } }
Returns
NULL if there is an error.
Note
An error occurred when NULL was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. Possible error codes:

◆ PdfToolsCryptoProvidersGlobalSignDss_Session_CreateSignatureForDynamicIdentityW()

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.

Parameters
[in,out]pSessionActs as a handle to the native object of type TPdfToolsCryptoProvidersGlobalSignDss_Session.
[in]szIdentityThe dynamic identity as JSON string. Example: { "subject_dn": {"common_name": "John Doe" } }
Returns
NULL if there is an error.
Note
An error occurred when NULL was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. Possible error codes:

◆ PdfToolsCryptoProvidersGlobalSignDss_Session_CreateSignatureForStaticIdentity()

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 configuration can be used for multiple signature operations.

Parameters
[in,out]pSessionActs as a handle to the native object of type TPdfToolsCryptoProvidersGlobalSignDss_Session.
Returns
NULL if there is an error.
Note
An error occurred when NULL was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. Possible error codes:

◆ PdfToolsCryptoProvidersGlobalSignDss_Session_CreateTimestamp()

PDFTOOLS_EXPORT TPdfToolsCryptoProvidersGlobalSignDss_TimestampConfiguration *PDFTOOLS_CALL PdfToolsCryptoProvidersGlobalSignDss_Session_CreateTimestamp ( TPdfToolsCryptoProvidersGlobalSignDss_Session * pSession)

Create a time-stamp configuration.

Parameters
[in,out]pSessionActs as a handle to the native object of type TPdfToolsCryptoProvidersGlobalSignDss_Session.
Returns
NULL if there is an error.
Note
An error occurred when NULL was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage.

◆ PdfToolsCryptoProvidersGlobalSignDss_Session_NewA()

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.

Parameters
[in]szUrlThe URL to the service endpoint. Typically: https://emea.api.dss.globalsign.com:8443
[in]szApi_keyYour account credentials’ key parameter for the login request.
[in]szApi_secretYour account credentials’ secret parameter for the login request.
[in,out]pHttpClientHandlerThe SSL configuration with the client certificate and trust store. Use PdfTools_HttpClientHandler_SetClientCertificateAndKey to set your SSL client certificate "clientcert.crt" and private key "privateKey.key" of your GlobalSign account.
Returns
Handle to the newly created native object.

NULL if there is an error.

Note
An error occurred when NULL was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. Possible error codes:

◆ PdfToolsCryptoProvidersGlobalSignDss_Session_NewW()

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.

Parameters
[in]szUrlThe URL to the service endpoint. Typically: https://emea.api.dss.globalsign.com:8443
[in]szApi_keyYour account credentials’ key parameter for the login request.
[in]szApi_secretYour account credentials’ secret parameter for the login request.
[in,out]pHttpClientHandlerThe SSL configuration with the client certificate and trust store. Use PdfTools_HttpClientHandler_SetClientCertificateAndKey to set your SSL client certificate "clientcert.crt" and private key "privateKey.key" of your GlobalSign account.
Returns
Handle to the newly created native object.

NULL if there is an error.

Note
An error occurred when NULL was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. Possible error codes:

◆ PdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration_GetAddTimestamp()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration_GetAddTimestamp ( TPdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration * pSignatureConfiguration)

Whether to add a trusted time-stamp to the signature Default: FALSE.

Parameters
[in,out]pSignatureConfigurationActs as a handle to the native object of type TPdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration.
Returns
Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note
An error occurred when FALSE was returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. Get the error message with PdfTools_GetLastErrorMessage.

◆ PdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration_GetHashAlgorithm()

PDFTOOLS_EXPORT TPdfToolsCrypto_HashAlgorithm PDFTOOLS_CALL PdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration_GetHashAlgorithm ( TPdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration * pSignatureConfiguration)

The message digest algorithm.

The algorithm used to hash the document and from which the cryptographic signature is created.

Value: ePdfToolsCrypto_HashAlgorithm_Sha256.

Parameters
[in,out]pSignatureConfigurationActs as a handle to the native object of type TPdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration.
Returns
Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note
An error occurred when 0 was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage.

◆ PdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration_GetSignatureFormat()

PDFTOOLS_EXPORT TPdfToolsCrypto_SignatureFormat PDFTOOLS_CALL PdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration_GetSignatureFormat ( TPdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration * pSignatureConfiguration)

The format (encoding) of the cryptographic signature Default: ePdfToolsCrypto_SignatureFormat_EtsiCadesDetached.

Parameters
[in,out]pSignatureConfigurationActs as a handle to the native object of type TPdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration.
Returns
Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note
An error occurred when 0 was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage.

◆ PdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration_GetSignaturePaddingType()

PDFTOOLS_EXPORT TPdfToolsCrypto_SignaturePaddingType PDFTOOLS_CALL PdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration_GetSignaturePaddingType ( TPdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration * pSignatureConfiguration)

The padding type of the cryptographic signature Value: ePdfToolsCrypto_SignaturePaddingType_RsaRsa.

Parameters
[in,out]pSignatureConfigurationActs as a handle to the native object of type TPdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration.
Returns
Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note
An error occurred when 0 was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage.

◆ PdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration_GetValidationInformation()

PDFTOOLS_EXPORT TPdfToolsCrypto_ValidationInformation PDFTOOLS_CALL PdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration_GetValidationInformation ( TPdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration * pSignatureConfiguration)

Whether to add validation information (LTV)

Note: This has no effect for signing certificates that do not offer revocation information.

Default: ePdfToolsCrypto_ValidationInformation_EmbedInDocument

Parameters
[in,out]pSignatureConfigurationActs as a handle to the native object of type TPdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration.
Returns
Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note
An error occurred when 0 was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage.

◆ PdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration_SetAddTimestamp()

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.

Parameters
[in,out]pSignatureConfigurationActs as a handle to the native object of type TPdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration.
[in]bAddTimestampSet value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage.

◆ PdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration_SetSignatureFormat()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration_SetSignatureFormat ( TPdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration * pSignatureConfiguration,
TPdfToolsCrypto_SignatureFormat iSignatureFormat )

The format (encoding) of the cryptographic signature Default: ePdfToolsCrypto_SignatureFormat_EtsiCadesDetached.

Parameters
[in,out]pSignatureConfigurationActs as a handle to the native object of type TPdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration.
[in]iSignatureFormatSet value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage.

◆ PdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration_SetValidationInformation()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration_SetValidationInformation ( TPdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration * pSignatureConfiguration,
TPdfToolsCrypto_ValidationInformation iValidationInformation )

Whether to add validation information (LTV)

Note: This has no effect for signing certificates that do not offer revocation information.

Default: ePdfToolsCrypto_ValidationInformation_EmbedInDocument

Parameters
[in,out]pSignatureConfigurationActs as a handle to the native object of type TPdfToolsCryptoProvidersGlobalSignDss_SignatureConfiguration.
[in]iValidationInformationSet value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage.

◆ PdfToolsCryptoProvidersGlobalSignDss_TimestampConfiguration_GetHashAlgorithm()

PDFTOOLS_EXPORT TPdfToolsCrypto_HashAlgorithm PDFTOOLS_CALL PdfToolsCryptoProvidersGlobalSignDss_TimestampConfiguration_GetHashAlgorithm ( TPdfToolsCryptoProvidersGlobalSignDss_TimestampConfiguration * pTimestampConfiguration)

The message digest algorithm.

The algorithm used to hash the document and from which the time-stamp is created.

Value: ePdfToolsCrypto_HashAlgorithm_Sha256.

Parameters
[in,out]pTimestampConfigurationActs as a handle to the native object of type TPdfToolsCryptoProvidersGlobalSignDss_TimestampConfiguration.
Returns
Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note
An error occurred when 0 was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage.
Generated by doxygen 1.10.0