CAdESVerifier Module

Properties   Methods   Events   Config Settings   Errors  

The CAdESVerifier module validates CAdES signatures and their trust chains.

Syntax

SecureBlackbox.CAdESVerifier

Remarks

CAdESVerifier validates electronic signatures that comply with the Electronic Signatures and Infrastructures (ESI) CMS Advanced Electronic Signatures (CAdES) specification. CAdES builds on PKCS#7 and CMS containers to add trust and long-term validity services to generic certificate-based signatures.

CAdES signatures are made over opaque arrays of uninterpreted binary data. They are often used in higher-level signature formats, such as S/MIME or PDF. A CAdES signature can be enveloped (with the data being covered included in the signature file) or detached (with the data distributed separately). It is important to establish if you are working with enveloped or detached signatures as early as possible, as the validation process for the two signature types is slightly different.

CAdESVerifier provides a simple and powerful mechanism to verify CAdES signatures in accordance with the respective ETSI standards (ETSI EN 319 122). It supports the following features of the standard (which cover the most of it):

• Enveloped and detached signatures.
• Matching the signature to all the current and older ETSI signature profiles (including B-B, B-T, B-LT, B-LTA).
• Short-term, long-term, and archival signatures.
• RFC 3161 timestamps.
• Countersignatures.
• Complete chain of trust validation process, using local, global, nation-specific (EUTL), or custom trust.
• Removal of existing signatures.
• Online and offline modes.

The component is being actively maintained and updated, following ongoing developments in AdES world. For more than 10 years, our engineers have been active participants of ETSI Plugtests events, to make sure that our e-Signature infrastructure is compliant and highly interoperable.

Just like our other signature components, CAdESVerifier supports several work modes that differ in complexity, allowing for both 'quick' and 'flexible' use. The simple mode assumes providing the InputFile and the OutputFile, and calling the one-pass Verify method (for detached signatures you will also need to provide the data being covered via the DataFile property). This approach is straightforward and would let you integrate CAdES verification in accordance with built-in validation defaults.

More complex tune-up may involve fine-grained adjustment of validation properties, such as providing your own validation material (certificates, OCSPs, CRLs) or fine-tuning conflict/error resolution options. You can also choose to work with the container step-by-step, by splitting the one-pass operation into a sequence of individual Open, Validate/Revalidate, and Close calls. CAdESVerifier lets you walk up and down the CMS tree to any level of depth using its powerful SelectInfo mechanism. CAdESVerifier verifier = new CAdESVerifier(); // Select the file which contains the signed message verifier.setInputFile("signedFile.scs"); if (verifier.isDetached()){ // To verify a detached signature, we need // to provide both the signature and the original data verifier.setDataFile("MyExe.exe"); verifier.verify(); } else { // To verify an enveloping signature, we need // to provide the location to extract the data verifier.setOutputFile("output.exe"); verifier.verify(); } // The outcome of the cryptographic signature validation for (int idx = 0; idx < verifier.getSignatures().size() ; idx++) { switch (verifier.getSignatures().item(idx).getSignatureValidationResult()) { case CAdESSignature.svtValid: System.out.println("The signature is valid."); break; case CAdESSignature.svtUnknown: System.out.println("Signature verification failed: Unknown signature."); break; case CAdESSignature.svtFailure: case CAdESSignature.svtCorrupted: System.out.println("Signature verification failed: The signature is corrupt or invalid."); break; case CAdESSignature.svtSignerNotFound: System.out.println("Signature verification failed: The signature does not contain a signer."); break; default: System.out.println("Signature verification failed."); break; } }

Property List

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

Method List

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

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.

Config Settings

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

AllSignaturesValid Property (CAdESVerifier Module)

The cumulative validity of all signatures.

Syntax

• Swift
• Objective-C

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

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

Syntax

• Swift
• Objective-C

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

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

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

Default Value

True

Remarks

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

BlockedCertificates Property (CAdESVerifier Module)

The certificates that must be rejected as trust anchors.

Syntax

• Swift
• Objective-C

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

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

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

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

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

Default Value

""

Remarks

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

Certificates Property (CAdESVerifier Module)

A collection of certificates included in the electronic signature.

Syntax

• Swift
• Objective-C

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

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

- (int)certCount;

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

- (BOOL)certCA:(int)certIndex;

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

- (int)certCertType:(int)certIndex;

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

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

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

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

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

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

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

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

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

- (int)certKeyBits:(int)certIndex;

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

- (int)certKeyUsage:(int)certIndex;

- (BOOL)certKeyValid:(int)certIndex;

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

- (BOOL)certOCSPNoCheck:(int)certIndex;

- (int)certOrigin:(int)certIndex;

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

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

- (BOOL)certPrivateKeyExists:(int)certIndex;

- (BOOL)certPrivateKeyExtractable:(int)certIndex;

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

- (BOOL)certQualified:(int)certIndex;

- (int)certQualifiedStatements:(int)certIndex;

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

- (BOOL)certSelfSigned:(int)certIndex;

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

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

- (int)certSource:(int)certIndex;

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

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

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

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

- (BOOL)certValid:(int)certIndex;

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

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

Default Value

""

Remarks

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

CheckTrustedLists Property (CAdESVerifier Module)

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

Syntax

• Swift
• Objective-C

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

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

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

Default Value

False

Remarks

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

CRLs Property (CAdESVerifier Module)

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

Syntax

• Swift
• Objective-C

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

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

- (int)CRLCount;

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

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

- (int)CRLEntryCount:(int)cRLIndex;

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

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

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

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

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

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

- (int)CRLSource:(int)cRLIndex;

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

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

Default Value

""

Remarks

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

DataBytes Property (CAdESVerifier Module)

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

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=dataBytes,setter=setDataBytes:) NSData* dataBytes;

- (NSData*)dataBytes;
- (void)setDataBytes :(NSData*)newDataBytes;

Remarks

Assign a byte array containing the original signed data to this property.

DataFile Property (CAdESVerifier Module)

A path to the file containing the originally signed data.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=dataFile,setter=setDataFile:) NSString* dataFile;

- (NSString*)dataFile;
- (void)setDataFile :(NSString*)newDataFile;

Default Value

""

Remarks

Use this property when working with detached signatures to provide the original signed input. Alternatively, use DataStream to provide in-memory data.

DataIsHash Property (CAdESVerifier Module)

Specifies whether the data source contains the hash of the data or the actual data.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=dataIsHash,setter=setDataIsHash:) BOOL dataIsHash;

- (BOOL)dataIsHash;
- (void)setDataIsHash :(BOOL)newDataIsHash;

Default Value

False

Remarks

Use this property to tell the component whether the data source contains the actual data or its hash.

Detached Property (CAdESVerifier Module)

Specifies whether a detached signature should be produced or verified.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=detached,setter=setDetached:) BOOL detached;

- (BOOL)detached;
- (void)setDetached :(BOOL)newDetached;

Default Value

False

Remarks

Use this property to specify whether a detached signature should be produced or verified.

When this property is set to "true" value, the data will be detached from the signature.

If this property is set to "true" value, the user must provide the detached content via the DataFile or DataStream or DataBytes properties.

When Detached is set to "false" value, the data is included with the signature.

ExtractContent Property (CAdESVerifier Module)

Specifies whether a message content should be extracted.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=extractContent,setter=setExtractContent:) BOOL extractContent;

- (BOOL)extractContent;
- (void)setExtractContent :(BOOL)newExtractContent;

Default Value

False

Remarks

Use this property to specify whether a message content should be extracted when a signature is loaded. This applies only to non-detached signatures with embedded data.

When this property is set to "true" value, the message content will be extracted from the signature.

The user must provide the OutputFile or OutputStream properties with a filename or stream where to save the message content, if none is provided then message content is returned via OutputBytes property.

FIPSMode Property (CAdESVerifier Module)

Reserved.

Syntax

• Swift
• Objective-C

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

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

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

Default Value

False

Remarks

This property is reserved for future use.

IgnoreChainValidationErrors Property (CAdESVerifier Module)

Makes the module tolerant to chain validation errors.

Syntax

• Swift
• Objective-C

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

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

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

Default Value

False

Remarks

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

InputBytes Property (CAdESVerifier Module)

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

Syntax

• Swift
• Objective-C

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

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

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

Remarks

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

InputFile Property (CAdESVerifier Module)

A path to the file containing the signature blob.

Syntax

• Swift
• Objective-C

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

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

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

Default Value

""

Remarks

Use this property to provide a path to the file containing the CAdES signature blob. If verifying detached signatures, use DataStream or DataFile to also supply the original data that was signed.

KnownCertificates Property (CAdESVerifier Module)

Additional certificates for chain validation.

Syntax

• Swift
• Objective-C

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

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

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

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

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

Default Value

""

Remarks

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

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

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

KnownCRLs Property (CAdESVerifier Module)

Additional CRLs for chain validation.

Syntax

• Swift
• Objective-C

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

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

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

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

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

Default Value

""

Remarks

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

KnownOCSPs Property (CAdESVerifier Module)

Additional OCSP responses for chain validation.

Syntax

• Swift
• Objective-C

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

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

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

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

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

Default Value

""

Remarks

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

OCSPs Property (CAdESVerifier Module)

A collection of OCSP responses embedded into the signature.

Syntax

• Swift
• Objective-C

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

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

- (int)OCSPCount;

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

- (int)OCSPEntryCount:(int)oCSPIndex;

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

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

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

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

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

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

- (int)OCSPSource:(int)oCSPIndex;

Default Value

""

Remarks

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

OfflineMode Property (CAdESVerifier Module)

Switches the module to offline mode.

Syntax

• Swift
• Objective-C

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

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

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

Default Value

False

Remarks

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

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

OutputBytes Property (CAdESVerifier Module)

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

Syntax

• Swift
• Objective-C

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

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

- (NSData*)outputBytes;

Remarks

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

This property is read-only.

OutputFile Property (CAdESVerifier Module)

A path to the file to write the extracted data to.

Syntax

• Swift
• Objective-C

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

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

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

Default Value

""

Remarks

Use this property to provide a file name to save the data extracted from the enveloping signature.

Profile Property (CAdESVerifier Module)

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

Syntax

• Swift
• Objective-C

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

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

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

Default Value

""

Remarks

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

Proxy Property (CAdESVerifier Module)

The proxy server settings.

Syntax

• Swift
• Objective-C

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

 

Default Value

""

Remarks

Use this property to tune up the proxy server settings.

RevocationCheck Property (CAdESVerifier Module)

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

Syntax

• Swift
• Objective-C

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

public enum CAdESVerifierRevocationChecks: 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 (CRLs) and Online Certificate Status Protocol (OCSP) responses serve the same purpose of ensuring that the certificate had not been revoked by the Certificate Authority (CA) at the time of use. Depending on your circumstances and security policy requirements, you may want to use either one or both of the revocation information source types.

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

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

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

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

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

Signatures Property (CAdESVerifier Module)

Contains the list of signatures included in the CAdES signature.

Syntax

• Swift
• Objective-C

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

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

- (int)signatureCount;

- (int)signatureChainValidationDetails:(int)signatureIndex;

- (int)signatureChainValidationResult:(int)signatureIndex;

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

- (int)signatureCompatibilityErrors:(int)signatureIndex;

- (BOOL)signatureContainsLongTermInfo:(int)signatureIndex;

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

- (BOOL)signatureCountersigned:(int)signatureIndex;

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

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

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

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

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

- (int)signatureLevel:(int)signatureIndex;

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

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

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

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

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

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

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

- (int)signatureScope:(int)signatureIndex;

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

- (NSData*)signatureSignatureBytes:(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;

Default Value

""

Remarks

Use this property to access all signatures in the CAdES signature.

SignedAttributes Property (CAdESVerifier Module)

Custom signature attributes that are covered by the electronic signature.

Syntax

• Swift
• Objective-C

public var signedAttributes: Array<SignatureAttribute> {
  get {...}
}

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

- (int)signedAttributeCount;

- (NSString*)signedAttributeOID:(int)signedAttributeIndex;

- (NSData*)signedAttributeValue:(int)signedAttributeIndex;

Default Value

""

Remarks

Signature attributes are used to store auxiliary information in the signature. Values included as signed attributes are covered by the signature.

SocketSettings Property (CAdESVerifier Module)

Manages network connection settings.

Syntax

• Swift
• Objective-C

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

 

Default Value

""

Remarks

Use this property to tune up network connection parameters.

Timestamps Property (CAdESVerifier Module)

Contains a collection of timestamps for the processed document.

Syntax

• Swift
• Objective-C

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

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

- (int)timestampCount;

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

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

- (int)timestampCertificateIndex:(int)timestampIndex;

- (int)timestampChainValidationDetails:(int)timestampIndex;

- (int)timestampChainValidationResult:(int)timestampIndex;

- (BOOL)timestampContainsLongTermInfo:(int)timestampIndex;

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

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

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

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

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

- (int)timestampTimestampType:(int)timestampIndex;

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

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

- (int)timestampValidationResult:(int)timestampIndex;

Default Value

""

Remarks

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

TLSClientChain Property (CAdESVerifier Module)

The TLS client certificate chain.

Syntax

• Swift
• Objective-C

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

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

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

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

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

Default Value

""

Remarks

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

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

TLSServerChain Property (CAdESVerifier Module)

The TLS server's certificate chain.

Syntax

• Swift
• Objective-C

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

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

- (int)TLSServerCertCount;

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

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

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

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

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

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

- (int)TLSServerCertKeyBits:(int)tLSServerCertIndex;

- (int)TLSServerCertKeyUsage:(int)tLSServerCertIndex;

- (BOOL)TLSServerCertSelfSigned:(int)tLSServerCertIndex;

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

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

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

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

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

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

Default Value

""

Remarks

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

TLSSettings Property (CAdESVerifier Module)

Manages TLS layer settings.

Syntax

• Swift
• Objective-C

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

 

Default Value

""

Remarks

Use this property to tune up the TLS layer parameters.

TrustedCertificates Property (CAdESVerifier Module)

A list of trusted certificates for chain validation.

Syntax

• Swift
• Objective-C

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

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

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

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

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

Default Value

""

Remarks

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

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

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

UnsignedAttributes Property (CAdESVerifier Module)

Custom unsigned attributes included in the electronic signature.

Syntax

• Swift
• Objective-C

public var unsignedAttributes: Array<SignatureAttribute> {
  get {...}
}

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

- (int)unsignedAttributeCount;

- (NSString*)unsignedAttributeOID:(int)unsignedAttributeIndex;

- (NSData*)unsignedAttributeValue:(int)unsignedAttributeIndex;

Default Value

""

Remarks

Signature attributes are used to store auxiliary information in the signature. Values included as unsigned attributes are not covered by the signature and can be changed or removed without affecting the signature.

ValidationMoment Property (CAdESVerifier Module)

The time point at which signature validity is to be established.

Syntax

• Swift
• Objective-C

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

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

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

Default Value

""

Remarks

Use this property to specify the moment in time at which signature validity should be established. The time is in UTC. Leave the setting empty to stick to the default moment (either the signature creation time or the current time).

The validity of the same signature may differ depending on the time point chosen due to temporal changes in chain validities, revocation statuses, and timestamp times.

Close Method (CAdESVerifier Module)

Closes an opened container.

Syntax

• Swift
• Objective-C

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

- (void)close:(BOOL)saveChanges;

Remarks

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

Config Method (CAdESVerifier Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

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

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

Remarks

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

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

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

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

DoAction Method (CAdESVerifier Module)

Performs an additional action.

Syntax

• Swift
• Objective-C

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

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

Remarks

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

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

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

Common ActionIDs:

Open Method (CAdESVerifier Module)

Opens an existing container for signing or updating.

Syntax

• Swift
• Objective-C

public func open() throws -> Void

- (void)open;

Remarks

Use this method to open a container for signing or updating. When finished, call Close to complete or discard the operation.

Reset Method (CAdESVerifier Module)

Resets the component settings.

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

Reset is a generic method available in every class.

Revalidate Method (CAdESVerifier Module)

Revalidates a signature in accordance with current settings.

Syntax

• Swift
• Objective-C

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

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

Remarks

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

SelectInfo Method (CAdESVerifier Module)

Select signature information for a specific entity.

Syntax

• Swift
• Objective-C

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

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

Remarks

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

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

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

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

Unsign Method (CAdESVerifier Module)

Deletes a signature from the CAdES signature.

Syntax

• Swift
• Objective-C

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

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

Remarks

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

Verify Method (CAdESVerifier Module)

Verifies a digitally signed CAdES message.

Syntax

• Swift
• Objective-C

public func verify() throws -> Void

- (void)verify;

Remarks

CAdESVerifier supports two types of signatures: enveloping and detached. In the enveloping case, both the data and the signature travel in the same 'combined' message. The detached variant observes the signature and the data (in its original form) residing in different files.

To verify enveloping signatures pass the signature via InputFile, InputStream or InputBytes properties.

To verify detached signatures pass the signature via InputFile, InputStream or InputBytes properties, and the data via DataStream or DataFile properties, and set Detached property.

ChainElementDownload Event (CAdESVerifier Module)

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

Syntax

• Swift
• Objective-C

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

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

Remarks

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

ChainElementNeeded Event (CAdESVerifier Module)

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

Syntax

• Swift
• Objective-C

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

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

Remarks

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

ChainValidated Event (CAdESVerifier Module)

Reports the completion of a certificate chain validation.

Syntax

• Swift
• Objective-C

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

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

Remarks

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

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

ChainValidationProgress Event (CAdESVerifier Module)

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

Syntax

• Swift
• Objective-C

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

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

Remarks

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

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

Error Event (CAdESVerifier Module)

Information about errors during CAdES verification.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

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

Remarks

The event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Messages section.

Loaded Event (CAdESVerifier Module)

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

Syntax

• Swift
• Objective-C

func onLoaded(cancel: inout Bool)

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

Remarks

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

Set Cancel to true to terminate CAdES signature processing on this stage.

Notification Event (CAdESVerifier Module)

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

Syntax

• Swift
• Objective-C

func onNotification(eventID: String, eventParam: String)

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

Remarks

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

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

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

SignatureFound Event (CAdESVerifier Module)

Signifies the start of signature validation.

Syntax

• Swift
• Objective-C

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

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

Remarks

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

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

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

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

SignatureValidated Event (CAdESVerifier Module)

Marks the completion of the signature validation routine.

Syntax

• Swift
• Objective-C

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

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

Remarks

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

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

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

TimestampFound Event (CAdESVerifier Module)

Signifies the start of a timestamp validation routine.

Syntax

• Swift
• Objective-C

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

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

Remarks

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

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

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

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

TimestampValidated Event (CAdESVerifier Module)

Reports the completion of the timestamp validation routine.

Syntax

• Swift
• Objective-C

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

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

Remarks

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

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

TLSCertNeeded Event (CAdESVerifier Module)

Fires when a remote TLS party requests a client certificate.

Syntax

• Swift
• Objective-C

func onTLSCertNeeded(host: String, caNames: String)

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

Remarks

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

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

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

TLSCertValidate Event (CAdESVerifier Module)

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

Syntax

• Swift
• Objective-C

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

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

Remarks

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

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

TLSEstablished Event (CAdESVerifier Module)

Fires when a TLS handshake with Host successfully completes.

Syntax

• Swift
• Objective-C

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

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

Remarks

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

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

TLSHandshake Event (CAdESVerifier Module)

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

Syntax

• Swift
• Objective-C

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

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

Remarks

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

TLSShutdown Event (CAdESVerifier Module)

Reports the graceful closure of a TLS connection.

Syntax

• Swift
• Objective-C

func onTLSShutdown(host: String)

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

Remarks

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

CAdESSignature Type

Represents an individual signature in a CAdES container.

Remarks

This type contains information about a signature found in CAdES container. It holds various information about the signature, including its coverage and validation results.

Fields

Constructors

public init()

Certificate Type

Encapsulates an individual X.509 certificate.

Remarks

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

Fields

Constructors

public init(stream: )

public init()

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

Constructors

public init()

OCSPResponse Type

Represents a single OCSP response originating from an OCSP responder.

Remarks

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

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

Fields

Constructors

public init()

ProxySettings Type

A container for proxy server settings.

Remarks

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

Fields

Constructors

public init()

SignatureAttribute Type

Represents an attribute of a digital PKCS#7/CMS signature.

Remarks

Attributes store auxiliary information about the signed message, the signature, or the owner. Each attribute is a = pair.

Common attributes are signing time, a content type, a policy identifier, and a signature timestamp.

Fields

Constructors

public init()

SocketSettings Type

A container for the socket settings.

Remarks

This type is a container for socket-layer parameters.

Fields

Constructors

public init()

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

Constructors

public init()

TLSSettings Type

A container for TLS connection settings.

Remarks

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

Fields