SOAPQuickSigner Configuration
The component 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 component, access to these internal properties is provided through the Config method.SOAPQuickSigner Configuration Settings
BinarySecurityTokenID:
Specifies the ID for BinarySecurityToken element. This property contains the identifier (ID) attribute of the wsse:BinarySecurityToken element. | ||||||||||||||||||||||
HMACKey:
The key value for HMAC. TBD The component uses base16 (hex) encoding for this configuration value. | ||||||||||||||||||||||
HMACOutputLength:
TBD. TBD Def | ||||||||||||||||||||||
IncludeKey:
Specifies whether to include the signing key to the signature. Set this property to True to include the public part of the signing key to the signature. This property is used when the SOAP signature type is set. | ||||||||||||||||||||||
IncludeKeyValue:
Specifies whether the key value must be included to the signature. Set this property to True if the key value (its public part) should be included to the signature. This property is used when the SOAP signature type is set. | ||||||||||||||||||||||
InclusiveNamespacesPrefixList:
Specifies the InclusiveNamespaces PrefixList. Use this property to specify InclusiveNamespaces PrefixList for exclusive canonicalization transform of SignedInfo element. See XML-Signature Syntax and Processing specification for details. | ||||||||||||||||||||||
KeyInfoCustomXML:
The custom XML content for KeyInfo element. Use this property to specify the custom XML content of the ds:KeyInfo element. TBD The empty elements in the custom XML content act as a placeholder for auto-generated elements. For example to change the order of ds:KeyValue and ds:X509Data auto-generated elements use the value: "<X509Data/><KeyValue/>" | ||||||||||||||||||||||
KeyInfoDetails:
Specifies the signing key info details to include to the signature. Contains a comma-separated list of values that specifies which signing key info details to include to the signature. This property is used when the SOAP signature type is set. Supported values are:
| ||||||||||||||||||||||
KeyInfoID:
Specifies the ID for KeyInfo element. This property contains the identifier (ID) attribute of the ds:KeyInfo element. | ||||||||||||||||||||||
KeyName:
Contains information about the key used for signing. The KeyName element contains a string value (with significant whitespaces) which may be used by the signer to communicate a key identifier to the recipient. Typically, the KeyName element 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 the KeyName include simple string names for keys, a key index, a distinguished name (DN), an email address, etc. | ||||||||||||||||||||||
PrependCustomXML:
The custom XML content that prepended before signature. Use this property to specify the custom XML content that should be prepended before ds:Signature element. TBD | ||||||||||||||||||||||
SecurityHeaderIndex:
Specifies the SecurityHeader index. Use this property to specify the index of SecurityHeader element where to put the signature. If the specified SecurityHeader element doesn't exist then a new SecurityHeader element will be created. The default value is "-1", in this case a new SecurityHeader element will be always created. | ||||||||||||||||||||||
SecurityTokenReferenceID:
Specifies the ID for SecurityTokenReference element. This property contains the identifier (ID) attribute of the wsse:SecurityTokenReference element. | ||||||||||||||||||||||
SignatureID:
Specifies the ID for Signature element. This property contains the identifier (ID) attribute of the ds:Signature element. | ||||||||||||||||||||||
SignaturePrefix:
Specifies the signature prefix. Specifies the prefix for the Signature elements. Default value is "ds". In this case "ds:" prefix will be used. Special values:
| ||||||||||||||||||||||
SignatureValueID:
Specifies the ID for SignatureValue element. This property contains the identifier (ID) attribute of the ds:SignatureValue element. | ||||||||||||||||||||||
SignedInfoID:
Specifies the ID for SignedInfo element. This property contains the identifier (ID) attribute of the ds:SignedInfo element. | ||||||||||||||||||||||
TempPath:
Location where the temporary files are stored. This setting specifies an absolute path to the location on disk where temporary files are stored. | ||||||||||||||||||||||
UseHMACSigning:
Whether to use HMAC signing. TBD | ||||||||||||||||||||||
UsePSS:
Whether to use RSASSA-PSS algorithm. 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. | ||||||||||||||||||||||
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. | ||||||||||||||||||||||
XMLFormatting:
Specifies the signature XML formatting. Use this property to specify how the signature should be formatted. Supported values:
Custom values, contains a list of value pairs ("name:value") separated by comma or semicolon:
For more preciese formatting use OnFormatText and OnFormatElement events. |
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 component. Supported values are:
| |||||||||||||||||||||||||||||||
Cookies:
Gets or sets local cookies for the component (supported for HTTPClient, RESTClient and SOAPClient only). Use this property to get cookies from the internal cookie storage of the component 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 components 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 components. | |||||||||||||||||||||||||||||||
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. | |||||||||||||||||||||||||||||||
UseOwnDNSResolver:
Specifies whether the client components should use own DNS resolver. Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one. | |||||||||||||||||||||||||||||||
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. |