If this property is set to True, the all data objects timestamp (xades:AllDataObjectsTimeStamp element) will be added.

Use this property to get/specify the XML content of the claimed roles element.

Use this property to get/specify the text of the first claimed role.

This property contains if the CommitmentTypeIndication's AllSignedDataObjects element is present that indicates that all the signed data objects share the same commitment. Index value could be omitted for the first CommitmentTypeIndication element.

Returns the number of the xades:CommitmentTypeIndication elements available.

This property contains an identifier indicating the type of commitment made by the signer in the CommitmentTypeIndication's CommitmentTypeId's Identifier element. Index value could be omitted for the first CommitmentTypeIndication element.

This property contains an identifier's description indicating the type of commitment made by the signer in the CommitmentTypeIndication's CommitmentTypeId's Description element. Index value could be omitted for the first CommitmentTypeIndication element.

This property contains an identifier's documentation references indicating the type of commitment made by the signer in the CommitmentTypeIndication's CommitmentTypeId's DocumentationReferences element. Index value could be omitted for the first CommitmentTypeIndication element.

This property contains an identifier qualifier indicating the type of commitment made by the signer in the CommitmentTypeIndication's CommitmentTypeId's IdentifierQualifier element. Index value could be omitted for the first CommitmentTypeIndication element.

This property contains the CommitmentTypeIndication's ObjectReference elements that refer to one or several ds:Reference elements of the ds:SignedInfo corresponding with one data object qualified by this property. Index value could be omitted for the first CommitmentTypeIndication element.

This property contains the CommitmentTypeIndication's Qualifiers elements XML content. Index value could be omitted for the first CommitmentTypeIndication element.

Returns the number of the xades:DataObjectFormat elements available.

This property contains textual information related to the signed data object in the DataObjectFormat's Description element. Index value could be omitted for the first DataObjectFormat element.

This property contains an indication of the encoding format of the signed data object in the DataObjectFormat's Encoding element. Index value could be omitted for the first DataObjectFormat element.

This property contains an indication of the MIME type of the signed data object in the DataObjectFormat's MimeType element. Index value could be omitted for the first DataObjectFormat element.

This property contains an identifier indicating the type of the signed data object in the DataObjectFormat's ObjectIdentifier's Identifier element. Index value could be omitted for the first DataObjectFormat element.

This property contains an identifier's description indicating the type of the signed data object in the DataObjectFormat's ObjectIdentifier's Description element. Index value could be omitted for the first DataObjectFormat element.

This property contains an identifier's documentation references indicating the type of the signed data object in the DataObjectFormat's ObjectIdentifier's DocumentationReferences element. Index value could be omitted for the first DataObjectFormat element.

This property contains an identifier qualifier indicating the type of the signed data object in the DataObjectFormat's ObjectIdentifier's IdentifierQualifier element. Index value could be omitted for the first DataObjectFormat element.

This property contains the DataObjectFormat's ObjectReference element that reference the ds:Reference element of the ds:Signature corresponding with the data object qualified by this property.

For example, if the corresponding ds:Reference element has an Id "reference-id-1", then you should set this property to "#reference-id-1" value.

Index value could be omitted for the first DataObjectFormat element.

Specifies the prefix for the ec:InclusiveNamespaces element for the exclusive canonicalization.

Default value is "ec". In this case "ec:" prefix will be used.

Special values:

Specifies the signature expiration time in UTC. Used for Binary Crypto API signature.

Use this property to set the HMAC key. The component uses base16 (hex) encoding for this configuration value.

Use this property to configure the length of the HMAC output, in bytes.

Set this property to true to make the component perform signing using HMAC method, rather than asymmetric cryptography. TBD

If this property is set to True, any failure during time-stamping process will be ignored.

This property specifies whether revocation pieces provided via KnownCertificates, KnownCRLs, and KnownOCSPs properties should be included into the signature. This property lets you include custom validation elements to the signature in addition to the ones comprising the signing chain.

Use this property to read/specify InclusiveNamespaces PrefixList for exclusive canonicalization transform of SignedInfo element. See XML-Signature Syntax and Processing specification for details.

This property contains the identifier (ID) attribute of the ds:KeyInfo element.

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.

This property specifies the Description of the signature policy.

Use this property to specify the explicit text of the user notice to be displayed when the signature is verified.

Defines the "noticeNumbers" part of the NoticeReference signature policy qualifier for CAdES-EPES.

Defines the "organization" part of the NoticeReference signature policy qualifier for CAdES-EPES.

The signature production place in JSON format that was included or to be included into the signature.

Sample value: '{"addressCountry": "UK", "addressLocality": "London", "postalCode": "N1 7GU", "streetAddress": "20-22 Wenlock Road"}'

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. This is an alias for UsePSS.

This property contains the identifier (ID) attribute of the xades:QualifyingProperties element.

This property contains the identifier (ID) attribute of the ds:Object element that contains xades:QualifyingProperties element.

Returns the number of the xades:QualifyingPropertiesReference elements available.

This property contains an identifier (ID) attribute of the xades:QualifyingPropertiesReference element. Index value could be omitted for the first QualifyingPropertiesReference element.

This property contains an URI attribute of the xades:QualifyingPropertiesReference element. Index value could be omitted for the first QualifyingPropertiesReference element.

Contains a comma-separated list of values that specifies which references timestamp type to include to the signature when signature upgraded to XAdES-X or XAdES-E-X form.

Supported values are:

This property contains the identifier (ID) attribute of the ds:Signature element.

Use this property to specify the location at which the signature was created.

Use this property to specify the location at which the signature was created.

Comments to the signature info text.

Use this property to specify the name of a person to whom the signature has been delegated.

Use this property to specify the title of a person to whom the signature has been delegated.

Use this property to specify the e-mail address of a person to whom the signature has been delegated.

Use his property to set an image for the digital signature.

Specifies whether to include the signature info.

Sample code that demonstrates adding signature information for OpenXML documents: signer.NewSignature.Level = aslEPES; signer.Config("SignatureInfoIncluded=true"); signer.Config("SignatureInfoText=Text"); signer.Config("SignatureInfoComments=Comment"); signer.Config("ClaimedRoleText=Role"); signer.Config("CommitmentTypeIndicationCount=1"); signer.Config("CommitmentTypeIndicationAllSignedDataObjects=true"); signer.Config("CommitmentTypeIndicationIdentifier=http://uri.etsi.org/01903/v1.2.2#ProofOfApproval"); signer.Config("CommitmentTypeIndicationIdentifierDescription=Approved this document"); signer.Config("ProductionPlace=CITY=Test City, ST=Test State, POSTALCODE=Test Code, C=Test Country"); signer.Config("SignatureInfoAddress1=Address1"); signer.Config("SignatureInfoAddress2=Address2");

Use this property to set the image of an invalid signature, if the digital signature must be printed.

Use this property to specify the type of the digital signature.

When the type is 2, both SignatureInfoValidLnImage and SignatureInfoInvalidLnImage images should be specified.

The text to be displayed as the signature info.

Use this property to set the image of a valid signature, if the digital signature must be printed.

This property contains additional signature information.

This property contains the True value if comments are allowed.

Returns the number of the signature lines available for Office Open XML (OOXML) documents.

This property contains signature unique ID.

This property contains signature image.

Use this property to specify the signature line that should be signed. If the default value of -1 is assigned to this property, no signature line will be signed.

This property contains the True value if the signature line should include the signing date.

This property contains the index of the signature that signs this signature line.

This property contains a unique ID identifying which signature provider created the signature line.

This property contains a signature provider download URL.

This property contains the True value if signature line is signed.

This property contains the instructions, shown to the user at signing time.

This property contains the second line of information of who should sign the signature line.

This property contains the first line of information of who should sign the signature line.

This property contains the email address of who should sign the signature line.

Use this property to get or set the signature origin part URI record.

Use this property to specify the custom name of the signature part for Open XML documents.

Specifies the prefix for the Signature elements.

Default value is "ds". In this case "ds:" prefix will be used.

Special values:

This property contains the identifier (ID) attribute of the ds:SignatureValue element.

This property contains the identifier (ID) attribute of the ds:SignedInfo element.

This property contains the identifier (ID) attribute of the xades:SignedProperties element.

Use this property to specify the canonicalization method for the canonicalization transform of the ds:Reference element that points to xades:SignedProperties element. Use cxcmNone value to not to include canonicalization transform in transform chain.

Use this property to specify the hash algorithm to be used for the ds:Reference element that points to xades:SignedProperties element.

Supported values:

The default value is empty string, in this case, the hash algorithm specified in hash_algorithm property is used.

This property contains the identifier (ID) attribute of the ds:Reference element that points to xades:SignedProperties element.

Use this property to specify InclusiveNamespaces PrefixList for exclusive canonicalization transform of the ds:Reference element that points to xades:SignedProperties element.

Use this property to specify the reference's index for the ds:Reference element that points to xades:SignedProperties element.

This property contains the identifier (ID) attribute of the xades:SignedSignatureProperties element.

Use this property to check or set the indices of the signing chain included in the signature. The none and all placeholders are supported.

Use this property to specify the hash algorithm to be used for xades:SigningCertificates element.

Supported values:

The default value is empty string, in this case, the hash algorithm specified in hash_algorithm property is used.

Specifies the signing time in UTC. Used for Binary Crypto API signature.

This property specifies the Description of the signature policy (an alias for PolicyDescription).

Use this property to specify the explicit text of the user notice to be displayed when the signature is verified (an alias for PolicyExplicitText);

Use this configuration setting to provide the EPES policy hash.

Use this setting to provide the hash algorithm that was used to generate the policy hash.

The EPES signature policy identifier, in dotted OID format (1.2.3.4.5).

Defines the "noticeNumbers" part of the NoticeReference signature policy qualifier for CAdES-EPES (an alias for PolicyUNNumbers).

Defines the "organization" part of the NoticeReference signature policy qualifier for CAdES-EPES (an alias for PolicyUNOrganization).

Assign the EPES policy URI to this setting.

Use this property to specify the canonicalization method used in timestamp.

Contains a comma-separated list of values that specifies which validation data values details to include to the signature when xades:TimeStampValidationData element added.

Supported values are:

Set this property to true to make the component perform signing using HMAC method, rather than asymmetric cryptography.

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.

Contains a comma-separated list of values that specifies which validation data references details to include to the signature when signature upgraded to XAdES-C or XAdES-E-C form.

Supported values are:

Use this property to specify the hash algorithm used to compute hashes for validation data references.

Supported values:

The default value is empty string, in this case, the hash algorithm specified in hash_algorithm property is used.

Contains a comma-separated list of values that specifies which validation data values details to include to the signature when signature upgraded to XAdES-X-L or XAdES-E-X-L form.

Supported values are:

Specifies the prefix for the XAdES elements.

Default value is "xades". In this case "xades:" prefix will be used.

Special values:

Specifies the prefix for the XAdES v1.4.1 elements.

Default value is "xadesv141". In this case "xadesv141:" prefix will be used.

Special values:

This is a performance setting. It is unlikely that you will ever need to adjust it.

This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it.

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.

Set this property to enable or disable cookies caching for the class.

Supported values are:

Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.

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.

Use this global setting to adjust the default suffix to assign to top-level domain names. The default is .local.

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.

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 classes that have its CookieCaching property set to "global".

This global setting controls the hardware cryptography usage policy: auto, enable, or disable.

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 classes.

Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use.

It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account.

Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence.

Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:

Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:

Use this property to provide a path to the log file.

Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:

Use this property to set the log flush mode. The following values are defined:

Use this property to provide the desired debug log level.

Supported values are:

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.

Use this property to set the log rotation mode. The following values are defined:

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.

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.

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.

Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak.

The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached.

Supported Values:

Example (default value): PKICache=certificate,crl,ocsp In this example, the component caches certificates, CRLs, and OCSP responses.

The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts.

The default value is an empty string - no cached PKI data is stored on disk.

Example: PKICachePath=C:\Temp\cache In this example, the cached PKI data is stored in the C:\Temp\cache directory.

This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision).

Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server.

Set this property to enable or disable static DNS rules for the class. Works only if UseOwnDNSResolver is set to true.

Supported values are:

Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the StaticDNS value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are devided by the | (pipe) character.

Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If StaticDNS of the class is set to "local", the property returns/restores the rules from/to the internal storage of the class. If StaticDNS of the class is set to "global", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format.

Use this config property to store any custom data.

Use this property to limit the search of chached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes.

Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes).

Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).

This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used.

Allows to switch between internal/native PRNG implementation and the one provided by the platform.

Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details).

This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used.

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.

Set this global property to false to make each validation run use its own copy of system certificate stores.

This is an internal setting. Please do not use it unless instructed by the support team.

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.

Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures.

The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing.

Syntax: Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");

Where:

OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map.

PrimaryName: The main descriptor name used in the XML signature when the OID is encountered.

Alias1, Alias2, ...: Optional alternative names recognized during parsing.

Usage Examples:

Map OID 2.5.4.5 to SERIALNUMBER: Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");

Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");

This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing.

Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1).

Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value.