SignDoc SDK (.NET with exceptions)  5.0.0
SignDocVerificationParameters Class Reference

Parameters for verifying a certificate chain. More...

Public Member Functions

 SignDocVerificationParameters ()
 Constructor. More...
 
 ~SignDocVerificationParameters ()
 Destructor. More...
 
 !SignDocVerificationParameters ()
 Finalizer. More...
 
SignDocVerificationParameters clone ()
 Clone this object. More...
 
void setForUpdateDSS ()
 Set suitable values for using this object with SignDocDocument.updateDSS() and SignDocDocument.updateDSS2(). More...
 
void setString (string aName, string aValue)
 Set a string parameter. More...
 
void setInteger (string aName, int aValue)
 Set an integer parameter. More...
 
void setBlob (string aName, byte[] aValue)
 Set a blob parameter. More...
 
string getErrorMessage ()
 Get an error message for the last function call. More...
 
bool equals (SignDocVerificationParameters aOther)
 

Detailed Description

Parameters for verifying a certificate chain.

Use getErrorMessage() to get more information after a function call failed.

If you use null instead of a SignDocVerificationParameters object, the following default values will be used (those are identical to the default values for a freshly created SignDocVerificationParameters object):

However, for SignDocDocument.updateDSS() and SignDocDocument.updateDSS2(), the following default values will be used if null is passed (those are identical to the values set by setForUpdateDSS()):

To make the signature maximally meaningful, verification parameters for SignDocDocument.addSignature() should include VerificationFlags.CheckRevocation in integer parameter "VerificationFlags".

If integer parameter "CertificateChainVerificationPolicy" is CertificateChainVerificationPolicy.DontVerify, integer parameter "CertificateRevocationVerificationPolicy" must be CertificateRevocationVerificationPolicy.DontCheck.

See also
SignDocDocument.renderPageAsImage(), SignDocDocument.renderPageAsSignDocImage(), SignDocDocument.updateDSS(), SignDocDocument.updateDSS2(), SignDocVerificationResult.verifyCertificateChain(), SignDocVerificationResult.verifyCertificateSimplified(), SignDocVerificationResult.verifyTimeStampCertificateChain(), SignDocVerificationResult.verifyTimeStampSimplified()

Constructor & Destructor Documentation

Constructor.

See SignDocVerificationParameters for the default values.

See also
setForUpdateDSS()

Member Function Documentation

Clone this object.

Returns
A clone of this object.
bool equals ( SignDocVerificationParameters  aOther)
string getErrorMessage ( )

Get an error message for the last function call.

Returns
A string describing the reason for the failure of the last function call. The string is empty if the last call succeeded.
void setBlob ( string  aName,
byte[]  aValue 
)

Set a blob parameter.

Available blob parameters are:

  • IntermediateCertificate Add an intermediate certificate which might help building the certificate chain. The blob must contain a serialized X.509 certificate (DER or PEM).
  • TrustedCertificate Add a trusted root certificate. The blob must contain a serialized X.509 certificate (DER or PEM).
Parameters
[in]aNameThe name of the parameter (case-sensitive).
[in]aValueThe value.
void setForUpdateDSS ( )

Set suitable values for using this object with SignDocDocument.updateDSS() and SignDocDocument.updateDSS2().

See SignDocVerificationParameters for the values set by this function.

void setInteger ( string  aName,
int  aValue 
)

Set an integer parameter.

Available integer parameters are:

Parameters
[in]aNameThe name of the parameter (case-sensitive).
[in]aValueThe value of the parameter.
void setString ( string  aName,
string  aValue 
)

Set a string parameter.

Available string parameters are:

  • UserAgent The value of the User-Agent header field sent to CRL and OCSP servers. The default value is "SignDoc".
  • VerificationTime Empty (for the current date and time) or a string in ISO 8601 format ("yyyy-mm-ddThh:mm:ss", with optional timezone) specifying the verification date and time. The default value is empty. Used only if integer parameter "VerificationModel" is VerificationModel.Shell. This parameteter is not used by SignDocDocument.addSignature(); that function always use the signing time as verification time.
Parameters
[in]aNameThe name of the parameter (case-sensitive).
[in]aValueThe value of the parameter.

The documentation for this class was generated from the following file: