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.
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. |
| 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 the 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 the 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. |
| 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. |
| Revalidate | Revalidates a signature in accordance with current settings. |
| 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.
| ClaimedRoleText | The text of the claimed role. |
| ClaimedRoleXML | The XML content of the claimed roles. |
| 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. |
| DislikeOpenEndedOCSPs | Tells the module to discourage OCSP responses without an explicit NextUpdate parameter. |
| 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. |
| IgnoreChainLoops | Whether chain loops should be ignored. |
| IgnoreOCSPNoCheckExtension | Whether OCSP NoCheck extension should be ignored. |
| IgnoreSystemTrust | Whether trusted Windows Certificate Stores should be treated as trusted. |
| ImplicitlyTrustSelfSignedCertificates | Whether to trust self-signed certificates. |
| IncludeKnownRevocationInfoToSignature | Whether to include custom revocation info to the signature. |
| ProductionPlace | Identifies the place of the signature production. |
| PromoteLongOCSPResponses | Whether long OCSP responses are requested. |
| RemoveSignature | Whether to remove signature. |
| 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. |
| 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. |
| SigPolicyDescription | signature policy description. |
| SigPolicyExplicitText | The explicit text of the user notice. |
| SigPolicyHash | The hash value of the signature policy. |
| SigPolicyHashAlgorithm | The hash algorithm used to compute the signature policy hash. |
| SigPolicyID | Identifies the signature policy. |
| SigPolicyNoticeNumbers | Contains user notice numbers. |
| SigPolicyNoticeOrganization | The organization part of the NoticeReference qualifier. |
| SigPolicyURI | Signature policy URI. |
| TempPath | Location where the temporary files are stored. |
| TimestampCanonicalizationMethod | Specifies canonicalization method used in timestamp. |
| 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. |
| TspHashAlgorithm | Sets a specific hash algorithm for use with the timestamping service. |
| UseMicrosoftCTL | Enables or disables automatic use of Microsoft online certificate trust list. |
| UseSystemCertificates | Enables or disables the use of the system certificates. |
| UseValidationCache | Enables or disable the use of the product-wide certificate chain validation cache. |
| ValidationDataRefsDetails | Specifies validation data references details to include to the signature. |
| ValidationDataValuesDetails | Specifies validation data values details to include to the signature. |
| 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 (supported for HTTPClient, RESTClient and SOAPClient only). |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| 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. |
| Tag | Allows to store any custom data. |
| 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. |
| 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.
Syntax
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
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
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 specify the time for which the signature validation is performed. The time is in UTC.
Certificates Property (OfficeVerifier Module)
A collection of certificates included in the electronic signature.
Syntax
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; - (NSString*)certCRLDistributionPoints:(int)certIndex; - (NSString*)certCurve:(int)certIndex; - (NSData*)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; - (NSData*)certKeyFingerprint:(int)certIndex; - (int)certKeyUsage:(int)certIndex; - (BOOL)certKeyValid:(int)certIndex; - (NSString*)certOCSPLocations:(int)certIndex; - (NSString*)certPolicyIDs:(int)certIndex; - (NSData*)certPublicKeyBytes:(int)certIndex; - (BOOL)certSelfSigned:(int)certIndex; - (NSData*)certSerialNumber:(int)certIndex; - (NSString*)certSigAlgorithm:(int)certIndex; - (NSString*)certSubject:(int)certIndex; - (NSData*)certSubjectKeyID:(int)certIndex; - (NSString*)certSubjectRDN:(int)certIndex; - (NSString*)certValidFrom:(int)certIndex; - (NSString*)certValidTo:(int)certIndex;
Default Value
""
Remarks
Use this property to specify the time for which the signature validation is performed. The time is in UTC.
CRLs Property (OfficeVerifier Module)
A collection of certificate revocation lists embedded into the signature by the signer.
Syntax
public var crLs: Array<CRL> { get {...} }
@property (nonatomic,readonly,assign,getter=CRLCount) int CRLCount; - (int)CRLCount; - (NSData*)CRLBytes:(int)cRLIndex; - (long long)CRLHandle:(int)cRLIndex; - (NSString*)CRLIssuer:(int)cRLIndex; - (NSString*)CRLIssuerRDN:(int)cRLIndex; - (NSString*)CRLLocation:(int)cRLIndex; - (NSString*)CRLNextUpdate:(int)cRLIndex; - (NSString*)CRLThisUpdate:(int)cRLIndex;
Default Value
""
Remarks
Use this property to specify the time for which the signature validation is performed. The time is in UTC.
DocumentFormat Property (OfficeVerifier Module)
Defines the format of the Office document.
Syntax
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
0
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
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
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
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 the byte array form.
Syntax
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
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
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 specify the time for which the signature validation is performed. The time is in UTC.
KnownCRLs Property (OfficeVerifier Module)
Additional CRLs for chain validation.
Syntax
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 specify the time for which the signature validation is performed. The time is in UTC.
KnownOCSPs Property (OfficeVerifier Module)
Additional OCSP responses for chain validation.
Syntax
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 specify the time for which the signature validation is performed. The time is in UTC.
OCSPs Property (OfficeVerifier Module)
A collection of OCSP responses embedded into the signature.
Syntax
public var ocsPs: Array<OCSPResponse> { get {...} }
@property (nonatomic,readonly,assign,getter=OCSPCount) int OCSPCount; - (int)OCSPCount; - (NSData*)OCSPBytes:(int)oCSPIndex; - (long long)OCSPHandle:(int)oCSPIndex; - (NSString*)OCSPIssuer:(int)oCSPIndex; - (NSString*)OCSPIssuerRDN:(int)oCSPIndex; - (NSString*)OCSPLocation:(int)oCSPIndex; - (NSString*)OCSPProducedAt:(int)oCSPIndex;
Default Value
""
Remarks
Use this property to specify the time for which the signature validation is performed. The time is in UTC.
OfflineMode Property (OfficeVerifier Module)
Switches the module to the offline mode.
Syntax
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 component restricts itself from using any online revocation information sources, such as CRL or OCSP responders.
Offline mode may be useful if there is a need to verify the completeness of validation information included within the signature or provided via KnownCertificates, KnownCRLs, and other related properties.
OutputBytes Property (OfficeVerifier Module)
Use this property to read the output the module object has produced.
Syntax
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 is completed to read the produced output. This property will only be set if OutputFile and OutputStream properties had not been assigned.
This property is read-only.
OutputFile Property (OfficeVerifier Module)
Defines where to save the modified signed document.
Syntax
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
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
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=proxyUseProxy,setter=setProxyUseProxy:) BOOL proxyUseProxy; - (BOOL)proxyUseProxy; - (void)setProxyUseProxy :(BOOL)newProxyUseProxy; @property (nonatomic,readwrite,assign,getter=proxyUsername,setter=setProxyUsername:) NSString* proxyUsername; - (NSString*)proxyUsername; - (void)setProxyUsername :(NSString*)newProxyUsername;
Default Value
""
Remarks
Use this property to specify the time for which the signature validation is performed. The time is in UTC.
RevocationCheck Property (OfficeVerifier Module)
Specifies the kind(s) of revocation check to perform.
Syntax
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
1
Remarks
Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.
Certificate Revocation Lists (CRL) and Online Certificate Status Protocol (OCSP) responses serve the same purpose of ensuring that the certificate had not been revoked by the Certificate Authority (CA) at the time of use. Depending on your circumstances and security policy requirements, you may want to use either one or both of the revocation information source types.
| crcNone (0) | No revocation checking |
| crcAuto (1) | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. |
| crcAllCRL (2) | Check all provided CRL endpoints for all chain certificates. |
| crcAllOCSP (3) | Check all provided OCSP endpoints for all chain certificates. |
| crcAllCRLAndOCSP (4) | Check all CRL and OCSP endpoints for all chain certificates. |
| crcAnyCRL (5) | At least one CRL check for every certificate in the chain must succeed. |
| crcAnyOCSP (6) | At least one OCSP check for every certificate in the chain must succeed. |
| crcAnyCRLOrOCSP (7) | At least one CRL or OCSP check for every certificate in the chain must succeed. CRL endpoints are checked first. |
| crcAnyOCSPOrCRL (8) | At least one CRL or OCSP check for every certificate in the chain must succeed. OCSP endpoints are checked first. |
This setting controls the way the revocation checks are performed. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.
There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).
This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to faster OCSP route and only demand one source to succeed) is a good choice for most of typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.
Signatures Property (OfficeVerifier Module)
All signatures found in the Office document.
Syntax
public var signatures: Array<OfficeSignature> { get {...} }
@property (nonatomic,readonly,assign,getter=signatureCount) int signatureCount; - (int)signatureCount; - (int)signatureCertificateIndex:(int)signatureIndex; - (int)signatureChainValidationDetails:(int)signatureIndex; - (int)signatureChainValidationResult:(int)signatureIndex; - (NSString*)signatureClaimedSigningTime:(int)signatureIndex; - (BOOL)signatureCorePropertiesSigned:(int)signatureIndex; - (BOOL)signatureDocumentSigned:(int)signatureIndex; - (NSString*)signatureExpireTime:(int)signatureIndex; - (long long)signatureHandle:(int)signatureIndex; - (NSString*)signatureHashAlgorithm:(int)signatureIndex; - (NSString*)signatureIssuerRDN:(int)signatureIndex; - (NSString*)signatureLastArchivalTime:(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; - (BOOL)signatureXAdES:(int)signatureIndex; - (int)signatureXAdESForm:(int)signatureIndex; - (int)signatureXAdESVersion:(int)signatureIndex;
Default Value
""
Remarks
Use this property to specify the time for which the signature validation is performed. The time is in UTC.
SignedParts Property (OfficeVerifier Module)
All signed parts or entries found in the Office signatures.
Syntax
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)signedPartSignatureIndex:(int)signedPartIndex; - (int)signedPartValidationResult:(int)signedPartIndex;
Default Value
""
Remarks
Use this property to specify the time for which the signature validation is performed. The time is in UTC.
SocketSettings Property (OfficeVerifier Module)
Manages network connection settings.
Syntax
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 specify the time for which the signature validation is performed. The time is in UTC.
Timestamps Property (OfficeVerifier Module)
Contains a collection of timestamps for the processed document.
Syntax
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; - (NSString*)timestampHashAlgorithm:(int)timestampIndex; - (NSData*)timestampSerialNumber:(int)timestampIndex; - (int)timestampSignatureIndex:(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 specify the time for which the signature validation is performed. The time is in UTC.
TLSClientChain Property (OfficeVerifier Module)
The TLS client certificate chain.
Syntax
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
Use this property to specify the time for which the signature validation is performed. The time is in UTC.
TLSServerChain Property (OfficeVerifier Module)
The TLS server's certificate chain.
Syntax
public var tlsServerChain: Array<Certificate> { get {...} }
@property (nonatomic,readonly,assign,getter=TLSServerCertCount) int TLSServerCertCount; - (int)TLSServerCertCount; - (NSData*)TLSServerCertBytes:(int)tLSServerCertIndex; - (long long)TLSServerCertHandle:(int)tLSServerCertIndex;
Default Value
""
Remarks
Use this property to specify the time for which the signature validation is performed. The time is in UTC.
TLSSettings Property (OfficeVerifier Module)
Manages TLS layer settings.
Syntax
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=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 specify the time for which the signature validation is performed. The time is in UTC.
TrustedCertificates Property (OfficeVerifier Module)
A list of trusted certificates for chain validation.
Syntax
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 specify the time for which the signature validation is performed. The time is in UTC.
ValidationMoment Property (OfficeVerifier Module)
Specifies the validation moment.
Syntax
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
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
- (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
- (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 of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
Open Method (OfficeVerifier Module)
Opens a document for verifying or removing signatures.
Syntax
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).
Revalidate Method (OfficeVerifier Module)
Revalidates a signature in accordance with current settings.
Syntax
Remarks
Use this method to re-validate a signature in the opened Office document.
Unsign Method (OfficeVerifier Module)
Deletes a signature from the document.
Syntax
Remarks
Use this method to delete an existing signature from the document. Use SigIndex parameter to specify the signature to be removed.
Verify Method (OfficeVerifier Module)
Verifies the whole document.
Syntax
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
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 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 |
ChainElementNeeded Event (OfficeVerifier Module)
Fires when an element required to validate the chain was not located.
Syntax
- (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.
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
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.
ChainValidated Event (OfficeVerifier Module)
Reports the completion of a certificate chain validation.
Syntax
func onChainValidated(index: Int32, subjectRDN: String, validationResult: Int32, validationDetails: Int32)
- (void)onChainValidated:(int)index :(NSString*)subjectRDN :(int)validationResult :(int)validationDetails;
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) |
| 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
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 Action parameter to alter the validation flow.
The EventKind parameter reports the nature of the event being reported. The CertRDN and CACertRDN report the distinguished names of the certificates that are relevant for the event invocation (one or both can be empty, depending on EventKind. Use 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
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
- (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
- (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 component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.
The unique identifier of the event is provided in EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.
This 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. |
SignatureFound Event (OfficeVerifier Module)
Signifies the start of signature validation.
Syntax
func onSignatureFound(index: Int32, issuerRDN: String, serialNumber: Data, subjectKeyID: Data, certFound: Bool, validateSignature: inout Bool, validateChain: inout Bool)
- (void)onSignatureFound:(int)index :(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 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 KnownCertificates property.
Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with SignatureValidationResult and ChainValidationResult properties respectively.
Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.
SignatureValidated Event (OfficeVerifier Module)
Marks the completion of the signature validation routine.
Syntax
func onSignatureValidated(index: Int32, issuerRDN: String, serialNumber: Data, subjectKeyID: Data, validationResult: Int32)
- (void)onSignatureValidated:(int)index :(NSString*)issuerRDN :(NSData*)serialNumber :(NSData*)subjectKeyID :(int)validationResult;
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 |
TimestampFound Event (OfficeVerifier Module)
Signifies the start of a timestamp validation routine.
Syntax
func onTimestampFound(index: Int32, issuerRDN: String, serialNumber: Data, subjectKeyID: Data, certFound: Bool, validateTimestamp: inout Bool, validateChain: inout Bool)
- (void)onTimestampFound:(int)index :(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.
The CertFound 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 KnownCertificates property.
Just like with signature validation, timestamp validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with SignatureValidationResult and ChainValidationResult properties respectively.
Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.
TimestampValidated Event (OfficeVerifier Module)
Reports the completion of the timestamp validation routine.
Syntax
func onTimestampValidated(index: Int32, issuerRDN: String, serialNumber: Data, subjectKeyID: Data, time: String, validationResult: Int32, chainValidationResult: Int32, chainValidationDetails: Int32)
- (void)onTimestampValidated:(int)index :(NSString*)issuerRDN :(NSData*)serialNumber :(NSData*)subjectKeyID :(NSString*)time :(int)validationResult :(int)chainValidationResult :(int)chainValidationDetails;
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 |
TLSCertNeeded Event (OfficeVerifier Module)
Fires when a remote TLS party requests a client certificate.
Syntax
- (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 (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
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 TLSServerChain property to access the certificate chain. In general case, components may contact a number of TLS endpoints during their work, depending on their configuration.
Accept is assigned in accordance with the outcome of the internal validation check performed by the component, and can be adjusted if needed.
TLSEstablished Event (OfficeVerifier Module)
Fires when a TLS handshake with Host successfully completes.
Syntax
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 successful completion of a TLS handshake.
The Version, Ciphersuite, and ConnectionId parameters indicate 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
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 with TLSEstablished event. If the server chooses to request a client certificate, TLSCertNeeded event will also be fired.
TLSShutdown Event (OfficeVerifier Module)
Reports the graceful closure of a TLS connection.
Syntax
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
Provides details of an individual X.509 certificate.
Remarks
This type provides access to X.509 certificate details.
Fields
|
bytes Data |
Returns raw certificate data in DER format. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ca Bool |
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
caKeyID Data |
A unique identifier (fingerprint) of the CA certificate's private key. Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
crlDistributionPoints String |
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
curve String |
Specifies the elliptic curve of the EC public key.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
fingerprint Data |
Contains the fingerprint (a hash imprint) of this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
friendlyName String |
Contains an associated alias (friendly name) of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
handle Int64 |
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.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
hashAlgorithm String |
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
issuer String |
The common name of the certificate issuer (CA), typically a company name. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
issuerRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyAlgorithm String |
Specifies the public key algorithm of this certificate.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyBits Int32 |
Returns the length of the public key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyFingerprint Data |
Returns a fingerprint of the public key contained in the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyUsage Int32 |
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:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyValid Bool |
Returns True if the certificate's key is cryptographically valid, and False otherwise. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ocspLocations String |
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ocspNoCheck Bool |
Accessor to the value of the certificates ocsp-no-check extension. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
origin Int32 |
Returns the origin of this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
policyIDs String |
Contains identifiers (OIDs) of the applicable certificate policies. The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
privateKeyBytes Data |
Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
privateKeyExists Bool |
Indicates whether the certificate has an associated private key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
privateKeyExtractable Bool |
Indicates whether the private key is extractable |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
publicKeyBytes Data |
Contains the certificate's public key in DER format. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
qualifiedStatements QualifiedStatementsTypes |
Returns the qualified status of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
selfSigned Bool |
Indicates whether the certificate is self-signed (root) or signed by an external CA. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
serialNumber Data |
Returns the certificate's serial number. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
sigAlgorithm String |
Indicates the algorithm that was used by the CA to sign this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
subject String |
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
subjectAlternativeName String |
Returns or sets the value of the Subject Alternative Name extension of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
subjectKeyID Data |
Contains a unique identifier (fingerprint) of the certificate's private key. Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
subjectRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
validFrom String |
The time point at which the certificate becomes valid, in UTC. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
validTo String |
The time point at which the certificate expires, in UTC. |
Constructors
public 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.
Fields
|
bytes Data |
Returns raw CRL data in DER format. |
|
caKeyID Data |
A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL. |
|
entryCount Int32 |
Returns the number of certificate status entries in the CRL. |
|
handle Int64 |
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.
|
|
issuer String |
The common name of the CRL issuer (CA), typically a company name. |
|
issuerRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer. |
|
location String |
The URL that the CRL was downloaded from. |
|
nextUpdate String |
The planned time and date of the next version of this CRL to be published. |
|
sigAlgorithm String |
The public key algorithm that was used by the CA to sign this CRL. |
|
tbs Data |
The to-be-signed part of the CRL (the CRL without the signature part). |
|
thisUpdate String |
The date and time at which this version of the CRL was published. |
Constructors
public 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 (CRL).
An OCSP response is a snapshot of the certificate status at a given time.
Fields
|
bytes Data |
Buffer containing raw OCSP response data. |
|
entryCount Int32 |
The number of SingleResponse elements contained in this OCSP response. Each SingleResponse element corresponds to a certificate status. |
|
handle Int64 |
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.
|
|
issuer String |
Indicates the issuer of this response (a CA or its authorized representative). |
|
issuerRDN String |
Indicates the RDN of the issuer of this response (a CA or its authorized representative). |
|
location String |
Location of the OCSP responder. |
|
producedAt String |
Specifies the time when the response was produced, in UTC. |
Constructors
public 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.
Fields
|
certificateIndex Int32 |
Returns the index of the signing certificate in the Certificates collection Use this property to look up the signing certificate in the Certificates collection. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
chainValidationDetails Int32 |
The details of a certificate chain validation outcome. They may often suggest what reasons that contributed to the overall validation result. Returns a bit mask of the following options:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
chainValidationResult ChainValidities |
The outcome of a certificate chain validation routine. Available options:
Use the ValidationLog property to access the detailed validation log. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
claimedSigningTime String |
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
corePropertiesSigned Bool |
Returns True if this signature covers the core properties of the document. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
documentSigned Bool |
Returns True if the signature covers the document itself. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
expireTime String |
Specifies the signature expiration time in UTC. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
handle Int64 |
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.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
hashAlgorithm String |
The hash algorithm used for signing.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
issuerRDN String |
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 |
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
policyHash String |
The signature policy hash value. Use this property to get the signature policy hash from EPES signatures |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
policyHashAlgorithm String |
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 .
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
policyID String |
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 |
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 |
The serial number of the timestamp. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
signatureBytes Data |
Returns the binary representation of the ASiC signature. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
signatureInfoComments String |
Contains the comments for the SignatureInfoText. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
signatureInfoText String |
Contains the text of the signature info. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
signatureOriginSigned Bool |
Returns True if the signature origin is signed. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
signatureType OfficeSignatureTypes |
Specifies the type of this signature.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
signatureValidationResult SignatureValidities |
The outcome of the cryptographic signature validation. The following signature validity values are supported:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
subjectKeyID Data |
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 |
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 |
Use this property to establish whether the signature contains an embedded timestamp. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
validatedSigningTime String |
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. ClaimedSigningTime returns a non-trusted signing time from the signer's computer. Both times are in UTC. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
validationLog String |
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
xAdES Bool |
Specifies whether the document contains an advanced signature (XAdES). Use this property to check whether the document is signed with XAdES or XML-DSIG only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
xAdESForm XAdESForms |
Specifies which form of XAdES should be produced. Use this property to specify the form (level) of advanced electronic signature to be produced.
* XAdES-E-* forms are supported starting from XAdES v1.3.2 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
xAdESVersion XAdESVersions |
Specifies XAdES version. This property specifies the version of the XAdES specification the signature should comply with. For the form of XAdES, use XAdESForm.
|
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.
Fields
|
contentType String |
Specifies the content type of this signed part. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
hashAlgorithm String |
The hash algorithm used for signing.
The hash algorithm used for signing.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
isRelationshipPart Bool |
Specifies whether this signed part is a relationship part. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
path String |
The path to this signed part in the document package. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
signatureIndex Int32 |
Returns the index of the owner signature, if applicable. Use this property to establish the index of the associated signature object in the signature collection. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
validationResult SignatureValidities |
The outcome of the cryptographic signature validation. The following signature validity values are supported:
|
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.
Fields
|
address String |
The IP address of the proxy server. |
||||||||||
|
authentication ProxyAuthTypes |
The authentication type used by the proxy server.
|
||||||||||
|
password String |
The password to authenticate to the proxy server. |
||||||||||
|
port Int32 |
The port on the proxy server to connect to. |
||||||||||
|
proxyType ProxyTypes |
The type of the proxy server. The WebTunnel proxy is also known as HTTPS proxy. Unlike HTTP proxy, HTTPS proxy (WebTunnel) provides end-to-end security.
|
||||||||||
|
requestHeaders String |
Contains HTTP request headers for WebTunnel and HTTP proxy. |
||||||||||
|
responseBody String |
Contains the HTTP or HTTPS (WebTunnel) proxy response body. |
||||||||||
|
responseHeaders String |
Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. |
||||||||||
|
useIPv6 Bool |
Specifies whether IPv6 should be used when connecting through the proxy. |
||||||||||
|
useProxy Bool |
Enables or disables proxy-driven connection. |
||||||||||
|
username String |
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.
Fields
|
dnsMode DNSResolveModes |
Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.
|
||||||||
|
dnsPort Int32 |
Specifies the port number to be used for sending queries to the DNS server. |
||||||||
|
dnsQueryTimeout Int32 |
The timeout (in milliseconds) for each DNS query. The value of 0 indicates the infinite timeout. |
||||||||
|
dnsServers String |
The addresses of DNS servers to use for address resolution, separated by commas or semicolons. |
||||||||
|
dnsTotalTimeout Int32 |
The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates the infinite timeout. |
||||||||
|
incomingSpeedLimit Int32 |
The maximum number of bytes to read from the socket, per second. |
||||||||
|
localAddress String |
The local network interface to bind the socket to. |
||||||||
|
localPort Int32 |
The local port number to bind the socket to. |
||||||||
|
outgoingSpeedLimit Int32 |
The maximum number of bytes to write to the socket, per second. |
||||||||
|
timeout Int32 |
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 |
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.
Fields
|
accuracy Int64 |
This field indicates the accuracy of the included time mark, in microseconds. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
bytes Data |
Returns raw timestamp data in DER format. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
certificateIndex Int32 |
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 |
The details of a certificate chain validation outcome. They may often suggest what reasons that contributed to the overall validation result. Returns a bit mask of the following options:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
chainValidationResult ChainValidities |
The outcome of a certificate chain validation routine. Available options:
Use the ValidationLog property to access the detailed validation log. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
hashAlgorithm String |
Returns the timestamp's hash algorithm
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
serialNumber Data |
Returns the timestamp's serial number. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
signatureIndex Int32 |
Returns the index of the owner signature, if applicable. Use this property to establish the index of the associated signature object in the signature collection. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
time String |
The time point incorporated into the timestamp. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
timestampType Int32 |
Returns the type of the timestamp. Available options:
Not all of the above timestamp types can be supported by a specific signature technology used (CAdES, PDF, XAdES). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
tsaName String |
This value uniquely identifies the Timestamp Authority (TSA). This property provides information about the entity that manages the TSA. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
validationLog String |
Contains the TSA certificate chain validation log. This information is extremely useful if the timestamp validation fails. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
validationResult SignatureValidities |
Contains timestamp validation outcome. Use this property to check the result of the most recent timestamp validation.
|
Constructors
public init()
Creates a new TimestampInfo object with default field values.
TLSSettings Type
A container for TLS connection settings.
Remarks
TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP.
Fields
|
autoValidateCertificates Bool |
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. |
|||||||||||||||||||||||||||||||||
|
baseConfiguration SecureTransportPredefinedConfigurations |
Selects the base configuration for the TLS settings. Several profiles are on offer, tuned up for different purposes, such as high security or higher compatibility.
|
|||||||||||||||||||||||||||||||||
|
ciphersuites String |
A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases that allow to blanketly enable or disable all ciphersuites at once. Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by BaseConfiguration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:
|
|||||||||||||||||||||||||||||||||
|
ecCurves String |
Defines the elliptic curves to enable. |
|||||||||||||||||||||||||||||||||
|
extensions String |
Provides access to TLS extensions. |
|||||||||||||||||||||||||||||||||
|
forceResumeIfDestinationChanges Bool |
Whether to force TLS session resumption when the destination address changes. |
|||||||||||||||||||||||||||||||||
|
preSharedIdentity String |
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
|||||||||||||||||||||||||||||||||
|
preSharedKey String |
Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. |
|||||||||||||||||||||||||||||||||
|
preSharedKeyCiphersuite String |
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. |
|||||||||||||||||||||||||||||||||
|
renegotiationAttackPreventionMode RenegotiationAttackPreventionModes |
Selects renegotiation attack prevention mechanism. The following options are available:
|
|||||||||||||||||||||||||||||||||
|
revocationCheck RevocationCheckKinds |
Specifies the kind(s) of revocation check to perform. Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.
This setting controls the way the revocation checks are performed. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time. There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs). This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to faster OCSP route and only demand one source to succeed) is a good choice for most of typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential. |
|||||||||||||||||||||||||||||||||
|
sslOptions Int32 |
Various SSL (TLS) protocol options, set of
|
|||||||||||||||||||||||||||||||||
|
tlsMode SSLModes |
Specifies the TLS mode to use.
|
|||||||||||||||||||||||||||||||||
|
useExtendedMasterSecret Bool |
Enables Extended Master Secret Extension, as defined in RFC 7627. |
|||||||||||||||||||||||||||||||||
|
useSessionResumption Bool |
Enables or disables TLS session resumption capability. |
|||||||||||||||||||||||||||||||||
|
versions Int32 |
Th SSL/TLS versions to enable by default.
|
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 | ||||||||||||||||||||||||||||||
| ClaimedRoleText:
The text of the claimed role.Use this property to get the text of the first claimed role.
TBD |
||||||||||||||||||||||||||||||
| ClaimedRoleXML:
The XML content of the claimed roles.Use this property to get the XML content of the claimed roles element.
TBD |
||||||||||||||||||||||||||||||
| CommitmentTypeIndicationAllSignedDataObjects[Index]: Specifies the CommitmentTypeIndication's AllSignedDataObjects.This property contains if the CommitmentTypeIndication's AllSignedDataObjects element is present that indicates that all the signed data objects share the same commitment. Index value could be omitted for the first CommitmentTypeIndication element. | ||||||||||||||||||||||||||||||
| CommitmentTypeIndicationCount: The number of the CommitmentTypeIndication elements.Returns the number of the xades:CommitmentTypeIndication elements available. | ||||||||||||||||||||||||||||||
| CommitmentTypeIndicationIdentifier[Index]: Specifies the CommitmentTypeIndication's CommitmentTypeId's Identifier.This property contains an identifier indicating the type of commitment made by the signer in the CommitmentTypeIndication's CommitmentTypeId's Identifier element. Index value could be omitted for the first CommitmentTypeIndication element. | ||||||||||||||||||||||||||||||
| CommitmentTypeIndicationIdentifierDescription[Index]: Specifies the CommitmentTypeIndication's CommitmentTypeId's Description.This property contains an identifier's description indicating the type of commitment made by the signer in the CommitmentTypeIndication's CommitmentTypeId's Description element. Index value could be omitted for the first CommitmentTypeIndication element. | ||||||||||||||||||||||||||||||
| CommitmentTypeIndicationIdentifierDocumentationReferences[Index]: Specifies the CommitmentTypeIndication's CommitmentTypeId's DocumentationReferences.This property contains an identifier's documentation references indicating the type of commitment made by the signer in the CommitmentTypeIndication's CommitmentTypeId's DocumentationReferences element. Index value could be omitted for the first CommitmentTypeIndication element. | ||||||||||||||||||||||||||||||
| CommitmentTypeIndicationIdentifierQualifier[Index]: Specifies the CommitmentTypeIndication's CommitmentTypeId's IdentifierQualifier.This property contains an identifier qualifier indicating the type of commitment made by the signer in the CommitmentTypeIndication's CommitmentTypeId's IdentifierQualifier element. Index value could be omitted for the first CommitmentTypeIndication element. | ||||||||||||||||||||||||||||||
| CommitmentTypeIndicationObjectReference[Index]: Specifies the CommitmentTypeIndication's ObjectReference.This property contains the CommitmentTypeIndication's ObjectReference elements that refer to one or several ds:Reference elements of the ds:SignedInfo corresponding with one data object qualified by this property. Index value could be omitted for the first CommitmentTypeIndication element. | ||||||||||||||||||||||||||||||
| CommitmentTypeIndicationQualifiersXML[Index]: The XML content of the CommitmentTypeIndication's Qualifiers.This property contains the CommitmentTypeIndication's Qualifiers elements XML content. Index value could be omitted for the first CommitmentTypeIndication element. | ||||||||||||||||||||||||||||||
| DislikeOpenEndedOCSPs: Tells the component 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 component 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). | ||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||
| IgnoreOCSPNoCheckExtension: Whether 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 component should respect
the trust to CA certificates as configured in the operating system.
In Windows this effectively defines whether the component should trust the
certificates residing in the Trusted Root Certification Authorities store.
If IgnoreSystemTrust is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as TrustedCertificates property) are considered trusted. |
||||||||||||||||||||||||||||||
| ImplicitlyTrustSelfSignedCertificates: Whether to trust self-signed certificates. Set this property to True to implicitly trust all self-signed certificates. Use it with care as trusting just about every self-signed certificate is unwise. One exceptional reason where this property may be handy is where a chain is validated in an environment that is not supposed to trust it (for example, a signing, rather than verifying environment, or a QA server). Trusting all self-signing certificates (which are normally trusted) allows to emulate the verifying environment without actually changing its security settings. | ||||||||||||||||||||||||||||||
| IncludeKnownRevocationInfoToSignature: Whether to include custom revocation info to the signature.This property specifies whether revocation pieces provided via KnownCertificates, KnownCRLs, and KnownOCSPs properties should be included into the signature. This property lets you include custom validation elements to the signature in addition to the ones comprising the signing chain. | ||||||||||||||||||||||||||||||
| ProductionPlace: Identifies the place of the signature production.Use this property to get the signature production place. | ||||||||||||||||||||||||||||||
| PromoteLongOCSPResponses: Whether long OCSP responses are requested. Set this property to True to force the class to publish 'long' form of OCSP responses. Otherwise, only BasicOCSPResponse blobs are promoted. | ||||||||||||||||||||||||||||||
| RemoveSignature: Whether to remove signature.Enable to remove signature after its verification. | ||||||||||||||||||||||||||||||
| SignatureInfoAddress1: Specifies the location at which the signature was created.Use this property to specify the location at which the signature was created. | ||||||||||||||||||||||||||||||
| SignatureInfoAddress2: Specifies the location at which the signature was created.Use this property to specify the location at which the signature was created. | ||||||||||||||||||||||||||||||
| SignatureInfoComments: Comments to the signature info text.Comments to the signature info text. | ||||||||||||||||||||||||||||||
| SignatureInfoDelegateSuggestedSigner: Specifies the name of a person.Use this property to specify the name of a person to whom the signature has been delegated. | ||||||||||||||||||||||||||||||
| SignatureInfoDelegateSuggestedSigner2: Specifies the title of a person.Use this property to specify the title of a person to whom the signature has been delegated. | ||||||||||||||||||||||||||||||
| SignatureInfoDelegateSuggestedSignerEmail: Specifies the e-mail address of a person.Use this property to specify the e-mail address of a person to whom the signature has been delegated. | ||||||||||||||||||||||||||||||
| SignatureInfoImage: Specifies an image for the digital signature.Use his property to set an image for the digital signature. | ||||||||||||||||||||||||||||||
| SignatureInfoIncluded:
Whether to include the signature info.Specifies whether to include the signature info.
Sample code that demonstrates adding signature information for OpenXML documents:
|
||||||||||||||||||||||||||||||
| SignatureInfoInvalidLnImage: Specifies the image of an invalid signature.Use this property to set the image of an invalid signature, if the digital signature must be printed. | ||||||||||||||||||||||||||||||
| SignatureInfoSignatureType:
Specifies the type of the digital signature.Use this property to specify the type of the digital signature.
When the type is 2, both SignatureInfoValidLnImage and SignatureInfoInvalidLnImage images should be specified. |
||||||||||||||||||||||||||||||
| SignatureInfoText: The text to be displayed as the signature info.The text to be displayed as the signature info. | ||||||||||||||||||||||||||||||
| SignatureInfoValidLnImage: Specifies the image of a valid signature.Use this property to set the image of a valid signature, if the digital signature must be printed. | ||||||||||||||||||||||||||||||
| SignatureLineAdditionalSignatureInfo[Index]: Contains additional signature information.This property contains additional signature information. | ||||||||||||||||||||||||||||||
| SignatureLineAllowComments[Index]: Indicates if comments are allowed.This property contains the True value if comments are allowed. | ||||||||||||||||||||||||||||||
| SignatureLineCount: The number of signature lines.Returns the number of the signature lines available for Office Open XML (OOXML) documents. | ||||||||||||||||||||||||||||||
| SignatureLineId[Index]: Contains signature unique ID.This property contains signature unique ID. | ||||||||||||||||||||||||||||||
| SignatureLineImageData[Index]: Contains signature image.This property contains signature image. | ||||||||||||||||||||||||||||||
| SignatureLineShowSignDate[Index]: Indicates if signing date should be shown.This property contains the True value if the signature line should include the signing date. | ||||||||||||||||||||||||||||||
| SignatureLineSignatureIndex[Index]: The index of the signature that signs signature line.This property contains the index of the signature that signs this signature line. | ||||||||||||||||||||||||||||||
| SignatureLineSignatureProviderId[Index]: Contains signature provider ID.This property contains a unique ID identifying which signature provider created the signature line. | ||||||||||||||||||||||||||||||
| SignatureLineSignatureProviderUrl[Index]: Contains signature provider URL.This property contains a signature provider download URL. | ||||||||||||||||||||||||||||||
| SignatureLineSigned[Index]: Indicates if signature line is signed.This property contains the True value if signature line is signed. | ||||||||||||||||||||||||||||||
| SignatureLineSigningInstructions[Index]: Contains signing instructions.This property contains the instructions, shown to the user at signing time. | ||||||||||||||||||||||||||||||
| SignatureLineSuggestedSigner2[Index]: Suggested signer line two.This property contains the second line of information of who should sign the signature line. | ||||||||||||||||||||||||||||||
| SignatureLineSuggestedSigner[Index]: Suggested signer line one.This property contains the first line of information of who should sign the signature line. | ||||||||||||||||||||||||||||||
| SignatureLineSuggestedSignerEmail[Index]: Suggested signer email address.This property contains the email address of who should sign the signature line. | ||||||||||||||||||||||||||||||
| SigPolicyDescription: signature policy description.Use this property to get the Description of the signature policy. | ||||||||||||||||||||||||||||||
| SigPolicyExplicitText: The explicit text of the user notice.Use this property to get the explicit text of the user notice to be displayed when the signature is verified. | ||||||||||||||||||||||||||||||
| SigPolicyHash: The hash value of the signature policy.Use this property to get the hash value of the signature policy. | ||||||||||||||||||||||||||||||
| SigPolicyHashAlgorithm: The hash algorithm used to compute the signature policy hash.Use this property to get the algorithm used to compute the signature policy hash. | ||||||||||||||||||||||||||||||
| SigPolicyID: Identifies the signature policy.Use this property to get an identifier that uniquely identifies a specific version of the signature policy. | ||||||||||||||||||||||||||||||
| SigPolicyNoticeNumbers: Contains user notice numbers.This property provides an access to the list of notice numbers, by which the explicit signature policy notice texts could be retrieved. | ||||||||||||||||||||||||||||||
| SigPolicyNoticeOrganization: The organization part of the NoticeReference qualifier.Defines the "organization" part of the NoticeReference signature policy qualifier for XAdES-EPES form. | ||||||||||||||||||||||||||||||
| SigPolicyURI: Signature policy URI.Use this property to get the URI of the signature policy. | ||||||||||||||||||||||||||||||
| TempPath: Location where the temporary files are stored.This setting specifies an absolute path to the location on disk where temporary files are stored. | ||||||||||||||||||||||||||||||
TimestampCanonicalizationMethod:
Specifies canonicalization method used in timestamp.Use this property to specify the canonicalization method used in timestamp.
|
||||||||||||||||||||||||||||||
| 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:
|
||||||||||||||||||||||||||||||
| TLSChainValidationDetails: Contains the advanced details of the TLS server certificate validation.Check this property in TLSCertValidate event handler to access the TLS certificate validation details. | ||||||||||||||||||||||||||||||
| TLSChainValidationResult: Contains the result of the TLS server certificate validation.Check this property in TLSCertValidate event handler to obtain the TLS certificate validation result. | ||||||||||||||||||||||||||||||
| TLSClientAuthRequested: Indicates whether the TLS server requests client authentication.Check this property in TLSCertValidate event handler to find out whether the TLS server requests the client to provide the authentication certificate. If this property is set to true, provide your certificate via TLSClientChain property. Note that the component may fire this event more than once during each operation, as more than one TLS-enabled server may need to be contacted. | ||||||||||||||||||||||||||||||
| TLSValidationLog: Contains the log of the TLS server certificate validation.Check this property in TLSCertValidate event handler to retrieve the validation log of the TLS server. | ||||||||||||||||||||||||||||||
TolerateMinorChainIssues:
Whether to tolerate minor chain issues.This parameter controls whether the chain validator should tolerate minor technical issues when validating the chain. Those are:
|
||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||
| UseMicrosoftCTL: Enables or disables automatic use of Microsoft online certificate trust list.Enable this property to make the chain validation module automatically look up missing CA certificates in the public Windows Update repository. | ||||||||||||||||||||||||||||||
| UseSystemCertificates: Enables or disables the use of the system certificates.Use this property to tell chain validation module automatically look up missing CA certificates in the system certificates. In many cases it is beneficial to switch this property on, as the operating system certificate configuration provides a representative trust framework. | ||||||||||||||||||||||||||||||
| 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 component will consult the product-wide validation cache when validating the signing chains. Also, the outcomes of any new chain validations performed by the component, 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 the fresh start. | ||||||||||||||||||||||||||||||
| 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:
|
||||||||||||||||||||||||||||||
| 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:
|
||||||||||||||||||||||||||||||
Base Config Settings | ||||||||||||||||||||||||||||||
| CheckKeyIntegrityBeforeUse:
Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit,
but prevents a selection of attacks on RSA keys where keys with unknown origins are used.
You can switch this property off to improve performance if your project only uses known, good private keys. |
||||||||||||||||||||||||||||||
| CookieCaching:
Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class.
Supported values are:
|
||||||||||||||||||||||||||||||
| Cookies: Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).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. | ||||||||||||||||||||||||||||||
| 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". | ||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||
| LogDestination:
Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.
Supported values are:
|
||||||||||||||||||||||||||||||
| 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:
|
||||||||||||||||||||||||||||||
| 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:
|
||||||||||||||||||||||||||||||
LogFlushMode:
Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:
|
||||||||||||||||||||||||||||||
| LogLevel:
Specifies the debug log level.Use this property to provide the desired debug log level.
Supported values are:
|
||||||||||||||||||||||||||||||
| 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:
|
||||||||||||||||||||||||||||||
| MaxASN1BufferLength: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. | ||||||||||||||||||||||||||||||
| MaxASN1TreeDepth: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. | ||||||||||||||||||||||||||||||
| OCSPHashAlgorithm: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. | ||||||||||||||||||||||||||||||
| Tag: Allows to store any custom data.Use this config property to store any custom data. | ||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||
| 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 value (SB_ERROR_INVALID_PARAMETER) | |
| 1048578 Class is configured incorrectly (SB_ERROR_INVALID_SETUP) | |
| 1048579 Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE) | |
| 1048580 Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE) | |
| 1048581 Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY) | |
| 1048581 Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) | |
| 24117249 Input file does not exist (SB_ERROR_OFFICE_INPUTFILE_NOT_EXISTS) | |
| 24117250 Unsupported document format (SB_ERROR_OFFICE_UNSUPPORTED_DOCUMENT_FORMAT) | |
| 24117251 Document cannot be signed (SB_ERROR_OFFICE_DOCUMENT_NOT_SIGNABLE) | |
| 24117252 Document is not signed (SB_ERROR_OFFICE_DOCUMENT_NOT_SIGNED) | |
| 24117253 Document is encrypted (SB_ERROR_OFFICE_DOCUMENT_ENCRYPTED) | |
| 24117254 Document cannot be encrypted (SB_ERROR_OFFICE_DOCUMENT_NOT_ENCRYPTABLE) | |
| 24117255 Document is not encrypted (SB_ERROR_OFFICE_DOCUMENT_NOT_ENCRYPTED) | |
| 24117256 Unknown encryption algorithm (SB_ERROR_OFFICE_DOCUMENT_UNKNOWN_ENCRYPTION) | |
| 24117257 Invalid password (SB_ERROR_OFFICE_INVALID_PASSWORD) | |
| 24117258 Signature not found (SB_ERROR_OFFICE_SIGNATURE_NOT_FOUND) |