SOAPVerifier Module
Properties Methods Events Configuration 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.
| AllSignaturesValid | The cumulative validity of all signatures. |
| BlockedCertificates | The certificates that must be rejected as trust anchors. |
| CanonicalizationMethod | The XML canonicalization method that was used for signing. |
| Certificates | A collection of certificates included in the electronic signature. |
| ChainValidationDetails | The details of a certificate chain validation outcome. |
| ChainValidationResult | The general outcome of a certificate chain validation routine. Use ChainValidationDetails to get information about the reasons that contributed to the validation result. |
| ClaimedSigningTime | Returns a signature's claimed signing time. |
| CRLs | A collection of certificate revocation lists embedded into the signature by the signer. |
| CurrentCACertificate | The CA of the currently processed certificate. |
| CurrentCertificate | The certificate that is currently being processed. |
| Encoding | Specifies XML encoding. |
| FIPSMode | Reserved. |
| HashAlgorithm | The hash algorithm used for signing. |
| IgnoreChainValidationErrors | Makes the module tolerant to chain validation errors. |
| InputBytes | Use this property to pass the input to module in the byte array form. |
| InputFile | A path to the signed SOAP message. |
| InterimValidationDetails | Contains the validation details of the moment. |
| InterimValidationResult | Contains the validation status of the moment. |
| KnownCertificates | Additional certificates for chain validation. |
| KnownCRLs | Additional CRLs for chain validation. |
| KnownOCSPs | Additional OCSP responses for chain validation. |
| LastArchivalTime | Indicates the most recent archival time of an archived signature. |
| OCSPs | A collection of OCSP responses embedded into the signature. |
| OfflineMode | Switches the module to the offline mode. |
| OutputBytes | Use this property to read the output the module object has produced. |
| OutputFile | A file where the extracted SOAP message is to be saved. |
| Profile | Specifies a pre-defined profile to apply when creating the signature. |
| Proxy | The proxy server settings. |
| Qualified | Indicates a qualified electronic signature. |
| References | References covered by the signature. |
| RevocationCheck | Specifies the kind(s) of revocation check to perform. |
| SignatureBytes | TBD. |
| SignatureIndex | The index of the signature to update. |
| SignatureType | The signature type that was used to sign the SOAP message. |
| SignatureValidationResult | Contains the signature validation result. |
| SigningCertificate | The certificate of the signature creator. |
| SocketSettings | Manages network connection settings. |
| Timestamp | Contains the timestamp which is being validated. |
| Timestamped | Indicates whether or not the signature is timestamped. |
| TLSClientChain | The TLS client certificate chain. |
| TLSServerChain | The TLS server's certificate chain. |
| TLSSettings | Manages TLS layer settings. |
| TrustedCertificates | A list of trusted certificates for chain validation. |
| TSACertificate | The certificate of the Time Stamping Authority. |
| ValidatedSigningTime | Contains the certified signing time. |
| ValidationLog | Contains the complete log of the certificate validation routine. |
| ValidationMoment | The time point at which signature validity is to be established. |
| XAdESEnabled | Specifies whether the document contains an advanced signature (XAdES). |
| XAdESForm | Specifies which form of XAdES has been used. |
| XAdESVersion | Specifies XAdES version. |
| XPathNamespaces | Specifies namespaces for an XPath expression. |
Method List
The following is the full list of the methods of the module with short descriptions. Click on the links for further details.
| AddTimestamp | Use this method to add an timestamp. |
| AddTimestampValidationData | Use this method to add timestamp validation data to the signature. |
| AddValidationDataRefs | Use this method to add signature validation references to the signature. |
| AddValidationDataValues | Use this method to add signature validation values to the signature. |
| Config | Sets or retrieves a configuration setting. |
| DoAction | Performs an additional action. |
| Verify | Verifies 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.
| ChainElementDownload | TBD. |
| ChainElementNeeded | TBD. |
| ChainValidated | Reports the end of the validation process. |
| Error | Information about errors during signature verification. |
| Notification | This event notifies the application about an underlying control flow event. |
| ReferenceValidated | Marks the end of a reference validation. |
| ResolveReference | Asks the application to resolve a reference. |
| RetrieveCertificate | This event is fired when a certificate should be retrieved. |
| RetrieveCRL | This event is fired when a CRL should be retrieved. |
| RetrieveOCSPResponse | This event is fired when a OCSP Response should be retrieved. |
| SignatureFound | Signifies the start of signature validation. |
| SignatureValidated | Reports the signature validation result. |
| StoreCertificate | This event is fired when a certificate should be stored along with a signature. |
| StoreCRL | This event is fired when a CRL should be stored along with a signature. |
| StoreOCSPResponse | This event is fired when a OCSP Response should be stored along with a signature. |
| TimestampFound | Signifies the start of a timestamp validation routine. |
| TimestampValidated | Reports the completion of the timestamp validation routine. |
| TLSCertValidate | This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. |
| ValidationProgress | TBD. |
Configuration Settings
The following is a list of configuration settings for the module with short descriptions. Click on the links for further details.
| ClaimedRoleText | The text of the claimed role. |
| ClaimedRoleXML | The XML content of the claimed roles. |
| CommitmentTypeIndicationAllSignedDataObjects[Index] | Specifies the CommitmentTypeIndication's AllSignedDataObjects. |
| CommitmentTypeIndicationCount | The number of the CommitmentTypeIndication elements. |
| CommitmentTypeIndicationIdentifier[Index] | Specifies the CommitmentTypeIndication's CommitmentTypeId's Identifier. |
| CommitmentTypeIndicationIdentifierDescription[Index] | Specifies the CommitmentTypeIndication's CommitmentTypeId's Description. |
| CommitmentTypeIndicationIdentifierDocumentationReferences[Index] | Specifies the CommitmentTypeIndication's CommitmentTypeId's DocumentationReferences. |
| CommitmentTypeIndicationIdentifierQualifier[Index] | Specifies the CommitmentTypeIndication's CommitmentTypeId's IdentifierQualifier. |
| CommitmentTypeIndicationObjectReference[Index] | Specifies the CommitmentTypeIndication's ObjectReference. |
| CommitmentTypeIndicationQualifiersXML[Index] | The XML content of the CommitmentTypeIndication's Qualifiers. |
| CustomTSLs | Specifies the custom TSLs. |
| DataObjectFormatCount | The number of the DataObjectFormat elements. |
| DataObjectFormatDescription[Index] | Specifies the DataObjectFormat's Description. |
| DataObjectFormatEncoding[Index] | Specifies the DataObjectFormat's Encoding. |
| DataObjectFormatMimeType[Index] | Specifies the DataObjectFormat's MimeType. |
| DataObjectFormatObjectIdentifier[Index] | Specifies the DataObjectFormat's ObjectIdentifier's Identifier. |
| DataObjectFormatObjectIdentifierDescription[Index] | Specifies the DataObjectFormat's ObjectIdentifier's Description. |
| DataObjectFormatObjectIdentifierDocumentationReferences[Index] | Specifies the DataObjectFormat's ObjectIdentifier's DocumentationReferences. |
| DataObjectFormatObjectIdentifierQualifier[Index] | Specifies the DataObjectFormat's ObjectIdentifier's IdentifierQualifier. |
| DataObjectFormatObjectReference[Index] | Specifies the DataObjectFormat's ObjectReference. |
| ForceCompleteChainValidation | Whether to check the CA certificates when the signing certificate is invalid. |
| ForceCompleteChainValidationForTrusted | Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors. |
| GracePeriod | Specifies a grace period to apply during revocation information checks. |
| HMACKey | The key value for HMAC. |
| HMACSigningUsed | Whether HMAC signing was used. |
| IgnoreOCSPNoCheckExtension | Whether OCSP NoCheck extension should be ignored. |
| IgnoreSystemTrust | Whether trusted Windows Certificate Stores should be treated as trusted. |
| ImplicitlyTrustSelfSignedCertificates | Whether to trust self-signed certificates. |
| IncludeKnownRevocationInfoToSignature | Whether to include custom revocation info to the signature. |
| InclusiveNamespacesPrefixList | Specifies the InclusiveNamespaces PrefixList. |
| KeyName | Identifies the key. |
| ProductionPlace | Identifies the place of the signature production. |
| PromoteLongOCSPResponses | Whether long OCSP responses are requested. |
| PSSUsed | Whether RSASSA-PSS mode was used. |
| QualifiedStatus | Indicates a qualified electronic signature. |
| RemoveSignature | Whether to remove signature. |
| SignatureID | Contains the ID for Signature element. |
| SigPolicyDescription | signature policy description. |
| SigPolicyExplicitText | The explicit text of the user notice. |
| SigPolicyHash | The hash value of the signature policy. |
| SigPolicyHashAlgorithm | The hash algorithm used to compute the signature policy hash. |
| SigPolicyID | Identifies the signature policy. |
| SigPolicyNoticeNumbers | Contains user notice numbers. |
| SigPolicyNoticeOrganization | The organization part of the NoticeReference qualifier. |
| SigPolicyURI | Signature policy URI. |
| TempPath | Location where the temporary files are stored. |
| TimestampCanonicalizationMethod | Specifies canonicalization method used in timestamp. |
| TimestampValidationDataDetails | Specifies timestamp validation data details to include to the signature. |
| TolerateMinorChainIssues | Whether to tolerate minor chain issues. |
| TSLDistributionPoints | Contains XML content of distribution points of the TSL used. |
| TSLDistributionPoints[Idx] | Contains distribution point of the specified index of the TSL used. |
| TSLHistoricalInformationPeriod | Contains historical information period of the TSL used. |
| TSLLegalNotices | Contains XML content of legal notices of the TSL used. |
| TSLLegalNotices[lang] | Contains legal notices for the specified language of the TSL used. |
| TSLListIssueDateTime | Contains list issue date and time of the TSL used. |
| TSLNextUpdate | Contains next update date and time of the TSL used. |
| TSLPolicies | Contains XML content of policies of the TSL used. |
| TSLPolicies[lang] | Contains policies for the specified language of the TSL used. |
| TSLSchemeExtensions | Contains XML content of scheme extensions of the TSL used. |
| TSLSchemeExtensions[Idx] | Contains XML content of scheme extension of the specified index of the TSL used. |
| TSLSchemeInformationURI | Contains XML content of scheme information URI of the TSL used. |
| TSLSchemeInformationURI[lang] | Contains scheme information URI for the specified language of the TSL used. |
| TSLSchemeName | Contains XML content of scheme name of the TSL used. |
| TSLSchemeName[lang] | Contains scheme name for the specified language of the TSL used. |
| TSLSchemeOperatorAddress | Contains XML content of scheme operator address of the TSL used. |
| TSLSchemeOperatorName | Contains XML content of scheme operator name of the TSL used. |
| TSLSchemeOperatorName[lang] | Contains scheme operator name for the specified language of the TSL used. |
| TSLSchemeTerritory | Contains scheme territory of the TSL used. |
| TSLSchemeTypeCommunityRules | Contains XML content of scheme type/community/rules of the TSL used. |
| TSLSchemeTypeCommunityRules[lang] | Contains scheme type/community/rules for the specified language of the TSL used. |
| TSLSequenceNumber | Contains sequence number of the TSL used. |
| TSLsRetrieveLog | Contains the complete log of the TSLs retrieve. |
| TSLStatusDeterminationApproach | Contains status determination approach of the TSL used. |
| TSLsValidationLog | Contains the complete log of the TSLs validation. |
| TSLTSPAdditionalServiceInformation | Contains addtional service information of the TSP service used. |
| TSLTSPAddress | Contains XML content of the address of the TSP used. |
| TSLTSPHistoryInstance | Indicates that TSP service history instance used. |
| TSLTSPHistoryInstanceAdditionalServiceInformation | Contains addtional service information of the TSP service history instance used. |
| TSLTSPHistoryInstanceQualifiers | Contains list of qualifiers of the TSP service history instance used. |
| TSLTSPHistoryInstanceServiceInformationExtensions | Contains XML content of information extensions of the TSP service history instance used. |
| TSLTSPHistoryInstanceServiceInformationExtensions[Idx] | Contains XML content of information extension of the specified index of the TSP service history instance used. |
| TSLTSPHistoryInstanceServiceName | Contains XML content of name of the TSP service history instance used. |
| TSLTSPHistoryInstanceServiceName[lang] | Contains name for the specified language of the TSP service history instance used. |
| TSLTSPHistoryInstanceServiceStatus | Contains status of the TSP service history instance used. |
| TSLTSPHistoryInstanceServiceStatusStartingTime | Contains status starting time of the TSP service history instance used. |
| TSLTSPHistoryInstanceServiceTypeIdentifier | Contains type identifier of the TSP service history instance used. |
| TSLTSPHistoryInstanceXML | Contains XML content of the TSP service history instance used. |
| TSLTSPInformationExtensions | Contains XML content of information extensions of the TSP used. |
| TSLTSPInformationExtensions[Idx] | Contains XML content of information extension of the specified index of the TSP used. |
| TSLTSPInformationURI | Contains XML content of information URI of the TSP used. |
| TSLTSPInformationURI[lang] | Contains information URI for the specified language of the TSP used. |
| TSLTSPName | Contains XML content of name of the TSP used. |
| TSLTSPName[lang] | Contains name for the specified language of the TSP used. |
| TSLTSPSchemeServiceDefinitionURI | Contains XML content of scheme service definition URI of the TSP service used. |
| TSLTSPSchemeServiceDefinitionURI[lang] | Contains scheme service definition URI for the specified language of the TSP service used. |
| TSLTSPServiceDefinitionURI | Contains XML content of definition URI of the TSP service used. |
| TSLTSPServiceDefinitionURI[lang] | Contains definition URI for the specified language of the TSP service used. |
| TSLTSPServiceInformationExtensions | Contains XML content of information extensions of the TSP service used. |
| TSLTSPServiceInformationExtensions[Idx] | Contains XML content of information extension of the specified index of the TSP service used. |
| TSLTSPServiceName | Contains XML content of name of the TSP service used. |
| TSLTSPServiceName[lang] | Contains name for the specified language of the TSP service used. |
| TSLTSPServiceQualifiers | Contains list of qualifiers of the TSP service used. |
| TSLTSPServiceStatus | Contains status of the TSP service used. |
| TSLTSPServiceStatusStartingTime | Contains status starting time of the TSP service used. |
| TSLTSPServiceSupplyPoints | Contains XML content of the supply points of the TSP service used. |
| TSLTSPServiceTypeIdentifier | Contains type identifier of the TSP service used. |
| TSLTSPServiceXML | Contains XML content of the TSP service used. |
| TSLTSPTradeName | Contains XML content of trade name of the TSP used. |
| TSLTSPTradeName[lang] | Contains trade name for the specified language of the TSP used. |
| TSLTSPXML | Contains XML content of the TSP used. |
| TSLType | Contains TSL type of the TSL used. |
| TSLVersionIdentifier | Contains version identifier of the TSL used. |
| TSLXML | Contains XML content of the TSL used. |
| TspHashAlgorithm | Sets a specific hash algorithm for use with the timestamping service. |
| UseDefaultTSLs | Enables or disables the use of the default TSLs. |
| UseMicrosoftCTL | Enables or disables automatic use of Microsoft online certificate trust list. |
| UseSystemCertificates | Enables or disables the use of the system certificates. |
| ValidationDataRefsDetails | Specifies validation data references details to include to the signature. |
| ValidationDataValuesDetails | Specifies validation data values details to include to the signature. |
| WriteBOM | Specifies whether byte-order mark should be written when saving the document. |
| CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
| CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| Cookies | Gets or sets local cookies for the module (supported for HTTPClient, RESTClient and SOAPClient only). |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| LogDestination | Specifies the debug log destination. |
| LogDetails | Specifies the debug log details to dump. |
| LogFile | Specifies the debug log filename. |
| LogFilters | Specifies the debug log filters. |
| LogFlushMode | Specifies the log flush mode. |
| LogLevel | Specifies the debug log level. |
| LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
| LogRotationMode | Specifies the log rotation mode. |
| MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
| OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| Tag | Allows to store any custom data. |
| UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |
AllSignaturesValid Property (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.
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
CanonicalizationMethod Property (SOAPVerifier Module)
The XML canonicalization method that was used for signing.
Syntax
public var canonicalizationMethod: SoapverifierCanonicalizationMethods {
get {...} }
public enum SoapverifierCanonicalizationMethods: Int32 { case cxcmNone = 0 case cxcmCanon = 1 case cxcmCanonComment = 2 case cxcmExclCanon = 3 case cxcmExclCanonComment = 4 case cxcmMinCanon = 5 case cxcmCanon_v1_1 = 6 case cxcmCanonComment_v1_1 = 7 }
@property (nonatomic,readonly,assign,getter=canonicalizationMethod) int canonicalizationMethod; - (int)canonicalizationMethod;
Default Value
0
Remarks
Use this property to get the XML canonicalization method used for SignedInfo element. See XML-Signature Syntax and Processing specification for details.
Supported canonicalization methods:
| cxcmNone | 0 | |
| cxcmCanon | 1 | |
| cxcmCanonComment | 2 | |
| cxcmExclCanon | 3 | |
| cxcmExclCanonComment | 4 | |
| cxcmMinCanon | 5 | |
| cxcmCanon_v1_1 | 6 | |
| cxcmCanonComment_v1_1 | 7 |
This property is read-only.
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; - (NSString*)certCRLDistributionPoints:(int)certIndex; - (NSString*)certCurve:(int)certIndex; - (NSData*)certFingerprint:(int)certIndex; - (NSString*)certFriendlyName:(int)certIndex; - (long long)certHandle:(int)certIndex; - (NSString*)certHashAlgorithm:(int)certIndex; - (NSString*)certIssuer:(int)certIndex; - (NSString*)certIssuerRDN:(int)certIndex; - (NSString*)certKeyAlgorithm:(int)certIndex; - (int)certKeyBits:(int)certIndex; - (NSData*)certKeyFingerprint:(int)certIndex; - (int)certKeyUsage:(int)certIndex; - (BOOL)certKeyValid:(int)certIndex; - (NSString*)certOCSPLocations:(int)certIndex; - (NSString*)certPolicyIDs:(int)certIndex; - (NSData*)certPublicKeyBytes:(int)certIndex; - (BOOL)certSelfSigned:(int)certIndex; - (NSData*)certSerialNumber:(int)certIndex; - (NSString*)certSigAlgorithm:(int)certIndex; - (NSString*)certSubject:(int)certIndex; - (NSData*)certSubjectKeyID:(int)certIndex; - (NSString*)certSubjectRDN:(int)certIndex; - (NSString*)certValidFrom:(int)certIndex; - (NSString*)certValidTo:(int)certIndex;
Default Value
""
Remarks
ChainValidationDetails Property (SOAPVerifier Module)
The details of a certificate chain validation outcome.
Syntax
public var chainValidationDetails: Int32 {
get {...} }
@property (nonatomic,readonly,assign,getter=chainValidationDetails) int chainValidationDetails; - (int)chainValidationDetails;
Default Value
0
Remarks
Use the value(s) returned by this property to identify the reasons that contributed to the overall validation result.
Returns a bit mask of the following options:
| cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
| cvrRevoked | 0x0002 | One or more certificates are revoked |
| cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
| cvrExpired | 0x0008 | One or more certificates are expired |
| cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
| cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
| cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
| cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
| cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
| cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
| cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
| cvrBlocked | 0x0800 | One or more certificates are blocked |
| cvrFailure | 0x1000 | General validation failure |
| cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
| cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
| cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
This property is read-only.
ChainValidationResult Property (SOAPVerifier Module)
The general outcome of a certificate chain validation routine. Use ChainValidationDetails to get information about the reasons that contributed to the validation result.
Syntax
public var chainValidationResult: SoapverifierChainValidationResults {
get {...} }
public enum SoapverifierChainValidationResults: Int32 { case cvtValid = 0 case cvtValidButUntrusted = 1 case cvtInvalid = 2 case cvtCantBeEstablished = 3 }
@property (nonatomic,readonly,assign,getter=chainValidationResult) int chainValidationResult; - (int)chainValidationResult;
Default Value
0
Remarks
Available options:
| cvtValid | 0 | The chain is valid |
| cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
| cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
| cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
Use the ValidationLog property to access the detailed validation log.
This property is read-only.
ClaimedSigningTime Property (SOAPVerifier Module)
Returns a signature's claimed signing time.
Syntax
public var claimedSigningTime: String {
get {...} }
@property (nonatomic,readonly,assign,getter=claimedSigningTime) NSString* claimedSigningTime; - (NSString*)claimedSigningTime;
Default Value
""
Remarks
Use this property to get the signature creation time from the signer's computer. Note that the claimed time is not covered by the signature and may be forfeited or wrong. Use ValidatedSigningTime to obtain the signing time figure verified by a trusted timestamping authority. The time is in UTC.
This property is read-only.
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; - (long long)CRLHandle:(int)cRLIndex; - (NSString*)CRLIssuer:(int)cRLIndex; - (NSString*)CRLIssuerRDN:(int)cRLIndex; - (NSString*)CRLLocation:(int)cRLIndex; - (NSString*)CRLNextUpdate:(int)cRLIndex; - (NSString*)CRLThisUpdate:(int)cRLIndex;
Default Value
""
Remarks
CurrentCACertificate Property (SOAPVerifier Module)
The CA of the currently processed certificate.
Syntax
public var currentCACertificate: Certificate {
get {...} }
@property (nonatomic,readonly,assign,getter=currentCACertBytes) NSData* currentCACertBytes; - (NSData*)currentCACertBytes; @property (nonatomic,readonly,assign,getter=currentCACertCA) BOOL currentCACertCA; - (BOOL)currentCACertCA; @property (nonatomic,readonly,assign,getter=currentCACertCAKeyID) NSData* currentCACertCAKeyID; - (NSData*)currentCACertCAKeyID; @property (nonatomic,readonly,assign,getter=currentCACertCRLDistributionPoints) NSString* currentCACertCRLDistributionPoints; - (NSString*)currentCACertCRLDistributionPoints; @property (nonatomic,readonly,assign,getter=currentCACertCurve) NSString* currentCACertCurve; - (NSString*)currentCACertCurve; @property (nonatomic,readonly,assign,getter=currentCACertFingerprint) NSData* currentCACertFingerprint; - (NSData*)currentCACertFingerprint; @property (nonatomic,readonly,assign,getter=currentCACertFriendlyName) NSString* currentCACertFriendlyName; - (NSString*)currentCACertFriendlyName; @property (nonatomic,readonly,assign,getter=currentCACertHandle) long long currentCACertHandle; - (long long)currentCACertHandle; @property (nonatomic,readonly,assign,getter=currentCACertHashAlgorithm) NSString* currentCACertHashAlgorithm; - (NSString*)currentCACertHashAlgorithm; @property (nonatomic,readonly,assign,getter=currentCACertIssuer) NSString* currentCACertIssuer; - (NSString*)currentCACertIssuer; @property (nonatomic,readonly,assign,getter=currentCACertIssuerRDN) NSString* currentCACertIssuerRDN; - (NSString*)currentCACertIssuerRDN; @property (nonatomic,readonly,assign,getter=currentCACertKeyAlgorithm) NSString* currentCACertKeyAlgorithm; - (NSString*)currentCACertKeyAlgorithm; @property (nonatomic,readonly,assign,getter=currentCACertKeyBits) int currentCACertKeyBits; - (int)currentCACertKeyBits; @property (nonatomic,readonly,assign,getter=currentCACertKeyFingerprint) NSData* currentCACertKeyFingerprint; - (NSData*)currentCACertKeyFingerprint; @property (nonatomic,readonly,assign,getter=currentCACertKeyUsage) int currentCACertKeyUsage; - (int)currentCACertKeyUsage; @property (nonatomic,readonly,assign,getter=currentCACertKeyValid) BOOL currentCACertKeyValid; - (BOOL)currentCACertKeyValid; @property (nonatomic,readonly,assign,getter=currentCACertOCSPLocations) NSString* currentCACertOCSPLocations; - (NSString*)currentCACertOCSPLocations; @property (nonatomic,readonly,assign,getter=currentCACertOCSPNoCheck) BOOL currentCACertOCSPNoCheck; - (BOOL)currentCACertOCSPNoCheck; @property (nonatomic,readonly,assign,getter=currentCACertOrigin) int currentCACertOrigin; - (int)currentCACertOrigin; @property (nonatomic,readonly,assign,getter=currentCACertPolicyIDs) NSString* currentCACertPolicyIDs; - (NSString*)currentCACertPolicyIDs; @property (nonatomic,readonly,assign,getter=currentCACertPrivateKeyBytes) NSData* currentCACertPrivateKeyBytes; - (NSData*)currentCACertPrivateKeyBytes; @property (nonatomic,readonly,assign,getter=currentCACertPrivateKeyExists) BOOL currentCACertPrivateKeyExists; - (BOOL)currentCACertPrivateKeyExists; @property (nonatomic,readonly,assign,getter=currentCACertPrivateKeyExtractable) BOOL currentCACertPrivateKeyExtractable; - (BOOL)currentCACertPrivateKeyExtractable; @property (nonatomic,readonly,assign,getter=currentCACertPublicKeyBytes) NSData* currentCACertPublicKeyBytes; - (NSData*)currentCACertPublicKeyBytes; @property (nonatomic,readonly,assign,getter=currentCACertQualifiedStatements) int currentCACertQualifiedStatements; - (int)currentCACertQualifiedStatements; @property (nonatomic,readonly,assign,getter=currentCACertSelfSigned) BOOL currentCACertSelfSigned; - (BOOL)currentCACertSelfSigned; @property (nonatomic,readonly,assign,getter=currentCACertSerialNumber) NSData* currentCACertSerialNumber; - (NSData*)currentCACertSerialNumber; @property (nonatomic,readonly,assign,getter=currentCACertSigAlgorithm) NSString* currentCACertSigAlgorithm; - (NSString*)currentCACertSigAlgorithm; @property (nonatomic,readonly,assign,getter=currentCACertSubject) NSString* currentCACertSubject; - (NSString*)currentCACertSubject; @property (nonatomic,readonly,assign,getter=currentCACertSubjectAlternativeName) NSString* currentCACertSubjectAlternativeName; - (NSString*)currentCACertSubjectAlternativeName; @property (nonatomic,readonly,assign,getter=currentCACertSubjectKeyID) NSData* currentCACertSubjectKeyID; - (NSData*)currentCACertSubjectKeyID; @property (nonatomic,readonly,assign,getter=currentCACertSubjectRDN) NSString* currentCACertSubjectRDN; - (NSString*)currentCACertSubjectRDN; @property (nonatomic,readonly,assign,getter=currentCACertValidFrom) NSString* currentCACertValidFrom; - (NSString*)currentCACertValidFrom; @property (nonatomic,readonly,assign,getter=currentCACertValidTo) NSString* currentCACertValidTo; - (NSString*)currentCACertValidTo;
Default Value
""
Remarks
CurrentCertificate Property (SOAPVerifier Module)
The certificate that is currently being processed.
Syntax
public var currentCertificate: Certificate {
get {...} }
@property (nonatomic,readonly,assign,getter=currentCertBytes) NSData* currentCertBytes; - (NSData*)currentCertBytes; @property (nonatomic,readonly,assign,getter=currentCertCA) BOOL currentCertCA; - (BOOL)currentCertCA; @property (nonatomic,readonly,assign,getter=currentCertCAKeyID) NSData* currentCertCAKeyID; - (NSData*)currentCertCAKeyID; @property (nonatomic,readonly,assign,getter=currentCertCRLDistributionPoints) NSString* currentCertCRLDistributionPoints; - (NSString*)currentCertCRLDistributionPoints; @property (nonatomic,readonly,assign,getter=currentCertCurve) NSString* currentCertCurve; - (NSString*)currentCertCurve; @property (nonatomic,readonly,assign,getter=currentCertFingerprint) NSData* currentCertFingerprint; - (NSData*)currentCertFingerprint; @property (nonatomic,readonly,assign,getter=currentCertFriendlyName) NSString* currentCertFriendlyName; - (NSString*)currentCertFriendlyName; @property (nonatomic,readonly,assign,getter=currentCertHandle) long long currentCertHandle; - (long long)currentCertHandle; @property (nonatomic,readonly,assign,getter=currentCertHashAlgorithm) NSString* currentCertHashAlgorithm; - (NSString*)currentCertHashAlgorithm; @property (nonatomic,readonly,assign,getter=currentCertIssuer) NSString* currentCertIssuer; - (NSString*)currentCertIssuer; @property (nonatomic,readonly,assign,getter=currentCertIssuerRDN) NSString* currentCertIssuerRDN; - (NSString*)currentCertIssuerRDN; @property (nonatomic,readonly,assign,getter=currentCertKeyAlgorithm) NSString* currentCertKeyAlgorithm; - (NSString*)currentCertKeyAlgorithm; @property (nonatomic,readonly,assign,getter=currentCertKeyBits) int currentCertKeyBits; - (int)currentCertKeyBits; @property (nonatomic,readonly,assign,getter=currentCertKeyFingerprint) NSData* currentCertKeyFingerprint; - (NSData*)currentCertKeyFingerprint; @property (nonatomic,readonly,assign,getter=currentCertKeyUsage) int currentCertKeyUsage; - (int)currentCertKeyUsage; @property (nonatomic,readonly,assign,getter=currentCertKeyValid) BOOL currentCertKeyValid; - (BOOL)currentCertKeyValid; @property (nonatomic,readonly,assign,getter=currentCertOCSPLocations) NSString* currentCertOCSPLocations; - (NSString*)currentCertOCSPLocations; @property (nonatomic,readonly,assign,getter=currentCertOCSPNoCheck) BOOL currentCertOCSPNoCheck; - (BOOL)currentCertOCSPNoCheck; @property (nonatomic,readonly,assign,getter=currentCertOrigin) int currentCertOrigin; - (int)currentCertOrigin; @property (nonatomic,readonly,assign,getter=currentCertPolicyIDs) NSString* currentCertPolicyIDs; - (NSString*)currentCertPolicyIDs; @property (nonatomic,readonly,assign,getter=currentCertPrivateKeyBytes) NSData* currentCertPrivateKeyBytes; - (NSData*)currentCertPrivateKeyBytes; @property (nonatomic,readonly,assign,getter=currentCertPrivateKeyExists) BOOL currentCertPrivateKeyExists; - (BOOL)currentCertPrivateKeyExists; @property (nonatomic,readonly,assign,getter=currentCertPrivateKeyExtractable) BOOL currentCertPrivateKeyExtractable; - (BOOL)currentCertPrivateKeyExtractable; @property (nonatomic,readonly,assign,getter=currentCertPublicKeyBytes) NSData* currentCertPublicKeyBytes; - (NSData*)currentCertPublicKeyBytes; @property (nonatomic,readonly,assign,getter=currentCertQualifiedStatements) int currentCertQualifiedStatements; - (int)currentCertQualifiedStatements; @property (nonatomic,readonly,assign,getter=currentCertSelfSigned) BOOL currentCertSelfSigned; - (BOOL)currentCertSelfSigned; @property (nonatomic,readonly,assign,getter=currentCertSerialNumber) NSData* currentCertSerialNumber; - (NSData*)currentCertSerialNumber; @property (nonatomic,readonly,assign,getter=currentCertSigAlgorithm) NSString* currentCertSigAlgorithm; - (NSString*)currentCertSigAlgorithm; @property (nonatomic,readonly,assign,getter=currentCertSubject) NSString* currentCertSubject; - (NSString*)currentCertSubject; @property (nonatomic,readonly,assign,getter=currentCertSubjectAlternativeName) NSString* currentCertSubjectAlternativeName; - (NSString*)currentCertSubjectAlternativeName; @property (nonatomic,readonly,assign,getter=currentCertSubjectKeyID) NSData* currentCertSubjectKeyID; - (NSData*)currentCertSubjectKeyID; @property (nonatomic,readonly,assign,getter=currentCertSubjectRDN) NSString* currentCertSubjectRDN; - (NSString*)currentCertSubjectRDN; @property (nonatomic,readonly,assign,getter=currentCertValidFrom) NSString* currentCertValidFrom; - (NSString*)currentCertValidFrom; @property (nonatomic,readonly,assign,getter=currentCertValidTo) NSString* currentCertValidTo; - (NSString*)currentCertValidTo;
Default Value
""
Remarks
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.
HashAlgorithm Property (SOAPVerifier Module)
The hash algorithm used for signing.
Syntax
public var hashAlgorithm: String {
get {...} }
@property (nonatomic,readonly,assign,getter=hashAlgorithm) NSString* hashAlgorithm; - (NSString*)hashAlgorithm;
Default Value
"Unknown"
Remarks
Use this property to check which hash algorithm was used.
Supported values:
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| SB_HASH_ALGORITHM_SHA1 | SHA1 | |
| SB_HASH_ALGORITHM_SHA224 | SHA224 | |
| SB_HASH_ALGORITHM_SHA256 | SHA256 | |
| SB_HASH_ALGORITHM_SHA384 | SHA384 | |
| SB_HASH_ALGORITHM_SHA512 | SHA512 | |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |
This property is read-only.
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 the byte array form.
Syntax
public var inputBytes: Data {
get {...}
set {...} }
@property (nonatomic,readwrite,assign,getter=inputBytes,setter=setInputBytes:) NSData* inputBytes; - (NSData*)inputBytes; - (void)setInputBytes :(NSData*)newInputBytes;
Remarks
Assign a byte array containing the data to be processed to this property.
InputFile Property (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.
InterimValidationDetails Property (SOAPVerifier Module)
Contains the validation details of the moment.
Syntax
public var interimValidationDetails: Int32 {
get {...}
set {...} }
@property (nonatomic,readwrite,assign,getter=interimValidationDetails,setter=setInterimValidationDetails:) int interimValidationDetails; - (int)interimValidationDetails; - (void)setInterimValidationDetails :(int)newInterimValidationDetails;
Default Value
0
Remarks
Over the course of the validation process, the validator maintains an interim validity status for the chain that is being processed. This status is influenced by every single step of the validation routine, and may change along the way, before the end of the chain is reached and the final validation conclusion is drawn.
Use this property to check the interim validity details mid-flight.
The value of this property is a bit mask of the following options:
| cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
| cvrRevoked | 0x0002 | One or more certificates are revoked |
| cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
| cvrExpired | 0x0008 | One or more certificates are expired |
| cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
| cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
| cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
| cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
| cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
| cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
| cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
| cvrBlocked | 0x0800 | One or more certificates are blocked |
| cvrFailure | 0x1000 | General validation failure |
| cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
| cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
| cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
InterimValidationResult Property (SOAPVerifier Module)
Contains the validation status of the moment.
Syntax
public var interimValidationResult: SoapverifierInterimValidationResults {
get {...}
set {...} }
public enum SoapverifierInterimValidationResults: Int32 { case cvtValid = 0 case cvtValidButUntrusted = 1 case cvtInvalid = 2 case cvtCantBeEstablished = 3 }
@property (nonatomic,readwrite,assign,getter=interimValidationResult,setter=setInterimValidationResult:) int interimValidationResult; - (int)interimValidationResult; - (void)setInterimValidationResult :(int)newInterimValidationResult;
Default Value
0
Remarks
Over the course of the validation process, the validator maintains an interim validity status for the chain that is being processed. This status is influenced by every single step of the validation routine, and may change along the way, before the end of the chain is reached and the final validation conclusion is drawn.
Use this property to check the interim validity status mid-flight.
| cvtValid | 0 | The chain is valid |
| cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
| cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
| cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
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
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
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
LastArchivalTime Property (SOAPVerifier Module)
Indicates the most recent archival time of an archived signature.
Syntax
public var lastArchivalTime: String {
get {...} }
@property (nonatomic,readonly,assign,getter=lastArchivalTime) NSString* lastArchivalTime; - (NSString*)lastArchivalTime;
Default Value
""
Remarks
This property returns the time of the most recent archival timestamp applied to the signature. This property only makes sense for 'archived' (CAdES-A) signatures.
This property is read-only.
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; - (long long)OCSPHandle:(int)oCSPIndex; - (NSString*)OCSPIssuer:(int)oCSPIndex; - (NSString*)OCSPIssuerRDN:(int)oCSPIndex; - (NSString*)OCSPLocation:(int)oCSPIndex; - (NSString*)OCSPProducedAt:(int)oCSPIndex;
Default Value
""
Remarks
OfflineMode Property (SOAPVerifier Module)
Switches the module to the offline mode.
Syntax
public var offlineMode: Bool {
get {...}
set {...} }
@property (nonatomic,readwrite,assign,getter=offlineMode,setter=setOfflineMode:) BOOL offlineMode; - (BOOL)offlineMode; - (void)setOfflineMode :(BOOL)newOfflineMode;
Default Value
False
Remarks
When working in offline mode, the component restricts itself from using any online revocation information sources, such as CRL or OCSP responders.
Offline mode may be useful if there is a need to verify the completeness of validation information included within the signature or provided via KnownCertificates, KnownCRLs, and other related properties.
OutputBytes Property (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 is completed to read the produced output. This property will only be set if OutputFile and OutputStream properties had not been assigned.
This property is read-only.
OutputFile Property (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=proxyUseProxy,setter=setProxyUseProxy:) BOOL proxyUseProxy; - (BOOL)proxyUseProxy; - (void)setProxyUseProxy :(BOOL)newProxyUseProxy; @property (nonatomic,readwrite,assign,getter=proxyUsername,setter=setProxyUsername:) NSString* proxyUsername; - (NSString*)proxyUsername; - (void)setProxyUsername :(NSString*)newProxyUsername;
Default Value
""
Remarks
Qualified Property (SOAPVerifier Module)
Indicates a qualified electronic signature.
Syntax
public var qualified: SoapverifierQualifieds {
get {...} }
public enum SoapverifierQualifieds: Int32 { case sqsUnknown = 0 case sqsNone = 1 case sqsGranted = 2 case sqsWithdrawn = 3 case sqsSetByNationalLaw = 4 case sqsDeprecatedByNationalLaw = 5 case sqsRecognizedAtNationalLevel = 6 case sqsDeprecatedAtNationalLevel = 7 case sqsUnderSupervision = 8 case sqsSupervisionInCessation = 9 case sqsSupervisionCeased = 10 case sqsSupervisionRevoked = 11 case sqsAccredited = 12 case sqsAccreditationCeased = 13 case sqsAccreditationRevoked = 14 case sqsInAccordance = 15 case sqsExpired = 16 case sqsSuspended = 17 case sqsRevoked = 18 case sqsNotInAccordance = 19 }
@property (nonatomic,readonly,assign,getter=qualified) int qualified; - (int)qualified;
Default Value
0
Remarks
Use this property to check if an electronic signature is created using a qualified device for creating electronic signatures and that relies on a qualified electronic signature certificate.
Adjust UseDefaultTSLs property and/or CustomTSLs property before validating the signature/certificate to properly obtain TSP (Trust Service Provider) service status. Use Qualified* and TSL* config properties to obtain extended information.
The following qualified statuses are supported:
| sqsUnknown | 0 | Qualified status unknown. Use config's QualifiedInfo setting to obtain service status URI. |
| sqsNone | 1 | None |
| sqsGranted | 2 | Granted |
| sqsWithdrawn | 3 | Withdrawn |
| sqsSetByNationalLaw | 4 | Set by national law |
| sqsDeprecatedByNationalLaw | 5 | Deprecated by national law |
| sqsRecognizedAtNationalLevel | 6 | Recognized at national level |
| sqsDeprecatedAtNationalLevel | 7 | Deprecated at national level |
| sqsUnderSupervision | 8 | Under supervision |
| sqsSupervisionInCessation | 9 | Supervision in cessation |
| sqsSupervisionCeased | 10 | Supervision ceased |
| sqsSupervisionRevoked | 11 | Supervision revoked |
| sqsAccredited | 12 | Accredited |
| sqsAccreditationCeased | 13 | Accreditation ceased |
| sqsAccreditationRevoked | 14 | Accreditation revoked |
| sqsInAccordance | 15 | Deprecated. The subject service is in accordance with the scheme's specific status determination criteria (only for use in positive approval schemes). |
| sqsExpired | 16 | Deprecated. The subject service is no longer overseen by the scheme, e.g. due to nonrenewal or withdrawal by the TSP, or cessation of the service or the scheme's operations. |
| sqsSuspended | 17 | Deprecated. The subject service's status is temporarily uncertain whilst checks are made by the scheme operator (typically e.g. while a revocation request is being investigated or if action is required to resolve a deficiency in the service fulfilling the scheme's criteria. |
| sqsRevoked | 18 | Deprecated. The subject service's approved status has been revoked because it is no longer in accordance with the scheme's specific status determination criteria (only for use in positive approval schemes). |
| sqsNotInAccordance | 19 | Deprecated. The subject service is not in accordance with the scheme's specific status determination criteria (only for use in negative approval schemes). |
This property is read-only.
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; - (NSData*)referenceDigestValue:(int)referenceIndex; - (long long)referenceHandle:(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; - (NSString*)referenceTargetXMLElement:(int)referenceIndex; - (NSString*)referenceURI:(int)referenceIndex; - (BOOL)referenceUseBase64Transform:(int)referenceIndex; - (BOOL)referenceUseEnvelopedSignatureTransform:(int)referenceIndex; - (BOOL)referenceUseXPathFilter2Transform:(int)referenceIndex; - (BOOL)referenceUseXPathTransform:(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
RevocationCheck Property (SOAPVerifier Module)
Specifies the kind(s) of revocation check to perform.
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 (CRL) and Online Certificate Status Protocol (OCSP) responses serve the same purpose of ensuring that the certificate had not been revoked by the Certificate Authority (CA) at the time of use. Depending on your circumstances and security policy requirements, you may want to use either one or both of the revocation information source types.
| crcNone (0) | No revocation checking |
| crcAuto (1) | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. |
| crcAllCRL (2) | Check all provided CRL endpoints for all chain certificates. |
| crcAllOCSP (3) | Check all provided OCSP endpoints for all chain certificates. |
| crcAllCRLAndOCSP (4) | Check all CRL and OCSP endpoints for all chain certificates. |
| crcAnyCRL (5) | At least one CRL check for every certificate in the chain must succeed. |
| crcAnyOCSP (6) | At least one OCSP check for every certificate in the chain must succeed. |
| crcAnyCRLOrOCSP (7) | At least one CRL or OCSP check for every certificate in the chain must succeed. CRL endpoints are checked first. |
| crcAnyOCSPOrCRL (8) | At least one CRL or OCSP check for every certificate in the chain must succeed. OCSP endpoints are checked first. |
This setting controls the way the revocation checks are performed. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.
There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).
This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to faster OCSP route and only demand one source to succeed) is a good choice for most of typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.
SignatureBytes Property (SOAPVerifier Module)
TBD.
Syntax
public var signatureBytes: Data {
get {...} }
@property (nonatomic,readonly,assign,getter=signatureBytes) NSData* signatureBytes; - (NSData*)signatureBytes;
Remarks
TBD.
This property is read-only.
SignatureIndex Property (SOAPVerifier Module)
The index of the signature to update.
Syntax
public var signatureIndex: Int32 {
get {...}
set {...} }
@property (nonatomic,readwrite,assign,getter=signatureIndex,setter=setSignatureIndex:) int signatureIndex; - (int)signatureIndex; - (void)setSignatureIndex :(int)newSignatureIndex;
Default Value
0
Remarks
Use this property to specify the index of the existing signature before timestamping or adding validation info.
SignatureType Property (SOAPVerifier Module)
The signature type that was used to sign the SOAP message.
Syntax
public var signatureType: SoapverifierSignatureTypes {
get {...} }
public enum SoapverifierSignatureTypes: Int32 { case sstUnknown = 0 case sstWSSSignature = 1 case sstSOAPSignature = 2 }
@property (nonatomic,readonly,assign,getter=signatureType) int signatureType; - (int)signatureType;
Default Value
0
Remarks
Use this property to get the signature type that was used to sign the SOAP message.
Supported values:
sstWSSSignature uses Web Services Security (WS-Security, WSS) signature. It is implemented according to the OASIS Web Services Security extension to SOAP.
sstSOAPSignature uses SOAP signature. It is implemented according to the SOAP Security Extensions: Digital Signature.
This property is read-only.
SignatureValidationResult Property (SOAPVerifier Module)
Contains the signature validation result.
Syntax
public var signatureValidationResult: SoapverifierSignatureValidationResults {
get {...} }
public enum SoapverifierSignatureValidationResults: Int32 { case xsvValid = 0 case xsvUnknown = 1 case xsvCorrupted = 2 case xsvSignerNotFound = 3 case xsvFailure = 4 case xsvReferenceCorrupted = 5 }
@property (nonatomic,readonly,assign,getter=signatureValidationResult) int signatureValidationResult; - (int)signatureValidationResult;
Default Value
0
Remarks
Use this property to check the result of the most recent XML signature validation.
| xsvValid | 0 | |
| xsvUnknown | 1 | |
| xsvCorrupted | 2 | |
| xsvSignerNotFound | 3 | |
| xsvFailure | 4 | |
| xsvReferenceCorrupted | 5 |
This property is read-only.
SigningCertificate Property (SOAPVerifier Module)
The certificate of the signature creator.
Syntax
public var signingCertificate: Certificate {
get {...} }
@property (nonatomic,readonly,assign,getter=signingCertBytes) NSData* signingCertBytes; - (NSData*)signingCertBytes; @property (nonatomic,readonly,assign,getter=signingCertCA) BOOL signingCertCA; - (BOOL)signingCertCA; @property (nonatomic,readonly,assign,getter=signingCertCAKeyID) NSData* signingCertCAKeyID; - (NSData*)signingCertCAKeyID; @property (nonatomic,readonly,assign,getter=signingCertCRLDistributionPoints) NSString* signingCertCRLDistributionPoints; - (NSString*)signingCertCRLDistributionPoints; @property (nonatomic,readonly,assign,getter=signingCertCurve) NSString* signingCertCurve; - (NSString*)signingCertCurve; @property (nonatomic,readonly,assign,getter=signingCertFingerprint) NSData* signingCertFingerprint; - (NSData*)signingCertFingerprint; @property (nonatomic,readonly,assign,getter=signingCertFriendlyName) NSString* signingCertFriendlyName; - (NSString*)signingCertFriendlyName; @property (nonatomic,readonly,assign,getter=signingCertHandle) long long signingCertHandle; - (long long)signingCertHandle; @property (nonatomic,readonly,assign,getter=signingCertHashAlgorithm) NSString* signingCertHashAlgorithm; - (NSString*)signingCertHashAlgorithm; @property (nonatomic,readonly,assign,getter=signingCertIssuer) NSString* signingCertIssuer; - (NSString*)signingCertIssuer; @property (nonatomic,readonly,assign,getter=signingCertIssuerRDN) NSString* signingCertIssuerRDN; - (NSString*)signingCertIssuerRDN; @property (nonatomic,readonly,assign,getter=signingCertKeyAlgorithm) NSString* signingCertKeyAlgorithm; - (NSString*)signingCertKeyAlgorithm; @property (nonatomic,readonly,assign,getter=signingCertKeyBits) int signingCertKeyBits; - (int)signingCertKeyBits; @property (nonatomic,readonly,assign,getter=signingCertKeyFingerprint) NSData* signingCertKeyFingerprint; - (NSData*)signingCertKeyFingerprint; @property (nonatomic,readonly,assign,getter=signingCertKeyUsage) int signingCertKeyUsage; - (int)signingCertKeyUsage; @property (nonatomic,readonly,assign,getter=signingCertKeyValid) BOOL signingCertKeyValid; - (BOOL)signingCertKeyValid; @property (nonatomic,readonly,assign,getter=signingCertOCSPLocations) NSString* signingCertOCSPLocations; - (NSString*)signingCertOCSPLocations; @property (nonatomic,readonly,assign,getter=signingCertPolicyIDs) NSString* signingCertPolicyIDs; - (NSString*)signingCertPolicyIDs; @property (nonatomic,readonly,assign,getter=signingCertPublicKeyBytes) NSData* signingCertPublicKeyBytes; - (NSData*)signingCertPublicKeyBytes; @property (nonatomic,readonly,assign,getter=signingCertSelfSigned) BOOL signingCertSelfSigned; - (BOOL)signingCertSelfSigned; @property (nonatomic,readonly,assign,getter=signingCertSerialNumber) NSData* signingCertSerialNumber; - (NSData*)signingCertSerialNumber; @property (nonatomic,readonly,assign,getter=signingCertSigAlgorithm) NSString* signingCertSigAlgorithm; - (NSString*)signingCertSigAlgorithm; @property (nonatomic,readonly,assign,getter=signingCertSubject) NSString* signingCertSubject; - (NSString*)signingCertSubject; @property (nonatomic,readonly,assign,getter=signingCertSubjectKeyID) NSData* signingCertSubjectKeyID; - (NSData*)signingCertSubjectKeyID; @property (nonatomic,readonly,assign,getter=signingCertSubjectRDN) NSString* signingCertSubjectRDN; - (NSString*)signingCertSubjectRDN; @property (nonatomic,readonly,assign,getter=signingCertValidFrom) NSString* signingCertValidFrom; - (NSString*)signingCertValidFrom; @property (nonatomic,readonly,assign,getter=signingCertValidTo) NSString* signingCertValidTo; - (NSString*)signingCertValidTo;
Default Value
""
Remarks
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
Timestamp Property (SOAPVerifier Module)
Contains the timestamp which is being validated.
Syntax
public var timestamp: TimestampInfo {
get {...} }
@property (nonatomic,readonly,assign,getter=timestampAccuracy) long long timestampAccuracy; - (long long)timestampAccuracy; @property (nonatomic,readonly,assign,getter=timestampBytes) NSData* timestampBytes; - (NSData*)timestampBytes; @property (nonatomic,readonly,assign,getter=timestampChainValidationDetails) int timestampChainValidationDetails; - (int)timestampChainValidationDetails; @property (nonatomic,readonly,assign,getter=timestampChainValidationResult) int timestampChainValidationResult; - (int)timestampChainValidationResult; @property (nonatomic,readonly,assign,getter=timestampHashAlgorithm) NSString* timestampHashAlgorithm; - (NSString*)timestampHashAlgorithm; @property (nonatomic,readonly,assign,getter=timestampSerialNumber) NSData* timestampSerialNumber; - (NSData*)timestampSerialNumber; @property (nonatomic,readonly,assign,getter=timestampTime) NSString* timestampTime; - (NSString*)timestampTime; @property (nonatomic,readonly,assign,getter=timestampTimestampType) int timestampTimestampType; - (int)timestampTimestampType; @property (nonatomic,readonly,assign,getter=timestampTSAName) NSString* timestampTSAName; - (NSString*)timestampTSAName; @property (nonatomic,readonly,assign,getter=timestampValidationLog) NSString* timestampValidationLog; - (NSString*)timestampValidationLog; @property (nonatomic,readonly,assign,getter=timestampValidationResult) int timestampValidationResult; - (int)timestampValidationResult;
Default Value
""
Remarks
Timestamped Property (SOAPVerifier Module)
Indicates whether or not the signature is timestamped.
Syntax
public var timestamped: Bool {
get {...} }
@property (nonatomic,readonly,assign,getter=timestamped) BOOL timestamped; - (BOOL)timestamped;
Default Value
False
Remarks
This property returns True if the signature is timestamped, and False otherwise.
This property is read-only.
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
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; - (long long)TLSServerCertHandle:(int)tLSServerCertIndex;
Default Value
""
Remarks
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=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
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
TSACertificate Property (SOAPVerifier Module)
The certificate of the Time Stamping Authority.
Syntax
public var tsaCertificate: Certificate {
get {...} }
@property (nonatomic,readonly,assign,getter=TSACertBytes) NSData* TSACertBytes; - (NSData*)TSACertBytes; @property (nonatomic,readonly,assign,getter=TSACertCA) BOOL TSACertCA; - (BOOL)TSACertCA; @property (nonatomic,readonly,assign,getter=TSACertCAKeyID) NSData* TSACertCAKeyID; - (NSData*)TSACertCAKeyID; @property (nonatomic,readonly,assign,getter=TSACertCRLDistributionPoints) NSString* TSACertCRLDistributionPoints; - (NSString*)TSACertCRLDistributionPoints; @property (nonatomic,readonly,assign,getter=TSACertCurve) NSString* TSACertCurve; - (NSString*)TSACertCurve; @property (nonatomic,readonly,assign,getter=TSACertFingerprint) NSData* TSACertFingerprint; - (NSData*)TSACertFingerprint; @property (nonatomic,readonly,assign,getter=TSACertFriendlyName) NSString* TSACertFriendlyName; - (NSString*)TSACertFriendlyName; @property (nonatomic,readonly,assign,getter=TSACertHandle) long long TSACertHandle; - (long long)TSACertHandle; @property (nonatomic,readonly,assign,getter=TSACertHashAlgorithm) NSString* TSACertHashAlgorithm; - (NSString*)TSACertHashAlgorithm; @property (nonatomic,readonly,assign,getter=TSACertIssuer) NSString* TSACertIssuer; - (NSString*)TSACertIssuer; @property (nonatomic,readonly,assign,getter=TSACertIssuerRDN) NSString* TSACertIssuerRDN; - (NSString*)TSACertIssuerRDN; @property (nonatomic,readonly,assign,getter=TSACertKeyAlgorithm) NSString* TSACertKeyAlgorithm; - (NSString*)TSACertKeyAlgorithm; @property (nonatomic,readonly,assign,getter=TSACertKeyBits) int TSACertKeyBits; - (int)TSACertKeyBits; @property (nonatomic,readonly,assign,getter=TSACertKeyFingerprint) NSData* TSACertKeyFingerprint; - (NSData*)TSACertKeyFingerprint; @property (nonatomic,readonly,assign,getter=TSACertKeyUsage) int TSACertKeyUsage; - (int)TSACertKeyUsage; @property (nonatomic,readonly,assign,getter=TSACertKeyValid) BOOL TSACertKeyValid; - (BOOL)TSACertKeyValid; @property (nonatomic,readonly,assign,getter=TSACertOCSPLocations) NSString* TSACertOCSPLocations; - (NSString*)TSACertOCSPLocations; @property (nonatomic,readonly,assign,getter=TSACertPolicyIDs) NSString* TSACertPolicyIDs; - (NSString*)TSACertPolicyIDs; @property (nonatomic,readonly,assign,getter=TSACertPublicKeyBytes) NSData* TSACertPublicKeyBytes; - (NSData*)TSACertPublicKeyBytes; @property (nonatomic,readonly,assign,getter=TSACertSelfSigned) BOOL TSACertSelfSigned; - (BOOL)TSACertSelfSigned; @property (nonatomic,readonly,assign,getter=TSACertSerialNumber) NSData* TSACertSerialNumber; - (NSData*)TSACertSerialNumber; @property (nonatomic,readonly,assign,getter=TSACertSigAlgorithm) NSString* TSACertSigAlgorithm; - (NSString*)TSACertSigAlgorithm; @property (nonatomic,readonly,assign,getter=TSACertSubject) NSString* TSACertSubject; - (NSString*)TSACertSubject; @property (nonatomic,readonly,assign,getter=TSACertSubjectKeyID) NSData* TSACertSubjectKeyID; - (NSData*)TSACertSubjectKeyID; @property (nonatomic,readonly,assign,getter=TSACertSubjectRDN) NSString* TSACertSubjectRDN; - (NSString*)TSACertSubjectRDN; @property (nonatomic,readonly,assign,getter=TSACertValidFrom) NSString* TSACertValidFrom; - (NSString*)TSACertValidFrom; @property (nonatomic,readonly,assign,getter=TSACertValidTo) NSString* TSACertValidTo; - (NSString*)TSACertValidTo;
Default Value
""
Remarks
ValidatedSigningTime Property (SOAPVerifier Module)
Contains the certified signing time.
Syntax
public var validatedSigningTime: String {
get {...} }
@property (nonatomic,readonly,assign,getter=validatedSigningTime) NSString* validatedSigningTime; - (NSString*)validatedSigningTime;
Default Value
""
Remarks
Use this property to obtain the signing time as certified by an external timestamp. The time is in UTC.
This property is read-only.
ValidationLog Property (SOAPVerifier Module)
Contains the complete log of the certificate validation routine.
Syntax
public var validationLog: String {
get {...} }
@property (nonatomic,readonly,assign,getter=validationLog) NSString* validationLog; - (NSString*)validationLog;
Default Value
""
Remarks
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.
This property is read-only.
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 signature creation time, or 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.
XAdESEnabled Property (SOAPVerifier Module)
Specifies whether the document contains an advanced signature (XAdES).
Syntax
public var xAdESEnabled: Bool {
get {...} }
@property (nonatomic,readonly,assign,getter=XAdESEnabled) BOOL XAdESEnabled; - (BOOL)XAdESEnabled;
Default Value
False
Remarks
Use this property to check whether the document is signed with XAdES or XML-DSIG only.
This property is read-only.
XAdESForm Property (SOAPVerifier Module)
Specifies which form of XAdES has been used.
Syntax
public var xAdESForm: SoapverifierXAdESForms {
get {...} }
public enum SoapverifierXAdESForms: Int32 { case xafUnknown = 0 case xafBasic = 1 case xafBES = 2 case xafEPES = 3 case xafT = 4 case xafC = 5 case xafX = 6 case xafXL = 7 case xafA = 8 case xafExtendedBES = 9 case xafExtendedEPES = 10 case xafExtendedT = 11 case xafExtendedC = 12 case xafExtendedX = 13 case xafExtendedXLong = 14 case xafExtendedXL = 15 case xafExtendedA = 16 }
@property (nonatomic,readonly,assign,getter=XAdESForm) int XAdESForm; - (int)XAdESForm;
Default Value
0
Remarks
Use this property to check the form (level) of XAdES.
| xafUnknown | 0 | |
| xafBasic | 1 | XAdES form, supported by XAdES v1.1.1 |
| xafBES | 2 | XAdES-BES form, supported starting from XAdES v1.2.2 |
| xafEPES | 3 | XAdES-EPES form, supported starting from XAdES v1.2.2 |
| xafT | 4 | XAdES-T form |
| xafC | 5 | XAdES-C form |
| xafX | 6 | XAdES-X form |
| xafXL | 7 | XAdES-X-L form |
| xafA | 8 | XAdES-A form |
| xafExtendedBES | 9 | XAdES-E-BES form |
| xafExtendedEPES | 10 | XAdES-E-EPES form |
| xafExtendedT | 11 | XAdES-E-T form |
| xafExtendedC | 12 | XAdES-E-C form |
| xafExtendedX | 13 | XAdES-E-X form |
| xafExtendedXLong | 14 | XAdES-E-X-Long form (type 1) |
| xafExtendedXL | 15 | XAdES-E-X-L form (type 2) |
| xafExtendedA | 16 | XAdES-E-A form |
* XAdES-E-* forms are supported starting from XAdES v1.3.2
This property is read-only.
XAdESVersion Property (SOAPVerifier Module)
Specifies XAdES version.
Syntax
public var xAdESVersion: SoapverifierXAdESVersions {
get {...}
set {...} }
public enum SoapverifierXAdESVersions: Int32 { case xavUnknown = 0 case xav111 = 1 case xav122 = 2 case xav132 = 3 case xav141 = 4 }
@property (nonatomic,readwrite,assign,getter=XAdESVersion,setter=setXAdESVersion:) int XAdESVersion; - (int)XAdESVersion; - (void)setXAdESVersion :(int)newXAdESVersion;
Default Value
0
Remarks
This property specifies the version of the XAdES specification used to produce the signature.
| xavUnknown | 0 | |
| xav111 | 1 | XAdES v1.1.1 |
| xav122 | 2 | XAdES v1.2.2 |
| xav132 | 3 | XAdES v1.3.2 |
| xav141 | 4 | XAdES v1.4.1 (aka v1.4.2) |
XPathNamespaces Property (SOAPVerifier Module)
Specifies namespaces for an XPath expression.
Syntax
public var xPathNamespaces: Array<XMLNamespace> {
get {...} }
@property (nonatomic,readwrite,assign,getter=namespaceCount,setter=setNamespaceCount:) int namespaceCount; - (int)namespaceCount; - (void)setNamespaceCount :(int)newNamespaceCount; - (NSString*)namespacePrefix:(int)namespaceIndex; - (void)setNamespacePrefix:(int)namespaceIndex :(NSString*)newNamespacePrefix; - (NSString*)namespaceURI:(int)namespaceIndex; - (void)setNamespaceURI:(int)namespaceIndex :(NSString*)newNamespaceURI;
Default Value
""
Remarks
AddTimestamp Method (SOAPVerifier Module)
Use this method to add an timestamp.
Syntax
- (void)addTimestamp:(int)timestampType :(NSString*)timestampServer;
Remarks
Call this method to timestamp the signature. Use the TimestampServer parameter to provide the address of the TSA (Time Stamping Authority) server which should be used for timestamping. This method could be called separately or in SignatureValidated event handler after successful signature validation. Use the TimestampType parameter to specify the type of timestamp to create
Supported timestamp types:
| tstSignature | 12 | Signature timestamp |
| tstRefsOnly | 13 | RefsOnly timestamp |
| tstSigAndRefs | 14 | SigAndRefs timestamp |
| tstArchive | 7 | Archive timestamp |
AddTimestampValidationData Method (SOAPVerifier Module)
Use this method to add timestamp validation data to the signature.
Syntax
public func addTimestampValidationData() throws -> Void
- (void)addTimestampValidationData;
Remarks
Call this method to add certificates and revocation information used to validate timestamp's signer certificates at a particular time. This method could be called separately or in SignatureValidated event handler after successful signature validation.
AddValidationDataRefs Method (SOAPVerifier Module)
Use this method to add signature validation references to the signature.
Syntax
public func addValidationDataRefs() throws -> Void
- (void)addValidationDataRefs;
Remarks
Call this method to add references to certificates and revocation information used to validate a signature at a particular time. This method could be called separately or in SignatureValidated event handler after successful signature validation.
AddValidationDataValues Method (SOAPVerifier Module)
Use this method to add signature validation values to the signature.
Syntax
public func addValidationDataValues() throws -> Void
- (void)addValidationDataValues;
Remarks
Call this method to add certificates and revocation information used to validate a signature at a particular time. This method could be called separately or in SignatureValidated event handler after successful signature validation.
Config Method (SOAPVerifier Module)
Sets or retrieves a configuration setting.
Syntax
- (NSString*)config:(NSString*)configurationString;
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
DoAction Method (SOAPVerifier Module)
Performs an additional action.
Syntax
- (NSString*)doAction:(NSString*)actionID :(NSString*)actionParams;
Remarks
DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.
The unique identifier of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
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)
TBD.
Syntax
- (void)onChainElementDownload:(NSString*)cert :(NSString*)CACert :(NSString*)location;
Remarks
TBD.
ChainElementNeeded Event (SOAPVerifier Module)
TBD.
Syntax
- (void)onChainElementNeeded:(NSString*)cert :(NSString*)CACert;
Remarks
TBD.
ChainValidated Event (SOAPVerifier Module)
Reports the end of the validation process.
Syntax
- (void)onChainValidated:(NSString*)subjectRDN :(int)validationResult :(int)validationDetails;
Remarks
This event is fired when a certificate chain has been validated. SubjectRDN identifies the owner of the validated certificate.
If ValidationResult equals to 0 (zero), validation has succeeded. Any other value reports failure, and ValidationDetails specifies more details on possible reason for it.
Error Event (SOAPVerifier Module)
Information about errors during signature verification.
Syntax
- (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.
Notification Event (SOAPVerifier Module)
This event notifies the application about an underlying control flow event.
Syntax
- (void)onNotification:(NSString*)eventID :(NSString*)eventParam;
Remarks
The class fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.
The unique identifier of the event is provided in EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.
ReferenceValidated Event (SOAPVerifier Module)
Marks the end of a reference validation.
Syntax
func onReferenceValidated(id: String, uri: String, refType: String, referenceIndex: Int32, digestValid: Bool)
- (void)onReferenceValidated:(NSString*)ID :(NSString*)URI :(NSString*)refType :(int)referenceIndex :(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
- (void)onResolveReference:(NSString*)URI :(int)referenceIndex;
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.
RetrieveCertificate Event (SOAPVerifier Module)
This event is fired when a certificate should be retrieved.
Syntax
func onRetrieveCertificate(uri: String)
- (void)onRetrieveCertificate:(NSString*)URI;
Remarks
This event could occur if you are verifying XAdES-C form or higher. URI parameter contains a URI value of the stored certificate along with a signature. The user should add the certificate to the KnownCertificates property.
RetrieveCRL Event (SOAPVerifier Module)
This event is fired when a CRL should be retrieved.
Syntax
func onRetrieveCRL(uri: String)
- (void)onRetrieveCRL:(NSString*)URI;
Remarks
This event could occur if you are verifying XAdES-C form or higher. URI parameter contains a URI value of the stored CRL along with a signature. The user should add the CRL to the KnownCRLs property.
RetrieveOCSPResponse Event (SOAPVerifier Module)
This event is fired when a OCSP Response should be retrieved.
Syntax
func onRetrieveOCSPResponse(uri: String)
- (void)onRetrieveOCSPResponse:(NSString*)URI;
Remarks
This event could occur if you are verifying XAdES-C form or higher. URI parameter contains a URI value of the stored OCSP Response along with a signature. The user should add the OCSP Response to the KnownOCSPs property.
SignatureFound Event (SOAPVerifier Module)
Signifies the start of signature validation.
Syntax
func onSignatureFound(issuerRDN: String, serialNumber: Data, subjectKeyID: Data, certFound: Bool, validateSignature: inout Bool, validateChain: inout Bool)
- (void)onSignatureFound:(NSString*)issuerRDN :(NSData*)serialNumber :(NSData*)subjectKeyID :(BOOL)certFound :(int*)validateSignature :(int*)validateChain;
Remarks
This event tells the application that signature validation is about to start, and provides the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters. It fires for every signature located in the verified document or message.
The CertFound is set to True if the class has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via KnownCertificates property.
Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with SignatureValidationResult and ChainValidationResult properties respectively.
Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.
SignatureValidated Event (SOAPVerifier Module)
Reports the signature validation result.
Syntax
func onSignatureValidated(issuerRDN: String, serialNumber: Data, subjectKeyID: Data, validationResult: Int32)
- (void)onSignatureValidated:(NSString*)issuerRDN :(NSData*)serialNumber :(NSData*)subjectKeyID :(int)validationResult;
Remarks
This event is fired when the complete XML signature validation process is finished. IssuerRDN returns the name of the signature issuer, SerialNumber identifies the signing certificate, SubjectKeyID contains the key identifier (SecureBlackbox uses SHA-1 hash algorithm output as key identifiers). Finally, ValidationResult specifies whether signature is valid or not:
| xsvValid | 0 | |
| xsvUnknown | 1 | |
| xsvCorrupted | 2 | |
| xsvSignerNotFound | 3 | |
| xsvFailure | 4 | |
| xsvReferenceCorrupted | 5 |
StoreCertificate Event (SOAPVerifier Module)
This event is fired when a certificate should be stored along with a signature.
Syntax
func onStoreCertificate(cert: Data, uri: inout String)
- (void)onStoreCertificate:(NSData*)cert :(NSString**)URI;
Remarks
This event could occur if you are verifying XAdES-C form or higher. Cert parameter contains a certificate in binary form that should be stored along with a signature, and the user should provide the URI of the stored certificate.
StoreCRL Event (SOAPVerifier Module)
This event is fired when a CRL should be stored along with a signature.
Syntax
func onStoreCRL(crl: Data, uri: inout String)
- (void)onStoreCRL:(NSData*)CRL :(NSString**)URI;
Remarks
This event could occur if you are verifying XAdES-C form or higher. CRL parameter contains a CRL in binary form that should be stored along with a signature, and the user should provide the URI of the stored CRL.
StoreOCSPResponse Event (SOAPVerifier Module)
This event is fired when a OCSP Response should be stored along with a signature.
Syntax
func onStoreOCSPResponse(ocspResponse: Data, uri: inout String)
- (void)onStoreOCSPResponse:(NSData*)OCSPResponse :(NSString**)URI;
Remarks
This event could occur if you are verifying XAdES-C form or higher. OCSPResponse parameter contains an OCSP Response in binary form that should be stored along with a signature, and the user should provide the URI of the stored OCSP Response.
TimestampFound Event (SOAPVerifier Module)
Signifies the start of a timestamp validation routine.
Syntax
func onTimestampFound(issuerRDN: String, serialNumber: Data, subjectKeyID: Data, certFound: Bool, validateTimestamp: inout Bool, validateChain: inout Bool)
- (void)onTimestampFound:(NSString*)issuerRDN :(NSData*)serialNumber :(NSData*)subjectKeyID :(BOOL)certFound :(int*)validateTimestamp :(int*)validateChain;
Remarks
This event fires for every timestamp identified during signature processing, and reports the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters.
The CertFound is set to True if the class has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via KnownCertificates property.
Just like with signature validation, timestamp validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with SignatureValidationResult and ChainValidationResult properties respectively.
Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.
TimestampValidated Event (SOAPVerifier Module)
Reports the completion of the timestamp validation routine.
Syntax
func onTimestampValidated(issuerRDN: String, serialNumber: Data, subjectKeyID: Data, time: String, validationResult: Int32, chainValidationResult: Int32, chainValidationDetails: Int32)
- (void)onTimestampValidated:(NSString*)issuerRDN :(NSData*)serialNumber :(NSData*)subjectKeyID :(NSString*)time :(int)validationResult :(int)chainValidationResult :(int)chainValidationDetails;
Remarks
This event is fired upon the completion of the timestamp validation routine, and reports the respective validation result.
ValidationResult is set to 0 if the validation has been successful, or to a non-zero value in case of a failure.
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
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(serverHostname: String, serverIP: String, accept: inout Bool)
- (void)onTLSCertValidate:(NSString*)serverHostname :(NSString*)serverIP :(int*)accept;
Remarks
This event is fired during a TLS handshake. Use TLSServerChain property to access the certificate chain. In general case, components may contact a number of TLS endpoints during their work, depending on their configuration.
Accept is assigned in accordance with the outcome of the internal validation check performed by the component, and can be adjusted if needed.
ValidationProgress Event (SOAPVerifier Module)
TBD.
Syntax
func onValidationProgress(validationEventType: String, cert: String, caCert: String, doContinue: inout Bool)
- (void)onValidationProgress:(NSString*)validationEventType :(NSString*)cert :(NSString*)CACert :(int*)doContinue;
Remarks
TBD.
Certificate Type
Provides details of an individual X.509 certificate.
Remarks
This type provides access to X.509 certificate details.
Fields
|
bytes Data |
Returns raw certificate data in DER format. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ca Bool |
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
caKeyID Data |
A unique identifier (fingerprint) of the CA certificate's private key. Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
crlDistributionPoints String |
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
curve String |
Specifies the elliptic curve of the EC public key.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
fingerprint Data |
Contains the fingerprint (a hash imprint) of this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
friendlyName String |
Contains an associated alias (friendly name) of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
handle Int64 |
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
hashAlgorithm String |
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
issuer String |
The common name of the certificate issuer (CA), typically a company name. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
issuerRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyAlgorithm String |
Specifies the public key algorithm of this certificate.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyBits Int32 |
Returns the length of the public key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyFingerprint Data |
Returns a fingerprint of the public key contained in the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyUsage Int32 |
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. This value is a bit mask of the following values:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyValid Bool |
Returns True if the certificate's key is cryptographically valid, and False otherwise. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ocspLocations String |
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ocspNoCheck Bool |
TBD. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
origin Int32 |
Returns the origin of this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
policyIDs String |
Contains identifiers (OIDs) of the applicable certificate policies. The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
privateKeyBytes Data |
Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
privateKeyExists Bool |
Indicates whether the certificate has an associated private key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
privateKeyExtractable Bool |
Indicates whether the private key is extractable |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
publicKeyBytes Data |
Contains the certificate's public key in DER format. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
qualifiedStatements QualifiedStatementsTypes |
TBD |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
selfSigned Bool |
Indicates whether the certificate is self-signed (root) or signed by an external CA. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
serialNumber Data |
Returns the certificate's serial number. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
sigAlgorithm String |
Indicates the algorithm that was used by the CA to sign this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
subject String |
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
subjectAlternativeName String |
TBD. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
subjectKeyID Data |
Contains a unique identifier (fingerprint) of the certificate's private key. Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
subjectRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
validFrom String |
The time point at which the certificate becomes valid, in UTC. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
validTo String |
The time point at which the certificate expires, in UTC. |
Constructors
public init(stream: InputStream?)
Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data.
public init()
Creates a new object with default field values.
CRL Type
Represents a Certificate Revocation List.
Remarks
CRLs store information about revoked certificates, i.e., certificates that have been identified as invalid by their issuing certificate authority (CA) for any number of reasons.
Each CRL object lists certificates from a single CA and identifies them by their serial numbers. A CA may or may not publish a CRL, may publish several CRLs, or may publish the same CRL in multiple locations.
Unlike OCSP responses, CRLs only list certificates that have been revoked. They do not list certificates that are still valid.
Fields
|
bytes Data |
Returns raw CRL data in DER format. |
|
caKeyID Data |
A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL. |
|
entryCount Int32 |
Returns the number of certificate status entries in the CRL. |
|
handle Int64 |
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
|
|
issuer String |
The common name of the CRL issuer (CA), typically a company name. |
|
issuerRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer. |
|
location String |
The URL that the CRL was downloaded from. |
|
nextUpdate String |
The planned time and date of the next version of this CRL to be published. |
|
sigAlgorithm String |
The public key algorithm that was used by the CA to sign this CRL. |
|
tbs Data |
The to-be-signed part of the CRL (the CRL without the signature part). |
|
thisUpdate String |
The date and time at which this version of the CRL was published. |
Constructors
public init()
Creates an empty CRL object.
OCSPResponse Type
Represents a single OCSP response originating from an OCSP responder.
Remarks
OCSP is a protocol that allows verification of certificate status in real-time, and is an alternative to Certificate Revocation Lists (CRL).
An OCSP response is a snapshot of the certificate status at a given time.
Fields
|
bytes Data |
Buffer containing raw OCSP response data. |
|
entryCount Int32 |
The number of SingleResponse elements contained in this OCSP response. Each SingleResponse element corresponds to a certificate status. |
|
handle Int64 |
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
|
|
issuer String |
Indicates the issuer of this response (a CA or its authorized representative). |
|
issuerRDN String |
Indicates the RDN of the issuer of this response (a CA or its authorized representative). |
|
location String |
Location of the OCSP responder. |
|
producedAt String |
Specifies the time when the response was produced, in UTC. |
Constructors
public init()
Creates an empty OCSP response object.
ProxySettings Type
A container for proxy server settings.
Remarks
This type exposes a collection of properties for tuning up the proxy server configuration.
Fields
|
address String |
The IP address of the proxy server. |
||||||||||
|
authentication ProxyAuthTypes |
The authentication type used by the proxy server.
|
||||||||||
|
password String |
The password to authenticate to the proxy server. |
||||||||||
|
port Int32 |
The port on the proxy server to connect to. |
||||||||||
|
proxyType ProxyTypes |
The type of the proxy server. The WebTunnel proxy is also known as HTTPS proxy. Unlike HTTP proxy, HTTPS proxy (WebTunnel) provides end-to-end security.
|
||||||||||
|
requestHeaders String |
Contains HTTP request headers for WebTunnel and HTTP proxy. |
||||||||||
|
responseBody String |
Contains the HTTP or HTTPS (WebTunnel) proxy response body. |
||||||||||
|
responseHeaders String |
Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. |
||||||||||
|
useIPv6 Bool |
Specifies whether IPv6 should be used when connecting through the proxy. |
||||||||||
|
useProxy Bool |
Enables or disables proxy-driven connection. |
||||||||||
|
username String |
Specifies the username credential for proxy authentication. |
Constructors
public init()
Creates a new ProxySettings object.
SocketSettings Type
A container for the socket settings.
Remarks
This type is a container for socket-layer parameters.
Fields
|
dnsMode DNSResolveModes |
Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.
|
||||||||
|
dnsPort Int32 |
Specifies the port number to be used for sending queries to the DNS server. |
||||||||
|
dnsQueryTimeout Int32 |
The timeout (in milliseconds) for each DNS query. The value of 0 indicates the infinite timeout. |
||||||||
|
dnsServers String |
The addresses of DNS servers to use for address resolution, separated by commas or semicolons. |
||||||||
|
dnsTotalTimeout Int32 |
The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates the infinite timeout. |
||||||||
|
incomingSpeedLimit Int32 |
The maximum number of bytes to read from the socket, per second. |
||||||||
|
localAddress String |
The local network interface to bind the socket to. |
||||||||
|
localPort Int32 |
The local port number to bind the socket to. |
||||||||
|
outgoingSpeedLimit Int32 |
The maximum number of bytes to write to the socket, per second. |
||||||||
|
timeout Int32 |
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack). |
||||||||
|
useIPv6 Bool |
Enables or disables IP protocol version 6. |
Constructors
public init()
Creates a new SocketSettings object.
TimestampInfo Type
A container for timestamp information.
Remarks
The TimestampInfo object contains details of a third-party timestamp and the outcome of its validation.
Fields
|
accuracy Int64 |
This field indicates the accuracy of the included time mark, in microseconds. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
bytes Data |
Returns raw timestamp data in DER format. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
chainValidationDetails Int32 |
The details of a certificate chain validation outcome. They may often suggest what reasons that contributed to the overall validation result. Returns a bit mask of the following options:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
chainValidationResult ChainValidities |
The outcome of a certificate chain validation routine. Available options:
Use the ValidationLog property to access the detailed validation log. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
hashAlgorithm String |
Returns the timestamp's hash algorithm
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
serialNumber Data |
Returns the timestamp's serial number. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
time String |
The time point incorporated into the timestamp. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
timestampType TimestampTypes |
Returns the timestamp type. Available options:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
tsaName String |
This value uniquely identifies the Timestamp Authority (TSA). This property provides information about the entity that manages the TSA. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
validationLog String |
Contains the TSA certificate chain validation log. This information is extremely useful if the timestamp validation fails. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
validationResult SignatureValidities |
Contains timestamp validation outcome. Use this property to check the result of the most recent timestamp validation.
|
Constructors
public init()
Creates a new TimestampInfo object with default field values.
TLSSettings Type
A container for TLS connection settings.
Remarks
TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP.
Fields
|
autoValidateCertificates Bool |
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. |
|||||||||||||||||||||||||||||||||
|
baseConfiguration SecureTransportPredefinedConfigurations |
Selects the base configuration for the TLS settings. Several profiles are on offer, tuned up for different purposes, such as high security or higher compatibility.
|
|||||||||||||||||||||||||||||||||
|
ciphersuites String |
A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases that allow to blanketly enable or disable all ciphersuites at once. Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by BaseConfiguration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:
|
|||||||||||||||||||||||||||||||||
|
ecCurves String |
Defines the elliptic curves to enable. |
|||||||||||||||||||||||||||||||||
|
extensions String |
Provides access to TLS extensions. |
|||||||||||||||||||||||||||||||||
|
forceResumeIfDestinationChanges Bool |
Whether to force TLS session resumption when the destination address changes. |
|||||||||||||||||||||||||||||||||
|
preSharedIdentity String |
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
|||||||||||||||||||||||||||||||||
|
preSharedKey String |
Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. |
|||||||||||||||||||||||||||||||||
|
preSharedKeyCiphersuite String |
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. |
|||||||||||||||||||||||||||||||||
|
renegotiationAttackPreventionMode RenegotiationAttackPreventionModes |
Selects renegotiation attack prevention mechanism. The following options are available:
|
|||||||||||||||||||||||||||||||||
|
revocationCheck RevocationCheckKinds |
Specifies the kind(s) of revocation check to perform. Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.
This setting controls the way the revocation checks are performed. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time. There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs). This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to faster OCSP route and only demand one source to succeed) is a good choice for most of typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential. |
|||||||||||||||||||||||||||||||||
|
sslOptions Int32 |
Various SSL (TLS) protocol options, set of
|
|||||||||||||||||||||||||||||||||
|
tlsMode SSLModes |
Specifies the TLS mode to use.
|
|||||||||||||||||||||||||||||||||
|
useExtendedMasterSecret Bool |
Enables Extended Master Secret Extension, as defined in RFC 7627. |
|||||||||||||||||||||||||||||||||
|
useSessionResumption Bool |
Enables or disables TLS session resumption capability. |
|||||||||||||||||||||||||||||||||
|
versions Int32 |
Th SSL/TLS versions to enable by default.
|
Constructors
public init()
Creates a new TLSSettings object.
XMLNamespace Type
Represents an XML namespace map for XPath expressions.
Remarks
This class defines the correspondence between Prefixes and namespace URIs.
Fields
|
prefix String |
A user-defined prefix value of a namespace. |
|
uri String |
A user-defined URI value of a namespace. |
Constructors
public init()
Creates a new XML namespace 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.
Fields
|
autoGenerateElementId Bool |
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 |
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.
|
||||||||||||||||||||||||||||||||||||
|
customElementId String |
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. |
||||||||||||||||||||||||||||||||||||
|
digestValue Data |
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 |
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
|
||||||||||||||||||||||||||||||||||||
|
hashAlgorithm String |
Specifies the hash algorithm to be used. Supported values:
|
||||||||||||||||||||||||||||||||||||
|
hasURI Bool |
Specifies whether the URI is set (even when it is empty). |
||||||||||||||||||||||||||||||||||||
|
id String |
A user-defined identifier (ID) attribute of this Reference element. |
||||||||||||||||||||||||||||||||||||
|
inclusiveNamespacesPrefixList String |
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 |
The Reference's type attribute as defined in XMLDSIG specification. |
||||||||||||||||||||||||||||||||||||
|
targetData Data |
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. |
||||||||||||||||||||||||||||||||||||
|
targetXMLElement String |
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:
|
||||||||||||||||||||||||||||||||||||
|
uri String |
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 |
Specifies whether Base64 transform is included in transform chain. |
||||||||||||||||||||||||||||||||||||
|
useEnvelopedSignatureTransform Bool |
Specifies whether enveloped signature transform is included in transform chain. |
||||||||||||||||||||||||||||||||||||
|
useXPathFilter2Transform Bool |
Specifies whether XPath Filter 2.0 transform is included in transform chain. |
||||||||||||||||||||||||||||||||||||
|
useXPathTransform Bool |
Specifies whether XPath transform is included in transform chain. |
||||||||||||||||||||||||||||||||||||
|
xPathExpression String |
Use this property to specify XPath expression for XPath transform of the reference. |
||||||||||||||||||||||||||||||||||||
|
xPathFilter2Expressions String |
Use this property to specify XPointer expression(s) for XPath Filter 2.0 transform of the reference. TBD |
||||||||||||||||||||||||||||||||||||
|
xPathFilter2Filters String |
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:
|
||||||||||||||||||||||||||||||||||||
|
xPathFilter2PrefixList String |
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 |
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: String)
Creates a new XML reference element from its ID .
public init(iD: String, uRI: String)
Creates a new XML reference element from its ID and URI reference to the external data.
Configuration 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 Configuration Settings | ||||||||||||||||||||||||||||||
| ClaimedRoleText:
The text of the claimed role.Use this property to get the text of the first claimed role.
TBD |
||||||||||||||||||||||||||||||
| ClaimedRoleXML:
The XML content of the claimed roles.Use this property to get the XML content of the claimed roles element.
TBD |
||||||||||||||||||||||||||||||
| CommitmentTypeIndicationAllSignedDataObjects[Index]: Specifies the CommitmentTypeIndication's AllSignedDataObjects.This property contains if the CommitmentTypeIndication's AllSignedDataObjects element is present that indicates that all the signed data objects share the same commitment. Index value could be omitted for the first CommitmentTypeIndication element. | ||||||||||||||||||||||||||||||
| CommitmentTypeIndicationCount: The number of the CommitmentTypeIndication elements.Returns the number of the xades:CommitmentTypeIndication elements available. | ||||||||||||||||||||||||||||||
| CommitmentTypeIndicationIdentifier[Index]: Specifies the CommitmentTypeIndication's CommitmentTypeId's Identifier.This property contains an identifier indicating the type of commitment made by the signer in the CommitmentTypeIndication's CommitmentTypeId's Identifier element. Index value could be omitted for the first CommitmentTypeIndication element. | ||||||||||||||||||||||||||||||
| CommitmentTypeIndicationIdentifierDescription[Index]: Specifies the CommitmentTypeIndication's CommitmentTypeId's Description.This property contains an identifier's description indicating the type of commitment made by the signer in the CommitmentTypeIndication's CommitmentTypeId's Description element. Index value could be omitted for the first CommitmentTypeIndication element. | ||||||||||||||||||||||||||||||
| CommitmentTypeIndicationIdentifierDocumentationReferences[Index]: Specifies the CommitmentTypeIndication's CommitmentTypeId's DocumentationReferences.This property contains an identifier's documentation references indicating the type of commitment made by the signer in the CommitmentTypeIndication's CommitmentTypeId's DocumentationReferences element. Index value could be omitted for the first CommitmentTypeIndication element. | ||||||||||||||||||||||||||||||
| CommitmentTypeIndicationIdentifierQualifier[Index]: Specifies the CommitmentTypeIndication's CommitmentTypeId's IdentifierQualifier.This property contains an identifier qualifier indicating the type of commitment made by the signer in the CommitmentTypeIndication's CommitmentTypeId's IdentifierQualifier element. Index value could be omitted for the first CommitmentTypeIndication element. | ||||||||||||||||||||||||||||||
| CommitmentTypeIndicationObjectReference[Index]: Specifies the CommitmentTypeIndication's ObjectReference.This property contains the CommitmentTypeIndication's ObjectReference elements that refer to one or several ds:Reference elements of the ds:SignedInfo corresponding with one data object qualified by this property. Index value could be omitted for the first CommitmentTypeIndication element. | ||||||||||||||||||||||||||||||
| CommitmentTypeIndicationQualifiersXML[Index]: The XML content of the CommitmentTypeIndication's Qualifiers.This property contains the CommitmentTypeIndication's Qualifiers elements XML content. Index value could be omitted for the first CommitmentTypeIndication element. | ||||||||||||||||||||||||||||||
| CustomTSLs: Specifies the custom TSLs.Use this property to specify the custom TSLs (Trust Service status Lists) to the validator. The URLs list is comma-separated. | ||||||||||||||||||||||||||||||
| DataObjectFormatCount: The number of the DataObjectFormat elements.Returns the number of the xades:DataObjectFormat elements available. | ||||||||||||||||||||||||||||||
| DataObjectFormatDescription[Index]: Specifies the DataObjectFormat's Description.This property contains textual information related to the signed data object in the DataObjectFormat's Description element. Index value could be omitted for the first DataObjectFormat element. | ||||||||||||||||||||||||||||||
| DataObjectFormatEncoding[Index]: Specifies the DataObjectFormat's Encoding.This property contains an indication of the encoding format of the signed data object in the DataObjectFormat's Encoding element. Index value could be omitted for the first DataObjectFormat element. | ||||||||||||||||||||||||||||||
| DataObjectFormatMimeType[Index]: Specifies the DataObjectFormat's MimeType.This property contains an indication of the MIME type of the signed data object in the DataObjectFormat's MimeType element. Index value could be omitted for the first DataObjectFormat element. | ||||||||||||||||||||||||||||||
| DataObjectFormatObjectIdentifier[Index]: Specifies the DataObjectFormat's ObjectIdentifier's Identifier.This property contains an identifier indicating the type of the signed data object in the DataObjectFormat's ObjectIdentifier's Identifier element. Index value could be omitted for the first DataObjectFormat element. | ||||||||||||||||||||||||||||||
| DataObjectFormatObjectIdentifierDescription[Index]: Specifies the DataObjectFormat's ObjectIdentifier's Description.This property contains an identifier's description indicating the type of the signed data object in the DataObjectFormat's ObjectIdentifier's Description element. Index value could be omitted for the first DataObjectFormat element. | ||||||||||||||||||||||||||||||
| DataObjectFormatObjectIdentifierDocumentationReferences[Index]: Specifies the DataObjectFormat's ObjectIdentifier's DocumentationReferences.This property contains an identifier's documentation references indicating the type of the signed data object in the DataObjectFormat's ObjectIdentifier's DocumentationReferences element. Index value could be omitted for the first DataObjectFormat element. | ||||||||||||||||||||||||||||||
| DataObjectFormatObjectIdentifierQualifier[Index]: Specifies the DataObjectFormat's ObjectIdentifier's IdentifierQualifier.This property contains an identifier qualifier indicating the type of the signed data object in the DataObjectFormat's ObjectIdentifier's IdentifierQualifier element. Index value could be omitted for the first DataObjectFormat element. | ||||||||||||||||||||||||||||||
| DataObjectFormatObjectReference[Index]:
Specifies the DataObjectFormat's ObjectReference.This property contains the DataObjectFormat's ObjectReference element that reference the ds:Reference element of the ds:Signature corresponding with the data object qualified by this property.
For example, if the corresponding ds:Reference element has an Id "reference-id-1", then you should set this property to "#reference-id-1" value. Index value could be omitted for the first DataObjectFormat element. |
||||||||||||||||||||||||||||||
| ForceCompleteChainValidation: Whether to check the CA certificates when the signing certificate is invalid.Set this property to True to check issuer (CA) certificates if the signing or an intermediate chain certificate is invalid. | ||||||||||||||||||||||||||||||
| ForceCompleteChainValidationForTrusted: Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors. Set this property to True to enable full chain validation for explicitly trusted intermediary or end-entity certificates. This may be useful when creating signatures to enforce completeness of the collected revocation information. It often makes sense to set this property to false when validating signatures to reduce validation time and avoid issues with badly configured environments. | ||||||||||||||||||||||||||||||
| GracePeriod: Specifies a grace period to apply during revocation information checks.Use this property to specify a grace period (in seconds). Grace period applies to certain subprotocols, such as OCSP, and caters to the inaccuracy and/or missynchronization of clocks on different participating systems. Any time deviations within the grace period will be tolerated. | ||||||||||||||||||||||||||||||
| HMACKey:
The key value for HMAC.TBD
The component uses base16 (hex) encoding for this configuration value. |
||||||||||||||||||||||||||||||
| HMACSigningUsed: Whether HMAC signing was used.TBD | ||||||||||||||||||||||||||||||
| IgnoreOCSPNoCheckExtension: Whether OCSP NoCheck extension should be ignored.Set this property to false to make the validation engine ignore the OCSP no-check extension. You would normally need to set this property when validating severely non-compliant chains that misuse the extension, causing chain loops or other validation issues. | ||||||||||||||||||||||||||||||
| IgnoreSystemTrust:
Whether trusted Windows Certificate Stores should be treated as trusted.Specifies whether, during chain validation, the component should respect
the trust to CA certificates as configured in the operating system.
In Windows this effectively defines whether the component should trust the
certificates residing in the Trusted Root Certification Authorities store.
If IgnoreSystemTrust is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as TrustedCertificates property) are considered trusted. |
||||||||||||||||||||||||||||||
| ImplicitlyTrustSelfSignedCertificates: Whether to trust self-signed certificates. Set this property to True to implicitly trust all self-signed certificates. Use it with care as trusting just about every self-signed certificate is unwise. One exceptional reason where this property may be handy is where a chain is validated in an environment that is not supposed to trust it (for example, a signing, rather than verifying environment, or a QA server). Trusting all self-signing certificates (which are normally trusted) allows to emulate the verifying environment without actually changing its security settings. | ||||||||||||||||||||||||||||||
| IncludeKnownRevocationInfoToSignature: Whether to include custom revocation info to the signature.This property specifies whether revocation pieces provided via KnownCertificates, KnownCRLs, and KnownOCSPs properties should be included into the signature. This property lets you include custom validation elements to the signature in addition to the ones comprising the signing chain. | ||||||||||||||||||||||||||||||
| InclusiveNamespacesPrefixList: Specifies the InclusiveNamespaces PrefixList.Use this property to read InclusiveNamespaces PrefixList used for exclusive canonicalization transform of SignedInfo element. See XML-Signature Syntax and Processing specification for details. | ||||||||||||||||||||||||||||||
| KeyName: Identifies the key.Contains a string value (with significant spaces) which may be used by the signer to communicate a key identifier to the recipient. Typically, KeyName 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 KeyName include simple string names for keys, a key index, a distinguished name (DN), an email address, etc. | ||||||||||||||||||||||||||||||
| ProductionPlace: Identifies the place of the signature production.Use this property to get the signature production place. | ||||||||||||||||||||||||||||||
| PromoteLongOCSPResponses: Whether long OCSP responses are requested. Set this property to True to force the class to publish 'long' form of OCSP responses. Otherwise, only BasicOCSPResponse blobs are promoted. | ||||||||||||||||||||||||||||||
| PSSUsed: Whether RSASSA-PSS mode was used.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. | ||||||||||||||||||||||||||||||
| QualifiedStatus: Indicates a qualified electronic signature.Use this property to check if an electronic signature is created using a qualified device for creating electronic signatures and that relies on a qualified electronic signature certificate. This property return TSP service status URI. | ||||||||||||||||||||||||||||||
| RemoveSignature: Whether to remove signature.Enable to remove signature after its verification. | ||||||||||||||||||||||||||||||
| SignatureID: Contains the ID for Signature element.This property contains the identifier (ID) attribute of the ds:Signature element. | ||||||||||||||||||||||||||||||
| SigPolicyDescription: signature policy description.Use this property to get the Description of the signature policy. | ||||||||||||||||||||||||||||||
| SigPolicyExplicitText: The explicit text of the user notice.Use this property to get the explicit text of the user notice to be displayed when the signature is verified. | ||||||||||||||||||||||||||||||
| SigPolicyHash: The hash value of the signature policy.Use this property to get the hash value of the signature policy. | ||||||||||||||||||||||||||||||
| SigPolicyHashAlgorithm: The hash algorithm used to compute the signature policy hash.Use this property to get the algorithm used to compute the signature policy hash. | ||||||||||||||||||||||||||||||
| SigPolicyID: Identifies the signature policy.Use this property to get an identifier that uniquely identifies a specific version of the signature policy. | ||||||||||||||||||||||||||||||
| SigPolicyNoticeNumbers: Contains user notice numbers.This property provides an access to the list of notice numbers, by which the explicit signature policy notice texts could be retrieved. | ||||||||||||||||||||||||||||||
| SigPolicyNoticeOrganization: The organization part of the NoticeReference qualifier.Defines the "organization" part of the NoticeReference signature policy qualifier for XAdES-EPES form. | ||||||||||||||||||||||||||||||
| SigPolicyURI: Signature policy URI.Use this property to get the URI of the signature policy. | ||||||||||||||||||||||||||||||
| TempPath: Location where the temporary files are stored.This setting specifies an absolute path to the location on disk where temporary files are stored. | ||||||||||||||||||||||||||||||
TimestampCanonicalizationMethod:
Specifies canonicalization method used in timestamp.Use this property to specify the canonicalization method used in timestamp.
|
||||||||||||||||||||||||||||||
| TimestampValidationDataDetails:
Specifies timestamp validation data details to include to the signature.Contains a comma-separated list of values that specifies which validation data values details to include to the signature when xades:TimeStampValidationData element added.
Supported values are:
|
||||||||||||||||||||||||||||||
| TolerateMinorChainIssues: Whether to tolerate minor chain issues.TBD | ||||||||||||||||||||||||||||||
| TSLDistributionPoints: Contains XML content of distribution points of the TSL used.Use this property to get XML content of distribution points of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLDistributionPoints[Idx]: Contains distribution point of the specified index of the TSL used.Use this property to get distribution point of the specified index of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLHistoricalInformationPeriod: Contains historical information period of the TSL used.Use this property to get historical information period of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLLegalNotices: Contains XML content of legal notices of the TSL used.Use this property to get XML content of multilingual legal notices of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLLegalNotices[lang]: Contains legal notices for the specified language of the TSL used.Use this property to get legal notices for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLListIssueDateTime: Contains list issue date and time of the TSL used.Use this property to get list issue date and time of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLNextUpdate: Contains next update date and time of the TSL used.Use this property to get next update date and time of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLPolicies: Contains XML content of policies of the TSL used.Use this property to get XML content of multilingual policies of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLPolicies[lang]: Contains policies for the specified language of the TSL used.Use this property to get policies for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLSchemeExtensions: Contains XML content of scheme extensions of the TSL used.Use this property to get XML content of scheme extensions of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLSchemeExtensions[Idx]: Contains XML content of scheme extension of the specified index of the TSL used.Use this property to get XML content of scheme extension of the specified index of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLSchemeInformationURI: Contains XML content of scheme information URI of the TSL used.Use this property to get XML content of multilingual scheme information URI of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLSchemeInformationURI[lang]: Contains scheme information URI for the specified language of the TSL used.Use this property to get scheme information URI for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLSchemeName: Contains XML content of scheme name of the TSL used.Use this property to get XML content of multilingual scheme name of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLSchemeName[lang]: Contains scheme name for the specified language of the TSL used.Use this property to get scheme name for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLSchemeOperatorAddress: Contains XML content of scheme operator address of the TSL used.Use this property to get XML content of scheme operator address of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLSchemeOperatorName: Contains XML content of scheme operator name of the TSL used.Use this property to get XML content of multilingual scheme operator name of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLSchemeOperatorName[lang]: Contains scheme operator name for the specified language of the TSL used.Use this property to get scheme operator name for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLSchemeTerritory: Contains scheme territory of the TSL used.Use this property to get scheme territory of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLSchemeTypeCommunityRules: Contains XML content of scheme type/community/rules of the TSL used.Use this property to get XML content of multilingual scheme type/community/rules of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLSchemeTypeCommunityRules[lang]: Contains scheme type/community/rules for the specified language of the TSL used.Use this property to get scheme type/community/rules for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLSequenceNumber: Contains sequence number of the TSL used.Use this property to get sequence number of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLsRetrieveLog: Contains the complete log of the TSLs retrieve.Use this property to access the TSLs retrieve log produced by the class. The log can be very useful when investigating issues with TSL retrieve. | ||||||||||||||||||||||||||||||
| TSLStatusDeterminationApproach: Contains status determination approach of the TSL used.Use this property to get status determination approach of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLsValidationLog: Contains the complete log of the TSLs validation.Use this property to access the TSLs validation log produced by the class. The log can be very useful when investigating issues with TSL validation. | ||||||||||||||||||||||||||||||
| TSLTSPAdditionalServiceInformation: Contains addtional service information of the TSP service used.Use this property to get the list of addtional service information of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. The URIs list is comma-separated. | ||||||||||||||||||||||||||||||
| TSLTSPAddress: Contains XML content of the address of the TSP used.Use this property to get XML content of the address of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPHistoryInstance: Indicates that TSP service history instance used.Indicates whether or not the qualified status was obtained from the TSP (Trust Service Provider) service history instance. | ||||||||||||||||||||||||||||||
| TSLTSPHistoryInstanceAdditionalServiceInformation: Contains addtional service information of the TSP service history instance used.Use this property to get the list of addtional service information of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. The URIs list is comma-separated. | ||||||||||||||||||||||||||||||
| TSLTSPHistoryInstanceQualifiers: Contains list of qualifiers of the TSP service history instance used.Use this property to get the list of qualifiers of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. The URIs list is comma-separated. | ||||||||||||||||||||||||||||||
| TSLTSPHistoryInstanceServiceInformationExtensions: Contains XML content of information extensions of the TSP service history instance used.Use this property to get XML content of information extensions of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPHistoryInstanceServiceInformationExtensions[Idx]: Contains XML content of information extension of the specified index of the TSP service history instance used.Use this property to get XML content of information extension of the specified index of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPHistoryInstanceServiceName: Contains XML content of name of the TSP service history instance used.Use this property to get XML content of multilingual name of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPHistoryInstanceServiceName[lang]: Contains name for the specified language of the TSP service history instance used.Use this property to get the name for the specified language code (e.g. 'en') of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPHistoryInstanceServiceStatus: Contains status of the TSP service history instance used.Use this property to get the status of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPHistoryInstanceServiceStatusStartingTime: Contains status starting time of the TSP service history instance used.Use this property to get the status starting time of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPHistoryInstanceServiceTypeIdentifier: Contains type identifier of the TSP service history instance used.Use this property to get type identifier of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPHistoryInstanceXML: Contains XML content of the TSP service history instance used.Use this property to get XML content of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPInformationExtensions: Contains XML content of information extensions of the TSP used.Use this property to get XML content of information extensions of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPInformationExtensions[Idx]: Contains XML content of information extension of the specified index of the TSP used.Use this property to get XML content of information extension of the specified index of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPInformationURI: Contains XML content of information URI of the TSP used.Use this property to get XML content of multilingual information URI of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPInformationURI[lang]: Contains information URI for the specified language of the TSP used.Use this property to get the information URI for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPName: Contains XML content of name of the TSP used.Use this property to get XML content of multilingual name of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPName[lang]: Contains name for the specified language of the TSP used.Use this property to get the name for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPSchemeServiceDefinitionURI: Contains XML content of scheme service definition URI of the TSP service used.Use this property to get XML content of multilingual scheme service definition URI of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPSchemeServiceDefinitionURI[lang]: Contains scheme service definition URI for the specified language of the TSP service used.Use this property to get the scheme service definition URI for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPServiceDefinitionURI: Contains XML content of definition URI of the TSP service used.Use this property to get XML content of multilingual definition URI of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPServiceDefinitionURI[lang]: Contains definition URI for the specified language of the TSP service used.Use this property to get the definition URI for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPServiceInformationExtensions: Contains XML content of information extensions of the TSP service used.Use this property to get XML content of information extensions of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPServiceInformationExtensions[Idx]: Contains XML content of information extension of the specified index of the TSP service used.Use this property to get XML content of information extension of the specified index of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPServiceName: Contains XML content of name of the TSP service used.Use this property to get XML content of multilingual name of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPServiceName[lang]: Contains name for the specified language of the TSP service used.Use this property to get the name for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPServiceQualifiers: Contains list of qualifiers of the TSP service used.Use this property to get the list of qualifiers of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. The URIs list is comma-separated. | ||||||||||||||||||||||||||||||
| TSLTSPServiceStatus: Contains status of the TSP service used.Use this property to get the status of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPServiceStatusStartingTime: Contains status starting time of the TSP service used.Use this property to get the status starting time of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPServiceSupplyPoints: Contains XML content of the supply points of the TSP service used.Use this property to get XML content of the supply points of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPServiceTypeIdentifier: Contains type identifier of the TSP service used.Use this property to get type identifier of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPServiceXML: Contains XML content of the TSP service used.Use this property to get XML content of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPTradeName: Contains XML content of trade name of the TSP used.Use this property to get XML content of multilingual trade name of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPTradeName[lang]: Contains trade name for the specified language of the TSP used.Use this property to get the trade name for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLTSPXML: Contains XML content of the TSP used.Use this property to get XML content of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLType: Contains TSL type of the TSL used.Use this property to get TSL type of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLVersionIdentifier: Contains version identifier of the TSL used.Use this property to get version identifier of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TSLXML: Contains XML content of the TSL used.Use this property to get XML content of the TSL used to obtain the qualified status of the certificate. | ||||||||||||||||||||||||||||||
| TspHashAlgorithm: Sets a specific hash algorithm for use with the timestamping service.In default configuration class uses the 'SHA256' hash algorithm. Use this property to specify a different hash algorithm for the timestamp. | ||||||||||||||||||||||||||||||
| UseDefaultTSLs:
Enables or disables the use of the default TSLs.Use this property to tell the validator to use (or not to use) the default TSLs (Trust Service status Lists).
The result of this check reported in Qualified property.
The following default TSLs are used: EU (European Union) LOTL (list of trusted lists). |
||||||||||||||||||||||||||||||
| UseMicrosoftCTL: Enables or disables automatic use of Microsoft online certificate trust list.Enable this property to make the chain validation module automatically look up missing CA certificates in the public Windows Update repository. | ||||||||||||||||||||||||||||||
| UseSystemCertificates: Enables or disables the use of the system certificates.Use this property to tell chain validation module automatically look up missing CA certificates in the system certificates. In many cases it is beneficial to switch this property on, as the operating system certificate configuration provides a representative trust framework. | ||||||||||||||||||||||||||||||
| ValidationDataRefsDetails:
Specifies validation data references details to include to the signature.Contains a comma-separated list of values that specifies which validation data references details to include to the signature when signature upgraded to XAdES-C or XAdES-E-C form.
Supported values are:
|
||||||||||||||||||||||||||||||
| ValidationDataValuesDetails:
Specifies validation data values details to include to the signature.Contains a comma-separated list of values that specifies which validation data values details to include to the signature when signature upgraded to XAdES-X-L or XAdES-E-X-L form.
Supported values are:
|
||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||
Base Configuration Settings | ||||||||||||||||||||||||||||||
| CheckKeyIntegrityBeforeUse:
Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit,
but prevents a selection of attacks on RSA keys where keys with unknown origins are used.
You can switch this property off to improve performance if your project only uses known, good private keys. |
||||||||||||||||||||||||||||||
| CookieCaching:
Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class.
Supported values are:
|
||||||||||||||||||||||||||||||
| Cookies: Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions. | ||||||||||||||||||||||||||||||
| DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. | ||||||||||||||||||||||||||||||
| EnableClientSideSSLFFDHE:
Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower
algorithm if compared to EC DHE; enabling it may result in slower connections.
This setting only applies to sessions negotiated with TLS version 1.3. |
||||||||||||||||||||||||||||||
| GlobalCookies: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global". | ||||||||||||||||||||||||||||||
| HttpUserAgent: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes. | ||||||||||||||||||||||||||||||
| LogDestination:
Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.
Supported values are:
|
||||||||||||||||||||||||||||||
| LogDetails:
Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump.
Supported values are:
|
||||||||||||||||||||||||||||||
| LogFile: Specifies the debug log filename.Use this property to provide a path to the log file. | ||||||||||||||||||||||||||||||
| LogFilters:
Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters.
Supported filter names are:
|
||||||||||||||||||||||||||||||
LogFlushMode:
Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:
|
||||||||||||||||||||||||||||||
| LogLevel:
Specifies the debug log level.Use this property to provide the desired debug log level.
Supported values are:
|
||||||||||||||||||||||||||||||
| LogMaxEventCount:
Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects,
depending on the rotation setting and/or the flush mode.
The default value of this setting is 100. |
||||||||||||||||||||||||||||||
LogRotationMode:
Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined:
|
||||||||||||||||||||||||||||||
| MaxASN1BufferLength: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. | ||||||||||||||||||||||||||||||
| MaxASN1TreeDepth: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. | ||||||||||||||||||||||||||||||
| OCSPHashAlgorithm: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. | ||||||||||||||||||||||||||||||
| Tag: Allows to store any custom data.Use this config property to store any custom data. | ||||||||||||||||||||||||||||||
| UseSharedSystemStorages: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores. | ||||||||||||||||||||||||||||||
| UseSystemOAEPAndPSS:
Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable.
If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations
using its own OAEP/PSS implementation.
This setting only applies to certificates originating from a Windows system store. |
||||||||||||||||||||||||||||||
| UseSystemRandom: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation. |
Trappable Errors (SOAPVerifier Module)
SOAPVerifier Errors
| 1048577 Invalid parameter value (SB_ERROR_INVALID_PARAMETER) | |
| 1048578 Class is configured incorrectly (SB_ERROR_INVALID_SETUP) | |
| 1048579 Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE) | |
| 1048580 Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE) | |
| 1048581 Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY) | |
| 1048581 Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) | |
| 33554433 Input file does not exist (SB_ERROR_SOAP_INPUTFILE_NOT_EXISTS) | |
| 33554434 Invalid key type (SB_ERROR_SOAP_INVALID_KEY_TYPE) | |
| 33554435 Signature not found (SB_ERROR_SOAP_SIGNATURE_NOT_FOUND) | |
| 33554436 Unsupported signature type (SB_ERROR_SOAP_UNSUPPORTED_SIGNATURE_TYPE) |