SOAPVerifier Module

Properties   Methods   Events   Config Settings   Errors  

The SOAPVerifier module verifies signed SOAP messages.

Syntax

SecureBlackbox.SOAPVerifier

Remarks

Use this control to verify signatures over signed SOAP messages.

Property List

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

AllSignaturesValidThe cumulative validity of all signatures.
AutoValidateSignaturesSpecifies whether module should validate any present signatures when the document is opened.
BlockedCertificatesThe certificates that must be rejected as trust anchors.
CertificatesA collection of certificates included in the electronic signature.
CheckTrustedListsSpecifies whether the module should attempt to validate chain trust via a known Trusted List.
CRLsA collection of certificate revocation lists embedded into the signature by the signer.
EncodingSpecifies XML encoding.
FIPSModeReserved.
IgnoreChainValidationErrorsMakes the module tolerant to chain validation errors.
InputBytesUse this property to pass the input to module in byte array form.
InputFileA path to the signed SOAP message.
KnownCertificatesAdditional certificates for chain validation.
KnownCRLsAdditional CRLs for chain validation.
KnownOCSPsAdditional OCSP responses for chain validation.
OCSPsA collection of OCSP responses embedded into the signature.
OfflineModeSwitches the module to offline mode.
OutputBytesUse this property to read the output the module object has produced.
OutputFileA file where the extracted SOAP message is to be saved.
ProfileSpecifies a pre-defined profile to apply when creating the signature.
ProxyThe proxy server settings.
ReferencesReferences covered by the signature.
RevocationCheckSpecifies the kind(s) of revocation check to perform for all chain certificates.
SignaturesAll signatures found in the SOAP message.
SocketSettingsManages network connection settings.
TimestampsContains a collection of timestamps for the processed document.
TLSClientChainThe TLS client certificate chain.
TLSServerChainThe TLS server's certificate chain.
TLSSettingsManages TLS layer settings.
TrustedCertificatesA list of trusted certificates for chain validation.
ValidationMomentThe 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.

AddKnownNamespaceAdds known prefix and correspondent namespace URI.
CloseCloses an opened SOAP message.
ConfigSets or retrieves a configuration setting.
DoActionPerforms an additional action.
GetInnerXMLGet the inner XML content of the selected XML element.
GetOuterXMLGet the outer XML content of the selected XML element.
GetSignedDataReturns the part of the XML document that is covered by the signature.
GetTextContentGet the text content of the selected XML element.
OpenOpens a document for verifying or removing signatures.
ResetResets the module settings.
RevalidateRevalidates a signature in accordance with current settings.
SelectInfoSelect signature information for a specific entity.
SetInnerXMLSet the inner XML content of the selected XML element.
SetTextContentSet the text content of the selected XML element.
UnsignDeletes a signature from the document.
VerifyVerifies a digitally signed SOAP message.

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.

ChainElementDownloadFires when there is a need to download a chain element from an online source.
ChainElementNeededFires when an element required to validate the chain was not located.
ChainElementStoreThis event is fired when a chain element (certificate, CRL, or OCSP response) should be stored along with a signature.
ChainValidatedReports the completion of a certificate chain validation.
ChainValidationProgressThis event is fired multiple times during chain validation to report various stages of the validation procedure.
ErrorInformation about errors during signature verification.
MessageLoadedThis event is fired when the message has been loaded into memory.
NotificationThis event notifies the application about an underlying control flow event.
ReferenceValidatedMarks the end of a reference validation.
ResolveReferenceAsks the application to resolve a reference.
SignatureFoundSignifies the start of signature validation.
SignatureValidatedMarks the completion of the signature validation routine.
TimestampFoundSignifies the start of a timestamp validation routine.
TimestampValidatedReports the completion of the timestamp validation routine.
TLSCertNeededFires when a remote TLS party requests a client certificate.
TLSCertValidateThis event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.
TLSEstablishedFires when a TLS handshake with Host successfully completes.
TLSHandshakeFires when a new TLS handshake is initiated, before the handshake commences.
TLSShutdownReports 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.

AddAllDataObjectsTimestampWhether to add all data objects timestamp during signing.
BinarySecurityTokenIDSpecifies the ID for BinarySecurityToken element.
ClaimedRolesXMLThe XML content of the claimed roles.
ClaimedRoleTextThe text of the claimed role.
CommitmentTypeIndicationAllSignedDataObjects[Index]Specifies the CommitmentTypeIndication's AllSignedDataObjects.
CommitmentTypeIndicationCountThe number of the CommitmentTypeIndication elements.
CommitmentTypeIndicationIdentifier[Index]Specifies the CommitmentTypeIndication's CommitmentTypeId's Identifier.
CommitmentTypeIndicationIdentifierDescription[Index]Specifies the CommitmentTypeIndication's CommitmentTypeId's Description.
CommitmentTypeIndicationIdentifierDocumentationReferences[Index]Specifies the CommitmentTypeIndication's CommitmentTypeId's DocumentationReferences.
CommitmentTypeIndicationIdentifierQualifier[Index]Specifies the CommitmentTypeIndication's CommitmentTypeId's IdentifierQualifier.
CommitmentTypeIndicationObjectReference[Index]Specifies the CommitmentTypeIndication's ObjectReference.
CommitmentTypeIndicationQualifiersXML[Index]The XML content of the CommitmentTypeIndication's Qualifiers.
DataObjectFormatCountThe number of the DataObjectFormat elements.
DataObjectFormatDescription[Index]Specifies the DataObjectFormat's Description.
DataObjectFormatEncoding[Index]Specifies the DataObjectFormat's Encoding.
DataObjectFormatMimeType[Index]Specifies the DataObjectFormat's MimeType.
DataObjectFormatObjectIdentifier[Index]Specifies the DataObjectFormat's ObjectIdentifier's Identifier.
DataObjectFormatObjectIdentifierDescription[Index]Specifies the DataObjectFormat's ObjectIdentifier's Description.
DataObjectFormatObjectIdentifierDocumentationReferences[Index]Specifies the DataObjectFormat's ObjectIdentifier's DocumentationReferences.
DataObjectFormatObjectIdentifierQualifier[Index]Specifies the DataObjectFormat's ObjectIdentifier's IdentifierQualifier.
DataObjectFormatObjectReference[Index]Specifies the DataObjectFormat's ObjectReference.
ExclusiveCanonicalizationPrefixSpecifies the exclusive canonicalization prefix.
HMACKeyThe key value for HMAC.
HMACOutputLengthSets the length of the HMAC output.
HMACSigningUsedWhether to use HMAC signing.
IgnoreTimestampFailureWhether to ignore time-stamping failure during signing.
IncludeKeySpecifies whether to include the signing key to the signature.
IncludeKeyValueSpecifies whether the key value must be included to the signature.
IncludeKnownRevocationInfoToSignatureWhether to include custom revocation info to the signature.
InclusiveNamespacesPrefixListSpecifies the InclusiveNamespaces PrefixList.
KeyInfoCustomXMLThe custom XML content for KeyInfo element.
KeyInfoDetailsSpecifies the signing key info details to include to the signature.
KeyInfoIDSpecifies the ID for KeyInfo element.
KeyNameContains information about the key used for signing.
NormalizeNewLineControls whether newline combinations should be automatically normalized.
PolicyDescriptionsignature policy description.
PolicyExplicitTextThe explicit text of the user notice.
PolicyUNNumbersThe noticeNumbers part of the NoticeReference CAdES attribute.
PolicyUNOrganizationThe organization part of the NoticeReference qualifier.
ProductionPlaceIdentifies the place of the signature production.
PSSUsedWhether to use RSASSA-PSS algorithm.
QualifyingPropertiesIDSpecifies the ID for QualifyingProperties element.
QualifyingPropertiesObjectIDSpecifies the ID for object with QualifyingProperties element.
QualifyingPropertiesReferenceCountThe number of the QualifyingPropertiesReference elements.
QualifyingPropertiesReferenceID[Index]Specifies the QualifyingPropertiesReference's ID.
QualifyingPropertiesReferenceURI[Index]Specifies the QualifyingPropertiesReference's URI.
RefsTimestampTypeSpecifies references timestamp type to include to the signature.
SecurityTokenReferenceIDSpecifies the ID for SecurityTokenReference element.
SignatureIDSpecifies the ID for Signature element.
SignaturePrefixSpecifies the signature prefix.
SignatureValueIDSpecifies the ID for SignatureValue element.
SignedInfoIDSpecifies the ID for SignedInfo element.
SignedPropertiesIDSpecifies the ID for SignedProperties element.
SignedPropertiesReferenceCanonicalizationMethodSpecifies the canonicalization method used in SignedProperties reference.
SignedPropertiesReferenceHashAlgorithmSpecifies the hash algorithm used in SignedProperties reference.
SignedPropertiesReferenceIDSpecifies the ID for Reference element that points to SignedProperties element.
SignedPropertiesReferenceInclusiveNamespacesPrefixListSpecifies the InclusiveNamespaces PrefixList used in SignedProperties reference.
SignedPropertiesReferenceIndexSpecifies the index of SignedProperties reference.
SignedSignaturePropertiesIDSpecifies the ID for SignedSignatureProperties element.
SigningCertificatesChainThe indicator of which certificates should be/are included as the signing chain.
SigningCertificatesHashAlgorithmSpecifies the hash algorithm used for SigningCertificates.
SigPolicyDescriptionsignature policy description.
SigPolicyExplicitTextThe explicit text of the user notice.
SigPolicyHashThe EPES policy hash.
SigPolicyHashAlgorithmThe hash algorithm that was used to generate the EPES policy hash.
SigPolicyIDThe EPES policy ID.
SigPolicyNoticeNumbersThe noticeNumbers part of the NoticeReference CAdES attribute.
SigPolicyNoticeOrganizationThe organization part of the NoticeReference qualifier.
SigPolicyURIThe EPES policy URI.
StripWhitespaceControls whether excessive whitespace characters should be stripped off when loading the document.
TimestampCanonicalizationMethodSpecifies canonicalization method used in timestamp.
TimestampValidationDataDetailsSpecifies timestamp validation data details to include to the signature.
UseHMACSigningWhether to use HMAC signing.
UsePSSWhether to use RSASSA-PSS algorithm.
ValidationDataRefsDetailsSpecifies validation data references details to include to the signature.
ValidationDataRefsHashAlgorithmSpecifies the hash algorithm used in validation data references.
ValidationDataValuesDetailsSpecifies validation data values details to include to the signature.
WriteBOMSpecifies whether byte-order mark should be written when saving the document.
XAdESPrefixSpecifies the XAdES prefix.
XAdESv141PrefixSpecifies the XAdES v1.4.1 prefix.
XMLFormattingSpecifies the signature XML formatting.
ASN1UseGlobalTagCacheControls whether ASN.1 module should use a global object cache.
AssignSystemSmartCardPinsSpecifies whether CSP-level PINs should be assigned to CNG keys.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the module.
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
DNSLocalSuffixThe suffix to assign for TLD names.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HardwareCryptoUsePolicyThe hardware crypto usage policy.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
HttpVersionThe HTTP version to use in any inner HTTP client modules created.
IgnoreExpiredMSCTLSigningCertWhether to tolerate the expired Windows Update signing certificate.
ListDelimiterThe delimiter character for multi-element lists.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
OldClientSideRSAFallbackSpecifies whether the SSH client should use a SHA1 fallback.
PKICacheSpecifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.
PKICachePathSpecifies the file system path where cached PKI data is stored.
ProductVersionReturns the version of the SecureBlackbox library.
ServerSSLDHKeyLengthSets the size of the TLS DHE key exchange group.
StaticDNSSpecifies whether static DNS rules should be used.
StaticIPAddress[domain]Gets or sets an IP address for the specified domain name.
StaticIPAddressesGets or sets all the static DNS rules.
TagAllows to store any custom data.
TLSSessionGroupSpecifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetimeSpecifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeIntervalSpecifies how often the session cache should remove the expired TLS sessions.
UseCRLObjectCachingSpecifies whether reuse of loaded CRL objects is enabled.
UseInternalRandomSwitches between SecureBlackbox-own and platform PRNGs.
UseLegacyAdESValidationEnables legacy AdES validation mode.
UseOCSPResponseObjectCachingSpecifies whether reuse of loaded OCSP response objects is enabled.
UseOwnDNSResolverSpecifies whether the client modules should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemNativeSizeCalculationAn internal CryptoAPI access tweak.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.
XMLRDNDescriptorName[OID]Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.
XMLRDNDescriptorPriority[OID]Specifies the priority of descriptor names associated with a specific OID.
XMLRDNDescriptorReverseOrderSpecifies whether to reverse the order of descriptors in RDN.
XMLRDNDescriptorSeparatorSpecifies the separator used between descriptors in RDN.

AllSignaturesValid Property (SOAPVerifier 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 (SOAPVerifier Module)

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

Syntax

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


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

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

Default Value

True

Remarks

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

BlockedCertificates Property (SOAPVerifier 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 (SOAPVerifier 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 (SOAPVerifier 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).

CRLs Property (SOAPVerifier 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.

Encoding Property (SOAPVerifier Module)

Specifies XML encoding.

Syntax

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


@property (nonatomic,readwrite,assign,getter=encoding,setter=setEncoding:) NSString* encoding;

- (NSString*)encoding;
- (void)setEncoding :(NSString*)newEncoding;

Default Value

""

Remarks

Use this property to specify the encoding to apply to the XML documents.

FIPSMode Property (SOAPVerifier Module)

Reserved.

Syntax

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


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

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

Default Value

False

Remarks

This property is reserved for future use.

IgnoreChainValidationErrors Property (SOAPVerifier 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 (SOAPVerifier 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 (SOAPVerifier Module)

A path to the signed SOAP message.

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 a path to the SOAP message to be verified.

KnownCertificates Property (SOAPVerifier 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 (SOAPVerifier 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 (SOAPVerifier 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 (SOAPVerifier 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 (SOAPVerifier 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 (SOAPVerifier 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 (SOAPVerifier Module)

A file where the extracted SOAP message is to be saved.

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

Provide a path to the file where the updated SOAP message should be saved.

Profile Property (SOAPVerifier 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 (SOAPVerifier 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.

References Property (SOAPVerifier Module)

References covered by the signature.

Syntax

public var references: Array<XMLReference> {
  get {...}
}


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

- (int)referenceCount;

- (BOOL)referenceAutoGenerateElementId:(int)referenceIndex;

- (int)referenceCanonicalizationMethod:(int)referenceIndex;

- (NSString*)referenceCustomElementId:(int)referenceIndex;

- (NSString*)referenceDataObjectDescription:(int)referenceIndex;

- (NSString*)referenceDataObjectEncoding:(int)referenceIndex;

- (NSString*)referenceDataObjectIdentifier:(int)referenceIndex;

- (NSString*)referenceDataObjectMimeType:(int)referenceIndex;

- (NSData*)referenceDigestValue:(int)referenceIndex;

- (long long)referenceHandle:(int)referenceIndex;

- (BOOL)referenceHasDataObjectFormat:(int)referenceIndex;

- (NSString*)referenceHashAlgorithm:(int)referenceIndex;

- (BOOL)referenceHasURI:(int)referenceIndex;

- (NSString*)referenceID:(int)referenceIndex;

- (NSString*)referenceInclusiveNamespacesPrefixList:(int)referenceIndex;

- (NSString*)referenceReferenceType:(int)referenceIndex;

- (NSData*)referenceTargetData:(int)referenceIndex;

- (int)referenceTargetType:(int)referenceIndex;

- (NSString*)referenceTargetXMLElement:(int)referenceIndex;

- (NSString*)referenceURI:(int)referenceIndex;

- (BOOL)referenceUseBase64Transform:(int)referenceIndex;

- (BOOL)referenceUseEnvelopedSignatureTransform:(int)referenceIndex;

- (BOOL)referenceUseXPathFilter2Transform:(int)referenceIndex;

- (BOOL)referenceUseXPathTransform:(int)referenceIndex;

- (BOOL)referenceValidationResult:(int)referenceIndex;

- (NSString*)referenceXPathExpression:(int)referenceIndex;

- (NSString*)referenceXPathFilter2Expressions:(int)referenceIndex;

- (NSString*)referenceXPathFilter2Filters:(int)referenceIndex;

- (NSString*)referenceXPathFilter2PrefixList:(int)referenceIndex;

- (NSString*)referenceXPathPrefixList:(int)referenceIndex;

Default Value

""

Remarks

Use this property to get the references to the data covered by the signature.

RevocationCheck Property (SOAPVerifier Module)

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

Syntax

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

public enum SOAPVerifierRevocationChecks: 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.

crcNone0No revocation checking.
crcAuto1Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future.
crcAllCRL2All provided CRL endpoints will be checked, and all checks must succeed.
crcAllOCSP3All provided OCSP endpoints will be checked, and all checks must succeed.
crcAllCRLAndOCSP4All provided CRL and OCSP endpoints will be checked, and all checks must succeed.
crcAnyCRL5All provided CRL endpoints will be checked, and at least one check must succeed.
crcAnyOCSP6All provided OCSP endpoints will be checked, and at least one check must succeed.
crcAnyCRLOrOCSP7All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first.
crcAnyOCSPOrCRL8All 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 (SOAPVerifier Module)

All signatures found in the SOAP message.

Syntax

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


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

- (int)signatureCount;

- (int)signatureCanonicalizationMethod:(int)signatureIndex;

- (int)signatureChainValidationDetails:(int)signatureIndex;

- (int)signatureChainValidationResult:(int)signatureIndex;

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

- (int)signatureCompatibilityErrors:(int)signatureIndex;

- (BOOL)signatureContainsLongTermInfo:(int)signatureIndex;

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

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

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

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

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

- (int)signatureLevel:(int)signatureIndex;

- (NSString*)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)signatureSignatureType:(int)signatureIndex;

- (int)signatureSignatureValidationResult:(int)signatureIndex;

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

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

- (BOOL)signatureTimestamped:(int)signatureIndex;

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

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

- (int)signatureXAdESVersion:(int)signatureIndex;

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

Default Value

""

Remarks

This property contains a list of all signatures made over the SOAP message.

SocketSettings Property (SOAPVerifier 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 (SOAPVerifier 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 (SOAPVerifier 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 (SOAPVerifier 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 (SOAPVerifier 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 (SOAPVerifier 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 (SOAPVerifier 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.

AddKnownNamespace Method (SOAPVerifier Module)

Adds known prefix and correspondent namespace URI.

Syntax

public func addKnownNamespace(prefix: String, uri: String) throws -> Void

- (void)addKnownNamespace:(NSString*)prefix :(NSString*)URI;

Remarks

Use this method to add a known prefix and namespace URI that are used in XPath expression within XMLElement/XMLNode property, and within TargetXMLElement and XPathPrefixList properties of the references.

Close Method (SOAPVerifier Module)

Closes an opened SOAP message.

Syntax

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

- (void)close:(BOOL)saveChanges;

Remarks

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

Config Method (SOAPVerifier Module)

Sets or retrieves a configuration setting.

Syntax

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

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

Remarks

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

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

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

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

DoAction Method (SOAPVerifier Module)

Performs an additional action.

Syntax

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

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

Remarks

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

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

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

Common ActionIDs:

ActionParametersReturned valueDescription
ResetTrustedListCachenonenoneClears the cached list of trusted lists.
ResetCertificateCachenonenoneClears the cached certificates.
ResetCRLCachenonenoneClears the cached CRLs.
ResetOCSPResponseCachenonenoneClears the cached OCSP responses.

GetInnerXML Method (SOAPVerifier Module)

Get the inner XML content of the selected XML element.

Syntax

public func getInnerXML(xPath: String) throws -> String

- (NSString*)getInnerXML:(NSString*)XPath;

Remarks

Call this method to get the inner XML content of the selected XML element.

GetOuterXML Method (SOAPVerifier Module)

Get the outer XML content of the selected XML element.

Syntax

public func getOuterXML(xPath: String) throws -> String

- (NSString*)getOuterXML:(NSString*)XPath;

Remarks

Call this method to get the outer XML content of the selected XML element.

GetSignedData Method (SOAPVerifier Module)

Returns the part of the XML document that is covered by the signature.

Syntax

public func getSignedData(sigLabel: String, refIndex: Int32) throws -> Void

- (void)getSignedData:(NSString*)sigLabel :(int)refIndex;

Remarks

Use this method to retrieve the part of the XML document or data that is covered by the SigLabel signature and referenced by RefIndex reference.

The output can be collected in one of the following ways: either by passing the destination path or stream via OutputFile and OutputStream respectively, or by reading the resulting data bytes from the OutputBytes property after the operation completes.

GetTextContent Method (SOAPVerifier Module)

Get the text content of the selected XML element.

Syntax

public func getTextContent(xPath: String) throws -> String

- (NSString*)getTextContent:(NSString*)XPath;

Remarks

Call this method to get the text content of the selected XML element.

Open Method (SOAPVerifier Module)

Opens a document for verifying or removing signatures.

Syntax

public func open() throws -> Void

- (void)open;

Remarks

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

Reset Method (SOAPVerifier 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 (SOAPVerifier Module)

Revalidates a signature in accordance with current settings.

Syntax

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

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

Remarks

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

SelectInfo Method (SOAPVerifier Module)

Select signature information for a specific entity.

Syntax

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

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

Remarks

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

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

sitEntity1Select the current entity

sitParentEntity2Select the parent entity of the current entity

sitTimestamps4Select all timestamps covering the current entity

sitSignatures8Select all signatures covering the current entity

sitSigningChain16Select the signing chain of the current entity

sitEmbeddedCertificates256Select all certificates embedded in the current entity

sitEmbeddedCRLs512Select all CRLs embedded in the current entity

sitEmbeddedOCSPs1024Select all OCSP responses embedded in the current entity

sitEmbeddedRevInfo1792Select the whole pack of embedded revocation information (certificates, CRLs and OCSPs)

sitUsedCertificates4096Select all the certificates used to validate this entity's chain

sitUsedCRLs8192Select all the CRLs used to validate this entity's chain

sitUsedOCSPs16384Select all the OCSP responses used to validate this entity's chain

sitUsedRevInfo28672Select the whole pack of revocation information used to validate this entity's chain (certificates, CRLs, OCSP responses)

sitAttributes65536Select this entity's CMS attributes

sitReferences131072Select this entity's XML references

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

SetInnerXML Method (SOAPVerifier Module)

Set the inner XML content of the selected XML element.

Syntax

public func setInnerXML(xPath: String, value: String) throws -> Void

- (void)setInnerXML:(NSString*)XPath :(NSString*)value;

Remarks

Call this method to set the inner XML content of the selected XML element.

SetTextContent Method (SOAPVerifier Module)

Set the text content of the selected XML element.

Syntax

public func setTextContent(xPath: String, value: String) throws -> Void

- (void)setTextContent:(NSString*)XPath :(NSString*)value;

Remarks

Call this method to set the text content of the selected XML element.

Unsign Method (SOAPVerifier Module)

Deletes a signature from the document.

Syntax

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

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

Remarks

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

Verify Method (SOAPVerifier Module)

Verifies a digitally signed SOAP message.

Syntax

public func verify() throws -> Void

- (void)verify;

Remarks

Call this method to verify a signed SOAP message. Provide the message via InputFile or InputStream property.

ChainElementDownload Event (SOAPVerifier 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.

veaAuto0Handle the action automatically (the default behaviour)

veaContinue1Accept the request implied by the event (accept the certificate, allow the object retrieval)

veaReject2Reject the request implied by the event (reject the certificate, disallow the object retrieval)

veaAcceptNow3Accept the validated certificate immediately

veaAbortNow4Abort the validation, reject the certificate

cekUnknown0Unknown or unsupported element type

cekCertificate1An X.509 certificate

cekCRL2A CRL

cekOCSP3An OCSP response

ChainElementNeeded Event (SOAPVerifier Module)

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

Syntax

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

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

Remarks

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

cekUnknown0Unknown or unsupported element type

cekCertificate1An X.509 certificate

cekCRL2A CRL

cekOCSP3An OCSP response

ChainElementStore Event (SOAPVerifier 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.

cekUnknown0Unknown or unsupported element type

cekCertificate1An X.509 certificate

cekCRL2A CRL

cekOCSP3An OCSP response

ChainValidated Event (SOAPVerifier 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.

cvtValid0The chain is valid

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

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

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

Any other value reports a failure, and ValidationDetails provides more details on its reasons.
cvrBadData0x0001One or more certificates in the validation path are malformed

cvrRevoked0x0002One or more certificates are revoked

cvrNotYetValid0x0004One or more certificates are not yet valid

cvrExpired0x0008One or more certificates are expired

cvrInvalidSignature0x0010A certificate contains a non-valid digital signature

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

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

cvrCRLNotVerified0x0080One or more CRLs could not be verified

cvrOCSPNotVerified0x0100One or more OCSP responses could not be verified

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

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

cvrBlocked0x0800One or more certificates are blocked

cvrFailure0x1000General validation failure

cvrChainLoop0x2000Chain loop: one of the CA certificates recursively signs itself

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

cvrUserEnforced0x8000The chain was considered invalid following intervention from a user code

ChainValidationProgress Event (SOAPVerifier 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.

veaAuto0Handle the action automatically (the default behaviour)

veaContinue1Accept the request implied by the event (accept the certificate, allow the object retrieval)

veaReject2Reject the request implied by the event (reject the certificate, disallow the object retrieval)

veaAcceptNow3Accept the validated certificate immediately

veaAbortNow4Abort the validation, reject the certificate

Error Event (SOAPVerifier Module)

Information about errors during signature verification.

Syntax

func onError(errorCode: Int32, description: String)

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

Remarks

The event is fired in case of exceptional conditions during verification.

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

MessageLoaded Event (SOAPVerifier Module)

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

Syntax

func onMessageLoaded(cancel: inout Bool)

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

Remarks

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

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

Notification Event (SOAPVerifier Module)

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

Syntax

func onNotification(eventID: String, eventParam: String)

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

Remarks

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

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

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

MessageLoadedNotifies the application that the SOAP message has been loaded. This is a backwards-compatibility-only notification: use OnMessageLoaded event instead.
RetrieveQualifyingPropertiesTBD
SignaturesLoadedNotifies the application that the component has finished loading signatures.
BeforeTimestampThis event is fired before a timestamp is requested from the timestamping authority. Use the event handler to modify TSA and HTTP settings.
TimestampErrorThis event is only fired if the class failed to obtain a timestamp from the timestamping authority. The EventParam parameter contains extended error info.
TimestampRequestA 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.

ReferenceValidated Event (SOAPVerifier Module)

Marks the end of a reference validation.

Syntax

func onReferenceValidated(referenceIndex: Int32, id: String, uri: String, refType: String, digestValid: Bool)

- (void)onReferenceValidated:(int)referenceIndex :(NSString*)ID :(NSString*)URI :(NSString*)refType :(BOOL)digestValid;

Remarks

The class fires this event to report completion of a reference validation. A reference is a building block of a signature as it binds signature coverage to a particular piece of the document.

ResolveReference Event (SOAPVerifier Module)

Asks the application to resolve a reference.

Syntax

func onResolveReference(referenceIndex: Int32, uri: String)

- (void)onResolveReference:(int)referenceIndex :(NSString*)URI;

Remarks

This event is fired when the control could not automatically resolve a reference and requires custom treatment.

URI contains a reference to the data.

ReferenceIndex specifies the index of the reference to process.

Based on the reference's URI the event handler should set either TargetXMLElement or TargetData property of the reference.

SignatureFound Event (SOAPVerifier 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 (SOAPVerifier 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.

svtValid0The signature is valid

svtUnknown1Signature validity is unknown

svtCorrupted2The signature is corrupted

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

svtFailure4General failure

svtReferenceCorrupted5Reference corrupted (XML-based signatures only)

TimestampFound Event (SOAPVerifier 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 (SOAPVerifier 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.

svtValid0The signature is valid

svtUnknown1Signature validity is unknown

svtCorrupted2The signature is corrupted

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

svtFailure4General failure

svtReferenceCorrupted5Reference corrupted (XML-based signatures only)

TLSCertNeeded Event (SOAPVerifier Module)

Fires when a remote TLS party requests a client certificate.

Syntax

func onTLSCertNeeded(host: String, caNames: String)

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

Remarks

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

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

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

TLSCertValidate Event (SOAPVerifier 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 (SOAPVerifier 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 (SOAPVerifier 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 (SOAPVerifier 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.

The following fields are available:
  • Bytes
  • CA
  • CAKeyID
  • CertType
  • CRLDistributionPoints
  • Curve
  • Fingerprint
  • FriendlyName
  • Handle
  • HashAlgorithm
  • Issuer
  • IssuerRDN
  • KeyAlgorithm
  • KeyBits
  • KeyFingerprint
  • KeyUsage
  • KeyValid
  • OCSPLocations
  • OCSPNoCheck
  • Origin
  • PolicyIDs
  • PrivateKeyBytes
  • PrivateKeyExists
  • PrivateKeyExtractable
  • PublicKeyBytes
  • Qualified
  • QualifiedStatements
  • Qualifiers
  • SelfSigned
  • SerialNumber
  • SigAlgorithm
  • Source
  • Subject
  • SubjectAlternativeName
  • SubjectKeyID
  • SubjectRDN
  • Valid
  • ValidFrom
  • ValidTo

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

    fingerprint
    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_SHA1SHA1
    SB_HASH_ALGORITHM_SHA224SHA224
    SB_HASH_ALGORITHM_SHA256SHA256
    SB_HASH_ALGORITHM_SHA384SHA384
    SB_HASH_ALGORITHM_SHA512SHA512
    SB_HASH_ALGORITHM_MD2MD2
    SB_HASH_ALGORITHM_MD4MD4
    SB_HASH_ALGORITHM_MD5MD5
    SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
    SB_HASH_ALGORITHM_CRC32CRC32
    SB_HASH_ALGORITHM_SSL3SSL3
    SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
    SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
    SB_HASH_ALGORITHM_POLY1305POLY1305
    SB_HASH_ALGORITHM_SHA3_224SHA3_224
    SB_HASH_ALGORITHM_SHA3_256SHA3_256
    SB_HASH_ALGORITHM_SHA3_384SHA3_384
    SB_HASH_ALGORITHM_SHA3_512SHA3_512
    SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
    SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
    SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
    SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
    SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
    SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
    SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
    SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
    SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
    SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
    SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
    SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

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

    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:

    ckuUnknown0x00000Unknown key usage

    ckuDigitalSignature0x00001Digital signature

    ckuNonRepudiation0x00002Non-repudiation

    ckuKeyEncipherment0x00004Key encipherment

    ckuDataEncipherment0x00008Data encipherment

    ckuKeyAgreement0x00010Key agreement

    ckuKeyCertSign0x00020Certificate signing

    ckuCRLSign0x00040Revocation signing

    ckuEncipherOnly0x00080Encipher only

    ckuDecipherOnly0x00100Decipher only

    ckuServerAuthentication0x00200Server authentication

    ckuClientAuthentication0x00400Client authentication

    ckuCodeSigning0x00800Code signing

    ckuEmailProtection0x01000Email protection

    ckuTimeStamping0x02000Timestamping

    ckuOCSPSigning0x04000OCSP signing

    ckuSmartCardLogon0x08000Smartcard logon

    ckuKeyPurposeClientAuth0x10000Kerberos - client authentication

    ckuKeyPurposeKDC0x20000Kerberos - KDC

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

    keyValid
    Bool (read-only)
    Default Value: False

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

    ocspLocations
    String
    Default Value: ""

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

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

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

    ocspNoCheck
    Bool
    Default Value: False

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

    origin
    Int32 (read-only)
    Default Value: 0

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

    policyIDs
    String
    Default Value: ""

    Contains identifiers (OIDs) of the applicable certificate policies.

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

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

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

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

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

    privateKeyExists
    Bool (read-only)
    Default Value: False

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

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

    privateKeyExtractable
    Bool (read-only)
    Default Value: False

    Indicates whether the private key is extractable (exportable).

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

    Contains the certificate's public key in DER format.

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

    qualified
    Bool (read-only)
    Default Value: False

    Indicates whether the certificate is qualified.

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

    qualifiedStatements
    QualifiedStatementsTypes
    Default Value: 0

    Returns a simplified qualified status of the certificate.

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

    A list of qualifiers.

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

    selfSigned
    Bool (read-only)
    Default Value: False

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

    serialNumber
    Data
    Default Value: ""

    Returns the certificate's serial number.

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

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

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

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

    source
    PKISources (read-only)
    Default Value: 0

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

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

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

    subjectAlternativeName
    String
    Default Value: ""

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

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

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

    subjectKeyID
    Data
    Default Value: ""

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

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

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

    subjectRDN
    String
    Default Value: ""

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

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

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

    valid
    Bool (read-only)
    Default Value: False

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

    validFrom
    String
    Default Value: ""

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

    validTo
    String
    Default Value: ""

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

    Constructors

    public init(stream: )

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

    public init()

    Creates a new object with default field values.

    CRL Type

    Represents a Certificate Revocation List.

    Remarks

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

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

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

    The following fields are available:
  • Bytes
  • CAKeyID
  • EntryCount
  • Handle
  • Issuer
  • IssuerRDN
  • Location
  • NextUpdate
  • SigAlgorithm
  • Source
  • TBS
  • ThisUpdate

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

    OCSPResponse Type

    Represents a single OCSP response originating from an OCSP responder.

    Remarks

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

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

    The following fields are available:
  • Bytes
  • EntryCount
  • Handle
  • Issuer
  • IssuerRDN
  • Location
  • ProducedAt
  • SigAlgorithm
  • Source

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

    The following fields are available:
  • Address
  • Authentication
  • Password
  • Port
  • ProxyType
  • RequestHeaders
  • ResponseBody
  • ResponseHeaders
  • UseIPv6
  • Username

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

    patNoAuthentication0
    patBasic1
    patDigest2
    patNTLM3

    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.

    cptNone0
    cptSocks41
    cptSocks52
    cptWebTunnel3
    cptHTTP4

    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.

    SOAPSignature Type

    The component is a container for an SOAP message signature.

    Remarks

    SOAP message may include any number of signatures. class stores on of them.

    The following fields are available:
  • CanonicalizationMethod
  • ChainValidationDetails
  • ChainValidationResult
  • ClaimedSigningTime
  • CompatibilityErrors
  • ContainsLongTermInfo
  • EntityLabel
  • Handle
  • HashAlgorithm
  • IssuerRDN
  • LastArchivalTime
  • Level
  • ParentEntity
  • PolicyHash
  • PolicyHashAlgorithm
  • PolicyID
  • PolicyURI
  • SerialNumber
  • SignatureBytes
  • SignatureType
  • SignatureValidationResult
  • SubjectKeyID
  • SubjectRDN
  • Timestamped
  • ValidatedSigningTime
  • ValidationLog
  • XAdESVersion
  • XMLElement

    • Fields

    canonicalizationMethod
    XMLCanonicalizationMethods
    Default Value: 0

    The XML canonicalization method that was used for signing.

    Supported canonicalization methods:

    cxcmNone0
    cxcmCanon1
    cxcmCanonComment2
    cxcmExclCanon3
    cxcmExclCanonComment4
    cxcmMinCanon5
    cxcmCanon_v1_16
    cxcmCanonComment_v1_17

    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:

    cvrBadData0x0001One or more certificates in the validation path are malformed

    cvrRevoked0x0002One or more certificates are revoked

    cvrNotYetValid0x0004One or more certificates are not yet valid

    cvrExpired0x0008One or more certificates are expired

    cvrInvalidSignature0x0010A certificate contains a non-valid digital signature

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

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

    cvrCRLNotVerified0x0080One or more CRLs could not be verified

    cvrOCSPNotVerified0x0100One or more OCSP responses could not be verified

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

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

    cvrBlocked0x0800One or more certificates are blocked

    cvrFailure0x1000General validation failure

    cvrChainLoop0x2000Chain loop: one of the CA certificates recursively signs itself

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

    cvrUserEnforced0x8000The chain was considered invalid following intervention from a user code

    chainValidationResult
    ChainValidities (read-only)
    Default Value: 0

    The outcome of a certificate chain validation routine.

    Available options:

    cvtValid0The chain is valid

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

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

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

    Use the ValidationLog property to access the detailed validation log.

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

    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: "Unknown"

    The hash algorithm used for signing.

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

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

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

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

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

    Indicates the most recent archival time of an archived signature

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

    level
    AdESSignatureLevels
    Default Value: 2

    Specifies which level or form of XAdES should be produced.

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

    Use the Generic value to produce XML-DSIG signature.

    The supported levels and forms are:

    aslUnknown0Unknown signature level

    aslGeneric1Generic (this value applicable to XAdES signature only and corresponds to XML-DSIG signature)

    aslBaselineB2Baseline B (B-B, basic)

    aslBaselineT3Baseline T (B-T, timestamped)

    aslBaselineLT4Baseline LT (B-LT, long-term)

    aslBaselineLTA5Baseline LTA (B-LTA, long-term with archived timestamp)

    aslBES6BES (Basic Electronic Signature)

    aslEPES7EPES (Electronic Signature with an Explicit Policy)

    aslT8T (Timestamped)

    aslC9C (T with revocation references)

    aslX10X (C with SigAndRefs timestamp or RefsOnly timestamp) (this value applicable to XAdES signature only)

    aslXType111X Type 1 (C with an ES-C timestamp) (this value applicable to CAdES signature only)

    aslXType212X Type 2 (C with a CertsAndCRLs timestamp) (this value applicable to CAdES signature only)

    aslXL13X-L (X with revocation values) (this value applicable to XAdES signature only)

    aslXLType114X-L Type 1 (C with revocation values and an ES-C timestamp) (this value applicable to CAdES signature only)

    aslXLType215X-L Type 2 (C with revocation values and a CertsAndCRLs timestamp) (this value applicable to CAdES signature only)

    aslA16A (archived)

    aslExtendedBES17Extended BES

    aslExtendedEPES18Extended EPES

    aslExtendedT19Extended T

    aslExtendedC20Extended C

    aslExtendedX21Extended X (this value applicable to XAdES signature only)

    aslExtendedXType122Extended X (type 1) (this value applicable to CAdES signature only)

    aslExtendedXType223Extended X (type 2) (this value applicable to CAdES signature only)

    aslExtendedXLong24Extended X-Long (this value applicable to XAdES signature only)

    aslExtendedXL25Extended X-L (this value applicable to XAdES signature only)

    aslExtendedXLType126Extended XL (type 1) (this value applicable to CAdES signature only)

    aslExtendedXLType227Extended XL (type 2) (this value applicable to CAdES signature only)

    aslExtendedA28Extended A

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

    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_SHA1SHA1
    SB_HASH_ALGORITHM_SHA224SHA224
    SB_HASH_ALGORITHM_SHA256SHA256
    SB_HASH_ALGORITHM_SHA384SHA384
    SB_HASH_ALGORITHM_SHA512SHA512
    SB_HASH_ALGORITHM_MD2MD2
    SB_HASH_ALGORITHM_MD4MD4
    SB_HASH_ALGORITHM_MD5MD5
    SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
    SB_HASH_ALGORITHM_CRC32CRC32
    SB_HASH_ALGORITHM_SSL3SSL3
    SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
    SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
    SB_HASH_ALGORITHM_POLY1305POLY1305
    SB_HASH_ALGORITHM_SHA3_224SHA3_224
    SB_HASH_ALGORITHM_SHA3_256SHA3_256
    SB_HASH_ALGORITHM_SHA3_384SHA3_384
    SB_HASH_ALGORITHM_SHA3_512SHA3_512
    SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
    SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
    SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
    SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
    SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
    SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
    SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
    SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
    SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
    SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
    SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
    SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

    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 SOAP signature.

    signatureType
    SOAPSignatureTypes
    Default Value: 1

    The SOAP signature type to use.

    Use this property to specify the signature type to use when forming the signature.

    Supported values:

    sstUnknown0Unknown signature
    sstWSSSignature1Uses Web Services Security (WS-Security, WSS) signature. It is implemented according to the OASIS Web Services Security extension to SOAP
    sstSOAPSignature2Uses SOAP signature. It is implemented according to the SOAP Security Extensions: Digital Signature.

    signatureValidationResult
    SignatureValidities (read-only)
    Default Value: 0

    The outcome of the cryptographic signature validation.

    The following signature validity values are supported:

    svtValid0The signature is valid

    svtUnknown1Signature validity is unknown

    svtCorrupted2The signature is corrupted

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

    svtFailure4General failure

    svtReferenceCorrupted5Reference corrupted (XML-based signatures only)

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

    Contains the subject key identifier of the signing certificate.

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

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

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

    timestamped
    Bool (read-only)
    Default Value: False

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

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

    Contains the certified signing time.

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

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

    Both times are in UTC.

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

    Contains the complete log of the certificate validation routine.

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

    xAdESVersion
    XAdESVersions
    Default Value: 3

    Specifies XAdES version.

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

    The supported vesions are:

    xavUnknown0Unknown

    xav1111XAdES v1.1.1

    xav1222XAdES v1.2.2

    xav1323XAdES v1.3.2

    xav1414XAdES v1.4.1 (aka v1.4.2)

    xmlElement
    String
    Default Value: ""

    Specifies the XML element where to save the signature or containing the signature.

    This property specifies the XML element where to save the electronic signature or that contains the signature to be validated.

    Supported values are:

    ""an empty string indicates the Document element
    "#id"indicates an XML element with specified Id
    XPath expressionindicates an XML element selected using XPath expression. Use AddKnownNamespace method to specify Prefixes and NamespaceURIs

    For example:

    "/root/data[1]" - indicates the second "data" element under the document element with a name "root"

    "//ns1:data" - indicates a data element. "ns1" prefix should be defined via AddKnownNamespace method.

    Node nameindicates an XML element selected using its NodeName.

    For example: "data" - indicates an XML element with node name "data".

    Constructors

    public init()

    Creates a new SOAP signature object.

    SocketSettings Type

    A container for the socket settings.

    Remarks

    This type is a container for socket-layer parameters.

    The following fields are available:
  • DNSMode
  • DNSPort
  • DNSQueryTimeout
  • DNSServers
  • DNSTotalTimeout
  • IncomingSpeedLimit
  • LocalAddress
  • LocalPort
  • OutgoingSpeedLimit
  • Timeout
  • UseIPv6

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

    dmAuto0
    dmPlatform1
    dmOwn2
    dmOwnSecure3

    dnsPort
    Int32
    Default Value: 0

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

    dnsQueryTimeout
    Int32
    Default Value: 0

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

    dnsServers
    String
    Default Value: ""

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

    dnsTotalTimeout
    Int32
    Default Value: 0

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

    incomingSpeedLimit
    Int32
    Default Value: 0

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

    localAddress
    String
    Default Value: ""

    The local network interface to bind the socket to.

    localPort
    Int32
    Default Value: 0

    The local port number to bind the socket to.

    outgoingSpeedLimit
    Int32
    Default Value: 0

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

    timeout
    Int32
    Default Value: 60000

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

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

    useIPv6
    Bool
    Default Value: False

    Enables or disables IP protocol version 6.

    Constructors

    public init()

    Creates a new SocketSettings object.

    TimestampInfo Type

    A container for timestamp information.

    Remarks

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

    The following fields are available:
  • Accuracy
  • Bytes
  • CertificateIndex
  • ChainValidationDetails
  • ChainValidationResult
  • ContainsLongTermInfo
  • EntityLabel
  • HashAlgorithm
  • ParentEntity
  • SerialNumber
  • Time
  • TimestampType
  • TSAName
  • ValidationLog
  • ValidationResult

    • 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:

    cvrBadData0x0001One or more certificates in the validation path are malformed

    cvrRevoked0x0002One or more certificates are revoked

    cvrNotYetValid0x0004One or more certificates are not yet valid

    cvrExpired0x0008One or more certificates are expired

    cvrInvalidSignature0x0010A certificate contains a non-valid digital signature

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

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

    cvrCRLNotVerified0x0080One or more CRLs could not be verified

    cvrOCSPNotVerified0x0100One or more OCSP responses could not be verified

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

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

    cvrBlocked0x0800One or more certificates are blocked

    cvrFailure0x1000General validation failure

    cvrChainLoop0x2000Chain loop: one of the CA certificates recursively signs itself

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

    cvrUserEnforced0x8000The chain was considered invalid following intervention from a user code

    chainValidationResult
    ChainValidities (read-only)
    Default Value: 0

    The outcome of a certificate chain validation routine.

    Available options:

    cvtValid0The chain is valid

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

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

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

    Use the ValidationLog property to access the detailed validation log.

    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_SHA1SHA1
    SB_HASH_ALGORITHM_SHA224SHA224
    SB_HASH_ALGORITHM_SHA256SHA256
    SB_HASH_ALGORITHM_SHA384SHA384
    SB_HASH_ALGORITHM_SHA512SHA512
    SB_HASH_ALGORITHM_MD2MD2
    SB_HASH_ALGORITHM_MD4MD4
    SB_HASH_ALGORITHM_MD5MD5
    SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
    SB_HASH_ALGORITHM_CRC32CRC32
    SB_HASH_ALGORITHM_SSL3SSL3
    SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
    SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
    SB_HASH_ALGORITHM_POLY1305POLY1305
    SB_HASH_ALGORITHM_SHA3_224SHA3_224
    SB_HASH_ALGORITHM_SHA3_256SHA3_256
    SB_HASH_ALGORITHM_SHA3_384SHA3_384
    SB_HASH_ALGORITHM_SHA3_512SHA3_512
    SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
    SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
    SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
    SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
    SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
    SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
    SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
    SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
    SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
    SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
    SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
    SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

    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:

    tstUnknown0
    tstLegacy1Supported by: Authenticode components

    tstTrusted2Supported by: Authenticode components

    tstGeneric3Supported by: CAdES components

    tstESC4Supported by: CAdES components

    tstContent5Supported by: CAdES components

    tstCertsAndCRLs6Supported by: CAdES components

    tstArchive7Archive timestamp. Supported by: ASiC, CAdES, JAdES, Office, SOAP, XAdES components

    tstArchive28Archive v2 timestamp. Supported by: ASiC, CAdES components

    tstArchive39Archive v3 timestamp. Supported by: ASiC, CAdES components

    tstIndividualDataObjects10Individual data objects timetamp. Supported by: ASiC, Office, SOAP, XAdES components

    tstAllDataObjects11All data objects timestamp. Supported by: ASiC, Office, SOAP, XAdES components

    tstSignature12Signature timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components

    tstRefsOnly13RefsOnly timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components

    tstSigAndRefs14SigAndRefs timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components

    tstSignedData15SignedData timestamp. Supported by: JAdES components

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

    svtValid0The signature is valid

    svtUnknown1Signature validity is unknown

    svtCorrupted2The signature is corrupted

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

    svtFailure4General failure

    svtReferenceCorrupted5Reference corrupted (XML-based signatures only)

    Constructors

    public init()

    Creates a new TimestampInfo object with default field values.

    TLSSettings Type

    A container for TLS connection settings.

    Remarks

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

    The following fields are available:
  • AutoValidateCertificates
  • BaseConfiguration
  • Ciphersuites
  • ClientAuth
  • ECCurves
  • Extensions
  • ForceResumeIfDestinationChanges
  • PreSharedIdentity
  • PreSharedKey
  • PreSharedKeyCiphersuite
  • RenegotiationAttackPreventionMode
  • RevocationCheck
  • SSLOptions
  • TLSMode
  • UseExtendedMasterSecret
  • UseSessionResumption
  • Versions

    • Fields

    autoValidateCertificates
    Bool
    Default Value: True

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

    baseConfiguration
    SecureTransportPredefinedConfigurations
    Default Value: 0

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

    stpcDefault0
    stpcCompatible1
    stpcComprehensiveInsecure2
    stpcHighlySecure3

    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:

    ccatNoAuth0
    ccatRequestCert1
    ccatRequireCert2

    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:

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

    revocationCheck
    RevocationCheckKinds
    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.

    crcNone0No revocation checking.
    crcAuto1Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future.
    crcAllCRL2All provided CRL endpoints will be checked, and all checks must succeed.
    crcAllOCSP3All provided OCSP endpoints will be checked, and all checks must succeed.
    crcAllCRLAndOCSP4All provided CRL and OCSP endpoints will be checked, and all checks must succeed.
    crcAnyCRL5All provided CRL endpoints will be checked, and at least one check must succeed.
    crcAnyOCSP6All provided OCSP endpoints will be checked, and at least one check must succeed.
    crcAnyCRLOrOCSP7All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first.
    crcAnyOCSPOrCRL8All 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

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

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

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

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

    cssloAutoAddServerNameExtension0x010Automatically add the server name extension when known

    cssloAcceptTrustedSRPPrimesOnly0x020Accept trusted SRP primes only

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

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

    cssloStickToPrefCertHashAlg0x100Stick to preferred certificate hash algorithms

    cssloNoImplicitTLS12Fallback0x200Disable implicit TLS 1.3 to 1.2 fallbacks

    cssloUseHandshakeBatches0x400Send the handshake message as large batches rather than individually

    tlsMode
    SSLModes
    Default Value: 0

    Specifies the TLS mode to use.

    smDefault0
    smNoTLS1Do not use TLS
    smExplicitTLS2Connect to the server without any encryption and then request an SSL session.
    smImplicitTLS3Connect to the specified port, and establish the SSL session at once.
    smMixedTLS4Connect 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.

    csbSSL20x01SSL 2

    csbSSL30x02SSL 3

    csbTLS10x04TLS 1.0

    csbTLS110x08TLS 1.1

    csbTLS120x10TLS 1.2

    csbTLS130x20TLS 1.3

    Constructors

    public init()

    Creates a new TLSSettings object.

    XMLReference Type

    Represents an XML reference element.

    Remarks

    XMLReference specifies the digest algorithm and digest value, and, optionally: an identifier of the object being signed, the type of the object, and/or a list of transforms to be applied prior to digesting.

    The following fields are available:
  • AutoGenerateElementId
  • CanonicalizationMethod
  • CustomElementId
  • DataObjectDescription
  • DataObjectEncoding
  • DataObjectIdentifier
  • DataObjectMimeType
  • DigestValue
  • Handle
  • HasDataObjectFormat
  • HashAlgorithm
  • HasURI
  • ID
  • InclusiveNamespacesPrefixList
  • ReferenceType
  • TargetData
  • TargetType
  • TargetXMLElement
  • URI
  • UseBase64Transform
  • UseEnvelopedSignatureTransform
  • UseXPathFilter2Transform
  • UseXPathTransform
  • ValidationResult
  • XPathExpression
  • XPathFilter2Expressions
  • XPathFilter2Filters
  • XPathFilter2PrefixList
  • XPathPrefixList

    • Fields

    autoGenerateElementId
    Bool
    Default Value: False

    Specifies whether the identifier (ID) attribute for a referenced (target) element should be auto-generated during signing. Used when the referenced element doesn't have an ID and CustomElementId and URI properties are empty.

    canonicalizationMethod
    XMLCanonicalizationMethods
    Default Value: 0

    Use this property to specify the canonicalization method for the transform of the reference. Use cxcmNone value to not to include canonicalization transform in transform chain. See XML-Signature Syntax and Processing specification for details.

    cxcmNone0
    cxcmCanon1
    cxcmCanonComment2
    cxcmExclCanon3
    cxcmExclCanonComment4
    cxcmMinCanon5
    cxcmCanon_v1_16
    cxcmCanonComment_v1_17

    customElementId
    String
    Default Value: ""

    Specifies a custom identifier (ID) attribute for a referenced (target) element that will be set on signing. Used when the referenced element doesn't have an ID and URI property is empty.

    dataObjectDescription
    String
    Default Value: ""

    This property contains textual information related to the referenced data object, which is found in the corresponding DataObjectFormat's Description element.

    dataObjectEncoding
    String
    Default Value: ""

    This property contains an indication of the encoding format of the referenced data object, which is found in the corresponding DataObjectFormat's Encoding element.

    dataObjectIdentifier
    String
    Default Value: ""

    This property contains an identifier indicating the type of the referenced data object, which is found in the corresponding DataObjectFormat's ObjectIdentifier element.

    dataObjectMimeType
    String
    Default Value: ""

    This property contains an indication of the MIME type of the referenced data object, which is found in the corresponding DataObjectFormat's MimeType element.

    digestValue
    Data
    Default Value: ""

    Use this property to get or set the value of the digest calculated over the referenced data.

    This property is optional and should be set only if you don't provide the actual data via TargetData or URI. If the data is set, then you don't need to set DigestValue since it will be calculated automatically.

    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());

    hasDataObjectFormat
    Bool
    Default Value: False

    Specifies whether corresponding XAdES DataObjectFormat element is created for the current reference.

    Check this property to find out if the reference has an associated DataObjectFormat element.

    hashAlgorithm
    String
    Default Value: "SHA256"

    Specifies the hash algorithm to be used.

    Supported values:

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

    hasURI
    Bool
    Default Value: True

    Specifies whether the URI is set (even when it is empty).

    id
    String
    Default Value: ""

    A user-defined identifier (ID) attribute of this Reference element.

    inclusiveNamespacesPrefixList
    String
    Default Value: ""

    Use this property to specify InclusiveNamespaces PrefixList for exclusive canonicalization transform of the reference. See XML-Signature Syntax and Processing specification for details.

    referenceType
    String
    Default Value: ""

    The Reference's type attribute as defined in XMLDSIG specification.

    targetData
    Data
    Default Value: ""

    Contains the referenced external data when the digest value is not explicitly specified.

    This property is optional and should only be set if you reference the external data via URI, and you don't provide the digest value explicitly via DigestValue.

    targetType
    XMLReferenceTargetTypes
    Default Value: 0

    The reference's target type to use.

    Use this property to specify the reference's target type to use when forming the signature.

    targetXMLElement
    String
    Default Value: ""

    This property specifies the referenced XML element. Used when the URI property is not set. In this case, the URI value is generated based on the ID of the referenced (target) XML element. If the URI property is set, this property is ignored until the ResolveReference event.

    Supported values are:

    ""an empty string indicates the Document element.
    "#id"indicates an XML element with specified Id.
    XPointer expressionindicates an XML element selected using XPointer expression. Use the AddKnownNamespace method to specify Prefixes and NamespaceURIs

    For example:

    "/root/data[1]" - indicates the second "data" element under the document element with a name "root"

    "//ns1:data" - indicates a data element. "ns1" prefix should be defined via AddKnownNamespace method.

    Node nameindicates an XML element selected using its NodeName.

    For example: "data" - indicates an XML element with node name "data".

    uri
    String
    Default Value: ""

    Use this property to get or set the URL which references the data. If the data is external, the application must set either TargetData or DigestValue. If TargetData is set, the digest is calculated automatically unless it is explicitly set by the application via DigestValue.

    useBase64Transform
    Bool
    Default Value: False

    Specifies whether Base64 transform is included in transform chain.

    useEnvelopedSignatureTransform
    Bool
    Default Value: False

    Specifies whether enveloped signature transform is included in transform chain.

    useXPathFilter2Transform
    Bool
    Default Value: False

    Specifies whether XPath Filter 2.0 transform is included in transform chain.

    useXPathTransform
    Bool
    Default Value: False

    Specifies whether XPath transform is included in transform chain.

    validationResult
    Bool (read-only)
    Default Value: False

    The outcome of the cryptographic reference validation.

    xPathExpression
    String
    Default Value: ""

    Use this property to specify XPath expression for XPath transform of the reference.

    xPathFilter2Expressions
    String
    Default Value: ""

    Use this property to specify XPointer expression(s) for XPath Filter 2.0 transform of the reference.

    xPathFilter2Filters
    String
    Default Value: ""

    Use this property to specify XPointer filter(s) for XPath Filter 2.0 transform of the reference. The prefix list is comma-separated.

    Supported values:

    "intersect"Intersect filter computes the intersection of the selected subtrees with the filter node-set.
    "subtract"Subtract filter computes the subtraction of the selected subtrees with the filter node-set.
    "union"Union filter computes the union of the selected subtrees with the filter node-set.

    xPathFilter2PrefixList
    String
    Default Value: ""

    Use this property to specify a prefix list for XPath Filter 2.0 transform of the reference. The prefix list is space-separated. Namespace URIs that are used are taken from XPathNamespaces property.

    xPathPrefixList
    String
    Default Value: ""

    Use this property to specify a prefix list for XPath transform of the reference. The prefix list is space-separated. Namespace URIs that are used are taken from XPathNamespaces property.

    Constructors

    public init()

    Creates a new XML reference element. 

    public init(iD: )

    Creates a new XML reference element from its ID . 

    public init(iD: , uRI: )

    Creates a new XML reference element from its ID and URI reference to the external data.

    Config Settings (SOAPVerifier 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.

    SOAPVerifier Config Settings

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

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

    BinarySecurityTokenID:   Specifies the ID for BinarySecurityToken element.

    This property contains the identifier (ID) attribute of the wsse:BinarySecurityToken element.

    ClaimedRolesXML:   The XML content of the claimed roles.

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

    ClaimedRoleText:   The text of the claimed role.

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

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

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

    CommitmentTypeIndicationCount:   The number of the CommitmentTypeIndication elements.

    Returns the number of the xades:CommitmentTypeIndication elements available.

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

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

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

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

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

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

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

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

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

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

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

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

    DataObjectFormatCount:   The number of the DataObjectFormat elements.

    Returns the number of the xades:DataObjectFormat elements available.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Index value could be omitted for the first DataObjectFormat element.

    ExclusiveCanonicalizationPrefix:   Specifies the exclusive canonicalization prefix.

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

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

    Special values:

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

    HMACKey:   The key value for HMAC.

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

    HMACOutputLength:   Sets the length of the HMAC output.

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

    HMACSigningUsed:   Whether to use HMAC signing.

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

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

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

    IncludeKey:   Specifies whether to include the signing key to the signature.

    Set this property to True to include the public part of the signing key to the signature.

    IncludeKeyValue:   Specifies whether the key value must be included to the signature.

    Set this property to True if the key value (its public part) should be included to the signature.

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

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

    InclusiveNamespacesPrefixList:   Specifies the InclusiveNamespaces PrefixList.

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

    KeyInfoCustomXML:   The custom XML content for KeyInfo element.

    Use this property to specify the custom XML content of the ds:KeyInfo element.

    The empty elements in the custom XML content act as a placeholder for auto-generated elements.

    For example to change the order of ds:KeyValue and ds:X509Data auto-generated elements use the value: "<X509Data/><KeyValue/>"

    KeyInfoDetails:   Specifies the signing key info details to include to the signature.

    Contains a comma-separated list of values that specifies which signing key info details to include to the signature.

    Supported values are:

    certificateBase64-encoded [X509v3] certificate is placed to the signature
    issuerserialX.509 issuer distinguished name/serial number pair are placed to the signature
    subjectnameX.509 subject distinguished name is placed to the signature
    skiBase64 encoded plain (i.e. non-DER-encoded) value of a X509 V.3 SubjectKeyIdentifier extension is placed to the signature
    crlBase64-encoded certificate revocation list (CRL) is placed to the signature

    KeyInfoID:   Specifies the ID for KeyInfo element.

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

    KeyName:   Contains information about the key used for signing.

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

    NormalizeNewLine:   Controls whether newline combinations should be automatically normalized.

    If set to true (the default value), the component will normalize any non-compliant newline characters to match those appropriate for the operating system.

    PolicyDescription:   signature policy description.

    This property specifies the Description of the signature policy.

    PolicyExplicitText:   The explicit text of the user notice.

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

    PolicyUNNumbers:   The noticeNumbers part of the NoticeReference CAdES attribute.

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

    PolicyUNOrganization:   The organization part of the NoticeReference qualifier.

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

    ProductionPlace:   Identifies the place of the signature production.

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

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

    PSSUsed:   Whether to use RSASSA-PSS algorithm.

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

    QualifyingPropertiesID:   Specifies the ID for QualifyingProperties element.

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

    QualifyingPropertiesObjectID:   Specifies the ID for object with QualifyingProperties element.

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

    QualifyingPropertiesReferenceCount:   The number of the QualifyingPropertiesReference elements.

    Returns the number of the xades:QualifyingPropertiesReference elements available.

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

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

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

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

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

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

    Supported values are:

    SigAndRefsSigAndRefs timestamp
    RefsOnlyRefsOnly timestamp

    SecurityTokenReferenceID:   Specifies the ID for SecurityTokenReference element.

    This property contains the identifier (ID) attribute of the wsse:SecurityTokenReference element.

    SignatureID:   Specifies the ID for Signature element.

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

    SignaturePrefix:   Specifies the signature prefix.

    Specifies the prefix for the Signature elements.

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

    Special values:

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

    SignatureValueID:   Specifies the ID for SignatureValue element.

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

    SignedInfoID:   Specifies the ID for SignedInfo element.

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

    SignedPropertiesID:   Specifies the ID for SignedProperties element.

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

    SignedPropertiesReferenceCanonicalizationMethod:   Specifies the canonicalization method used in SignedProperties reference.

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

    cxcmNone0
    cxcmCanon1
    cxcmCanonComment2
    cxcmExclCanon3
    cxcmExclCanonComment4
    cxcmMinCanon5
    cxcmCanon_v1_16
    cxcmCanonComment_v1_17
    SignedPropertiesReferenceHashAlgorithm:   Specifies the hash algorithm used in SignedProperties reference.

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

    Supported values:

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

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

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

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

    SignedPropertiesReferenceInclusiveNamespacesPrefixList:   Specifies the InclusiveNamespaces PrefixList used in SignedProperties reference.

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

    SignedPropertiesReferenceIndex:   Specifies the index of SignedProperties reference.

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

    SignedSignaturePropertiesID:   Specifies the ID for SignedSignatureProperties element.

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

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

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

    SigningCertificatesHashAlgorithm:   Specifies the hash algorithm used for SigningCertificates.

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

    Supported values:

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

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

    SigPolicyDescription:   signature policy description.

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

    SigPolicyExplicitText:   The explicit text of the user notice.

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

    SigPolicyHash:   The EPES policy hash.

    Use this configuration setting to provide the EPES policy hash.

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

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

    SigPolicyID:   The EPES policy ID.

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

    SigPolicyNoticeNumbers:   The noticeNumbers part of the NoticeReference CAdES attribute.

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

    SigPolicyNoticeOrganization:   The organization part of the NoticeReference qualifier.

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

    SigPolicyURI:   The EPES policy URI.

    Assign the EPES policy URI to this setting.

    StripWhitespace:   Controls whether excessive whitespace characters should be stripped off when loading the document.

    Set this property to true to have the component eliminate excessive whitespace from the document on loading.

    TimestampCanonicalizationMethod:   Specifies canonicalization method used in timestamp.

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

    cxcmNone0
    cxcmCanon1
    cxcmCanonComment2
    cxcmExclCanon3
    cxcmExclCanonComment4
    cxcmMinCanon5
    cxcmCanon_v1_16
    cxcmCanonComment_v1_17
    TimestampValidationDataDetails:   Specifies timestamp validation data details to include to the signature.

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

    Supported values are:

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

    UseHMACSigning:   Whether to use HMAC signing.

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

    UsePSS:   Whether to use RSASSA-PSS algorithm.

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

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

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

    Supported values are:

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

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

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

    Supported values:

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

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

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

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

    Supported values are:

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

    WriteBOM:   Specifies whether byte-order mark should be written when saving the document.

    Set this property to False to disable writing byte-order mark (BOM) when saving the XML document in Unicode encoding.

    XAdESPrefix:   Specifies the XAdES prefix.

    Specifies the prefix for the XAdES elements.

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

    Special values:

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

    XAdESv141Prefix:   Specifies the XAdES v1.4.1 prefix.

    Specifies the prefix for the XAdES v1.4.1 elements.

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

    Special values:

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

    XMLFormatting:   Specifies the signature XML formatting.

    Use this property to specify how the signature should be formatted.

    Supported values:

    "" or "none"no formatting (by default).
    "auto"enables auto-formatting, equivalent to: "indent: 1; indent-char: tab; base64-max-length: 64; starting-level: node"
    Custom values, contains a list of value pairs ("name:value") separated by comma or semicolon:
    indentspecifies indentation level (default is 1)
    indent-charspecifies indentation character: "space" or "tab" (default)
    base64-max-lengthspecifies max length of base64 encoded data, such as signature value, certificate data and etc. (default is 64)
    starting-levelspecifies starting indentation level: non-negative integer or "node" - detected based on parent node, or "root" - detected based on number of parent nodes to a document element (default is "node").
    indent-before-mainspecifies if whitespace characters should be inserted before a main (ds:Signature) element: "auto" (default), "yes" or "no"
    For more preciese formatting use OnFormatText and OnFormatElement events.

    Base Config Settings

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

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

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

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

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

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

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

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

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

    Supported values are:

    offNo caching (default)
    localLocal caching
    globalGlobal caching

    Cookies:   Gets or sets local cookies for the class.

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

    DefDeriveKeyIterations:   Specifies the default key derivation algorithm iteration count.

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

    DNSLocalSuffix:   The suffix to assign for TLD names.

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

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

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

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

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

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

    HardwareCryptoUsePolicy:   The hardware crypto usage policy.

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

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

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

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

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

    IgnoreExpiredMSCTLSigningCert:   Whether to tolerate the expired Windows Update signing certificate.

    It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account.

    ListDelimiter:   The delimiter character for multi-element lists.

    Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence.

    LogDestination:   Specifies the debug log destination.

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

    Supported values are:

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

    LogDetails:   Specifies the debug log details to dump.

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

    Supported values are:

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

    LogFile:   Specifies the debug log filename.

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

    LogFilters:   Specifies the debug log filters.

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

    Supported filter names are:

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

    LogFlushMode:   Specifies the log flush mode.

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

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

    LogLevel:   Specifies the debug log level.

    Use this property to provide the desired debug log level.

    Supported values are:

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

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

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

    The default value of this setting is 100.

    LogRotationMode:   Specifies the log rotation mode.

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

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

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

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

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

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

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

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

    OldClientSideRSAFallback:   Specifies whether the SSH client should use a SHA1 fallback.

    Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak.

    PKICache:   Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.

    The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached.

    Supported Values:

    certificateEnables caching of certificates.
    crlEnables caching of Certificate Revocation Lists (CRLs).
    ocspEnables caching of OCSP (Online Certificate Status Protocol) responses.

    Example (default value): PKICache=certificate,crl,ocsp In this example, the component caches certificates, CRLs, and OCSP responses.

    PKICachePath:   Specifies the file system path where cached PKI data is stored.

    The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts.

    The default value is an empty string - no cached PKI data is stored on disk.

    Example: PKICachePath=C:\Temp\cache In this example, the cached PKI data is stored in the C:\Temp\cache directory.

    ProductVersion:   Returns the version of the SecureBlackbox library.

    This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision).

    ServerSSLDHKeyLength:   Sets the size of the TLS DHE key exchange group.

    Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server.

    StaticDNS:   Specifies whether static DNS rules should be used.

    Set this property to enable or disable static DNS rules for the class. Works only if UseOwnDNSResolver is set to true.

    Supported values are:

    noneNo static DNS rules (default)
    localLocal static DNS rules
    globalGlobal static DNS rules

    StaticIPAddress[domain]:   Gets or sets an IP address for the specified domain name.

    Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the StaticDNS value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are devided by the | (pipe) character.

    StaticIPAddresses:   Gets or sets all the static DNS rules.

    Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If StaticDNS of the class is set to "local", the property returns/restores the rules from/to the internal storage of the class. If StaticDNS of the class is set to "global", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format.

    Tag:   Allows to store any custom data.

    Use this config property to store any custom data.

    TLSSessionGroup:   Specifies the group name of TLS sessions to be used for session resumption.

    Use this property to limit the search of chached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes.

    TLSSessionLifetime:   Specifies lifetime in seconds of the cached TLS session.

    Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes).

    TLSSessionPurgeInterval:   Specifies how often the session cache should remove the expired TLS sessions.

    Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).

    UseCRLObjectCaching:   Specifies whether reuse of loaded CRL objects is enabled.

    This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used.

    UseInternalRandom:   Switches between SecureBlackbox-own and platform PRNGs.

    Allows to switch between internal/native PRNG implementation and the one provided by the platform.

    UseLegacyAdESValidation:   Enables legacy AdES validation mode.

    Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details).

    UseOCSPResponseObjectCaching:   Specifies whether reuse of loaded OCSP response objects is enabled.

    This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used.

    UseOwnDNSResolver:   Specifies whether the client components should use own DNS resolver.

    Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one.

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

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

    UseSystemNativeSizeCalculation:   An internal CryptoAPI access tweak.

    This is an internal setting. Please do not use it unless instructed by the support team.

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

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

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

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

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

    XMLRDNDescriptorName[OID]:   Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.

    This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures.

    The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing.

    Syntax: Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");

    Where:

    OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map.

    PrimaryName: The main descriptor name used in the XML signature when the OID is encountered.

    Alias1, Alias2, ...: Optional alternative names recognized during parsing.

    Usage Examples:

    Map OID 2.5.4.5 to SERIALNUMBER: Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");

    Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");

    XMLRDNDescriptorPriority[OID]:   Specifies the priority of descriptor names associated with a specific OID.

    This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing.

    XMLRDNDescriptorReverseOrder:   Specifies whether to reverse the order of descriptors in RDN.

    Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1).

    XMLRDNDescriptorSeparator:   Specifies the separator used between descriptors in RDN.

    Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value.

    Trappable Errors (SOAPVerifier Module)

    SOAPVerifier 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)
    33554433   The input file does not exist (SB_ERROR_SOAP_INPUTFILE_NOT_EXISTS)
    33554434   Invalid key type (SB_ERROR_SOAP_INVALID_KEY_TYPE)
    33554435   No signature found to complete the asynchronous signing (SB_ERROR_SOAP_SIGNATURE_NOT_FOUND)
    33554436   Unsupported signature type (SB_ERROR_SOAP_UNSUPPORTED_SIGNATURE_TYPE)
    33554437   Unexpected HTTP status code (SB_ERROR_SOAP_UNEXPECTED_HTTP_STATUS_CODE)
    33554438   SOAP service failed (SB_ERROR_SOAP_SERVICE_FAILED)