SOAPQuickSigner Component
Properties Methods Events Configuration Settings Errors
The SOAPQuickSigner component signs SOAP messages.
Syntax
SecureBlackbox.Soapquicksigner
Remarks
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.
CanonicalizationMethod | Specifies XML canonicalization method to use. |
EmbedCertificateMethod | Controls the certificate disposition within the signature. |
Encoding | Specifies XML encoding. |
ExternalCrypto | Provides access to external signing and DC parameters. |
HashAlgorithm | Specifies the hash algorithm to be used. |
InputFile | Specifies the SOAP message to be signed. |
InputStream | A stream containing the SOAP message to be signed. |
OutputFile | A file where the signed SOAP message will be saved. |
OutputStream | A stream to write the signed SOAP message to. |
References | A list of references to the data to be signed. |
SignatureType | The SOAP signature type to use. |
SigningCertificate | The certificate to be used for signing. |
SigningChain | The signing certificate chain. |
XPathNamespaces | Specifies 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.
addBodyReference | Creates a new XML reference to the Body element of the SOAP message. |
addDataReference | Creates a new XML reference to the specified data. |
addReference | Creates a new XML reference to the specified XML element. |
config | Sets or retrieves a configuration setting. |
extractAsyncData | Extracts user data from the DC signing service response. |
sign | Signs the SOAP message. |
signAsyncBegin | Initiates the asynchronous signing operation. |
signAsyncEnd | Completes the asynchronous signing operation. |
signExternal | Signs 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.
Error | Information about errors during signing. |
ExternalSign | Handles remote or external signing initiated by the SignExternal method or other source. |
FormatElement | Reports the XML element that is currently being processed. |
FormatText | Reports XML text that is currently being processed. |
Notification | This event notifies the application about an underlying control flow event. |
ResolveReference | Asks 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.
BinarySecurityTokenID | Specifies the ID for BinarySecurityToken element. |
HMACKey | The key value for HMAC. |
HMACOutputLength | TBD. |
IncludeKey | Specifies whether to include the signing key to the signature. |
IncludeKeyValue | Specifies whether the key value must be included to the signature. |
InclusiveNamespacesPrefixList | Specifies the InclusiveNamespaces PrefixList. |
KeyInfoCustomXML | The custom XML content for KeyInfo element. |
KeyInfoDetails | Specifies the signing key info details to include to the signature. |
KeyInfoID | Specifies the ID for KeyInfo element. |
KeyName | Contains information about the key used for signing. |
PrependCustomXML | The custom XML content that prepended before signature. |
SecurityHeaderIndex | Specifies the SecurityHeader index. |
SecurityTokenReferenceID | Specifies the ID for SecurityTokenReference element. |
SignatureID | Specifies the ID for Signature element. |
SignaturePrefix | Specifies the signature prefix. |
SignatureValueID | Specifies the ID for SignatureValue element. |
SignedInfoID | Specifies the ID for SignedInfo element. |
TempPath | Location where the temporary files are stored. |
UseHMACSigning | Whether to use HMAC signing. |
UsePSS | Whether to use RSASSA-PSS algorithm. |
WriteBOM | Specifies whether byte-order mark should be written when saving the document. |
XMLFormatting | Specifies the signature XML formatting. |
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 component (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. |
UseOwnDNSResolver | Specifies whether the client components should use own DNS resolver. |
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. |