Docs

SecureBlackbox 2022 .NET Edition

Version 22.0 [Build 8174]

OfficeVerifier Component

Properties   Methods   Events   Configuration Settings   Errors  

The OfficeVerifier component is capable of verifying signatures stored in Office documents.

Syntax

nsoftware.SecureBlackbox.Officeverifier

Remarks

Use OfficeVerifier to validate electronic signatures made over Office documents.

Property List


The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

AllSignaturesValidThe cumulative validity of all signatures.
BlockedCertificatesThe certificates that must be rejected as trust anchors.
CertificatesA collection of certificates included in the electronic signature.
ChainValidationDetailsThe details of a certificate chain validation outcome.
ChainValidationResultThe general outcome of a certificate chain validation routine. Use ChainValidationDetails to get information about the reasons that contributed to the validation result.
ClaimedSigningTimeReturns a signature's claimed signing time.
CRLsA collection of certificate revocation lists embedded into the signature by the signer.
CurrentCACertificateThe CA of the currently processed certificate.
CurrentCertificateThe certificate that is currently being processed.
DocumentFormatDefines the format of the Office document.
FIPSModeReserved.
IgnoreChainValidationErrorsMakes the component tolerant to chain validation errors.
InputBytesUse this property to pass the input to component in the byte array form.
InputFileThe path to the signed office document.
InputStreamThe stream containing the signed document.
InterimValidationDetailsContains the validation details of the moment.
InterimValidationResultContains the validation status of the moment.
KnownCertificatesAdditional certificates for chain validation.
KnownCRLsAdditional CRLs for chain validation.
KnownOCSPsAdditional OCSP responses for chain validation.
LastArchivalTimeIndicates the most recent archival time of an archived signature
OCSPsA collection of OCSP responses embedded into the signature.
OfflineModeSwitches the component to the offline mode.
OutputBytesUse this property to read the output the component object has produced.
OutputFileDefines where to save the modified signed document.
OutputStreamThe stream where the modified signed document would be saved.
ProfileSpecifies a pre-defined profile to apply when creating the signature.
ProxyThe proxy server settings.
QualifiedIndicates a qualified electronic signature.
RevocationCheckSpecifies the kind(s) of revocation check to perform.
SignatureContains the signature which is being validated.
SignatureBytesTBD.
SignatureIndexThe index of the signature to update or to verify
SignaturesAll signatures found in the Office document.
SignatureValidationResultThe signature validation result.
SignedPartsAll signed parts or entries found in the Office signatures.
SigningCertificateThe certificate of the signature creator.
SocketSettingsManages network connection settings.
TimestampContains the timestamp which is being validated.
TimestampedIndicates whether or not the signature is timestamped.
TLSClientChainThe TLS client certificate chain.
TLSServerChainThe TLS server's certificate chain.
TLSSettingsManages TLS layer settings.
TrustedCertificatesA list of trusted certificates for chain validation.
TSACertificateThe certificate of the Time Stamping Authority.
ValidatedSigningTimeContains the certified signing time.
ValidationLogContains the complete log of the certificate validation routine.
ValidationMomentSpecifies the validation moment.
XAdESEnabledSpecifies whether the document contains an advanced signature (XAdES).
XAdESFormSpecifies which form of XAdES has been used.
XAdESVersionSpecifies XAdES version.

Method List


The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

AddTimestampUse this method to add an timestamp.
AddTimestampValidationDataUse this method to add timestamp validation data to the signature.
AddValidationDataRefsUse this method to add signature validation references to the signature.
AddValidationDataValuesUse this method to add signature validation values to the signature.
ConfigSets or retrieves a configuration setting.
DoActionPerforms an additional action.
VerifyVerifies the whole document.

Event List


The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

ChainElementDownloadTBD
ChainElementNeededTBD
ChainValidatedReports the completion of a certificate chain validation.
ErrorInformation about errors during the signature validation.
NotificationThis event notifies the application about an underlying control flow event.
RetrieveCertificateThis event is fired when a certificate should be retrieved.
RetrieveCRLThis event is fired when a CRL should be retrieved.
RetrieveOCSPResponseThis event is fired when a OCSP Response should be retrieved.
SignatureFoundSignifies the start of signature validation.
SignatureValidatedMarks the completion of the signature validation routine.
StoreCertificateThis event is fired when a certificate should be stored along with a signature.
StoreCRLThis event is fired when a CRL should be stored along with a signature.
StoreOCSPResponseThis event is fired when a OCSP Response should be stored along with a signature.
TimestampFoundSignifies the start of a timestamp validation routine.
TimestampValidatedReports the completion of the timestamp validation routine.
TLSCertValidateThis event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.
ValidationProgressTBD

Configuration Settings


The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.

ClaimedRoleTextThe text of the claimed role.
ClaimedRoleXMLThe XML content of the claimed roles.
CommitmentTypeIndicationAllSignedDataObjects[Index]Specifies the CommitmentTypeIndication's AllSignedDataObjects.
CommitmentTypeIndicationCountThe number of the CommitmentTypeIndication elements.
CommitmentTypeIndicationIdentifier[Index]Specifies the CommitmentTypeIndication's CommitmentTypeId's Identifier.
CommitmentTypeIndicationIdentifierDescription[Index]Specifies the CommitmentTypeIndication's CommitmentTypeId's Description.
CommitmentTypeIndicationIdentifierDocumentationReferences[Index]Specifies the CommitmentTypeIndication's CommitmentTypeId's DocumentationReferences.
CommitmentTypeIndicationIdentifierQualifier[Index]Specifies the CommitmentTypeIndication's CommitmentTypeId's IdentifierQualifier.
CommitmentTypeIndicationObjectReference[Index]Specifies the CommitmentTypeIndication's ObjectReference.
CommitmentTypeIndicationQualifiersXML[Index]The XML content of the CommitmentTypeIndication's Qualifiers.
CustomTSLsSpecifies the custom TSLs.
ForceCompleteChainValidationWhether to check the CA certificates when the signing certificate is invalid.
ForceCompleteChainValidationForTrustedWhether to continue with the full validation up to the root CA certificate for mid-level trust anchors.
GracePeriodSpecifies a grace period to apply during revocation information checks.
IgnoreOCSPNoCheckExtensionWhether OCSP NoCheck extension should be ignored.
IgnoreSystemTrustWhether trusted Windows Certificate Stores should be treated as trusted.
ImplicitlyTrustSelfSignedCertificatesWhether to trust self-signed certificates.
IncludeKnownRevocationInfoToSignatureWhether to include custom revocation info to the signature.
ProductionPlaceIdentifies the place of the signature production.
PromoteLongOCSPResponsesWhether long OCSP responses are requested.
QualifiedStatusIndicates a qualified electronic signature.
RemoveSignatureWhether to remove signature.
SignatureInfoAddress1Specifies the location at which the signature was created.
SignatureInfoAddress2Specifies the location at which the signature was created.
SignatureInfoCommentsComments to the signature info text.
SignatureInfoDelegateSuggestedSignerSpecifies the name of a person.
SignatureInfoDelegateSuggestedSigner2Specifies the title of a person.
SignatureInfoDelegateSuggestedSignerEmailSpecifies the e-mail address of a person.
SignatureInfoImageSpecifies an image for the digital signature.
SignatureInfoIncludedWhether to include the signature info.
SignatureInfoInvalidLnImageSpecifies the image of an invalid signature.
SignatureInfoSignatureTypeSpecifies the type of the digital signature.
SignatureInfoTextThe text to be displayed as the signature info.
SignatureInfoValidLnImageSpecifies the image of a valid signature.
SignatureLineAdditionalSignatureInfo[Index]Contains additional signature information.
SignatureLineAllowComments[Index]Indicates if comments are allowed.
SignatureLineCountThe number of signature lines.
SignatureLineId[Index]Contains signature unique ID.
SignatureLineImageData[Index]Contains signature image.
SignatureLineShowSignDate[Index]Indicates if signing date should be shown.
SignatureLineSignatureIndex[Index]The index of the signature that signs signature line.
SignatureLineSignatureProviderId[Index]Contains signature provider ID.
SignatureLineSignatureProviderUrl[Index]Contains signature provider URL.
SignatureLineSigned[Index]Indicates if signature line is signed.
SignatureLineSigningInstructions[Index]Contains signing instructions.
SignatureLineSuggestedSigner2[Index]Suggested signer line two.
SignatureLineSuggestedSigner[Index]Suggested signer line one.
SignatureLineSuggestedSignerEmail[Index]Suggested signer email address.
SigPolicyDescriptionsignature policy description.
SigPolicyExplicitTextThe explicit text of the user notice.
SigPolicyHashThe hash value of the signature policy.
SigPolicyHashAlgorithmThe hash algorithm used to compute the signature policy hash.
SigPolicyIDIdentifies the signature policy.
SigPolicyNoticeNumbersContains user notice numbers.
SigPolicyNoticeOrganizationThe organization part of the NoticeReference qualifier.
SigPolicyURISignature policy URI.
TempPathLocation where the temporary files are stored.
TimestampCanonicalizationMethodSpecifies canonicalization method used in timestamp.
TimestampValidationDataDetailsSpecifies timestamp validation data details to include to the signature.
TLSChainValidationDetailsContains the advanced details of the TLS server certificate validation.
TLSChainValidationResultContains the result of the TLS server certificate validation.
TLSClientAuthRequestedIndicates whether the TLS server requests client authentication.
TLSValidationLogContains the log of the TLS server certificate validation.
TolerateMinorChainIssuesWhether to tolerate minor chain issues.
TSLDistributionPointsContains XML content of distribution points of the TSL used.
TSLDistributionPoints[Idx]Contains distribution point of the specified index of the TSL used.
TSLHistoricalInformationPeriodContains historical information period of the TSL used.
TSLLegalNoticesContains XML content of legal notices of the TSL used.
TSLLegalNotices[lang]Contains legal notices for the specified language of the TSL used.
TSLListIssueDateTimeContains list issue date and time of the TSL used.
TSLNextUpdateContains next update date and time of the TSL used.
TSLPoliciesContains XML content of policies of the TSL used.
TSLPolicies[lang]Contains policies for the specified language of the TSL used.
TSLSchemeExtensionsContains XML content of scheme extensions of the TSL used.
TSLSchemeExtensions[Idx]Contains XML content of scheme extension of the specified index of the TSL used.
TSLSchemeInformationURIContains XML content of scheme information URI of the TSL used.
TSLSchemeInformationURI[lang]Contains scheme information URI for the specified language of the TSL used.
TSLSchemeNameContains XML content of scheme name of the TSL used.
TSLSchemeName[lang]Contains scheme name for the specified language of the TSL used.
TSLSchemeOperatorAddressContains XML content of scheme operator address of the TSL used.
TSLSchemeOperatorNameContains XML content of scheme operator name of the TSL used.
TSLSchemeOperatorName[lang]Contains scheme operator name for the specified language of the TSL used.
TSLSchemeTerritoryContains scheme territory of the TSL used.
TSLSchemeTypeCommunityRulesContains XML content of scheme type/community/rules of the TSL used.
TSLSchemeTypeCommunityRules[lang]Contains scheme type/community/rules for the specified language of the TSL used.
TSLSequenceNumberContains sequence number of the TSL used.
TSLsRetrieveLogContains the complete log of the TSLs retrieve.
TSLStatusDeterminationApproachContains status determination approach of the TSL used.
TSLsValidationLogContains the complete log of the TSLs validation.
TSLTSPAdditionalServiceInformationContains addtional service information of the TSP service used.
TSLTSPAddressContains XML content of the address of the TSP used.
TSLTSPHistoryInstanceIndicates that TSP service history instance used.
TSLTSPHistoryInstanceAdditionalServiceInformationContains addtional service information of the TSP service history instance used.
TSLTSPHistoryInstanceQualifiersContains list of qualifiers of the TSP service history instance used.
TSLTSPHistoryInstanceServiceInformationExtensionsContains XML content of information extensions of the TSP service history instance used.
TSLTSPHistoryInstanceServiceInformationExtensions[Idx]Contains XML content of information extension of the specified index of the TSP service history instance used.
TSLTSPHistoryInstanceServiceNameContains XML content of name of the TSP service history instance used.
TSLTSPHistoryInstanceServiceName[lang]Contains name for the specified language of the TSP service history instance used.
TSLTSPHistoryInstanceServiceStatusContains status of the TSP service history instance used.
TSLTSPHistoryInstanceServiceStatusStartingTimeContains status starting time of the TSP service history instance used.
TSLTSPHistoryInstanceServiceTypeIdentifierContains type identifier of the TSP service history instance used.
TSLTSPHistoryInstanceXMLContains XML content of the TSP service history instance used.
TSLTSPInformationExtensionsContains XML content of information extensions of the TSP used.
TSLTSPInformationExtensions[Idx]Contains XML content of information extension of the specified index of the TSP used.
TSLTSPInformationURIContains XML content of information URI of the TSP used.
TSLTSPInformationURI[lang]Contains information URI for the specified language of the TSP used.
TSLTSPNameContains XML content of name of the TSP used.
TSLTSPName[lang]Contains name for the specified language of the TSP used.
TSLTSPSchemeServiceDefinitionURIContains XML content of scheme service definition URI of the TSP service used.
TSLTSPSchemeServiceDefinitionURI[lang]Contains scheme service definition URI for the specified language of the TSP service used.
TSLTSPServiceDefinitionURIContains XML content of definition URI of the TSP service used.
TSLTSPServiceDefinitionURI[lang]Contains definition URI for the specified language of the TSP service used.
TSLTSPServiceInformationExtensionsContains XML content of information extensions of the TSP service used.
TSLTSPServiceInformationExtensions[Idx]Contains XML content of information extension of the specified index of the TSP service used.
TSLTSPServiceNameContains XML content of name of the TSP service used.
TSLTSPServiceName[lang]Contains name for the specified language of the TSP service used.
TSLTSPServiceQualifiersContains list of qualifiers of the TSP service used.
TSLTSPServiceStatusContains status of the TSP service used.
TSLTSPServiceStatusStartingTimeContains status starting time of the TSP service used.
TSLTSPServiceSupplyPointsContains XML content of the supply points of the TSP service used.
TSLTSPServiceTypeIdentifierContains type identifier of the TSP service used.
TSLTSPServiceXMLContains XML content of the TSP service used.
TSLTSPTradeNameContains XML content of trade name of the TSP used.
TSLTSPTradeName[lang]Contains trade name for the specified language of the TSP used.
TSLTSPXMLContains XML content of the TSP used.
TSLTypeContains TSL type of the TSL used.
TSLVersionIdentifierContains version identifier of the TSL used.
TSLXMLContains XML content of the TSL used.
TspHashAlgorithmSets a specific hash algorithm for use with the timestamping service.
UseDefaultTSLsEnables or disables the use of the default TSLs.
UseMicrosoftCTLEnables or disables automatic use of Microsoft online certificate trust list.
UseSystemCertificatesEnables or disables the use of the system certificates.
ValidationDataRefsDetailsSpecifies validation data references details to include to the signature.
ValidationDataValuesDetailsSpecifies validation data values details to include to the signature.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the component (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
TagAllows to store any custom data.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

AllSignaturesValid Property (OfficeVerifier Component)

The cumulative validity of all signatures.

Syntax

public bool AllSignaturesValid { get; }
Public ReadOnly Property AllSignaturesValid As Boolean

Default Value

False

Remarks

Use this property to check if all the signatures found in the message or document are valid.

This property is read-only and not available at design time.

BlockedCertificates Property (OfficeVerifier Component)

The certificates that must be rejected as trust anchors.

Syntax

public CertificateList BlockedCertificates { get; }
Public Property BlockedCertificates As CertificateList

Remarks

Use this property to provide a list of compromised or blocked certificates. Any chain containing a blocked certificate will fail validation.

This property is not available at design time.

Certificates Property (OfficeVerifier Component)

A collection of certificates included in the electronic signature.

Syntax

public CertificateList Certificates { get; }
Public ReadOnly Property Certificates As CertificateList

Remarks

Use this property to access all certificates included into the signature(s) by its creator.

This property is read-only and not available at design time.

ChainValidationDetails Property (OfficeVerifier Component)

The details of a certificate chain validation outcome.

Syntax

public int ChainValidationDetails { get; }
Public ReadOnly Property ChainValidationDetails As Integer

Default Value

0

Remarks

Use the value(s) returned by this property to identify the reasons that contributed to the overall validation result.

Returns a bit mask of the following options:

cvrBadData0x0001One or more certificates in the validation path are malformed

cvrRevoked0x0002One or more certificates are revoked

cvrNotYetValid0x0004One or more certificates are not yet valid

cvrExpired0x0008One or more certificates are expired

cvrInvalidSignature0x0010A certificate contains a non-valid digital signature

cvrUnknownCA0x0020A CA certificate for one or more certificates has not been found (chain incomplete)

cvrCAUnauthorized0x0040One of the CA certificates are not authorized to act as CA

cvrCRLNotVerified0x0080One or more CRLs could not be verified

cvrOCSPNotVerified0x0100One or more OCSP responses could not be verified

cvrIdentityMismatch0x0200The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate

cvrNoKeyUsage0x0400A mandatory key usage is not enabled in one of the chain certificates

cvrBlocked0x0800One or more certificates are blocked

cvrFailure0x1000General validation failure

cvrChainLoop0x2000Chain loop: one of the CA certificates recursively signs itself

cvrWeakAlgorithm0x4000A weak algorithm is used in one of certificates or revocation elements

cvrUserEnforced0x8000The chain was considered invalid following intervention from a user code

This property is read-only and not available at design time.

ChainValidationResult Property (OfficeVerifier Component)

The general outcome of a certificate chain validation routine. Use ChainValidationDetails to get information about the reasons that contributed to the validation result.

Syntax

public OfficeverifierChainValidationResults ChainValidationResult { get; }

enum OfficeverifierChainValidationResults { cvtValid, cvtValidButUntrusted, cvtInvalid, cvtCantBeEstablished }
Public ReadOnly Property ChainValidationResult As OfficeverifierChainValidationResults

Enum OfficeverifierChainValidationResults cvtValid cvtValidButUntrusted cvtInvalid cvtCantBeEstablished End Enum

Default Value

0

Remarks

Available options:

cvtValid0The chain is valid

cvtValidButUntrusted1The chain is valid, but the root certificate is not trusted

cvtInvalid2The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature)

cvtCantBeEstablished3The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses)

Use the ValidationLog property to access the detailed validation log.

This property is read-only and not available at design time.

ClaimedSigningTime Property (OfficeVerifier Component)

Returns a signature's claimed signing time.

Syntax

public string ClaimedSigningTime { get; }
Public ReadOnly Property ClaimedSigningTime As String

Default Value

""

Remarks

Use this property to get the signature creation time from the signer's computer. Note that the claimed time is not covered by the signature and may be forfeited or wrong. Use ValidatedSigningTime to obtain the signing time figure verified by a trusted timestamping authority. The time is in UTC.

This property is read-only and not available at design time.

CRLs Property (OfficeVerifier Component)

A collection of certificate revocation lists embedded into the signature by the signer.

Syntax

public CRLList CRLs { get; }
Public ReadOnly Property CRLs As CRLList

Remarks

Use this property to access the CRLs embedded into the signature by the signer.

This property is read-only and not available at design time.

CurrentCACertificate Property (OfficeVerifier Component)

The CA of the currently processed certificate.

Syntax

public Certificate CurrentCACertificate { get; }
Public ReadOnly Property CurrentCACertificate As Certificate

Remarks

The validator component uses this property to publish the issuer certificate of the certificate that is currently being processed, if it is available.

This property is read-only and not available at design time.

CurrentCertificate Property (OfficeVerifier Component)

The certificate that is currently being processed.

Syntax

public Certificate CurrentCertificate { get; }
Public ReadOnly Property CurrentCertificate As Certificate

Remarks

This property returns the certificate that is currently being processed by the validator.

This property is read-only and not available at design time.

DocumentFormat Property (OfficeVerifier Component)

Defines the format of the Office document.

Syntax

public OfficeverifierDocumentFormats DocumentFormat { get; }

enum OfficeverifierDocumentFormats { odfUnknown, odfBinary, odfOpenXML, odfOpenXPS, odfOpenDocument }
Public ReadOnly Property DocumentFormat As OfficeverifierDocumentFormats

Enum OfficeverifierDocumentFormats odfUnknown odfBinary odfOpenXML odfOpenXPS odfOpenDocument End Enum

Default Value

0

Remarks

This property contains the Office document format.

odfUnknown0Unknown document format
odfBinary1Binary Office document
odfOpenXML2OpenXML Office document
odfOpenXPS3OpenXPS document
odfOpenDocument4OpenOffice document

This property is read-only and not available at design time.

FIPSMode Property (OfficeVerifier Component)

Reserved.

Syntax

public bool FIPSMode { get; set; }
Public Property FIPSMode As Boolean

Default Value

False

Remarks

This property is reserved for future use.

IgnoreChainValidationErrors Property (OfficeVerifier Component)

Makes the component tolerant to chain validation errors.

Syntax

public bool IgnoreChainValidationErrors { get; set; }
Public Property IgnoreChainValidationErrors As Boolean

Default Value

False

Remarks

If this property is set to True, any errors emerging during certificate chain validation will be ignored. This setting may be handy if the purpose of validation is the creation of an LTV signature, and the validation is performed in an environment that doesn't trust the signer's certificate chain.

InputBytes Property (OfficeVerifier Component)

Use this property to pass the input to component in the byte array form.

Syntax

public byte[] InputBytes { get; set; }
Public Property InputBytes As Byte()

Remarks

Assign a byte array containing the data to be processed to this property.

This property is not available at design time.

InputFile Property (OfficeVerifier Component)

The path to the signed office document.

Syntax

public string InputFile { get; set; }
Public Property InputFile As String

Default Value

""

Remarks

Use this property to provide the path to the document which you would like to verify.

InputStream Property (OfficeVerifier Component)

The stream containing the signed document.

Syntax

public System.IO.Stream InputStream { get; set; }
Public Property InputStream As System.IO.Stream

Default Value

null

Remarks

Use this property to feed the document to the component via a stream.

This property is not available at design time.

InterimValidationDetails Property (OfficeVerifier Component)

Contains the validation details of the moment.

Syntax

public int InterimValidationDetails { get; set; }
Public Property InterimValidationDetails As Integer

Default Value

0

Remarks

Over the course of the validation process, the validator maintains an interim validity status for the chain that is being processed. This status is influenced by every single step of the validation routine, and may change along the way, before the end of the chain is reached and the final validation conclusion is drawn.

Use this property to check the interim validity details mid-flight.

The value of this property is a bit mask of the following options:

cvrBadData0x0001One or more certificates in the validation path are malformed

cvrRevoked0x0002One or more certificates are revoked

cvrNotYetValid0x0004One or more certificates are not yet valid

cvrExpired0x0008One or more certificates are expired

cvrInvalidSignature0x0010A certificate contains a non-valid digital signature

cvrUnknownCA0x0020A CA certificate for one or more certificates has not been found (chain incomplete)

cvrCAUnauthorized0x0040One of the CA certificates are not authorized to act as CA

cvrCRLNotVerified0x0080One or more CRLs could not be verified

cvrOCSPNotVerified0x0100One or more OCSP responses could not be verified

cvrIdentityMismatch0x0200The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate

cvrNoKeyUsage0x0400A mandatory key usage is not enabled in one of the chain certificates

cvrBlocked0x0800One or more certificates are blocked

cvrFailure0x1000General validation failure

cvrChainLoop0x2000Chain loop: one of the CA certificates recursively signs itself

cvrWeakAlgorithm0x4000A weak algorithm is used in one of certificates or revocation elements

cvrUserEnforced0x8000The chain was considered invalid following intervention from a user code

This property is not available at design time.

InterimValidationResult Property (OfficeVerifier Component)

Contains the validation status of the moment.

Syntax

public OfficeverifierInterimValidationResults InterimValidationResult { get; set; }

enum OfficeverifierInterimValidationResults { cvtValid, cvtValidButUntrusted, cvtInvalid, cvtCantBeEstablished }
Public Property InterimValidationResult As OfficeverifierInterimValidationResults

Enum OfficeverifierInterimValidationResults cvtValid cvtValidButUntrusted cvtInvalid cvtCantBeEstablished End Enum

Default Value

0

Remarks

Over the course of the validation process, the validator maintains an interim validity status for the chain that is being processed. This status is influenced by every single step of the validation routine, and may change along the way, before the end of the chain is reached and the final validation conclusion is drawn.

Use this property to check the interim validity status mid-flight.

cvtValid0The chain is valid

cvtValidButUntrusted1The chain is valid, but the root certificate is not trusted

cvtInvalid2The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature)

cvtCantBeEstablished3The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses)

This property is not available at design time.

KnownCertificates Property (OfficeVerifier Component)

Additional certificates for chain validation.

Syntax

public CertificateList KnownCertificates { get; }
Public Property KnownCertificates As CertificateList

Remarks

Use this property to supply a list of additional certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when intermediary CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the component manually.

The purpose of certificates to be added to this collection is roughly equivalent to that of Intermediate Certification Authorities system store in Windows.

Do not add trust anchors or root certificates to this collection: add them to TrustedCertificates instead.

This property is not available at design time.

KnownCRLs Property (OfficeVerifier Component)

Additional CRLs for chain validation.

Syntax

public CRLList KnownCRLs { get; }
Public Property KnownCRLs As CRLList

Remarks

Use this property to supply additional CRLs that might be needed for chain validation. This property may be helpful when a chain is validated in offline mode, and the associated CRLs are stored separately from the signed message or document.

This property is not available at design time.

KnownOCSPs Property (OfficeVerifier Component)

Additional OCSP responses for chain validation.

Syntax

public OCSPResponseList KnownOCSPs { get; }
Public Property KnownOCSPs As OCSPResponseList

Remarks

Use this property to supply additional OCSP responses that might be needed for chain validation. This property may be helpful when a chain is validated in offline mode, and the associated OCSP responses are stored separately from the signed message or document.

This property is not available at design time.

LastArchivalTime Property (OfficeVerifier Component)

Indicates the most recent archival time of an archived signature

Syntax

public string LastArchivalTime { get; }
Public ReadOnly Property LastArchivalTime As String

Default Value

""

Remarks

This property returns the time of the most recent archival timestamp applied to the signature. This property only makes sense for 'archived' (CAdES-A) signatures.

This property is read-only and not available at design time.

OCSPs Property (OfficeVerifier Component)

A collection of OCSP responses embedded into the signature.

Syntax

public OCSPResponseList OCSPs { get; }
Public ReadOnly Property OCSPs As OCSPResponseList

Remarks

Use this property to access the OCSP responses embedded into the signature by its creator.

This property is read-only and not available at design time.

OfflineMode Property (OfficeVerifier Component)

Switches the component to the offline mode.

Syntax

public bool OfflineMode { get; set; }
Public Property OfflineMode As Boolean

Default Value

False

Remarks

When working in offline mode, the component restricts itself from using any online revocation information sources, such as CRL or OCSP responders.

Offline mode may be useful if there is a need to verify the completeness of validation information included within the signature or provided via KnownCertificates, KnownCRLs, and other related properties.

OutputBytes Property (OfficeVerifier Component)

Use this property to read the output the component object has produced.

Syntax

public byte[] OutputBytes { get; }
Public ReadOnly Property OutputBytes As Byte()

Remarks

Read the contents of this property after the operation is completed to read the produced output. This property will only be set if OutputFile and OutputStream properties had not been assigned.

This property is read-only and not available at design time.

OutputFile Property (OfficeVerifier Component)

Defines where to save the modified signed document.

Syntax

public string OutputFile { get; set; }
Public Property OutputFile As String

Default Value

""

Remarks

Specifies the path where the modified signed Office document should be saved.

OutputStream Property (OfficeVerifier Component)

The stream where the modified signed document would be saved.

Syntax

public System.IO.Stream OutputStream { get; set; }
Public Property OutputStream As System.IO.Stream

Default Value

null

Remarks

Use this property to save the modified signed document to the stream.

This property is not available at design time.

Profile Property (OfficeVerifier Component)

Specifies a pre-defined profile to apply when creating the signature.

Syntax

public string Profile { get; set; }
Public Property Profile As String

Default Value

""

Remarks

Advanced signatures come in many variants, which are often defined by parties that needs to process them or by local standards. SecureBlackbox profiles are sets of pre-defined configurations which correspond to particular signature variants. By specifying a profile, you are pre-configuring the component to make it produce the signature that matches the configuration corresponding to that profile.

Proxy Property (OfficeVerifier Component)

The proxy server settings.

Syntax

public ProxySettings Proxy { get; }
Public ReadOnly Property Proxy As ProxySettings

Remarks

Use this property to tune up the proxy server settings.

This property is read-only.

Qualified Property (OfficeVerifier Component)

Indicates a qualified electronic signature.

Syntax

public OfficeverifierQualifieds Qualified { get; }

enum OfficeverifierQualifieds { sqsUnknown, sqsNone, sqsGranted, sqsWithdrawn, sqsSetByNationalLaw, sqsDeprecatedByNationalLaw, sqsRecognizedAtNationalLevel, sqsDeprecatedAtNationalLevel, sqsUnderSupervision, sqsSupervisionInCessation, sqsSupervisionCeased, sqsSupervisionRevoked, sqsAccredited, sqsAccreditationCeased, sqsAccreditationRevoked, sqsInAccordance, sqsExpired, sqsSuspended, sqsRevoked, sqsNotInAccordance }
Public ReadOnly Property Qualified As OfficeverifierQualifieds

Enum OfficeverifierQualifieds sqsUnknown sqsNone sqsGranted sqsWithdrawn sqsSetByNationalLaw sqsDeprecatedByNationalLaw sqsRecognizedAtNationalLevel sqsDeprecatedAtNationalLevel sqsUnderSupervision sqsSupervisionInCessation sqsSupervisionCeased sqsSupervisionRevoked sqsAccredited sqsAccreditationCeased sqsAccreditationRevoked sqsInAccordance sqsExpired sqsSuspended sqsRevoked sqsNotInAccordance End Enum

Default Value

0

Remarks

Use this property to check if an electronic signature is created using a qualified device for creating electronic signatures and that relies on a qualified electronic signature certificate.

Adjust UseDefaultTSLs property and/or CustomTSLs property before validating the signature/certificate to properly obtain TSP (Trust Service Provider) service status. Use Qualified* and TSL* config properties to obtain extended information.

The following qualified statuses are supported:

sqsUnknown0Qualified status unknown. Use config's QualifiedInfo setting to obtain service status URI.

sqsNone1None

sqsGranted2Granted

sqsWithdrawn3Withdrawn

sqsSetByNationalLaw4Set by national law

sqsDeprecatedByNationalLaw5Deprecated by national law

sqsRecognizedAtNationalLevel6Recognized at national level

sqsDeprecatedAtNationalLevel7Deprecated at national level

sqsUnderSupervision8Under supervision

sqsSupervisionInCessation9Supervision in cessation

sqsSupervisionCeased10Supervision ceased

sqsSupervisionRevoked11Supervision revoked

sqsAccredited12Accredited

sqsAccreditationCeased13Accreditation ceased

sqsAccreditationRevoked14Accreditation revoked

sqsInAccordance15Deprecated. The subject service is in accordance with the scheme's specific status determination criteria (only for use in positive approval schemes).

sqsExpired16Deprecated. The subject service is no longer overseen by the scheme, e.g. due to nonrenewal or withdrawal by the TSP, or cessation of the service or the scheme's operations.

sqsSuspended17Deprecated. The subject service's status is temporarily uncertain whilst checks are made by the scheme operator (typically e.g. while a revocation request is being investigated or if action is required to resolve a deficiency in the service fulfilling the scheme's criteria.

sqsRevoked18Deprecated. The subject service's approved status has been revoked because it is no longer in accordance with the scheme's specific status determination criteria (only for use in positive approval schemes).

sqsNotInAccordance19Deprecated. The subject service is not in accordance with the scheme's specific status determination criteria (only for use in negative approval schemes).

This property is read-only and not available at design time.

RevocationCheck Property (OfficeVerifier Component)

Specifies the kind(s) of revocation check to perform.

Syntax

public OfficeverifierRevocationChecks RevocationCheck { get; set; }

enum OfficeverifierRevocationChecks { crcNone, crcAuto, crcAllCRL, crcAllOCSP, crcAllCRLAndOCSP, crcAnyCRL, crcAnyOCSP, crcAnyCRLOrOCSP, crcAnyOCSPOrCRL }
Public Property RevocationCheck As OfficeverifierRevocationChecks

Enum OfficeverifierRevocationChecks crcNone crcAuto crcAllCRL crcAllOCSP crcAllCRLAndOCSP crcAnyCRL crcAnyOCSP crcAnyCRLOrOCSP crcAnyOCSPOrCRL End Enum

Default Value

1

Remarks

Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.

Certificate Revocation Lists (CRL) and Online Certificate Status Protocol (OCSP) responses serve the same purpose of ensuring that the certificate had not been revoked by the Certificate Authority (CA) at the time of use. Depending on your circumstances and security policy requirements, you may want to use either one or both of the revocation information source types.

crcNone (0)No revocation checking
crcAuto (1)Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future.
crcAllCRL (2)Check all provided CRL endpoints for all chain certificates.
crcAllOCSP (3)Check all provided OCSP endpoints for all chain certificates.
crcAllCRLAndOCSP (4)Check all CRL and OCSP endpoints for all chain certificates.
crcAnyCRL (5)At least one CRL check for every certificate in the chain must succeed.
crcAnyOCSP (6)At least one OCSP check for every certificate in the chain must succeed.
crcAnyCRLOrOCSP (7)At least one CRL or OCSP check for every certificate in the chain must succeed. CRL endpoints are checked first.
crcAnyOCSPOrCRL (8)At least one CRL or OCSP check for every certificate in the chain must succeed. OCSP endpoints are checked first.

This setting controls the way the revocation checks are performed. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.

There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).

This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to faster OCSP route and only demand one source to succeed) is a good choice for most of typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

Signature Property (OfficeVerifier Component)

Contains the signature which is being validated.

Syntax

public OfficeSignature Signature { get; }
Public ReadOnly Property Signature As OfficeSignature

Remarks

Use this property to access the signature which is currently being validated.

This property is read-only and not available at design time.

SignatureBytes Property (OfficeVerifier Component)

TBD.

Syntax

public byte[] SignatureBytes { get; }
Public ReadOnly Property SignatureBytes As Byte()

Remarks

TBD.

This property is read-only and not available at design time.

SignatureIndex Property (OfficeVerifier Component)

The index of the signature to update or to verify

Syntax

public int SignatureIndex { get; set; }
Public Property SignatureIndex As Integer

Default Value

-1

Remarks

Use this property to specify the index of the existing signature before timestamping or adding validation info, or verifying. Use -1 (default value) to verify all signatures.

Signatures Property (OfficeVerifier Component)

All signatures found in the Office document.

Syntax

public OfficeSignatureList Signatures { get; }
Public ReadOnly Property Signatures As OfficeSignatureList

Remarks

This property contains a list of all signatures made over the Office document.

This property is read-only and not available at design time.

SignatureValidationResult Property (OfficeVerifier Component)

The signature validation result.

Syntax

public OfficeverifierSignatureValidationResults SignatureValidationResult { get; }

enum OfficeverifierSignatureValidationResults { svtValid, svtUnknown, svtCorrupted, svtSignerNotFound, svtFailure }
Public ReadOnly Property SignatureValidationResult As OfficeverifierSignatureValidationResults

Enum OfficeverifierSignatureValidationResults svtValid svtUnknown svtCorrupted svtSignerNotFound svtFailure End Enum

Default Value

0

Remarks

Use this property to check the result of the most recent signature validation.

svtValid0The signature is valid

svtUnknown1Signature validity is unknown

svtCorrupted2The signature is corrupted

svtSignerNotFound3Failed to acquire the signing certificate. The signature cannot be validated.

svtFailure4General failure

This property is read-only and not available at design time.

SignedParts Property (OfficeVerifier Component)

All signed parts or entries found in the Office signatures.

Syntax

public OfficeSignedPartList SignedParts { get; }
Public ReadOnly Property SignedParts As OfficeSignedPartList

Remarks

This property contains a list of all signed parts or entries extracted from the Office signatures.

This property is read-only and not available at design time.

SigningCertificate Property (OfficeVerifier Component)

The certificate of the signature creator.

Syntax

public Certificate SigningCertificate { get; }
Public ReadOnly Property SigningCertificate As Certificate

Remarks

Use this property to access the certificate that was used to create the signature.

This property is read-only and not available at design time.

SocketSettings Property (OfficeVerifier Component)

Manages network connection settings.

Syntax

public SocketSettings SocketSettings { get; }
Public ReadOnly Property SocketSettings As SocketSettings

Remarks

Use this property to tune up network connection parameters.

This property is read-only.

Timestamp Property (OfficeVerifier Component)

Contains the timestamp which is being validated.

Syntax

public TimestampInfo Timestamp { get; }
Public ReadOnly Property Timestamp As TimestampInfo

Remarks

Use this property to access the timestamp which is currently being validated.

This property is read-only and not available at design time.

Timestamped Property (OfficeVerifier Component)

Indicates whether or not the signature is timestamped.

Syntax

public bool Timestamped { get; }
Public ReadOnly Property Timestamped As Boolean

Default Value

False

Remarks

This property returns True if the signature is timestamped, and False otherwise.

This property is read-only and not available at design time.

TLSClientChain Property (OfficeVerifier Component)

The TLS client certificate chain.

Syntax

public CertificateList TLSClientChain { get; }
Public Property TLSClientChain As CertificateList

Remarks

Assign a certificate chain to this property to enable TLS client authentication in the component. Note that the client's end-entity certificate should have a private key associated with it.

This property is not available at design time.

TLSServerChain Property (OfficeVerifier Component)

The TLS server's certificate chain.

Syntax

public CertificateList TLSServerChain { get; }
Public ReadOnly Property TLSServerChain As CertificateList

Remarks

Use this property to access the certificate chain sent by the TLS server.

This property is read-only and not available at design time.

TLSSettings Property (OfficeVerifier Component)

Manages TLS layer settings.

Syntax

public TLSSettings TLSSettings { get; }
Public ReadOnly Property TLSSettings As TLSSettings

Remarks

Use this property to tune up the TLS layer parameters.

This property is read-only.

TrustedCertificates Property (OfficeVerifier Component)

A list of trusted certificates for chain validation.

Syntax

public CertificateList TrustedCertificates { get; }
Public Property TrustedCertificates As CertificateList

Remarks

Use this property to supply a list of trusted certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when root CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the component manually.

The purpose of this certificate collection is largely the same than that of Windows Trusted Root Certification Authorities system store.

Use this property with extreme care as it directly affects chain verifiability; a wrong certificate added to the trusted list may result in bad chains being accepted, and forfeited signatures being recognized as genuine. Only add certificates that originate from the parties that you know and trust.

This property is not available at design time.

TSACertificate Property (OfficeVerifier Component)

The certificate of the Time Stamping Authority.

Syntax

public Certificate TSACertificate { get; }
Public ReadOnly Property TSACertificate As Certificate

Remarks

Use this property to access the certificate of the TSA that produced the timestamp.

Note that in some instances the TSA certificate might be unavailable, even for timestamped documents and signatures.

This property is read-only and not available at design time.

ValidatedSigningTime Property (OfficeVerifier Component)

Contains the certified signing time.

Syntax

public string ValidatedSigningTime { get; }
Public ReadOnly Property ValidatedSigningTime As String

Default Value

""

Remarks

Use this property to obtain the signing time as certified by an external timestamp. The time is in UTC.

This property is read-only and not available at design time.

ValidationLog Property (OfficeVerifier Component)

Contains the complete log of the certificate validation routine.

Syntax

public string ValidationLog { get; }
Public ReadOnly Property ValidationLog As String

Default Value

""

Remarks

Use this property to access the chain validation log produced by the component. The log can be very useful when investigating issues with chain validation, as it contains a step-by-step trace of the entire validation procedure.

This property is read-only and not available at design time.

ValidationMoment Property (OfficeVerifier Component)

Specifies the validation moment.

Syntax

public string ValidationMoment { get; set; }
Public Property ValidationMoment As String

Default Value

""

Remarks

Use this property to specify the time for which the signature validation is performed. The time is in UTC.

XAdESEnabled Property (OfficeVerifier Component)

Specifies whether the document contains an advanced signature (XAdES).

Syntax

public bool XAdESEnabled { get; }
Public ReadOnly Property XAdESEnabled As Boolean

Default Value

False

Remarks

Use this property to check whether the document is signed with XAdES or XML-DSIG only.

This property is read-only and not available at design time.

XAdESForm Property (OfficeVerifier Component)

Specifies which form of XAdES has been used.

Syntax

public OfficeverifierXAdESForms XAdESForm { get; }

enum OfficeverifierXAdESForms { xafUnknown, xafBasic, xafBES, xafEPES, xafT, xafC, xafX, xafXL, xafA, xafExtendedBES, xafExtendedEPES, xafExtendedT, xafExtendedC, xafExtendedX, xafExtendedXLong, xafExtendedXL, xafExtendedA }
Public ReadOnly Property XAdESForm As OfficeverifierXAdESForms

Enum OfficeverifierXAdESForms xafUnknown xafBasic xafBES xafEPES xafT xafC xafX xafXL xafA xafExtendedBES xafExtendedEPES xafExtendedT xafExtendedC xafExtendedX xafExtendedXLong xafExtendedXL xafExtendedA End Enum

Default Value

0

Remarks

Use this property to check the form (level) of XAdES.

xafUnknown0
xafBasic1XAdES form, supported by XAdES v1.1.1
xafBES2XAdES-BES form, supported starting from XAdES v1.2.2
xafEPES3XAdES-EPES form, supported starting from XAdES v1.2.2
xafT4XAdES-T form
xafC5XAdES-C form
xafX6XAdES-X form
xafXL7XAdES-X-L form
xafA8XAdES-A form
xafExtendedBES9XAdES-E-BES form
xafExtendedEPES10XAdES-E-EPES form
xafExtendedT11XAdES-E-T form
xafExtendedC12XAdES-E-C form
xafExtendedX13XAdES-E-X form
xafExtendedXLong14XAdES-E-X-Long form (type 1)
xafExtendedXL15XAdES-E-X-L form (type 2)
xafExtendedA16XAdES-E-A form

* XAdES-E-* forms are supported starting from XAdES v1.3.2

This property is read-only and not available at design time.

XAdESVersion Property (OfficeVerifier Component)

Specifies XAdES version.

Syntax

public OfficeverifierXAdESVersions XAdESVersion { get; set; }

enum OfficeverifierXAdESVersions { xavUnknown, xav111, xav122, xav132, xav141 }
Public Property XAdESVersion As OfficeverifierXAdESVersions

Enum OfficeverifierXAdESVersions xavUnknown xav111 xav122 xav132 xav141 End Enum

Default Value

0

Remarks

This property specifies the version of the XAdES specification used to produce the signature.

xavUnknown0
xav1111XAdES v1.1.1
xav1222XAdES v1.2.2
xav1323XAdES v1.3.2
xav1414XAdES v1.4.1 (aka v1.4.2)

This property is not available at design time.

AddTimestamp Method (OfficeVerifier Component)

Use this method to add an timestamp.

Syntax

public void AddTimestamp(int timestampType, string timestampServer);
Public Sub AddTimestamp(ByVal TimestampType As Integer, ByVal TimestampServer As String)

Remarks

Call this method to timestamp the signature. Use the TimestampServer parameter to provide the address of the TSA (Time Stamping Authority) server which should be used for timestamping. This method could be called separately or in SignatureValidated event handler after successful signature validation. Use the TimestampType parameter to specify the type of timestamp to create

Supported timestamp types:

tstSignature12Signature timestamp
tstRefsOnly13RefsOnly timestamp
tstSigAndRefs14SigAndRefs timestamp
tstArchive7Archive timestamp

AddTimestampValidationData Method (OfficeVerifier Component)

Use this method to add timestamp validation data to the signature.

Syntax

public void AddTimestampValidationData();
Public Sub AddTimestampValidationData()

Remarks

Call this method to add certificates and revocation information used to validate timestamp's signer certificates at a particular time. This method could be called separately or in SignatureValidated event handler after successful signature validation.

AddValidationDataRefs Method (OfficeVerifier Component)

Use this method to add signature validation references to the signature.

Syntax

public void AddValidationDataRefs();
Public Sub AddValidationDataRefs()

Remarks

Call this method to add references to certificates and revocation information used to validate a signature at a particular time. This method could be called separately or in SignatureValidated event handler after successful signature validation.

AddValidationDataValues Method (OfficeVerifier Component)

Use this method to add signature validation values to the signature.

Syntax

public void AddValidationDataValues();
Public Sub AddValidationDataValues()

Remarks

Call this method to add certificates and revocation information used to validate a signature at a particular time. This method could be called separately or in SignatureValidated event handler after successful signature validation.

Config Method (OfficeVerifier Component)

Sets or retrieves a configuration setting.

Syntax

public string Config(string configurationString);
Public Function Config(ByVal ConfigurationString As String) As String

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DoAction Method (OfficeVerifier Component)

Performs an additional action.

Syntax

public string DoAction(string actionID, string actionParams);
Public Function DoAction(ByVal ActionID As String, ByVal ActionParams As String) As String

Remarks

DoAction is a generic method available in every component. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Verify Method (OfficeVerifier Component)

Verifies the whole document.

Syntax

public void Verify();
Public Sub Verify()

Remarks

Use this method to verify the document.

ChainElementDownload Event (OfficeVerifier Component)

TBD

Syntax

public event OnChainElementDownloadHandler OnChainElementDownload;

public delegate void OnChainElementDownloadHandler(object sender, OfficeverifierChainElementDownloadEventArgs e);

public class OfficeverifierChainElementDownloadEventArgs : EventArgs {
  public string Cert { get; }

  public string CACert { get; }

  public string Location { get; }

}
Public Event OnChainElementDownload As OnChainElementDownloadHandler

Public Delegate Sub OnChainElementDownloadHandler(sender As Object, e As OfficeverifierChainElementDownloadEventArgs)

Public Class OfficeverifierChainElementDownloadEventArgs Inherits EventArgs
  Public ReadOnly Property Cert As String

  Public ReadOnly Property CACert As String

  Public ReadOnly Property Location As String

End Class

Remarks

TBD.

ChainElementNeeded Event (OfficeVerifier Component)

TBD

Syntax

public event OnChainElementNeededHandler OnChainElementNeeded;

public delegate void OnChainElementNeededHandler(object sender, OfficeverifierChainElementNeededEventArgs e);

public class OfficeverifierChainElementNeededEventArgs : EventArgs {
  public string Cert { get; }

  public string CACert { get; }

}
Public Event OnChainElementNeeded As OnChainElementNeededHandler

Public Delegate Sub OnChainElementNeededHandler(sender As Object, e As OfficeverifierChainElementNeededEventArgs)

Public Class OfficeverifierChainElementNeededEventArgs Inherits EventArgs
  Public ReadOnly Property Cert As String

  Public ReadOnly Property CACert As String

End Class

Remarks

TBD.

ChainValidated Event (OfficeVerifier Component)

Reports the completion of a certificate chain validation.

Syntax

public event OnChainValidatedHandler OnChainValidated;

public delegate void OnChainValidatedHandler(object sender, OfficeverifierChainValidatedEventArgs e);

public class OfficeverifierChainValidatedEventArgs : EventArgs {
  public string SubjectRDN { get; }

  public int ValidationResult { get; }

  public int ValidationDetails { get; }

}
Public Event OnChainValidated As OnChainValidatedHandler

Public Delegate Sub OnChainValidatedHandler(sender As Object, e As OfficeverifierChainValidatedEventArgs)

Public Class OfficeverifierChainValidatedEventArgs Inherits EventArgs
  Public ReadOnly Property SubjectRDN As String

  Public ReadOnly Property ValidationResult As Integer

  Public ReadOnly Property ValidationDetails As Integer

End Class

Remarks

This event is fired when a certificate chain validation routine completes. SubjectRDN identifies the owner of the validated certificate.

ValidationResult set to 0 (zero) indicates successful chain validation.

cvtValid0The chain is valid

cvtValidButUntrusted1The chain is valid, but the root certificate is not trusted

cvtInvalid2The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature)

cvtCantBeEstablished3The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses)

Any other value reports a failure, and ValidationDetails provides more details on its reasons.

cvrBadData0x0001One or more certificates in the validation path are malformed

cvrRevoked0x0002One or more certificates are revoked

cvrNotYetValid0x0004One or more certificates are not yet valid

cvrExpired0x0008One or more certificates are expired

cvrInvalidSignature0x0010A certificate contains a non-valid digital signature

cvrUnknownCA0x0020A CA certificate for one or more certificates has not been found (chain incomplete)

cvrCAUnauthorized0x0040One of the CA certificates are not authorized to act as CA

cvrCRLNotVerified0x0080One or more CRLs could not be verified

cvrOCSPNotVerified0x0100One or more OCSP responses could not be verified

cvrIdentityMismatch0x0200The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate

cvrNoKeyUsage0x0400A mandatory key usage is not enabled in one of the chain certificates

cvrBlocked0x0800One or more certificates are blocked

cvrFailure0x1000General validation failure

cvrChainLoop0x2000Chain loop: one of the CA certificates recursively signs itself

cvrWeakAlgorithm0x4000A weak algorithm is used in one of certificates or revocation elements

cvrUserEnforced0x8000The chain was considered invalid following intervention from a user code

Error Event (OfficeVerifier Component)

Information about errors during the signature validation.

Syntax

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, OfficeverifierErrorEventArgs e);

public class OfficeverifierErrorEventArgs : EventArgs {
  public int ErrorCode { get; }

  public string Description { get; }

}
Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As OfficeverifierErrorEventArgs)

Public Class OfficeverifierErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer

  Public ReadOnly Property Description As String

End Class

Remarks

This event is fired in case of exceptional conditions during the office document processing.

ErrorCode contains an error code and Description contains a textual description of the error.

Notification Event (OfficeVerifier Component)

This event notifies the application about an underlying control flow event.

Syntax

public event OnNotificationHandler OnNotification;

public delegate void OnNotificationHandler(object sender, OfficeverifierNotificationEventArgs e);

public class OfficeverifierNotificationEventArgs : EventArgs {
  public string EventID { get; }

  public string EventParam { get; }

}
Public Event OnNotification As OnNotificationHandler

Public Delegate Sub OnNotificationHandler(sender As Object, e As OfficeverifierNotificationEventArgs)

Public Class OfficeverifierNotificationEventArgs Inherits EventArgs
  Public ReadOnly Property EventID As String

  Public ReadOnly Property EventParam As String

End Class

Remarks

The component fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.

This component can fire this event with the following EventID values:

DocumentLoadedReports the completion of Office document processing by the component. Use the event handler to access document-related information. The EventParam value passed with this EventID is empty.

RetrieveCertificate Event (OfficeVerifier Component)

This event is fired when a certificate should be retrieved.

Syntax

public event OnRetrieveCertificateHandler OnRetrieveCertificate;

public delegate void OnRetrieveCertificateHandler(object sender, OfficeverifierRetrieveCertificateEventArgs e);

public class OfficeverifierRetrieveCertificateEventArgs : EventArgs {
  public string URI { get; }

}
Public Event OnRetrieveCertificate As OnRetrieveCertificateHandler

Public Delegate Sub OnRetrieveCertificateHandler(sender As Object, e As OfficeverifierRetrieveCertificateEventArgs)

Public Class OfficeverifierRetrieveCertificateEventArgs Inherits EventArgs
  Public ReadOnly Property URI As String

End Class

Remarks

This event could occur if you are verifying XAdES-C form or higher. URI parameter contains a URI value of the stored certificate along with a signature. The user should add the certificate to the KnownCertificates property.

RetrieveCRL Event (OfficeVerifier Component)

This event is fired when a CRL should be retrieved.

Syntax

public event OnRetrieveCRLHandler OnRetrieveCRL;

public delegate void OnRetrieveCRLHandler(object sender, OfficeverifierRetrieveCRLEventArgs e);

public class OfficeverifierRetrieveCRLEventArgs : EventArgs {
  public string URI { get; }

}
Public Event OnRetrieveCRL As OnRetrieveCRLHandler

Public Delegate Sub OnRetrieveCRLHandler(sender As Object, e As OfficeverifierRetrieveCRLEventArgs)

Public Class OfficeverifierRetrieveCRLEventArgs Inherits EventArgs
  Public ReadOnly Property URI As String

End Class

Remarks

This event could occur if you are verifying XAdES-C form or higher. URI parameter contains a URI value of the stored CRL along with a signature. The user should add the CRL to the KnownCRLs property.

RetrieveOCSPResponse Event (OfficeVerifier Component)

This event is fired when a OCSP Response should be retrieved.

Syntax

public event OnRetrieveOCSPResponseHandler OnRetrieveOCSPResponse;

public delegate void OnRetrieveOCSPResponseHandler(object sender, OfficeverifierRetrieveOCSPResponseEventArgs e);

public class OfficeverifierRetrieveOCSPResponseEventArgs : EventArgs {
  public string URI { get; }

}
Public Event OnRetrieveOCSPResponse As OnRetrieveOCSPResponseHandler

Public Delegate Sub OnRetrieveOCSPResponseHandler(sender As Object, e As OfficeverifierRetrieveOCSPResponseEventArgs)

Public Class OfficeverifierRetrieveOCSPResponseEventArgs Inherits EventArgs
  Public ReadOnly Property URI As String

End Class

Remarks

This event could occur if you are verifying XAdES-C form or higher. URI parameter contains a URI value of the stored OCSP Response along with a signature. The user should add the OCSP Response to the KnownOCSPs property.

SignatureFound Event (OfficeVerifier Component)

Signifies the start of signature validation.

Syntax

public event OnSignatureFoundHandler OnSignatureFound;

public delegate void OnSignatureFoundHandler(object sender, OfficeverifierSignatureFoundEventArgs e);

public class OfficeverifierSignatureFoundEventArgs : EventArgs {
  public string IssuerRDN { get; }

  public byte[] SerialNumber { get; }

  public byte[] SubjectKeyID { get; }

  public bool CertFound { get; }

  public bool ValidateSignature { get; set; }

  public bool ValidateChain { get; set; }

}
Public Event OnSignatureFound As OnSignatureFoundHandler

Public Delegate Sub OnSignatureFoundHandler(sender As Object, e As OfficeverifierSignatureFoundEventArgs)

Public Class OfficeverifierSignatureFoundEventArgs Inherits EventArgs
  Public ReadOnly Property IssuerRDN As String

  Public ReadOnly Property SerialNumber As Byte()

  Public ReadOnly Property SubjectKeyID As Byte()

  Public ReadOnly Property CertFound As Boolean

  Public Property ValidateSignature As Boolean

  Public Property ValidateChain As Boolean

End Class

Remarks

This event tells the application that signature validation is about to start, and provides the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters. It fires for every signature located in the verified document or message.

The CertFound is set to True if the component has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via KnownCertificates property.

Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with SignatureValidationResult and ChainValidationResult properties respectively.

Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.

SignatureValidated Event (OfficeVerifier Component)

Marks the completion of the signature validation routine.

Syntax

public event OnSignatureValidatedHandler OnSignatureValidated;

public delegate void OnSignatureValidatedHandler(object sender, OfficeverifierSignatureValidatedEventArgs e);

public class OfficeverifierSignatureValidatedEventArgs : EventArgs {
  public string IssuerRDN { get; }

  public byte[] SerialNumber { get; }

  public byte[] SubjectKeyID { get; }

  public int ValidationResult { get; }

}
Public Event OnSignatureValidated As OnSignatureValidatedHandler

Public Delegate Sub OnSignatureValidatedHandler(sender As Object, e As OfficeverifierSignatureValidatedEventArgs)

Public Class OfficeverifierSignatureValidatedEventArgs Inherits EventArgs
  Public ReadOnly Property IssuerRDN As String

  Public ReadOnly Property SerialNumber As Byte()

  Public ReadOnly Property SubjectKeyID As Byte()

  Public ReadOnly Property ValidationResult As Integer

End Class

Remarks

This event is fired upon the completion of the signature validation routine, and reports the respective validation result.

Use the IssuerRDN, SerialNumber, and/or SubjectKeyID parameters to identify the signing certificate.

ValidationResult is set to 0 if the validation has been successful, or to a non-zero value in case of a validation failure.

svtValid0The signature is valid

svtUnknown1Signature validity is unknown

svtCorrupted2The signature is corrupted

svtSignerNotFound3Failed to acquire the signing certificate. The signature cannot be validated.

svtFailure4General failure

StoreCertificate Event (OfficeVerifier Component)

This event is fired when a certificate should be stored along with a signature.

Syntax

public event OnStoreCertificateHandler OnStoreCertificate;

public delegate void OnStoreCertificateHandler(object sender, OfficeverifierStoreCertificateEventArgs e);

public class OfficeverifierStoreCertificateEventArgs : EventArgs {
  public byte[] Cert { get; }

  public string URI { get; set; }

}
Public Event OnStoreCertificate As OnStoreCertificateHandler

Public Delegate Sub OnStoreCertificateHandler(sender As Object, e As OfficeverifierStoreCertificateEventArgs)

Public Class OfficeverifierStoreCertificateEventArgs Inherits EventArgs
  Public ReadOnly Property Cert As Byte()

  Public Property URI As String

End Class

Remarks

This event could occur if you are verifying XAdES-C form or higher. Cert parameter contains a certificate in binary form that should be stored along with a signature, and the user should provide the URI of the stored certificate.

StoreCRL Event (OfficeVerifier Component)

This event is fired when a CRL should be stored along with a signature.

Syntax

public event OnStoreCRLHandler OnStoreCRL;

public delegate void OnStoreCRLHandler(object sender, OfficeverifierStoreCRLEventArgs e);

public class OfficeverifierStoreCRLEventArgs : EventArgs {
  public byte[] CRL { get; }

  public string URI { get; set; }

}
Public Event OnStoreCRL As OnStoreCRLHandler

Public Delegate Sub OnStoreCRLHandler(sender As Object, e As OfficeverifierStoreCRLEventArgs)

Public Class OfficeverifierStoreCRLEventArgs Inherits EventArgs
  Public ReadOnly Property CRL As Byte()

  Public Property URI As String

End Class

Remarks

This event could occur if you are verifying XAdES-C form or higher. CRL parameter contains a CRL in binary form that should be stored along with a signature, and the user should provide the URI of the stored CRL.

StoreOCSPResponse Event (OfficeVerifier Component)

This event is fired when a OCSP Response should be stored along with a signature.

Syntax

public event OnStoreOCSPResponseHandler OnStoreOCSPResponse;

public delegate void OnStoreOCSPResponseHandler(object sender, OfficeverifierStoreOCSPResponseEventArgs e);

public class OfficeverifierStoreOCSPResponseEventArgs : EventArgs {
  public byte[] OCSPResponse { get; }

  public string URI { get; set; }

}
Public Event OnStoreOCSPResponse As OnStoreOCSPResponseHandler

Public Delegate Sub OnStoreOCSPResponseHandler(sender As Object, e As OfficeverifierStoreOCSPResponseEventArgs)

Public Class OfficeverifierStoreOCSPResponseEventArgs Inherits EventArgs
  Public ReadOnly Property OCSPResponse As Byte()

  Public Property URI As String

End Class

Remarks

This event could occur if you are verifying XAdES-C form or higher. OCSPResponse parameter contains an OCSP Response in binary form that should be stored along with a signature, and the user should provide the URI of the stored OCSP Response.

TimestampFound Event (OfficeVerifier Component)

Signifies the start of a timestamp validation routine.

Syntax

public event OnTimestampFoundHandler OnTimestampFound;

public delegate void OnTimestampFoundHandler(object sender, OfficeverifierTimestampFoundEventArgs e);

public class OfficeverifierTimestampFoundEventArgs : EventArgs {
  public string IssuerRDN { get; }

  public byte[] SerialNumber { get; }

  public byte[] SubjectKeyID { get; }

  public bool CertFound { get; }

  public bool ValidateTimestamp { get; set; }

  public bool ValidateChain { get; set; }

}
Public Event OnTimestampFound As OnTimestampFoundHandler

Public Delegate Sub OnTimestampFoundHandler(sender As Object, e As OfficeverifierTimestampFoundEventArgs)

Public Class OfficeverifierTimestampFoundEventArgs Inherits EventArgs
  Public ReadOnly Property IssuerRDN As String

  Public ReadOnly Property SerialNumber As Byte()

  Public ReadOnly Property SubjectKeyID As Byte()

  Public ReadOnly Property CertFound As Boolean

  Public Property ValidateTimestamp As Boolean

  Public Property ValidateChain As Boolean

End Class

Remarks

This event fires for every timestamp identified during signature processing, and reports the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters.

The CertFound is set to True if the component has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via KnownCertificates property.

Just like with signature validation, timestamp validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with SignatureValidationResult and ChainValidationResult properties respectively.

Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.

TimestampValidated Event (OfficeVerifier Component)

Reports the completion of the timestamp validation routine.

Syntax

public event OnTimestampValidatedHandler OnTimestampValidated;

public delegate void OnTimestampValidatedHandler(object sender, OfficeverifierTimestampValidatedEventArgs e);

public class OfficeverifierTimestampValidatedEventArgs : EventArgs {
  public string IssuerRDN { get; }

  public byte[] SerialNumber { get; }

  public byte[] SubjectKeyID { get; }

  public string Time { get; }

  public int ValidationResult { get; }

  public int ChainValidationResult { get; }

  public int ChainValidationDetails { get; }

}
Public Event OnTimestampValidated As OnTimestampValidatedHandler

Public Delegate Sub OnTimestampValidatedHandler(sender As Object, e As OfficeverifierTimestampValidatedEventArgs)

Public Class OfficeverifierTimestampValidatedEventArgs Inherits EventArgs
  Public ReadOnly Property IssuerRDN As String

  Public ReadOnly Property SerialNumber As Byte()

  Public ReadOnly Property SubjectKeyID As Byte()

  Public ReadOnly Property Time As String

  Public ReadOnly Property ValidationResult As Integer

  Public ReadOnly Property ChainValidationResult As Integer

  Public ReadOnly Property ChainValidationDetails As Integer

End Class

Remarks

This event is fired upon the completion of the timestamp validation routine, and reports the respective validation result.

ValidationResult is set to 0 if the validation has been successful, or to a non-zero value in case of a failure.

svtValid0The signature is valid

svtUnknown1Signature validity is unknown

svtCorrupted2The signature is corrupted

svtSignerNotFound3Failed to acquire the signing certificate. The signature cannot be validated.

svtFailure4General failure

TLSCertValidate Event (OfficeVerifier Component)

This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.

Syntax

public event OnTLSCertValidateHandler OnTLSCertValidate;

public delegate void OnTLSCertValidateHandler(object sender, OfficeverifierTLSCertValidateEventArgs e);

public class OfficeverifierTLSCertValidateEventArgs : EventArgs {
  public string ServerHostname { get; }

  public string ServerIP { get; }

  public bool Accept { get; set; }

}
Public Event OnTLSCertValidate As OnTLSCertValidateHandler

Public Delegate Sub OnTLSCertValidateHandler(sender As Object, e As OfficeverifierTLSCertValidateEventArgs)

Public Class OfficeverifierTLSCertValidateEventArgs Inherits EventArgs
  Public ReadOnly Property ServerHostname As String

  Public ReadOnly Property ServerIP As String

  Public Property Accept As Boolean

End Class

Remarks

This event is fired during a TLS handshake. Use TLSServerChain property to access the certificate chain. In general case, components may contact a number of TLS endpoints during their work, depending on their configuration.

Accept is assigned in accordance with the outcome of the internal validation check performed by the component, and can be adjusted if needed.

ValidationProgress Event (OfficeVerifier Component)

TBD

Syntax

public event OnValidationProgressHandler OnValidationProgress;

public delegate void OnValidationProgressHandler(object sender, OfficeverifierValidationProgressEventArgs e);

public class OfficeverifierValidationProgressEventArgs : EventArgs {
  public string ValidationEventType { get; }

  public string Cert { get; }

  public string CACert { get; }

  public bool DoContinue { get; set; }

}
Public Event OnValidationProgress As OnValidationProgressHandler

Public Delegate Sub OnValidationProgressHandler(sender As Object, e As OfficeverifierValidationProgressEventArgs)

Public Class OfficeverifierValidationProgressEventArgs Inherits EventArgs
  Public ReadOnly Property ValidationEventType As String

  Public ReadOnly Property Cert As String

  Public ReadOnly Property CACert As String

  Public Property DoContinue As Boolean

End Class

Remarks

TBD.

Certificate Type

Provides details of an individual X.509 certificate.

Remarks

This type provides access to X.509 certificate details.

Fields

Bytes
Byte()

Returns raw certificate data in DER format.

CA
Boolean

Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).

CAKeyID
Byte()

A unique identifier (fingerprint) of the CA certificate's private key.

Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.

CRLDistributionPoints
String

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

Curve
String

Specifies the elliptic curve of the EC public key.

SB_EC_SECP112R1SECP112R1
SB_EC_SECP112R2SECP112R2
SB_EC_SECP128R1SECP128R1
SB_EC_SECP128R2SECP128R2
SB_EC_SECP160K1SECP160K1
SB_EC_SECP160R1SECP160R1
SB_EC_SECP160R2SECP160R2
SB_EC_SECP192K1SECP192K1
SB_EC_SECP192R1SECP192R1
SB_EC_SECP224K1SECP224K1
SB_EC_SECP224R1SECP224R1
SB_EC_SECP256K1SECP256K1
SB_EC_SECP256R1SECP256R1
SB_EC_SECP384R1SECP384R1
SB_EC_SECP521R1SECP521R1
SB_EC_SECT113R1SECT113R1
SB_EC_SECT113R2SECT113R2
SB_EC_SECT131R1SECT131R1
SB_EC_SECT131R2SECT131R2
SB_EC_SECT163K1SECT163K1
SB_EC_SECT163R1SECT163R1
SB_EC_SECT163R2SECT163R2
SB_EC_SECT193R1SECT193R1
SB_EC_SECT193R2SECT193R2
SB_EC_SECT233K1SECT233K1
SB_EC_SECT233R1SECT233R1
SB_EC_SECT239K1SECT239K1
SB_EC_SECT283K1SECT283K1
SB_EC_SECT283R1SECT283R1
SB_EC_SECT409K1SECT409K1
SB_EC_SECT409R1SECT409R1
SB_EC_SECT571K1SECT571K1
SB_EC_SECT571R1SECT571R1
SB_EC_PRIME192V1PRIME192V1
SB_EC_PRIME192V2PRIME192V2
SB_EC_PRIME192V3PRIME192V3
SB_EC_PRIME239V1PRIME239V1
SB_EC_PRIME239V2PRIME239V2
SB_EC_PRIME239V3PRIME239V3
SB_EC_PRIME256V1PRIME256V1
SB_EC_C2PNB163V1C2PNB163V1
SB_EC_C2PNB163V2C2PNB163V2
SB_EC_C2PNB163V3C2PNB163V3
SB_EC_C2PNB176W1C2PNB176W1
SB_EC_C2TNB191V1C2TNB191V1
SB_EC_C2TNB191V2C2TNB191V2
SB_EC_C2TNB191V3C2TNB191V3
SB_EC_C2ONB191V4C2ONB191V4
SB_EC_C2ONB191V5C2ONB191V5
SB_EC_C2PNB208W1C2PNB208W1
SB_EC_C2TNB239V1C2TNB239V1
SB_EC_C2TNB239V2C2TNB239V2
SB_EC_C2TNB239V3C2TNB239V3
SB_EC_C2ONB239V4C2ONB239V4
SB_EC_C2ONB239V5C2ONB239V5
SB_EC_C2PNB272W1C2PNB272W1
SB_EC_C2PNB304W1C2PNB304W1
SB_EC_C2TNB359V1C2TNB359V1
SB_EC_C2PNB368W1C2PNB368W1
SB_EC_C2TNB431R1C2TNB431R1
SB_EC_NISTP192NISTP192
SB_EC_NISTP224NISTP224
SB_EC_NISTP256NISTP256
SB_EC_NISTP384NISTP384
SB_EC_NISTP521NISTP521
SB_EC_NISTB163NISTB163
SB_EC_NISTB233NISTB233
SB_EC_NISTB283NISTB283
SB_EC_NISTB409NISTB409
SB_EC_NISTB571NISTB571
SB_EC_NISTK163NISTK163
SB_EC_NISTK233NISTK233
SB_EC_NISTK283NISTK283
SB_EC_NISTK409NISTK409
SB_EC_NISTK571NISTK571
SB_EC_GOSTCPTESTGOSTCPTEST
SB_EC_GOSTCPAGOSTCPA
SB_EC_GOSTCPBGOSTCPB
SB_EC_GOSTCPCGOSTCPC
SB_EC_GOSTCPXCHAGOSTCPXCHA
SB_EC_GOSTCPXCHBGOSTCPXCHB
SB_EC_BRAINPOOLP160R1BRAINPOOLP160R1
SB_EC_BRAINPOOLP160T1BRAINPOOLP160T1
SB_EC_BRAINPOOLP192R1BRAINPOOLP192R1
SB_EC_BRAINPOOLP192T1BRAINPOOLP192T1
SB_EC_BRAINPOOLP224R1BRAINPOOLP224R1
SB_EC_BRAINPOOLP224T1BRAINPOOLP224T1
SB_EC_BRAINPOOLP256R1BRAINPOOLP256R1
SB_EC_BRAINPOOLP256T1BRAINPOOLP256T1
SB_EC_BRAINPOOLP320R1BRAINPOOLP320R1
SB_EC_BRAINPOOLP320T1BRAINPOOLP320T1
SB_EC_BRAINPOOLP384R1BRAINPOOLP384R1
SB_EC_BRAINPOOLP384T1BRAINPOOLP384T1
SB_EC_BRAINPOOLP512R1BRAINPOOLP512R1
SB_EC_BRAINPOOLP512T1BRAINPOOLP512T1
SB_EC_CURVE25519CURVE25519
SB_EC_CURVE448CURVE448

Fingerprint
Byte()

Contains the fingerprint (a hash imprint) of this certificate.

FriendlyName
String

Contains an associated alias (friendly name) of the certificate.

HashAlgorithm
String

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)

SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_MD2MD2
SB_HASH_ALGORITHM_MD4MD4
SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_CRC32CRC32
SB_HASH_ALGORITHM_SSL3SSL3
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_POLY1305POLY1305
SB_HASH_ALGORITHM_SHA3_224SHA3_224
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512
SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

Issuer
String

The common name of the certificate issuer (CA), typically a company name.

IssuerRDN
String

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

KeyAlgorithm
String

Specifies the public key algorithm of this certificate.

SB_CERT_ALGORITHM_ID_RSA_ENCRYPTIONrsaEncryption
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTIONmd2withRSAEncryption
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTIONmd5withRSAEncryption
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTIONsha1withRSAEncryption
SB_CERT_ALGORITHM_ID_DSAid-dsa
SB_CERT_ALGORITHM_ID_DSA_SHA1id-dsa-with-sha1
SB_CERT_ALGORITHM_DH_PUBLICdhpublicnumber
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTIONsha224WithRSAEncryption
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTIONsha256WithRSAEncryption
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTIONsha384WithRSAEncryption
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTIONsha512WithRSAEncryption
SB_CERT_ALGORITHM_ID_RSAPSSid-RSASSA-PSS
SB_CERT_ALGORITHM_ID_RSAOAEPid-RSAES-OAEP
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160ripemd160withRSA
SB_CERT_ALGORITHM_ID_ELGAMALelGamal
SB_CERT_ALGORITHM_SHA1_ECDSAecdsa-with-SHA1
SB_CERT_ALGORITHM_RECOMMENDED_ECDSAecdsa-recommended
SB_CERT_ALGORITHM_SHA224_ECDSAecdsa-with-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSAecdsa-with-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSAecdsa-with-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSAecdsa-with-SHA512
SB_CERT_ALGORITHM_ECid-ecPublicKey
SB_CERT_ALGORITHM_SPECIFIED_ECDSAecdsa-specified
SB_CERT_ALGORITHM_GOST_R3410_1994id-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3410_2001id-GostR3410-2001
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994id-GostR3411-94-with-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001id-GostR3411-94-with-GostR3410-2001
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAINecdsa-plain-SHA1
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAINecdsa-plain-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAINecdsa-plain-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAINecdsa-plain-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAINecdsa-plain-SHA512
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAINecdsa-plain-RIPEMD160
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTIONwhirlpoolWithRSAEncryption
SB_CERT_ALGORITHM_ID_DSA_SHA224id-dsa-with-sha224
SB_CERT_ALGORITHM_ID_DSA_SHA256id-dsa-with-sha256
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSAid-ecdsa-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSAid-ecdsa-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSAid-ecdsa-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSAid-ecdsa-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAINid-ecdsa-plain-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAINid-ecdsa-plain-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAINid-ecdsa-plain-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAINid-ecdsa-plain-with-sha3-512
SB_CERT_ALGORITHM_ID_DSA_SHA3_224id-dsa-with-sha3-224
SB_CERT_ALGORITHM_ID_DSA_SHA3_256id-dsa-with-sha3-256
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSAid-ecdsa-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSAid-ecdsa-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSAid-ecdsa-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSAid-ecdsa-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSAid-ecdsa-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSAid-ecdsa-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSAid-ecdsa-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSAid-ecdsa-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAINid-ecdsa-plain-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAINid-ecdsa-plain-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAINid-ecdsa-plain-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAINid-ecdsa-plain-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAINid-ecdsa-plain-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAINid-ecdsa-plain-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAINid-ecdsa-plain-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAINid-ecdsa-plain-with-blake2b512
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224id-dsa-with-blake2s224
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256id-dsa-with-blake2s256
SB_CERT_ALGORITHM_EDDSA_ED25519id-Ed25519
SB_CERT_ALGORITHM_EDDSA_ED448id-Ed448
SB_CERT_ALGORITHM_EDDSA_ED25519_PHid-Ed25519ph
SB_CERT_ALGORITHM_EDDSA_ED448_PHid-Ed448ph
SB_CERT_ALGORITHM_EDDSAid-EdDSA
SB_CERT_ALGORITHM_EDDSA_SIGNATUREid-EdDSA-sig

KeyBits
Integer

Returns the length of the public key.

KeyFingerprint
Byte()

Returns a fingerprint of the public key contained in the certificate.

KeyUsage
Integer

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

This value is a bit mask of the following values:

ckuUnknown0x00000Unknown key usage

ckuDigitalSignature0x00001Digital signature

ckuNonRepudiation0x00002Non-repudiation

ckuKeyEncipherment0x00004Key encipherment

ckuDataEncipherment0x00008Data encipherment

ckuKeyAgreement0x00010Key agreement

ckuKeyCertSign0x00020Certificate signing

ckuCRLSign0x00040Revocation signing

ckuEncipherOnly0x00080Encipher only

ckuDecipherOnly0x00100Decipher only

ckuServerAuthentication0x00200Server authentication

ckuClientAuthentication0x00400Client authentication

ckuCodeSigning0x00800Code signing

ckuEmailProtection0x01000Email protection

ckuTimeStamping0x02000Timestamping

ckuOCSPSigning0x04000OCSP signing

ckuSmartCardLogon0x08000Smartcard logon

ckuKeyPurposeClientAuth0x10000Kerberos - client authentication

ckuKeyPurposeKDC0x20000Kerberos - KDC

KeyValid
Boolean

Returns True if the certificate's key is cryptographically valid, and False otherwise.

OCSPLocations
String

Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.

OCSPNoCheck
Boolean

TBD.

Origin
Integer

Returns the origin of this certificate.

PolicyIDs
String

Contains identifiers (OIDs) of the applicable certificate policies.

The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.

PrivateKeyBytes
Byte()

Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable.

PrivateKeyExists
Boolean

Indicates whether the certificate has an associated private key.

PrivateKeyExtractable
Boolean

Indicates whether the private key is extractable

PublicKeyBytes
Byte()

Contains the certificate's public key in DER format.

QualifiedStatements
QualifiedStatementsTypes

TBD

SelfSigned
Boolean

Indicates whether the certificate is self-signed (root) or signed by an external CA.

SerialNumber
Byte()

Returns the certificate's serial number.

SigAlgorithm
String

Indicates the algorithm that was used by the CA to sign this certificate.

Subject
String

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

SubjectAlternativeName
String

TBD.

SubjectKeyID
Byte()

Contains a unique identifier (fingerprint) of the certificate's private key.

Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key.

SubjectRDN
String

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

ValidFrom
String

The time point at which the certificate becomes valid, in UTC.

ValidTo
String

The time point at which the certificate expires, in UTC.

Constructors

public Certificate(byte[] bytes, int startIndex, int count, string password);
Public Certificate(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer, ByVal Password As String)

Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.

public Certificate(byte[] certBytes, int certStartIndex, int certCount, byte[] keyBytes, int keyStartIndex, int keyCount, string password);
Public Certificate(ByVal CertBytes As Byte(), ByVal CertStartIndex As Integer, ByVal CertCount As Integer, ByVal KeyBytes As Byte(), ByVal KeyStartIndex As Integer, ByVal KeyCount As Integer, ByVal Password As String)

Loads the X.509 certificate from a memory buffer. CertBytes is a buffer containing the raw certificate data. CertStartIndex and CertCount specify the number of bytes to be read from the buffer, respectively. KeyBytes is a buffer containing the private key data. KeyStartIndex and KeyCount specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.

public Certificate(byte[] bytes, int startIndex, int count);
Public Certificate(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer)

Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively.

public Certificate(string path, string password);
Public Certificate(ByVal Path As String, ByVal Password As String)

Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data. Password is a password encrypting the certificate.

public Certificate(string certPath, string keyPath, string password);
Public Certificate(ByVal CertPath As String, ByVal KeyPath As String, ByVal Password As String)

Loads the X.509 certificate from a file. CertPath specifies the full path to the file containing the certificate data. KeyPath specifies the full path to the file containing the private key. Password is a password encrypting the certificate.

public Certificate(string path);
Public Certificate(ByVal Path As String)

Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data.

public Certificate(System.IO.Stream stream);
Public Certificate(ByVal Stream As System.IO.Stream)

Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data.

public Certificate(System.IO.Stream stream, string password);
Public Certificate(ByVal Stream As System.IO.Stream, ByVal Password As String)

Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data. Password is a password encrypting the certificate.

public Certificate(System.IO.Stream certStream, System.IO.Stream keyStream, string password);
Public Certificate(ByVal CertStream As System.IO.Stream, ByVal KeyStream As System.IO.Stream, ByVal Password As String)

Loads the X.509 certificate from a stream. CertStream is a stream containing the certificate data. KeyStream is a stream containing the private key. Password is a password encrypting the certificate.

public Certificate();
Public Certificate()

Creates a new object with default field values.

CRL Type

Represents a Certificate Revocation List.

Remarks

CRLs store information about revoked certificates, i.e., certificates that have been identified as invalid by their issuing certificate authority (CA) for any number of reasons.

Each CRL object lists certificates from a single CA and identifies them by their serial numbers. A CA may or may not publish a CRL, may publish several CRLs, or may publish the same CRL in multiple locations.

Unlike OCSP responses, CRLs only list certificates that have been revoked. They do not list certificates that are still valid.

Fields

Bytes
Byte()

Returns raw CRL data in DER format.

CAKeyID
Byte()

A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL.

EntryCount
Integer

Returns the number of certificate status entries in the CRL.

Issuer
String

The common name of the CRL issuer (CA), typically a company name.

IssuerRDN
String

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer.

Location
String

The URL that the CRL was downloaded from.

NextUpdate
String

The planned time and date of the next version of this CRL to be published.

SigAlgorithm
String

The public key algorithm that was used by the CA to sign this CRL.

TBS
Byte()

The to-be-signed part of the CRL (the CRL without the signature part).

ThisUpdate
String

The date and time at which this version of the CRL was published.

Constructors

public CRL(byte[] bytes, int startIndex, int count);
Public CRL(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer)

Creates a CRL object from a memory buffer. Bytes is a buffer containing raw (DER) CRL data, StartIndex and Count specify the starting position and the length of the CRL data in the buffer, respectively.

public CRL(string location);
Public CRL(ByVal Location As String)

Creates a CRL object by downloading it from a remote location.

public CRL(System.IO.Stream stream);
Public CRL(ByVal Stream As System.IO.Stream)

Creates a CRL object from data contained in a stream.

public CRL();
Public CRL()

Creates an empty CRL object.

OCSPResponse Type

Represents a single OCSP response originating from an OCSP responder.

Remarks

OCSP is a protocol that allows verification of certificate status in real-time, and is an alternative to Certificate Revocation Lists (CRL).

An OCSP response is a snapshot of the certificate status at a given time.

Fields

Bytes
Byte()

Buffer containing raw OCSP response data.

EntryCount
Integer

The number of SingleResponse elements contained in this OCSP response. Each SingleResponse element corresponds to a certificate status.

Issuer
String

Indicates the issuer of this response (a CA or its authorized representative).

IssuerRDN
String

Indicates the RDN of the issuer of this response (a CA or its authorized representative).

Location
String

Location of the OCSP responder.

ProducedAt
String

Specifies the time when the response was produced, in UTC.

Constructors

public OCSPResponse(byte[] bytes, int startIndex, int count);
Public OCSPResponse(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer)

Initializes the response from a memory buffer. Bytes is a buffer containing raw OCSP response data, StartIndex and Count specify the starting position and the number of bytes to be read from this buffer.

public OCSPResponse(string location);
Public OCSPResponse(ByVal Location As String)

Downloads an OCSP response from a remote location.

public OCSPResponse(System.IO.Stream stream);
Public OCSPResponse(ByVal Stream As System.IO.Stream)

Initializes the response with the data from a stream.

public OCSPResponse();
Public OCSPResponse()

Creates an empty OCSP response object.

OfficeSignature Type

The component is a container for an Office document signature.

Remarks

Office document may include any number of document signatures. component stores on of them.

Fields

ChainValidationDetails
Integer

The details of a certificate chain validation outcome. They may often suggest what reasons that contributed to the overall validation result.

Returns a bit mask of the following options:

cvrBadData0x0001One or more certificates in the validation path are malformed

cvrRevoked0x0002One or more certificates are revoked

cvrNotYetValid0x0004One or more certificates are not yet valid

cvrExpired0x0008One or more certificates are expired

cvrInvalidSignature0x0010A certificate contains a non-valid digital signature

cvrUnknownCA0x0020A CA certificate for one or more certificates has not been found (chain incomplete)

cvrCAUnauthorized0x0040One of the CA certificates are not authorized to act as CA

cvrCRLNotVerified0x0080One or more CRLs could not be verified

cvrOCSPNotVerified0x0100One or more OCSP responses could not be verified

cvrIdentityMismatch0x0200The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate

cvrNoKeyUsage0x0400A mandatory key usage is not enabled in one of the chain certificates

cvrBlocked0x0800One or more certificates are blocked

cvrFailure0x1000General validation failure

cvrChainLoop0x2000Chain loop: one of the CA certificates recursively signs itself

cvrWeakAlgorithm0x4000A weak algorithm is used in one of certificates or revocation elements

cvrUserEnforced0x8000The chain was considered invalid following intervention from a user code

ChainValidationResult
ChainValidities

The outcome of a certificate chain validation routine.

Available options:

cvtValid0The chain is valid

cvtValidButUntrusted1The chain is valid, but the root certificate is not trusted

cvtInvalid2The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature)

cvtCantBeEstablished3The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses)

Use the ValidationLog property to access the detailed validation log.

CorePropertiesSigned
Boolean

Returns True if this signature covers the core properties of the document.

DocumentSigned
Boolean

Returns True if the signature covers the document itself.

ExpireTime
String

Specifies the signature expiration time in UTC.

HashAlgorithm
String

The hash algorithm used for signing.

SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512

Qualified
QualifiedStatuses

Indicates a qualified electronic signature.

Use this property to check if an electronic signature is created using a qualified device for creating electronic signatures and that relies on a qualified electronic signature certificate.

Adjust UseDefaultTSLs property and/or CustomTSLs property before validating the signature/certificate to properly obtain TSP (Trust Service Provider) service status. Use Qualified* and TSL* config properties to obtain extended information.

The following qualified statuses are supported:

sqsUnknown0Qualified status unknown. Use config's QualifiedInfo setting to obtain service status URI.

sqsNone1None

sqsGranted2Granted

sqsWithdrawn3Withdrawn

sqsSetByNationalLaw4Set by national law

sqsDeprecatedByNationalLaw5Deprecated by national law

sqsRecognizedAtNationalLevel6Recognized at national level

sqsDeprecatedAtNationalLevel7Deprecated at national level

sqsUnderSupervision8Under supervision

sqsSupervisionInCessation9Supervision in cessation

sqsSupervisionCeased10Supervision ceased

sqsSupervisionRevoked11Supervision revoked

sqsAccredited12Accredited

sqsAccreditationCeased13Accreditation ceased

sqsAccreditationRevoked14Accreditation revoked

sqsInAccordance15Deprecated. The subject service is in accordance with the scheme's specific status determination criteria (only for use in positive approval schemes).

sqsExpired16Deprecated. The subject service is no longer overseen by the scheme, e.g. due to nonrenewal or withdrawal by the TSP, or cessation of the service or the scheme's operations.

sqsSuspended17Deprecated. The subject service's status is temporarily uncertain whilst checks are made by the scheme operator (typically e.g. while a revocation request is being investigated or if action is required to resolve a deficiency in the service fulfilling the scheme's criteria.

sqsRevoked18Deprecated. The subject service's approved status has been revoked because it is no longer in accordance with the scheme's specific status determination criteria (only for use in positive approval schemes).

sqsNotInAccordance19Deprecated. The subject service is not in accordance with the scheme's specific status determination criteria (only for use in negative approval schemes).

SignatureInfoComments
String

Contains the comments for the SignatureInfoText.

SignatureInfoIncluded
Boolean

Specifies whether the signature info is included.

SignatureInfoText
String

Contains the text of the signature info.

SignatureOriginSigned
Boolean

Returns True if the signature origin is signed.

SignatureTime
String

Specifies the certified signing time.

SignatureType
OfficeSignatureTypes

Specifies the type of this signature.

ostDefault0
ostBinaryCryptoAPI1
ostBinaryXML2
ostOpenXML3
ostOpenXPS4
ostOpenDocument5

SignatureValidationResult
SignatureValidities

The outcome of the cryptographic signature validation.

The following signature validity values are supported:

svtValid0The signature is valid

svtUnknown1Signature validity is unknown

svtCorrupted2The signature is corrupted

svtSignerNotFound3Failed to acquire the signing certificate. The signature cannot be validated.

svtFailure4General failure

SignTime
String

Specifies the time when the signature was generated.

SubjectRDN
String

Contains information about the person owning the signing certificate. Only certificates with given subject information will be enumerated during the search operation. Information is stored in the form of [Object Identifier, Value] pairs.

ValidationLog
String

Contains the signature validation log. This information is extremely useful if the signature validation fails.

Constructors

public OfficeSignature();
Public OfficeSignature()

Creates a new Office signature object.

OfficeSignedPart Type

The component is responsible for storing a signed part of an Office document.

Remarks

An Office document may contain any number of signed parts; component contains a single one of them.

Fields

ContentType
String

Specifies the content type of this signed part.

DigestValue
Byte()

Contains the digest value computed over this signed part.

HashAlgorithm
String

The hash algorithm used for signing.

SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512

The hash algorithm used for signing.

SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512

IsRelationshipPart
Boolean

Specifies whether this signed part is a relationship part.

Path
String

The path to this signed part in the document package.

SignatureValidationResult
SignatureValidities

The outcome of the cryptographic signature validation.

The following signature validity values are supported:

svtValid0The signature is valid

svtUnknown1Signature validity is unknown

svtCorrupted2The signature is corrupted

svtSignerNotFound3Failed to acquire the signing certificate. The signature cannot be validated.

svtFailure4General failure

Constructors

public OfficeSignedPart();
Public OfficeSignedPart()

Creates a new Office signed part object.

ProxySettings Type

A container for proxy server settings.

Remarks

This type exposes a collection of properties for tuning up the proxy server configuration.

Fields

Address
String

The IP address of the proxy server.

Authentication
ProxyAuthTypes

The authentication type used by the proxy server.

patNoAuthentication0
patBasic1
patDigest2
patNTLM3

Password
String

The password to authenticate to the proxy server.

Port
Integer

The port on the proxy server to connect to.

ProxyType
ProxyTypes

The type of the proxy server.

The WebTunnel proxy is also known as HTTPS proxy. Unlike HTTP proxy, HTTPS proxy (WebTunnel) provides end-to-end security.

cptNone0
cptSocks41
cptSocks52
cptWebTunnel3
cptHTTP4

RequestHeaders
String

Contains HTTP request headers for WebTunnel and HTTP proxy.

ResponseBody
String

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

ResponseHeaders
String

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

UseIPv6
Boolean

Specifies whether IPv6 should be used when connecting through the proxy.

UseProxy
Boolean

Enables or disables proxy-driven connection.

Username
String

Specifies the username credential for proxy authentication.

Constructors

public ProxySettings();
Public ProxySettings()

Creates a new ProxySettings object.

SocketSettings Type

A container for the socket settings.

Remarks

This type is a container for socket-layer parameters.

Fields

DNSMode
DNSResolveModes

Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.

dmAuto0
dmPlatform1
dmOwn2
dmOwnSecure3

DNSPort
Integer

Specifies the port number to be used for sending queries to the DNS server.

DNSQueryTimeout
Integer

The timeout (in milliseconds) for each DNS query. The value of 0 indicates the infinite timeout.

DNSServers
String

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

DNSTotalTimeout
Integer

The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates the infinite timeout.

IncomingSpeedLimit
Integer

The maximum number of bytes to read from the socket, per second.

LocalAddress
String

The local network interface to bind the socket to.

LocalPort
Integer

The local port number to bind the socket to.

OutgoingSpeedLimit
Integer

The maximum number of bytes to write to the socket, per second.

Timeout
Integer

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).

UseIPv6
Boolean

Enables or disables IP protocol version 6.

Constructors

public SocketSettings();
Public SocketSettings()

Creates a new SocketSettings object.

TimestampInfo Type

A container for timestamp information.

Remarks

The TimestampInfo object contains details of a third-party timestamp and the outcome of its validation.

Fields

Accuracy
Long

This field indicates the accuracy of the included time mark, in microseconds.

Bytes
Byte()

Returns raw timestamp data in DER format.

ChainValidationDetails
Integer

The details of a certificate chain validation outcome. They may often suggest what reasons that contributed to the overall validation result.

Returns a bit mask of the following options:

cvrBadData0x0001One or more certificates in the validation path are malformed

cvrRevoked0x0002One or more certificates are revoked

cvrNotYetValid0x0004One or more certificates are not yet valid

cvrExpired0x0008One or more certificates are expired

cvrInvalidSignature0x0010A certificate contains a non-valid digital signature

cvrUnknownCA0x0020A CA certificate for one or more certificates has not been found (chain incomplete)

cvrCAUnauthorized0x0040One of the CA certificates are not authorized to act as CA

cvrCRLNotVerified0x0080One or more CRLs could not be verified

cvrOCSPNotVerified0x0100One or more OCSP responses could not be verified

cvrIdentityMismatch0x0200The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate

cvrNoKeyUsage0x0400A mandatory key usage is not enabled in one of the chain certificates

cvrBlocked0x0800One or more certificates are blocked

cvrFailure0x1000General validation failure

cvrChainLoop0x2000Chain loop: one of the CA certificates recursively signs itself

cvrWeakAlgorithm0x4000A weak algorithm is used in one of certificates or revocation elements

cvrUserEnforced0x8000The chain was considered invalid following intervention from a user code

ChainValidationResult
ChainValidities

The outcome of a certificate chain validation routine.

Available options:

cvtValid0The chain is valid

cvtValidButUntrusted1The chain is valid, but the root certificate is not trusted

cvtInvalid2The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature)

cvtCantBeEstablished3The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses)

Use the ValidationLog property to access the detailed validation log.

HashAlgorithm
String

Returns the timestamp's hash algorithm

SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_MD2MD2
SB_HASH_ALGORITHM_MD4MD4
SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_CRC32CRC32
SB_HASH_ALGORITHM_SSL3SSL3
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_POLY1305POLY1305
SB_HASH_ALGORITHM_SHA3_224SHA3_224
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512
SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

SerialNumber
Byte()

Returns the timestamp's serial number.

Time
String

The time point incorporated into the timestamp.

TimestampType
TimestampTypes

Returns the timestamp type.

Available options:

tstUnknown0
tstLegacy1Supported by: AuthenticodeVerifier

tstTrusted2Supported by: AuthenticodeVerifier

tstGeneric3Supported by: CAdESVerifier

tstESC4Supported by: CAdESVerifier

tstContent5Supported by: CAdESVerifier

tstCertsAndCRLs6Supported by: CAdESVerifier

tstArchive7Archive timestamp. Supported by: CAdESVerifier, OfficeVerifier, SOAPVerifier, XAdESVerifier

tstArchive28Archive v2 timestamp. Supported by: CAdESVerifier

tstArchive39Archive v3 timestamp. Supported by: CAdESVerifier

tstIndividualDataObjects10Supported by: OfficeVerifier, SOAPVerifier, XAdESVerifier

tstAllDataObjects11Supported by: OfficeVerifier, SOAPVerifier, XAdESVerifier

tstSignature12Signature timestamp. Supported by: OfficeVerifier, SOAPVerifier, XAdESVerifier

tstRefsOnly13RefsOnly timestamp. Supported by: OfficeVerifier, SOAPVerifier, XAdESVerifier

tstSigAndRefs14SigAndRefs timestamp. Supported by: OfficeVerifier, SOAPVerifier, XAdESVerifier

TSAName
String

This value uniquely identifies the Timestamp Authority (TSA).

This property provides information about the entity that manages the TSA.

ValidationLog
String

Contains the TSA certificate chain validation log. This information is extremely useful if the timestamp validation fails.

ValidationResult
SignatureValidities

Contains timestamp validation outcome.

Use this property to check the result of the most recent timestamp validation.

svtValid0The signature is valid

svtUnknown1Signature validity is unknown

svtCorrupted2The signature is corrupted

svtSignerNotFound3Failed to acquire the signing certificate. The signature cannot be validated.

svtFailure4General failure

Constructors

public TimestampInfo();
Public TimestampInfo()

Creates a new TimestampInfo object with default field values.

TLSSettings Type

A container for TLS connection settings.

Remarks

TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP.

Fields

AutoValidateCertificates
Boolean

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

BaseConfiguration
SecureTransportPredefinedConfigurations

Selects the base configuration for the TLS settings. Several profiles are on offer, tuned up for different purposes, such as high security or higher compatibility.

stpcDefault0
stpcCompatible1
stpcComprehensiveInsecure2
stpcHighlySecure3

Ciphersuites
String

A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases that allow to blanketly enable or disable all ciphersuites at once.

Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by BaseConfiguration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:

  • NULL_NULL_NULL
  • RSA_NULL_MD5
  • RSA_NULL_SHA
  • RSA_RC4_MD5
  • RSA_RC4_SHA
  • RSA_RC2_MD5
  • RSA_IDEA_MD5
  • RSA_IDEA_SHA
  • RSA_DES_MD5
  • RSA_DES_SHA
  • RSA_3DES_MD5
  • RSA_3DES_SHA
  • RSA_AES128_SHA
  • RSA_AES256_SHA
  • DH_DSS_DES_SHA
  • DH_DSS_3DES_SHA
  • DH_DSS_AES128_SHA
  • DH_DSS_AES256_SHA
  • DH_RSA_DES_SHA
  • DH_RSA_3DES_SHA
  • DH_RSA_AES128_SHA
  • DH_RSA_AES256_SHA
  • DHE_DSS_DES_SHA
  • DHE_DSS_3DES_SHA
  • DHE_DSS_AES128_SHA
  • DHE_DSS_AES256_SHA
  • DHE_RSA_DES_SHA
  • DHE_RSA_3DES_SHA
  • DHE_RSA_AES128_SHA
  • DHE_RSA_AES256_SHA
  • DH_ANON_RC4_MD5
  • DH_ANON_DES_SHA
  • DH_ANON_3DES_SHA
  • DH_ANON_AES128_SHA
  • DH_ANON_AES256_SHA
  • RSA_RC2_MD5_EXPORT
  • RSA_RC4_MD5_EXPORT
  • RSA_DES_SHA_EXPORT
  • DH_DSS_DES_SHA_EXPORT
  • DH_RSA_DES_SHA_EXPORT
  • DHE_DSS_DES_SHA_EXPORT
  • DHE_RSA_DES_SHA_EXPORT
  • DH_ANON_RC4_MD5_EXPORT
  • DH_ANON_DES_SHA_EXPORT
  • RSA_CAMELLIA128_SHA
  • DH_DSS_CAMELLIA128_SHA
  • DH_RSA_CAMELLIA128_SHA
  • DHE_DSS_CAMELLIA128_SHA
  • DHE_RSA_CAMELLIA128_SHA
  • DH_ANON_CAMELLIA128_SHA
  • RSA_CAMELLIA256_SHA
  • DH_DSS_CAMELLIA256_SHA
  • DH_RSA_CAMELLIA256_SHA
  • DHE_DSS_CAMELLIA256_SHA
  • DHE_RSA_CAMELLIA256_SHA
  • DH_ANON_CAMELLIA256_SHA
  • PSK_RC4_SHA
  • PSK_3DES_SHA
  • PSK_AES128_SHA
  • PSK_AES256_SHA
  • DHE_PSK_RC4_SHA
  • DHE_PSK_3DES_SHA
  • DHE_PSK_AES128_SHA
  • DHE_PSK_AES256_SHA
  • RSA_PSK_RC4_SHA
  • RSA_PSK_3DES_SHA
  • RSA_PSK_AES128_SHA
  • RSA_PSK_AES256_SHA
  • RSA_SEED_SHA
  • DH_DSS_SEED_SHA
  • DH_RSA_SEED_SHA
  • DHE_DSS_SEED_SHA
  • DHE_RSA_SEED_SHA
  • DH_ANON_SEED_SHA
  • SRP_SHA_3DES_SHA
  • SRP_SHA_RSA_3DES_SHA
  • SRP_SHA_DSS_3DES_SHA
  • SRP_SHA_AES128_SHA
  • SRP_SHA_RSA_AES128_SHA
  • SRP_SHA_DSS_AES128_SHA
  • SRP_SHA_AES256_SHA
  • SRP_SHA_RSA_AES256_SHA
  • SRP_SHA_DSS_AES256_SHA
  • ECDH_ECDSA_NULL_SHA
  • ECDH_ECDSA_RC4_SHA
  • ECDH_ECDSA_3DES_SHA
  • ECDH_ECDSA_AES128_SHA
  • ECDH_ECDSA_AES256_SHA
  • ECDHE_ECDSA_NULL_SHA
  • ECDHE_ECDSA_RC4_SHA
  • ECDHE_ECDSA_3DES_SHA
  • ECDHE_ECDSA_AES128_SHA
  • ECDHE_ECDSA_AES256_SHA
  • ECDH_RSA_NULL_SHA
  • ECDH_RSA_RC4_SHA
  • ECDH_RSA_3DES_SHA
  • ECDH_RSA_AES128_SHA
  • ECDH_RSA_AES256_SHA
  • ECDHE_RSA_NULL_SHA
  • ECDHE_RSA_RC4_SHA
  • ECDHE_RSA_3DES_SHA
  • ECDHE_RSA_AES128_SHA
  • ECDHE_RSA_AES256_SHA
  • ECDH_ANON_NULL_SHA
  • ECDH_ANON_RC4_SHA
  • ECDH_ANON_3DES_SHA
  • ECDH_ANON_AES128_SHA
  • ECDH_ANON_AES256_SHA
  • RSA_NULL_SHA256
  • RSA_AES128_SHA256
  • RSA_AES256_SHA256
  • DH_DSS_AES128_SHA256
  • DH_RSA_AES128_SHA256
  • DHE_DSS_AES128_SHA256
  • DHE_RSA_AES128_SHA256
  • DH_DSS_AES256_SHA256
  • DH_RSA_AES256_SHA256
  • DHE_DSS_AES256_SHA256
  • DHE_RSA_AES256_SHA256
  • DH_ANON_AES128_SHA256
  • DH_ANON_AES256_SHA256
  • RSA_AES128_GCM_SHA256
  • RSA_AES256_GCM_SHA384
  • DHE_RSA_AES128_GCM_SHA256
  • DHE_RSA_AES256_GCM_SHA384
  • DH_RSA_AES128_GCM_SHA256
  • DH_RSA_AES256_GCM_SHA384
  • DHE_DSS_AES128_GCM_SHA256
  • DHE_DSS_AES256_GCM_SHA384
  • DH_DSS_AES128_GCM_SHA256
  • DH_DSS_AES256_GCM_SHA384
  • DH_ANON_AES128_GCM_SHA256
  • DH_ANON_AES256_GCM_SHA384
  • ECDHE_ECDSA_AES128_SHA256
  • ECDHE_ECDSA_AES256_SHA384
  • ECDH_ECDSA_AES128_SHA256
  • ECDH_ECDSA_AES256_SHA384
  • ECDHE_RSA_AES128_SHA256
  • ECDHE_RSA_AES256_SHA384
  • ECDH_RSA_AES128_SHA256
  • ECDH_RSA_AES256_SHA384
  • ECDHE_ECDSA_AES128_GCM_SHA256
  • ECDHE_ECDSA_AES256_GCM_SHA384
  • ECDH_ECDSA_AES128_GCM_SHA256
  • ECDH_ECDSA_AES256_GCM_SHA384
  • ECDHE_RSA_AES128_GCM_SHA256
  • ECDHE_RSA_AES256_GCM_SHA384
  • ECDH_RSA_AES128_GCM_SHA256
  • ECDH_RSA_AES256_GCM_SHA384
  • PSK_AES128_GCM_SHA256
  • PSK_AES256_GCM_SHA384
  • DHE_PSK_AES128_GCM_SHA256
  • DHE_PSK_AES256_GCM_SHA384
  • RSA_PSK_AES128_GCM_SHA256
  • RSA_PSK_AES256_GCM_SHA384
  • PSK_AES128_SHA256
  • PSK_AES256_SHA384
  • PSK_NULL_SHA256
  • PSK_NULL_SHA384
  • DHE_PSK_AES128_SHA256
  • DHE_PSK_AES256_SHA384
  • DHE_PSK_NULL_SHA256
  • DHE_PSK_NULL_SHA384
  • RSA_PSK_AES128_SHA256
  • RSA_PSK_AES256_SHA384
  • RSA_PSK_NULL_SHA256
  • RSA_PSK_NULL_SHA384
  • RSA_CAMELLIA128_SHA256
  • DH_DSS_CAMELLIA128_SHA256
  • DH_RSA_CAMELLIA128_SHA256
  • DHE_DSS_CAMELLIA128_SHA256
  • DHE_RSA_CAMELLIA128_SHA256
  • DH_ANON_CAMELLIA128_SHA256
  • RSA_CAMELLIA256_SHA256
  • DH_DSS_CAMELLIA256_SHA256
  • DH_RSA_CAMELLIA256_SHA256
  • DHE_DSS_CAMELLIA256_SHA256
  • DHE_RSA_CAMELLIA256_SHA256
  • DH_ANON_CAMELLIA256_SHA256
  • ECDHE_ECDSA_CAMELLIA128_SHA256
  • ECDHE_ECDSA_CAMELLIA256_SHA384
  • ECDH_ECDSA_CAMELLIA128_SHA256
  • ECDH_ECDSA_CAMELLIA256_SHA384
  • ECDHE_RSA_CAMELLIA128_SHA256
  • ECDHE_RSA_CAMELLIA256_SHA384
  • ECDH_RSA_CAMELLIA128_SHA256
  • ECDH_RSA_CAMELLIA256_SHA384
  • RSA_CAMELLIA128_GCM_SHA256
  • RSA_CAMELLIA256_GCM_SHA384
  • DHE_RSA_CAMELLIA128_GCM_SHA256
  • DHE_RSA_CAMELLIA256_GCM_SHA384
  • DH_RSA_CAMELLIA128_GCM_SHA256
  • DH_RSA_CAMELLIA256_GCM_SHA384
  • DHE_DSS_CAMELLIA128_GCM_SHA256
  • DHE_DSS_CAMELLIA256_GCM_SHA384
  • DH_DSS_CAMELLIA128_GCM_SHA256
  • DH_DSS_CAMELLIA256_GCM_SHA384
  • DH_anon_CAMELLIA128_GCM_SHA256
  • DH_anon_CAMELLIA256_GCM_SHA384
  • ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
  • ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
  • ECDH_ECDSA_CAMELLIA128_GCM_SHA256
  • ECDH_ECDSA_CAMELLIA256_GCM_SHA384
  • ECDHE_RSA_CAMELLIA128_GCM_SHA256
  • ECDHE_RSA_CAMELLIA256_GCM_SHA384
  • ECDH_RSA_CAMELLIA128_GCM_SHA256
  • ECDH_RSA_CAMELLIA256_GCM_SHA384
  • PSK_CAMELLIA128_GCM_SHA256
  • PSK_CAMELLIA256_GCM_SHA384
  • DHE_PSK_CAMELLIA128_GCM_SHA256
  • DHE_PSK_CAMELLIA256_GCM_SHA384
  • RSA_PSK_CAMELLIA128_GCM_SHA256
  • RSA_PSK_CAMELLIA256_GCM_SHA384
  • PSK_CAMELLIA128_SHA256
  • PSK_CAMELLIA256_SHA384
  • DHE_PSK_CAMELLIA128_SHA256
  • DHE_PSK_CAMELLIA256_SHA384
  • RSA_PSK_CAMELLIA128_SHA256
  • RSA_PSK_CAMELLIA256_SHA384
  • ECDHE_PSK_CAMELLIA128_SHA256
  • ECDHE_PSK_CAMELLIA256_SHA384
  • ECDHE_PSK_RC4_SHA
  • ECDHE_PSK_3DES_SHA
  • ECDHE_PSK_AES128_SHA
  • ECDHE_PSK_AES256_SHA
  • ECDHE_PSK_AES128_SHA256
  • ECDHE_PSK_AES256_SHA384
  • ECDHE_PSK_NULL_SHA
  • ECDHE_PSK_NULL_SHA256
  • ECDHE_PSK_NULL_SHA384
  • ECDHE_RSA_CHACHA20_POLY1305_SHA256
  • ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
  • DHE_RSA_CHACHA20_POLY1305_SHA256
  • PSK_CHACHA20_POLY1305_SHA256
  • ECDHE_PSK_CHACHA20_POLY1305_SHA256
  • DHE_PSK_CHACHA20_POLY1305_SHA256
  • RSA_PSK_CHACHA20_POLY1305_SHA256
  • AES128_GCM_SHA256
  • AES256_GCM_SHA384
  • CHACHA20_POLY1305_SHA256
  • AES128_CCM_SHA256
  • AES128_CCM8_SHA256

ECCurves
String

Defines the elliptic curves to enable.

Extensions
String

Provides access to TLS extensions.

ForceResumeIfDestinationChanges
Boolean

Whether to force TLS session resumption when the destination address changes.

PreSharedIdentity
String

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

PreSharedKey
String

Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

PreSharedKeyCiphersuite
String

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

RenegotiationAttackPreventionMode
RenegotiationAttackPreventionModes

Selects renegotiation attack prevention mechanism.

The following options are available:

crapmCompatible0TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled).
crapmStrict1Renegotiation attack prevention is enabled and enforced.
crapmAuto2Automatically choose whether to enable or disable renegotiation attack prevention.

RevocationCheck
RevocationCheckKinds

Specifies the kind(s) of revocation check to perform.

Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.

crcNone (0)No revocation checking
crcAuto (1)Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future.
crcAllCRL (2)Check all provided CRL endpoints for all chain certificates.
crcAllOCSP (3)Check all provided OCSP endpoints for all chain certificates.
crcAllCRLAndOCSP (4)Check all CRL and OCSP endpoints for all chain certificates.
crcAnyCRL (5)At least one CRL check for every certificate in the chain must succeed.
crcAnyOCSP (6)At least one OCSP check for every certificate in the chain must succeed.
crcAnyCRLOrOCSP (7)At least one CRL or OCSP check for every certificate in the chain must succeed. CRL endpoints are checked first.
crcAnyOCSPOrCRL (8)At least one CRL or OCSP check for every certificate in the chain must succeed. OCSP endpoints are checked first.

This setting controls the way the revocation checks are performed. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.

There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).

This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to faster OCSP route and only demand one source to succeed) is a good choice for most of typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

SSLOptions
Integer

Various SSL (TLS) protocol options, set of

cssloExpectShutdownMessage0x001Wait for the close-notify message when shutting down the connection

cssloOpenSSLDTLSWorkaround0x002(DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions

cssloDisableKexLengthAlignment0x004Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it.

cssloForceUseOfClientCertHashAlg0x008Enforce use of client certificate hash algorithm. It is unlikely that you will ever need to adjust it.

cssloAutoAddServerNameExtension0x010Automatically add server name extension when known

cssloAcceptTrustedSRPPrimesOnly0x020Accept trusted SRP primes only

cssloDisableSignatureAlgorithmsExtension0x040Disable (not send) signature algorithms extension. It is unlikely that you will ever need to adjust it.

cssloIntolerateHigherProtocolVersions0x080(server option) Do not allow fallback from TLS versions higher than currently enabled

cssloStickToPrefCertHashAlg0x100Stick to preferred certificate hash algorithms

cssloNoImplicitTLS12Fallback0x200Disable implicit TLS 1.3 to 1.2 fallbacks

cssloUseHandshakeBatches0x400Send handshake message as large batches rather than individually

TLSMode
SSLModes

Specifies the TLS mode to use.

smDefault0
smNoTLS1Do not use TLS
smExplicitTLS2Connect to the server without any encryption and then request an SSL session.
smImplicitTLS3Connect to the specified port, and establish the SSL session at once.

UseExtendedMasterSecret
Boolean

Enables Extended Master Secret Extension, as defined in RFC 7627.

UseSessionResumption
Boolean

Enables or disables TLS session resumption capability.

Versions
Integer

Th SSL/TLS versions to enable by default.

csbSSL20x01SSL 2

csbSSL30x02SSL 3

csbTLS10x04TLS 1.0

csbTLS110x08TLS 1.1

csbTLS120x10TLS 1.2

csbTLS130x20TLS 1.3

Constructors

public TLSSettings();
Public TLSSettings()

Creates a new TLSSettings object.

Configuration Settings (OfficeVerifier Component)

The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

OfficeVerifier Configuration Settings

ClaimedRoleText:   The text of the claimed role.

Use this property to get the text of the first claimed role.

TBD

ClaimedRoleXML:   The XML content of the claimed roles.

Use this property to get the XML content of the claimed roles element.

TBD

CommitmentTypeIndicationAllSignedDataObjects[Index]:   Specifies the CommitmentTypeIndication's AllSignedDataObjects.

This property contains if the CommitmentTypeIndication's AllSignedDataObjects element is present that indicates that all the signed data objects share the same commitment. Index value could be omitted for the first CommitmentTypeIndication element.

CommitmentTypeIndicationCount:   The number of the CommitmentTypeIndication elements.

Returns the number of the xades:CommitmentTypeIndication elements available.

CommitmentTypeIndicationIdentifier[Index]:   Specifies the CommitmentTypeIndication's CommitmentTypeId's Identifier.

This property contains an identifier indicating the type of commitment made by the signer in the CommitmentTypeIndication's CommitmentTypeId's Identifier element. Index value could be omitted for the first CommitmentTypeIndication element.

CommitmentTypeIndicationIdentifierDescription[Index]:   Specifies the CommitmentTypeIndication's CommitmentTypeId's Description.

This property contains an identifier's description indicating the type of commitment made by the signer in the CommitmentTypeIndication's CommitmentTypeId's Description element. Index value could be omitted for the first CommitmentTypeIndication element.

CommitmentTypeIndicationIdentifierDocumentationReferences[Index]:   Specifies the CommitmentTypeIndication's CommitmentTypeId's DocumentationReferences.

This property contains an identifier's documentation references indicating the type of commitment made by the signer in the CommitmentTypeIndication's CommitmentTypeId's DocumentationReferences element. Index value could be omitted for the first CommitmentTypeIndication element.

CommitmentTypeIndicationIdentifierQualifier[Index]:   Specifies the CommitmentTypeIndication's CommitmentTypeId's IdentifierQualifier.

This property contains an identifier qualifier indicating the type of commitment made by the signer in the CommitmentTypeIndication's CommitmentTypeId's IdentifierQualifier element. Index value could be omitted for the first CommitmentTypeIndication element.

CommitmentTypeIndicationObjectReference[Index]:   Specifies the CommitmentTypeIndication's ObjectReference.

This property contains the CommitmentTypeIndication's ObjectReference elements that refer to one or several ds:Reference elements of the ds:SignedInfo corresponding with one data object qualified by this property. Index value could be omitted for the first CommitmentTypeIndication element.

CommitmentTypeIndicationQualifiersXML[Index]:   The XML content of the CommitmentTypeIndication's Qualifiers.

This property contains the CommitmentTypeIndication's Qualifiers elements XML content. Index value could be omitted for the first CommitmentTypeIndication element.

CustomTSLs:   Specifies the custom TSLs.

Use this property to specify the custom TSLs (Trust Service status Lists) to the validator. The URLs list is comma-separated.

ForceCompleteChainValidation:   Whether to check the CA certificates when the signing certificate is invalid.

Set this property to True to check issuer (CA) certificates if the signing or an intermediate chain certificate is invalid.

ForceCompleteChainValidationForTrusted:   Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors.

Set this property to True to enable full chain validation for explicitly trusted intermediary or end-entity certificates. This may be useful when creating signatures to enforce completeness of the collected revocation information. It often makes sense to set this property to false when validating signatures to reduce validation time and avoid issues with badly configured environments.

GracePeriod:   Specifies a grace period to apply during revocation information checks.

Use this property to specify a grace period (in seconds). Grace period applies to certain subprotocols, such as OCSP, and caters to the inaccuracy and/or missynchronization of clocks on different participating systems. Any time deviations within the grace period will be tolerated.

IgnoreOCSPNoCheckExtension:   Whether OCSP NoCheck extension should be ignored.

Set this property to false to make the validation engine ignore the OCSP no-check extension. You would normally need to set this property when validating severely non-compliant chains that misuse the extension, causing chain loops or other validation issues.

IgnoreSystemTrust:   Whether trusted Windows Certificate Stores should be treated as trusted.

Specifies whether, during chain validation, the component should respect the trust to CA certificates as configured in the operating system. In Windows this effectively defines whether the component should trust the certificates residing in the Trusted Root Certification Authorities store.

If IgnoreSystemTrust is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as TrustedCertificates property) are considered trusted.

ImplicitlyTrustSelfSignedCertificates:   Whether to trust self-signed certificates.

Set this property to True to implicitly trust all self-signed certificates. Use it with care as trusting just about every self-signed certificate is unwise. One exceptional reason where this property may be handy is where a chain is validated in an environment that is not supposed to trust it (for example, a signing, rather than verifying environment, or a QA server). Trusting all self-signing certificates (which are normally trusted) allows to emulate the verifying environment without actually changing its security settings.

IncludeKnownRevocationInfoToSignature:   Whether to include custom revocation info to the signature.

This property specifies whether revocation pieces provided via KnownCertificates, KnownCRLs, and KnownOCSPs properties should be included into the signature. This property lets you include custom validation elements to the signature in addition to the ones comprising the signing chain.

ProductionPlace:   Identifies the place of the signature production.

Use this property to get the signature production place.

PromoteLongOCSPResponses:   Whether long OCSP responses are requested.

Set this property to True to force the component to publish 'long' form of OCSP responses. Otherwise, only BasicOCSPResponse blobs are promoted.

QualifiedStatus:   Indicates a qualified electronic signature.

Use this property to check if an electronic signature is created using a qualified device for creating electronic signatures and that relies on a qualified electronic signature certificate. This property return TSP service status URI.

RemoveSignature:   Whether to remove signature.

Enable to remove signature after its verification.

SignatureInfoAddress1:   Specifies the location at which the signature was created.

Use this property to specify the location at which the signature was created.

SignatureInfoAddress2:   Specifies the location at which the signature was created.

Use this property to specify the location at which the signature was created.

SignatureInfoComments:   Comments to the signature info text.

Comments to the signature info text.

SignatureInfoDelegateSuggestedSigner:   Specifies the name of a person.

Use this property to specify the name of a person to whom the signature has been delegated.

SignatureInfoDelegateSuggestedSigner2:   Specifies the title of a person.

Use this property to specify the title of a person to whom the signature has been delegated.

SignatureInfoDelegateSuggestedSignerEmail:   Specifies the e-mail address of a person.

Use this property to specify the e-mail address of a person to whom the signature has been delegated.

SignatureInfoImage:   Specifies an image for the digital signature.

Use his property to set an image for the digital signature.

SignatureInfoIncluded:   Whether to include the signature info.

Specifies whether to include the signature info.

Sample code that demonstrates adding signature information for OpenXML documents: signer.EnableXAdES = true; signer.XAdESForm = xafEPES; signer.Config("SignatureInfoIncluded=true"); signer.Config("SignatureInfoText=Text"); signer.Config("SignatureInfoComments=Comment"); signer.Config("ClaimedRoleText=Role"); signer.Config("CommitmentTypeIndicationCount=1"); signer.Config("CommitmentTypeIndicationAllSignedDataObjects=true"); signer.Config("CommitmentTypeIndicationIdentifier=http://uri.etsi.org/01903/v1.2.2#ProofOfApproval"); signer.Config("CommitmentTypeIndicationIdentifierDescription=Approved this document"); signer.Config("ProductionPlace=CITY=Test City, ST=Test State, POSTALCODE=Test Code, C=Test Country"); signer.Config("SignatureInfoAddress1=Address1"); signer.Config("SignatureInfoAddress2=Address2");

SignatureInfoInvalidLnImage:   Specifies the image of an invalid signature.

Use this property to set the image of an invalid signature, if the digital signature must be printed.

SignatureInfoSignatureType:   Specifies the type of the digital signature.

Use this property to specify the type of the digital signature.

When the type is 2, both SignatureInfoValidLnImage and SignatureInfoInvalidLnImage images should be specified.

SignatureInfoText:   The text to be displayed as the signature info.

The text to be displayed as the signature info.

SignatureInfoValidLnImage:   Specifies the image of a valid signature.

Use this property to set the image of a valid signature, if the digital signature must be printed.

SignatureLineAdditionalSignatureInfo[Index]:   Contains additional signature information.

This property contains additional signature information.

SignatureLineAllowComments[Index]:   Indicates if comments are allowed.

This property contains the True value if comments are allowed.

SignatureLineCount:   The number of signature lines.

Returns the number of the signature lines available for Office Open XML (OOXML) documents.

SignatureLineId[Index]:   Contains signature unique ID.

This property contains signature unique ID.

SignatureLineImageData[Index]:   Contains signature image.

This property contains signature image.

SignatureLineShowSignDate[Index]:   Indicates if signing date should be shown.

This property contains the True value if the signature line should include the signing date.

SignatureLineSignatureIndex[Index]:   The index of the signature that signs signature line.

This property contains the index of the signature that signs this signature line.

SignatureLineSignatureProviderId[Index]:   Contains signature provider ID.

This property contains a unique ID identifying which signature provider created the signature line.

SignatureLineSignatureProviderUrl[Index]:   Contains signature provider URL.

This property contains a signature provider download URL.

SignatureLineSigned[Index]:   Indicates if signature line is signed.

This property contains the True value if signature line is signed.

SignatureLineSigningInstructions[Index]:   Contains signing instructions.

This property contains the instructions, shown to the user at signing time.

SignatureLineSuggestedSigner2[Index]:   Suggested signer line two.

This property contains the second line of information of who should sign the signature line.

SignatureLineSuggestedSigner[Index]:   Suggested signer line one.

This property contains the first line of information of who should sign the signature line.

SignatureLineSuggestedSignerEmail[Index]:   Suggested signer email address.

This property contains the email address of who should sign the signature line.

SigPolicyDescription:   signature policy description.

Use this property to get the Description of the signature policy.

SigPolicyExplicitText:   The explicit text of the user notice.

Use this property to get the explicit text of the user notice to be displayed when the signature is verified.

SigPolicyHash:   The hash value of the signature policy.

Use this property to get the hash value of the signature policy.

SigPolicyHashAlgorithm:   The hash algorithm used to compute the signature policy hash.

Use this property to get the algorithm used to compute the signature policy hash.

SigPolicyID:   Identifies the signature policy.

Use this property to get an identifier that uniquely identifies a specific version of the signature policy.

SigPolicyNoticeNumbers:   Contains user notice numbers.

This property provides an access to the list of notice numbers, by which the explicit signature policy notice texts could be retrieved.

SigPolicyNoticeOrganization:   The organization part of the NoticeReference qualifier.

Defines the "organization" part of the NoticeReference signature policy qualifier for XAdES-EPES form.

SigPolicyURI:   Signature policy URI.

Use this property to get the URI of the signature policy.

TempPath:   Location where the temporary files are stored.

This setting specifies an absolute path to the location on disk where temporary files are stored.

TimestampCanonicalizationMethod:   Specifies canonicalization method used in timestamp.

Use this property to specify the canonicalization method used in timestamp.

cxcmNone0
cxcmCanon1
cxcmCanonComment2
cxcmExclCanon3
cxcmExclCanonComment4
cxcmMinCanon5
cxcmCanon_v1_16
cxcmCanonComment_v1_17

TimestampValidationDataDetails:   Specifies timestamp validation data details to include to the signature.

Contains a comma-separated list of values that specifies which validation data values details to include to the signature when xades:TimeStampValidationData element added.

Supported values are:

certificateBase64-encoded [X509v3] certificates
crlBase64-encoded certificate revocation lists (CRL)
ocspOCSP responses

TLSChainValidationDetails:   Contains the advanced details of the TLS server certificate validation.

Check this property in TLSCertValidate event handler to access the TLS certificate validation details.

TLSChainValidationResult:   Contains the result of the TLS server certificate validation.

Check this property in TLSCertValidate event handler to obtain the TLS certificate validation result.

TLSClientAuthRequested:   Indicates whether the TLS server requests client authentication.

Check this property in TLSCertValidate event handler to find out whether the TLS server requests the client to provide the authentication certificate. If this property is set to true, provide your certificate via TLSClientChain property. Note that the component may fire this event more than once during each operation, as more than one TLS-enabled server may need to be contacted.

TLSValidationLog:   Contains the log of the TLS server certificate validation.

Check this property in TLSCertValidate event handler to retrieve the validation log of the TLS server.

TolerateMinorChainIssues:   Whether to tolerate minor chain issues.

TBD

TSLDistributionPoints:   Contains XML content of distribution points of the TSL used.

Use this property to get XML content of distribution points of the TSL used to obtain the qualified status of the certificate.

TSLDistributionPoints[Idx]:   Contains distribution point of the specified index of the TSL used.

Use this property to get distribution point of the specified index of the TSL used to obtain the qualified status of the certificate.

TSLHistoricalInformationPeriod:   Contains historical information period of the TSL used.

Use this property to get historical information period of the TSL used to obtain the qualified status of the certificate.

TSLLegalNotices:   Contains XML content of legal notices of the TSL used.

Use this property to get XML content of multilingual legal notices of the TSL used to obtain the qualified status of the certificate.

TSLLegalNotices[lang]:   Contains legal notices for the specified language of the TSL used.

Use this property to get legal notices for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate.

TSLListIssueDateTime:   Contains list issue date and time of the TSL used.

Use this property to get list issue date and time of the TSL used to obtain the qualified status of the certificate.

TSLNextUpdate:   Contains next update date and time of the TSL used.

Use this property to get next update date and time of the TSL used to obtain the qualified status of the certificate.

TSLPolicies:   Contains XML content of policies of the TSL used.

Use this property to get XML content of multilingual policies of the TSL used to obtain the qualified status of the certificate.

TSLPolicies[lang]:   Contains policies for the specified language of the TSL used.

Use this property to get policies for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate.

TSLSchemeExtensions:   Contains XML content of scheme extensions of the TSL used.

Use this property to get XML content of scheme extensions of the TSL used to obtain the qualified status of the certificate.

TSLSchemeExtensions[Idx]:   Contains XML content of scheme extension of the specified index of the TSL used.

Use this property to get XML content of scheme extension of the specified index of the TSL used to obtain the qualified status of the certificate.

TSLSchemeInformationURI:   Contains XML content of scheme information URI of the TSL used.

Use this property to get XML content of multilingual scheme information URI of the TSL used to obtain the qualified status of the certificate.

TSLSchemeInformationURI[lang]:   Contains scheme information URI for the specified language of the TSL used.

Use this property to get scheme information URI for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate.

TSLSchemeName:   Contains XML content of scheme name of the TSL used.

Use this property to get XML content of multilingual scheme name of the TSL used to obtain the qualified status of the certificate.

TSLSchemeName[lang]:   Contains scheme name for the specified language of the TSL used.

Use this property to get scheme name for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate.

TSLSchemeOperatorAddress:   Contains XML content of scheme operator address of the TSL used.

Use this property to get XML content of scheme operator address of the TSL used to obtain the qualified status of the certificate.

TSLSchemeOperatorName:   Contains XML content of scheme operator name of the TSL used.

Use this property to get XML content of multilingual scheme operator name of the TSL used to obtain the qualified status of the certificate.

TSLSchemeOperatorName[lang]:   Contains scheme operator name for the specified language of the TSL used.

Use this property to get scheme operator name for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate.

TSLSchemeTerritory:   Contains scheme territory of the TSL used.

Use this property to get scheme territory of the TSL used to obtain the qualified status of the certificate.

TSLSchemeTypeCommunityRules:   Contains XML content of scheme type/community/rules of the TSL used.

Use this property to get XML content of multilingual scheme type/community/rules of the TSL used to obtain the qualified status of the certificate.

TSLSchemeTypeCommunityRules[lang]:   Contains scheme type/community/rules for the specified language of the TSL used.

Use this property to get scheme type/community/rules for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate.

TSLSequenceNumber:   Contains sequence number of the TSL used.

Use this property to get sequence number of the TSL used to obtain the qualified status of the certificate.

TSLsRetrieveLog:   Contains the complete log of the TSLs retrieve.

Use this property to access the TSLs retrieve log produced by the component. The log can be very useful when investigating issues with TSL retrieve.

TSLStatusDeterminationApproach:   Contains status determination approach of the TSL used.

Use this property to get status determination approach of the TSL used to obtain the qualified status of the certificate.

TSLsValidationLog:   Contains the complete log of the TSLs validation.

Use this property to access the TSLs validation log produced by the component. The log can be very useful when investigating issues with TSL validation.

TSLTSPAdditionalServiceInformation:   Contains addtional service information of the TSP service used.

Use this property to get the list of addtional service information of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. The URIs list is comma-separated.

TSLTSPAddress:   Contains XML content of the address of the TSP used.

Use this property to get XML content of the address of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSLTSPHistoryInstance:   Indicates that TSP service history instance used.

Indicates whether or not the qualified status was obtained from the TSP (Trust Service Provider) service history instance.

TSLTSPHistoryInstanceAdditionalServiceInformation:   Contains addtional service information of the TSP service history instance used.

Use this property to get the list of addtional service information of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. The URIs list is comma-separated.

TSLTSPHistoryInstanceQualifiers:   Contains list of qualifiers of the TSP service history instance used.

Use this property to get the list of qualifiers of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. The URIs list is comma-separated.

TSLTSPHistoryInstanceServiceInformationExtensions:   Contains XML content of information extensions of the TSP service history instance used.

Use this property to get XML content of information extensions of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPHistoryInstanceServiceInformationExtensions[Idx]:   Contains XML content of information extension of the specified index of the TSP service history instance used.

Use this property to get XML content of information extension of the specified index of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPHistoryInstanceServiceName:   Contains XML content of name of the TSP service history instance used.

Use this property to get XML content of multilingual name of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPHistoryInstanceServiceName[lang]:   Contains name for the specified language of the TSP service history instance used.

Use this property to get the name for the specified language code (e.g. 'en') of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPHistoryInstanceServiceStatus:   Contains status of the TSP service history instance used.

Use this property to get the status of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPHistoryInstanceServiceStatusStartingTime:   Contains status starting time of the TSP service history instance used.

Use this property to get the status starting time of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPHistoryInstanceServiceTypeIdentifier:   Contains type identifier of the TSP service history instance used.

Use this property to get type identifier of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPHistoryInstanceXML:   Contains XML content of the TSP service history instance used.

Use this property to get XML content of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPInformationExtensions:   Contains XML content of information extensions of the TSP used.

Use this property to get XML content of information extensions of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSLTSPInformationExtensions[Idx]:   Contains XML content of information extension of the specified index of the TSP used.

Use this property to get XML content of information extension of the specified index of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSLTSPInformationURI:   Contains XML content of information URI of the TSP used.

Use this property to get XML content of multilingual information URI of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSLTSPInformationURI[lang]:   Contains information URI for the specified language of the TSP used.

Use this property to get the information URI for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSLTSPName:   Contains XML content of name of the TSP used.

Use this property to get XML content of multilingual name of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSLTSPName[lang]:   Contains name for the specified language of the TSP used.

Use this property to get the name for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSLTSPSchemeServiceDefinitionURI:   Contains XML content of scheme service definition URI of the TSP service used.

Use this property to get XML content of multilingual scheme service definition URI of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPSchemeServiceDefinitionURI[lang]:   Contains scheme service definition URI for the specified language of the TSP service used.

Use this property to get the scheme service definition URI for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceDefinitionURI:   Contains XML content of definition URI of the TSP service used.

Use this property to get XML content of multilingual definition URI of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceDefinitionURI[lang]:   Contains definition URI for the specified language of the TSP service used.

Use this property to get the definition URI for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceInformationExtensions:   Contains XML content of information extensions of the TSP service used.

Use this property to get XML content of information extensions of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceInformationExtensions[Idx]:   Contains XML content of information extension of the specified index of the TSP service used.

Use this property to get XML content of information extension of the specified index of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceName:   Contains XML content of name of the TSP service used.

Use this property to get XML content of multilingual name of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceName[lang]:   Contains name for the specified language of the TSP service used.

Use this property to get the name for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceQualifiers:   Contains list of qualifiers of the TSP service used.

Use this property to get the list of qualifiers of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. The URIs list is comma-separated.

TSLTSPServiceStatus:   Contains status of the TSP service used.

Use this property to get the status of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceStatusStartingTime:   Contains status starting time of the TSP service used.

Use this property to get the status starting time of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceSupplyPoints:   Contains XML content of the supply points of the TSP service used.

Use this property to get XML content of the supply points of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceTypeIdentifier:   Contains type identifier of the TSP service used.

Use this property to get type identifier of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceXML:   Contains XML content of the TSP service used.

Use this property to get XML content of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPTradeName:   Contains XML content of trade name of the TSP used.

Use this property to get XML content of multilingual trade name of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSLTSPTradeName[lang]:   Contains trade name for the specified language of the TSP used.

Use this property to get the trade name for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSLTSPXML:   Contains XML content of the TSP used.

Use this property to get XML content of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSLType:   Contains TSL type of the TSL used.

Use this property to get TSL type of the TSL used to obtain the qualified status of the certificate.

TSLVersionIdentifier:   Contains version identifier of the TSL used.

Use this property to get version identifier of the TSL used to obtain the qualified status of the certificate.

TSLXML:   Contains XML content of the TSL used.

Use this property to get XML content of the TSL used to obtain the qualified status of the certificate.

TspHashAlgorithm:   Sets a specific hash algorithm for use with the timestamping service.

In default configuration component uses the 'SHA256' hash algorithm. Use this property to specify a different hash algorithm for the timestamp.

UseDefaultTSLs:   Enables or disables the use of the default TSLs.

Use this property to tell the validator to use (or not to use) the default TSLs (Trust Service status Lists). The result of this check reported in Qualified property.

The following default TSLs are used: EU (European Union) LOTL (list of trusted lists).

UseMicrosoftCTL:   Enables or disables automatic use of Microsoft online certificate trust list.

Enable this property to make the chain validation module automatically look up missing CA certificates in the public Windows Update repository.

UseSystemCertificates:   Enables or disables the use of the system certificates.

Use this property to tell chain validation module automatically look up missing CA certificates in the system certificates. In many cases it is beneficial to switch this property on, as the operating system certificate configuration provides a representative trust framework.

ValidationDataRefsDetails:   Specifies validation data references details to include to the signature.

Contains a comma-separated list of values that specifies which validation data references details to include to the signature when signature upgraded to XAdES-C or XAdES-E-C form.

Supported values are:

certificateReferences to X.509 certificates
crlReferences to certificate revocation lists (CRL)
ocspReferences to OCSP responses

ValidationDataValuesDetails:   Specifies validation data values details to include to the signature.

Contains a comma-separated list of values that specifies which validation data values details to include to the signature when signature upgraded to XAdES-X-L or XAdES-E-X-L form.

Supported values are:

certificateBase64-encoded [X509v3] certificates
crlBase64-encoded certificate revocation lists (CRL)
ocspOCSP responses

Base Configuration Settings

CheckKeyIntegrityBeforeUse:   Enables or disable private key integrity check before use.

This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used.

You can switch this property off to improve performance if your project only uses known, good private keys.

CookieCaching:   Specifies whether a cookie cache should be used for HTTP(S) transports.

Set this property to enable or disable cookies caching for the component.

Supported values are:

offNo caching (default)
localLocal caching (supported for HTTPClient, RESTClient and SOAPClient only)
globalGlobal caching

Cookies:   Gets or sets local cookies for the component (supported for HTTPClient, RESTClient and SOAPClient only).

Use this property to get cookies from the internal cookie storage of the component and/or restore them back between application sessions.

DefDeriveKeyIterations:   Specifies the default key derivation algorithm iteration count.

This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.

EnableClientSideSSLFFDHE:   Enables or disables finite field DHE key exchange support in TLS clients.

This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections.

This setting only applies to sessions negotiated with TLS version 1.3.

GlobalCookies:   Gets or sets global cookies for all the HTTP transports.

Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the components that have its CookieCaching property set to "global".

HttpUserAgent:   Specifies the user agent name to be used by all HTTP clients.

This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other components.

LogDestination:   Specifies the debug log destination.

Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:

fileFile
consoleConsole
systemlogSystem Log (supported for Android only)
debuggerDebugger (supported for VCL for Windows and .Net)

LogDetails:   Specifies the debug log details to dump.

Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:

timeCurrent time
levelLevel
packagePackage name
moduleModule name
classClass name
methodMethod name
threadidThread Id
contenttypeContent type
contentContent
allAll details

LogFile:   Specifies the debug log filename.

Use this property to provide a path to the log file.

LogFilters:   Specifies the debug log filters.

Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:

exclude-packageExclude a package specified in the value
exclude-moduleExclude a module specified in the value
exclude-classExclude a class specified in the value
exclude-methodExclude a method specified in the value
include-packageInclude a package specified in the value
include-moduleInclude a module specified in the value
include-classInclude a class specified in the value
include-methodInclude a method specified in the value

LogFlushMode:   Specifies the log flush mode.

Use this property to set the log flush mode. The following values are defined:

noneNo flush (caching only)
immediateImmediate flush (real-time logging)
maxcountFlush cached entries upon reaching LogMaxEventCount entries in the cache.

LogLevel:   Specifies the debug log level.

Use this property to provide the desired debug log level.

Supported values are:

noneNone (by default)
fatalSevere errors that cause premature termination.
errorOther runtime errors or unexpected conditions.
warningUse of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
infoInteresting runtime events (startup/shutdown).
debugDetailed information on flow of through the system.
traceMore detailed information.

LogMaxEventCount:   Specifies the maximum number of events to cache before further action is taken.

Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

LogRotationMode:   Specifies the log rotation mode.

Use this property to set the log rotation mode. The following values are defined:

noneNo rotation
deleteolderDelete older entries from the cache upon reaching LogMaxEventCount
keepolderKeep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded)

MaxASN1BufferLength:   Specifies the maximal allowed length for ASN.1 primitive tag data.

This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.

MaxASN1TreeDepth:   Specifies the maximal depth for processed ASN.1 trees.

This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.

OCSPHashAlgorithm:   Specifies the hash algorithm to be used to identify certificates in OCSP requests.

This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.

Tag:   Allows to store any custom data.

Use this config property to store any custom data.

UseSharedSystemStorages:   Specifies whether the validation engine should use a global per-process copy of the system certificate stores.

Set this global property to false to make each validation run use its own copy of system certificate stores.

UseSystemOAEPAndPSS:   Enforces or disables the use of system-driven RSA OAEP and PSS computations.

This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation.

This setting only applies to certificates originating from a Windows system store.

UseSystemRandom:   Enables or disables the use of the OS PRNG.

Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

Trappable Errors (OfficeVerifier Component)

OfficeVerifier Errors

1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
1048578   Component is configured incorrectly (SB_ERROR_INVALID_SETUP)
1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) 
24117249   Input file does not exist (SB_ERROR_OFFICE_INPUTFILE_NOT_EXISTS)
24117250   Unsupported document format (SB_ERROR_OFFICE_UNSUPPORTED_DOCUMENT_FORMAT)
24117251   Document cannot be signed (SB_ERROR_OFFICE_DOCUMENT_NOT_SIGNABLE)
24117252   Document is not signed (SB_ERROR_OFFICE_DOCUMENT_NOT_SIGNED)
24117253   Document is encrypted (SB_ERROR_OFFICE_DOCUMENT_ENCRYPTED)
24117254   Document cannot be encrypted (SB_ERROR_OFFICE_DOCUMENT_NOT_ENCRYPTABLE)
24117255   Document is not encrypted (SB_ERROR_OFFICE_DOCUMENT_NOT_ENCRYPTED)
24117256   Unknown encryption algorithm (SB_ERROR_OFFICE_DOCUMENT_UNKNOWN_ENCRYPTION)
24117257   Invalid password (SB_ERROR_OFFICE_INVALID_PASSWORD)
24117258   Signature not found (SB_ERROR_OFFICE_SIGNATURE_NOT_FOUND)

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2022 .NET Edition - Version 22.0 [Build 8174]