SignDoc SDK (C)
5.0.0
|
Parameters for verifying a certificate chain. More...
#include <SignDocSDK-c.h>
Parameters for verifying a certificate chain.
Use SIGNDOC_VerificationParameters_getErrorMessage() or SIGNDOC_VerificationParameters_getErrorMessageW() to get more information after a function call failed.
If you use a NULL pointer instead of a pointer to a SIGNDOC_VerificationParameters object, the following default values will be used (those are identical to the default values for a freshly created SIGNDOC_VerificationParameters object):
However, for SIGNDOC_Document_updateDSS() and SIGNDOC_Document_updateDSS2(), the following default values will be used if a NULL pointer is passed (those are identical to the values set by SIGNDOC_VerificationParameters_setForUpdateDSS()):
To make the signature maximally meaningful, verification parameters for SIGNDOC_Document_addSignature() should include SIGNDOC_VERIFICATIONPARAMETERS_VERIFICATIONFLAGS_CHECK_REVOCATION in integer parameter "VerificationFlags".
If integer parameter "CertificateChainVerificationPolicy" is SIGNDOC_VERIFICATIONPARAMETERS_CERTIFICATECHAINVERIFICATIONPOLICY_DONT_VERIFY, integer parameter "CertificateRevocationVerificationPolicy" must be SIGNDOC_VERIFICATIONPARAMETERS_CERTIFICATEREVOCATIONVERIFICATIONPOLICY_DONT_CHECK.
void SIGNDOC_VerificationParameters_assign | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_VerificationParameters * | aObj, | ||
const struct SIGNDOC_VerificationParameters * | aSource | ||
) |
SIGNDOC_VerificationParameters assignment operator.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_VerificationParameters object. |
[in] | aSource | The source object. |
struct SIGNDOC_VerificationParameters * SIGNDOC_VerificationParameters_clone | ( | struct SIGNDOC_Exception ** | aEx, |
const struct SIGNDOC_VerificationParameters * | aSource | ||
) |
Clone a SIGNDOC_VerificationParameters object.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aSource | The object to be copied. |
void SIGNDOC_VerificationParameters_delete | ( | struct SIGNDOC_VerificationParameters * | aObj | ) |
SIGNDOC_VerificationParameters destructor.
[in] | aObj | A pointer to the SIGNDOC_VerificationParameters object. |
SIGNDOC_Boolean SIGNDOC_VerificationParameters_equals | ( | struct SIGNDOC_Exception ** | aEx, |
const struct SIGNDOC_VerificationParameters * | aObj, | ||
const struct SIGNDOC_VerificationParameters * | aOther | ||
) |
Compare against another SIGNDOC_VerificationParameters object.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_VerificationParameters object. |
[in] | aOther | The object to compare against. |
const char * SIGNDOC_VerificationParameters_getErrorMessage | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_VerificationParameters * | aObj, | ||
int | aEncoding | ||
) |
Get an error message for the last function call.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_VerificationParameters object. |
[in] | aEncoding | The encoding to be used for the error message (SIGNDOC_ENCODING_NATIVE, SIGNDOC_ENCODING_UTF_8, or SIGNDOC_ENCODING_LATIN_1). |
const wchar_t * SIGNDOC_VerificationParameters_getErrorMessageW | ( | struct SIGNDOC_Exception ** | aEx, |
const struct SIGNDOC_VerificationParameters * | aObj | ||
) |
Get an error message for the last function call.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_VerificationParameters object. |
struct SIGNDOC_VerificationParameters * SIGNDOC_VerificationParameters_new | ( | struct SIGNDOC_Exception ** | aEx | ) |
SIGNDOC_VerificationParameters constructor.
See struct SIGNDOC_VerificationParameters for the default values.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
int SIGNDOC_VerificationParameters_setBlob | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_VerificationParameters * | aObj, | ||
const char * | aName, | ||
const unsigned char * | aData, | ||
size_t | aSize | ||
) |
Set a blob parameter.
Available blob parameters are:
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_VerificationParameters object. |
[in] | aName | The name of the parameter (case-sensitive). |
[in] | aData | A pointer to the first octet of the value. |
[in] | aSize | Size of the blob (number of octets). |
void SIGNDOC_VerificationParameters_setForUpdateDSS | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_VerificationParameters * | aObj | ||
) |
Set suitable SIGNDOC_VerificationParameters values for SIGNDOC_Document_updateDSS() and SIGNDOC_Document_updateDSS2().
See struct SIGNDOC_VerificationParameters for the values set by this function.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_VerificationParameters object. |
int SIGNDOC_VerificationParameters_setInteger | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_VerificationParameters * | aObj, | ||
const char * | aName, | ||
int | aValue | ||
) |
Set an integer parameter.
Available integer parameters are:
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_VerificationParameters object. |
[in] | aName | The name of the parameter (case-sensitive). |
[in] | aValue | The value of the parameter. |
int SIGNDOC_VerificationParameters_setString | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_VerificationParameters * | aObj, | ||
int | aEncoding, | ||
const char * | aName, | ||
const char * | aValue | ||
) |
Set a string parameter.
Available string parameters are:
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_VerificationParameters object. |
[in] | aEncoding | The encoding used for aValue (SIGNDOC_ENCODING_NATIVE, SIGNDOC_ENCODING_UTF_8, or SIGNDOC_ENCODING_LATIN_1). |
[in] | aName | The name of the parameter (case-sensitive). |
[in] | aValue | The value of the parameter. The encoding is specified by aEncoding. |
int SIGNDOC_VerificationParameters_setStringW | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_VerificationParameters * | aObj, | ||
const char * | aName, | ||
const wchar_t * | aValue | ||
) |
Set a string parameter.
See SIGNDOC_VerificationParameters_setString() for a list of available string parameters.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_VerificationParameters object. |
[in] | aName | The name of the parameter (case-sensitive). |
[in] | aValue | The value of the parameter. |