SecureBlackbox 2020 macOS Edition

Questions / Feedback?

ASiCVerifier Configuration

The class 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 class, access to these internal properties is provided through the Config method.

ASiCVerifier Configuration Settings

CustomTSLs:   Specifies the custom TSLs.

Use this property to specify the custom TSLs (Trust Service status Lists) to the validator. The URLs list is comma-separated.

ExtractToMemory:   Tells the component to extract the current entry to memory.

Set this property to true to extract the entry being currently processed to memory and make it available in OutputBytes property. This property is reset before every subsequent entry is processed. Use FileExtractionStart event handler to re-enable it.

ForceCompleteChainValidation:   Whether to check the CA certificates when the signing certificate is invalid.

Set this property to True to check issuer (CA) certificates when the signing certificate is invalid.

ForceCompleteChainValidationForTrusted:   Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors.

Set this property to True to enable full chain validation for explicitly trusted intermediary or end-entity certificates. This may be useful when creating signatures to enforce completeness of the collected revocation information. It often makes sense to set this property to false when validating signatures to reduce validation time and avoid issues with badly configured environments.

GracePeriod:   Specifies a grace period to apply during revocation information checks.

Use this property to specify a grace period (in seconds). Grace period applies to certain subprotocols, such as OCSP, and caters to the inaccuracy and/or missynchronization of clocks on different participating systems. Any time deviations within the grace period will be tolerated.

IgnoreChainValidationErrors:   Enable this property to ignore any chain validation issues.

Set this property to True to make the component ignore any chain validation issues. This is not recommended unless you know what you are doing.

IgnoreOCSPNoCheckExtension:   Whether OCSP NoCheck extension should be ignored.

Set this property to false to make the validation engine ignore the OCSP no-check extension. You would normally need to set this property when validating severely non-compliant chains that misuse the extension, causing chain loops or other validation issues.

IgnoreSystemTrust:   Whether trusted Windows Certificate Stores should be treated as trusted.

Specifies whether, during chain validation, the component should respect the trust to CA certificates as configured in the operating system. In Windows this effectively defines whether the component should trust the certificates residing in the Trusted Root Certification Authorities store.

If IgnoreSystemTrust is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as TrustedCertificates property) are considered trusted.

ImplicitlyTrustSelfSignedCertificates:   Whether to trust self-signed certificates.

Set this property to True to implicitly trust all self-signed certificates. Use it with care as trusting just about every self-signed certificate is unwise. One exceptional reason where this property may be handy is where a chain is validated in an environment that is not supposed to trust it (for example, a signing, rather than verifying environment, or a QA server). Trusting all self-signing certificates (which are normally trusted) allows to emulate the verifying environment without actually changing its security settings.

PolicyExplicitText:   The explicit text of the user notice.

This property specifies the explicit text of the user notice which is displayed when the signature is verified.

PolicyUNNumbers:   The noticeNumbers part of the NoticeReference CAdES attribute.

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

PolicyUNOrganization:   The organization part of the NoticeReference qualifier.

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

ProductionPlace:   The production place XAdES attribute.

Check this property to access the ProductionPlace XAdES attribute.

PromoteLongOCSPResponses:   Whether long OCSP responses are requested.

Set this property to True to force the class to publish 'long' form of OCSP responses. Otherwise, only BasicOCSPResponse blobs are promoted.

QualifiedStatus:   Indicates a qualified electronic signature.

Use this property to check if an electronic signature is created using a qualified device for creating electronic signatures and that relies on a qualified electronic signature certificate. This property return TSP service status URI.

TempPath:   Path for storing temporary files.

This setting specifies an absolute path to the location on disk where temporary files are stored.

TLSChainValidationDetails:   Contains the advanced details of the TLS server certificate validation.

Check this property in TLSCertValidate event handler to access the TLS certificate validation details.

TLSChainValidationResult:   Contains the result of the TLS server certificate validation.

Check this property in TLSCertValidate event handler to obtain the TLS certificate validation result.

TLSClientAuthRequested:   Indicates whether the TLS server requests client authentication.

Check this property in TLSCertValidate event handler to find out whether the TLS server requests the client to provide the authentication certificate. If this property is set to true, provide your certificate via TLSClientChain property. Note that the component may fire this event more than once during each operation, as more than one TLS-enabled server may need to be contacted.

TLSValidationLog:   Contains the log of the TLS server certificate validation.

Check this property in TLSCertValidate event handler to retrieve the validation log of the TLS server.

TolerateMinorChainIssues:   Whether to tolerate minor chain issues.

TBD

TSLDistributionPoints:   Contains XML content of distribution points of the TSL used.

Use this property to get XML content of distribution points of the TSL used to obtain the qualified status of the certificate.

TSLDistributionPoints[Idx]:   Contains distribution point of the specified index of the TSL used.

Use this property to get distribution point of the specified index of the TSL used to obtain the qualified status of the certificate.

TSLHistoricalInformationPeriod:   Contains historical information period of the TSL used.

Use this property to get historical information period of the TSL used to obtain the qualified status of the certificate.

TSLLegalNotices:   Contains XML content of legal notices of the TSL used.

Use this property to get XML content of multilingual legal notices of the TSL used to obtain the qualified status of the certificate.

TSLLegalNotices[lang]:   Contains legal notices for the specified language of the TSL used.

Use this property to get legal notices for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate.

TSLListIssueDateTime:   Contains list issue date and time of the TSL used.

Use this property to get list issue date and time of the TSL used to obtain the qualified status of the certificate.

TSLNextUpdate:   Contains next update date and time of the TSL used.

Use this property to get next update date and time of the TSL used to obtain the qualified status of the certificate.

TSLPolicies:   Contains XML content of policies of the TSL used.

Use this property to get XML content of multilingual policies of the TSL used to obtain the qualified status of the certificate.

TSLPolicies[lang]:   Contains policies for the specified language of the TSL used.

Use this property to get policies for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate.

TSLSchemeExtensions:   Contains XML content of scheme extensions of the TSL used.

Use this property to get XML content of scheme extensions of the TSL used to obtain the qualified status of the certificate.

TSLSchemeExtensions[Idx]:   Contains XML content of scheme extension of the specified index of the TSL used.

Use this property to get XML content of scheme extension of the specified index of the TSL used to obtain the qualified status of the certificate.

TSLSchemeInformationURI:   Contains XML content of scheme information URI of the TSL used.

Use this property to get XML content of multilingual scheme information URI of the TSL used to obtain the qualified status of the certificate.

TSLSchemeInformationURI[lang]:   Contains scheme information URI for the specified language of the TSL used.

Use this property to get scheme information URI for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate.

TSLSchemeName:   Contains XML content of scheme name of the TSL used.

Use this property to get XML content of multilingual scheme name of the TSL used to obtain the qualified status of the certificate.

TSLSchemeName[lang]:   Contains scheme name for the specified language of the TSL used.

Use this property to get scheme name for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate.

TSLSchemeOperatorAddress:   Contains XML content of scheme operator address of the TSL used.

Use this property to get XML content of scheme operator address of the TSL used to obtain the qualified status of the certificate.

TSLSchemeOperatorName:   Contains XML content of scheme operator name of the TSL used.

Use this property to get XML content of multilingual scheme operator name of the TSL used to obtain the qualified status of the certificate.

TSLSchemeOperatorName[lang]:   Contains scheme operator name for the specified language of the TSL used.

Use this property to get scheme operator name for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate.

TSLSchemeTerritory:   Contains scheme territory of the TSL used.

Use this property to get scheme territory of the TSL used to obtain the qualified status of the certificate.

TSLSchemeTypeCommunityRules:   Contains XML content of scheme type/community/rules of the TSL used.

Use this property to get XML content of multilingual scheme type/community/rules of the TSL used to obtain the qualified status of the certificate.

TSLSchemeTypeCommunityRules[lang]:   Contains scheme type/community/rules for the specified language of the TSL used.

Use this property to get scheme type/community/rules for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate.

TSLSequenceNumber:   Contains sequence number of the TSL used.

Use this property to get sequence number of the TSL used to obtain the qualified status of the certificate.

TSLsRetrieveLog:   Contains the complete log of the TSLs retrieve.

Use this property to access the TSLs retrieve log produced by the class. The log can be very useful when investigating issues with TSL retrieve.

TSLStatusDeterminationApproach:   Contains status determination approach of the TSL used.

Use this property to get status determination approach of the TSL used to obtain the qualified status of the certificate.

TSLsValidationLog:   Contains the complete log of the TSLs validation.

Use this property to access the TSLs validation log produced by the class. The log can be very useful when investigating issues with TSL validation.

TSLTSPAdditionalServiceInformation:   Contains addtional service information of the TSP service used.

Use this property to get the list of addtional service information of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. The URIs list is comma-separated.

TSLTSPAddress:   Contains XML content of the address of the TSP used.

Use this property to get XML content of the address of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSLTSPHistoryInstance:   Indicates that TSP service history instance used.

Indicates whether or not the qualified status was obtained from the TSP (Trust Service Provider) service history instance.

TSLTSPHistoryInstanceAdditionalServiceInformation:   Contains addtional service information of the TSP service history instance used.

Use this property to get the list of addtional service information of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. The URIs list is comma-separated.

TSLTSPHistoryInstanceQualifiers:   Contains list of qualifiers of the TSP service history instance used.

Use this property to get the list of qualifiers of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. The URIs list is comma-separated.

TSLTSPHistoryInstanceServiceInformationExtensions:   Contains XML content of information extensions of the TSP service history instance used.

Use this property to get XML content of information extensions of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPHistoryInstanceServiceInformationExtensions[Idx]:   Contains XML content of information extension of the specified index of the TSP service history instance used.

Use this property to get XML content of information extension of the specified index of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPHistoryInstanceServiceName:   Contains XML content of name of the TSP service history instance used.

Use this property to get XML content of multilingual name of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPHistoryInstanceServiceName[lang]:   Contains name for the specified language of the TSP service history instance used.

Use this property to get the name for the specified language code (e.g. 'en') of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPHistoryInstanceServiceStatus:   Contains status of the TSP service history instance used.

Use this property to get the status of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPHistoryInstanceServiceStatusStartingTime:   Contains status starting time of the TSP service history instance used.

Use this property to get the status starting time of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPHistoryInstanceServiceTypeIdentifier:   Contains type identifier of the TSP service history instance used.

Use this property to get type identifier of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPHistoryInstanceXML:   Contains XML content of the TSP service history instance used.

Use this property to get XML content of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPInformationExtensions:   Contains XML content of information extensions of the TSP used.

Use this property to get XML content of information extensions of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSLTSPInformationExtensions[Idx]:   Contains XML content of information extension of the specified index of the TSP used.

Use this property to get XML content of information extension of the specified index of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSLTSPInformationURI:   Contains XML content of information URI of the TSP used.

Use this property to get XML content of multilingual information URI of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSLTSPInformationURI[lang]:   Contains information URI for the specified language of the TSP used.

Use this property to get the information URI for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSLTSPName:   Contains XML content of name of the TSP used.

Use this property to get XML content of multilingual name of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSLTSPName[lang]:   Contains name for the specified language of the TSP used.

Use this property to get the name for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSLTSPSchemeServiceDefinitionURI:   Contains XML content of scheme service definition URI of the TSP service used.

Use this property to get XML content of multilingual scheme service definition URI of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPSchemeServiceDefinitionURI[lang]:   Contains scheme service definition URI for the specified language of the TSP service used.

Use this property to get the scheme service definition URI for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceDefinitionURI:   Contains XML content of definition URI of the TSP service used.

Use this property to get XML content of multilingual definition URI of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceDefinitionURI[lang]:   Contains definition URI for the specified language of the TSP service used.

Use this property to get the definition URI for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceInformationExtensions:   Contains XML content of information extensions of the TSP service used.

Use this property to get XML content of information extensions of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceInformationExtensions[Idx]:   Contains XML content of information extension of the specified index of the TSP service used.

Use this property to get XML content of information extension of the specified index of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceName:   Contains XML content of name of the TSP service used.

Use this property to get XML content of multilingual name of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceName[lang]:   Contains name for the specified language of the TSP service used.

Use this property to get the name for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceQualifiers:   Contains list of qualifiers of the TSP service used.

Use this property to get the list of qualifiers of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. The URIs list is comma-separated.

TSLTSPServiceStatus:   Contains status of the TSP service used.

Use this property to get the status of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceStatusStartingTime:   Contains status starting time of the TSP service used.

Use this property to get the status starting time of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceSupplyPoints:   Contains XML content of the supply points of the TSP service used.

Use this property to get XML content of the supply points of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceTypeIdentifier:   Contains type identifier of the TSP service used.

Use this property to get type identifier of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceXML:   Contains XML content of the TSP service used.

Use this property to get XML content of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPTradeName:   Contains XML content of trade name of the TSP used.

Use this property to get XML content of multilingual trade name of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSLTSPTradeName[lang]:   Contains trade name for the specified language of the TSP used.

Use this property to get the trade name for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSLTSPXML:   Contains XML content of the TSP used.

Use this property to get XML content of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSLType:   Contains TSL type of the TSL used.

Use this property to get TSL type of the TSL used to obtain the qualified status of the certificate.

TSLVersionIdentifier:   Contains version identifier of the TSL used.

Use this property to get version identifier of the TSL used to obtain the qualified status of the certificate.

TSLXML:   Contains XML content of the TSL used.

Use this property to get XML content of the TSL used to obtain the qualified status of the certificate.

UseDefaultTSLs:   Enables or disables the use of the default TSLs.

Use this property to tell the validator to use (or not to use) the default TSLs (Trust Service status Lists). The result of this check reported in Qualified property.

The following default TSLs are used: EU (European Union) LOTL (list of trusted lists).

UseMicrosoftCTL:   Enables or disables automatic use of Microsoft online certificate trust list.

Enable this property to make the chain validation module automatically look up missing CA certificates in the public Windows Update repository.

UseSystemCertificates:   Enables or disables the use of the system certificates.

Use this property to tell chain validation module automatically look up missing CA certificates in the system certificates. In many cases it is beneficial to switch this property on, as the operating system certificate configuration provides a representative trust framework.

UseUTF8Filenames:   Specifies whether to use UTF-8 filenames.

Set this property to False to use system encoding for filenames inside container.

UseValidationCache:   Enables or disable the use of the product-wide certificate chain validation cache.

Use this property to enable or disable the use of the global chain validation cache. If enabled, the component will consult the product-wide validation cache when validating the signing chains. Also, the outcomes of any new chain validations performed by the component, both interim and final, will be saved in the cache and available for re-use by any future validations. Disable this property to ignore the cache and always perform the validation from the fresh start.

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

Supported values are:

offNo caching (default)
localLocal caching (supported for HTTPClient, RESTClient and SOAPClient only)
globalGlobal caching

Cookies:   Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).

Use this property to get cookies from the internal cookie storage of the class 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 classes 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 classes.

LogDestination:   Specifies the debug log destination.

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

Supported values are:

fileFile
consoleConsole
systemlogSystem Log (supported for Android only)
debuggerDebugger (supported for VCL for Windows and .Net)

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:

timeCurrent time
levelLevel
packagePackage name
moduleModule name
classClass name
methodMethod name
threadidThread Id
contenttypeContent type
contentContent
allAll details

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:

exclude-packageExclude a package specified in the value
exclude-moduleExclude a module specified in the value
exclude-classExclude a class specified in the value
exclude-methodExclude a method specified in the value
include-packageInclude a package specified in the value
include-moduleInclude a module specified in the value
include-classInclude a class specified in the value
include-methodInclude a method specified in the value

LogFlushMode:   Specifies the log flush mode.

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

noneNo flush (caching only)
immediateImmediate flush (real-time logging)
maxcountFlush cached entries upon reaching LogMaxEventCount entries in the cache.

LogLevel:   Specifies the debug log level.

Use this property to provide the desired debug log level.

Supported values are:

noneNone (by default)
fatalSevere errors that cause premature termination.
errorOther runtime errors or unexpected conditions.
warningUse of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
infoInteresting runtime events (startup/shutdown).
debugDetailed information on flow of through the system.
traceMore detailed information.

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:

noneNo rotation
deleteolderDelete older entries from the cache upon reaching LogMaxEventCount
keepolderKeep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded)

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.

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2020 macOS Edition - Version 20.0 [Build 8165]