OfficeVerifier Module

Properties Methods Events Config Settings Errors

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

Syntax

SecureBlackbox.OfficeVerifier

Remarks

Use OfficeVerifier to validate electronic signatures made over Office documents. OfficeVerifier verifier = new OfficeVerifier(); // Set the file that you want to verify verifier.setInputFile("SignedDoc.docx"); verifier.verify(); // Signature information for (int idx = 0; idx < verifier.getSignatures().size(); idx++) { OfficeSignature signature = verifier.getSignatures().get(idx); System.out.println("Signature #" + (idx + 1)); System.out.println(" Signature Coverage: " + (signature.getDocumentSigned() ? "document, " : "") + (signature.getCorePropertiesSigned() ? "document properties, " : "") + (signature.getSignatureOriginSigned() ? "signature origin, " : "") ); System.out.println(" Signature Time: " + signature.getClaimedSigningTime()); System.out.println(" Signature Validation Result: " + signature.getSignatureValidationResult()); System.out.println(" Chain Validation Result: " + signature.getChainValidationResult() + "\n"); }

Property List

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


AllSignaturesValid	The cumulative validity of all signatures.
AutoValidateSignatures	Specifies whether module should validate any present signatures when the document is opened.
BlockedCertificates	The certificates that must be rejected as trust anchors.
Certificates	A collection of certificates included in the electronic signature.
CheckTrustedLists	Specifies whether the module should attempt to validate chain trust via a known Trusted List.
CRLs	A collection of certificate revocation lists embedded into the signature by the signer.
DocumentFormat	Defines the format of the Office document.
DocumentType	Defines the type of the Office document.
FIPSMode	Reserved.
IgnoreChainValidationErrors	Makes the module tolerant to chain validation errors.
InputBytes	Use this property to pass the input to module in byte array form.
InputFile	The path to the signed office document.
KnownCertificates	Additional certificates for chain validation.
KnownCRLs	Additional CRLs for chain validation.
KnownOCSPs	Additional OCSP responses for chain validation.
OCSPs	A collection of OCSP responses embedded into the signature.
OfflineMode	Switches the module to offline mode.
OutputBytes	Use this property to read the output the module object has produced.
OutputFile	Defines where to save the modified signed document.
Profile	Specifies a pre-defined profile to apply when creating the signature.
Proxy	The proxy server settings.
RevocationCheck	Specifies the kind(s) of revocation check to perform for all chain certificates.
Signatures	All signatures found in the Office document.
SignedParts	All signed parts or entries found in the Office signatures.
SocketSettings	Manages network connection settings.
Timestamps	Contains a collection of timestamps for the processed document.
TLSClientChain	The TLS client certificate chain.
TLSServerChain	The TLS server's certificate chain.
TLSSettings	Manages TLS layer settings.
TrustedCertificates	A list of trusted certificates for chain validation.
ValidationMoment	Specifies the validation moment.

Method List

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


Close	Closes an opened document.
Config	Sets or retrieves a configuration setting.
DoAction	Performs an additional action.
Open	Opens a document for verifying or removing signatures.
Reset	Resets the module settings.
Revalidate	Revalidates a signature in accordance with current settings.
SelectInfo	Select signature information for a specific entity.
Unsign	Deletes a signature from the document.
Verify	Verifies the whole document.

Event List

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


ChainElementDownload	Fires when there is a need to download a chain element from an online source.
ChainElementNeeded	Fires when an element required to validate the chain was not located.
ChainElementStore	This event is fired when a chain element (certificate, CRL, or OCSP response) should be stored along with a signature.
ChainValidated	Reports the completion of a certificate chain validation.
ChainValidationProgress	This event is fired multiple times during chain validation to report various stages of the validation procedure.
DocumentLoaded	This event is fired when the document has been loaded into memory.
Error	Information about errors during the signature validation.
Notification	This event notifies the application about an underlying control flow event.
SignatureFound	Signifies the start of signature validation.
SignatureValidated	Marks the completion of the signature validation routine.
TimestampFound	Signifies the start of a timestamp validation routine.
TimestampValidated	Reports the completion of the timestamp validation routine.
TLSCertNeeded	Fires when a remote TLS party requests a client certificate.
TLSCertValidate	This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.
TLSEstablished	Fires when a TLS handshake with Host successfully completes.
TLSHandshake	Fires when a new TLS handshake is initiated, before the handshake commences.
TLSShutdown	Reports the graceful closure of a TLS connection.

Config Settings

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


AddAllDataObjectsTimestamp	Whether to add all data objects timestamp during signing.
AsyncDocumentID	Specifies the document ID for SignAsyncEnd() call.
ChainCurrentCACert	Returns the current CA certificate.
ChainCurrentCert	Returns the certificate that is currently being validated.
ChainCurrentCRL	Returns the current CRL.
ChainCurrentCRLSize	Returns the size of the current CRL.
ChainCurrentOCSP	Returns the current OCSP response.
ChainCurrentOCSPSigner	Returns the signer of the current OCSP object.
ChainInterimDetails	Returns the current interim validation details.
ChainInterimResult	Returns the current interim validation result.
CheckValidityPeriodForTrusted	Whether to check validity period for trusted certificates.
ClaimedRolesXML	The XML content of the claimed roles.
ClaimedRoleText	The text of the claimed role.
CommitmentTypeIndicationAllSignedDataObjects[Index]	Specifies the CommitmentTypeIndication's AllSignedDataObjects.
CommitmentTypeIndicationCount	The 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.
CustomTrustedLists	Specifies the custom TrustedLists.
CustomTSLs	Specifies the custom TrustedLists.
DataObjectFormatCount	The number of the DataObjectFormat elements.
DataObjectFormatDescription[Index]	Specifies the DataObjectFormat's Description.
DataObjectFormatEncoding[Index]	Specifies the DataObjectFormat's Encoding.
DataObjectFormatMimeType[Index]	Specifies the DataObjectFormat's MimeType.
DataObjectFormatObjectIdentifier[Index]	Specifies the DataObjectFormat's ObjectIdentifier's Identifier.
DataObjectFormatObjectIdentifierDescription[Index]	Specifies the DataObjectFormat's ObjectIdentifier's Description.
DataObjectFormatObjectIdentifierDocumentationReferences[Index]	Specifies the DataObjectFormat's ObjectIdentifier's DocumentationReferences.
DataObjectFormatObjectIdentifierQualifier[Index]	Specifies the DataObjectFormat's ObjectIdentifier's IdentifierQualifier.
DataObjectFormatObjectReference[Index]	Specifies the DataObjectFormat's ObjectReference.
DislikeOpenEndedOCSPs	Tells the module to discourage OCSP responses without an explicit NextUpdate parameter.
ExclusiveCanonicalizationPrefix	Specifies the exclusive canonicalization prefix.
ExpireTime	Signature expiration time in UTC.
ForceCompleteChainValidation	Whether to check the CA certificates when the signing certificate is invalid.
ForceCompleteChainValidationForTrusted	Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors.
GracePeriod	Specifies a grace period to apply during revocation information checks.
HMACKey	The key value for HMAC.
HMACOutputLength	Sets the length of the HMAC output.
HMACSigningUsed	Whether to use HMAC signing.
IgnoreChainLoops	Whether chain loops should be ignored.
IgnoreChainValidationErrors	Whether to ignore any certificate chain validation issues.
IgnoreOCSPNoCheckExtension	Whether the OCSP NoCheck extension should be ignored.
IgnoreSystemTrust	Whether trusted Windows Certificate Stores should be treated as trusted.
IgnoreTimestampFailure	Whether to ignore time-stamping failure during signing.
ImplicitlyTrustSelfSignedCertificates	Whether to trust self-signed certificates.
IncludeKnownRevocationInfoToSignature	Whether to include custom revocation info to the signature.
InclusiveNamespacesPrefixList	Specifies the InclusiveNamespaces PrefixList.
KeyInfoID	Specifies the ID for KeyInfo element.
KeyName	Contains information about the key used for signing.
ManifestCount	TBD.
ManifestID[i]	TBD.
ManifestObjectIndex[i]	TBD.
ManifestXML[i]	TBD.
ObjectCount	TBD.
ObjectEncoding[i]	TBD.
ObjectID[i]	TBD.
ObjectMimeType[i]	TBD.
ObjectSignaturePropertiesCount	TBD.
ObjectSignaturePropertiesID[i]	TBD.
ObjectSignaturePropertiesObjectIndex[i]	TBD.
ObjectSignaturePropertiesXML[i]	TBD.
ObjectSignaturePropertyCount	TBD.
ObjectSignaturePropertyID[i]	TBD.
ObjectSignaturePropertyPropertiesIndex[i]	TBD.
ObjectSignaturePropertyTarget[i]	TBD.
ObjectSignaturePropertyXML[i]	TBD.
ObjectXML[i]	TBD.
PolicyDescription	signature policy description.
PolicyDescription	signature policy description.
PolicyExplicitText	The explicit text of the user notice.
PolicyExplicitText	The explicit text of the user notice.
PolicyUNNumbers	The noticeNumbers part of the NoticeReference CAdES attribute.
PolicyUNNumbers	The noticeNumbers part of the NoticeReference CAdES attribute.
PolicyUNOrganization	The organization part of the NoticeReference qualifier.
PolicyUNOrganization	The organization part of the NoticeReference qualifier.
ProductionPlace	Identifies the place of the signature production.
ProductionPlace	Identifies the place of the signature production.
PromoteLongOCSPResponses	Whether long OCSP responses are requested.
PSSUsed	Whether to use RSASSA-PSS algorithm.
PSSUsed	Whether to use RSASSA-PSS algorithm.
QualifyingPropertiesID	Specifies the ID for QualifyingProperties element.
QualifyingPropertiesObjectID	Specifies the ID for object with QualifyingProperties element.
QualifyingPropertiesReferenceCount	The number of the QualifyingPropertiesReference elements.
QualifyingPropertiesReferenceID[Index]	Specifies the QualifyingPropertiesReference's ID.
QualifyingPropertiesReferenceURI[Index]	Specifies the QualifyingPropertiesReference's URI.
RefsTimestampType	Specifies references timestamp type to include to the signature.
SchemeParams	The algorithm scheme parameters to employ.
SignatureID	Specifies the ID for Signature element.
SignatureInfoAddress1	Specifies the location at which the signature was created.
SignatureInfoAddress2	Specifies the location at which the signature was created.
SignatureInfoComments	Comments to the signature info text.
SignatureInfoDelegateSuggestedSigner	Specifies the name of a person.
SignatureInfoDelegateSuggestedSigner2	Specifies the title of a person.
SignatureInfoDelegateSuggestedSignerEmail	Specifies the e-mail address of a person.
SignatureInfoImage	Specifies an image for the digital signature.
SignatureInfoIncluded	Whether to include the signature info.
SignatureInfoInvalidLnImage	Specifies the image of an invalid signature.
SignatureInfoSignatureType	Specifies the type of the digital signature.
SignatureInfoText	The text to be displayed as the signature info.
SignatureInfoValidLnImage	Specifies the image of a valid signature.
SignatureLineAdditionalSignatureInfo[Index]	Contains additional signature information.
SignatureLineAllowComments[Index]	Indicates if comments are allowed.
SignatureLineCount	The number of signature lines.
SignatureLineId[Index]	Contains signature unique ID.
SignatureLineImageData[Index]	Contains signature image.
SignatureLineIndex	Specifies the index of the signature line to sign.
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.
SignatureOriginPartURI	Contains the signature origin part URI element.
SignaturePartName	Name of signature part.
SignaturePrefix	Specifies the signature prefix.
SignatureValueID	Specifies the ID for SignatureValue element.
SignedInfoID	Specifies the ID for SignedInfo element.
SignedPropertiesID	Specifies the ID for SignedProperties element.
SignedPropertiesReferenceCanonicalizationMethod	Specifies the canonicalization method used in SignedProperties reference.
SignedPropertiesReferenceHashAlgorithm	Specifies the hash algorithm used in SignedProperties reference.
SignedPropertiesReferenceID	Specifies the ID for Reference element that points to SignedProperties element.
SignedPropertiesReferenceInclusiveNamespacesPrefixList	Specifies the InclusiveNamespaces PrefixList used in SignedProperties reference.
SignedPropertiesReferenceIndex	Specifies the index of SignedProperties reference.
SignedSignaturePropertiesID	Specifies the ID for SignedSignatureProperties element.
SigningCertificatesChain	The indicator of which certificates should be/are included as the signing chain.
SigningCertificatesHashAlgorithm	Specifies the hash algorithm used for SigningCertificates.
SignTime	Specifies the signing time in UTC.
SigPolicyDescription	signature policy description.
SigPolicyDescription	signature policy description.
SigPolicyExplicitText	The explicit text of the user notice.
SigPolicyExplicitText	The explicit text of the user notice.
SigPolicyHash	The EPES policy hash.
SigPolicyHash	The EPES policy hash.
SigPolicyHashAlgorithm	The hash algorithm that was used to generate the EPES policy hash.
SigPolicyHashAlgorithm	The hash algorithm that was used to generate the EPES policy hash.
SigPolicyID	The EPES policy ID.
SigPolicyID	The EPES policy ID.
SigPolicyNoticeNumbers	The noticeNumbers part of the NoticeReference CAdES attribute.
SigPolicyNoticeNumbers	The noticeNumbers part of the NoticeReference CAdES attribute.
SigPolicyNoticeOrganization	The organization part of the NoticeReference qualifier.
SigPolicyNoticeOrganization	The organization part of the NoticeReference qualifier.
SigPolicyURI	The EPES policy URI.
SigPolicyURI	The EPES policy URI.
TempPath	Path for storing temporary files.
TimestampCanonicalizationMethod	Specifies canonicalization method used in timestamp.
TimestampResponse	A base16-encoded timestamp response received from a TSA.
TimestampValidationDataDetails	Specifies timestamp validation data details to include to the signature.
TLSChainValidationDetails	Contains the advanced details of the TLS server certificate validation.
TLSChainValidationResult	Contains the result of the TLS server certificate validation.
TLSClientAuthRequested	Indicates whether the TLS server requests client authentication.
TLSValidationLog	Contains the log of the TLS server certificate validation.
TolerateMinorChainIssues	Whether to tolerate minor chain issues.
TspAttemptCount	Specifies the number of timestamping request attempts.
TspHashAlgorithm	Sets a specific hash algorithm for use with the timestamping service.
TspReqPolicy	Sets a request policy ID to include in the timestamping request.
UseDefaultTrustedLists	Enables or disables the use of the default TrustedLists.
UseDefaultTSLs	Enables or disables the use of the default TrustedLists.
UseHMACSigning	Whether to use HMAC signing.
UseHMACSigning	Whether to use HMAC signing.
UseMicrosoftCTL	Enables or disables the automatic use of the Microsoft online certificate trust list.
UsePSS	Whether to use RSASSA-PSS algorithm.
UsePSS	Whether to use RSASSA-PSS algorithm.
UseSystemCertificates	Enables or disables the use of the system certificates.
UseValidationCache	Enables or disable the use of the product-wide certificate chain validation cache.
UseValidatorSettingsForTLSValidation	Whether to employ the primary chain validator setup for auxiliary TLS chain validations.
ValidationDataRefsDetails	Specifies validation data references details to include to the signature.
ValidationDataRefsHashAlgorithm	Specifies the hash algorithm used in validation data references.
ValidationDataValuesDetails	Specifies validation data values details to include to the signature.
XAdESPrefix	Specifies the XAdES prefix.
XAdESv141Prefix	Specifies the XAdES v1.4.1 prefix.
ASN1UseGlobalTagCache	Controls whether ASN.1 module should use a global object cache.
AssignSystemSmartCardPins	Specifies whether CSP-level PINs should be assigned to CNG keys.
CheckKeyIntegrityBeforeUse	Enables or disable private key integrity check before use.
CookieCaching	Specifies whether a cookie cache should be used for HTTP(S) transports.
Cookies	Gets or sets local cookies for the module.
DefDeriveKeyIterations	Specifies the default key derivation algorithm iteration count.
DNSLocalSuffix	The suffix to assign for TLD names.
EnableClientSideSSLFFDHE	Enables or disables finite field DHE key exchange support in TLS clients.
GlobalCookies	Gets or sets global cookies for all the HTTP transports.
HardwareCryptoUsePolicy	The hardware crypto usage policy.
HttpUserAgent	Specifies the user agent name to be used by all HTTP clients.
HttpVersion	The HTTP version to use in any inner HTTP client modules created.
IgnoreExpiredMSCTLSigningCert	Whether to tolerate the expired Windows Update signing certificate.
ListDelimiter	The delimiter character for multi-element lists.
LogDestination	Specifies the debug log destination.
LogDetails	Specifies the debug log details to dump.
LogFile	Specifies the debug log filename.
LogFilters	Specifies the debug log filters.
LogFlushMode	Specifies the log flush mode.
LogLevel	Specifies the debug log level.
LogMaxEventCount	Specifies the maximum number of events to cache before further action is taken.
LogRotationMode	Specifies the log rotation mode.
MaxASN1BufferLength	Specifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepth	Specifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithm	Specifies the hash algorithm to be used to identify certificates in OCSP requests.
OldClientSideRSAFallback	Specifies whether the SSH client should use a SHA1 fallback.
ProductVersion	Returns the version of the SecureBlackbox library.
ServerSSLDHKeyLength	Sets the size of the TLS DHE key exchange group.
StaticDNS	Specifies whether static DNS rules should be used.
StaticIPAddress[domain]	Gets or sets an IP address for the specified domain name.
StaticIPAddresses	Gets or sets all the static DNS rules.
Tag	Allows to store any custom data.
TLSSessionGroup	Specifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetime	Specifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeInterval	Specifies how often the session cache should remove the expired TLS sessions.
UseInternalRandom	Switches between SecureBlackbox-own and platform PRNGs.
UseLegacyAdESValidation	Enables legacy AdES validation mode.
UseOwnDNSResolver	Specifies whether the client modules should use own DNS resolver.
UseSharedSystemStorages	Specifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemNativeSizeCalculation	An internal CryptoAPI access tweak.
UseSystemOAEPAndPSS	Enforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandom	Enables or disables the use of the OS PRNG.

AllSignaturesValid Property (OfficeVerifier Module)

The cumulative validity of all signatures.

public var allSignaturesValid: Bool {
  get {...}
}


@property (nonatomic,readonly,assign,getter=allSignaturesValid) BOOL allSignaturesValid;

- (BOOL)allSignaturesValid;

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.

AutoValidateSignatures Property (OfficeVerifier Module)

Specifies whether module should validate any present signatures when the document is opened.

Syntax

Swift
Objective-C

public var autoValidateSignatures: Bool {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=autoValidateSignatures,setter=setAutoValidateSignatures:) BOOL autoValidateSignatures;

- (BOOL)autoValidateSignatures;
- (void)setAutoValidateSignatures :(BOOL)newAutoValidateSignatures;

Default Value

True

Remarks

This setting is switched on by default. You can choose to set this property to false in order to validate the signatures manually on a later stage using the Revalidate method.

BlockedCertificates Property (OfficeVerifier Module)

The certificates that must be rejected as trust anchors.

Syntax

Swift
Objective-C

public var blockedCertificates: Array<Certificate> {
  get {...}
}


@property (nonatomic,readwrite,assign,getter=blockedCertCount,setter=setBlockedCertCount:) int blockedCertCount;

- (int)blockedCertCount;
- (void)setBlockedCertCount :(int)newBlockedCertCount;

- (NSData*)blockedCertBytes:(int)blockedCertIndex;

- (long long)blockedCertHandle:(int)blockedCertIndex;
- (void)setBlockedCertHandle:(int)blockedCertIndex :(long long)newBlockedCertHandle;

Default Value

Remarks

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

Certificates Property (OfficeVerifier Module)

A collection of certificates included in the electronic signature.

Syntax

Swift
Objective-C

public var certificates: Array<Certificate> {
  get {...}
}


@property (nonatomic,readonly,assign,getter=certCount) int certCount;

- (int)certCount;

- (NSData*)certBytes:(int)certIndex;

- (BOOL)certCA:(int)certIndex;

- (NSData*)certCAKeyID:(int)certIndex;

- (int)certCertType:(int)certIndex;

- (NSString*)certCRLDistributionPoints:(int)certIndex;

- (NSString*)certCurve:(int)certIndex;

- (NSString*)certFingerprint:(int)certIndex;

- (NSString*)certFriendlyName:(int)certIndex;

- (long long)certHandle:(int)certIndex;

- (NSString*)certHashAlgorithm:(int)certIndex;

- (NSString*)certIssuer:(int)certIndex;

- (NSString*)certIssuerRDN:(int)certIndex;

- (NSString*)certKeyAlgorithm:(int)certIndex;

- (int)certKeyBits:(int)certIndex;

- (NSString*)certKeyFingerprint:(int)certIndex;

- (int)certKeyUsage:(int)certIndex;

- (BOOL)certKeyValid:(int)certIndex;

- (NSString*)certOCSPLocations:(int)certIndex;

- (BOOL)certOCSPNoCheck:(int)certIndex;

- (int)certOrigin:(int)certIndex;

- (NSString*)certPolicyIDs:(int)certIndex;

- (NSData*)certPrivateKeyBytes:(int)certIndex;

- (BOOL)certPrivateKeyExists:(int)certIndex;

- (BOOL)certPrivateKeyExtractable:(int)certIndex;

- (NSData*)certPublicKeyBytes:(int)certIndex;

- (BOOL)certQualified:(int)certIndex;

- (int)certQualifiedStatements:(int)certIndex;

- (NSString*)certQualifiers:(int)certIndex;

- (BOOL)certSelfSigned:(int)certIndex;

- (NSData*)certSerialNumber:(int)certIndex;

- (NSString*)certSigAlgorithm:(int)certIndex;

- (int)certSource:(int)certIndex;

- (NSString*)certSubject:(int)certIndex;

- (NSString*)certSubjectAlternativeName:(int)certIndex;

- (NSData*)certSubjectKeyID:(int)certIndex;

- (NSString*)certSubjectRDN:(int)certIndex;

- (BOOL)certValid:(int)certIndex;

- (NSString*)certValidFrom:(int)certIndex;

- (NSString*)certValidTo:(int)certIndex;

Default Value

Remarks

This property includes a collection of certificates of the currently selected info.

CheckTrustedLists Property (OfficeVerifier Module)

Specifies whether the module should attempt to validate chain trust via a known Trusted List.

Syntax

Swift
Objective-C

public var checkTrustedLists: Bool {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=checkTrustedLists,setter=setCheckTrustedLists:) BOOL checkTrustedLists;

- (BOOL)checkTrustedLists;
- (void)setCheckTrustedLists :(BOOL)newCheckTrustedLists;

Default Value

False

Remarks

Set this property to true to enable the component to validate chain trust against an internal list of known Trusted Lists (such as EUTL).

CRLs Property (OfficeVerifier Module)

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

Syntax

Swift
Objective-C

public var crLs: Array<CRL> {
  get {...}
}


@property (nonatomic,readonly,assign,getter=CRLCount) int CRLCount;

- (int)CRLCount;

- (NSData*)CRLBytes:(int)cRLIndex;

- (NSData*)CRLCAKeyID:(int)cRLIndex;

- (int)CRLEntryCount:(int)cRLIndex;

- (long long)CRLHandle:(int)cRLIndex;

- (NSString*)CRLIssuer:(int)cRLIndex;

- (NSString*)CRLIssuerRDN:(int)cRLIndex;

- (NSString*)CRLLocation:(int)cRLIndex;

- (NSString*)CRLNextUpdate:(int)cRLIndex;

- (NSString*)CRLSigAlgorithm:(int)cRLIndex;

- (int)CRLSource:(int)cRLIndex;

- (NSData*)CRLTBS:(int)cRLIndex;

- (NSString*)CRLThisUpdate:(int)cRLIndex;

Default Value

Remarks

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

DocumentFormat Property (OfficeVerifier Module)

Defines the format of the Office document.

Syntax

Swift
Objective-C

public var documentFormat: OfficeVerifierDocumentFormats {
  get {...}
}

public enum OfficeVerifierDocumentFormats: Int32 {
  case odfUnknown = 0
  case odfBinary = 1
  case odfOpenXML = 2
  case odfOpenXPS = 3
  case odfOpenDocument = 4
}


@property (nonatomic,readonly,assign,getter=documentFormat) int documentFormat;

- (int)documentFormat;

Default Value

Remarks

This property contains the Office document format.


odfUnknown	`0`	Unknown document format
odfBinary	`1`	Binary Office document
odfOpenXML	`2`	OpenXML Office document
odfOpenXPS	`3`	OpenXPS document
odfOpenDocument	`4`	OpenOffice document

This property is read-only.

DocumentType Property (OfficeVerifier Module)

Defines the type of the Office document.

Syntax

Swift
Objective-C

public var documentType: String {
  get {...}
}


@property (nonatomic,readonly,assign,getter=documentType) NSString* documentType;

- (NSString*)documentType;

Default Value

Remarks

This property contains the Office document type.

This property is read-only.

FIPSMode Property (OfficeVerifier Module)

Reserved.

Syntax

Swift
Objective-C

public var fipsMode: Bool {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=FIPSMode,setter=setFIPSMode:) BOOL FIPSMode;

- (BOOL)FIPSMode;
- (void)setFIPSMode :(BOOL)newFIPSMode;

Default Value

False

Remarks

This property is reserved for future use.

IgnoreChainValidationErrors Property (OfficeVerifier Module)

Makes the module tolerant to chain validation errors.

Syntax

Swift
Objective-C

public var ignoreChainValidationErrors: Bool {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=ignoreChainValidationErrors,setter=setIgnoreChainValidationErrors:) BOOL ignoreChainValidationErrors;

- (BOOL)ignoreChainValidationErrors;
- (void)setIgnoreChainValidationErrors :(BOOL)newIgnoreChainValidationErrors;

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 Module)

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

Syntax

Swift
Objective-C

public var inputBytes: Data {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=inputBytes,setter=setInputBytes:) NSData* inputBytes;

- (NSData*)inputBytes;
- (void)setInputBytes :(NSData*)newInputBytes;

Remarks

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

InputFile Property (OfficeVerifier Module)

The path to the signed office document.

Syntax

Swift
Objective-C

public var inputFile: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=inputFile,setter=setInputFile:) NSString* inputFile;

- (NSString*)inputFile;
- (void)setInputFile :(NSString*)newInputFile;

Default Value

Remarks

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

KnownCertificates Property (OfficeVerifier Module)

Additional certificates for chain validation.

Syntax

Swift
Objective-C

public var knownCertificates: Array<Certificate> {
  get {...}
}


@property (nonatomic,readwrite,assign,getter=knownCertCount,setter=setKnownCertCount:) int knownCertCount;

- (int)knownCertCount;
- (void)setKnownCertCount :(int)newKnownCertCount;

- (NSData*)knownCertBytes:(int)knownCertIndex;

- (long long)knownCertHandle:(int)knownCertIndex;
- (void)setKnownCertHandle:(int)knownCertIndex :(long long)newKnownCertHandle;

Default Value

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 class manually.

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

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

KnownCRLs Property (OfficeVerifier Module)

Additional CRLs for chain validation.

Syntax

Swift
Objective-C

public var knownCRLs: Array<CRL> {
  get {...}
}


@property (nonatomic,readwrite,assign,getter=knownCRLCount,setter=setKnownCRLCount:) int knownCRLCount;

- (int)knownCRLCount;
- (void)setKnownCRLCount :(int)newKnownCRLCount;

- (NSData*)knownCRLBytes:(int)knownCRLIndex;

- (long long)knownCRLHandle:(int)knownCRLIndex;
- (void)setKnownCRLHandle:(int)knownCRLIndex :(long long)newKnownCRLHandle;

Default Value

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.

KnownOCSPs Property (OfficeVerifier Module)

Additional OCSP responses for chain validation.

Syntax

Swift
Objective-C

public var knownOCSPs: Array<OCSPResponse> {
  get {...}
}


@property (nonatomic,readwrite,assign,getter=knownOCSPCount,setter=setKnownOCSPCount:) int knownOCSPCount;

- (int)knownOCSPCount;
- (void)setKnownOCSPCount :(int)newKnownOCSPCount;

- (NSData*)knownOCSPBytes:(int)knownOCSPIndex;

- (long long)knownOCSPHandle:(int)knownOCSPIndex;
- (void)setKnownOCSPHandle:(int)knownOCSPIndex :(long long)newKnownOCSPHandle;

Default Value

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.

OCSPs Property (OfficeVerifier Module)

A collection of OCSP responses embedded into the signature.

Syntax

Swift
Objective-C

public var ocsPs: Array<OCSPResponse> {
  get {...}
}


@property (nonatomic,readonly,assign,getter=OCSPCount) int OCSPCount;

- (int)OCSPCount;

- (NSData*)OCSPBytes:(int)oCSPIndex;

- (int)OCSPEntryCount:(int)oCSPIndex;

- (long long)OCSPHandle:(int)oCSPIndex;

- (NSString*)OCSPIssuer:(int)oCSPIndex;

- (NSString*)OCSPIssuerRDN:(int)oCSPIndex;

- (NSString*)OCSPLocation:(int)oCSPIndex;

- (NSString*)OCSPProducedAt:(int)oCSPIndex;

- (NSString*)OCSPSigAlgorithm:(int)oCSPIndex;

- (int)OCSPSource:(int)oCSPIndex;

Default Value

Remarks

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

OfflineMode Property (OfficeVerifier Module)

Switches the module to offline mode.

Syntax

Swift
Objective-C

public var offlineMode: Bool {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=offlineMode,setter=setOfflineMode:) BOOL offlineMode;

- (BOOL)offlineMode;
- (void)setOfflineMode :(BOOL)newOfflineMode;

Default Value

False

Remarks

When working in offline mode, the class 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 the validation information included within the signature or provided via KnownCertificates, KnownCRLs, and other related properties.

OutputBytes Property (OfficeVerifier Module)

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

Syntax

Swift
Objective-C

public var outputBytes: Data {
  get {...}
}


@property (nonatomic,readonly,assign,getter=outputBytes) NSData* outputBytes;

- (NSData*)outputBytes;

Remarks

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

This property is read-only.

OutputFile Property (OfficeVerifier Module)

Defines where to save the modified signed document.

Syntax

Swift
Objective-C

public var outputFile: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=outputFile,setter=setOutputFile:) NSString* outputFile;

- (NSString*)outputFile;
- (void)setOutputFile :(NSString*)newOutputFile;

Default Value

Remarks

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

Profile Property (OfficeVerifier Module)

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

Syntax

Swift
Objective-C

public var profile: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=profile,setter=setProfile:) NSString* profile;

- (NSString*)profile;
- (void)setProfile :(NSString*)newProfile;

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 Module)

The proxy server settings.

Syntax

Swift
Objective-C

public var proxy: ProxySettings {
  get {...}
}


@property (nonatomic,readwrite,assign,getter=proxyAddress,setter=setProxyAddress:) NSString* proxyAddress;

- (NSString*)proxyAddress;
- (void)setProxyAddress :(NSString*)newProxyAddress;

@property (nonatomic,readwrite,assign,getter=proxyAuthentication,setter=setProxyAuthentication:) int proxyAuthentication;

- (int)proxyAuthentication;
- (void)setProxyAuthentication :(int)newProxyAuthentication;

@property (nonatomic,readwrite,assign,getter=proxyPassword,setter=setProxyPassword:) NSString* proxyPassword;

- (NSString*)proxyPassword;
- (void)setProxyPassword :(NSString*)newProxyPassword;

@property (nonatomic,readwrite,assign,getter=proxyPort,setter=setProxyPort:) int proxyPort;

- (int)proxyPort;
- (void)setProxyPort :(int)newProxyPort;

@property (nonatomic,readwrite,assign,getter=proxyProxyType,setter=setProxyProxyType:) int proxyProxyType;

- (int)proxyProxyType;
- (void)setProxyProxyType :(int)newProxyProxyType;

@property (nonatomic,readwrite,assign,getter=proxyRequestHeaders,setter=setProxyRequestHeaders:) NSString* proxyRequestHeaders;

- (NSString*)proxyRequestHeaders;
- (void)setProxyRequestHeaders :(NSString*)newProxyRequestHeaders;

@property (nonatomic,readwrite,assign,getter=proxyResponseBody,setter=setProxyResponseBody:) NSString* proxyResponseBody;

- (NSString*)proxyResponseBody;
- (void)setProxyResponseBody :(NSString*)newProxyResponseBody;

@property (nonatomic,readwrite,assign,getter=proxyResponseHeaders,setter=setProxyResponseHeaders:) NSString* proxyResponseHeaders;

- (NSString*)proxyResponseHeaders;
- (void)setProxyResponseHeaders :(NSString*)newProxyResponseHeaders;

@property (nonatomic,readwrite,assign,getter=proxyUseIPv6,setter=setProxyUseIPv6:) BOOL proxyUseIPv6;

- (BOOL)proxyUseIPv6;
- (void)setProxyUseIPv6 :(BOOL)newProxyUseIPv6;

@property (nonatomic,readwrite,assign,getter=proxyUsername,setter=setProxyUsername:) NSString* proxyUsername;

- (NSString*)proxyUsername;
- (void)setProxyUsername :(NSString*)newProxyUsername;

Default Value

Remarks

Use this property to tune up the proxy server settings.

RevocationCheck Property (OfficeVerifier Module)

Specifies the kind(s) of revocation check to perform for all chain certificates.

Syntax

Swift
Objective-C

public var revocationCheck: OfficeVerifierRevocationChecks {
  get {...}
  set {...}
}

public enum OfficeVerifierRevocationChecks: Int32 {
  case crcNone = 0
  case crcAuto = 1
  case crcAllCRL = 2
  case crcAllOCSP = 3
  case crcAllCRLAndOCSP = 4
  case crcAnyCRL = 5
  case crcAnyOCSP = 6
  case crcAnyCRLOrOCSP = 7
  case crcAnyOCSPOrCRL = 8
}


@property (nonatomic,readwrite,assign,getter=revocationCheck,setter=setRevocationCheck:) int revocationCheck;

- (int)revocationCheck;
- (void)setRevocationCheck :(int)newRevocationCheck;

Default Value

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 (CRLs) 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`	All provided CRL endpoints will be checked, and all checks must succeed.
crcAllOCSP	`3`	All provided OCSP endpoints will be checked, and all checks must succeed.
crcAllCRLAndOCSP	`4`	All provided CRL and OCSP endpoints will be checked, and all checks must succeed.
crcAnyCRL	`5`	All provided CRL endpoints will be checked, and at least one check must succeed.
crcAnyOCSP	`6`	All provided OCSP endpoints will be checked, and at least one check must succeed.
crcAnyCRLOrOCSP	`7`	All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first.
crcAnyOCSPOrCRL	`8`	All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first.

This setting controls the way the revocation checks are performed for every certificate in the chain. 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 the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

Note: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.

Note: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.

Signatures Property (OfficeVerifier Module)

All signatures found in the Office document.

Syntax

Swift
Objective-C

public var signatures: Array<OfficeSignature> {
  get {...}
}


@property (nonatomic,readonly,assign,getter=signatureCount) int signatureCount;

- (int)signatureCount;

- (int)signatureChainValidationDetails:(int)signatureIndex;

- (int)signatureChainValidationResult:(int)signatureIndex;

- (NSString*)signatureClaimedSigningTime:(int)signatureIndex;

- (int)signatureCompatibilityErrors:(int)signatureIndex;

- (BOOL)signatureContainsLongTermInfo:(int)signatureIndex;

- (BOOL)signatureCorePropertiesSigned:(int)signatureIndex;

- (BOOL)signatureDocumentSigned:(int)signatureIndex;

- (NSString*)signatureEntityLabel:(int)signatureIndex;

- (NSString*)signatureExpireTime:(int)signatureIndex;

- (long long)signatureHandle:(int)signatureIndex;

- (NSString*)signatureHashAlgorithm:(int)signatureIndex;

- (NSString*)signatureIssuerRDN:(int)signatureIndex;

- (NSString*)signatureLastArchivalTime:(int)signatureIndex;

- (int)signatureLevel:(int)signatureIndex;

- (NSString*)signaturePolicyHash:(int)signatureIndex;

- (NSString*)signaturePolicyHashAlgorithm:(int)signatureIndex;

- (NSString*)signaturePolicyID:(int)signatureIndex;

- (NSString*)signaturePolicyURI:(int)signatureIndex;

- (NSData*)signatureSerialNumber:(int)signatureIndex;

- (NSData*)signatureSignatureBytes:(int)signatureIndex;

- (NSString*)signatureSignatureInfoComments:(int)signatureIndex;

- (NSString*)signatureSignatureInfoText:(int)signatureIndex;

- (BOOL)signatureSignatureOriginSigned:(int)signatureIndex;

- (int)signatureSignatureType:(int)signatureIndex;

- (int)signatureSignatureValidationResult:(int)signatureIndex;

- (NSData*)signatureSubjectKeyID:(int)signatureIndex;

- (NSString*)signatureSubjectRDN:(int)signatureIndex;

- (BOOL)signatureTimestamped:(int)signatureIndex;

- (NSString*)signatureValidatedSigningTime:(int)signatureIndex;

- (NSString*)signatureValidationLog:(int)signatureIndex;

- (int)signatureXAdESVersion:(int)signatureIndex;

Default Value

Remarks

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

SignedParts Property (OfficeVerifier Module)

All signed parts or entries found in the Office signatures.

Syntax

Swift
Objective-C

public var signedParts: Array<OfficeSignedPart> {
  get {...}
}


@property (nonatomic,readonly,assign,getter=signedPartCount) int signedPartCount;

- (int)signedPartCount;

- (NSString*)signedPartContentType:(int)signedPartIndex;

- (NSString*)signedPartHashAlgorithm:(int)signedPartIndex;

- (BOOL)signedPartIsRelationshipPart:(int)signedPartIndex;

- (NSString*)signedPartPath:(int)signedPartIndex;

- (int)signedPartValidationResult:(int)signedPartIndex;

Default Value

Remarks

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

SocketSettings Property (OfficeVerifier Module)

Manages network connection settings.

Syntax

Swift
Objective-C

public var socketSettings: SocketSettings {
  get {...}
}


@property (nonatomic,readwrite,assign,getter=socketDNSMode,setter=setSocketDNSMode:) int socketDNSMode;

- (int)socketDNSMode;
- (void)setSocketDNSMode :(int)newSocketDNSMode;

@property (nonatomic,readwrite,assign,getter=socketDNSPort,setter=setSocketDNSPort:) int socketDNSPort;

- (int)socketDNSPort;
- (void)setSocketDNSPort :(int)newSocketDNSPort;

@property (nonatomic,readwrite,assign,getter=socketDNSQueryTimeout,setter=setSocketDNSQueryTimeout:) int socketDNSQueryTimeout;

- (int)socketDNSQueryTimeout;
- (void)setSocketDNSQueryTimeout :(int)newSocketDNSQueryTimeout;

@property (nonatomic,readwrite,assign,getter=socketDNSServers,setter=setSocketDNSServers:) NSString* socketDNSServers;

- (NSString*)socketDNSServers;
- (void)setSocketDNSServers :(NSString*)newSocketDNSServers;

@property (nonatomic,readwrite,assign,getter=socketDNSTotalTimeout,setter=setSocketDNSTotalTimeout:) int socketDNSTotalTimeout;

- (int)socketDNSTotalTimeout;
- (void)setSocketDNSTotalTimeout :(int)newSocketDNSTotalTimeout;

@property (nonatomic,readwrite,assign,getter=socketIncomingSpeedLimit,setter=setSocketIncomingSpeedLimit:) int socketIncomingSpeedLimit;

- (int)socketIncomingSpeedLimit;
- (void)setSocketIncomingSpeedLimit :(int)newSocketIncomingSpeedLimit;

@property (nonatomic,readwrite,assign,getter=socketLocalAddress,setter=setSocketLocalAddress:) NSString* socketLocalAddress;

- (NSString*)socketLocalAddress;
- (void)setSocketLocalAddress :(NSString*)newSocketLocalAddress;

@property (nonatomic,readwrite,assign,getter=socketLocalPort,setter=setSocketLocalPort:) int socketLocalPort;

- (int)socketLocalPort;
- (void)setSocketLocalPort :(int)newSocketLocalPort;

@property (nonatomic,readwrite,assign,getter=socketOutgoingSpeedLimit,setter=setSocketOutgoingSpeedLimit:) int socketOutgoingSpeedLimit;

- (int)socketOutgoingSpeedLimit;
- (void)setSocketOutgoingSpeedLimit :(int)newSocketOutgoingSpeedLimit;

@property (nonatomic,readwrite,assign,getter=socketTimeout,setter=setSocketTimeout:) int socketTimeout;

- (int)socketTimeout;
- (void)setSocketTimeout :(int)newSocketTimeout;

@property (nonatomic,readwrite,assign,getter=socketUseIPv6,setter=setSocketUseIPv6:) BOOL socketUseIPv6;

- (BOOL)socketUseIPv6;
- (void)setSocketUseIPv6 :(BOOL)newSocketUseIPv6;

Default Value

Remarks

Use this property to tune up network connection parameters.

Timestamps Property (OfficeVerifier Module)

Contains a collection of timestamps for the processed document.

Syntax

Swift
Objective-C

public var timestamps: Array<TimestampInfo> {
  get {...}
}


@property (nonatomic,readonly,assign,getter=timestampCount) int timestampCount;

- (int)timestampCount;

- (long long)timestampAccuracy:(int)timestampIndex;

- (NSData*)timestampBytes:(int)timestampIndex;

- (int)timestampCertificateIndex:(int)timestampIndex;

- (int)timestampChainValidationDetails:(int)timestampIndex;

- (int)timestampChainValidationResult:(int)timestampIndex;

- (BOOL)timestampContainsLongTermInfo:(int)timestampIndex;

- (NSString*)timestampEntityLabel:(int)timestampIndex;

- (NSString*)timestampHashAlgorithm:(int)timestampIndex;

- (NSString*)timestampParentEntity:(int)timestampIndex;

- (NSData*)timestampSerialNumber:(int)timestampIndex;

- (NSString*)timestampTime:(int)timestampIndex;

- (int)timestampTimestampType:(int)timestampIndex;

- (NSString*)timestampTSAName:(int)timestampIndex;

- (NSString*)timestampValidationLog:(int)timestampIndex;

- (int)timestampValidationResult:(int)timestampIndex;

Default Value

Remarks

Use this property to access the timestamps included in the processed document.

TLSClientChain Property (OfficeVerifier Module)

The TLS client certificate chain.

Syntax

Swift
Objective-C

public var tlsClientChain: Array<Certificate> {
  get {...}
}


@property (nonatomic,readwrite,assign,getter=TLSClientCertCount,setter=setTLSClientCertCount:) int TLSClientCertCount;

- (int)TLSClientCertCount;
- (void)setTLSClientCertCount :(int)newTLSClientCertCount;

- (NSData*)TLSClientCertBytes:(int)tLSClientCertIndex;

- (long long)TLSClientCertHandle:(int)tLSClientCertIndex;
- (void)setTLSClientCertHandle:(int)tLSClientCertIndex :(long long)newTLSClientCertHandle;

Default Value

Remarks

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

Use the CertificateStorage or CertificateManager components to import the certificate from a file, system store, or PKCS11 device.

TLSServerChain Property (OfficeVerifier Module)

The TLS server's certificate chain.

Syntax

Swift
Objective-C

public var tlsServerChain: Array<Certificate> {
  get {...}
}


@property (nonatomic,readonly,assign,getter=TLSServerCertCount) int TLSServerCertCount;

- (int)TLSServerCertCount;

- (NSData*)TLSServerCertBytes:(int)tLSServerCertIndex;

- (NSString*)TLSServerCertFingerprint:(int)tLSServerCertIndex;

- (long long)TLSServerCertHandle:(int)tLSServerCertIndex;

- (NSString*)TLSServerCertIssuer:(int)tLSServerCertIndex;

- (NSString*)TLSServerCertIssuerRDN:(int)tLSServerCertIndex;

- (NSString*)TLSServerCertKeyAlgorithm:(int)tLSServerCertIndex;

- (int)TLSServerCertKeyBits:(int)tLSServerCertIndex;

- (int)TLSServerCertKeyUsage:(int)tLSServerCertIndex;

- (BOOL)TLSServerCertSelfSigned:(int)tLSServerCertIndex;

- (NSData*)TLSServerCertSerialNumber:(int)tLSServerCertIndex;

- (NSString*)TLSServerCertSigAlgorithm:(int)tLSServerCertIndex;

- (NSString*)TLSServerCertSubject:(int)tLSServerCertIndex;

- (NSString*)TLSServerCertSubjectRDN:(int)tLSServerCertIndex;

- (NSString*)TLSServerCertValidFrom:(int)tLSServerCertIndex;

- (NSString*)TLSServerCertValidTo:(int)tLSServerCertIndex;

Default Value

Remarks

Use this property to access the certificate chain sent by the TLS server. This property is ready to read when the TLSCertValidate event is fired by the client component.

TLSSettings Property (OfficeVerifier Module)

Manages TLS layer settings.

Syntax

Swift
Objective-C

public var tlsSettings: TLSSettings {
  get {...}
}


@property (nonatomic,readwrite,assign,getter=TLSAutoValidateCertificates,setter=setTLSAutoValidateCertificates:) BOOL TLSAutoValidateCertificates;

- (BOOL)TLSAutoValidateCertificates;
- (void)setTLSAutoValidateCertificates :(BOOL)newTLSAutoValidateCertificates;

@property (nonatomic,readwrite,assign,getter=TLSBaseConfiguration,setter=setTLSBaseConfiguration:) int TLSBaseConfiguration;

- (int)TLSBaseConfiguration;
- (void)setTLSBaseConfiguration :(int)newTLSBaseConfiguration;

@property (nonatomic,readwrite,assign,getter=TLSCiphersuites,setter=setTLSCiphersuites:) NSString* TLSCiphersuites;

- (NSString*)TLSCiphersuites;
- (void)setTLSCiphersuites :(NSString*)newTLSCiphersuites;

@property (nonatomic,readwrite,assign,getter=TLSClientAuth,setter=setTLSClientAuth:) int TLSClientAuth;

- (int)TLSClientAuth;
- (void)setTLSClientAuth :(int)newTLSClientAuth;

@property (nonatomic,readwrite,assign,getter=TLSECCurves,setter=setTLSECCurves:) NSString* TLSECCurves;

- (NSString*)TLSECCurves;
- (void)setTLSECCurves :(NSString*)newTLSECCurves;

@property (nonatomic,readwrite,assign,getter=TLSExtensions,setter=setTLSExtensions:) NSString* TLSExtensions;

- (NSString*)TLSExtensions;
- (void)setTLSExtensions :(NSString*)newTLSExtensions;

@property (nonatomic,readwrite,assign,getter=TLSForceResumeIfDestinationChanges,setter=setTLSForceResumeIfDestinationChanges:) BOOL TLSForceResumeIfDestinationChanges;

- (BOOL)TLSForceResumeIfDestinationChanges;
- (void)setTLSForceResumeIfDestinationChanges :(BOOL)newTLSForceResumeIfDestinationChanges;

@property (nonatomic,readwrite,assign,getter=TLSPreSharedIdentity,setter=setTLSPreSharedIdentity:) NSString* TLSPreSharedIdentity;

- (NSString*)TLSPreSharedIdentity;
- (void)setTLSPreSharedIdentity :(NSString*)newTLSPreSharedIdentity;

@property (nonatomic,readwrite,assign,getter=TLSPreSharedKey,setter=setTLSPreSharedKey:) NSString* TLSPreSharedKey;

- (NSString*)TLSPreSharedKey;
- (void)setTLSPreSharedKey :(NSString*)newTLSPreSharedKey;

@property (nonatomic,readwrite,assign,getter=TLSPreSharedKeyCiphersuite,setter=setTLSPreSharedKeyCiphersuite:) NSString* TLSPreSharedKeyCiphersuite;

- (NSString*)TLSPreSharedKeyCiphersuite;
- (void)setTLSPreSharedKeyCiphersuite :(NSString*)newTLSPreSharedKeyCiphersuite;

@property (nonatomic,readwrite,assign,getter=TLSRenegotiationAttackPreventionMode,setter=setTLSRenegotiationAttackPreventionMode:) int TLSRenegotiationAttackPreventionMode;

- (int)TLSRenegotiationAttackPreventionMode;
- (void)setTLSRenegotiationAttackPreventionMode :(int)newTLSRenegotiationAttackPreventionMode;

@property (nonatomic,readwrite,assign,getter=TLSRevocationCheck,setter=setTLSRevocationCheck:) int TLSRevocationCheck;

- (int)TLSRevocationCheck;
- (void)setTLSRevocationCheck :(int)newTLSRevocationCheck;

@property (nonatomic,readwrite,assign,getter=TLSSSLOptions,setter=setTLSSSLOptions:) int TLSSSLOptions;

- (int)TLSSSLOptions;
- (void)setTLSSSLOptions :(int)newTLSSSLOptions;

@property (nonatomic,readwrite,assign,getter=TLSTLSMode,setter=setTLSTLSMode:) int TLSTLSMode;

- (int)TLSTLSMode;
- (void)setTLSTLSMode :(int)newTLSTLSMode;

@property (nonatomic,readwrite,assign,getter=TLSUseExtendedMasterSecret,setter=setTLSUseExtendedMasterSecret:) BOOL TLSUseExtendedMasterSecret;

- (BOOL)TLSUseExtendedMasterSecret;
- (void)setTLSUseExtendedMasterSecret :(BOOL)newTLSUseExtendedMasterSecret;

@property (nonatomic,readwrite,assign,getter=TLSUseSessionResumption,setter=setTLSUseSessionResumption:) BOOL TLSUseSessionResumption;

- (BOOL)TLSUseSessionResumption;
- (void)setTLSUseSessionResumption :(BOOL)newTLSUseSessionResumption;

@property (nonatomic,readwrite,assign,getter=TLSVersions,setter=setTLSVersions:) int TLSVersions;

- (int)TLSVersions;
- (void)setTLSVersions :(int)newTLSVersions;

Default Value

Remarks

Use this property to tune up the TLS layer parameters.

TrustedCertificates Property (OfficeVerifier Module)

A list of trusted certificates for chain validation.

Syntax

Swift
Objective-C

public var trustedCertificates: Array<Certificate> {
  get {...}
}


@property (nonatomic,readwrite,assign,getter=trustedCertCount,setter=setTrustedCertCount:) int trustedCertCount;

- (int)trustedCertCount;
- (void)setTrustedCertCount :(int)newTrustedCertCount;

- (NSData*)trustedCertBytes:(int)trustedCertIndex;

- (long long)trustedCertHandle:(int)trustedCertIndex;
- (void)setTrustedCertHandle:(int)trustedCertIndex :(long long)newTrustedCertHandle;

Default Value

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 as that of the 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.

ValidationMoment Property (OfficeVerifier Module)

Specifies the validation moment.

Syntax

Swift
Objective-C

public var validationMoment: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=validationMoment,setter=setValidationMoment:) NSString* validationMoment;

- (NSString*)validationMoment;
- (void)setValidationMoment :(NSString*)newValidationMoment;

Default Value

Remarks

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

Close Method (OfficeVerifier Module)

Closes an opened document.

Syntax

Swift
Objective-C

public func close(saveChanges: Bool) throws -> Void

- (void)close:(BOOL)saveChanges;

Remarks

Use this method to close a previously opened document. Set SaveChanges to true to apply any changes made.

Config Method (OfficeVerifier Module)

Sets or retrieves a configuration setting.

Syntax

Swift
Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)configurationString;

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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 Module)

Performs an additional action.

Syntax

Swift
Objective-C

public func doAction(actionID: String, actionParams: String) throws -> String

- (NSString*)doAction:(NSString*)actionID :(NSString*)actionParams;

Remarks

DoAction is a generic method available in every class. 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 (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Open Method (OfficeVerifier Module)

Opens a document for verifying or removing signatures.

Syntax

Swift
Objective-C

public func open(editMode: Bool) throws -> Void

- (void)open:(BOOL)editMode;

Remarks

Use this method to open a document for verifying or removing signatures. When finished, call Close to complete or discard the operation.

Set EditMode to true to open the document in edit mode (only useful if you intend to remove signatures).

Reset Method (OfficeVerifier Module)

Resets the component settings.

Syntax

Swift
Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

Reset is a generic method available in every class.

Revalidate Method (OfficeVerifier Module)

Revalidates a signature in accordance with current settings.

Syntax

Swift
Objective-C

public func revalidate(sigLabel: String) throws -> Void

- (void)revalidate:(NSString*)sigLabel;

Remarks

Use this method to re-validate a signature in the opened Office document.

SelectInfo Method (OfficeVerifier Module)

Select signature information for a specific entity.

Syntax

Swift
Objective-C

public func selectInfo(entityLabel: String, infoType: Int32, clearSelection: Bool) throws -> Void

- (void)selectInfo:(NSString*)entityLabel :(int)infoType :(BOOL)clearSelection;

Remarks

Use this method to select (or filter) signature-related information for a specific signature element.

Provide the unique label of the entity that you are interested in via the EntityLabel parameter. Use one of the following filters, or their combination, to specify what information you are interested in:


sitEntity	`1`	Select the current entity
sitParentEntity	`2`	Select the parent entity of the current entity
sitTimestamps	`4`	Select all timestamps covering the current entity
sitSignatures	`8`	Select all signatures covering the current entity
sitSigningChain	`16`	Select the signing chain of the current entity
sitEmbeddedCertificates	`256`	Select all certificates embedded in the current entity
sitEmbeddedCRLs	`512`	Select all CRLs embedded in the current entity
sitEmbeddedOCSPs	`1024`	Select all OCSP responses embedded in the current entity
sitEmbeddedRevInfo	`1792`	Select the whole pack of embedded revocation information (certificates, CRLs and OCSPs)
sitUsedCertificates	`4096`	Select all the certificates used to validate this entity's chain
sitUsedCRLs	`8192`	Select all the CRLs used to validate this entity's chain
sitUsedOCSPs	`16384`	Select all the OCSP responses used to validate this entity's chain
sitUsedRevInfo	`28672`	Select the whole pack of revocation information used to validate this entity's chain (certificates, CRLs, OCSP responses)
sitAttributes	`65536`	Select this entity's CMS attributes
sitReferences	`131072`	Select this entity's XML references
sitSignedParts	`262144`	Select this entity's signed parts

Following the call, the relevant pieces of information will be copied to the respective component properties (Certificates, CRLs, OCSPs). Note that you can accumulate information in the properties by making repeated calls to SelectInfo and keeping ClearSelection set to false.

This method is useful if you would like to read/display detailed information about a particular signature or timestamp.

Unsign Method (OfficeVerifier Module)

Deletes a signature from the document.

Syntax

Swift
Objective-C

public func unsign(sigLabel: String) throws -> Void

- (void)unsign:(NSString*)sigLabel;

Remarks

Use this method to delete an existing signature from the document. Use SigLabel parameter to specify the signature to be removed.

Verify Method (OfficeVerifier Module)

Verifies the whole document.

Syntax

Swift
Objective-C

public func verify() throws -> Void

- (void)verify;

Remarks

Use this method to verify the document.

ChainElementDownload Event (OfficeVerifier Module)

Fires when there is a need to download a chain element from an online source.

Syntax

Swift
Objective-C

func onChainElementDownload(kind: Int32, certRDN: String, caCertRDN: String, location: String, action: inout Int32)

- (void)onChainElementDownload:(int)kind :(NSString*)certRDN :(NSString*)CACertRDN :(NSString*)location :(int*)action;

Remarks

Subscribe to this event to be notified about validation element retrievals. Use the Action parameter to suppress the download if required.


veaAuto	`0`	Handle the action automatically (the default behaviour)
veaContinue	`1`	Accept the request implied by the event (accept the certificate, allow the object retrieval)
veaReject	`2`	Reject the request implied by the event (reject the certificate, disallow the object retrieval)
veaAcceptNow	`3`	Accept the validated certificate immediately
veaAbortNow	`4`	Abort the validation, reject the certificate


cekUnknown	`0`	Unknown or unsupported element type
cekCertificate	`1`	An X.509 certificate
cekCRL	`2`	A CRL
cekOCSP	`3`	An OCSP response

ChainElementNeeded Event (OfficeVerifier Module)

Fires when an element required to validate the chain was not located.

Syntax

Swift
Objective-C

func onChainElementNeeded(kind: Int32, certRDN: String, caCertRDN: String)

- (void)onChainElementNeeded:(int)kind :(NSString*)certRDN :(NSString*)CACertRDN;

Remarks

Subscribe to this event to be notified about missing validation elements. Use the KnownCRLs, KnownCertificates, and KnownOCSPs properties in the event handler to provide the missing piece.


cekUnknown	`0`	Unknown or unsupported element type
cekCertificate	`1`	An X.509 certificate
cekCRL	`2`	A CRL
cekOCSP	`3`	An OCSP response

ChainElementStore Event (OfficeVerifier Module)

This event is fired when a chain element (certificate, CRL, or OCSP response) should be stored along with a signature.

Syntax

Swift
Objective-C

func onChainElementStore(kind: Int32, body: Data, uri: inout String)

- (void)onChainElementStore:(int)kind :(NSData*)body :(NSString**)URI;

Remarks

This event could occur if you are verifying XAdES-C form or higher. The Body parameter contains the element in binary form that should be stored along with a signature. Use the URI parameter to provide an URI of the stored element.


cekUnknown	`0`	Unknown or unsupported element type
cekCertificate	`1`	An X.509 certificate
cekCRL	`2`	A CRL
cekOCSP	`3`	An OCSP response

ChainValidated Event (OfficeVerifier Module)

Reports the completion of a certificate chain validation.

Syntax

Swift
Objective-C

func onChainValidated(index: Int32, entityLabel: String, subjectRDN: String, validationResult: Int32, validationDetails: Int32, cancel: inout Bool)

- (void)onChainValidated:(int)index :(NSString*)entityLabel :(NSString*)subjectRDN :(int)validationResult :(int)validationDetails :(int*)cancel;

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.


cvtValid	`0`	The chain is valid
cvtValidButUntrusted	`1`	The chain is valid, but the root certificate is not trusted
cvtInvalid	`2`	The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature)
cvtCantBeEstablished	`3`	The 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.


cvrBadData	`0x0001`	One or more certificates in the validation path are malformed
cvrRevoked	`0x0002`	One or more certificates are revoked
cvrNotYetValid	`0x0004`	One or more certificates are not yet valid
cvrExpired	`0x0008`	One or more certificates are expired
cvrInvalidSignature	`0x0010`	A certificate contains a non-valid digital signature
cvrUnknownCA	`0x0020`	A CA certificate for one or more certificates has not been found (chain incomplete)
cvrCAUnauthorized	`0x0040`	One of the CA certificates are not authorized to act as CA
cvrCRLNotVerified	`0x0080`	One or more CRLs could not be verified
cvrOCSPNotVerified	`0x0100`	One or more OCSP responses could not be verified
cvrIdentityMismatch	`0x0200`	The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate
cvrNoKeyUsage	`0x0400`	A mandatory key usage is not enabled in one of the chain certificates
cvrBlocked	`0x0800`	One or more certificates are blocked
cvrFailure	`0x1000`	General validation failure
cvrChainLoop	`0x2000`	Chain loop: one of the CA certificates recursively signs itself
cvrWeakAlgorithm	`0x4000`	A weak algorithm is used in one of certificates or revocation elements
cvrUserEnforced	`0x8000`	The chain was considered invalid following intervention from a user code

ChainValidationProgress Event (OfficeVerifier Module)

This event is fired multiple times during chain validation to report various stages of the validation procedure.

Syntax

Swift
Objective-C

func onChainValidationProgress(eventKind: String, certRDN: String, caCertRDN: String, action: inout Int32)

- (void)onChainValidationProgress:(NSString*)eventKind :(NSString*)certRDN :(NSString*)CACertRDN :(int*)action;

Remarks

Subscribe to this event to be notified about chain validation progress. Use the Action parameter to alter the validation flow.

The EventKind parameter reports the nature of the event being reported. The CertRDN and CACertRDN parameters report the distinguished names of the certificates that are relevant for the event invocation (one or both can be empty, depending on EventKind). Use the Action parameter to adjust the validation flow.


veaAuto	`0`	Handle the action automatically (the default behaviour)
veaContinue	`1`	Accept the request implied by the event (accept the certificate, allow the object retrieval)
veaReject	`2`	Reject the request implied by the event (reject the certificate, disallow the object retrieval)
veaAcceptNow	`3`	Accept the validated certificate immediately
veaAbortNow	`4`	Abort the validation, reject the certificate

DocumentLoaded Event (OfficeVerifier Module)

This event is fired when the document has been loaded into memory.

Syntax

Swift
Objective-C

func onDocumentLoaded(cancel: inout Bool)

- (void)onDocumentLoaded:(int*)cancel;

Remarks

The handler for this event is a good place to check document properties, which may be useful when preparing the signature, for example, the document format.

Set Cancel to true to terminate document processing on this stage.

Error Event (OfficeVerifier Module)

Information about errors during the signature validation.

Syntax

Swift
Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)description;

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 Module)

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

Syntax

Swift
Objective-C

func onNotification(eventID: String, eventParam: String)

- (void)onNotification:(NSString*)eventID :(NSString*)eventParam;

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. 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 the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

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


DocumentLoaded	Reports 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.
RetrieveQualifyingProperties	TBD
SignaturesLoaded	Notifies the application that the component has finished loading signatures.
BeforeTimestamp	This event is fired before a timestamp is requested from the timestamping authority. Use the event handler to modify TSA and HTTP settings.
TimestampError	This event is only fired if the class failed to obtain a timestamp from the timestamping authority. The EventParam parameter contains extended error info.
TimestampRequest	A timestamp is requested from the custom timestamping authority. This event is only fired if TimestampServer was set to a virtual:// URI. The EventParam parameter contains the TSP request (or the plain hash, depending on the value provided to TimestampServer), in base16, that needs to be sent to the TSA. Use the event handler to send the request to the TSA. Upon receiving the response, assign it, in base16, to the TimestampResponse configuration property.

SignatureFound Event (OfficeVerifier Module)

Signifies the start of signature validation.

Syntax

Swift
Objective-C

func onSignatureFound(index: Int32, entityLabel: String, issuerRDN: String, serialNumber: Data, subjectKeyID: Data, certFound: Bool, validateSignature: inout Bool, validateChain: inout Bool)

- (void)onSignatureFound:(int)index :(NSString*)entityLabel :(NSString*)issuerRDN :(NSData*)serialNumber :(NSData*)subjectKeyID :(BOOL)certFound :(int*)validateSignature :(int*)validateChain;

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 parameter is set to True if the class has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via the KnownCertificates property.

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

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

SignatureValidated Event (OfficeVerifier Module)

Marks the completion of the signature validation routine.

Syntax

Swift
Objective-C

func onSignatureValidated(index: Int32, entityLabel: String, issuerRDN: String, serialNumber: Data, subjectKeyID: Data, validationResult: Int32, cancel: inout Bool)

- (void)onSignatureValidated:(int)index :(NSString*)entityLabel :(NSString*)issuerRDN :(NSData*)serialNumber :(NSData*)subjectKeyID :(int)validationResult :(int*)cancel;

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.


svtValid	`0`	The signature is valid
svtUnknown	`1`	Signature validity is unknown
svtCorrupted	`2`	The signature is corrupted
svtSignerNotFound	`3`	Failed to acquire the signing certificate. The signature cannot be validated.
svtFailure	`4`	General failure
svtReferenceCorrupted	`5`	Reference corrupted (XML-based signatures only)

TimestampFound Event (OfficeVerifier Module)

Signifies the start of a timestamp validation routine.

Syntax

Swift
Objective-C

func onTimestampFound(index: Int32, entityLabel: String, issuerRDN: String, serialNumber: Data, subjectKeyID: Data, certFound: Bool, validateTimestamp: inout Bool, validateChain: inout Bool)

- (void)onTimestampFound:(int)index :(NSString*)entityLabel :(NSString*)issuerRDN :(NSData*)serialNumber :(NSData*)subjectKeyID :(BOOL)certFound :(int*)validateTimestamp :(int*)validateChain;

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.

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 the and properties respectively.

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

TimestampValidated Event (OfficeVerifier Module)

Reports the completion of the timestamp validation routine.

Syntax

Swift
Objective-C

func onTimestampValidated(index: Int32, entityLabel: String, issuerRDN: String, serialNumber: Data, subjectKeyID: Data, time: String, validationResult: Int32, chainValidationResult: Int32, chainValidationDetails: Int32, cancel: inout Bool)

- (void)onTimestampValidated:(int)index :(NSString*)entityLabel :(NSString*)issuerRDN :(NSData*)serialNumber :(NSData*)subjectKeyID :(NSString*)time :(int)validationResult :(int)chainValidationResult :(int)chainValidationDetails :(int*)cancel;

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.


svtValid	`0`	The signature is valid
svtUnknown	`1`	Signature validity is unknown
svtCorrupted	`2`	The signature is corrupted
svtSignerNotFound	`3`	Failed to acquire the signing certificate. The signature cannot be validated.
svtFailure	`4`	General failure
svtReferenceCorrupted	`5`	Reference corrupted (XML-based signatures only)

TLSCertNeeded Event (OfficeVerifier Module)

Fires when a remote TLS party requests a client certificate.

Syntax

Swift
Objective-C

func onTLSCertNeeded(host: String, caNames: String)

- (void)onTLSCertNeeded:(NSString*)host :(NSString*)CANames;

Remarks

This event fires to notify the implementation that a remote TLS server has requested a client certificate. The Host parameter identifies the host that makes a request, and the CANames parameter (optional, according to the TLS spec) advises on the accepted issuing CAs.

Use the TLSClientChain property in response to this event to provide the requested certificate. Please make sure the client certificate includes the associated private key. Note that you may set the certificates before the connection without waiting for this event to fire.

This event is preceded by the TLSHandshake event for the given host and, if the certificate was accepted, succeeded by the TLSEstablished event.

TLSCertValidate Event (OfficeVerifier Module)

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

Syntax

Swift
Objective-C

func onTLSCertValidate(serverHost: String, serverIP: String, accept: inout Bool)

- (void)onTLSCertValidate:(NSString*)serverHost :(NSString*)serverIP :(int*)accept;

Remarks

This event is fired during a TLS handshake. Use the TLSServerChain property to access the certificate chain. In general, classes 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 class, and can be adjusted if needed.

TLSEstablished Event (OfficeVerifier Module)

Fires when a TLS handshake with Host successfully completes.

Syntax

Swift
Objective-C

func onTLSEstablished(host: String, version: String, ciphersuite: String, connectionId: Data, abort: inout Bool)

- (void)onTLSEstablished:(NSString*)host :(NSString*)version :(NSString*)ciphersuite :(NSData*)connectionId :(int*)abort;

Remarks

The class uses this event to notify the application about a successful completion of a TLS handshake.

The Version, Ciphersuite, and ConnectionId parameters indicate the security parameters of the new connection. Use the Abort parameter if you need to terminate the connection at this stage.

TLSHandshake Event (OfficeVerifier Module)

Fires when a new TLS handshake is initiated, before the handshake commences.

Syntax

Swift
Objective-C

func onTLSHandshake(host: String, abort: inout Bool)

- (void)onTLSHandshake:(NSString*)host :(int*)abort;

Remarks

The class uses this event to notify the application about the start of a new TLS handshake to Host. If the handshake is successful, this event will be followed by the TLSEstablished event. If the server chooses to request a client certificate, the TLSCertNeeded event will also be fired.

TLSShutdown Event (OfficeVerifier Module)

Reports the graceful closure of a TLS connection.

Syntax

Swift
Objective-C

func onTLSShutdown(host: String)

- (void)onTLSShutdown:(NSString*)host;

Remarks

This event notifies the application about the closure of an earlier established TLS connection. Note that only graceful connection closures are reported.

Certificate Type

Encapsulates an individual X.509 certificate.

Remarks

This type keeps and provides access to X.509 certificate details.

The following fields are available:

Fields

bytes
Data (read-only)
Default Value: ""

Returns the raw certificate data in DER format.

ca
Bool
Default Value: False

Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.

Set this property when generating a new certificate to have its Basic Constraints extension generated automatically.

caKeyID
Data (read-only)
Default Value: ""

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

Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.

This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

certType
CertTypes (read-only)
Default Value: 0

Returns the type of the entity contained in the Certificate object.

A Certificate object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.

Use the CertificateManager class to load or create new certificate and certificate requests objects.

crlDistributionPoints
String
Default Value: ""

Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.

Use this property when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.

The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

curve
String
Default Value: ""

Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.


SB_EC_SECP112R1	`SECP112R1`
SB_EC_SECP112R2	`SECP112R2`
SB_EC_SECP128R1	`SECP128R1`
SB_EC_SECP128R2	`SECP128R2`
SB_EC_SECP160K1	`SECP160K1`
SB_EC_SECP160R1	`SECP160R1`
SB_EC_SECP160R2	`SECP160R2`
SB_EC_SECP192K1	`SECP192K1`
SB_EC_SECP192R1	`SECP192R1`
SB_EC_SECP224K1	`SECP224K1`
SB_EC_SECP224R1	`SECP224R1`
SB_EC_SECP256K1	`SECP256K1`
SB_EC_SECP256R1	`SECP256R1`
SB_EC_SECP384R1	`SECP384R1`
SB_EC_SECP521R1	`SECP521R1`
SB_EC_SECT113R1	`SECT113R1`
SB_EC_SECT113R2	`SECT113R2`
SB_EC_SECT131R1	`SECT131R1`
SB_EC_SECT131R2	`SECT131R2`
SB_EC_SECT163K1	`SECT163K1`
SB_EC_SECT163R1	`SECT163R1`
SB_EC_SECT163R2	`SECT163R2`
SB_EC_SECT193R1	`SECT193R1`
SB_EC_SECT193R2	`SECT193R2`
SB_EC_SECT233K1	`SECT233K1`
SB_EC_SECT233R1	`SECT233R1`
SB_EC_SECT239K1	`SECT239K1`
SB_EC_SECT283K1	`SECT283K1`
SB_EC_SECT283R1	`SECT283R1`
SB_EC_SECT409K1	`SECT409K1`
SB_EC_SECT409R1	`SECT409R1`
SB_EC_SECT571K1	`SECT571K1`
SB_EC_SECT571R1	`SECT571R1`
SB_EC_PRIME192V1	`PRIME192V1`
SB_EC_PRIME192V2	`PRIME192V2`
SB_EC_PRIME192V3	`PRIME192V3`
SB_EC_PRIME239V1	`PRIME239V1`
SB_EC_PRIME239V2	`PRIME239V2`
SB_EC_PRIME239V3	`PRIME239V3`
SB_EC_PRIME256V1	`PRIME256V1`
SB_EC_C2PNB163V1	`C2PNB163V1`
SB_EC_C2PNB163V2	`C2PNB163V2`
SB_EC_C2PNB163V3	`C2PNB163V3`
SB_EC_C2PNB176W1	`C2PNB176W1`
SB_EC_C2TNB191V1	`C2TNB191V1`
SB_EC_C2TNB191V2	`C2TNB191V2`
SB_EC_C2TNB191V3	`C2TNB191V3`
SB_EC_C2ONB191V4	`C2ONB191V4`
SB_EC_C2ONB191V5	`C2ONB191V5`
SB_EC_C2PNB208W1	`C2PNB208W1`
SB_EC_C2TNB239V1	`C2TNB239V1`
SB_EC_C2TNB239V2	`C2TNB239V2`
SB_EC_C2TNB239V3	`C2TNB239V3`
SB_EC_C2ONB239V4	`C2ONB239V4`
SB_EC_C2ONB239V5	`C2ONB239V5`
SB_EC_C2PNB272W1	`C2PNB272W1`
SB_EC_C2PNB304W1	`C2PNB304W1`
SB_EC_C2TNB359V1	`C2TNB359V1`
SB_EC_C2PNB368W1	`C2PNB368W1`
SB_EC_C2TNB431R1	`C2TNB431R1`
SB_EC_NISTP192	`NISTP192`
SB_EC_NISTP224	`NISTP224`
SB_EC_NISTP256	`NISTP256`
SB_EC_NISTP384	`NISTP384`
SB_EC_NISTP521	`NISTP521`
SB_EC_NISTB163	`NISTB163`
SB_EC_NISTB233	`NISTB233`
SB_EC_NISTB283	`NISTB283`
SB_EC_NISTB409	`NISTB409`
SB_EC_NISTB571	`NISTB571`
SB_EC_NISTK163	`NISTK163`
SB_EC_NISTK233	`NISTK233`
SB_EC_NISTK283	`NISTK283`
SB_EC_NISTK409	`NISTK409`
SB_EC_NISTK571	`NISTK571`
SB_EC_GOSTCPTEST	`GOSTCPTEST`
SB_EC_GOSTCPA	`GOSTCPA`
SB_EC_GOSTCPB	`GOSTCPB`
SB_EC_GOSTCPC	`GOSTCPC`
SB_EC_GOSTCPXCHA	`GOSTCPXCHA`
SB_EC_GOSTCPXCHB	`GOSTCPXCHB`
SB_EC_BRAINPOOLP160R1	`BRAINPOOLP160R1`
SB_EC_BRAINPOOLP160T1	`BRAINPOOLP160T1`
SB_EC_BRAINPOOLP192R1	`BRAINPOOLP192R1`
SB_EC_BRAINPOOLP192T1	`BRAINPOOLP192T1`
SB_EC_BRAINPOOLP224R1	`BRAINPOOLP224R1`
SB_EC_BRAINPOOLP224T1	`BRAINPOOLP224T1`
SB_EC_BRAINPOOLP256R1	`BRAINPOOLP256R1`
SB_EC_BRAINPOOLP256T1	`BRAINPOOLP256T1`
SB_EC_BRAINPOOLP320R1	`BRAINPOOLP320R1`
SB_EC_BRAINPOOLP320T1	`BRAINPOOLP320T1`
SB_EC_BRAINPOOLP384R1	`BRAINPOOLP384R1`
SB_EC_BRAINPOOLP384T1	`BRAINPOOLP384T1`
SB_EC_BRAINPOOLP512R1	`BRAINPOOLP512R1`
SB_EC_BRAINPOOLP512T1	`BRAINPOOLP512T1`
SB_EC_CURVE25519	`CURVE25519`
SB_EC_CURVE448	`CURVE448`

fingerprint
String (read-only)
Default Value: ""

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

While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.

friendlyName
String (read-only)
Default Value: ""

Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.

handle
Int64
Default Value: 0

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

hashAlgorithm
String
Default Value: ""

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use to find out the hash algorithm that is part of the certificate signature.


SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_MD2	`MD2`
SB_HASH_ALGORITHM_MD4	`MD4`
SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_CRC32	`CRC32`
SB_HASH_ALGORITHM_SSL3	`SSL3`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_POLY1305	`POLY1305`
SB_HASH_ALGORITHM_SHA3_224	`SHA3_224`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`
SB_HASH_ALGORITHM_BLAKE2S_128	`BLAKE2S_128`
SB_HASH_ALGORITHM_BLAKE2S_160	`BLAKE2S_160`
SB_HASH_ALGORITHM_BLAKE2S_224	`BLAKE2S_224`
SB_HASH_ALGORITHM_BLAKE2S_256	`BLAKE2S_256`
SB_HASH_ALGORITHM_BLAKE2B_160	`BLAKE2B_160`
SB_HASH_ALGORITHM_BLAKE2B_256	`BLAKE2B_256`
SB_HASH_ALGORITHM_BLAKE2B_384	`BLAKE2B_384`
SB_HASH_ALGORITHM_BLAKE2B_512	`BLAKE2B_512`
SB_HASH_ALGORITHM_SHAKE_128	`SHAKE_128`
SB_HASH_ALGORITHM_SHAKE_256	`SHAKE_256`
SB_HASH_ALGORITHM_SHAKE_128_LEN	`SHAKE_128_LEN`
SB_HASH_ALGORITHM_SHAKE_256_LEN	`SHAKE_256_LEN`

issuer
String (read-only)
Default Value: ""

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via .

issuerRDN
String
Default Value: ""

A list of Property=Value pairs that uniquely identify the certificate issuer.

Example: /C=US/O=Nationwide CA/CN=Web Certification Authority

keyAlgorithm
String
Default Value: "0"

Specifies the public key algorithm of this certificate.


SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION	`rsaEncryption`
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION	`md2withRSAEncryption`
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION	`md5withRSAEncryption`
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION	`sha1withRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA	`id-dsa`
SB_CERT_ALGORITHM_ID_DSA_SHA1	`id-dsa-with-sha1`
SB_CERT_ALGORITHM_DH_PUBLIC	`dhpublicnumber`
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION	`sha224WithRSAEncryption`
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION	`sha256WithRSAEncryption`
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION	`sha384WithRSAEncryption`
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION	`sha512WithRSAEncryption`
SB_CERT_ALGORITHM_ID_RSAPSS	`id-RSASSA-PSS`
SB_CERT_ALGORITHM_ID_RSAOAEP	`id-RSAES-OAEP`
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160	`ripemd160withRSA`
SB_CERT_ALGORITHM_ID_ELGAMAL	`elGamal`
SB_CERT_ALGORITHM_SHA1_ECDSA	`ecdsa-with-SHA1`
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA	`ecdsa-recommended`
SB_CERT_ALGORITHM_SHA224_ECDSA	`ecdsa-with-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA	`ecdsa-with-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA	`ecdsa-with-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA	`ecdsa-with-SHA512`
SB_CERT_ALGORITHM_EC	`id-ecPublicKey`
SB_CERT_ALGORITHM_SPECIFIED_ECDSA	`ecdsa-specified`
SB_CERT_ALGORITHM_GOST_R3410_1994	`id-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3410_2001	`id-GostR3410-2001`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994	`id-GostR3411-94-with-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001	`id-GostR3411-94-with-GostR3410-2001`
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN	`ecdsa-plain-SHA1`
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN	`ecdsa-plain-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN	`ecdsa-plain-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN	`ecdsa-plain-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN	`ecdsa-plain-SHA512`
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN	`ecdsa-plain-RIPEMD160`
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION	`whirlpoolWithRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA_SHA224	`id-dsa-with-sha224`
SB_CERT_ALGORITHM_ID_DSA_SHA256	`id-dsa-with-sha256`
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA	`id-ecdsa-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA	`id-ecdsa-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA	`id-ecdsa-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA	`id-ecdsa-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-512`
SB_CERT_ALGORITHM_ID_DSA_SHA3_224	`id-dsa-with-sha3-224`
SB_CERT_ALGORITHM_ID_DSA_SHA3_256	`id-dsa-with-sha3-256`
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA	`id-ecdsa-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA	`id-ecdsa-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA	`id-ecdsa-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA	`id-ecdsa-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA	`id-ecdsa-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA	`id-ecdsa-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA	`id-ecdsa-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA	`id-ecdsa-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b512`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224	`id-dsa-with-blake2s224`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256	`id-dsa-with-blake2s256`
SB_CERT_ALGORITHM_EDDSA_ED25519	`id-Ed25519`
SB_CERT_ALGORITHM_EDDSA_ED448	`id-Ed448`
SB_CERT_ALGORITHM_EDDSA_ED25519_PH	`id-Ed25519ph`
SB_CERT_ALGORITHM_EDDSA_ED448_PH	`id-Ed448ph`
SB_CERT_ALGORITHM_EDDSA	`id-EdDSA`
SB_CERT_ALGORITHM_EDDSA_SIGNATURE	`id-EdDSA-sig`

Use the , , and properties to get more details about the key the certificate contains.

keyBits
Int32 (read-only)
Default Value: 0

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the or property would typically contain auxiliary values, and therefore be longer.

keyFingerprint
String (read-only)
Default Value: ""

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

Note that the key fingerprint is different from the certificate fingerprint accessible via the property. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

keyUsage
Int32
Default Value: 0

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:


ckuUnknown	`0x00000`	Unknown key usage
ckuDigitalSignature	`0x00001`	Digital signature
ckuNonRepudiation	`0x00002`	Non-repudiation
ckuKeyEncipherment	`0x00004`	Key encipherment
ckuDataEncipherment	`0x00008`	Data encipherment
ckuKeyAgreement	`0x00010`	Key agreement
ckuKeyCertSign	`0x00020`	Certificate signing
ckuCRLSign	`0x00040`	Revocation signing
ckuEncipherOnly	`0x00080`	Encipher only
ckuDecipherOnly	`0x00100`	Decipher only
ckuServerAuthentication	`0x00200`	Server authentication
ckuClientAuthentication	`0x00400`	Client authentication
ckuCodeSigning	`0x00800`	Code signing
ckuEmailProtection	`0x01000`	Email protection
ckuTimeStamping	`0x02000`	Timestamping
ckuOCSPSigning	`0x04000`	OCSP signing
ckuSmartCardLogon	`0x08000`	Smartcard logon
ckuKeyPurposeClientAuth	`0x10000`	Kerberos - client authentication
ckuKeyPurposeKDC	`0x20000`	Kerberos - KDC

Set this property before generating the certificate to propagate the key usage flags to the new certificate.

keyValid
Bool (read-only)
Default Value: False

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

ocspLocations
String
Default Value: ""

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Set this property before calling the certificate manager's Generate method to propagate it to the new certificate.

The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

ocspNoCheck
Bool
Default Value: False

Accessor to the value of the certificate's ocsp-no-check extension.

origin
Int32 (read-only)
Default Value: 0

Returns the location that the certificate was taken or loaded from.

policyIDs
String
Default Value: ""

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.

Set this property when generating a certificate to propagate the policies information to the new certificate.

The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.

privateKeyBytes
Data (read-only)
Default Value: ""

Returns the certificate's private key in DER-encoded format. It is normal for this property to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices.

privateKeyExists
Bool (read-only)
Default Value: False

Indicates whether the certificate has a usable private key associated with it. If it is set to True, the certificate can be used for private key operations, such as signing or decryption.

This property is independent from , and can be set to True even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.

privateKeyExtractable
Bool (read-only)
Default Value: False

Indicates whether the private key is extractable (exportable).

publicKeyBytes
Data (read-only)
Default Value: ""

Contains the certificate's public key in DER format.

This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.

qualified
Bool (read-only)
Default Value: False

Indicates whether the certificate is qualified.

This property is set to True if the certificate is confirmed by a Trusted List to be qualified.

qualifiedStatements
QualifiedStatementsTypes
Default Value: 0

Returns a simplified qualified status of the certificate.

qualifiers
String (read-only)
Default Value: ""

A list of qualifiers.

Contains a comma-separated list of qualifier aliases for the certificate, for example QCP-n-qscd,QCWithSSCD.

selfSigned
Bool (read-only)
Default Value: False

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

serialNumber
Data
Default Value: ""

Returns the certificate's serial number.

The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.

sigAlgorithm
String (read-only)
Default Value: ""

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

A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.

source
PKISources (read-only)
Default Value: 0

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

subject
String (read-only)
Default Value: ""

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via .

subjectAlternativeName
String
Default Value: ""

Returns or sets the value of the Subject Alternative Name extension of the certificate.

Subject alternative names are used to provide additional names that are impractical to store in the main field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.

The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator.

subjectKeyID
Data
Default Value: ""

Contains a unique identifier of the certificate's cryptographic key.

Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.

The and properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

subjectRDN
String
Default Value: ""

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.

Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.

valid
Bool (read-only)
Default Value: False

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

validFrom
String
Default Value: ""

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

validTo
String
Default Value: ""

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

Constructors

public init(stream: )

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

public init()

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.

The following fields are available:

Fields

bytes
Data (read-only)
Default Value: ""

Returns the raw CRL data in DER format.

caKeyID
Data
Default Value: ""

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

entryCount
Int32 (read-only)
Default Value: 0

Returns the number of certificate status entries in the CRL.

handle
Int64
Default Value: 0

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

issuer
String (read-only)
Default Value: ""

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

issuerRDN
String (read-only)
Default Value: ""

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

location
String (read-only)
Default Value: ""

The URL that the CRL was downloaded from.

nextUpdate
String
Default Value: ""

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

sigAlgorithm
String
Default Value: "0"

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

source
PKISources (read-only)
Default Value: 0

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

tbs
Data (read-only)
Default Value: ""

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

thisUpdate
String
Default Value: ""

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

Constructors

public init()

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 (CRLs).

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

The following fields are available:

Fields

bytes
Data (read-only)
Default Value: ""

A buffer containing the raw OCSP response data.

entryCount
Int32 (read-only)
Default Value: 0

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

handle
Int64
Default Value: 0

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

issuer
String (read-only)
Default Value: ""

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

issuerRDN
String (read-only)
Default Value: ""

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

location
String (read-only)
Default Value: ""

The location of the OCSP responder.

producedAt
String
Default Value: ""

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

sigAlgorithm
String
Default Value: "0"

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

source
PKISources (read-only)
Default Value: 0

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

Constructors

public init()

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. class stores on of them.

The following fields are available:

Fields

chainValidationDetails
Int32 (read-only)
Default Value: 0

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

Returns a bit mask of the following options:


cvrBadData	`0x0001`	One or more certificates in the validation path are malformed
cvrRevoked	`0x0002`	One or more certificates are revoked
cvrNotYetValid	`0x0004`	One or more certificates are not yet valid
cvrExpired	`0x0008`	One or more certificates are expired
cvrInvalidSignature	`0x0010`	A certificate contains a non-valid digital signature
cvrUnknownCA	`0x0020`	A CA certificate for one or more certificates has not been found (chain incomplete)
cvrCAUnauthorized	`0x0040`	One of the CA certificates are not authorized to act as CA
cvrCRLNotVerified	`0x0080`	One or more CRLs could not be verified
cvrOCSPNotVerified	`0x0100`	One or more OCSP responses could not be verified
cvrIdentityMismatch	`0x0200`	The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate
cvrNoKeyUsage	`0x0400`	A mandatory key usage is not enabled in one of the chain certificates
cvrBlocked	`0x0800`	One or more certificates are blocked
cvrFailure	`0x1000`	General validation failure
cvrChainLoop	`0x2000`	Chain loop: one of the CA certificates recursively signs itself
cvrWeakAlgorithm	`0x4000`	A weak algorithm is used in one of certificates or revocation elements
cvrUserEnforced	`0x8000`	The chain was considered invalid following intervention from a user code

chainValidationResult
ChainValidities (read-only)
Default Value: 0

The outcome of a certificate chain validation routine.

Available options:


cvtValid	`0`	The chain is valid
cvtValidButUntrusted	`1`	The chain is valid, but the root certificate is not trusted
cvtInvalid	`2`	The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature)
cvtCantBeEstablished	`3`	The 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.

claimedSigningTime
String
Default Value: ""

The signing time from the signer's computer.

Use this property to provide the signature production time. The claimed time is not supported by a trusted source; it may be inaccurate, forfeited, or wrong, and as such is usually taken for informational purposes only by verifiers. Use timestamp servers to embed verifiable trusted timestamps. The time is in UTC.

compatibilityErrors
Int32 (read-only)
Default Value: 0

Returns compatibility errors encountered during validation.

Use this property to get specific compatibility errors encountered during validation. Unlike chain validation details, compatibility errors indicate violations by the signature of the assumed signature level/profile. For example, BES signatures are required to contain the signing time attribute. A prospective BES signature without such attribute will invoke a compatibility error.

containsLongTermInfo
Bool (read-only)
Default Value: False

Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).

corePropertiesSigned
Bool
Default Value: False

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

documentSigned
Bool
Default Value: False

Returns True if the signature covers the document itself.

entityLabel
String (read-only)
Default Value: ""

Use this property to get the signature entity label.

This property returns a string label that uniquely identifies the signature. The label can be used to establish the signature target in the SignatureFound event or to select the signing chain via the SelectInfo method.

expireTime
String (read-only)
Default Value: ""

Specifies the signature expiration time in UTC.

handle
Int64
Default Value: 0

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

hashAlgorithm
String
Default Value: "Unknown"

The hash algorithm used for signing.


SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`

issuerRDN
String (read-only)
Default Value: ""

The Relative Distinguished Name of the signing certificate's issuer.

A collection of information, in the form of [OID, Value] pairs, about the company that issued the signing certificate.

lastArchivalTime
String (read-only)
Default Value: ""

Indicates the most recent archival time of an archived signature

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

level
AdESSignatureLevels
Default Value: 6

Specifies which level or form of XAdES should be produced.

Use this property to specify the level or form of advanced electronic signature to be produced.

Use the Generic value to produce XML-DSIG signature.

The supported levels and forms are:


aslUnknown	`0`	Unknown signature level
aslGeneric	`1`	Generic (this value applicable to XAdES signature only and corresponds to XML-DSIG signature)
aslBaselineB	`2`	Baseline B (B-B, basic)
aslBaselineT	`3`	Baseline T (B-T, timestamped)
aslBaselineLT	`4`	Baseline LT (B-LT, long-term)
aslBaselineLTA	`5`	Baseline LTA (B-LTA, long-term with archived timestamp)
aslBES	`6`	BES (Basic Electronic Signature)
aslEPES	`7`	EPES (Electronic Signature with an Explicit Policy)
aslT	`8`	T (Timestamped)
aslC	`9`	C (T with revocation references)
aslX	`10`	X (C with SigAndRefs timestamp or RefsOnly timestamp) (this value applicable to XAdES signature only)
aslXType1	`11`	X Type 1 (C with an ES-C timestamp) (this value applicable to CAdES signature only)
aslXType2	`12`	X Type 2 (C with a CertsAndCRLs timestamp) (this value applicable to CAdES signature only)
aslXL	`13`	X-L (X with revocation values) (this value applicable to XAdES signature only)
aslXLType1	`14`	X-L Type 1 (C with revocation values and an ES-C timestamp) (this value applicable to CAdES signature only)
aslXLType2	`15`	X-L Type 2 (C with revocation values and a CertsAndCRLs timestamp) (this value applicable to CAdES signature only)
aslA	`16`	A (archived)
aslExtendedBES	`17`	Extended BES
aslExtendedEPES	`18`	Extended EPES
aslExtendedT	`19`	Extended T
aslExtendedC	`20`	Extended C
aslExtendedX	`21`	Extended X (this value applicable to XAdES signature only)
aslExtendedXType1	`22`	Extended X (type 1) (this value applicable to CAdES signature only)
aslExtendedXType2	`23`	Extended X (type 2) (this value applicable to CAdES signature only)
aslExtendedXLong	`24`	Extended X-Long (this value applicable to XAdES signature only)
aslExtendedXL	`25`	Extended X-L (this value applicable to XAdES signature only)
aslExtendedXLType1	`26`	Extended XL (type 1) (this value applicable to CAdES signature only)
aslExtendedXLType2	`27`	Extended XL (type 2) (this value applicable to CAdES signature only)
aslExtendedA	`28`	Extended A

* For XAdES form from XAdES v1.1.1 use either BES or EPES form values ** Extended forms are supported starting from XAdES v1.3.2

policyHash
String
Default Value: ""

The signature policy hash value.

Use this property to get the signature policy hash from EPES signatures

policyHashAlgorithm
String
Default Value: ""

The algorithm that was used to calculate the signature policy hash

Use this property to get or set the hash algorithm used to calculate the signature policy hash. Read the actual hash value from .


SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_MD2	`MD2`
SB_HASH_ALGORITHM_MD4	`MD4`
SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_CRC32	`CRC32`
SB_HASH_ALGORITHM_SSL3	`SSL3`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_POLY1305	`POLY1305`
SB_HASH_ALGORITHM_SHA3_224	`SHA3_224`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`
SB_HASH_ALGORITHM_BLAKE2S_128	`BLAKE2S_128`
SB_HASH_ALGORITHM_BLAKE2S_160	`BLAKE2S_160`
SB_HASH_ALGORITHM_BLAKE2S_224	`BLAKE2S_224`
SB_HASH_ALGORITHM_BLAKE2S_256	`BLAKE2S_256`
SB_HASH_ALGORITHM_BLAKE2B_160	`BLAKE2B_160`
SB_HASH_ALGORITHM_BLAKE2B_256	`BLAKE2B_256`
SB_HASH_ALGORITHM_BLAKE2B_384	`BLAKE2B_384`
SB_HASH_ALGORITHM_BLAKE2B_512	`BLAKE2B_512`
SB_HASH_ALGORITHM_SHAKE_128	`SHAKE_128`
SB_HASH_ALGORITHM_SHAKE_256	`SHAKE_256`
SB_HASH_ALGORITHM_SHAKE_128_LEN	`SHAKE_128_LEN`
SB_HASH_ALGORITHM_SHAKE_256_LEN	`SHAKE_256_LEN`

policyID
String
Default Value: ""

The policy ID that was included or to be included into the signature.

Use this property to retrieve the signature policy identifier from EPES signatures.

policyURI
String
Default Value: ""

The signature policy URI that was included in the signature.

Use this property to set or retrieve the URI of the signature policy from EPES signatures.

serialNumber
Data (read-only)
Default Value: ""

The serial number of the signing certificate.

signatureBytes
Data (read-only)
Default Value: ""

Returns the binary representation of the Office signature.

signatureInfoComments
String
Default Value: ""

Contains the comments for the SignatureInfoText.

signatureInfoText
String
Default Value: ""

Contains the text of the signature info.

signatureOriginSigned
Bool
Default Value: False

Returns True if the signature origin is signed.

signatureType
OfficeSignatureTypes
Default Value: 0

Specifies the type of this signature.


ostDefault	`0`
ostBinaryCryptoAPI	`1`
ostBinaryXML	`2`
ostOpenXML	`3`
ostOpenXPS	`4`
ostOpenDocument	`5`

signatureValidationResult
SignatureValidities (read-only)
Default Value: 0

The outcome of the cryptographic signature validation.

The following signature validity values are supported:


svtValid	`0`	The signature is valid
svtUnknown	`1`	Signature validity is unknown
svtCorrupted	`2`	The signature is corrupted
svtSignerNotFound	`3`	Failed to acquire the signing certificate. The signature cannot be validated.
svtFailure	`4`	General failure
svtReferenceCorrupted	`5`	Reference corrupted (XML-based signatures only)

subjectKeyID
Data (read-only)
Default Value: ""

Contains the subject key identifier of the signing certificate.

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 by a SHA-1 hash of the bit string of the subject public key.

subjectRDN
String (read-only)
Default Value: ""

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.

timestamped
Bool (read-only)
Default Value: False

Use this property to establish whether the signature contains an embedded timestamp.

validatedSigningTime
String (read-only)
Default Value: ""

Contains the certified signing time.

Use this property to obtain the signing time as certified by a timestamp from a trusted timestamping authority. This property is only non-empty if there was a valid timestamp included in the signature.

returns a non-trusted signing time from the signer's computer.

Both times are in UTC.

validationLog
String (read-only)
Default Value: ""

Contains the complete log of the certificate validation routine.

Use this property to access the chain validation log produced by the class. 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.

xAdESVersion
XAdESVersions
Default Value: 3

Specifies XAdES version.

This property specifies the version of the XAdES specification the signature should comply with.

The supported vesions are:


xavUnknown	`0`	Unknown
xav111	`1`	XAdES v1.1.1
xav122	`2`	XAdES v1.2.2
xav132	`3`	XAdES v1.3.2
xav141	`4`	XAdES v1.4.1 (aka v1.4.2)

Constructors

public init()

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; class contains a single one of them.

The following fields are available:

Fields

contentType
String (read-only)
Default Value: ""

Specifies the content type of this signed part.

hashAlgorithm
String (read-only)
Default Value: "Unknown"

The hash algorithm used for signing.


SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`

The hash algorithm used for signing.


SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`

isRelationshipPart
Bool (read-only)
Default Value: False

Specifies whether this signed part is a relationship part.

path
String (read-only)
Default Value: ""

The path to this signed part in the document package.

validationResult
SignatureValidities (read-only)
Default Value: 0

The outcome of the cryptographic signature validation.

The following signature validity values are supported:


svtValid	`0`	The signature is valid
svtUnknown	`1`	Signature validity is unknown
svtCorrupted	`2`	The signature is corrupted
svtSignerNotFound	`3`	Failed to acquire the signing certificate. The signature cannot be validated.
svtFailure	`4`	General failure
svtReferenceCorrupted	`5`	Reference corrupted (XML-based signatures only)

Constructors

public init()

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.

The following fields are available:

Fields

address
String
Default Value: ""

The IP address of the proxy server.

authentication
ProxyAuthTypes
Default Value: 0

The authentication type used by the proxy server.


patNoAuthentication	`0`
patBasic	`1`
patDigest	`2`
patNTLM	`3`

password
String
Default Value: ""

The password to authenticate to the proxy server.

port
Int32
Default Value: 0

The port on the proxy server to connect to.

proxyType
ProxyTypes
Default Value: 0

The type of the proxy server.


cptNone	`0`
cptSocks4	`1`
cptSocks5	`2`
cptWebTunnel	`3`
cptHTTP	`4`

requestHeaders
String
Default Value: ""

Contains HTTP request headers for WebTunnel and HTTP proxy.

responseBody
String
Default Value: ""

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

responseHeaders
String
Default Value: ""

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

useIPv6
Bool
Default Value: False

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

username
String
Default Value: ""

Specifies the username credential for proxy authentication.

Constructors

public init()

Creates a new ProxySettings object.

SocketSettings Type

A container for the socket settings.

Remarks

This type is a container for socket-layer parameters.

The following fields are available:

Fields

dnsMode
DNSResolveModes
Default Value: 0

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


dmAuto	`0`
dmPlatform	`1`
dmOwn	`2`
dmOwnSecure	`3`

dnsPort
Int32
Default Value: 0

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

dnsQueryTimeout
Int32
Default Value: 0

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

dnsServers
String
Default Value: ""

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

dnsTotalTimeout
Int32
Default Value: 0

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

incomingSpeedLimit
Int32
Default Value: 0

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

localAddress
String
Default Value: ""

The local network interface to bind the socket to.

localPort
Int32
Default Value: 0

The local port number to bind the socket to.

outgoingSpeedLimit
Int32
Default Value: 0

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

timeout
Int32
Default Value: 60000

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
Bool
Default Value: False

Enables or disables IP protocol version 6.

Constructors

public init()

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.

The following fields are available:

Accuracy

Bytes

CertificateIndex

ChainValidationDetails

ChainValidationResult

Fields

accuracy
Int64 (read-only)
Default Value: 0

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

bytes
Data (read-only)
Default Value: ""

Returns the raw timestamp data in DER format.

certificateIndex
Int32 (read-only)
Default Value: -1

Returns the index of the TSA certificate in the Certificates collection.

Use this property to look up the TSA certificate in the Certificates collection.

chainValidationDetails
Int32 (read-only)
Default Value: 0

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

Returns a bit mask of the following options:


cvrBadData	`0x0001`	One or more certificates in the validation path are malformed
cvrRevoked	`0x0002`	One or more certificates are revoked
cvrNotYetValid	`0x0004`	One or more certificates are not yet valid
cvrExpired	`0x0008`	One or more certificates are expired
cvrInvalidSignature	`0x0010`	A certificate contains a non-valid digital signature
cvrUnknownCA	`0x0020`	A CA certificate for one or more certificates has not been found (chain incomplete)
cvrCAUnauthorized	`0x0040`	One of the CA certificates are not authorized to act as CA
cvrCRLNotVerified	`0x0080`	One or more CRLs could not be verified
cvrOCSPNotVerified	`0x0100`	One or more OCSP responses could not be verified
cvrIdentityMismatch	`0x0200`	The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate
cvrNoKeyUsage	`0x0400`	A mandatory key usage is not enabled in one of the chain certificates
cvrBlocked	`0x0800`	One or more certificates are blocked
cvrFailure	`0x1000`	General validation failure
cvrChainLoop	`0x2000`	Chain loop: one of the CA certificates recursively signs itself
cvrWeakAlgorithm	`0x4000`	A weak algorithm is used in one of certificates or revocation elements
cvrUserEnforced	`0x8000`	The chain was considered invalid following intervention from a user code

chainValidationResult
ChainValidities (read-only)
Default Value: 0

The outcome of a certificate chain validation routine.

Available options:


cvtValid	`0`	The chain is valid
cvtValidButUntrusted	`1`	The chain is valid, but the root certificate is not trusted
cvtInvalid	`2`	The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature)
cvtCantBeEstablished	`3`	The 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.

containsLongTermInfo
Bool (read-only)
Default Value: False

Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).

entityLabel
String (read-only)
Default Value: ""

Use this property to get the timestamp entity label.

This property returns a string label that uniquely identifies the timestamp. The label can be used to establish the signature target in the SignatureFound event or to select the signing chain via the SelectInfo method.

hashAlgorithm
String (read-only)
Default Value: ""

Returns the timestamp's hash algorithm.


SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_MD2	`MD2`
SB_HASH_ALGORITHM_MD4	`MD4`
SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_CRC32	`CRC32`
SB_HASH_ALGORITHM_SSL3	`SSL3`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_POLY1305	`POLY1305`
SB_HASH_ALGORITHM_SHA3_224	`SHA3_224`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`
SB_HASH_ALGORITHM_BLAKE2S_128	`BLAKE2S_128`
SB_HASH_ALGORITHM_BLAKE2S_160	`BLAKE2S_160`
SB_HASH_ALGORITHM_BLAKE2S_224	`BLAKE2S_224`
SB_HASH_ALGORITHM_BLAKE2S_256	`BLAKE2S_256`
SB_HASH_ALGORITHM_BLAKE2B_160	`BLAKE2B_160`
SB_HASH_ALGORITHM_BLAKE2B_256	`BLAKE2B_256`
SB_HASH_ALGORITHM_BLAKE2B_384	`BLAKE2B_384`
SB_HASH_ALGORITHM_BLAKE2B_512	`BLAKE2B_512`
SB_HASH_ALGORITHM_SHAKE_128	`SHAKE_128`
SB_HASH_ALGORITHM_SHAKE_256	`SHAKE_256`
SB_HASH_ALGORITHM_SHAKE_128_LEN	`SHAKE_128_LEN`
SB_HASH_ALGORITHM_SHAKE_256_LEN	`SHAKE_256_LEN`

parentEntity
String (read-only)
Default Value: ""

Use this property to get the label of the timestamp's parent entity.

This property references the EntityLabel of the object that the timestamp covers, typically a signature.

serialNumber
Data (read-only)
Default Value: ""

Returns the timestamp's serial number.

time
String (read-only)
Default Value: ""

The time point incorporated into the timestamp.

timestampType
Int32 (read-only)
Default Value: 0

Returns the type of the timestamp.

Available options:


tstUnknown	`0`
tstLegacy	`1`	Supported by: Authenticode components
tstTrusted	`2`	Supported by: Authenticode components
tstGeneric	`3`	Supported by: CAdES components
tstESC	`4`	Supported by: CAdES components
tstContent	`5`	Supported by: CAdES components
tstCertsAndCRLs	`6`	Supported by: CAdES components
tstArchive	`7`	Archive timestamp. Supported by: ASiC, CAdES, JAdES, Office, SOAP, XAdES components
tstArchive2	`8`	Archive v2 timestamp. Supported by: ASiC, CAdES components
tstArchive3	`9`	Archive v3 timestamp. Supported by: ASiC, CAdES components
tstIndividualDataObjects	`10`	Individual data objects timetamp. Supported by: ASiC, Office, SOAP, XAdES components
tstAllDataObjects	`11`	All data objects timestamp. Supported by: ASiC, Office, SOAP, XAdES components
tstSignature	`12`	Signature timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components
tstRefsOnly	`13`	RefsOnly timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components
tstSigAndRefs	`14`	SigAndRefs timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components
tstSignedData	`15`	SignedData timestamp. Supported by: JAdES components
tstArchive141	`16`	Archive timestamp v1.4.1. Supported by: ASiC, Office, SOAP, XAdES components

Not all of the above timestamp types can be supported by a specific signature technology used (CAdES, PDF, XAdES).

tsaName
String (read-only)
Default Value: ""

This value uniquely identifies the Timestamp Authority (TSA).

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

validationLog
String (read-only)
Default Value: ""

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

validationResult
SignatureValidities (read-only)
Default Value: 0

Contains the timestamp validation outcome.

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


svtValid	`0`	The signature is valid
svtUnknown	`1`	Signature validity is unknown
svtCorrupted	`2`	The signature is corrupted
svtSignerNotFound	`3`	Failed to acquire the signing certificate. The signature cannot be validated.
svtFailure	`4`	General failure
svtReferenceCorrupted	`5`	Reference corrupted (XML-based signatures only)

Constructors

public init()

Creates a new TimestampInfo object with default field values.

TLSSettings Type

A container for TLS connection settings.

Remarks

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

The following fields are available:

AutoValidateCertificates

ForceResumeIfDestinationChanges

PreSharedIdentity

PreSharedKey

PreSharedKeyCiphersuite

RenegotiationAttackPreventionMode

RevocationCheck

SSLOptions

TLSMode

UseExtendedMasterSecret

UseSessionResumption

Versions

Fields

autoValidateCertificates
Bool
Default Value: True

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

baseConfiguration
SecureTransportPredefinedConfigurations
Default Value: 0

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


stpcDefault	`0`
stpcCompatible	`1`
stpcComprehensiveInsecure	`2`
stpcHighlySecure	`3`

ciphersuites
String
Default Value: ""

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, allowing all ciphersuites to be blanketly enabled or disabled at once.

Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by . 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

clientAuth
ClientAuthTypes
Default Value: 0

Enables or disables certificate-based client authentication.

Set this property to true to tune up the client authentication type:


ccatNoAuth	`0`
ccatRequestCert	`1`
ccatRequireCert	`2`

ecCurves
String
Default Value: ""

Defines the elliptic curves to enable.

extensions
String
Default Value: ""

Provides access to TLS extensions.

forceResumeIfDestinationChanges
Bool
Default Value: False

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

preSharedIdentity
String
Default Value: ""

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

preSharedKey
String
Default Value: ""

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

preSharedKeyCiphersuite
String
Default Value: ""

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

renegotiationAttackPreventionMode
RenegotiationAttackPreventionModes
Default Value: 2

Selects the renegotiation attack prevention mechanism.

The following options are available:


crapmCompatible	`0`	TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled).
crapmStrict	`1`	Renegotiation attack prevention is enabled and enforced.
crapmAuto	`2`	Automatically choose whether to enable or disable renegotiation attack prevention.

revocationCheck
RevocationCheckKinds
Default Value: 1

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`	All provided CRL endpoints will be checked, and all checks must succeed.
crcAllOCSP	`3`	All provided OCSP endpoints will be checked, and all checks must succeed.
crcAllCRLAndOCSP	`4`	All provided CRL and OCSP endpoints will be checked, and all checks must succeed.
crcAnyCRL	`5`	All provided CRL endpoints will be checked, and at least one check must succeed.
crcAnyOCSP	`6`	All provided OCSP endpoints will be checked, and at least one check must succeed.
crcAnyCRLOrOCSP	`7`	All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first.
crcAnyOCSPOrCRL	`8`	All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first.

Note: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.

sslOptions
Int32
Default Value: 16

Various SSL (TLS) protocol options, set of


cssloExpectShutdownMessage	`0x001`	Wait for the close-notify message when shutting down the connection
cssloOpenSSLDTLSWorkaround	`0x002`	(DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions
cssloDisableKexLengthAlignment	`0x004`	Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it.
cssloForceUseOfClientCertHashAlg	`0x008`	Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it.
cssloAutoAddServerNameExtension	`0x010`	Automatically add the server name extension when known
cssloAcceptTrustedSRPPrimesOnly	`0x020`	Accept trusted SRP primes only
cssloDisableSignatureAlgorithmsExtension	`0x040`	Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it.
cssloIntolerateHigherProtocolVersions	`0x080`	(server option) Do not allow fallback from TLS versions higher than currently enabled
cssloStickToPrefCertHashAlg	`0x100`	Stick to preferred certificate hash algorithms
cssloNoImplicitTLS12Fallback	`0x200`	Disable implicit TLS 1.3 to 1.2 fallbacks
cssloUseHandshakeBatches	`0x400`	Send the handshake message as large batches rather than individually

tlsMode
SSLModes
Default Value: 0

Specifies the TLS mode to use.


smDefault	`0`
smNoTLS	`1`	Do not use TLS
smExplicitTLS	`2`	Connect to the server without any encryption and then request an SSL session.
smImplicitTLS	`3`	Connect to the specified port, and establish the SSL session at once.
smMixedTLS	`4`	Connect to the specified port, and establish the SSL session at once, but allow plain data.

useExtendedMasterSecret
Bool
Default Value: False

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

useSessionResumption
Bool
Default Value: False

Enables or disables the TLS session resumption capability.

versions
Int32
Default Value: 16

The SSL/TLS versions to enable by default.


csbSSL2	`0x01`	SSL 2
csbSSL3	`0x02`	SSL 3
csbTLS1	`0x04`	TLS 1.0
csbTLS11	`0x08`	TLS 1.1
csbTLS12	`0x10`	TLS 1.2
csbTLS13	`0x20`	TLS 1.3

Constructors

public init()

Creates a new TLSSettings object.

Config Settings (OfficeVerifier Module)

The class 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 class, access to these internal properties is provided through the Config method.

OfficeVerifier Config Settings

AddAllDataObjectsTimestamp: Whether to add all data objects timestamp during signing.

If this property is set to True, the all data objects timestamp (xades:AllDataObjectsTimeStamp element) will be added.

AsyncDocumentID: Specifies the document ID for SignAsyncEnd() call.

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. This value helps ASiCSigner identify the correct signature in the returned batch of responses. If using batched requests, make sure to set this property to the same value on both pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

ChainCurrentCACert: Returns the current CA certificate.

This property returns the CA certificate that is used on the current step.

ChainCurrentCert: Returns the certificate that is currently being validated.

Use this property to obtain the body of the certificate that is currently being validated.

ChainCurrentCRL: Returns the current CRL.

Returns the CRL object that is currently being processed.

ChainCurrentCRLSize: Returns the size of the current CRL.

This property returns the size of the CRL object that is currently being processed.

ChainCurrentOCSP: Returns the current OCSP response.

Returns the OCSP object that is currently being processed.

ChainCurrentOCSPSigner: Returns the signer of the current OCSP object.

Returns the signer/CA that has issued the OCSP response that is currently being processed.

ChainInterimDetails: Returns the current interim validation details.

This property returns the interim chain validation details.

ChainInterimResult: Returns the current interim validation result.

Use this setting to obtain the current (mid-chain) validation result. This property applies to the current validation step and may change as the chain walk proceeds. The final result will be published in the ChainValidationResult property once the validation process completes.

CheckValidityPeriodForTrusted: Whether to check validity period for trusted certificates.

Whether to check validity period for trusted certificates.

ClaimedRolesXML: The XML content of the claimed roles.

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

ClaimedRoleText: The text of the claimed role.

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

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.

CustomTrustedLists: Specifies the custom TrustedLists.

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

CustomTSLs: Specifies the custom TrustedLists.

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

DataObjectFormatCount: The number of the DataObjectFormat elements.

Returns the number of the xades:DataObjectFormat elements available.

DataObjectFormatDescription[Index]: Specifies the DataObjectFormat's Description.

This property contains textual information related to the signed data object in the DataObjectFormat's Description element. Index value could be omitted for the first DataObjectFormat element.

DataObjectFormatEncoding[Index]: Specifies the DataObjectFormat's Encoding.

This property contains an indication of the encoding format of the signed data object in the DataObjectFormat's Encoding element. Index value could be omitted for the first DataObjectFormat element.

DataObjectFormatMimeType[Index]: Specifies the DataObjectFormat's MimeType.

This property contains an indication of the MIME type of the signed data object in the DataObjectFormat's MimeType element. Index value could be omitted for the first DataObjectFormat element.

DataObjectFormatObjectIdentifier[Index]: Specifies the DataObjectFormat's ObjectIdentifier's Identifier.

This property contains an identifier indicating the type of the signed data object in the DataObjectFormat's ObjectIdentifier's Identifier element. Index value could be omitted for the first DataObjectFormat element.

DataObjectFormatObjectIdentifierDescription[Index]: Specifies the DataObjectFormat's ObjectIdentifier's Description.

This property contains an identifier's description indicating the type of the signed data object in the DataObjectFormat's ObjectIdentifier's Description element. Index value could be omitted for the first DataObjectFormat element.

DataObjectFormatObjectIdentifierDocumentationReferences[Index]: Specifies the DataObjectFormat's ObjectIdentifier's DocumentationReferences.

This property contains an identifier's documentation references indicating the type of the signed data object in the DataObjectFormat's ObjectIdentifier's DocumentationReferences element. Index value could be omitted for the first DataObjectFormat element.

DataObjectFormatObjectIdentifierQualifier[Index]: Specifies the DataObjectFormat's ObjectIdentifier's IdentifierQualifier.

This property contains an identifier qualifier indicating the type of the signed data object in the DataObjectFormat's ObjectIdentifier's IdentifierQualifier element. Index value could be omitted for the first DataObjectFormat element.

DataObjectFormatObjectReference[Index]: Specifies the DataObjectFormat's ObjectReference.

This property contains the DataObjectFormat's ObjectReference element that reference the ds:Reference element of the ds:Signature corresponding with the data object qualified by this property.

For example, if the corresponding ds:Reference element has an Id "reference-id-1", then you should set this property to "#reference-id-1" value.

Index value could be omitted for the first DataObjectFormat element.

DislikeOpenEndedOCSPs: Tells the class to discourage OCSP responses without an explicit NextUpdate parameter.

When this property is set to True, the validation engine treats OCSP response without a NextUpdate field as 'substandard' and tries to obtain some further revocation material for the certificate in question (a different OCSP or a CRL, even if the class is configured to prefer the OCSP route). This is to work around Adobe Reader's intolerance to such OCSPs when classifying signed documents as LTV (as of August 2022).

ExclusiveCanonicalizationPrefix: Specifies the exclusive canonicalization prefix.

Specifies the prefix for the ec:InclusiveNamespaces element for the exclusive canonicalization.

Default value is "ec". In this case "ec:" prefix will be used.

Special values:


"#default" or ""	indicates that the prefix will be omitted.
"#auto"	indicates that the prefix will be auto-detected based on the parent nodes.

ExpireTime: Signature expiration time in UTC.

Specifies the signature expiration time in UTC. Used for Binary Crypto API signature.

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.

HMACKey: The key value for HMAC.

Use this property to set the HMAC key. The component uses base16 (hex) encoding for this configuration value.

HMACOutputLength: Sets the length of the HMAC output.

Use this property to configure the length of the HMAC output, in bytes.

HMACSigningUsed: Whether to use HMAC signing.

Set this property to true to make the component perform signing using HMAC method, rather than asymmetric cryptography. TBD

IgnoreChainLoops: Whether chain loops should be ignored.

Set this property to True to make the validation engine ignore chain loops. This may be an option when you need to process chains from buggy CAs that happen to include subchains that sign themselves.

IgnoreChainValidationErrors: Whether to ignore any certificate chain validation issues.

Enable this property to ignore any chain validation errors when creating a signature. This may be useful if the signature is created in an environment which uses different trust settings to the validation environment.

IgnoreOCSPNoCheckExtension: Whether the OCSP NoCheck extension should be ignored.

Set this property to True 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 class should respect the trust to CA certificates as configured in the operating system. In Windows this effectively defines whether the class 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 the TrustedCertificates property) are considered trusted.

IgnoreTimestampFailure: Whether to ignore time-stamping failure during signing.

If this property is set to True, any failure during time-stamping process will be ignored.

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 emulating 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.

InclusiveNamespacesPrefixList: Specifies the InclusiveNamespaces PrefixList.

Use this property to read/specify InclusiveNamespaces PrefixList for exclusive canonicalization transform of SignedInfo element. See XML-Signature Syntax and Processing specification for details.

KeyInfoID: Specifies the ID for KeyInfo element.

This property contains the identifier (ID) attribute of the ds:KeyInfo element.

KeyName: Contains information about the key used for signing.

The KeyName element contains a string value (with significant whitespaces) which may be used by the signer to communicate a key identifier to the recipient. Typically, the KeyName element contains an identifier related to the key pair used to sign the message, but it may contain other protocol-related information that indirectly identifies a key pair. Common uses of the KeyName include simple string names for keys, a key index, a distinguished name (DN), an email address, etc.

ManifestCount: TBD.

TBD

ManifestID[i]: TBD.

TBD

ManifestObjectIndex[i]: TBD.

TBD

ManifestXML[i]: TBD.

TBD

ObjectCount: TBD.

TBD

ObjectEncoding[i]: TBD.

TBD

ObjectID[i]: TBD.

TBD

ObjectMimeType[i]: TBD.

TBD

ObjectSignaturePropertiesCount: TBD.

TBD

ObjectSignaturePropertiesID[i]: TBD.

TBD

ObjectSignaturePropertiesObjectIndex[i]: TBD.

TBD

ObjectSignaturePropertiesXML[i]: TBD.

TBD

ObjectSignaturePropertyCount: TBD.

TBD

ObjectSignaturePropertyID[i]: TBD.

TBD

ObjectSignaturePropertyPropertiesIndex[i]: TBD.

TBD

ObjectSignaturePropertyTarget[i]: TBD.

TBD

ObjectSignaturePropertyXML[i]: TBD.

TBD

ObjectXML[i]: TBD.

TBD

PolicyDescription: signature policy description.

This property specifies the Description of the signature policy. signature policy description.

This property specifies the Description of the signature policy.

PolicyDescription: signature policy description.

This property specifies the Description of the signature policy. signature policy description.

This property specifies the Description of the signature policy.

PolicyExplicitText: The explicit text of the user notice.

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

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

PolicyExplicitText: The explicit text of the user notice.

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

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

PolicyUNNumbers: The noticeNumbers part of the NoticeReference CAdES attribute.

Defines the "noticeNumbers" part of the NoticeReference signature policy qualifier for CAdES-EPES. The noticeNumbers part of the NoticeReference CAdES attribute.

Defines the "noticeNumbers" part of the NoticeReference signature policy qualifier for CAdES-EPES.

PolicyUNNumbers: The noticeNumbers part of the NoticeReference CAdES attribute.

Defines the "noticeNumbers" part of the NoticeReference signature policy qualifier for CAdES-EPES. The noticeNumbers part of the NoticeReference CAdES attribute.

Defines the "noticeNumbers" part of the NoticeReference signature policy qualifier for CAdES-EPES.

PolicyUNOrganization: The organization part of the NoticeReference qualifier.

Defines the "organization" part of the NoticeReference signature policy qualifier for CAdES-EPES. The organization part of the NoticeReference qualifier.

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

PolicyUNOrganization: The organization part of the NoticeReference qualifier.

Defines the "organization" part of the NoticeReference signature policy qualifier for CAdES-EPES. The organization part of the NoticeReference qualifier.

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

ProductionPlace: Identifies the place of the signature production.

The signature production place in JSON format that was included or to be included into the signature.

Sample value: '{"addressCountry": "UK", "addressLocality": "London", "postalCode": "N1 7GU", "streetAddress": "20-22 Wenlock Road"}'

Identifies the place of the signature production.

The signature production place in JSON format that was included or to be included into the signature.

Sample value: '{"addressCountry": "UK", "addressLocality": "London", "postalCode": "N1 7GU", "streetAddress": "20-22 Wenlock Road"}'

ProductionPlace: Identifies the place of the signature production.

The signature production place in JSON format that was included or to be included into the signature.

Sample value: '{"addressCountry": "UK", "addressLocality": "London", "postalCode": "N1 7GU", "streetAddress": "20-22 Wenlock Road"}'

Identifies the place of the signature production.

The signature production place in JSON format that was included or to be included into the signature.

Sample value: '{"addressCountry": "UK", "addressLocality": "London", "postalCode": "N1 7GU", "streetAddress": "20-22 Wenlock Road"}'

PromoteLongOCSPResponses: Whether long OCSP responses are requested.

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

PSSUsed: Whether to use RSASSA-PSS algorithm.

Although the RSASSA-PSS algorithm provides better security than a classic RSA scheme (PKCS#1-1.5), please take into account that RSASSA-PSS is a relatively new algorithm which may not be understood by older implementations. This is an alias for UsePSS. Whether to use RSASSA-PSS algorithm.

PSSUsed: Whether to use RSASSA-PSS algorithm.

QualifyingPropertiesID: Specifies the ID for QualifyingProperties element.

This property contains the identifier (ID) attribute of the xades:QualifyingProperties element.

QualifyingPropertiesObjectID: Specifies the ID for object with QualifyingProperties element.

This property contains the identifier (ID) attribute of the ds:Object element that contains xades:QualifyingProperties element.

QualifyingPropertiesReferenceCount: The number of the QualifyingPropertiesReference elements.

Returns the number of the xades:QualifyingPropertiesReference elements available.

QualifyingPropertiesReferenceID[Index]: Specifies the QualifyingPropertiesReference's ID.

This property contains an identifier (ID) attribute of the xades:QualifyingPropertiesReference element. Index value could be omitted for the first QualifyingPropertiesReference element.

QualifyingPropertiesReferenceURI[Index]: Specifies the QualifyingPropertiesReference's URI.

This property contains an URI attribute of the xades:QualifyingPropertiesReference element. Index value could be omitted for the first QualifyingPropertiesReference element.

RefsTimestampType: Specifies references timestamp type to include to the signature.

Contains a comma-separated list of values that specifies which references timestamp type to include to the signature when signature upgraded to XAdES-X or XAdES-E-X form.

Supported values are:


SigAndRefs		SigAndRefs timestamp
RefsOnly		RefsOnly timestamp

SchemeParams: The algorithm scheme parameters to employ.

Use this property to specify the parameters of the algorithm scheme if needed.

This setting is used to provide parameters for some cryptographic schemes. Use the Name1=Value1;Name2=Value2;... syntax to encode the parameters. For example: Scheme=PSS;SaltSize=32;TrailerField=1.

SignatureID: Specifies the ID for Signature element.

This property contains the identifier (ID) attribute of the ds:Signature element.

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.NewSignature.Level = aslEPES; 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.

SignatureLineIndex: Specifies the index of the signature line to sign.

Use this property to specify the signature line that should be signed. If the default value of -1 is assigned to this property, no signature line will be signed.

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.

SignatureOriginPartURI: Contains the signature origin part URI element.

Use this property to get or set the signature origin part URI record.

SignaturePartName: Name of signature part.

Use this property to specify the custom name of the signature part for Open XML documents.

SignaturePrefix: Specifies the signature prefix.

Specifies the prefix for the Signature elements.

Default value is "ds". In this case "ds:" prefix will be used.

Special values:


"#default" or ""	indicates that the prefix will be omitted.
"#auto"	indicates that the prefix will be auto-detected based on the parent nodes.

SignatureValueID: Specifies the ID for SignatureValue element.

This property contains the identifier (ID) attribute of the ds:SignatureValue element.

SignedInfoID: Specifies the ID for SignedInfo element.

This property contains the identifier (ID) attribute of the ds:SignedInfo element.

SignedPropertiesID: Specifies the ID for SignedProperties element.

This property contains the identifier (ID) attribute of the xades:SignedProperties element.

SignedPropertiesReferenceCanonicalizationMethod: Specifies the canonicalization method used in SignedProperties reference.

Use this property to specify the canonicalization method for the canonicalization transform of the ds:Reference element that points to xades:SignedProperties element. Use cxcmNone value to not to include canonicalization transform in transform chain.


cxcmNone	`0`
cxcmCanon	`1`
cxcmCanonComment	`2`
cxcmExclCanon	`3`
cxcmExclCanonComment	`4`
cxcmMinCanon	`5`
cxcmCanon_v1_1	`6`
cxcmCanonComment_v1_1	`7`

SignedPropertiesReferenceHashAlgorithm: Specifies the hash algorithm used in SignedProperties reference.

Use this property to specify the hash algorithm to be used for the ds:Reference element that points to xades:SignedProperties element.

Supported values:


SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`

The default value is empty string, in this case, the hash algorithm specified in HashAlgorithm property is used.

SignedPropertiesReferenceID: Specifies the ID for Reference element that points to SignedProperties element.

This property contains the identifier (ID) attribute of the ds:Reference element that points to xades:SignedProperties element.

SignedPropertiesReferenceInclusiveNamespacesPrefixList: Specifies the InclusiveNamespaces PrefixList used in SignedProperties reference.

Use this property to specify InclusiveNamespaces PrefixList for exclusive canonicalization transform of the ds:Reference element that points to xades:SignedProperties element.

SignedPropertiesReferenceIndex: Specifies the index of SignedProperties reference.

Use this property to specify the reference's index for the ds:Reference element that points to xades:SignedProperties element.

SignedSignaturePropertiesID: Specifies the ID for SignedSignatureProperties element.

This property contains the identifier (ID) attribute of the xades:SignedSignatureProperties element.

SigningCertificatesChain: The indicator of which certificates should be/are included as the signing chain.

Use this property to check or set the indices of the signing chain included in the signature. The none and all placeholders are supported.

SigningCertificatesHashAlgorithm: Specifies the hash algorithm used for SigningCertificates.

Use this property to specify the hash algorithm to be used for xades:SigningCertificates element.

Supported values:


SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`

The default value is empty string, in this case, the hash algorithm specified in HashAlgorithm property is used.

SignTime: Specifies the signing time in UTC.

Specifies the signing time in UTC. Used for Binary Crypto API signature.

SigPolicyDescription: signature policy description.

This property specifies the Description of the signature policy (an alias for PolicyDescription). signature policy description.

This property specifies the Description of the signature policy (an alias for PolicyDescription).

SigPolicyDescription: signature policy description.

This property specifies the Description of the signature policy (an alias for PolicyDescription). signature policy description.

This property specifies the Description of the signature policy (an alias for PolicyDescription).

SigPolicyExplicitText: The explicit text of the user notice.

Use this property to specify the explicit text of the user notice to be displayed when the signature is verified (an alias for PolicyExplicitText); The explicit text of the user notice.

Use this property to specify the explicit text of the user notice to be displayed when the signature is verified (an alias for PolicyExplicitText);

SigPolicyExplicitText: The explicit text of the user notice.

Use this property to specify the explicit text of the user notice to be displayed when the signature is verified (an alias for PolicyExplicitText); The explicit text of the user notice.

Use this property to specify the explicit text of the user notice to be displayed when the signature is verified (an alias for PolicyExplicitText);

SigPolicyHash: The EPES policy hash.

Use this configuration setting to provide the EPES policy hash. The EPES policy hash.

Use this configuration setting to provide the EPES policy hash.

SigPolicyHash: The EPES policy hash.

Use this configuration setting to provide the EPES policy hash. The EPES policy hash.

Use this configuration setting to provide the EPES policy hash.

SigPolicyHashAlgorithm: The hash algorithm that was used to generate the EPES policy hash.

Use this setting to provide the hash algorithm that was used to generate the policy hash. The hash algorithm that was used to generate the EPES policy hash.

Use this setting to provide the hash algorithm that was used to generate the policy hash.

SigPolicyHashAlgorithm: The hash algorithm that was used to generate the EPES policy hash.

Use this setting to provide the hash algorithm that was used to generate the policy hash. The hash algorithm that was used to generate the EPES policy hash.

Use this setting to provide the hash algorithm that was used to generate the policy hash.

SigPolicyID: The EPES policy ID.

The EPES signature policy identifier, in dotted OID format (1.2.3.4.5). The EPES policy ID.

The EPES signature policy identifier, in dotted OID format (1.2.3.4.5).

SigPolicyID: The EPES policy ID.

The EPES signature policy identifier, in dotted OID format (1.2.3.4.5). The EPES policy ID.

The EPES signature policy identifier, in dotted OID format (1.2.3.4.5).

SigPolicyNoticeNumbers: The noticeNumbers part of the NoticeReference CAdES attribute.

Defines the "noticeNumbers" part of the NoticeReference signature policy qualifier for CAdES-EPES (an alias for PolicyUNNumbers). The noticeNumbers part of the NoticeReference CAdES attribute.

Defines the "noticeNumbers" part of the NoticeReference signature policy qualifier for CAdES-EPES (an alias for PolicyUNNumbers).

SigPolicyNoticeNumbers: The noticeNumbers part of the NoticeReference CAdES attribute.

Defines the "noticeNumbers" part of the NoticeReference signature policy qualifier for CAdES-EPES (an alias for PolicyUNNumbers). The noticeNumbers part of the NoticeReference CAdES attribute.

Defines the "noticeNumbers" part of the NoticeReference signature policy qualifier for CAdES-EPES (an alias for PolicyUNNumbers).

SigPolicyNoticeOrganization: The organization part of the NoticeReference qualifier.

Defines the "organization" part of the NoticeReference signature policy qualifier for CAdES-EPES (an alias for PolicyUNOrganization). The organization part of the NoticeReference qualifier.

Defines the "organization" part of the NoticeReference signature policy qualifier for CAdES-EPES (an alias for PolicyUNOrganization).

SigPolicyNoticeOrganization: The organization part of the NoticeReference qualifier.

Defines the "organization" part of the NoticeReference signature policy qualifier for CAdES-EPES (an alias for PolicyUNOrganization). The organization part of the NoticeReference qualifier.

Defines the "organization" part of the NoticeReference signature policy qualifier for CAdES-EPES (an alias for PolicyUNOrganization).

SigPolicyURI: The EPES policy URI.

Assign the EPES policy URI to this setting. The EPES policy URI.

Assign the EPES policy URI to this setting.

SigPolicyURI: The EPES policy URI.

Assign the EPES policy URI to this setting. The EPES policy URI.

Assign the EPES policy URI to this setting.

TempPath: Path for storing temporary files.

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.


cxcmNone	`0`
cxcmCanon	`1`
cxcmCanonComment	`2`
cxcmExclCanon	`3`
cxcmExclCanonComment	`4`
cxcmMinCanon	`5`
cxcmCanon_v1_1	`6`
cxcmCanonComment_v1_1	`7`

TimestampResponse: A base16-encoded timestamp response received from a TSA.

When using virtual:// timestamp endpoints, assign this property in your Notification event handler with the TSP response that you receive from the TSA. Remember to encode the response in hex (base16).

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:


certificate		Base64-encoded [X509v3] certificates
crl		Base64-encoded certificate revocation lists (CRL)
ocsp		OCSP responses

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

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

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

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

TLSClientAuthRequested: Indicates whether the TLS server requests client authentication.

Check this property in the 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 the TLSClientChain property. Note that the class 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 the TLSCertValidate event handler to retrieve the validation log of the TLS server.

TolerateMinorChainIssues: Whether to tolerate minor chain issues.

This parameter controls whether the chain validator should tolerate minor technical issues when validating the chain. Those are:

CA, revocation source, TLS key usage requirements are not mandated
Violation of OCSP issuer requirements are ignored
The AuthorityKeyID extension in CRL- and certificate-issuing CAs are ignored (helps with incorrectly renewed certificates)
Basic constraints and name constraints of CA certificates are ignored
Some weaker algorithms are tolerated

TspAttemptCount: Specifies the number of timestamping request attempts.

Use this property to specify a number of timestamping request attempts.

In case of a timestamping failure, provide new TSA and HTTP settings inside the Notification event handler ('BeforeTimestamp' and 'TimestampError' event IDs).

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

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

TspReqPolicy: Sets a request policy ID to include in the timestamping request.

Use this property to provide a specific request policy OID to include in the timestamping request. Use the standard human-readable OID notation (1.2.3.4.5).

UseDefaultTrustedLists: Enables or disables the use of the default TrustedLists.

Use this property to tell the validator to use (or not to use) the default TSLs (Trust Service status Lists).

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

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

Use this property to tell the validator to use (or not to use) the default TSLs (Trust Service status Lists).

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

UseHMACSigning: Whether to use HMAC signing.

Set this property to true to make the component perform signing using HMAC method, rather than asymmetric cryptography. Whether to use HMAC signing.

Set this property to true to make the component perform signing using HMAC method, rather than asymmetric cryptography.

UseHMACSigning: Whether to use HMAC signing.

Set this property to true to make the component perform signing using HMAC method, rather than asymmetric cryptography. Whether to use HMAC signing.

Set this property to true to make the component perform signing using HMAC method, rather than asymmetric cryptography.

UseMicrosoftCTL: Enables or disables the automatic use of the 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.

UsePSS: Whether to use RSASSA-PSS algorithm.

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

Use this property to tell the chain validation module to 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.

UseValidationCache: Enables or disable the use of the product-wide certificate chain validation cache.

Use this property to enable or disable the use of the global chain validation cache. If enabled, the class will consult the product-wide validation cache when validating the signing chains. Also, the outcomes of any new chain validations performed by the class, both interim and final, will be saved in the cache and available for re-use by any future validations. Disable this property to ignore the cache and always perform the validation from a fresh start.

UseValidatorSettingsForTLSValidation: Whether to employ the primary chain validator setup for auxiliary TLS chain validations.

Use this property to specify whether you would like to use the primary (AdES) chain validator component to validate TLS chains for any connections involved (OCSP, CRL).

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:


certificate		References to X.509 certificates
crl		References to certificate revocation lists (CRL)
ocsp		References to OCSP responses

ValidationDataRefsHashAlgorithm: Specifies the hash algorithm used in validation data references.

Use this property to specify the hash algorithm used to compute hashes for validation data references.

Supported values:


SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`

The default value is empty string, in this case, the hash algorithm specified in HashAlgorithm property is used.

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:


certificate		Base64-encoded [X509v3] certificates
crl		Base64-encoded certificate revocation lists (CRL)
ocsp		OCSP responses

XAdESPrefix: Specifies the XAdES prefix.

Specifies the prefix for the XAdES elements.

Default value is "xades". In this case "xades:" prefix will be used.

Special values:


"#default" or ""	indicates that the prefix will be omitted.
"#auto"	indicates that the prefix will be auto-detected based on the parent nodes.

XAdESv141Prefix: Specifies the XAdES v1.4.1 prefix.

Specifies the prefix for the XAdES v1.4.1 elements.

Default value is "xadesv141". In this case "xadesv141:" prefix will be used.

Special values:


"#default" or ""	indicates that the prefix will be omitted.
"#auto"	indicates that the prefix will be auto-detected based on the parent nodes.

Base Config Settings

ASN1UseGlobalTagCache: Controls whether ASN.1 module should use a global object cache.

This is a performance setting. It is unlikely that you will ever need to adjust it.

AssignSystemSmartCardPins: Specifies whether CSP-level PINs should be assigned to CNG keys.

This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it.

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 class.

Supported values are:


off		No caching (default)
local		Local caching
global		Global caching

Cookies: Gets or sets local cookies for the class.

Use this property to get cookies from the internal cookie storage of the class 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.

DNSLocalSuffix: The suffix to assign for TLD names.

Use this global setting to adjust the default suffix to assign to top-level domain names. The default is .local.

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 classes that have its CookieCaching property set to "global".

HardwareCryptoUsePolicy: The hardware crypto usage policy.

This global setting controls the hardware cryptography usage policy: auto, enable, or disable.

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 classes.

HttpVersion: The HTTP version to use in any inner HTTP client components created.

Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use.

IgnoreExpiredMSCTLSigningCert: Whether to tolerate the expired Windows Update signing certificate.

It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account.

ListDelimiter: The delimiter character for multi-element lists.

Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence.

LogDestination: Specifies the debug log destination.

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

Supported values are:


file		File
console		Console
systemlog		System Log (supported for Android only)
debugger		Debugger (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:


time		Current time
level		Level
package		Package name
module		Module name
class		Class name
method		Method name
threadid		Thread Id
contenttype		Content type
content		Content
all		All 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-package		Exclude a package specified in the value
exclude-module		Exclude a module specified in the value
exclude-class		Exclude a class specified in the value
exclude-method		Exclude a method specified in the value
include-package		Include a package specified in the value
include-module		Include a module specified in the value
include-class		Include a class specified in the value
include-method		Include 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:


none		No flush (caching only)
immediate		Immediate flush (real-time logging)
maxcount		Flush 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:


none		None (by default)
fatal		Severe errors that cause premature termination.
error		Other runtime errors or unexpected conditions.
warning		Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
info		Interesting runtime events (startup/shutdown).
debug		Detailed information on flow of through the system.
trace		More 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:


none		No rotation
deleteolder		Delete older entries from the cache upon reaching LogMaxEventCount
keepolder		Keep 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.

OldClientSideRSAFallback: Specifies whether the SSH client should use a SHA1 fallback.

Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak.

ProductVersion: Returns the version of the SecureBlackbox library.

This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision).

ServerSSLDHKeyLength: Sets the size of the TLS DHE key exchange group.

Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server.

StaticDNS: Specifies whether static DNS rules should be used.

Set this property to enable or disable static DNS rules for the class. Works only if UseOwnDNSResolver is set to true.

Supported values are:


none		No static DNS rules (default)
local		Local static DNS rules
global		Global static DNS rules

StaticIPAddress[domain]: Gets or sets an IP address for the specified domain name.

Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the StaticDNS value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are devided by the | (pipe) character.

StaticIPAddresses: Gets or sets all the static DNS rules.

Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If StaticDNS of the class is set to "local", the property returns/restores the rules from/to the internal storage of the class. If StaticDNS of the class is set to "global", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format.

Tag: Allows to store any custom data.

Use this config property to store any custom data.

TLSSessionGroup: Specifies the group name of TLS sessions to be used for session resumption.

Use this property to limit the search of chached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes.

TLSSessionLifetime: Specifies lifetime in seconds of the cached TLS session.

Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes).

TLSSessionPurgeInterval: Specifies how often the session cache should remove the expired TLS sessions.

Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).

UseInternalRandom: Switches between SecureBlackbox-own and platform PRNGs.

Allows to switch between internal/native PRNG implementation and the one provided by the platform.

UseLegacyAdESValidation: Enables legacy AdES validation mode.

Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details).

UseOwnDNSResolver: Specifies whether the client components should use own DNS resolver.

Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one.

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.

UseSystemNativeSizeCalculation: An internal CryptoAPI access tweak.

This is an internal setting. Please do not use it unless instructed by the support team.

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 Module)

OfficeVerifier Errors

1048577	Invalid parameter (`SB_ERROR_INVALID_PARAMETER`)
1048578	Invalid configuration (`SB_ERROR_INVALID_SETUP`)
1048579	Invalid state (`SB_ERROR_INVALID_STATE`)
1048580	Invalid value (`SB_ERROR_INVALID_VALUE`)
1048581	Private key not found (`SB_ERROR_NO_PRIVATE_KEY`)
1048582	Cancelled by the user (`SB_ERROR_CANCELLED_BY_USER`)
1048583	The file was not found (`SB_ERROR_NO_SUCH_FILE`)
1048584	Unsupported feature or operation (`SB_ERROR_UNSUPPORTED_FEATURE`)
1048585	General error (`SB_ERROR_GENERAL_ERROR`)
24117249	The input file does not exist (`SB_ERROR_OFFICE_INPUTFILE_NOT_EXISTS`)
24117250	Unsupported document format (`SB_ERROR_OFFICE_UNSUPPORTED_DOCUMENT_FORMAT`)
24117251	The document cannot be signed (`SB_ERROR_OFFICE_DOCUMENT_NOT_SIGNABLE`)
24117253	The document is already encrypted (`SB_ERROR_OFFICE_DOCUMENT_ENCRYPTED`)
24117254	The document cannot be encrypted (`SB_ERROR_OFFICE_DOCUMENT_NOT_ENCRYPTABLE`)
24117255	The document is not encrypted (`SB_ERROR_OFFICE_DOCUMENT_NOT_ENCRYPTED`)
24117256	Unsupported encryption type (`SB_ERROR_OFFICE_DOCUMENT_UNKNOWN_ENCRYPTION`)
24117257	Invalid password (`SB_ERROR_OFFICE_INVALID_PASSWORD`)
24117258	No signature found to complete the asynchronous signing (`SB_ERROR_OFFICE_SIGNATURE_NOT_FOUND`)