SecureBlackbox 2020 Python Edition

Questions / Feedback?

SOAPQuickSigner Class

Properties   Methods   Events   Configuration Settings   Errors  

The SOAPQuickSigner class signs SOAP messages.

Syntax

class secureblackbox.SOAPQuickSigner

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.

canonicalization_methodSpecifies XML canonicalization method to use.
embed_certificate_methodControls the certificate disposition within the signature.
encodingSpecifies XML encoding.
external_crypto_custom_paramsCustom parameters to be passed to the signing service (uninterpreted).
external_crypto_dataAdditional data to be included in the async state and mirrored back by the requestor.
external_crypto_external_hash_calculationSpecifies whether the message hash is to be calculated at the external endpoint.
external_crypto_hash_algorithmSpecifies the request's signature hash algorithm.
external_crypto_key_idThe ID of the pre-shared key used for DC request authentication.
external_crypto_key_secretThe pre-shared key used for DC request authentication.
external_crypto_methodSpecifies the asynchronous signing method.
external_crypto_modeSpecifies the external cryptography mode.
external_crypto_public_key_algorithmProvide public key algorithm here if the certificate is not available on the pre-signing stage.
hash_algorithmSpecifies the hash algorithm to be used.
input_fileSpecifies the SOAP message to be signed.
output_fileA file where the signed SOAP message will be saved.
reference_countThe number of records in the Reference arrays.
reference_auto_generate_element_idSpecifies whether the identifier (ID) attribute for a referenced (target) element should be auto-generated during signing.
reference_canonicalization_methodUse this property to specify the canonicalization method for the transform of the reference.
reference_custom_element_idSpecifies a custom identifier (ID) attribute for a referenced (target) element that will be set on signing.
reference_digest_valueUse this property to get or set the value of the digest calculated over the referenced data.
reference_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
reference_hash_algorithmSpecifies the hash algorithm to be used.
reference_has_uriSpecifies whether the URI is set (even when it is empty).
reference_idA user-defined identifier (ID) attribute of this Reference element.
reference_inclusive_namespaces_prefix_listUse this property to specify InclusiveNamespaces PrefixList for exclusive canonicalization transform of the reference.
reference_reference_typeThe Reference's type attribute as defined in XMLDSIG specification.
reference_target_dataContains the referenced external data when the digest value is not explicitly specified.
reference_target_xml_elementThis property specifies the referenced XML element.
reference_uriUse this property to get or set the URL which references the data.
reference_use_base_64_transformSpecifies whether Base64 transform is included in transform chain.
reference_use_enveloped_signature_transformSpecifies whether enveloped signature transform is included in transform chain.
reference_use_x_path_filter_2_transformSpecifies whether XPath Filter 2.
reference_use_x_path_transformSpecifies whether XPath transform is included in transform chain.
reference_x_path_expressionUse this property to specify XPath expression for XPath transform of the reference.
reference_x_path_filter_2_expressionsUse this property to specify XPointer expression(s) for XPath Filter 2.
reference_x_path_filter_2_filtersUse this property to specify XPointer filter(s) for XPath Filter 2.
reference_x_path_filter_2_prefix_listUse this property to specify a prefix list for XPath Filter 2.
reference_x_path_prefix_listUse this property to specify a prefix list for XPath transform of the reference.
signature_typeThe SOAP signature type to use.
signing_cert_bytesReturns raw certificate data in DER format.
signing_cert_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
signing_chain_countThe number of records in the SigningChain arrays.
signing_chain_bytesReturns raw certificate data in DER format.
signing_chain_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
namespace_countThe number of records in the Namespace arrays.
namespace_prefixA user-defined prefix value of a namespace.
namespace_uriA 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.

add_body_referenceCreates a new XML reference to the Body element of the SOAP message.
add_data_referenceCreates a new XML reference to the specified data.
add_referenceCreates a new XML reference to the specified XML element.
configSets or retrieves a configuration setting.
extract_async_dataExtracts user data from the DC signing service response.
signSigns the SOAP message.
sign_async_beginInitiates the asynchronous signing operation.
sign_async_endCompletes the asynchronous signing operation.
sign_externalSigns 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.

on_errorInformation about errors during signing.
on_external_signHandles remote or external signing initiated by the SignExternal method or other source.
on_format_elementReports the XML element that is currently being processed.
on_format_textReports XML text that is currently being processed.
on_notificationThis event notifies the application about an underlying control flow event.
on_resolve_referenceAsks 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 Python Edition - Version 20.0 [Build 8165]