SecureBlackbox 2020 Android Edition

Questions / Feedback?

SOAPQuickSigner Component

Properties   Methods   Events   Configuration Settings   Errors  

The SOAPQuickSigner component signs SOAP messages.




The purpose of the SOAPQuickSigner component 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 component 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.
ExternalCryptoProvides access to external signing and DC parameters.
HashAlgorithmSpecifies the hash algorithm to be used.
InputFileSpecifies the SOAP message to be signed.
InputStreamA stream containing the SOAP message to be signed.
OutputFileA file where the signed SOAP message will be saved.
OutputStreamA stream to write the signed SOAP message to.
ReferencesA list of references to the data to be signed.
SignatureTypeThe SOAP signature type to use.
SigningCertificateThe certificate to be used for signing.
SigningChainThe signing certificate chain.
XPathNamespacesSpecifies namespaces for XPath expression.

Method List

The following is the full list of the methods of the component 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 component with short descriptions. Click on the links for further details.

ErrorInformation about errors during signing.
ExternalSignHandles remote or external signing initiated by the SignExternal method or other source.
FormatElementReports the XML element that is currently being processed.
FormatTextReports XML text that is currently being processed.
NotificationThis event notifies the application about an underlying control flow event.
ResolveReferenceAsks the application to resolve a reference.

Configuration Settings

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

BinarySecurityTokenIDSpecifies the ID for BinarySecurityToken element.
HMACKeyThe key value for HMAC.
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 component (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 components 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 Android Edition - Version 20.0 [Build 8165]