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 (out ReturnCode aReturnCode, string aName, string aValue)
	Set a string parameter. More...
void	setInteger (out ReturnCode aReturnCode, string aName, int aValue)
	Set an integer parameter. More...
void	setBlob (out ReturnCode aReturnCode, 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):

• CertificateChainVerificationPolicy: CertificateChainVerificationPolicy.AcceptSelfSignedWithRSABio
• CertificateRevocationVerificationPolicy: CertificateRevocationVerificationPolicy.DontCheck
• ComputeOfflineNextUpdate: -1 (that is, embedded CRLs and OCSP responses without nextUpdate will be indefinitely valid)
• Timeout: 10000
• UserAgent: "SignDoc"
• VerificationFlags: 0 (that is, revocation checking is disabled)
• VerificationModel: VerificationModel.Minimal
• VerificationTime: empty (that is, current date and time)

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()):

• CertificateChainVerificationPolicy: CertificateChainVerificationPolicy.AcceptSelfSignedWithRSABio
• CertificateRevocationVerificationPolicy: CertificateRevocationVerificationPolicy.Online
• ComputeOfflineNextUpdate: 0 (that is, embedded CRLs and OCSP responses without nextUpdate won't be valid)
• Timeout: 10000
• UserAgent: "SignDoc"
• VerificationFlags: 0
• VerificationModel: VerificationModel.Shell
• VerificationTime: empty (that is, current date and time)

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

SignDocVerificationParameters

(

)

Constructor.

See SignDocVerificationParameters for the default values.

See also

setForUpdateDSS()

~SignDocVerificationParameters

(

)

Destructor.

!SignDocVerificationParameters

(

)

Finalizer.

Member Function Documentation

SignDocVerificationParameters clone

(

)

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	(	out ReturnCode	aReturnCode,
		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

[out]	aReturnCode	The return code, ReturnCode.OK if successful, ReturnCode.UnknownParameter if aName is not the name of a blob parameter, ReturnCode.InvalidValue if aValue is invalid.
[in]	aName	The name of the parameter (case-sensitive).
[in]	aValue	The 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	(	out ReturnCode	aReturnCode,
		string	aName,
		int	aValue
	)

Set an integer parameter.

Available integer parameters are:

• CertificateChainVerificationPolicy Policy for simplified verification of the certificate chain, see enum CertificateRevocationVerificationPolicy. The default value is CertificateChainVerificationPolicy.AcceptSelfSignedWithRSABio. This parameter is used by SignDocDocument.renderPageAsImage(), SignDocDocument.renderPageAsSignDocImage(), SignDocDocument.updateDSS(), SignDocDocument.updateDSS2(), SignDocVerificationResult.verifyCertificateSimplified(), and SignDocVerificationResult.verifyTimeStampCertificateSimplified() only.
• CertificateRevocationVerificationPolicy Policy for simplified verification of the revocation status of the certificates, see enum CertificateRevocationVerificationPolicy. The default value is CertificateRevocationVerificationPolicy.DontCheck. This parameter is used by SignDocDocument.renderPageAsImage(), SignDocDocument.renderPageAsSignDocImage(), SignDocDocument.updateDSS(), SignDocDocument.updateDSS2(), SignDocVerificationResult.verifyCertificateSimplified(), and SignDocVerificationResult.verifyTimeStampCertificateSimplified() only.
• ChainPolicy Abbreviation for "CertificateChainVerificationPolicy".
• ComputeOfflineNextUpdate Number of hours embedded CRLs and OCSP responses that do not have a nextUpdate value will be assumed to be valid after their thisUpdate value. That is, nextUpdate will be computed from thisUpdate by adding the specified number of hours. The value -1 is special and means that those CRLs and OCSP responses will be assumed to be valid indefinitely. The default value is -1. See also flag VerificationFlags.EnforceNextUpdate of integer parameter "VerificationFlags".
• Flags Abbreviation for "VerificationFlags".
• Model Abbreviation for "VerificationModel".
• RevocationPolicy Abbreviation for "CertificateRevocationVerificationPolicy".
• Timeout The timeout (in millisconds) for HTTP connections used for checking the revocation state of certificates. This value is ignored unless VerificationFlags.CheckRevocation is set for integer parameter "VerificationFlags". The default value is 10000.
• VerificationFlags Flags modifying the verification. This is a combination of flags from enum VerificationFlags. If you pass 0, the revocation state of the certificates won't be checked. The default value is 0. SignDocDocument.renderPageAsImage(), SignDocDocument.renderPageAsSignDocImage(), SignDocDocument.updateDSS(), SignDocDocument.updateDSS2(), SignDocVerificationResult.verifyCertificateSimplified(), and SignDocVerificationResult.verifyTimeStampCertificateSimplified() use integer parameter CertificateRevocationVerificationPolicy instead of the VerificationFlags.CheckRevocation flag. VerificationFlags.Offline should not be set for SignDocDocument.addSignature().
• VerificationModel Model to be used for verifying the certificate chain, see enum VerificationModel. The default value is VerificationModel.Minimal. SignDocDocument.addSignature() ignores this parameter and uses VerificationModel.Chain if revocation data is to be included in the signature.

Parameters

[out]	aReturnCode	The return code, ReturnCode.OK if successful, ReturnCode.UnknownParameter if aName is not the name of an integer parameter, ReturnCode.InvalidValue if aValue is invalid.
[in]	aName	The name of the parameter (case-sensitive).
[in]	aValue	The value of the parameter.

void setString	(	out ReturnCode	aReturnCode,
		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

[out]	aReturnCode	The return code, ReturnCode.OK if successful, ReturnCode.UnknownParameter if aName is not the name of a string parameter, ReturnCode.InvalidValue if aValue is invalid.
[in]	aName	The name of the parameter (case-sensitive).
[in]	aValue	The value of the parameter.

---

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

• SignDocDotNet.cs