SecureBlackbox 2020 iOS Edition

Questions / Feedback?

SOAPQuickSigner Class

Properties   Methods   Events   Configuration Settings   Errors  

The SOAPQuickSigner class signs SOAP messages.

Syntax

SecureBlackboxSOAPQuickSigner
SecureBlackboxSOAPQuickSignerSwift

Remarks

The purpose of the SOAPQuickSigner class is creating simple generic signatures over SOAP messages. Unlike SOAPSigner, it does not include chain validation and LTV features, and may be more appropriate for scenarios where no chain validation is required.

Property List


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

- canonicalizationMethodSpecifies XML canonicalization method to use.
- embedCertificateMethodControls the certificate disposition within the signature.
- encodingSpecifies XML encoding.
- externalCryptoCustomParamsCustom parameters to be passed to the signing service (uninterpreted).
- externalCryptoDataAdditional data to be included in the async state and mirrored back by the requestor.
- externalCryptoExternalHashCalculationSpecifies whether the message hash is to be calculated at the external endpoint.
- externalCryptoHashAlgorithmSpecifies the request's signature hash algorithm.
- externalCryptoKeyIDThe ID of the pre-shared key used for DC request authentication.
- externalCryptoKeySecretThe pre-shared key used for DC request authentication.
- externalCryptoMethodSpecifies the asynchronous signing method.
- externalCryptoModeSpecifies the external cryptography mode.
- externalCryptoPublicKeyAlgorithmProvide public key algorithm here if the certificate is not available on the pre-signing stage.
- hashAlgorithmSpecifies the hash algorithm to be used.
- inputFileSpecifies the SOAP message to be signed.
- outputFileA file where the signed SOAP message will be saved.
- referenceCountThe number of records in the Reference arrays.
- referenceAutoGenerateElementId:(int)referenceIndexSpecifies whether the identifier (ID) attribute for a referenced (target) element should be auto-generated during signing.
- referenceCanonicalizationMethod:(int)referenceIndexUse this property to specify the canonicalization method for the transform of the reference.
- referenceCustomElementId:(int)referenceIndexSpecifies a custom identifier (ID) attribute for a referenced (target) element that will be set on signing.
- referenceDigestValue:(int)referenceIndexUse this property to get or set the value of the digest calculated over the referenced data.
- referenceHandle:(int)referenceIndexAllows to get or set a 'handle', a unique identifier of the underlying property object.
- referenceHashAlgorithm:(int)referenceIndexSpecifies the hash algorithm to be used.
- referenceHasURI:(int)referenceIndexSpecifies whether the URI is set (even when it is empty).
- referenceID:(int)referenceIndexA user-defined identifier (ID) attribute of this Reference element.
- referenceInclusiveNamespacesPrefixList:(int)referenceIndexUse this property to specify InclusiveNamespaces PrefixList for exclusive canonicalization transform of the reference.
- referenceReferenceType:(int)referenceIndexThe Reference's type attribute as defined in XMLDSIG specification.
- referenceTargetData:(int)referenceIndexContains the referenced external data when the digest value is not explicitly specified.
- referenceTargetXMLElement:(int)referenceIndexThis property specifies the referenced XML element.
- referenceURI:(int)referenceIndexUse this property to get or set the URL which references the data.
- referenceUseBase64Transform:(int)referenceIndexSpecifies whether Base64 transform is included in transform chain.
- referenceUseEnvelopedSignatureTransform:(int)referenceIndexSpecifies whether enveloped signature transform is included in transform chain.
- referenceUseXPathFilter2Transform:(int)referenceIndexSpecifies whether XPath Filter 2.
- referenceUseXPathTransform:(int)referenceIndexSpecifies whether XPath transform is included in transform chain.
- referenceXPathExpression:(int)referenceIndexUse this property to specify XPath expression for XPath transform of the reference.
- referenceXPathFilter2Expressions:(int)referenceIndexUse this property to specify XPointer expression(s) for XPath Filter 2.
- referenceXPathFilter2Filters:(int)referenceIndexUse this property to specify XPointer filter(s) for XPath Filter 2.
- referenceXPathFilter2PrefixList:(int)referenceIndexUse this property to specify a prefix list for XPath Filter 2.
- referenceXPathPrefixList:(int)referenceIndexUse this property to specify a prefix list for XPath transform of the reference.
- signatureTypeThe SOAP signature type to use.
- signingCertBytesReturns raw certificate data in DER format.
- signingCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
- signingChainCountThe number of records in the SigningChain arrays.
- signingChainBytes:(int)signingChainIndexReturns raw certificate data in DER format.
- signingChainHandle:(int)signingChainIndexAllows to get or set a 'handle', a unique identifier of the underlying property object.
- namespaceCountThe number of records in the Namespace arrays.
- namespacePrefix:(int)namespaceIndexA user-defined prefix value of a namespace.
- namespaceURI:(int)namespaceIndexA user-defined URI value of a namespace.

Method List


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

- addBodyReferenceCreates a new XML reference to the Body element of the SOAP message.
- addDataReferenceCreates a new XML reference to the specified data.
- addReferenceCreates a new XML reference to the specified XML element.
- configSets or retrieves a configuration setting.
- extractAsyncDataExtracts user data from the DC signing service response.
- signSigns the SOAP message.
- signAsyncBeginInitiates the asynchronous signing operation.
- signAsyncEndCompletes the asynchronous signing operation.
- signExternalSigns the document using an external signing facility.

Event List


The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

- onErrorInformation about errors during signing.
- onExternalSignHandles remote or external signing initiated by the SignExternal method or other source.
- onFormatElementReports the XML element that is currently being processed.
- onFormatTextReports XML text that is currently being processed.
- onNotificationThis event notifies the application about an underlying control flow event.
- onResolveReferenceAsks the application to resolve a reference.

Configuration Settings


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

BinarySecurityTokenIDSpecifies the ID for BinarySecurityToken element.
HMACKeyThe key value for HMAC.
HMACOutputLengthTBD.
IncludeKeySpecifies whether to include the signing key to the signature.
IncludeKeyValueSpecifies whether the key value must be included to the signature.
InclusiveNamespacesPrefixListSpecifies the InclusiveNamespaces PrefixList.
KeyInfoCustomXMLThe custom XML content for KeyInfo element.
KeyInfoDetailsSpecifies the signing key info details to include to the signature.
KeyInfoIDSpecifies the ID for KeyInfo element.
KeyNameContains information about the key used for signing.
PrependCustomXMLThe custom XML content that prepended before signature.
SecurityHeaderIndexSpecifies the SecurityHeader index.
SecurityTokenReferenceIDSpecifies the ID for SecurityTokenReference element.
SignatureIDSpecifies the ID for Signature element.
SignaturePrefixSpecifies the signature prefix.
SignatureValueIDSpecifies the ID for SignatureValue element.
SignedInfoIDSpecifies the ID for SignedInfo element.
TempPathLocation where the temporary files are stored.
UseHMACSigningWhether to use HMAC signing.
UsePSSWhether to use RSASSA-PSS algorithm.
WriteBOMSpecifies whether byte-order mark should be written when saving the document.
XMLFormattingSpecifies the signature XML formatting.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
UseOwnDNSResolverSpecifies whether the client classes should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2020 iOS Edition - Version 20.0 [Build 8165]