JAdESVerifier Module
Properties Methods Events Config Settings Errors
The JAdESVerifier module verifies signatures over JSON objects.
Syntax
SecureBlackbox.JAdESVerifier
Remarks
Use JAdESVerifier to validate electronic signatures over JSON structures. Generic (JWS) and JAdES (JSON Advanced Electronic Signatures) are supported.
JAdESVerifier verifier = new JAdESVerifier();
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++) {
System.out.println("Signature " + (idx + 1));
System.out.println(" Timestamp: " + verifier.getSignatures().item(idx).getValidatedSigningTime());
System.out.print(" Validation Result: " + verifier.getSignatures().item(idx).getSignatureValidationResult() + ", ");
switch (verifier.getSignatures().item(idx).getSignatureValidationResult()) {
case svtValid:
System.out.println("The signature is valid.");
break;
case svtCorrupted:
System.out.println("The signature is corrupted.");
break;
case svtSignerNotFound:
System.out.println("Failed to acquire the signing certificate. The signature cannot be validated.");
break;
case svtFailure:
System.out.println("General failure.");
break;
default:
System.out.println("Signature validity is unknown.");
break;
}
}
JAdESVerifier validates each signature from two perspectives: the integrity and validity of the signature itself (i.e. its correspondence to the JSON data it covers), and the validity and trustworthiness of the signing certificate chain. These two signature aspects are generally independent of each other: the signature may be valid but the chain may not be trusted, or, the other way round, the chain may be trusted, but the integrity of the signature may be violated. Under normal circumstances both the signature and the chain must be valid for the signature to be considered good.
To initiate the validation, assign the path to the signed JSON file to the InputFile property (alternatively, you can provide it in a memory buffer via InputBytes or InputString property), and call Verify method. For every signature located in the document, JAdESVerifier will fire the SignatureFound event. This event lets you specify whether you want JAdESVerifier to validate the signature, the chain, or both.
Note: it does not mean that any of the two is optional. This API lets you be flexible in how you validate documents in your code, to allow for a variety of validation scenarios. For example, if your trust environment relies on certificate pinning, validating the chain by JAdESVerifier internally may cause unnecessary burden on the system, in which case (but not in others!) it may be reasonable to disable it in the event handler.
Once SignatureFound returns, JAdESVerifier proceeds to the signature validation routine in accordance with the provided settings. Upon completion of the validation, SignatureValidated event is fired, and the validation results are separately provided via SignatureValidationResult and ChainValidationResult properties of the relevant signature object. Other information about the signature can be accessed via the Signatures property.
Useful settings and properties
The following properties of JAdESVerifier may be handy when working with this component:
- OfflineMode lets you validate the JSON object without contacting online revocation sources. Paired with switched off system trust settings, it can be used to establish the long-term validity of the signed object and the completeness of validation material included in it.
- RevocationCheck lets you adjust the revocation checking preferences.
- ValidatedSigningTime returns the signing time as recorded in the embedded signature timestamp. This is in contrast to ClaimedSigningTime, which returns the signing time as specified by the signer.
- ValidationLog is a great way to find out the details of chain validation failures. This property returns a comprehensive validation log that reports all the issues encountered during the validation.
By default, JAdESVerifier uses the system trust settings to establish certificate chain validity. You can configure it to use your own, custom validation environment by providing the necessary trust elements via KnownCertificates, TrustedCertificates, KnownCRLs, and other similar properties.
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 JWS/JAdES signature is opened. |
| BlockedCertificates | The certificates that must be rejected as trust anchors. |
| Certificates | A collection of certificates included in the electronic signature. |
| CheckTrustedLists | Specifies whether the module should attempt to validate chain trust via a known Trusted List. |
| CompactForm | Specifies if the JWS compact serialization to be used. |
| ContentType | Specifies payload content type. |
| CRLs | A collection of certificate revocation lists embedded into the signature by the signer. |
| DataBytes | Use this property to pass a payload or an object data to module in the byte array form. |
| DataFile | A path to a file containing a payload or an object data. |
| DataString | Use this property to pass a payload or an object data to module in the string form. |
| Detached | Specifies whether a detached signature should be produced or verified. |
| ExtractPayload | Specifies whether a payload should be extracted. |
| FIPSMode | Reserved. |
| FlattenedSignature | Specifies if the flattened signature to be used. |
| IgnoreChainValidationErrors | Makes the module tolerant to chain validation errors. |
| InputBytes | Use this property to pass the input to module in byte array form. |
| InputFile | The file to be signed. |
| InputString | Use this property to pass the input to module in the string form. |
| KnownCertificates | Additional certificates for chain validation. |
| KnownCRLs | Additional CRLs for chain validation. |
| KnownOCSPs | Additional OCSP responses for chain validation. |
| OCSPs | A collection of OCSP responses embedded into the signature. |
| OfflineMode | Switches the module to offline mode. |
| OutputBytes | Use this property to read the output the module object has produced. |
| OutputFile | Defines where to save the signature. |
| OutputString | Use this property to read the output the module object has produced. |
| Profile | Specifies a pre-defined profile to apply when creating the signature. |
| Proxy | The proxy server settings. |
| RevocationCheck | Specifies the kind(s) of revocation check to perform for all chain certificates. |
| Signatures | Provides details of all signatures found in the JWS/JAdES signature. |
| 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 | The time point at which signature validity is to be established. |
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 JWS/JAdES signature. |
| Config | Sets or retrieves a configuration setting. |
| DoAction | Performs an additional action. |
| Open | Opens a JSON for verifying or removing signatures. |
| Reset | Resets the module settings. |
| Revalidate | Revalidates a signature in accordance with current settings. |
| SelectInfo | Select signature information for a specific entity. |
| Unsign | Deletes a signature from the JWS/JAdES signature. |
| Verify | Verifies the JWS/JAdES signature. |
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. |
| Error | Information about errors during signing. |
| HTTPHeaderFieldNeeded | This event is fired when HTTP header field value is required. |
| Loaded | This event is fired when the JSON has been loaded into memory. |
| Notification | This event notifies the application about an underlying control flow event. |
| ObjectNeeded | This event is fired when object is required. |
| ObjectValidate | This event is fired when object should be verified by user. |
| 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.
| AsyncDocumentID | Specifies the document ID for SignAsyncEnd() call. |
| CertThumbprint | Specifies the certificate thumbprint. |
| CertURL | Specifies the certificate URL. |
| ChainCurrentCACert | Returns the current CA certificate. |
| ChainCurrentCert | Returns the certificate that is currently being validated. |
| ChainCurrentCRL | Returns the current CRL. |
| ChainCurrentCRLSize | Returns the size of the current CRL. |
| ChainCurrentOCSP | Returns the current OCSP response. |
| ChainCurrentOCSPSigner | Returns the signer of the current OCSP object. |
| ChainInterimDetails | Returns the current interim validation details. |
| ChainInterimResult | Returns the current interim validation result. |
| CheckValidityPeriodForTrusted | Whether to check validity period for trusted certificates. |
| CustomTrustedLists | Specifies the custom TrustedLists. |
| CustomTSLs | Specifies the custom TrustedLists. |
| DataBase64 | Specifies whether data is Base64-URL-encoded. |
| 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. |
| IgnoreChainValidationErrors | Whether to ignore any certificate chain validation issues. |
| IgnoreOCSPNoCheckExtension | Whether the OCSP NoCheck extension should be ignored. |
| IgnoreSystemTrust | Whether trusted Windows Certificate Stores should be treated as trusted. |
| ImplicitlyTrustSelfSignedCertificates | Whether to trust self-signed certificates. |
| JAdESOptions | Specifies the JAdES options. |
| KeyId | Specifies Key ID. |
| PolicyDescription | signature policy description. |
| PolicyExplicitText | The explicit text of the user notice. |
| PolicyUNNumbers | The noticeNumbers part of the NoticeReference CAdES attribute. |
| PolicyUNOrganization | The organization part of the NoticeReference qualifier. |
| ProductionPlace | Identifies the place of the signature production. |
| PromoteLongOCSPResponses | Whether long OCSP responses are requested. |
| ProtectedHeader | Specifies the protected header. |
| PSSUsed | Whether to use RSASSA-PSS algorithm. |
| SchemeParams | The algorithm scheme parameters to employ. |
| SignerAttrs | Identifies the signer attributes. |
| SignerCommitments | Identifies the signer commitments. |
| SigPolicyDescription | signature policy description. |
| SigPolicyExplicitText | The explicit text of the user notice. |
| SigPolicyHash | The EPES policy hash. |
| SigPolicyHashAlgorithm | The hash algorithm that was used to generate the EPES policy hash. |
| SigPolicyID | The EPES policy ID. |
| SigPolicyNoticeNumbers | The noticeNumbers part of the NoticeReference CAdES attribute. |
| SigPolicyNoticeOrganization | The organization part of the NoticeReference qualifier. |
| SigPolicyURI | The EPES policy URI. |
| TempPath | Path for storing temporary files. |
| ThumbprintHashAlgorithm | Specifies the thumbprint hash algorithm. |
| TimestampResponse | A base16-encoded timestamp response received from a TSA. |
| TLSChainValidationDetails | Contains the advanced details of the TLS server certificate validation. |
| TLSChainValidationResult | Contains the result of the TLS server certificate validation. |
| TLSClientAuthRequested | Indicates whether the TLS server requests client authentication. |
| TLSValidationLog | Contains the log of the TLS server certificate validation. |
| TolerateMinorChainIssues | Whether to tolerate minor chain issues. |
| TspAttemptCount | Specifies the number of timestamping request attempts. |
| TspHashAlgorithm | Sets a specific hash algorithm for use with the timestamping service. |
| TspReqPolicy | Sets a request policy ID to include in the timestamping request. |
| UnprotectedHeader | Specifies the unprotected header. |
| UseDefaultTrustedLists | Enables or disables the use of the default TrustedLists. |
| UseDefaultTSLs | Enables or disables the use of the default TrustedLists. |
| UseMicrosoftCTL | Enables or disables the automatic use of the Microsoft online certificate trust list. |
| UsePSS | Whether to use RSASSA-PSS algorithm. |
| UseSystemCertificates | Enables or disables the use of the system certificates. |
| UseValidationCache | Enables or disable the use of the product-wide certificate chain validation cache. |
| UseValidatorSettingsForTLSValidation | Whether to employ the primary chain validator setup for auxiliary TLS chain validations. |
| ASN1UseGlobalTagCache | Controls whether ASN.1 module should use a global object cache. |
| AssignSystemSmartCardPins | Specifies whether CSP-level PINs should be assigned to CNG keys. |
| CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
| CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| Cookies | Gets or sets local cookies for the module. |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| DNSLocalSuffix | The suffix to assign for TLD names. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HardwareCryptoUsePolicy | The hardware crypto usage policy. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| HttpVersion | The HTTP version to use in any inner HTTP client modules created. |
| IgnoreExpiredMSCTLSigningCert | Whether to tolerate the expired Windows Update signing certificate. |
| ListDelimiter | The delimiter character for multi-element lists. |
| LogDestination | Specifies the debug log destination. |
| LogDetails | Specifies the debug log details to dump. |
| LogFile | Specifies the debug log filename. |
| LogFilters | Specifies the debug log filters. |
| LogFlushMode | Specifies the log flush mode. |
| LogLevel | Specifies the debug log level. |
| LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
| LogRotationMode | Specifies the log rotation mode. |
| MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
| OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| OldClientSideRSAFallback | Specifies whether the SSH client should use a SHA1 fallback. |
| ProductVersion | Returns the version of the SecureBlackbox library. |
| ServerSSLDHKeyLength | Sets the size of the TLS DHE key exchange group. |
| StaticDNS | Specifies whether static DNS rules should be used. |
| StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
| StaticIPAddresses | Gets or sets all the static DNS rules. |
| Tag | Allows to store any custom data. |
| TLSSessionGroup | Specifies the group name of TLS sessions to be used for session resumption. |
| TLSSessionLifetime | Specifies lifetime in seconds of the cached TLS session. |
| TLSSessionPurgeInterval | Specifies how often the session cache should remove the expired TLS sessions. |
| UseInternalRandom | Switches between SecureBlackbox-own and platform PRNGs. |
| UseLegacyAdESValidation | Enables legacy AdES validation mode. |
| UseOwnDNSResolver | Specifies whether the client modules should use own DNS resolver. |
| UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| UseSystemNativeSizeCalculation | An internal CryptoAPI access tweak. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |
AllSignaturesValid Property (JAdESVerifier 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 (JAdESVerifier Module)
Specifies whether module should validate any present signatures when the JWS/JAdES signature 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 (JAdESVerifier 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 provide a list of compromised or blocked certificates. Any chain containing a blocked certificate will fail validation.
Certificates Property (JAdESVerifier 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; - (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 (JAdESVerifier Module)
Specifies whether the module should attempt to validate chain trust via a known Trusted List.
Syntax
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).
CompactForm Property (JAdESVerifier Module)
Specifies if the JWS compact serialization to be used.
Syntax
public var compactForm: Bool { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=compactForm,setter=setCompactForm:) BOOL compactForm; - (BOOL)compactForm; - (void)setCompactForm :(BOOL)newCompactForm;
Default Value
False
Remarks
When this property is set to "true" value, the JAdES component will use the JWS compact serialization format when saving a signature.
The JWS compact serialization format is a compact, Url safe representation of a JWS (JSON Web Signature) or JWE (JSON Web Encryption) object, used for transmitting security tokens.
The JWS compact serialization format supports only one signature without unprotected header (only JWS or JAdES BaselineB signature).
ContentType Property (JAdESVerifier Module)
Specifies payload content type.
Syntax
public var contentType: String { get {...} }
@property (nonatomic,readonly,assign,getter=contentType) NSString* contentType; - (NSString*)contentType;
Default Value
""
Remarks
Use this property to read the content type of the payload.
This property is read-only.
CRLs Property (JAdESVerifier 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; - (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 (JAdESVerifier Module)
Use this property to pass a payload or an object data to module in the byte array form.
Syntax
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 a JWS payload or an object data to be processed to this property.
DataFile Property (JAdESVerifier Module)
A path to a file containing a payload or an object data.
Syntax
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 to provide a JWS payload or an object data to be processed.
DataString Property (JAdESVerifier Module)
Use this property to pass a payload or an object data to module in the string form.
Syntax
public var dataString: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=dataString,setter=setDataString:) NSString* dataString; - (NSString*)dataString; - (void)setDataString :(NSString*)newDataString;
Default Value
""
Remarks
Assign a string containing a JWS payload or an object data to be processed to this property.
Detached Property (JAdESVerifier Module)
Specifies whether a detached signature should be produced or verified.
Syntax
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 JWS payload will be detached from the signature and may either be a single detached object or the result of concatenating multiple detached data objects. In other words, the JWS payload and the signature are stored in separate objects.
If this property is set to "true" value, the user must provide the detached content via the DataFile or DataStream or DataBytes or DataString properties.
When Detached is set to "false" value, the JWS payload is included with the signature as a single object.
ExtractPayload Property (JAdESVerifier Module)
Specifies whether a payload should be extracted.
Syntax
public var extractPayload: Bool { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=extractPayload,setter=setExtractPayload:) BOOL extractPayload; - (BOOL)extractPayload; - (void)setExtractPayload :(BOOL)newExtractPayload;
Default Value
False
Remarks
Use this property to specify whether a payload should be extracted when signature loaded. This applies only to non-detached signatures with a payload.
When this property is set to "true" value, the JWS payload will be extracted from the signature.
The user must provide the OutputFile or OutputStream properties with a filename or stream where to save the payload, if none is provided then payload is returned via OutputBytes or OutputString properties.
FIPSMode Property (JAdESVerifier 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.
FlattenedSignature Property (JAdESVerifier Module)
Specifies if the flattened signature to be used.
Syntax
public var flattenedSignature: Bool { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=flattenedSignature,setter=setFlattenedSignature:) BOOL flattenedSignature; - (BOOL)flattenedSignature; - (void)setFlattenedSignature :(BOOL)newFlattenedSignature;
Default Value
True
Remarks
This property determines whether to use the flattened JWS JSON serialization format. This format is optimized for the single digital signature case and flattens the general JWS JSON serialization syntax by removing the "signatures" member and instead placing the "protected", "header", and "signature" members at the top-level JSON object (at the same level as the "payload" member).
When the FlattenedSignature property is set to "true" value, the signature will be represented using the flattened JWS JSON serialization format, but it is only applicable when there is a single signature involved.
When the property is set to "false" value, the signature will be represented using the general JWS JSON serialization format.
IgnoreChainValidationErrors Property (JAdESVerifier 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 (JAdESVerifier Module)
Use this property to pass the input to module in 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 (JAdESVerifier Module)
The file to be signed.
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
Provide the path to the JSON to be signed.
InputString Property (JAdESVerifier Module)
Use this property to pass the input to module in the string form.
Syntax
public var inputString: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=inputString,setter=setInputString:) NSString* inputString; - (NSString*)inputString; - (void)setInputString :(NSString*)newInputString;
Default Value
""
Remarks
Assign a string containing the data to be processed to this property.
KnownCertificates Property (JAdESVerifier 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 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 (JAdESVerifier 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 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 (JAdESVerifier 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 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 (JAdESVerifier 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; - (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 (JAdESVerifier Module)
Switches the module to 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 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 (JAdESVerifier 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 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 (JAdESVerifier Module)
Defines where to save the signature.
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 JWS/JAdES signature should be saved.
OutputString Property (JAdESVerifier Module)
Use this property to read the output the module object has produced.
Syntax
public var outputString: String { get {...} }
@property (nonatomic,readonly,assign,getter=outputString) NSString* outputString; - (NSString*)outputString;
Default Value
""
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.
Profile Property (JAdESVerifier 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 (JAdESVerifier 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=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 (JAdESVerifier Module)
Specifies the kind(s) of revocation check to perform for all chain certificates.
Syntax
public var revocationCheck: JAdESVerifierRevocationChecks { get {...} set {...} }
public enum JAdESVerifierRevocationChecks: 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.
| crcNone | 0 | No revocation checking. |
| crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. |
| crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. |
| crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. |
| crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. |
| crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. |
| crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. |
| crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. |
| crcAnyOCSPOrCRL | 8 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first. |
This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.
There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).
This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.
Note: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.
Note: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.
Signatures Property (JAdESVerifier Module)
Provides details of all signatures found in the JWS/JAdES signature.
Syntax
public var signatures: Array<JAdESSignature> { 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; - (int)signatureJAdESVersion:(int)signatureIndex; - (NSString*)signatureLastArchivalTime:(int)signatureIndex; - (int)signatureLevel:(int)signatureIndex; - (NSString*)signatureObjectType:(int)signatureIndex; - (NSString*)signatureParentEntity:(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; - (int)signatureSignatureValidationResult:(int)signatureIndex; - (NSString*)signatureSignedData:(int)signatureIndex; - (int)signatureSignedDataType:(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 get the details of all the signatures identified in the JWS/JAdES signature.
SocketSettings Property (JAdESVerifier 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 tune up network connection parameters.
Timestamps Property (JAdESVerifier 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; - (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 (JAdESVerifier 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
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 (JAdESVerifier 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; - (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 (JAdESVerifier 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=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 (JAdESVerifier 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 supply a list of trusted certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when root CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the component manually.
The purpose of this certificate collection is largely the same as that of the Windows Trusted Root Certification Authorities system store.
Use this property with extreme care as it directly affects chain verifiability; a wrong certificate added to the trusted list may result in bad chains being accepted, and forfeited signatures being recognized as genuine. Only add certificates that originate from the parties that you know and trust.
ValidationMoment Property (JAdESVerifier Module)
The time point at which signature validity is to be established.
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 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 (JAdESVerifier Module)
Closes an opened JWS/JAdES signature.
Syntax
Remarks
Use this method to close a previously opened JWS/JAdES signature. Set SaveChanges to true to apply any changes made.
Config Method (JAdESVerifier 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 (JAdESVerifier 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 (case insensitive) of the action is provided in the ActionID parameter.
ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
Open Method (JAdESVerifier Module)
Opens a JSON for verifying or removing signatures.
Syntax
public func open() throws -> Void
- (void)open;
Remarks
Use this method to open a JSON for verifying or removing signatures. When finished, call Close to complete or discard the operation.
Reset Method (JAdESVerifier Module)
Resets the component settings.
Syntax
public func reset() throws -> Void
- (void)reset;
Remarks
Reset is a generic method available in every class.
Revalidate Method (JAdESVerifier Module)
Revalidates a signature in accordance with current settings.
Syntax
Remarks
Use this method to re-validate a signature in the opened JWS/JAdES signature.
SelectInfo Method (JAdESVerifier Module)
Select signature information for a specific entity.
Syntax
- (void)selectInfo:(NSString*)entityLabel :(int)infoType :(BOOL)clearSelection;
Remarks
Use this method to select (or filter) signature-related information for a specific signature element.
Provide the unique label of the entity that you are interested in via the EntityLabel parameter. Use one of the following filters, or their combination, to specify what information you are interested in:
| sitEntity | 1 | Select the current entity |
| sitParentEntity | 2 | Select the parent entity of the current entity |
| sitTimestamps | 4 | Select all timestamps covering the current entity |
| sitSignatures | 8 | Select all signatures covering the current entity |
| sitSigningChain | 16 | Select the signing chain of the current entity |
| sitEmbeddedCertificates | 256 | Select all certificates embedded in the current entity |
| sitEmbeddedCRLs | 512 | Select all CRLs embedded in the current entity |
| sitEmbeddedOCSPs | 1024 | Select all OCSP responses embedded in the current entity |
| sitEmbeddedRevInfo | 1792 | Select the whole pack of embedded revocation information (certificates, CRLs and OCSPs) |
| sitUsedCertificates | 4096 | Select all the certificates used to validate this entity's chain |
| sitUsedCRLs | 8192 | Select all the CRLs used to validate this entity's chain |
| sitUsedOCSPs | 16384 | Select all the OCSP responses used to validate this entity's chain |
| sitUsedRevInfo | 28672 | Select the whole pack of revocation information used to validate this entity's chain (certificates, CRLs, OCSP responses) |
| sitAttributes | 65536 | Select this entity's CMS attributes |
| sitReferences | 131072 | Select this entity's XML references |
| sitSignedParts | 262144 | Select this entity's signed parts |
Following the call, the relevant pieces of information will be copied to the respective component properties (Certificates, CRLs, OCSPs). Note that you can accumulate information in the properties by making repeated calls to SelectInfo and keeping ClearSelection set to false.
This method is useful if you would like to read/display detailed information about a particular signature or timestamp.
Unsign Method (JAdESVerifier Module)
Deletes a signature from the JWS/JAdES signature.
Syntax
Remarks
Use this method to delete an existing signature from the JWS/JAdES signature. Use SigLabel parameter to specify the signature to be removed.
Verify Method (JAdESVerifier Module)
Verifies the JWS/JAdES signature.
Syntax
public func verify() throws -> Void
- (void)verify;
Remarks
Use this method to verify the JWS/JAdES signature.
ChainElementDownload Event (JAdESVerifier 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 the Action parameter to suppress the download if required.
| veaAuto | 0 | Handle the action automatically (the default behaviour) |
| veaContinue | 1 | Accept the request implied by the event (accept the certificate, allow the object retrieval) |
| veaReject | 2 | Reject the request implied by the event (reject the certificate, disallow the object retrieval) |
| veaAcceptNow | 3 | Accept the validated certificate immediately |
| veaAbortNow | 4 | Abort the validation, reject the certificate |
| cekUnknown | 0 | Unknown or unsupported element type |
| cekCertificate | 1 | An X.509 certificate |
| cekCRL | 2 | A CRL |
| cekOCSP | 3 | An OCSP response |
ChainElementNeeded Event (JAdESVerifier 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.
| cekUnknown | 0 | Unknown or unsupported element type |
| cekCertificate | 1 | An X.509 certificate |
| cekCRL | 2 | A CRL |
| cekOCSP | 3 | An OCSP response |
ChainElementStore Event (JAdESVerifier 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.
| cekUnknown | 0 | Unknown or unsupported element type |
| cekCertificate | 1 | An X.509 certificate |
| cekCRL | 2 | A CRL |
| cekOCSP | 3 | An OCSP response |
ChainValidated Event (JAdESVerifier Module)
Reports the completion of a certificate chain validation.
Syntax
func onChainValidated(index: Int32, entityLabel: String, subjectRDN: String, validationResult: Int32, validationDetails: Int32, cancel: inout Bool)
- (void)onChainValidated:(int)index :(NSString*)entityLabel :(NSString*)subjectRDN :(int)validationResult :(int)validationDetails :(int*)cancel;
Remarks
This event is fired when a certificate chain validation routine completes. SubjectRDN identifies the owner of the validated certificate.
ValidationResult set to 0 (zero) indicates successful chain validation.
| cvtValid | 0 | The chain is valid |
| cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
| cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
| cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
| 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 (JAdESVerifier 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 the Action parameter to alter the validation flow.
The EventKind parameter reports the nature of the event being reported. The CertRDN and CACertRDN parameters report the distinguished names of the certificates that are relevant for the event invocation (one or both can be empty, depending on EventKind). Use the Action parameter to adjust the validation flow.
| veaAuto | 0 | Handle the action automatically (the default behaviour) |
| veaContinue | 1 | Accept the request implied by the event (accept the certificate, allow the object retrieval) |
| veaReject | 2 | Reject the request implied by the event (reject the certificate, disallow the object retrieval) |
| veaAcceptNow | 3 | Accept the validated certificate immediately |
| veaAbortNow | 4 | Abort the validation, reject the certificate |
Error Event (JAdESVerifier Module)
Information about errors during signing.
Syntax
- (void)onError:(int)errorCode :(NSString*)description;
Remarks
This event is fired in case of exceptional conditions during the JSON processing.
ErrorCode contains an error code and Description contains a textual description of the error.
HTTPHeaderFieldNeeded Event (JAdESVerifier Module)
This event is fired when HTTP header field value is required.
Syntax
func onHTTPHeaderFieldNeeded(fieldName: String, fieldValues: inout String)
- (void)onHTTPHeaderFieldNeeded:(NSString*)fieldName :(NSString**)fieldValues;
Remarks
This event is triggered when the type of signed data is HttpHeaders mechanism (jasdtHttpHeaders). It indicates that a HTTP header field value is needed.
For "(request target)" field name value return request method and target URI seperated by space character. For example: "GET https://nsoftware.com/sbb/"
Loaded Event (JAdESVerifier Module)
This event is fired when the JSON has been loaded into memory.
Syntax
func onLoaded(cancel: inout Bool)
- (void)onLoaded:(int*)cancel;
Remarks
The handler for this event is a good place to check JWS/JAdES signature properties, which may be useful when preparing the signature.
Set Cancel to true to terminate JSON processing on this stage.
Notification Event (JAdESVerifier 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 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:
| Loaded | Reports the completion of signature processing by the component. Use the event handler to access signature-related information. The EventParam value passed with this EventID is empty. |
| PayloadExtracted | Reports the completion of payload extraction by the component if ExtractPayload property is enabled. Use the event handler to access payload. The EventParam value passed with this EventID is empty. |
| SignaturesLoaded | Notifies the application that the component has finished loading signatures. |
| BeforeTimestamp | This event is fired before a timestamp is requested from the timestamping authority. Use the event handler to modify TSA and HTTP settings. |
| TimestampError | This event is only fired if the class failed to obtain a timestamp from the timestamping authority. The EventParam parameter contains extended error info. |
| TimestampRequest | A timestamp is requested from the custom timestamping
authority. This event is only fired if TimestampServer was set to a
virtual:// URI. The EventParam parameter contains the
TSP request (or the plain hash, depending on the value provided to
TimestampServer), in base16, that needs to be sent to the TSA.
Use the event handler to send the request to the TSA. Upon receiving the response, assign it, in base16, to the TimestampResponse configuration property. |
ObjectNeeded Event (JAdESVerifier Module)
This event is fired when object is required.
Syntax
func onObjectNeeded(uri: String, contentType: String, base64: inout Bool)
- (void)onObjectNeeded:(NSString*)URI :(NSString*)contentType :(int*)base64;
Remarks
This event is triggered when the type of signed data is ObjectIdByURI mechanism (jasdtObjectIdByURI). It is fired to request the data to be signed/verified.
The event handler must pass object data to the component via DataFile or DataStream or DataBytes or DataString property.
ObjectValidate Event (JAdESVerifier Module)
This event is fired when object should be verified by user.
Syntax
func onObjectValidate(uri: String, contentType: String, hashAlgorithm: String, hash: Data, base64: Bool, valid: inout Bool)
- (void)onObjectValidate:(NSString*)URI :(NSString*)contentType :(NSString*)hashAlgorithm :(NSData*)hash :(BOOL)base64 :(int*)valid;
Remarks
This event is triggered when the type of signed data is ObjectIdByURIHash mechanism (jasdtObjectIdByURIHash). It is fired to validate the detached object.
The event handler must pass the object validity to the component via Valid parameter.
SignatureFound Event (JAdESVerifier Module)
Signifies the start of signature validation.
Syntax
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 (JAdESVerifier Module)
Marks the completion of the signature validation routine.
Syntax
func onSignatureValidated(index: Int32, entityLabel: String, issuerRDN: String, serialNumber: Data, subjectKeyID: Data, validationResult: Int32, cancel: inout Bool)
- (void)onSignatureValidated:(int)index :(NSString*)entityLabel :(NSString*)issuerRDN :(NSData*)serialNumber :(NSData*)subjectKeyID :(int)validationResult :(int*)cancel;
Remarks
This event is fired upon the completion of the signature validation routine, and reports the respective validation result.
Use the IssuerRDN, SerialNumber, and/or SubjectKeyID parameters to identify the signing certificate.
ValidationResult is set to 0 if the validation has been successful, or to a non-zero value in case of a validation failure.
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
TimestampFound Event (JAdESVerifier Module)
Signifies the start of a timestamp validation routine.
Syntax
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 (JAdESVerifier Module)
Reports the completion of the timestamp validation routine.
Syntax
func onTimestampValidated(index: Int32, entityLabel: String, issuerRDN: String, serialNumber: Data, subjectKeyID: Data, time: String, validationResult: Int32, chainValidationResult: Int32, chainValidationDetails: Int32, cancel: inout Bool)
- (void)onTimestampValidated:(int)index :(NSString*)entityLabel :(NSString*)issuerRDN :(NSData*)serialNumber :(NSData*)subjectKeyID :(NSString*)time :(int)validationResult :(int)chainValidationResult :(int)chainValidationDetails :(int*)cancel;
Remarks
This event is fired upon the completion of the timestamp validation routine, and reports the respective validation result.
ValidationResult is set to 0 if the validation has been successful, or to a non-zero value in case of a failure.
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
TLSCertNeeded Event (JAdESVerifier 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 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 (JAdESVerifier 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 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 (JAdESVerifier 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 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 (JAdESVerifier 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 by the TLSEstablished event. If the server chooses to request a client certificate, the TLSCertNeeded event will also be fired.
TLSShutdown Event (JAdESVerifier 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
Encapsulates an individual X.509 certificate.
Remarks
This type keeps and provides access to X.509 certificate details.
Fields
bytes
Data (read-only)
Default Value: ""
Returns the raw certificate data in DER format.
ca
Bool
Default Value: False
Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.
Set this property when generating a new certificate to have its Basic Constraints extension generated automatically.
caKeyID
Data (read-only)
Default Value: ""
A unique identifier (fingerprint) of the CA certificate's cryptographic key.
Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.
This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the setting, and for lower-level certificates, from the parent certificate's subject key ID extension.
certType
CertTypes (read-only)
Default Value: 0
Returns the type of the entity contained in the Certificate object.
A Certificate object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.
Use the CertificateManager class to load or create new certificate and certificate requests objects.
crlDistributionPoints
String
Default Value: ""
Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.
Use this property when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.
The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.
curve
String
Default Value: ""
Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.
| SB_EC_SECP112R1 | SECP112R1 | |
| SB_EC_SECP112R2 | SECP112R2 | |
| SB_EC_SECP128R1 | SECP128R1 | |
| SB_EC_SECP128R2 | SECP128R2 | |
| SB_EC_SECP160K1 | SECP160K1 | |
| SB_EC_SECP160R1 | SECP160R1 | |
| SB_EC_SECP160R2 | SECP160R2 | |
| SB_EC_SECP192K1 | SECP192K1 | |
| SB_EC_SECP192R1 | SECP192R1 | |
| SB_EC_SECP224K1 | SECP224K1 | |
| SB_EC_SECP224R1 | SECP224R1 | |
| SB_EC_SECP256K1 | SECP256K1 | |
| SB_EC_SECP256R1 | SECP256R1 | |
| SB_EC_SECP384R1 | SECP384R1 | |
| SB_EC_SECP521R1 | SECP521R1 | |
| SB_EC_SECT113R1 | SECT113R1 | |
| SB_EC_SECT113R2 | SECT113R2 | |
| SB_EC_SECT131R1 | SECT131R1 | |
| SB_EC_SECT131R2 | SECT131R2 | |
| SB_EC_SECT163K1 | SECT163K1 | |
| SB_EC_SECT163R1 | SECT163R1 | |
| SB_EC_SECT163R2 | SECT163R2 | |
| SB_EC_SECT193R1 | SECT193R1 | |
| SB_EC_SECT193R2 | SECT193R2 | |
| SB_EC_SECT233K1 | SECT233K1 | |
| SB_EC_SECT233R1 | SECT233R1 | |
| SB_EC_SECT239K1 | SECT239K1 | |
| SB_EC_SECT283K1 | SECT283K1 | |
| SB_EC_SECT283R1 | SECT283R1 | |
| SB_EC_SECT409K1 | SECT409K1 | |
| SB_EC_SECT409R1 | SECT409R1 | |
| SB_EC_SECT571K1 | SECT571K1 | |
| SB_EC_SECT571R1 | SECT571R1 | |
| SB_EC_PRIME192V1 | PRIME192V1 | |
| SB_EC_PRIME192V2 | PRIME192V2 | |
| SB_EC_PRIME192V3 | PRIME192V3 | |
| SB_EC_PRIME239V1 | PRIME239V1 | |
| SB_EC_PRIME239V2 | PRIME239V2 | |
| SB_EC_PRIME239V3 | PRIME239V3 | |
| SB_EC_PRIME256V1 | PRIME256V1 | |
| SB_EC_C2PNB163V1 | C2PNB163V1 | |
| SB_EC_C2PNB163V2 | C2PNB163V2 | |
| SB_EC_C2PNB163V3 | C2PNB163V3 | |
| SB_EC_C2PNB176W1 | C2PNB176W1 | |
| SB_EC_C2TNB191V1 | C2TNB191V1 | |
| SB_EC_C2TNB191V2 | C2TNB191V2 | |
| SB_EC_C2TNB191V3 | C2TNB191V3 | |
| SB_EC_C2ONB191V4 | C2ONB191V4 | |
| SB_EC_C2ONB191V5 | C2ONB191V5 | |
| SB_EC_C2PNB208W1 | C2PNB208W1 | |
| SB_EC_C2TNB239V1 | C2TNB239V1 | |
| SB_EC_C2TNB239V2 | C2TNB239V2 | |
| SB_EC_C2TNB239V3 | C2TNB239V3 | |
| SB_EC_C2ONB239V4 | C2ONB239V4 | |
| SB_EC_C2ONB239V5 | C2ONB239V5 | |
| SB_EC_C2PNB272W1 | C2PNB272W1 | |
| SB_EC_C2PNB304W1 | C2PNB304W1 | |
| SB_EC_C2TNB359V1 | C2TNB359V1 | |
| SB_EC_C2PNB368W1 | C2PNB368W1 | |
| SB_EC_C2TNB431R1 | C2TNB431R1 | |
| SB_EC_NISTP192 | NISTP192 | |
| SB_EC_NISTP224 | NISTP224 | |
| SB_EC_NISTP256 | NISTP256 | |
| SB_EC_NISTP384 | NISTP384 | |
| SB_EC_NISTP521 | NISTP521 | |
| SB_EC_NISTB163 | NISTB163 | |
| SB_EC_NISTB233 | NISTB233 | |
| SB_EC_NISTB283 | NISTB283 | |
| SB_EC_NISTB409 | NISTB409 | |
| SB_EC_NISTB571 | NISTB571 | |
| SB_EC_NISTK163 | NISTK163 | |
| SB_EC_NISTK233 | NISTK233 | |
| SB_EC_NISTK283 | NISTK283 | |
| SB_EC_NISTK409 | NISTK409 | |
| SB_EC_NISTK571 | NISTK571 | |
| SB_EC_GOSTCPTEST | GOSTCPTEST | |
| SB_EC_GOSTCPA | GOSTCPA | |
| SB_EC_GOSTCPB | GOSTCPB | |
| SB_EC_GOSTCPC | GOSTCPC | |
| SB_EC_GOSTCPXCHA | GOSTCPXCHA | |
| SB_EC_GOSTCPXCHB | GOSTCPXCHB | |
| SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | |
| SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | |
| SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | |
| SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | |
| SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | |
| SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | |
| SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | |
| SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | |
| SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | |
| SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | |
| SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | |
| SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | |
| SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | |
| SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | |
| SB_EC_CURVE25519 | CURVE25519 | |
| SB_EC_CURVE448 | CURVE448 |
fingerprint
String (read-only)
Default Value: ""
Contains the fingerprint (a hash imprint) of this certificate.
While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.
friendlyName
String (read-only)
Default Value: ""
Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.
handle
Int64
Default Value: 0
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
hashAlgorithm
String
Default Value: ""
Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use to find out the hash algorithm that is part of the certificate signature.
| SB_HASH_ALGORITHM_SHA1 | SHA1 | |
| SB_HASH_ALGORITHM_SHA224 | SHA224 | |
| SB_HASH_ALGORITHM_SHA256 | SHA256 | |
| SB_HASH_ALGORITHM_SHA384 | SHA384 | |
| SB_HASH_ALGORITHM_SHA512 | SHA512 | |
| SB_HASH_ALGORITHM_MD2 | MD2 | |
| SB_HASH_ALGORITHM_MD4 | MD4 | |
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_CRC32 | CRC32 | |
| SB_HASH_ALGORITHM_SSL3 | SSL3 | |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
| SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
| SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
| SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
| SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
| SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
| SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
| SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
| SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
| SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
| SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
| SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
| SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
issuer
String (read-only)
Default Value: ""
The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via .
issuerRDN
String
Default Value: ""
A list of Property=Value pairs that uniquely identify the certificate issuer.
Example: /C=US/O=Nationwide CA/CN=Web Certification Authority
keyAlgorithm
String
Default Value: "0"
Specifies the public key algorithm of this certificate.
| SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
| SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
| SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
| SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
| SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
| SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
| SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
| SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
| SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
| SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
| SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
| SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
| SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
| SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
| SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
| SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
| SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
| SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
| SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
| SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
| SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
| SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
| SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
| SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
| SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
| SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
| SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
| SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
| SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
| SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
| SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
| SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
| SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
| SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
| SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
| SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
| SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |
Use the , , and properties to get more details about the key the certificate contains.
keyBits
Int32 (read-only)
Default Value: 0
Returns the length of the public key in bits.
This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the or property would typically contain auxiliary values, and therefore be longer.
keyFingerprint
String (read-only)
Default Value: ""
Returns a SHA1 fingerprint of the public key contained in the certificate.
Note that the key fingerprint is different from the certificate fingerprint accessible via the property. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.
keyUsage
Int32
Default Value: 0
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
This value is a bit mask of the following values:
| ckuUnknown | 0x00000 | Unknown key usage |
| ckuDigitalSignature | 0x00001 | Digital signature |
| ckuNonRepudiation | 0x00002 | Non-repudiation |
| ckuKeyEncipherment | 0x00004 | Key encipherment |
| ckuDataEncipherment | 0x00008 | Data encipherment |
| ckuKeyAgreement | 0x00010 | Key agreement |
| ckuKeyCertSign | 0x00020 | Certificate signing |
| ckuCRLSign | 0x00040 | Revocation signing |
| ckuEncipherOnly | 0x00080 | Encipher only |
| ckuDecipherOnly | 0x00100 | Decipher only |
| ckuServerAuthentication | 0x00200 | Server authentication |
| ckuClientAuthentication | 0x00400 | Client authentication |
| ckuCodeSigning | 0x00800 | Code signing |
| ckuEmailProtection | 0x01000 | Email protection |
| ckuTimeStamping | 0x02000 | Timestamping |
| ckuOCSPSigning | 0x04000 | OCSP signing |
| ckuSmartCardLogon | 0x08000 | Smartcard logon |
| ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
| ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |
Set this property before generating the certificate to propagate the key usage flags to the new certificate.
keyValid
Bool (read-only)
Default Value: False
Returns True if the certificate's key is cryptographically valid, and False otherwise.
ocspLocations
String
Default Value: ""
Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.
Set this property before calling the certificate manager's Generate method to propagate it to the new certificate.
The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.
ocspNoCheck
Bool
Default Value: False
Accessor to the value of the certificate's ocsp-no-check extension.
origin
Int32 (read-only)
Default Value: 0
Returns the location that the certificate was taken or loaded from.
policyIDs
String
Default Value: ""
Contains identifiers (OIDs) of the applicable certificate policies.
The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.
Set this property when generating a certificate to propagate the policies information to the new certificate.
The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.
privateKeyBytes
Data (read-only)
Default Value: ""
Returns the certificate's private key in DER-encoded format. It is normal for this property to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices.
privateKeyExists
Bool (read-only)
Default Value: False
Indicates whether the certificate has a usable private key associated with it. If it is set to True, the certificate can be used for private key operations, such as signing or decryption.
This property is independent from , and can be set to True even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.
privateKeyExtractable
Bool (read-only)
Default Value: False
Indicates whether the private key is extractable (exportable).
publicKeyBytes
Data (read-only)
Default Value: ""
Contains the certificate's public key in DER format.
This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.
qualified
Bool (read-only)
Default Value: False
Indicates whether the certificate is qualified.
This property is set to True if the certificate is confirmed by a Trusted List to be qualified.
qualifiedStatements
QualifiedStatementsTypes
Default Value: 0
Returns a simplified qualified status of the certificate.
qualifiers
String (read-only)
Default Value: ""
A list of qualifiers.
Contains a comma-separated list of qualifier aliases for the certificate, for example QCP-n-qscd,QCWithSSCD.
selfSigned
Bool (read-only)
Default Value: False
Indicates whether the certificate is self-signed (root) or signed by an external CA.
serialNumber
Data
Default Value: ""
Returns the certificate's serial number.
The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.
sigAlgorithm
String (read-only)
Default Value: ""
Indicates the algorithm that was used by the CA to sign this certificate.
A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.
source
PKISources (read-only)
Default Value: 0
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
subject
String (read-only)
Default Value: ""
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via .
subjectAlternativeName
String
Default Value: ""
Returns or sets the value of the Subject Alternative Name extension of the certificate.
Subject alternative names are used to provide additional names that are impractical to store in the main field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.
The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator.
subjectKeyID
Data
Default Value: ""
Contains a unique identifier of the certificate's cryptographic key.
Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.
The and properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.
subjectRDN
String
Default Value: ""
A list of Property=Value pairs that uniquely identify the certificate holder (subject).
Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.
Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.
valid
Bool (read-only)
Default Value: False
Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.
validFrom
String
Default Value: ""
The time point at which the certificate becomes valid, in UTC.
validTo
String
Default Value: ""
The time point at which the certificate expires, in UTC.
Constructors
public init(stream: )
Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data.
public init()
Creates a new object with default field values.
CRL Type
Represents a Certificate Revocation List.
Remarks
CRLs store information about revoked certificates, i.e., certificates that have been identified as invalid by their issuing certificate authority (CA) for any number of reasons.
Each CRL object lists certificates from a single CA and identifies them by their serial numbers. A CA may or may not publish a CRL, may publish several CRLs, or may publish the same CRL in multiple locations.
Unlike OCSP responses, CRLs only list certificates that have been revoked. They do not list certificates that are still valid.
Fields
bytes
Data (read-only)
Default Value: ""
Returns the raw CRL data in DER format.
caKeyID
Data
Default Value: ""
A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL.
entryCount
Int32 (read-only)
Default Value: 0
Returns the number of certificate status entries in the CRL.
handle
Int64
Default Value: 0
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
issuer
String (read-only)
Default Value: ""
The common name of the CRL issuer (CA), typically a company name.
issuerRDN
String (read-only)
Default Value: ""
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer.
location
String (read-only)
Default Value: ""
The URL that the CRL was downloaded from.
nextUpdate
String
Default Value: ""
The planned time and date of the next version of this CRL to be published.
sigAlgorithm
String
Default Value: "0"
The public key algorithm that was used by the CA to sign this CRL.
source
PKISources (read-only)
Default Value: 0
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
tbs
Data (read-only)
Default Value: ""
The to-be-signed part of the CRL (the CRL without the signature part).
thisUpdate
String
Default Value: ""
The date and time at which this version of the CRL was published.
Constructors
public init()
Creates an empty CRL object.
JAdESSignature Type
The component is a container for an JWS/JAdES signature.
Remarks
JSON message may include any number of JWS/JAdES signatures. class stores one of them.
Fields
chainValidationDetails
Int32 (read-only)
Default Value: 0
The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.
Returns a bit mask of the following options:
| cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
| cvrRevoked | 0x0002 | One or more certificates are revoked |
| cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
| cvrExpired | 0x0008 | One or more certificates are expired |
| cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
| cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
| cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
| cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
| cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
| cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
| cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
| cvrBlocked | 0x0800 | One or more certificates are blocked |
| cvrFailure | 0x1000 | General validation failure |
| cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
| cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
| cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
chainValidationResult
ChainValidities (read-only)
Default Value: 0
The outcome of a certificate chain validation routine.
Available options:
| cvtValid | 0 | The chain is valid |
| cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
| cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
| cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
Use the ValidationLog property to access the detailed validation log.
claimedSigningTime
String
Default Value: ""
The signing time from the signer's computer.
Use this property to provide the signature production time. The claimed time is not supported by a trusted source; it may be inaccurate, forfeited, or wrong, and as such is usually taken for informational purposes only by verifiers. Use timestamp servers to embed verifiable trusted timestamps. The time is in UTC.
compatibilityErrors
Int32 (read-only)
Default Value: 0
Returns compatibility errors encountered during validation.
Use this property to get specific compatibility errors encountered during validation. Unlike chain validation details, compatibility errors indicate violations by the signature of the assumed signature level/profile. For example, BES signatures are required to contain the signing time attribute. A prospective BES signature without such attribute will invoke a compatibility error.
containsLongTermInfo
Bool (read-only)
Default Value: False
Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).
contentType
String
Default Value: ""
Specifies payload content type.
Use this property to indicate the content type of the JWS Payload.
This property provides a way for the application to disambiguate among different kinds of objects that might be present in the payload, but it is typically not used when the kind of object is already known. The value of this property is a string that conforms to the Internet Media Type (MIME) format, such as "text/plain" or "application/json".
It is optional to use this property and it is recommended to omit the "application/" prefix of the media type value when it is not needed. The recipient of the signed message should treat the value as if "application/" were prepended to it, unless it already contains a '/'.
countersigned
Bool (read-only)
Default Value: False
Indicates if the signature is countersigned.
Use this property to find out whether the JWS/JAdES signature contains any countersignatures over the main signature(s).
entityLabel
String (read-only)
Default Value: ""
Use this property to get the signature entity label.
This property returns a string label that uniquely identifies the signature. The label can be used to establish the signature target in the SignatureFound event or to select the signing chain via the SelectInfo method.
handle
Int64
Default Value: 0
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
hashAlgorithm
String
Default Value: "SHA256"
Specifies the hash algorithm to be used.
Supported values:
| SB_HASH_ALGORITHM_SHA224 | SHA224 | |
| SB_HASH_ALGORITHM_SHA256 | SHA256 | |
| SB_HASH_ALGORITHM_SHA384 | SHA384 | |
| SB_HASH_ALGORITHM_SHA512 | SHA512 | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |
issuerRDN
String (read-only)
Default Value: ""
The Relative Distinguished Name of the signing certificate's issuer.
A collection of information, in the form of [OID, Value] pairs, about the company that issued the signing certificate.
jAdESVersion
JAdESVersions
Default Value: 1
Specifies JAdES version.
This property specifies the version of the JAdES specification the signature should comply with.
The supported values are:
| javUnknown | 0 | Unknown |
| jav111 | 1 | JAdES v1.1.1 |
lastArchivalTime
String (read-only)
Default Value: ""
Indicates the most recent archival time of an archived signature
This property returns the time of the most recent archival timestamp applied to the signature. This property only makes sense for 'archived' (e.g. CAdES-A) signatures. Time is in UTC.
level
JAdESSignatureLevels
Default Value: 2
Specifies the signature kind and level.
JAdES standard defines a number of different 'levels' of signatures which can be used for different purposes.
Use the Generic value to produce JWS signature.
The supported levels are:
| jaslUnknown | 0 | Unknown signature level |
| jaslGeneric | 1 | Generic signature: JSON Web Signature (JWS) |
| jaslBaselineB | 2 | Baseline B (B-B, basic) |
| jaslBaselineT | 3 | Baseline T (B-T, timestamped) |
| jaslBaselineLT | 4 | Baseline LT (B-LT, long-term) |
| jaslBaselineLTA | 5 | Baseline LTA (B-LTA, long-term with archived timestamp) |
objectType
String
Default Value: "jose+json"
Specifies signature object content type.
Use this property to specify the content type of the signature object.
It is used by the application to differentiate between different types of objects that might be present in an application data structure containing a JWS or JAdES.
The default value is "jose+json" which indicates that it is a JWS or JAdES using the JWS JSON Serialization, and "jose" which indicates that the object is a JWS or JAdES using the JWS Compact Serialization. Other type values can also be used by the application.
parentEntity
String
Default Value: ""
Use this property to get the parent signature label.
This property contains the unique entity label of the current signature's parent object - typically a higher-level signature or a timestamp.
policyHash
String
Default Value: ""
The signature policy hash value.
Use this property to get the signature policy hash from EPES signatures
policyHashAlgorithm
String
Default Value: ""
The algorithm that was used to calculate the signature policy hash
Use this property to get or set the hash algorithm used to calculate the signature policy hash. Read the actual hash value from .
| SB_HASH_ALGORITHM_SHA1 | SHA1 | |
| SB_HASH_ALGORITHM_SHA224 | SHA224 | |
| SB_HASH_ALGORITHM_SHA256 | SHA256 | |
| SB_HASH_ALGORITHM_SHA384 | SHA384 | |
| SB_HASH_ALGORITHM_SHA512 | SHA512 | |
| SB_HASH_ALGORITHM_MD2 | MD2 | |
| SB_HASH_ALGORITHM_MD4 | MD4 | |
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_CRC32 | CRC32 | |
| SB_HASH_ALGORITHM_SSL3 | SSL3 | |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
| SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
| SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
| SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
| SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
| SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
| SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
| SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
| SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
| SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
| SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
| SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
| SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
policyID
String
Default Value: ""
The policy ID that was included or to be included into the signature.
Use this property to retrieve the signature policy identifier from EPES signatures.
policyURI
String
Default Value: ""
The signature policy URI that was included in the signature.
Use this property to set or retrieve the URI of the signature policy from EPES signatures.
serialNumber
Data (read-only)
Default Value: ""
The serial number of the signing certificate.
signatureBytes
Data (read-only)
Default Value: ""
Returns the binary representation of the JSON/JAdES signature.
signatureValidationResult
SignatureValidities (read-only)
Default Value: 0
The outcome of the cryptographic signature validation.
The following signature validity values are supported:
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
signedData
String
Default Value: ""
The sigD header parameter in JSON format that was included or to be included into the signature.
signedDataType
JAdESSignedDataTypes
Default Value: 0
Specifies the type of signed data.
Supported values:
| jasdtPayload | 0 | JWS Payload |
| jasdtHttpHeaders | 1 | HttpHeaders mechanism |
| jasdtObjectIdByURI | 2 | ObjectIdByURI mechanism |
| jasdtObjectIdByURIHash | 3 | ObjectIdByURIHash mechanism |
| jasdtCustom | 4 | Custom mechanism |
subjectKeyID
Data (read-only)
Default Value: ""
Contains the subject key identifier of the signing certificate.
Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented by a SHA-1 hash of the bit string of the subject public key.
subjectRDN
String (read-only)
Default Value: ""
Contains information about the person owning the signing certificate. Only certificates with given subject information will be enumerated during the search operation. Information is stored in the form of [Object Identifier, Value] pairs.
timestamped
Bool (read-only)
Default Value: False
Use this property to establish whether the signature contains an embedded timestamp.
validatedSigningTime
String (read-only)
Default Value: ""
Contains the certified signing time.
Use this property to obtain the signing time as certified by a timestamp from a trusted timestamping authority. This property is only non-empty if there was a valid timestamp included in the signature.
returns a non-trusted signing time from the signer's computer.
Both times are in UTC.
validationLog
String (read-only)
Default Value: ""
Contains the complete log of the certificate validation routine.
Use this property to access the chain validation log produced by the class. The log can be very useful when investigating issues with chain validation, as it contains a step-by-step trace of the entire validation procedure.
Constructors
public init()
Creates a new JAdES/JWS signature object.
OCSPResponse Type
Represents a single OCSP response originating from an OCSP responder.
Remarks
OCSP is a protocol that allows verification of certificate status in real-time, and is an alternative to Certificate Revocation Lists (CRLs).
An OCSP response is a snapshot of the certificate status at a given time.
Fields
bytes
Data (read-only)
Default Value: ""
A buffer containing the raw OCSP response data.
entryCount
Int32 (read-only)
Default Value: 0
The number of SingleResponse elements contained in this OCSP response. Each SingleResponse element corresponds to a certificate status.
handle
Int64
Default Value: 0
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
issuer
String (read-only)
Default Value: ""
Indicates the issuer of this response (a CA or its authorized representative).
issuerRDN
String (read-only)
Default Value: ""
Indicates the RDN of the issuer of this response (a CA or its authorized representative).
location
String (read-only)
Default Value: ""
The location of the OCSP responder.
producedAt
String
Default Value: ""
Specifies the time when the response was produced, in UTC.
sigAlgorithm
String
Default Value: "0"
The public key algorithm that was used by the CA to sign this OCSP response.
source
PKISources (read-only)
Default Value: 0
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
Constructors
public init()
Creates an empty OCSP response object.
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
Default Value: ""
The IP address of the proxy server.
authentication
ProxyAuthTypes
Default Value: 0
The authentication type used by the proxy server.
| patNoAuthentication | 0 |
| patBasic | 1 |
| patDigest | 2 |
| patNTLM | 3 |
password
String
Default Value: ""
The password to authenticate to the proxy server.
port
Int32
Default Value: 0
The port on the proxy server to connect to.
proxyType
ProxyTypes
Default Value: 0
The type of the proxy server.
| cptNone | 0 |
| cptSocks4 | 1 |
| cptSocks5 | 2 |
| cptWebTunnel | 3 |
| cptHTTP | 4 |
requestHeaders
String
Default Value: ""
Contains HTTP request headers for WebTunnel and HTTP proxy.
responseBody
String
Default Value: ""
Contains the HTTP or HTTPS (WebTunnel) proxy response body.
responseHeaders
String
Default Value: ""
Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
useIPv6
Bool
Default Value: False
Specifies whether IPv6 should be used when connecting through the proxy.
username
String
Default Value: ""
Specifies the username credential for proxy authentication.
Constructors
public init()
Creates a new ProxySettings object.
SocketSettings Type
A container for the socket settings.
Remarks
This type is a container for socket-layer parameters.
Fields
dnsMode
DNSResolveModes
Default Value: 0
Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.
| dmAuto | 0 |
| dmPlatform | 1 |
| dmOwn | 2 |
| dmOwnSecure | 3 |
dnsPort
Int32
Default Value: 0
Specifies the port number to be used for sending queries to the DNS server.
dnsQueryTimeout
Int32
Default Value: 0
The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout.
dnsServers
String
Default Value: ""
The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
dnsTotalTimeout
Int32
Default Value: 0
The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout.
incomingSpeedLimit
Int32
Default Value: 0
The maximum number of bytes to read from the socket, per second.
localAddress
String
Default Value: ""
The local network interface to bind the socket to.
localPort
Int32
Default Value: 0
The local port number to bind the socket to.
outgoingSpeedLimit
Int32
Default Value: 0
The maximum number of bytes to write to the socket, per second.
timeout
Int32
Default Value: 60000
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).
useIPv6
Bool
Default Value: False
Enables or disables IP protocol version 6.
Constructors
public init()
Creates a new SocketSettings object.
TimestampInfo Type
A container for timestamp information.
Remarks
The TimestampInfo object contains details of a third-party timestamp and the outcome of its validation.
Fields
accuracy
Int64 (read-only)
Default Value: 0
This field indicates the accuracy of the included time mark, in microseconds.
bytes
Data (read-only)
Default Value: ""
Returns the raw timestamp data in DER format.
certificateIndex
Int32 (read-only)
Default Value: -1
Returns the index of the TSA certificate in the Certificates collection.
Use this property to look up the TSA certificate in the Certificates collection.
chainValidationDetails
Int32 (read-only)
Default Value: 0
The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.
Returns a bit mask of the following options:
| cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
| cvrRevoked | 0x0002 | One or more certificates are revoked |
| cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
| cvrExpired | 0x0008 | One or more certificates are expired |
| cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
| cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
| cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
| cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
| cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
| cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
| cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
| cvrBlocked | 0x0800 | One or more certificates are blocked |
| cvrFailure | 0x1000 | General validation failure |
| cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
| cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
| cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
chainValidationResult
ChainValidities (read-only)
Default Value: 0
The outcome of a certificate chain validation routine.
Available options:
| cvtValid | 0 | The chain is valid |
| cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
| cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
| cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
Use the ValidationLog property to access the detailed validation log.
containsLongTermInfo
Bool (read-only)
Default Value: False
Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).
entityLabel
String (read-only)
Default Value: ""
Use this property to get the timestamp entity label.
This property returns a string label that uniquely identifies the timestamp. The label can be used to establish the signature target in the SignatureFound event or to select the signing chain via the SelectInfo method.
hashAlgorithm
String (read-only)
Default Value: ""
Returns the timestamp's hash algorithm.
| SB_HASH_ALGORITHM_SHA1 | SHA1 | |
| SB_HASH_ALGORITHM_SHA224 | SHA224 | |
| SB_HASH_ALGORITHM_SHA256 | SHA256 | |
| SB_HASH_ALGORITHM_SHA384 | SHA384 | |
| SB_HASH_ALGORITHM_SHA512 | SHA512 | |
| SB_HASH_ALGORITHM_MD2 | MD2 | |
| SB_HASH_ALGORITHM_MD4 | MD4 | |
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_CRC32 | CRC32 | |
| SB_HASH_ALGORITHM_SSL3 | SSL3 | |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
| SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
| SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
| SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
| SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
| SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
| SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
| SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
| SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
| SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
| SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
| SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
| SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
parentEntity
String (read-only)
Default Value: ""
Use this property to get the label of the timestamp's parent entity.
This property references the EntityLabel of the object that the timestamp covers, typically a signature.
serialNumber
Data (read-only)
Default Value: ""
Returns the timestamp's serial number.
time
String (read-only)
Default Value: ""
The time point incorporated into the timestamp.
timestampType
Int32 (read-only)
Default Value: 0
Returns the type of the timestamp.
Available options:
| tstUnknown | 0 | |
| tstLegacy | 1 | Supported by: Authenticode components |
| tstTrusted | 2 | Supported by: Authenticode components |
| tstGeneric | 3 | Supported by: CAdES components |
| tstESC | 4 | Supported by: CAdES components |
| tstContent | 5 | Supported by: CAdES components |
| tstCertsAndCRLs | 6 | Supported by: CAdES components |
| tstArchive | 7 | Archive timestamp. Supported by: ASiC, CAdES, JAdES, Office, SOAP, XAdES components |
| tstArchive2 | 8 | Archive v2 timestamp. Supported by: ASiC, CAdES components |
| tstArchive3 | 9 | Archive v3 timestamp. Supported by: ASiC, CAdES components |
| tstIndividualDataObjects | 10 | Individual data objects timetamp. Supported by: ASiC, Office, SOAP, XAdES components |
| tstAllDataObjects | 11 | All data objects timestamp. Supported by: ASiC, Office, SOAP, XAdES components |
| tstSignature | 12 | Signature timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components |
| tstRefsOnly | 13 | RefsOnly timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components |
| tstSigAndRefs | 14 | SigAndRefs timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components |
| tstSignedData | 15 | SignedData timestamp. Supported by: JAdES components |
| tstArchive141 | 16 | Archive timestamp v1.4.1. Supported by: ASiC, Office, SOAP, XAdES components |
Not all of the above timestamp types can be supported by a specific signature technology used (CAdES, PDF, XAdES).
tsaName
String (read-only)
Default Value: ""
This value uniquely identifies the Timestamp Authority (TSA).
This property provides information about the entity that manages the TSA.
validationLog
String (read-only)
Default Value: ""
Contains the TSA certificate chain validation log. This information is extremely useful if the timestamp validation fails.
validationResult
SignatureValidities (read-only)
Default Value: 0
Contains the timestamp validation outcome.
Use this property to check the result of the most recent timestamp validation.
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
Constructors
public init()
Creates a new TimestampInfo object with default field values.
TLSSettings Type
A container for TLS connection settings.
Remarks
The TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP.
Fields
autoValidateCertificates
Bool
Default Value: True
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
baseConfiguration
SecureTransportPredefinedConfigurations
Default Value: 0
Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility.
| stpcDefault | 0 | |
| stpcCompatible | 1 | |
| stpcComprehensiveInsecure | 2 | |
| stpcHighlySecure | 3 |
ciphersuites
String
Default Value: ""
A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases, allowing all ciphersuites to be blanketly enabled or disabled at once.
Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by . Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:
- NULL_NULL_NULL
- RSA_NULL_MD5
- RSA_NULL_SHA
- RSA_RC4_MD5
- RSA_RC4_SHA
- RSA_RC2_MD5
- RSA_IDEA_MD5
- RSA_IDEA_SHA
- RSA_DES_MD5
- RSA_DES_SHA
- RSA_3DES_MD5
- RSA_3DES_SHA
- RSA_AES128_SHA
- RSA_AES256_SHA
- DH_DSS_DES_SHA
- DH_DSS_3DES_SHA
- DH_DSS_AES128_SHA
- DH_DSS_AES256_SHA
- DH_RSA_DES_SHA
- DH_RSA_3DES_SHA
- DH_RSA_AES128_SHA
- DH_RSA_AES256_SHA
- DHE_DSS_DES_SHA
- DHE_DSS_3DES_SHA
- DHE_DSS_AES128_SHA
- DHE_DSS_AES256_SHA
- DHE_RSA_DES_SHA
- DHE_RSA_3DES_SHA
- DHE_RSA_AES128_SHA
- DHE_RSA_AES256_SHA
- DH_ANON_RC4_MD5
- DH_ANON_DES_SHA
- DH_ANON_3DES_SHA
- DH_ANON_AES128_SHA
- DH_ANON_AES256_SHA
- RSA_RC2_MD5_EXPORT
- RSA_RC4_MD5_EXPORT
- RSA_DES_SHA_EXPORT
- DH_DSS_DES_SHA_EXPORT
- DH_RSA_DES_SHA_EXPORT
- DHE_DSS_DES_SHA_EXPORT
- DHE_RSA_DES_SHA_EXPORT
- DH_ANON_RC4_MD5_EXPORT
- DH_ANON_DES_SHA_EXPORT
- RSA_CAMELLIA128_SHA
- DH_DSS_CAMELLIA128_SHA
- DH_RSA_CAMELLIA128_SHA
- DHE_DSS_CAMELLIA128_SHA
- DHE_RSA_CAMELLIA128_SHA
- DH_ANON_CAMELLIA128_SHA
- RSA_CAMELLIA256_SHA
- DH_DSS_CAMELLIA256_SHA
- DH_RSA_CAMELLIA256_SHA
- DHE_DSS_CAMELLIA256_SHA
- DHE_RSA_CAMELLIA256_SHA
- DH_ANON_CAMELLIA256_SHA
- PSK_RC4_SHA
- PSK_3DES_SHA
- PSK_AES128_SHA
- PSK_AES256_SHA
- DHE_PSK_RC4_SHA
- DHE_PSK_3DES_SHA
- DHE_PSK_AES128_SHA
- DHE_PSK_AES256_SHA
- RSA_PSK_RC4_SHA
- RSA_PSK_3DES_SHA
- RSA_PSK_AES128_SHA
- RSA_PSK_AES256_SHA
- RSA_SEED_SHA
- DH_DSS_SEED_SHA
- DH_RSA_SEED_SHA
- DHE_DSS_SEED_SHA
- DHE_RSA_SEED_SHA
- DH_ANON_SEED_SHA
- SRP_SHA_3DES_SHA
- SRP_SHA_RSA_3DES_SHA
- SRP_SHA_DSS_3DES_SHA
- SRP_SHA_AES128_SHA
- SRP_SHA_RSA_AES128_SHA
- SRP_SHA_DSS_AES128_SHA
- SRP_SHA_AES256_SHA
- SRP_SHA_RSA_AES256_SHA
- SRP_SHA_DSS_AES256_SHA
- ECDH_ECDSA_NULL_SHA
- ECDH_ECDSA_RC4_SHA
- ECDH_ECDSA_3DES_SHA
- ECDH_ECDSA_AES128_SHA
- ECDH_ECDSA_AES256_SHA
- ECDHE_ECDSA_NULL_SHA
- ECDHE_ECDSA_RC4_SHA
- ECDHE_ECDSA_3DES_SHA
- ECDHE_ECDSA_AES128_SHA
- ECDHE_ECDSA_AES256_SHA
- ECDH_RSA_NULL_SHA
- ECDH_RSA_RC4_SHA
- ECDH_RSA_3DES_SHA
- ECDH_RSA_AES128_SHA
- ECDH_RSA_AES256_SHA
- ECDHE_RSA_NULL_SHA
- ECDHE_RSA_RC4_SHA
- ECDHE_RSA_3DES_SHA
- ECDHE_RSA_AES128_SHA
- ECDHE_RSA_AES256_SHA
- ECDH_ANON_NULL_SHA
- ECDH_ANON_RC4_SHA
- ECDH_ANON_3DES_SHA
- ECDH_ANON_AES128_SHA
- ECDH_ANON_AES256_SHA
- RSA_NULL_SHA256
- RSA_AES128_SHA256
- RSA_AES256_SHA256
- DH_DSS_AES128_SHA256
- DH_RSA_AES128_SHA256
- DHE_DSS_AES128_SHA256
- DHE_RSA_AES128_SHA256
- DH_DSS_AES256_SHA256
- DH_RSA_AES256_SHA256
- DHE_DSS_AES256_SHA256
- DHE_RSA_AES256_SHA256
- DH_ANON_AES128_SHA256
- DH_ANON_AES256_SHA256
- RSA_AES128_GCM_SHA256
- RSA_AES256_GCM_SHA384
- DHE_RSA_AES128_GCM_SHA256
- DHE_RSA_AES256_GCM_SHA384
- DH_RSA_AES128_GCM_SHA256
- DH_RSA_AES256_GCM_SHA384
- DHE_DSS_AES128_GCM_SHA256
- DHE_DSS_AES256_GCM_SHA384
- DH_DSS_AES128_GCM_SHA256
- DH_DSS_AES256_GCM_SHA384
- DH_ANON_AES128_GCM_SHA256
- DH_ANON_AES256_GCM_SHA384
- ECDHE_ECDSA_AES128_SHA256
- ECDHE_ECDSA_AES256_SHA384
- ECDH_ECDSA_AES128_SHA256
- ECDH_ECDSA_AES256_SHA384
- ECDHE_RSA_AES128_SHA256
- ECDHE_RSA_AES256_SHA384
- ECDH_RSA_AES128_SHA256
- ECDH_RSA_AES256_SHA384
- ECDHE_ECDSA_AES128_GCM_SHA256
- ECDHE_ECDSA_AES256_GCM_SHA384
- ECDH_ECDSA_AES128_GCM_SHA256
- ECDH_ECDSA_AES256_GCM_SHA384
- ECDHE_RSA_AES128_GCM_SHA256
- ECDHE_RSA_AES256_GCM_SHA384
- ECDH_RSA_AES128_GCM_SHA256
- ECDH_RSA_AES256_GCM_SHA384
- PSK_AES128_GCM_SHA256
- PSK_AES256_GCM_SHA384
- DHE_PSK_AES128_GCM_SHA256
- DHE_PSK_AES256_GCM_SHA384
- RSA_PSK_AES128_GCM_SHA256
- RSA_PSK_AES256_GCM_SHA384
- PSK_AES128_SHA256
- PSK_AES256_SHA384
- PSK_NULL_SHA256
- PSK_NULL_SHA384
- DHE_PSK_AES128_SHA256
- DHE_PSK_AES256_SHA384
- DHE_PSK_NULL_SHA256
- DHE_PSK_NULL_SHA384
- RSA_PSK_AES128_SHA256
- RSA_PSK_AES256_SHA384
- RSA_PSK_NULL_SHA256
- RSA_PSK_NULL_SHA384
- RSA_CAMELLIA128_SHA256
- DH_DSS_CAMELLIA128_SHA256
- DH_RSA_CAMELLIA128_SHA256
- DHE_DSS_CAMELLIA128_SHA256
- DHE_RSA_CAMELLIA128_SHA256
- DH_ANON_CAMELLIA128_SHA256
- RSA_CAMELLIA256_SHA256
- DH_DSS_CAMELLIA256_SHA256
- DH_RSA_CAMELLIA256_SHA256
- DHE_DSS_CAMELLIA256_SHA256
- DHE_RSA_CAMELLIA256_SHA256
- DH_ANON_CAMELLIA256_SHA256
- ECDHE_ECDSA_CAMELLIA128_SHA256
- ECDHE_ECDSA_CAMELLIA256_SHA384
- ECDH_ECDSA_CAMELLIA128_SHA256
- ECDH_ECDSA_CAMELLIA256_SHA384
- ECDHE_RSA_CAMELLIA128_SHA256
- ECDHE_RSA_CAMELLIA256_SHA384
- ECDH_RSA_CAMELLIA128_SHA256
- ECDH_RSA_CAMELLIA256_SHA384
- RSA_CAMELLIA128_GCM_SHA256
- RSA_CAMELLIA256_GCM_SHA384
- DHE_RSA_CAMELLIA128_GCM_SHA256
- DHE_RSA_CAMELLIA256_GCM_SHA384
- DH_RSA_CAMELLIA128_GCM_SHA256
- DH_RSA_CAMELLIA256_GCM_SHA384
- DHE_DSS_CAMELLIA128_GCM_SHA256
- DHE_DSS_CAMELLIA256_GCM_SHA384
- DH_DSS_CAMELLIA128_GCM_SHA256
- DH_DSS_CAMELLIA256_GCM_SHA384
- DH_anon_CAMELLIA128_GCM_SHA256
- DH_anon_CAMELLIA256_GCM_SHA384
- ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
- ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
- ECDH_ECDSA_CAMELLIA128_GCM_SHA256
- ECDH_ECDSA_CAMELLIA256_GCM_SHA384
- ECDHE_RSA_CAMELLIA128_GCM_SHA256
- ECDHE_RSA_CAMELLIA256_GCM_SHA384
- ECDH_RSA_CAMELLIA128_GCM_SHA256
- ECDH_RSA_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_GCM_SHA256
- PSK_CAMELLIA256_GCM_SHA384
- DHE_PSK_CAMELLIA128_GCM_SHA256
- DHE_PSK_CAMELLIA256_GCM_SHA384
- RSA_PSK_CAMELLIA128_GCM_SHA256
- RSA_PSK_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_SHA256
- PSK_CAMELLIA256_SHA384
- DHE_PSK_CAMELLIA128_SHA256
- DHE_PSK_CAMELLIA256_SHA384
- RSA_PSK_CAMELLIA128_SHA256
- RSA_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_CAMELLIA128_SHA256
- ECDHE_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_RC4_SHA
- ECDHE_PSK_3DES_SHA
- ECDHE_PSK_AES128_SHA
- ECDHE_PSK_AES256_SHA
- ECDHE_PSK_AES128_SHA256
- ECDHE_PSK_AES256_SHA384
- ECDHE_PSK_NULL_SHA
- ECDHE_PSK_NULL_SHA256
- ECDHE_PSK_NULL_SHA384
- ECDHE_RSA_CHACHA20_POLY1305_SHA256
- ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
- DHE_RSA_CHACHA20_POLY1305_SHA256
- PSK_CHACHA20_POLY1305_SHA256
- ECDHE_PSK_CHACHA20_POLY1305_SHA256
- DHE_PSK_CHACHA20_POLY1305_SHA256
- RSA_PSK_CHACHA20_POLY1305_SHA256
- AES128_GCM_SHA256
- AES256_GCM_SHA384
- CHACHA20_POLY1305_SHA256
- AES128_CCM_SHA256
- AES128_CCM8_SHA256
clientAuth
ClientAuthTypes
Default Value: 0
Enables or disables certificate-based client authentication.
Set this property to true to tune up the client authentication type:
| ccatNoAuth | 0 | |
| ccatRequestCert | 1 | |
| ccatRequireCert | 2 |
ecCurves
String
Default Value: ""
Defines the elliptic curves to enable.
extensions
String
Default Value: ""
Provides access to TLS extensions.
forceResumeIfDestinationChanges
Bool
Default Value: False
Whether to force TLS session resumption when the destination address changes.
preSharedIdentity
String
Default Value: ""
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
preSharedKey
String
Default Value: ""
Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
preSharedKeyCiphersuite
String
Default Value: ""
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
renegotiationAttackPreventionMode
RenegotiationAttackPreventionModes
Default Value: 2
Selects the renegotiation attack prevention mechanism.
The following options are available:
| crapmCompatible | 0 | TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled). |
| crapmStrict | 1 | Renegotiation attack prevention is enabled and enforced. |
| crapmAuto | 2 | Automatically choose whether to enable or disable renegotiation attack prevention. |
revocationCheck
RevocationCheckKinds
Default Value: 1
Specifies the kind(s) of revocation check to perform.
Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.
| crcNone | 0 | No revocation checking. |
| crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. |
| crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. |
| crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. |
| crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. |
| crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. |
| crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. |
| crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. |
| crcAnyOCSPOrCRL | 8 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first. |
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.
sslOptions
Int32
Default Value: 16
Various SSL (TLS) protocol options, set of
| cssloExpectShutdownMessage | 0x001 | Wait for the close-notify message when shutting down the connection |
| cssloOpenSSLDTLSWorkaround | 0x002 | (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions |
| cssloDisableKexLengthAlignment | 0x004 | Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it. |
| cssloForceUseOfClientCertHashAlg | 0x008 | Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it. |
| cssloAutoAddServerNameExtension | 0x010 | Automatically add the server name extension when known |
| cssloAcceptTrustedSRPPrimesOnly | 0x020 | Accept trusted SRP primes only |
| cssloDisableSignatureAlgorithmsExtension | 0x040 | Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it. |
| cssloIntolerateHigherProtocolVersions | 0x080 | (server option) Do not allow fallback from TLS versions higher than currently enabled |
| cssloStickToPrefCertHashAlg | 0x100 | Stick to preferred certificate hash algorithms |
| cssloNoImplicitTLS12Fallback | 0x200 | Disable implicit TLS 1.3 to 1.2 fallbacks |
| cssloUseHandshakeBatches | 0x400 | Send the handshake message as large batches rather than individually |
tlsMode
SSLModes
Default Value: 0
Specifies the TLS mode to use.
| smDefault | 0 | |
| smNoTLS | 1 | Do not use TLS |
| smExplicitTLS | 2 | Connect to the server without any encryption and then request an SSL session. |
| smImplicitTLS | 3 | Connect to the specified port, and establish the SSL session at once. |
| smMixedTLS | 4 | Connect to the specified port, and establish the SSL session at once, but allow plain data. |
useExtendedMasterSecret
Bool
Default Value: False
Enables the Extended Master Secret Extension, as defined in RFC 7627.
useSessionResumption
Bool
Default Value: False
Enables or disables the TLS session resumption capability.
versions
Int32
Default Value: 16
The SSL/TLS versions to enable by default.
| csbSSL2 | 0x01 | SSL 2 |
| csbSSL3 | 0x02 | SSL 3 |
| csbTLS1 | 0x04 | TLS 1.0 |
| csbTLS11 | 0x08 | TLS 1.1 |
| csbTLS12 | 0x10 | TLS 1.2 |
| csbTLS13 | 0x20 | TLS 1.3 |
Constructors
public init()
Creates a new TLSSettings object.
Config Settings (JAdESVerifier 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.JAdESVerifier Config Settings
The certificate URL is the "x5u" (X.509 URL) Header Parameter that refers to a resource for the X.509 public key certificate or certificate chain corresponding to the key used to digitally sign the JWS or JAdES.
If the value is set to "true", the JWS payload will be represented as a Base64-URL-encoded string.
If the value is "false", the JWS payload will be represented without any encoding.
The default value of this property is "true".
If IgnoreSystemTrust is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as the TrustedCertificates property) are considered trusted.
Supported values are:
| WriteBase64Param | The parameter controls the inclusion of the "b64" header parameter in the signature. When this flag is set, the "b64" header parameter will always be included in the header. Otherwise, the "b64" header parameter will only be included in the header when it is required. | |
| PreferEtsiUClearInstance | The parameter determines whether the EtsiU components should be written as clear JSON instances or as Base64-encoded strings. When this flag is set, EtsiU components will be written as clear JSON instances, if possible. Otherwise, the EtsiU components will be Base64url-encoded strings. |
Key ID is a hint indicating which key was used to secure the JWS or JAdES.
Sample value: '{"addressCountry": "UK", "addressLocality": "London", "postalCode": "N1 7GU", "streetAddress": "20-22 Wenlock Road"}'
This setting is used to provide parameters for some cryptographic schemes. Use the Name1=Value1;Name2=Value2;... syntax to encode the parameters. For example: Scheme=PSS;SaltSize=32;TrailerField=1.
- CA, revocation source, TLS key usage requirements are not mandated
- Violation of OCSP issuer requirements are ignored
- The AuthorityKeyID extension in CRL- and certificate-issuing CAs are ignored (helps with incorrectly renewed certificates)
- Basic constraints and name constraints of CA certificates are ignored
- Some weaker algorithms are tolerated
In case of a timestamping failure, provide new TSA and HTTP settings inside the Notification event handler ('BeforeTimestamp' and 'TimestampError' event IDs).
The following default TSLs are used: EU (European Union) LOTL (list of trusted lists).
The following default TSLs are used: EU (European Union) LOTL (list of trusted lists).
Base Config Settings
You can switch this property off to improve performance if your project only uses known, good private keys.
Supported values are:
| off | No caching (default) | |
| local | Local caching | |
| global | Global caching |
This setting only applies to sessions negotiated with TLS version 1.3.
Supported values are:
| file | File | |
| console | Console | |
| systemlog | System Log (supported for Android only) | |
| debugger | Debugger (supported for VCL for Windows and .Net) |
Supported values are:
| time | Current time | |
| level | Level | |
| package | Package name | |
| module | Module name | |
| class | Class name | |
| method | Method name | |
| threadid | Thread Id | |
| contenttype | Content type | |
| content | Content | |
| all | All details |
Supported filter names are:
| exclude-package | Exclude a package specified in the value | |
| exclude-module | Exclude a module specified in the value | |
| exclude-class | Exclude a class specified in the value | |
| exclude-method | Exclude a method specified in the value | |
| include-package | Include a package specified in the value | |
| include-module | Include a module specified in the value | |
| include-class | Include a class specified in the value | |
| include-method | Include a method specified in the value |
| none | No flush (caching only) | |
| immediate | Immediate flush (real-time logging) | |
| maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
Supported values are:
| none | None (by default) | |
| fatal | Severe errors that cause premature termination. | |
| error | Other runtime errors or unexpected conditions. | |
| warning | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | |
| info | Interesting runtime events (startup/shutdown). | |
| debug | Detailed information on flow of through the system. | |
| trace | More detailed information. |
The default value of this setting is 100.
| none | No rotation | |
| deleteolder | Delete older entries from the cache upon reaching LogMaxEventCount | |
| keepolder | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) |
Supported values are:
| none | No static DNS rules (default) | |
| local | Local static DNS rules | |
| global | Global static DNS rules |
This setting only applies to certificates originating from a Windows system store.
Trappable Errors (JAdESVerifier Module)
JAdESVerifier Errors
| 1048577 | Invalid parameter (SB_ERROR_INVALID_PARAMETER) |
| 1048578 | Invalid configuration (SB_ERROR_INVALID_SETUP) |
| 1048579 | Invalid state (SB_ERROR_INVALID_STATE) |
| 1048580 | Invalid value (SB_ERROR_INVALID_VALUE) |
| 1048581 | Private key not found (SB_ERROR_NO_PRIVATE_KEY) |
| 1048582 | Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) |
| 1048583 | The file was not found (SB_ERROR_NO_SUCH_FILE) |
| 1048584 | Unsupported feature or operation (SB_ERROR_UNSUPPORTED_FEATURE) |
| 1048585 | General error (SB_ERROR_GENERAL_ERROR) |
| 53477377 | The input file does not exist (SB_ERROR_JADES_INPUTFILE_NOT_EXISTS) |