# OAuthClient Class The OAuthClient class implements interaction between the client, the resource owner (end-user), and the authorization server via OAuth 2.0 protocol. ## Syntax ```text class secureblackbox.OAuthClient ``` ## Remarks OAuth 2.0 is a popular protocol for implementing a trusted third party-based user authentication. It is used in many modern environments, including Microsoft (Entra ID), Google, and Amazon ecosystems. OAuth relies on browser-based experience for performing the initial, hands-on, service-dependent authentication (for example, by providing Microsoft credentials in a login form), which produces an authorization token. Client applications, such as email clients, then can use the authorization token to authenticate directly to the services (such as SMTP or IMAP). OAuthClient implements interaction between the client (an application that needs access to a protected resource), the resource owner (end-user), and the authorization server via OAuth 2.0 ([RFC 6749](https://tools.ietf.org/html/rfc6749)) protocol. Unlike direct authentication types (login/password or certificate-base), which happen between the client and the server, OAuth2 authentication involves three participants (the client, the service, and the authorization service), and consists of two separate flows: - The client connects to the central authentication server, completes a browser-based authentication, and receives an authentication token, - The client uses the authentication token to authenticate to the desired service (e.g. SMTP). The client can use the authentication token multiple times, but when it expires, they need to refresh it or re-authenticate to the central server and get a new token. While providers may impose different requirements on their OAuth2 configuration, a typical registration and authentication flow consists of the following steps: **Registration** This is done manually by signing in to the service provider's authentication/authorization service and registering your 'application' (effectively, an equivalent of the user account in traditional systems) there. This may take different forms (see an example of registering a Microsoft Entra ID application below), but one way or another this process should yield the following deliverables: - Client ID and Client Secret: your application's credentials on the authentication service. - Auth URL: the URL that triggers the browser-based authorization workflow and returns the access token. - Token URL: the URL that returns an access token in response to the refresh token. - Redirect URL: a local URL that the authorization service redirects the browser to upon completion of the authorization routine. Services increasingly want this to be an HTTPS (not an HTTP) endpoint. - Scope: a string that describes the set of services that the token holder can access. The exact value expected here is service-dependent. **Initial authorization** This step is performed once in a while. The goal is to exchange the permanent credentials obtained on the preceding step (Client ID and Client Secret) to an ephemeral, short-lived access token. This exchange requires the user to be present and follow the authentication flow conducted by the authentication/authorization service in their browser. The outcome of the authentication process is the access token and/or refresh token. These are the ultimate authentication credentials that can later be used by the client applications (e.g. a mail client). Access tokens expire after certain period of time. Your application must keep an eye on the token's expiration time (using [expires_in](#expires_in-property) and [expires_at](#expires_at-property) properties), and make sure to get a new access token by *refreshing* it, or re-authenticating from scratch using the [authorize](#authorize-method) call. The code snippet below illustrates the use of OAuthClient for retrieving an access token. ```text // Use the credentials and URLs from the service's control panel oauth.AuthURL = "https://login.microsoftonline.com/778...39d6a4cf/oauth2/v2.0/authorize"; oauth.TokenURL = "https://login.microsoftonline.com/778...39d6a4cf/oauth2/v2.0/token"; oauth.ClientID = "20df...c9f2"; oauth.ClientSecret = "mH8Q..."; // Optionally set the scope as instructed by the service oauth.Scope = "https://outlook.office.com/SMTP.Send offline_access"; // This must match the redirect URL set up in the control panel oauth.RedirectURL = "https://localhost:17800"; // For HTTPS endpoints, a TLS certificate/chain needs to be set up. // This example uses a one-time certificate, but you may consider handling this more // carefully in real-world applications to avoid browser trust warnings. // CertificateManager mgr = new CertificateManager(); mgr.CreateNew(ctX509Certificate, "tls", "127.0.0.1"); mgr.Generate(2048); oauth.RedirectURLChain.Add(mgr.Certificate); // Making the authorization call. // This will launch the browser and navigate to the service's authorization page. // Upon successful authorization the tokens can be retrieved // from AccessToken and RefreshToken properties. oauth.Authorize(); Console.WriteLine("Access token: " + oauth.AccessToken); // Save these! Console.WriteLine("Refresh token: " + oauth.RefreshToken); ``` **Protocol-level authentication with access token** Now that you have the access token, you can use it in your application-level components to authenticate to the service. The respective code for [SMTPClient](SMTPClient.md#SMTPClient) authentication looks like this: ```text smtp.Username = "user@domain.com"; smtp.AccessToken = "your access token here"; smtp.TLSSettings.TLSMode = smExplicitTLS; smtp.Connect("smtp.office365.com", 587); ``` Please remember to keep track of the token validity time and refresh it when it approaches its expiration moment. That sums it up. Please see the [Setting up Microsoft Entra ID](pages.md#pg_msentraid) article to learn more about setting up the Entra ID variant of OAuth 2. ## Property List *The following is the full list of the properties of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [access_token](#access_token-property) | Contains the access token. | | [auth_url](#auth_url-property) | Specifies the URL of the authorization server. | | [auto_refresh](#auto_refresh-property) | Specifies whether access token should be automatically refreshed. | | [blocked_cert_count](#blocked_cert_count-property) | The number of records in the BlockedCert arrays. | | [blocked_cert_bytes](#blocked_cert_bytes-property) | Returns the raw certificate data in DER format. | | [blocked_cert_handle](#blocked_cert_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [client_id](#client_id-property) | Client ID of the application which needs access to the protected resource. | | [client_secret](#client_secret-property) | Client secret of the application which needs access to the protected resource. | | [conn_info_aead_cipher](#conn_info_aead_cipher-property) | Indicates whether the encryption algorithm used is an AEAD cipher. | | [conn_info_chain_validation_details](#conn_info_chain_validation_details-property) | The details of a certificate chain validation outcome. | | [conn_info_chain_validation_result](#conn_info_chain_validation_result-property) | The outcome of a certificate chain validation routine. | | [conn_info_ciphersuite](#conn_info_ciphersuite-property) | The cipher suite employed by this connection. | | [conn_info_client_authenticated](#conn_info_client_authenticated-property) | Specifies whether client authentication was performed during this connection. | | [conn_info_client_auth_requested](#conn_info_client_auth_requested-property) | Specifies whether client authentication was requested during this connection. | | [conn_info_connection_established](#conn_info_connection_established-property) | Indicates whether the connection has been established fully. | | [conn_info_connection_id](#conn_info_connection_id-property) | The unique identifier assigned to this connection. | | [conn_info_digest_algorithm](#conn_info_digest_algorithm-property) | The digest algorithm used in a TLS-enabled connection. | | [conn_info_encryption_algorithm](#conn_info_encryption_algorithm-property) | The symmetric encryption algorithm used in a TLS-enabled connection. | | [conn_info_exportable](#conn_info_exportable-property) | Indicates whether a TLS connection uses a reduced-strength exportable cipher. | | [conn_info_group](#conn_info_group-property) | The elliptic curve used in this connection. | | [conn_info_id](#conn_info_id-property) | The client connection's unique identifier. | | [conn_info_key_exchange_algorithm](#conn_info_key_exchange_algorithm-property) | The key exchange algorithm used in a TLS-enabled connection. | | [conn_info_key_exchange_key_bits](#conn_info_key_exchange_key_bits-property) | The length of the key exchange key of a TLS-enabled connection. | | [conn_info_pfs_cipher](#conn_info_pfs_cipher-property) | Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). | | [conn_info_pre_shared_identity](#conn_info_pre_shared_identity-property) | Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. | | [conn_info_pre_shared_identity_hint](#conn_info_pre_shared_identity_hint-property) | A hint professed by the server to help the client select the PSK identity to use. | | [conn_info_public_key_bits](#conn_info_public_key_bits-property) | The length of the public key. | | [conn_info_remote_address](#conn_info_remote_address-property) | The client's IP address. | | [conn_info_remote_port](#conn_info_remote_port-property) | The remote port of the client connection. | | [conn_info_resumed_session](#conn_info_resumed_session-property) | Indicates whether a TLS-enabled connection was spawned from another TLS connection. | | [conn_info_secure_connection](#conn_info_secure_connection-property) | Indicates whether TLS or SSL is enabled for this connection. | | [conn_info_server_authenticated](#conn_info_server_authenticated-property) | Indicates whether server authentication was performed during a TLS-enabled connection. | | [conn_info_signature_algorithm](#conn_info_signature_algorithm-property) | The signature algorithm used in a TLS handshake. | | [conn_info_symmetric_block_size](#conn_info_symmetric_block_size-property) | The block size of the symmetric algorithm used. | | [conn_info_symmetric_key_bits](#conn_info_symmetric_key_bits-property) | The key length of the symmetric algorithm used. | | [conn_info_total_bytes_received](#conn_info_total_bytes_received-property) | The total number of bytes received over this connection. | | [conn_info_total_bytes_sent](#conn_info_total_bytes_sent-property) | The total number of bytes sent over this connection. | | [conn_info_validation_log](#conn_info_validation_log-property) | Contains the server certificate's chain validation log. | | [conn_info_version](#conn_info_version-property) | Indicates the version of SSL/TLS protocol negotiated during this connection. | | [custom_param_count](#custom_param_count-property) | The number of records in the CustomParams arrays. | | [custom_params_category](#custom_params_category-property) | Specifies the string category of the contained value. | | [custom_params_format](#custom_params_format-property) | Specifies the format (encoding) of the value contained in the Value property. | | [custom_params_name](#custom_params_name-property) | The name element in a (name, value) pair. | | [custom_params_value](#custom_params_value-property) | The value element in a (name, value) pair. | | [expires_at](#expires_at-property) | The expiration time of access token. | | [expires_in](#expires_in-property) | Returns access token lifetime in seconds. | | [external_crypto_async_document_id](#external_crypto_async_document_id-property) | Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. | | [external_crypto_custom_params](#external_crypto_custom_params-property) | Custom parameters to be passed to the signing service (uninterpreted). | | [external_crypto_data](#external_crypto_data-property) | Additional data to be included in the async state and mirrored back by the requestor. | | [external_crypto_external_hash_calculation](#external_crypto_external_hash_calculation-property) | Specifies whether the message hash is to be calculated at the external endpoint. | | [external_crypto_hash_algorithm](#external_crypto_hash_algorithm-property) | Specifies the request's signature hash algorithm. | | [external_crypto_key_id](#external_crypto_key_id-property) | The ID of the pre-shared key used for DC request authentication. | | [external_crypto_key_secret](#external_crypto_key_secret-property) | The pre-shared key used for DC request authentication. | | [external_crypto_method](#external_crypto_method-property) | Specifies the asynchronous signing method. | | [external_crypto_mode](#external_crypto_mode-property) | Specifies the external cryptography mode. | | [external_crypto_public_key_algorithm](#external_crypto_public_key_algorithm-property) | Provide the public key algorithm here if the certificate is not available on the pre-signing stage. | | [failure_response](#failure_response-property) | The web page showed to the user by the class on authorization failure. | | [fips_mode](#fips_mode-property) | Reserved. | | [grant_type](#grant_type-property) | Specifies which protocol flow should be used to authorize the user. | | [grant_type_string](#grant_type_string-property) | Used to set a custom grant type string. | | [id_token](#id_token-property) | Contains the ID Token parameter for JWT. | | [keep_alive_policy](#keep_alive_policy-property) | Defines the keep-alive handling policy. | | [known_cert_count](#known_cert_count-property) | The number of records in the KnownCert arrays. | | [known_cert_bytes](#known_cert_bytes-property) | Returns the raw certificate data in DER format. | | [known_cert_handle](#known_cert_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [known_crl_count](#known_crl_count-property) | The number of records in the KnownCRL arrays. | | [known_crl_bytes](#known_crl_bytes-property) | Returns the raw CRL data in DER format. | | [known_crl_handle](#known_crl_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [known_ocsp_count](#known_ocsp_count-property) | The number of records in the KnownOCSP arrays. | | [known_ocsp_bytes](#known_ocsp_bytes-property) | A buffer containing the raw OCSP response data. | | [known_ocsp_handle](#known_ocsp_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [password](#password-property) | The connecting user's authentication password. | | [proxy_address](#proxy_address-property) | The IP address of the proxy server. | | [proxy_authentication](#proxy_authentication-property) | The authentication type used by the proxy server. | | [proxy_password](#proxy_password-property) | The password to authenticate to the proxy server. | | [proxy_port](#proxy_port-property) | The port on the proxy server to connect to. | | [proxy_type](#proxy_type-property) | The type of the proxy server. | | [proxy_request_headers](#proxy_request_headers-property) | Contains HTTP request headers for WebTunnel and HTTP proxy. | | [proxy_response_body](#proxy_response_body-property) | Contains the HTTP or HTTPS (WebTunnel) proxy response body. | | [proxy_response_headers](#proxy_response_headers-property) | Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. | | [proxy_use_ipv6](#proxy_use_ipv6-property) | Specifies whether IPv6 should be used when connecting through the proxy. | | [proxy_username](#proxy_username-property) | Specifies the username credential for proxy authentication. | | [redirect_url](#redirect_url-property) | The URL where the user is redirected after authorization. | | [redirect_url_cert_count](#redirect_url_cert_count-property) | The number of records in the RedirectURLCert arrays. | | [redirect_url_cert_bytes](#redirect_url_cert_bytes-property) | Returns the raw certificate data in DER format. | | [redirect_url_cert_handle](#redirect_url_cert_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [refresh_token](#refresh_token-property) | The refresh token, to be used to automatically obtain new access token. | | [scope](#scope-property) | The scope of the request to be authorized. | | [socket_dns_mode](#socket_dns_mode-property) | Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system. | | [socket_dns_port](#socket_dns_port-property) | Specifies the port number to be used for sending queries to the DNS server. | | [socket_dns_query_timeout](#socket_dns_query_timeout-property) | The timeout (in milliseconds) for each DNS query. | | [socket_dns_servers](#socket_dns_servers-property) | The addresses of DNS servers to use for address resolution, separated by commas or semicolons. | | [socket_dns_total_timeout](#socket_dns_total_timeout-property) | The timeout (in milliseconds) for the whole resolution process. | | [socket_incoming_speed_limit](#socket_incoming_speed_limit-property) | The maximum number of bytes to read from the socket, per second. | | [socket_local_address](#socket_local_address-property) | The local network interface to bind the socket to. | | [socket_local_port](#socket_local_port-property) | The local port number to bind the socket to. | | [socket_outgoing_speed_limit](#socket_outgoing_speed_limit-property) | The maximum number of bytes to write to the socket, per second. | | [socket_timeout](#socket_timeout-property) | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. | | [socket_use_ipv6](#socket_use_ipv6-property) | Enables or disables IP protocol version 6. | | [state](#state-property) | Specifies the state parameter of the authorization request or response. | | [success_response](#success_response-property) | The web page showed to the user by the class on authorization success. | | [timeout](#timeout-property) | Specifies waiting timeout (in milliseconds). | | [tls_auto_validate_certificates](#tls_auto_validate_certificates-property) | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. | | [tls_base_configuration](#tls_base_configuration-property) | Selects the base configuration for the TLS settings. | | [tls_ciphersuites](#tls_ciphersuites-property) | A list of ciphersuites separated with commas or semicolons. | | [tls_client_auth](#tls_client_auth-property) | Enables or disables certificate-based client authentication. | | [tls_extensions](#tls_extensions-property) | Provides access to TLS extensions. | | [tls_force_resume_if_destination_changes](#tls_force_resume_if_destination_changes-property) | Whether to force TLS session resumption when the destination address changes. | | [tls_groups](#tls_groups-property) | Specifies a list of key exchange groups to attempt during the TLS key exchange. | | [tls_pre_shared_identity](#tls_pre_shared_identity-property) | Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. | | [tls_pre_shared_key](#tls_pre_shared_key-property) | Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. | | [tls_pre_shared_key_ciphersuite](#tls_pre_shared_key_ciphersuite-property) | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. | | [tls_renegotiation_attack_prevention_mode](#tls_renegotiation_attack_prevention_mode-property) | Selects the renegotiation attack prevention mechanism. | | [tls_revocation_check](#tls_revocation_check-property) | Specifies the kind(s) of revocation check to perform. | | [tls_ssl_options](#tls_ssl_options-property) | Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size. | | [tls_mode](#tls_mode-property) | Specifies the TLS mode to use. | | [tls_use_extended_master_secret](#tls_use_extended_master_secret-property) | Enables the Extended Master Secret Extension, as defined in RFC 7627. | | [tls_use_session_resumption](#tls_use_session_resumption-property) | Enables or disables the TLS session resumption capability. | | [tls_versions](#tls_versions-property) | The SSL/TLS versions to enable by default. | | [tls_client_cert_count](#tls_client_cert_count-property) | The number of records in the TLSClientCert arrays. | | [tls_client_cert_bytes](#tls_client_cert_bytes-property) | Returns the raw certificate data in DER format. | | [tls_client_cert_handle](#tls_client_cert_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [tls_server_cert_count](#tls_server_cert_count-property) | The number of records in the TLSServerCert arrays. | | [tls_server_cert_bytes](#tls_server_cert_bytes-property) | Returns the raw certificate data in DER format. | | [tls_server_cert_fingerprint](#tls_server_cert_fingerprint-property) | Contains the fingerprint (a hash imprint) of this certificate. | | [tls_server_cert_handle](#tls_server_cert_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [tls_server_cert_issuer](#tls_server_cert_issuer-property) | The common name of the certificate issuer (CA), typically a company name. | | [tls_server_cert_issuer_rdn](#tls_server_cert_issuer_rdn-property) | A list of Property=Value pairs that uniquely identify the certificate issuer. | | [tls_server_cert_key_algorithm](#tls_server_cert_key_algorithm-property) | Specifies the public key algorithm of this certificate. | | [tls_server_cert_key_bits](#tls_server_cert_key_bits-property) | Returns the length of the public key in bits. | | [tls_server_cert_key_usage](#tls_server_cert_key_usage-property) | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. | | [tls_server_cert_self_signed](#tls_server_cert_self_signed-property) | Indicates whether the certificate is self-signed (root) or signed by an external CA. | | [tls_server_cert_serial_number](#tls_server_cert_serial_number-property) | Returns the certificate's serial number. | | [tls_server_cert_sig_algorithm](#tls_server_cert_sig_algorithm-property) | Indicates the algorithm that was used by the CA to sign this certificate. | | [tls_server_cert_subject](#tls_server_cert_subject-property) | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. | | [tls_server_cert_subject_rdn](#tls_server_cert_subject_rdn-property) | A list of Property=Value pairs that uniquely identify the certificate holder (subject). | | [tls_server_cert_valid_from](#tls_server_cert_valid_from-property) | The time point at which the certificate becomes valid, in UTC. | | [tls_server_cert_valid_to](#tls_server_cert_valid_to-property) | The time point at which the certificate expires, in UTC. | | [token_type](#token_type-property) | Returns the access token type. | | [token_url](#token_url-property) | Specifies the URL of the token endpoint. | | [trusted_cert_count](#trusted_cert_count-property) | The number of records in the TrustedCert arrays. | | [trusted_cert_bytes](#trusted_cert_bytes-property) | Returns the raw certificate data in DER format. | | [trusted_cert_handle](#trusted_cert_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [username](#username-property) | The connecting user's username (login name). | ## Method List *The following is the full list of the methods of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [authorize](#authorize-method) | Performs user authorization and gets an access token. | | [complete_authorization](#complete_authorization-method) | Completes the authorization routine. | | [config](#config-method) | Sets or retrieves a configuration setting. | | [do_action](#do_action-method) | Performs an additional action. | | [reset](#reset-method) | Resets the class settings. | | [start_authorization](#start_authorization-method) | Initiates OAuth authorization protocol. | ## 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_error](#on_error-event) | Provides information about errors during authorization operations. | | [on_external_sign](#on_external_sign-event) | Handles remote or external signing initiated by the SignExternal method or other source. | | [on_launch_browser](#on_launch_browser-event) | Fires to show the login page to the end-user. | | [on_notification](#on_notification-event) | This event notifies the application about an underlying control flow event. | | [on_tls_cert_needed](#on_tls_cert_needed-event) | Fires when a remote TLS party requests a client certificate. | | [on_tls_cert_validate](#on_tls_cert_validate-event) | This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. | | [on_tls_established](#on_tls_established-event) | Fires when a TLS handshake with Host successfully completes. | | [on_tls_handshake](#on_tls_handshake-event) | Fires when a new TLS handshake is initiated, before the handshake commences. | | [on_tls_psk](#on_tls_psk-event) | Notifies the application about the PSK key exchange. | | [on_tls_shutdown](#on_tls_shutdown-event) | Reports the graceful closure of a TLS connection. | | [on_wait](#on_wait-event) | Fired periodically to show how much waiting time is left. | ## Config Settings *The following is a list of config settings for the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AddOpenIDScope](#AddOpenIDScope) | Used to set whether the class should add 'openid' to the scope automatically. | | [CacheControl](#CacheControl) | Optional value for Cache-Control HTTP header field. | | [CachedCRLMaxAge](#CachedCRLMaxAge) | Specifies the maximum age of a cached CRL. | | [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio) | Specifies the maximum age of a cached CRL as a percentage of its remaining lifetime. | | [CachedCRLOverlapTime](#CachedCRLOverlapTime) | Specifies the time period before a cached CRL's NextUpdate when it is considered stale and must be refreshed. | | [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge) | Specifies the maximum age of a cached OCSP response. | | [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio) | Specifies the maximum age of a cached OCSP response as a percentage of its remaining lifetime. | | [CachedOCSPResponseOverlapTime](#CachedOCSPResponseOverlapTime) | Specifies the time period before a cached OCSP response's NextUpdate when it is considered stale and must be refreshed. | | [DeltaCRLPreference](#DeltaCRLPreference) | Specifies whether complete or delta CRLs are preferred. | | [EncodeScope](#EncodeScope) | Used to set whether the class should URL-encode the scope parameter. | | [EvaluateSystemTrust](#EvaluateSystemTrust) | Enables or disables usage of the platform's built-in trust validation facilities. | | [GrantTypeString](#GrantTypeString) | Used to set a custom grant type string. | | [IDToken](#IDToken) | ID Token parameter for JWT. | | [IgnoreSystemTrust](#IgnoreSystemTrust) | Whether trusted Windows Certificate Stores should be treated as trusted. | | [ListenURL](#ListenURL) | The URL where to listen for redirection from the user web browser. | | [LocalServerBaseConfiguration](#LocalServerBaseConfiguration) | Base configuration for the internal TLS server if an HTTPS redirect is used. | | [LocalServerCiphersuites](#LocalServerCiphersuites) | Ciphersuites allowed for the internal TLS server if an HTTPS redirect is used. | | [LocalServerVersions](#LocalServerVersions) | The SSL/TLS versions to enable for the internal TLS server if an HTTPS redirect is used. | | [PKCEMode](#PKCEMode) | Proof Key for Code Exchange method to use. | | [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) | Specifies a preset policy for cached CRL and OCSP response freshness settings. | | [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. | | [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. | | [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. | | [TLSCiphersuites](#TLSCiphersuites) | Returns the list of ciphersuites activated in the class for the current session. | | [TLSExtensions](#TLSExtensions) | TBD. | | [TLSGroups](#TLSGroups) | Returns the list of TLS key exchange groups enabled in the class. | | [TLSPeerExtensions](#TLSPeerExtensions) | TBD. | | [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. | | [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. | | [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. | | [TLSVersions](#TLSVersions) | Returns the list of TLS versions enabled in the class. | | [TolerateMinorChainIssues](#TolerateMinorChainIssues) | Whether to tolerate minor chain issues. | | [UseEnvStorages](#UseEnvStorages) | Enables or disables use of the environment storages. | | [UseMicrosoftCTL](#UseMicrosoftCTL) | Enables or disables the automatic use of the Microsoft online certificate trust list. | | [UseSystemCertificates](#UseSystemCertificates) | Enables or disables the use of the system certificates. | | [ASN1UseGlobalTagCache](#ASN1UseGlobalTagCache) | Controls whether ASN.1 module should use a global object cache. | | [AssignSystemSmartCardPins](#AssignSystemSmartCardPins) | Specifies whether CSP-level PINs should be assigned to CNG keys. | | [CheckKeyIntegrityBeforeUse](#CheckKeyIntegrityBeforeUse) | Enables or disable private key integrity check before use. | | [CookieCaching](#CookieCaching) | Specifies whether a cookie cache should be used for HTTP(S) transports. | | [Cookies](#Cookies) | Gets or sets local cookies for the class. | | [DefDeriveKeyIterations](#DefDeriveKeyIterations) | Specifies the default key derivation algorithm iteration count. | | [DNSLocalSuffix](#DNSLocalSuffix) | The suffix to assign for TLD names. | | [EnableClientSideSSLFFDHE](#EnableClientSideSSLFFDHE) | Enables or disables finite field DHE key exchange support in TLS clients. | | [EnableSSHMLKEM](#EnableSSHMLKEM) | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server classes. | | [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server classes. | | [GlobalCookies](#GlobalCookies) | Gets or sets global cookies for all the HTTP transports. | | [HardwareCryptoUsePolicy](#HardwareCryptoUsePolicy) | The hardware crypto usage policy. | | [HttpUserAgent](#HttpUserAgent) | Specifies the user agent name to be used by all HTTP clients. | | [HttpVersion](#HttpVersion) | The HTTP version to use in any inner HTTP client classes created. | | [IgnoreExpiredMSCTLSigningCert](#IgnoreExpiredMSCTLSigningCert) | Whether to tolerate the expired Windows Update signing certificate. | | [ListDelimiter](#ListDelimiter) | The delimiter character for multi-element lists. | | [LogDestination](#LogDestination) | Specifies the debug log destination. | | [LogDetails](#LogDetails) | Specifies the debug log details to dump. | | [LogFile](#LogFile) | Specifies the debug log filename. | | [LogFilters](#LogFilters) | Specifies the debug log filters. | | [LogFlushMode](#LogFlushMode) | Specifies the log flush mode. | | [LogLevel](#LogLevel) | Specifies the debug log level. | | [LogMaxEventCount](#LogMaxEventCount) | Specifies the maximum number of events to cache before further action is taken. | | [LogRotationMode](#LogRotationMode) | Specifies the log rotation mode. | | [MaxASN1BufferLength](#MaxASN1BufferLength) | Specifies the maximal allowed length for ASN.1 primitive tag data. | | [MaxASN1TreeDepth](#MaxASN1TreeDepth) | Specifies the maximal depth for processed ASN.1 trees. | | [OCSPHashAlgorithm](#OCSPHashAlgorithm) | Specifies the hash algorithm to be used to identify certificates in OCSP requests. | | [OldClientSideRSAFallback](#OldClientSideRSAFallback) | Specifies whether the SSH client should use a SHA1 fallback. | | [PKICache](#PKICache) | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. | | [PKICachePath](#PKICachePath) | Specifies the file system path where cached PKI data is stored. | | [ProductVersion](#ProductVersion) | Returns the version of the SecureBlackbox library. | | [ServerSSLDHKeyLength](#ServerSSLDHKeyLength) | Sets the size of the TLS DHE key exchange group. | | [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. | | [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. | | [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. | | [Tag](#Tag) | Allows to store any custom data. | | [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. | | [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. | | [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. | | [UseCRLObjectCaching](#UseCRLObjectCaching) | Specifies whether reuse of loaded CRL objects is enabled. | | [UseInternalRandom](#UseInternalRandom) | Switches between SecureBlackbox-own and platform PRNGs. | | [UseLegacyAdESValidation](#UseLegacyAdESValidation) | Enables legacy AdES validation mode. | | [UseOCSPResponseObjectCaching](#UseOCSPResponseObjectCaching) | Specifies whether reuse of loaded OCSP response objects is enabled. | | [UseOwnDNSResolver](#UseOwnDNSResolver) | Specifies whether the client classes should use own DNS resolver. | | [UseSharedSystemStorages](#UseSharedSystemStorages) | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. | | [UseSystemNativeSizeCalculation](#UseSystemNativeSizeCalculation) | An internal CryptoAPI access tweak. | | [UseSystemOAEPAndPSS](#UseSystemOAEPAndPSS) | Enforces or disables the use of system-driven RSA OAEP and PSS computations. | | [UseSystemRandom](#UseSystemRandom) | Enables or disables the use of the OS PRNG. | | [XMLRDNDescriptorName\[OID\]](#XMLRDNDescriptorName[OID]) | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. | | [XMLRDNDescriptorPriority\[OID\]](#XMLRDNDescriptorPriority[OID]) | Specifies the priority of descriptor names associated with a specific OID. | | [XMLRDNDescriptorReverseOrder](#XMLRDNDescriptorReverseOrder) | Specifies whether to reverse the order of descriptors in RDN. | | [XMLRDNDescriptorSeparator](#XMLRDNDescriptorSeparator) | Specifies the separator used between descriptors in RDN. | # access_token property Contains the access token. ## Syntax ```text def get_access_token() -> str: ... def set_access_token(value: str) -> None: ... access_token = property(get_access_token, set_access_token) ``` ## Default Value "" ## Remarks Use this property to check or set the authorization access token. # auth_url property Specifies the URL of the authorization server. ## Syntax ```text def get_auth_url() -> str: ... def set_auth_url(value: str) -> None: ... auth_url = property(get_auth_url, set_auth_url) ``` ## Default Value "" ## Remarks Use this property to set the URL of the authorization server. # auto_refresh property Specifies whether access token should be automatically refreshed. ## Syntax ```text def get_auto_refresh() -> bool: ... def set_auto_refresh(value: bool) -> None: ... auto_refresh = property(get_auto_refresh, set_auto_refresh) ``` ## Default Value TRUE ## Remarks Set this property to true to let the class automatically refresh [access_token](#access_token-property). If available, [refresh_token](#refresh_token-property) is used to renew access token. Otherwise the authorization process is initiated from the beginning, with user authentication and so on. # blocked_cert_count property The number of records in the BlockedCert arrays. ## Syntax ```text def get_blocked_cert_count() -> int: ... def set_blocked_cert_count(value: int) -> None: ... blocked_cert_count = property(get_blocked_cert_count, set_blocked_cert_count) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [blocked_cert_bytes](#blocked_cert_bytes-property) - [blocked_cert_handle](#blocked_cert_handle-property) The array indices start at *0* and end at *blocked_cert_count - 1*. # blocked_cert_bytes property Returns the raw certificate data in DER format. ## Syntax ```text def get_blocked_cert_bytes(blocked_cert_index: int) -> bytes: ... ``` ## Remarks Returns the raw certificate data in DER format. The *blocked_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [blocked_cert_count](#blocked_cert_count-property) property. This property is read-only. # blocked_cert_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_blocked_cert_handle(blocked_cert_index: int) -> int: ... def set_blocked_cert_handle(blocked_cert_index: int, value: int) -> None: ... ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *blocked_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [blocked_cert_count](#blocked_cert_count-property) property. # client_id property Client ID of the application which needs access to the protected resource. ## Syntax ```text def get_client_id() -> str: ... def set_client_id(value: str) -> None: ... client_id = property(get_client_id, set_client_id) ``` ## Default Value "" ## Remarks Use this property to specify the client ID of the application. # client_secret property Client secret of the application which needs access to the protected resource. ## Syntax ```text def get_client_secret() -> str: ... def set_client_secret(value: str) -> None: ... client_secret = property(get_client_secret, set_client_secret) ``` ## Default Value "" ## Remarks Use this property to specify client secret of the application. # conn_info_aead_cipher property Indicates whether the encryption algorithm used is an AEAD cipher. ## Syntax ```text def get_conn_info_aead_cipher() -> bool: ... conn_info_aead_cipher = property(get_conn_info_aead_cipher, None) ``` ## Default Value FALSE ## Remarks Indicates whether the encryption algorithm used is an AEAD cipher. This property is read-only. # conn_info_chain_validation_details property The details of a certificate chain validation outcome. ## Syntax ```text def get_conn_info_chain_validation_details() -> int: ... conn_info_chain_validation_details = property(get_conn_info_chain_validation_details, None) ``` ## Default Value 0 ## Remarks The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result. Returns a bit mask of the following options: | | | | | --- | --- | --- | | cvrBadData | 0x0001 | One or more certificates in the validation path are malformed | | cvrRevoked | 0x0002 | One or more certificates are revoked | | cvrNotYetValid | 0x0004 | One or more certificates are not yet valid | | cvrExpired | 0x0008 | One or more certificates are expired | | cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature | | cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) | | cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA | | cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified | | cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified | | cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate | | cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates | | cvrBlocked | 0x0800 | One or more certificates are blocked | | cvrFailure | 0x1000 | General validation failure | | cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself | | cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements | | cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code | This property is read-only. # conn_info_chain_validation_result property The outcome of a certificate chain validation routine. ## Syntax ```text def get_conn_info_chain_validation_result() -> int: ... conn_info_chain_validation_result = property(get_conn_info_chain_validation_result, None) ``` ## Possible Values ```text 0 # Valid1 # ValidButUntrusted2 # Invalid3 # CantBeEstablished ``` ## Default Value 0 ## Remarks The outcome of a certificate chain validation routine. Available options: | | | | | --- | --- | --- | | cvtValid | 0 | The chain is valid | | cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted | | cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) | | cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) | Use the ValidationLog property to access the detailed validation log. This property is read-only. # conn_info_ciphersuite property The cipher suite employed by this connection. ## Syntax ```text def get_conn_info_ciphersuite() -> str: ... conn_info_ciphersuite = property(get_conn_info_ciphersuite, None) ``` ## Default Value "" ## Remarks The cipher suite employed by this connection. For TLS connections, this property returns the ciphersuite that was/is employed by the connection. This property is read-only. # conn_info_client_authenticated property Specifies whether client authentication was performed during this connection. ## Syntax ```text def get_conn_info_client_authenticated() -> bool: ... conn_info_client_authenticated = property(get_conn_info_client_authenticated, None) ``` ## Default Value FALSE ## Remarks Specifies whether client authentication was performed during this connection. This property is read-only. # conn_info_client_auth_requested property Specifies whether client authentication was requested during this connection. ## Syntax ```text def get_conn_info_client_auth_requested() -> bool: ... conn_info_client_auth_requested = property(get_conn_info_client_auth_requested, None) ``` ## Default Value FALSE ## Remarks Specifies whether client authentication was requested during this connection. This property is read-only. # conn_info_connection_established property Indicates whether the connection has been established fully. ## Syntax ```text def get_conn_info_connection_established() -> bool: ... conn_info_connection_established = property(get_conn_info_connection_established, None) ``` ## Default Value FALSE ## Remarks Indicates whether the connection has been established fully. This property is read-only. # conn_info_connection_id property The unique identifier assigned to this connection. ## Syntax ```text def get_conn_info_connection_id() -> bytes: ... conn_info_connection_id = property(get_conn_info_connection_id, None) ``` ## Remarks The unique identifier assigned to this connection. This property is read-only. # conn_info_digest_algorithm property The digest algorithm used in a TLS-enabled connection. ## Syntax ```text def get_conn_info_digest_algorithm() -> str: ... conn_info_digest_algorithm = property(get_conn_info_digest_algorithm, None) ``` ## Default Value "" ## Remarks The digest algorithm used in a TLS-enabled connection. This property is read-only. # conn_info_encryption_algorithm property The symmetric encryption algorithm used in a TLS-enabled connection. ## Syntax ```text def get_conn_info_encryption_algorithm() -> str: ... conn_info_encryption_algorithm = property(get_conn_info_encryption_algorithm, None) ``` ## Default Value "" ## Remarks The symmetric encryption algorithm used in a TLS-enabled connection. This property is read-only. # conn_info_exportable property Indicates whether a TLS connection uses a reduced-strength exportable cipher. ## Syntax ```text def get_conn_info_exportable() -> bool: ... conn_info_exportable = property(get_conn_info_exportable, None) ``` ## Default Value FALSE ## Remarks Indicates whether a TLS connection uses a reduced-strength exportable cipher. This property is read-only. # conn_info_group property The elliptic curve used in this connection. ## Syntax ```text def get_conn_info_group() -> str: ... conn_info_group = property(get_conn_info_group, None) ``` ## Default Value "" ## Remarks The elliptic curve used in this connection. This property was named *NamedECCurve* in SecureBlackbox 2024 and earlier versions. This property is read-only. # conn_info_id property The client connection's unique identifier. ## Syntax ```text def get_conn_info_id() -> int: ... conn_info_id = property(get_conn_info_id, None) ``` ## Default Value -1 ## Remarks The client connection's unique identifier. This value is used throughout to refer to a particular client connection. This property is read-only. # conn_info_key_exchange_algorithm property The key exchange algorithm used in a TLS-enabled connection. ## Syntax ```text def get_conn_info_key_exchange_algorithm() -> str: ... conn_info_key_exchange_algorithm = property(get_conn_info_key_exchange_algorithm, None) ``` ## Default Value "" ## Remarks The key exchange algorithm used in a TLS-enabled connection. This property is read-only. # conn_info_key_exchange_key_bits property The length of the key exchange key of a TLS-enabled connection. ## Syntax ```text def get_conn_info_key_exchange_key_bits() -> int: ... conn_info_key_exchange_key_bits = property(get_conn_info_key_exchange_key_bits, None) ``` ## Default Value 0 ## Remarks The length of the key exchange key of a TLS-enabled connection. This property is read-only. # conn_info_pfs_cipher property Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). ## Syntax ```text def get_conn_info_pfs_cipher() -> bool: ... conn_info_pfs_cipher = property(get_conn_info_pfs_cipher, None) ``` ## Default Value FALSE ## Remarks Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). This property is read-only. # conn_info_pre_shared_identity property Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. ## Syntax ```text def get_conn_info_pre_shared_identity() -> str: ... conn_info_pre_shared_identity = property(get_conn_info_pre_shared_identity, None) ``` ## Default Value "" ## Remarks Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. This property is read-only. # conn_info_pre_shared_identity_hint property A hint professed by the server to help the client select the PSK identity to use. ## Syntax ```text def get_conn_info_pre_shared_identity_hint() -> str: ... conn_info_pre_shared_identity_hint = property(get_conn_info_pre_shared_identity_hint, None) ``` ## Default Value "" ## Remarks A hint professed by the server to help the client select the PSK identity to use. This property is read-only. # conn_info_public_key_bits property The length of the public key. ## Syntax ```text def get_conn_info_public_key_bits() -> int: ... conn_info_public_key_bits = property(get_conn_info_public_key_bits, None) ``` ## Default Value 0 ## Remarks The length of the public key. This property is read-only. # conn_info_remote_address property The client's IP address. ## Syntax ```text def get_conn_info_remote_address() -> str: ... conn_info_remote_address = property(get_conn_info_remote_address, None) ``` ## Default Value "" ## Remarks The client's IP address. This property is read-only. # conn_info_remote_port property The remote port of the client connection. ## Syntax ```text def get_conn_info_remote_port() -> int: ... conn_info_remote_port = property(get_conn_info_remote_port, None) ``` ## Default Value 0 ## Remarks The remote port of the client connection. This property is read-only. # conn_info_resumed_session property Indicates whether a TLS-enabled connection was spawned from another TLS connection. ## Syntax ```text def get_conn_info_resumed_session() -> bool: ... conn_info_resumed_session = property(get_conn_info_resumed_session, None) ``` ## Default Value FALSE ## Remarks Indicates whether a TLS-enabled connection was spawned from another TLS connection This property is read-only. # conn_info_secure_connection property Indicates whether TLS or SSL is enabled for this connection. ## Syntax ```text def get_conn_info_secure_connection() -> bool: ... conn_info_secure_connection = property(get_conn_info_secure_connection, None) ``` ## Default Value FALSE ## Remarks Indicates whether TLS or SSL is enabled for this connection. This property is read-only. # conn_info_server_authenticated property Indicates whether server authentication was performed during a TLS-enabled connection. ## Syntax ```text def get_conn_info_server_authenticated() -> bool: ... conn_info_server_authenticated = property(get_conn_info_server_authenticated, None) ``` ## Default Value FALSE ## Remarks Indicates whether server authentication was performed during a TLS-enabled connection. This property is read-only. # conn_info_signature_algorithm property The signature algorithm used in a TLS handshake. ## Syntax ```text def get_conn_info_signature_algorithm() -> str: ... conn_info_signature_algorithm = property(get_conn_info_signature_algorithm, None) ``` ## Default Value "" ## Remarks The signature algorithm used in a TLS handshake. This property is read-only. # conn_info_symmetric_block_size property The block size of the symmetric algorithm used. ## Syntax ```text def get_conn_info_symmetric_block_size() -> int: ... conn_info_symmetric_block_size = property(get_conn_info_symmetric_block_size, None) ``` ## Default Value 0 ## Remarks The block size of the symmetric algorithm used. This property is read-only. # conn_info_symmetric_key_bits property The key length of the symmetric algorithm used. ## Syntax ```text def get_conn_info_symmetric_key_bits() -> int: ... conn_info_symmetric_key_bits = property(get_conn_info_symmetric_key_bits, None) ``` ## Default Value 0 ## Remarks The key length of the symmetric algorithm used. This property is read-only. # conn_info_total_bytes_received property The total number of bytes received over this connection. ## Syntax ```text def get_conn_info_total_bytes_received() -> int: ... conn_info_total_bytes_received = property(get_conn_info_total_bytes_received, None) ``` ## Default Value 0 ## Remarks The total number of bytes received over this connection. This property is read-only. # conn_info_total_bytes_sent property The total number of bytes sent over this connection. ## Syntax ```text def get_conn_info_total_bytes_sent() -> int: ... conn_info_total_bytes_sent = property(get_conn_info_total_bytes_sent, None) ``` ## Default Value 0 ## Remarks The total number of bytes sent over this connection. This property is read-only. # conn_info_validation_log property Contains the server certificate's chain validation log. ## Syntax ```text def get_conn_info_validation_log() -> str: ... conn_info_validation_log = property(get_conn_info_validation_log, None) ``` ## Default Value "" ## Remarks Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures. This property is read-only. # conn_info_version property Indicates the version of SSL/TLS protocol negotiated during this connection. ## Syntax ```text def get_conn_info_version() -> str: ... conn_info_version = property(get_conn_info_version, None) ``` ## Default Value "" ## Remarks Indicates the version of SSL/TLS protocol negotiated during this connection. This property is read-only. # custom_param_count property The number of records in the CustomParams arrays. ## Syntax ```text def get_custom_param_count() -> int: ... def set_custom_param_count(value: int) -> None: ... custom_param_count = property(get_custom_param_count, set_custom_param_count) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [custom_params_category](#custom_params_category-property) - [custom_params_format](#custom_params_format-property) - [custom_params_name](#custom_params_name-property) - [custom_params_value](#custom_params_value-property) The array indices start at *0* and end at *custom_param_count - 1*. # custom_params_category property Specifies the string category of the contained value. ## Syntax ```text def get_custom_params_category(custom_param_index: int) -> str: ... def set_custom_params_category(custom_param_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks Specifies the string category of the contained value. This property allows to check or set the category (or type) associated with the contained value. Depending on the format used to load or save the string, the category parameter may or may not be used. For example, for ASN.1 property lists the category contains the ASN.1 tag of the contained data (OCTETSTRING, UTF8STRING, INTEGER, ...). For basic (name, value) pairs, such as HTTP headers, the category parameter is not used. The *custom_param_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [custom_param_count](#custom_param_count-property) property. # custom_params_format property Specifies the format (encoding) of the value contained in the Value property. ## Syntax ```text def get_custom_params_format(custom_param_index: int) -> int: ... def set_custom_params_format(custom_param_index: int, value: int) -> None: ... ``` ## Default Value 0 ## Remarks Specifies the format (encoding) of the value contained in the [custom_params_value](#custom_params_value-property) property. Use this property to check or set the format of the contained value. Remember to provide the actual value in the appropriate format that matches this setting: ```text utils.NameValuePairs[0].Name = "key"; utils.NameValuePairs[0].Format = svfBinary; utils.NameValuePairs[0].Name = "0a1b2c3d4e5f6071"; ``` The following formats are currently supported: | | | | | --- | --- | --- | | svfText | 0 | The property contains text | | svfBinary | 1 | The property contains binary data. The Value property contains a hex encoding of it. | The *custom_param_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [custom_param_count](#custom_param_count-property) property. # custom_params_name property The name element in a (name, value) pair. ## Syntax ```text def get_custom_params_name(custom_param_index: int) -> str: ... def set_custom_params_name(custom_param_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The name element in a (name, value) pair. The *custom_param_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [custom_param_count](#custom_param_count-property) property. # custom_params_value property The value element in a (name, value) pair. ## Syntax ```text def get_custom_params_value(custom_param_index: int) -> str: ... def set_custom_params_value(custom_param_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The value element in a (name, value) pair. The *custom_param_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [custom_param_count](#custom_param_count-property) property. # expires_at property The expiration time of access token. ## Syntax ```text def get_expires_at() -> str: ... def set_expires_at(value: str) -> None: ... expires_at = property(get_expires_at, set_expires_at) ``` ## Default Value "" ## Remarks Use this property to check the expiration time of [access_token](#access_token-property). # expires_in property Returns access token lifetime in seconds. ## Syntax ```text def get_expires_in() -> int: ... expires_in = property(get_expires_in, None) ``` ## Default Value 0 ## Remarks Use this property to get the [access_token](#access_token-property) lifetime in seconds. This value is returned by the authorization server together with the access token. To check the token's expiration moment, use [expires_at](#expires_at-property) property. This property is read-only. # external_crypto_async_document_id property Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. ## Syntax ```text def get_external_crypto_async_document_id() -> str: ... def set_external_crypto_async_document_id(value: str) -> None: ... external_crypto_async_document_id = property(get_external_crypto_async_document_id, set_external_crypto_async_document_id) ``` ## Default Value "" ## Remarks Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses. If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages. # external_crypto_custom_params property Custom parameters to be passed to the signing service (uninterpreted). ## Syntax ```text def get_external_crypto_custom_params() -> str: ... def set_external_crypto_custom_params(value: str) -> None: ... external_crypto_custom_params = property(get_external_crypto_custom_params, set_external_crypto_custom_params) ``` ## Default Value "" ## Remarks Custom parameters to be passed to the signing service (uninterpreted). # external_crypto_data property Additional data to be included in the async state and mirrored back by the requestor. ## Syntax ```text def get_external_crypto_data() -> str: ... def set_external_crypto_data(value: str) -> None: ... external_crypto_data = property(get_external_crypto_data, set_external_crypto_data) ``` ## Default Value "" ## Remarks Additional data to be included in the async state and mirrored back by the requestor. # external_crypto_external_hash_calculation property Specifies whether the message hash is to be calculated at the external endpoint. ## Syntax ```text def get_external_crypto_external_hash_calculation() -> bool: ... def set_external_crypto_external_hash_calculation(value: bool) -> None: ... external_crypto_external_hash_calculation = property(get_external_crypto_external_hash_calculation, set_external_crypto_external_hash_calculation) ``` ## Default Value FALSE ## Remarks Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth class. If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called. # external_crypto_hash_algorithm property Specifies the request's signature hash algorithm. ## Syntax ```text def get_external_crypto_hash_algorithm() -> str: ... def set_external_crypto_hash_algorithm(value: str) -> None: ... external_crypto_hash_algorithm = property(get_external_crypto_hash_algorithm, set_external_crypto_hash_algorithm) ``` ## Default Value "SHA256" ## Remarks Specifies the request's signature hash algorithm. | | | | | --- | --- | --- | | SB_HASH_ALGORITHM_SHA1 | SHA1 | | | SB_HASH_ALGORITHM_SHA224 | SHA224 | | | SB_HASH_ALGORITHM_SHA256 | SHA256 | | | SB_HASH_ALGORITHM_SHA384 | SHA384 | | | SB_HASH_ALGORITHM_SHA512 | SHA512 | | | SB_HASH_ALGORITHM_MD2 | MD2 | | | SB_HASH_ALGORITHM_MD4 | MD4 | | | SB_HASH_ALGORITHM_MD5 | MD5 | | | SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | | | SB_HASH_ALGORITHM_CRC32 | CRC32 | | | SB_HASH_ALGORITHM_SSL3 | SSL3 | | | SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | | | SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | | | SB_HASH_ALGORITHM_POLY1305 | POLY1305 | | | SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | | | SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | | | SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | | | SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | | | SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | | | SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | | | SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | | | SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | | | SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | | | SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | | | SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | | | SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | | | SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | | | SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | | | SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | | | SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN | | # external_crypto_key_id property The ID of the pre-shared key used for DC request authentication. ## Syntax ```text def get_external_crypto_key_id() -> str: ... def set_external_crypto_key_id(value: str) -> None: ... external_crypto_key_id = property(get_external_crypto_key_id, set_external_crypto_key_id) ``` ## Default Value "" ## Remarks The ID of the pre-shared key used for DC request authentication. Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use [external_crypto_key_secret](#external_crypto_key_secret-property) to pass the key itself. The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted. Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users. Example: ```text signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789"; ``` # external_crypto_key_secret property The pre-shared key used for DC request authentication. ## Syntax ```text def get_external_crypto_key_secret() -> str: ... def set_external_crypto_key_secret(value: str) -> None: ... external_crypto_key_secret = property(get_external_crypto_key_secret, set_external_crypto_key_secret) ``` ## Default Value "" ## Remarks The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work. Read more about configuring authentication in the [external_crypto_key_id](#external_crypto_key_id-property) topic. # external_crypto_method property Specifies the asynchronous signing method. ## Syntax ```text def get_external_crypto_method() -> int: ... def set_external_crypto_method(value: int) -> None: ... external_crypto_method = property(get_external_crypto_method, set_external_crypto_method) ``` ## Possible Values ```text 0 # PKCS11 # PKCS7 ``` ## Default Value 0 ## Remarks Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup. Available options: | | | | --- | --- | | asmdPKCS1 | 0 | | asmdPKCS7 | 1 | # external_crypto_mode property Specifies the external cryptography mode. ## Syntax ```text def get_external_crypto_mode() -> int: ... def set_external_crypto_mode(value: int) -> None: ... external_crypto_mode = property(get_external_crypto_mode, set_external_crypto_mode) ``` ## Possible Values ```text 0 # Default1 # Disabled2 # Generic3 # DCAuth4 # DCAuthJSON ``` ## Default Value 0 ## Remarks Specifies the external cryptography mode. Available options: | | | | --- | --- | | ecmDefault | The default value (0) | | ecmDisabled | Do not use DC or external signing (1) | | ecmGeneric | Generic external signing with the OnExternalSign event (2) | | ecmDCAuth | DCAuth signing (3) | | ecmDCAuthJSON | DCAuth signing in JSON format (4) | # external_crypto_public_key_algorithm property Provide the public key algorithm here if the certificate is not available on the pre-signing stage. ## Syntax ```text def get_external_crypto_public_key_algorithm() -> str: ... def set_external_crypto_public_key_algorithm(value: str) -> None: ... external_crypto_public_key_algorithm = property(get_external_crypto_public_key_algorithm, set_external_crypto_public_key_algorithm) ``` ## Default Value "" ## Remarks Provide the public key algorithm here if the certificate is not available on the pre-signing stage. | | | | | --- | --- | --- | | SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | | | SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | | | SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | | | SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA | id-dsa | | | SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | | | SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | | | SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | | | SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | | | SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | | | SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | | | SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | | | SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | | | SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | | | SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | | | SB_CERT_ALGORITHM_EC | id-ecPublicKey | | | SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | | | SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | | | SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | | | SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | | | SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | | | SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | | | SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | | | SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | | | SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | | | SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | | | SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | | | SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | | | SB_CERT_ALGORITHM_EDDSA | id-EdDSA | | | SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig | | | SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 | | | SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 | | | SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 | | | SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 | | | SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 | | | SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 | | | SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 | | # failure_response property The web page showed to the user by the class on authorization failure. ## Syntax ```text def get_failure_response() -> str: ... def set_failure_response(value: str) -> None: ... failure_response = property(get_failure_response, set_failure_response) ``` ## Default Value "" ## Remarks This property contains the html of the web page to be shown on authorization failure. # fips_mode property Reserved. ## Syntax ```text def get_fips_mode() -> bool: ... def set_fips_mode(value: bool) -> None: ... fips_mode = property(get_fips_mode, set_fips_mode) ``` ## Default Value FALSE ## Remarks This property is reserved for future use. # grant_type property Specifies which protocol flow should be used to authorize the user. ## Syntax ```text def get_grant_type() -> int: ... def set_grant_type(value: int) -> None: ... grant_type = property(get_grant_type, set_grant_type) ``` ## Possible Values ```text 0 # AuthorizationCode1 # Implicit2 # PasswordCredentials3 # ClientCredentials4 # HybridIdToken5 # HybridToken6 # HybridAll ``` ## Default Value 0 ## Remarks Use this property to specify the authorization protocol to use. | | | | | --- | --- | --- | | ogtAuthorizationCode | 0 | Authorization Code flow should be used (see [RFC 6749 Section 1.3.1](https://tools.ietf.org/html/rfc6749#section-1.3.1)) | | ogtImplicit | 1 | Implicit flow should be used (see [RFC 6749 Section 1.3.2](https://tools.ietf.org/html/rfc6749#section-1.3.2)) | | ogtPasswordCredentials | 2 | Resource Owner Password Credentials flow should be used (see [RFC 6749 Section 1.3.3](https://tools.ietf.org/html/rfc6749#section-1.3.3)) | | ogtClientCredentials | 3 | Client Credentials flow should be used (see [RFC 6749 Section 1.3.4](https://tools.ietf.org/html/rfc6749#section-1.3.4)) | | ogtHybridIdToken | 4 | Hybrid flow should be used to get an access token and an ID token | | ogtHybridToken | 5 | Hybrid flow should be used to get an access token | | ogtHybridAll | 6 | Hybrid flow should be used to get an access token and an ID token | # grant_type_string property Used to set a custom grant type string. ## Syntax ```text def get_grant_type_string() -> str: ... def set_grant_type_string(value: str) -> None: ... grant_type_string = property(get_grant_type_string, set_grant_type_string) ``` ## Default Value "" ## Remarks This setting is used to set the *grant_type* parameter manually. This class will still consider the [grant_type](#grant_type-property) property to determine how it will function. # id_token property Contains the ID Token parameter for JWT. ## Syntax ```text def get_id_token() -> str: ... id_token = property(get_id_token, None) ``` ## Default Value "" ## Remarks Use this property to get the id_token parameter (if any) than can be used for JWT operations. This property is read-only. # keep_alive_policy property Defines the keep-alive handling policy. ## Syntax ```text def get_keep_alive_policy() -> int: ... def set_keep_alive_policy(value: int) -> None: ... keep_alive_policy = property(get_keep_alive_policy, set_keep_alive_policy) ``` ## Possible Values ```text 0 # StandardDefined1 # PreferKeepAlive2 # RelyOnServer3 # KeepAlivesDisabled ``` ## Default Value 0 ## Remarks Use this property to tune-up the keep-alive mechanism as per the needs of your application. | | | | | --- | --- | --- | | ckapStandardDefined | 0 | Follow the standard | | ckapPreferKeepAlive | 1 | Always request a keep-alive connection | | ckapRelyOnServer | 2 | Not include the "Connection" header, allowing the server to choose the keep-alive mode | | ckapKeepAlivesDisabled | 3 | Disable keep-alives by including the "Connection: Close" header | # known_cert_count property The number of records in the KnownCert arrays. ## Syntax ```text def get_known_cert_count() -> int: ... def set_known_cert_count(value: int) -> None: ... known_cert_count = property(get_known_cert_count, set_known_cert_count) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [known_cert_bytes](#known_cert_bytes-property) - [known_cert_handle](#known_cert_handle-property) The array indices start at *0* and end at *known_cert_count - 1*. # known_cert_bytes property Returns the raw certificate data in DER format. ## Syntax ```text def get_known_cert_bytes(known_cert_index: int) -> bytes: ... ``` ## Remarks Returns the raw certificate data in DER format. The *known_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_cert_count](#known_cert_count-property) property. This property is read-only. # known_cert_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_known_cert_handle(known_cert_index: int) -> int: ... def set_known_cert_handle(known_cert_index: int, value: int) -> None: ... ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *known_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_cert_count](#known_cert_count-property) property. # known_crl_count property The number of records in the KnownCRL arrays. ## Syntax ```text def get_known_crl_count() -> int: ... def set_known_crl_count(value: int) -> None: ... known_crl_count = property(get_known_crl_count, set_known_crl_count) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [known_crl_bytes](#known_crl_bytes-property) - [known_crl_handle](#known_crl_handle-property) The array indices start at *0* and end at *known_crl_count - 1*. # known_crl_bytes property Returns the raw CRL data in DER format. ## Syntax ```text def get_known_crl_bytes(known_crl_index: int) -> bytes: ... ``` ## Remarks Returns the raw CRL data in DER format. The *known_crl_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_crl_count](#known_crl_count-property) property. This property is read-only. # known_crl_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_known_crl_handle(known_crl_index: int) -> int: ... def set_known_crl_handle(known_crl_index: int, value: int) -> None: ... ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *known_crl_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_crl_count](#known_crl_count-property) property. # known_ocsp_count property The number of records in the KnownOCSP arrays. ## Syntax ```text def get_known_ocsp_count() -> int: ... def set_known_ocsp_count(value: int) -> None: ... known_ocsp_count = property(get_known_ocsp_count, set_known_ocsp_count) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [known_ocsp_bytes](#known_ocsp_bytes-property) - [known_ocsp_handle](#known_ocsp_handle-property) The array indices start at *0* and end at *known_ocsp_count - 1*. # known_ocsp_bytes property A buffer containing the raw OCSP response data. ## Syntax ```text def get_known_ocsp_bytes(known_ocsp_index: int) -> bytes: ... ``` ## Remarks A buffer containing the raw OCSP response data. The *known_ocsp_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_ocsp_count](#known_ocsp_count-property) property. This property is read-only. # known_ocsp_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_known_ocsp_handle(known_ocsp_index: int) -> int: ... def set_known_ocsp_handle(known_ocsp_index: int, value: int) -> None: ... ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *known_ocsp_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_ocsp_count](#known_ocsp_count-property) property. # password property The connecting user's authentication password. ## Syntax ```text def get_password() -> str: ... def set_password(value: str) -> None: ... password = property(get_password, set_password) ``` ## Default Value "" ## Remarks Assign the user's authentication password to this property. Use [username](#username-property) for username/login. The Username and Password properties are used only when [grant_type](#grant_type-property) is *oauthPasswordCredentials*. # proxy_address property The IP address of the proxy server. ## Syntax ```text def get_proxy_address() -> str: ... def set_proxy_address(value: str) -> None: ... proxy_address = property(get_proxy_address, set_proxy_address) ``` ## Default Value "" ## Remarks The IP address of the proxy server. # proxy_authentication property The authentication type used by the proxy server. ## Syntax ```text def get_proxy_authentication() -> int: ... def set_proxy_authentication(value: int) -> None: ... proxy_authentication = property(get_proxy_authentication, set_proxy_authentication) ``` ## Possible Values ```text 0 # NoAuthentication1 # Basic2 # Digest3 # NTLM ``` ## Default Value 0 ## Remarks The authentication type used by the proxy server. | | | | --- | --- | | patNoAuthentication | 0 | | patBasic | 1 | | patDigest | 2 | | patNTLM | 3 | # proxy_password property The password to authenticate to the proxy server. ## Syntax ```text def get_proxy_password() -> str: ... def set_proxy_password(value: str) -> None: ... proxy_password = property(get_proxy_password, set_proxy_password) ``` ## Default Value "" ## Remarks The password to authenticate to the proxy server. # proxy_port property The port on the proxy server to connect to. ## Syntax ```text def get_proxy_port() -> int: ... def set_proxy_port(value: int) -> None: ... proxy_port = property(get_proxy_port, set_proxy_port) ``` ## Default Value 0 ## Remarks The port on the proxy server to connect to. # proxy_type property The type of the proxy server. ## Syntax ```text def get_proxy_type() -> int: ... def set_proxy_type(value: int) -> None: ... proxy_type = property(get_proxy_type, set_proxy_type) ``` ## Possible Values ```text 0 # None1 # Socks42 # Socks53 # WebTunnel4 # HTTP ``` ## Default Value 0 ## Remarks The type of the proxy server. | | | | --- | --- | | cptNone | 0 | | cptSocks4 | 1 | | cptSocks5 | 2 | | cptWebTunnel | 3 | | cptHTTP | 4 | # proxy_request_headers property Contains HTTP request headers for WebTunnel and HTTP proxy. ## Syntax ```text def get_proxy_request_headers() -> str: ... def set_proxy_request_headers(value: str) -> None: ... proxy_request_headers = property(get_proxy_request_headers, set_proxy_request_headers) ``` ## Default Value "" ## Remarks Contains HTTP request headers for WebTunnel and HTTP proxy. # proxy_response_body property Contains the HTTP or HTTPS (WebTunnel) proxy response body. ## Syntax ```text def get_proxy_response_body() -> str: ... def set_proxy_response_body(value: str) -> None: ... proxy_response_body = property(get_proxy_response_body, set_proxy_response_body) ``` ## Default Value "" ## Remarks Contains the HTTP or HTTPS (WebTunnel) proxy response body. # proxy_response_headers property Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. ## Syntax ```text def get_proxy_response_headers() -> str: ... def set_proxy_response_headers(value: str) -> None: ... proxy_response_headers = property(get_proxy_response_headers, set_proxy_response_headers) ``` ## Default Value "" ## Remarks Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. # proxy_use_ipv6 property Specifies whether IPv6 should be used when connecting through the proxy. ## Syntax ```text def get_proxy_use_ipv6() -> bool: ... def set_proxy_use_ipv6(value: bool) -> None: ... proxy_use_ipv6 = property(get_proxy_use_ipv6, set_proxy_use_ipv6) ``` ## Default Value FALSE ## Remarks Specifies whether IPv6 should be used when connecting through the proxy. # proxy_username property Specifies the username credential for proxy authentication. ## Syntax ```text def get_proxy_username() -> str: ... def set_proxy_username(value: str) -> None: ... proxy_username = property(get_proxy_username, set_proxy_username) ``` ## Default Value "" ## Remarks Specifies the username credential for proxy authentication. # redirect_url property The URL where the user is redirected after authorization. ## Syntax ```text def get_redirect_url() -> str: ... def set_redirect_url(value: str) -> None: ... redirect_url = property(get_redirect_url, set_redirect_url) ``` ## Default Value "" ## Remarks Use this property to specify the URL on which the local HTTP server should open the listening port and wait for response from the authorization server. When the port number is explicitly specified, e.g., "http://localhost:5050/", the application has to be allowed to open a listening socket on that port. **HTTPS redirects support** Services increasingly require that redirects are made to HTTPS-enabled endpoints (e.g. "https://localhost:5050/"). OAuthClient does support them. What you need to do is set up the TLS server certificate that the OAuth receiver will be presenting to the user's web browser. The certificate is an integral part of the TLS handshake process. You can provide the certificate to the component using the redirect_url_chain property. The provided TLS certificate must contain a matching private key. You can generate the certificate using the [CertificateManager](CertificateManager.md#CertificateManager) component, or third-party software such as OpenSSL. Note that some browsers no longer accept self-signed TLS certificates, which typically means that you need to generate and set up a pair of certificates (the self-signed root certificate and the subordinate web server certificate) to make your receiver work with such browsers. # redirect_url_cert_count property The number of records in the RedirectURLCert arrays. ## Syntax ```text def get_redirect_url_cert_count() -> int: ... def set_redirect_url_cert_count(value: int) -> None: ... redirect_url_cert_count = property(get_redirect_url_cert_count, set_redirect_url_cert_count) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [redirect_url_cert_bytes](#redirect_url_cert_bytes-property) - [redirect_url_cert_handle](#redirect_url_cert_handle-property) The array indices start at *0* and end at *redirect_url_cert_count - 1*. # redirect_url_cert_bytes property Returns the raw certificate data in DER format. ## Syntax ```text def get_redirect_url_cert_bytes(redirect_url_cert_index: int) -> bytes: ... ``` ## Remarks Returns the raw certificate data in DER format. The *redirect_url_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [redirect_url_cert_count](#redirect_url_cert_count-property) property. This property is read-only. # redirect_url_cert_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_redirect_url_cert_handle(redirect_url_cert_index: int) -> int: ... def set_redirect_url_cert_handle(redirect_url_cert_index: int, value: int) -> None: ... ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *redirect_url_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [redirect_url_cert_count](#redirect_url_cert_count-property) property. # refresh_token property The refresh token, to be used to automatically obtain new access token. ## Syntax ```text def get_refresh_token() -> str: ... def set_refresh_token(value: str) -> None: ... refresh_token = property(get_refresh_token, set_refresh_token) ``` ## Default Value "" ## Remarks The refresh token is used to obtain new [access_token](#access_token-property) without user authentication. # scope property The scope of the request to be authorized. ## Syntax ```text def get_scope() -> str: ... def set_scope(value: str) -> None: ... scope = property(get_scope, set_scope) ``` ## Default Value "" ## Remarks Use this property to specify the scope of the request to the protected resource. # socket_dns_mode property Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system. ## Syntax ```text def get_socket_dns_mode() -> int: ... def set_socket_dns_mode(value: int) -> None: ... socket_dns_mode = property(get_socket_dns_mode, set_socket_dns_mode) ``` ## Possible Values ```text 0 # Auto1 # Platform2 # Own3 # OwnSecure ``` ## Default Value 0 ## Remarks Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system. | | | | --- | --- | | dmAuto | 0 | | dmPlatform | 1 | | dmOwn | 2 | | dmOwnSecure | 3 | # socket_dns_port property Specifies the port number to be used for sending queries to the DNS server. ## Syntax ```text def get_socket_dns_port() -> int: ... def set_socket_dns_port(value: int) -> None: ... socket_dns_port = property(get_socket_dns_port, set_socket_dns_port) ``` ## Default Value 0 ## Remarks Specifies the port number to be used for sending queries to the DNS server. # socket_dns_query_timeout property The timeout (in milliseconds) for each DNS query. ## Syntax ```text def get_socket_dns_query_timeout() -> int: ... def set_socket_dns_query_timeout(value: int) -> None: ... socket_dns_query_timeout = property(get_socket_dns_query_timeout, set_socket_dns_query_timeout) ``` ## Default Value 0 ## Remarks The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout. # socket_dns_servers property The addresses of DNS servers to use for address resolution, separated by commas or semicolons. ## Syntax ```text def get_socket_dns_servers() -> str: ... def set_socket_dns_servers(value: str) -> None: ... socket_dns_servers = property(get_socket_dns_servers, set_socket_dns_servers) ``` ## Default Value "" ## Remarks The addresses of DNS servers to use for address resolution, separated by commas or semicolons. # socket_dns_total_timeout property The timeout (in milliseconds) for the whole resolution process. ## Syntax ```text def get_socket_dns_total_timeout() -> int: ... def set_socket_dns_total_timeout(value: int) -> None: ... socket_dns_total_timeout = property(get_socket_dns_total_timeout, set_socket_dns_total_timeout) ``` ## Default Value 0 ## Remarks The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout. # socket_incoming_speed_limit property The maximum number of bytes to read from the socket, per second. ## Syntax ```text def get_socket_incoming_speed_limit() -> int: ... def set_socket_incoming_speed_limit(value: int) -> None: ... socket_incoming_speed_limit = property(get_socket_incoming_speed_limit, set_socket_incoming_speed_limit) ``` ## Default Value 0 ## Remarks The maximum number of bytes to read from the socket, per second. # socket_local_address property The local network interface to bind the socket to. ## Syntax ```text def get_socket_local_address() -> str: ... def set_socket_local_address(value: str) -> None: ... socket_local_address = property(get_socket_local_address, set_socket_local_address) ``` ## Default Value "" ## Remarks The local network interface to bind the socket to. # socket_local_port property The local port number to bind the socket to. ## Syntax ```text def get_socket_local_port() -> int: ... def set_socket_local_port(value: int) -> None: ... socket_local_port = property(get_socket_local_port, set_socket_local_port) ``` ## Default Value 0 ## Remarks The local port number to bind the socket to. # socket_outgoing_speed_limit property The maximum number of bytes to write to the socket, per second. ## Syntax ```text def get_socket_outgoing_speed_limit() -> int: ... def set_socket_outgoing_speed_limit(value: int) -> None: ... socket_outgoing_speed_limit = property(get_socket_outgoing_speed_limit, set_socket_outgoing_speed_limit) ``` ## Default Value 0 ## Remarks The maximum number of bytes to write to the socket, per second. # socket_timeout property The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. ## Syntax ```text def get_socket_timeout() -> int: ... def set_socket_timeout(value: int) -> None: ... socket_timeout = property(get_socket_timeout, set_socket_timeout) ``` ## Default Value 60000 ## Remarks The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. If *Timeout* is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack). # socket_use_ipv6 property Enables or disables IP protocol version 6. ## Syntax ```text def get_socket_use_ipv6() -> bool: ... def set_socket_use_ipv6(value: bool) -> None: ... socket_use_ipv6 = property(get_socket_use_ipv6, set_socket_use_ipv6) ``` ## Default Value FALSE ## Remarks Enables or disables IP protocol version 6. # state property Specifies the state parameter of the authorization request or response. ## Syntax ```text def get_state() -> str: ... def set_state(value: str) -> None: ... state = property(get_state, set_state) ``` ## Default Value "" ## Remarks This parameter contains an opaque value used by the client to maintain state between the request and callback. If this parameter was present in the authorization request, the server should include the same value in its response. # success_response property The web page showed to the user by the class on authorization success. ## Syntax ```text def get_success_response() -> str: ... def set_success_response(value: str) -> None: ... success_response = property(get_success_response, set_success_response) ``` ## Default Value "" ## Remarks This property contains the html of the web page to be shown on authorization success. # timeout property Specifies waiting timeout (in milliseconds). ## Syntax ```text def get_timeout() -> int: ... def set_timeout(value: int) -> None: ... timeout = property(get_timeout, set_timeout) ``` ## Default Value 120000 ## Remarks This property specifies the timeout (in milliseconds) to wait for server's response. # tls_auto_validate_certificates property Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. ## Syntax ```text def get_tls_auto_validate_certificates() -> bool: ... def set_tls_auto_validate_certificates(value: bool) -> None: ... tls_auto_validate_certificates = property(get_tls_auto_validate_certificates, set_tls_auto_validate_certificates) ``` ## Default Value TRUE ## Remarks Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. # tls_base_configuration property Selects the base configuration for the TLS settings. ## Syntax ```text def get_tls_base_configuration() -> int: ... def set_tls_base_configuration(value: int) -> None: ... tls_base_configuration = property(get_tls_base_configuration, set_tls_base_configuration) ``` ## Possible Values ```text 0 # Default1 # Compatible2 # ComprehensiveInsecure3 # HighlySecure ``` ## Default Value 0 ## Remarks Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility. | | | | | --- | --- | --- | | stpcDefault | 0 | | | stpcCompatible | 1 | | | stpcComprehensiveInsecure | 2 | | | stpcHighlySecure | 3 | | # tls_ciphersuites property A list of ciphersuites separated with commas or semicolons. ## Syntax ```text def get_tls_ciphersuites() -> str: ... def set_tls_ciphersuites(value: str) -> None: ... tls_ciphersuites = property(get_tls_ciphersuites, set_tls_ciphersuites) ``` ## Default Value "" ## Remarks A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the *all* (and *-all*) aliases, allowing all ciphersuites to be blanketly enabled or disabled at once. Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by [tls_base_configuration](#tls_base_configuration-property). Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below: - NULL_NULL_NULL - RSA_NULL_MD5 - RSA_NULL_SHA - RSA_RC4_MD5 - RSA_RC4_SHA - RSA_RC2_MD5 - RSA_IDEA_MD5 - RSA_IDEA_SHA - RSA_DES_MD5 - RSA_DES_SHA - RSA_3DES_MD5 - RSA_3DES_SHA - RSA_AES128_SHA - RSA_AES256_SHA - DH_DSS_DES_SHA - DH_DSS_3DES_SHA - DH_DSS_AES128_SHA - DH_DSS_AES256_SHA - DH_RSA_DES_SHA - DH_RSA_3DES_SHA - DH_RSA_AES128_SHA - DH_RSA_AES256_SHA - DHE_DSS_DES_SHA - DHE_DSS_3DES_SHA - DHE_DSS_AES128_SHA - DHE_DSS_AES256_SHA - DHE_RSA_DES_SHA - DHE_RSA_3DES_SHA - DHE_RSA_AES128_SHA - DHE_RSA_AES256_SHA - DH_ANON_RC4_MD5 - DH_ANON_DES_SHA - DH_ANON_3DES_SHA - DH_ANON_AES128_SHA - DH_ANON_AES256_SHA - RSA_RC2_MD5_EXPORT - RSA_RC4_MD5_EXPORT - RSA_DES_SHA_EXPORT - DH_DSS_DES_SHA_EXPORT - DH_RSA_DES_SHA_EXPORT - DHE_DSS_DES_SHA_EXPORT - DHE_RSA_DES_SHA_EXPORT - DH_ANON_RC4_MD5_EXPORT - DH_ANON_DES_SHA_EXPORT - RSA_CAMELLIA128_SHA - DH_DSS_CAMELLIA128_SHA - DH_RSA_CAMELLIA128_SHA - DHE_DSS_CAMELLIA128_SHA - DHE_RSA_CAMELLIA128_SHA - DH_ANON_CAMELLIA128_SHA - RSA_CAMELLIA256_SHA - DH_DSS_CAMELLIA256_SHA - DH_RSA_CAMELLIA256_SHA - DHE_DSS_CAMELLIA256_SHA - DHE_RSA_CAMELLIA256_SHA - DH_ANON_CAMELLIA256_SHA - PSK_RC4_SHA - PSK_3DES_SHA - PSK_AES128_SHA - PSK_AES256_SHA - DHE_PSK_RC4_SHA - DHE_PSK_3DES_SHA - DHE_PSK_AES128_SHA - DHE_PSK_AES256_SHA - RSA_PSK_RC4_SHA - RSA_PSK_3DES_SHA - RSA_PSK_AES128_SHA - RSA_PSK_AES256_SHA - RSA_SEED_SHA - DH_DSS_SEED_SHA - DH_RSA_SEED_SHA - DHE_DSS_SEED_SHA - DHE_RSA_SEED_SHA - DH_ANON_SEED_SHA - SRP_SHA_3DES_SHA - SRP_SHA_RSA_3DES_SHA - SRP_SHA_DSS_3DES_SHA - SRP_SHA_AES128_SHA - SRP_SHA_RSA_AES128_SHA - SRP_SHA_DSS_AES128_SHA - SRP_SHA_AES256_SHA - SRP_SHA_RSA_AES256_SHA - SRP_SHA_DSS_AES256_SHA - ECDH_ECDSA_NULL_SHA - ECDH_ECDSA_RC4_SHA - ECDH_ECDSA_3DES_SHA - ECDH_ECDSA_AES128_SHA - ECDH_ECDSA_AES256_SHA - ECDHE_ECDSA_NULL_SHA - ECDHE_ECDSA_RC4_SHA - ECDHE_ECDSA_3DES_SHA - ECDHE_ECDSA_AES128_SHA - ECDHE_ECDSA_AES256_SHA - ECDH_RSA_NULL_SHA - ECDH_RSA_RC4_SHA - ECDH_RSA_3DES_SHA - ECDH_RSA_AES128_SHA - ECDH_RSA_AES256_SHA - ECDHE_RSA_NULL_SHA - ECDHE_RSA_RC4_SHA - ECDHE_RSA_3DES_SHA - ECDHE_RSA_AES128_SHA - ECDHE_RSA_AES256_SHA - ECDH_ANON_NULL_SHA - ECDH_ANON_RC4_SHA - ECDH_ANON_3DES_SHA - ECDH_ANON_AES128_SHA - ECDH_ANON_AES256_SHA - RSA_NULL_SHA256 - RSA_AES128_SHA256 - RSA_AES256_SHA256 - DH_DSS_AES128_SHA256 - DH_RSA_AES128_SHA256 - DHE_DSS_AES128_SHA256 - DHE_RSA_AES128_SHA256 - DH_DSS_AES256_SHA256 - DH_RSA_AES256_SHA256 - DHE_DSS_AES256_SHA256 - DHE_RSA_AES256_SHA256 - DH_ANON_AES128_SHA256 - DH_ANON_AES256_SHA256 - RSA_AES128_GCM_SHA256 - RSA_AES256_GCM_SHA384 - DHE_RSA_AES128_GCM_SHA256 - DHE_RSA_AES256_GCM_SHA384 - DH_RSA_AES128_GCM_SHA256 - DH_RSA_AES256_GCM_SHA384 - DHE_DSS_AES128_GCM_SHA256 - DHE_DSS_AES256_GCM_SHA384 - DH_DSS_AES128_GCM_SHA256 - DH_DSS_AES256_GCM_SHA384 - DH_ANON_AES128_GCM_SHA256 - DH_ANON_AES256_GCM_SHA384 - ECDHE_ECDSA_AES128_SHA256 - ECDHE_ECDSA_AES256_SHA384 - ECDH_ECDSA_AES128_SHA256 - ECDH_ECDSA_AES256_SHA384 - ECDHE_RSA_AES128_SHA256 - ECDHE_RSA_AES256_SHA384 - ECDH_RSA_AES128_SHA256 - ECDH_RSA_AES256_SHA384 - ECDHE_ECDSA_AES128_GCM_SHA256 - ECDHE_ECDSA_AES256_GCM_SHA384 - ECDH_ECDSA_AES128_GCM_SHA256 - ECDH_ECDSA_AES256_GCM_SHA384 - ECDHE_RSA_AES128_GCM_SHA256 - ECDHE_RSA_AES256_GCM_SHA384 - ECDH_RSA_AES128_GCM_SHA256 - ECDH_RSA_AES256_GCM_SHA384 - PSK_AES128_GCM_SHA256 - PSK_AES256_GCM_SHA384 - DHE_PSK_AES128_GCM_SHA256 - DHE_PSK_AES256_GCM_SHA384 - RSA_PSK_AES128_GCM_SHA256 - RSA_PSK_AES256_GCM_SHA384 - PSK_AES128_SHA256 - PSK_AES256_SHA384 - PSK_NULL_SHA256 - PSK_NULL_SHA384 - DHE_PSK_AES128_SHA256 - DHE_PSK_AES256_SHA384 - DHE_PSK_NULL_SHA256 - DHE_PSK_NULL_SHA384 - RSA_PSK_AES128_SHA256 - RSA_PSK_AES256_SHA384 - RSA_PSK_NULL_SHA256 - RSA_PSK_NULL_SHA384 - RSA_CAMELLIA128_SHA256 - DH_DSS_CAMELLIA128_SHA256 - DH_RSA_CAMELLIA128_SHA256 - DHE_DSS_CAMELLIA128_SHA256 - DHE_RSA_CAMELLIA128_SHA256 - DH_ANON_CAMELLIA128_SHA256 - RSA_CAMELLIA256_SHA256 - DH_DSS_CAMELLIA256_SHA256 - DH_RSA_CAMELLIA256_SHA256 - DHE_DSS_CAMELLIA256_SHA256 - DHE_RSA_CAMELLIA256_SHA256 - DH_ANON_CAMELLIA256_SHA256 - ECDHE_ECDSA_CAMELLIA128_SHA256 - ECDHE_ECDSA_CAMELLIA256_SHA384 - ECDH_ECDSA_CAMELLIA128_SHA256 - ECDH_ECDSA_CAMELLIA256_SHA384 - ECDHE_RSA_CAMELLIA128_SHA256 - ECDHE_RSA_CAMELLIA256_SHA384 - ECDH_RSA_CAMELLIA128_SHA256 - ECDH_RSA_CAMELLIA256_SHA384 - RSA_CAMELLIA128_GCM_SHA256 - RSA_CAMELLIA256_GCM_SHA384 - DHE_RSA_CAMELLIA128_GCM_SHA256 - DHE_RSA_CAMELLIA256_GCM_SHA384 - DH_RSA_CAMELLIA128_GCM_SHA256 - DH_RSA_CAMELLIA256_GCM_SHA384 - DHE_DSS_CAMELLIA128_GCM_SHA256 - DHE_DSS_CAMELLIA256_GCM_SHA384 - DH_DSS_CAMELLIA128_GCM_SHA256 - DH_DSS_CAMELLIA256_GCM_SHA384 - DH_anon_CAMELLIA128_GCM_SHA256 - DH_anon_CAMELLIA256_GCM_SHA384 - ECDHE_ECDSA_CAMELLIA128_GCM_SHA256 - ECDHE_ECDSA_CAMELLIA256_GCM_SHA384 - ECDH_ECDSA_CAMELLIA128_GCM_SHA256 - ECDH_ECDSA_CAMELLIA256_GCM_SHA384 - ECDHE_RSA_CAMELLIA128_GCM_SHA256 - ECDHE_RSA_CAMELLIA256_GCM_SHA384 - ECDH_RSA_CAMELLIA128_GCM_SHA256 - ECDH_RSA_CAMELLIA256_GCM_SHA384 - PSK_CAMELLIA128_GCM_SHA256 - PSK_CAMELLIA256_GCM_SHA384 - DHE_PSK_CAMELLIA128_GCM_SHA256 - DHE_PSK_CAMELLIA256_GCM_SHA384 - RSA_PSK_CAMELLIA128_GCM_SHA256 - RSA_PSK_CAMELLIA256_GCM_SHA384 - PSK_CAMELLIA128_SHA256 - PSK_CAMELLIA256_SHA384 - DHE_PSK_CAMELLIA128_SHA256 - DHE_PSK_CAMELLIA256_SHA384 - RSA_PSK_CAMELLIA128_SHA256 - RSA_PSK_CAMELLIA256_SHA384 - ECDHE_PSK_CAMELLIA128_SHA256 - ECDHE_PSK_CAMELLIA256_SHA384 - ECDHE_PSK_RC4_SHA - ECDHE_PSK_3DES_SHA - ECDHE_PSK_AES128_SHA - ECDHE_PSK_AES256_SHA - ECDHE_PSK_AES128_SHA256 - ECDHE_PSK_AES256_SHA384 - ECDHE_PSK_NULL_SHA - ECDHE_PSK_NULL_SHA256 - ECDHE_PSK_NULL_SHA384 - ECDHE_RSA_CHACHA20_POLY1305_SHA256 - ECDHE_ECDSA_CHACHA20_POLY1305_SHA256 - DHE_RSA_CHACHA20_POLY1305_SHA256 - PSK_CHACHA20_POLY1305_SHA256 - ECDHE_PSK_CHACHA20_POLY1305_SHA256 - DHE_PSK_CHACHA20_POLY1305_SHA256 - RSA_PSK_CHACHA20_POLY1305_SHA256 - AES128_GCM_SHA256 - AES256_GCM_SHA384 - CHACHA20_POLY1305_SHA256 - AES128_CCM_SHA256 - AES128_CCM8_SHA256 # tls_client_auth property Enables or disables certificate-based client authentication. ## Syntax ```text def get_tls_client_auth() -> int: ... def set_tls_client_auth(value: int) -> None: ... tls_client_auth = property(get_tls_client_auth, set_tls_client_auth) ``` ## Possible Values ```text 0 # NoAuth1 # RequestCert2 # RequireCert ``` ## Default Value 0 ## Remarks Enables or disables certificate-based client authentication. Set this property to true to tune up the client authentication type: | | | | | --- | --- | --- | | ccatNoAuth | 0 | | | ccatRequestCert | 1 | | | ccatRequireCert | 2 | | # tls_extensions property Provides access to TLS extensions. ## Syntax ```text def get_tls_extensions() -> str: ... def set_tls_extensions(value: str) -> None: ... tls_extensions = property(get_tls_extensions, set_tls_extensions) ``` ## Default Value "" ## Remarks Provides access to TLS extensions. # tls_force_resume_if_destination_changes property Whether to force TLS session resumption when the destination address changes. ## Syntax ```text def get_tls_force_resume_if_destination_changes() -> bool: ... def set_tls_force_resume_if_destination_changes(value: bool) -> None: ... tls_force_resume_if_destination_changes = property(get_tls_force_resume_if_destination_changes, set_tls_force_resume_if_destination_changes) ``` ## Default Value FALSE ## Remarks Whether to force TLS session resumption when the destination address changes. # tls_groups property Specifies a list of key exchange groups to attempt during the TLS key exchange. ## Syntax ```text def get_tls_groups() -> str: ... def set_tls_groups(value: str) -> None: ... tls_groups = property(get_tls_groups, set_tls_groups) ``` ## Default Value "" ## Remarks Specifies a list of key exchange groups to attempt during the TLS key exchange. Keep this setting at its default value (empty string) to stick with the default list of key exchange groups. You can tweak the list by using '+' and '-' modifiers that are immediately followed by a group name or the *all* placeholder: ```text // Ensure the two x25519-based groups are enabled and the finite field DHE2048 is disabled client.TLSSettings.Groups = "+x25519mlkem768;+x25519;-ffdhe2048"; // Only enable the hybrid X25519/ML-KEM768 group client.TLSSettings.Groups = "-all;+x25519mlkem768"; ``` The list of groups supported by the component is provided below. All the names are case-insensitive: **Elliptic curve-based groups:** - SECT163K1 - SECT163R1 - SECT163R2 - SECT193R1 - SECT193R2 - SECT233K1 - SECT233R1 - SECT239K1 - SECT283K1 - SECT283R1 - SECT409K1 - SECT409R1 - SECT571K1 - SECT571R1 - SECP160K1 - SECP160R1 - SECP160R2 - SECP192K1 - SECP192R1 - SECP224K1 - SECP224R1 - SECP256K1 - SECP256R1 - SECP384R1 - SECP521R1 - BRAINPOOLP256R1 - BRAINPOOLP384R1 - BRAINPOOLP512R1 - X25519 - X448 **Finite field-based groups:** - FFDHE2048 - FFDHE3072 - FFDHE4096 - FFDHE6144 - FFDHE8192 **Post-Quantum and Hybrid groups:** - MLKEM512 - MLKEM768 - MLKEM1024 - SECP256R1MLKEM768 - X25519MLKEM768 - SECP384R1MLKEM1024 Note: this property was called *ECCurves* in SecureBlackbox 2024 and older. # tls_pre_shared_identity property Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. ## Syntax ```text def get_tls_pre_shared_identity() -> str: ... def set_tls_pre_shared_identity(value: str) -> None: ... tls_pre_shared_identity = property(get_tls_pre_shared_identity, set_tls_pre_shared_identity) ``` ## Default Value "" ## Remarks Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. # tls_pre_shared_key property Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. ## Syntax ```text def get_tls_pre_shared_key() -> str: ... def set_tls_pre_shared_key(value: str) -> None: ... tls_pre_shared_key = property(get_tls_pre_shared_key, set_tls_pre_shared_key) ``` ## Default Value "" ## Remarks Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. # tls_pre_shared_key_ciphersuite property Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. ## Syntax ```text def get_tls_pre_shared_key_ciphersuite() -> str: ... def set_tls_pre_shared_key_ciphersuite(value: str) -> None: ... tls_pre_shared_key_ciphersuite = property(get_tls_pre_shared_key_ciphersuite, set_tls_pre_shared_key_ciphersuite) ``` ## Default Value "" ## Remarks Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. # tls_renegotiation_attack_prevention_mode property Selects the renegotiation attack prevention mechanism. ## Syntax ```text def get_tls_renegotiation_attack_prevention_mode() -> int: ... def set_tls_renegotiation_attack_prevention_mode(value: int) -> None: ... tls_renegotiation_attack_prevention_mode = property(get_tls_renegotiation_attack_prevention_mode, set_tls_renegotiation_attack_prevention_mode) ``` ## Possible Values ```text 0 # Compatible1 # Strict2 # Auto ``` ## Default Value 2 ## Remarks Selects the renegotiation attack prevention mechanism. The following options are available: | | | | | --- | --- | --- | | crapmCompatible | 0 | TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled). | | crapmStrict | 1 | Renegotiation attack prevention is enabled and enforced. | | crapmAuto | 2 | Automatically choose whether to enable or disable renegotiation attack prevention. | # tls_revocation_check property Specifies the kind(s) of revocation check to perform. ## Syntax ```text def get_tls_revocation_check() -> int: ... def set_tls_revocation_check(value: int) -> None: ... tls_revocation_check = property(get_tls_revocation_check, set_tls_revocation_check) ``` ## Possible Values ```text 0 # None1 # Auto2 # AllCRL3 # AllOCSP4 # AllCRLAndOCSP5 # AnyCRL6 # AnyOCSP7 # AnyCRLOrOCSP8 # AnyOCSPOrCRL ``` ## Default Value 1 ## Remarks Specifies the kind(s) of revocation check to perform. Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information. | | | | | --- | --- | --- | | crcNone | 0 | No revocation checking. | | crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. | | crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. | | crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. | | crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. | | crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. | | crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. | | crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. | | crcAnyOCSPOrCRL | 8 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first. | This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time. There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs). This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential. NOTE: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable. NOTE: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails. # tls_ssl_options property Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size. ## Syntax ```text def get_tls_ssl_options() -> int: ... def set_tls_ssl_options(value: int) -> None: ... tls_ssl_options = property(get_tls_ssl_options, set_tls_ssl_options) ``` ## Default Value 16 ## Remarks Various SSL (TLS) protocol options, set of | | | | | --- | --- | --- | | cssloExpectShutdownMessage | 0x001 | Wait for the close-notify message when shutting down the connection | | cssloOpenSSLDTLSWorkaround | 0x002 | (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions | | cssloDisableKexLengthAlignment | 0x004 | Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it. | | cssloForceUseOfClientCertHashAlg | 0x008 | Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it. | | cssloAutoAddServerNameExtension | 0x010 | Automatically add the server name extension when known | | cssloAcceptTrustedSRPPrimesOnly | 0x020 | Accept trusted SRP primes only | | cssloDisableSignatureAlgorithmsExtension | 0x040 | Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it. | | cssloIntolerateHigherProtocolVersions | 0x080 | (server option) Do not allow fallback from TLS versions higher than currently enabled | | cssloStickToPrefCertHashAlg | 0x100 | Stick to preferred certificate hash algorithms | | cssloNoImplicitTLS12Fallback | 0x200 | Disable implicit TLS 1.3 to 1.2 fallbacks | | cssloUseHandshakeBatches | 0x400 | Send the handshake message as large batches rather than individually | # tls_mode property Specifies the TLS mode to use. ## Syntax ```text def get_tls_mode() -> int: ... def set_tls_mode(value: int) -> None: ... tls_mode = property(get_tls_mode, set_tls_mode) ``` ## Possible Values ```text 0 # Default1 # NoTLS2 # ExplicitTLS3 # ImplicitTLS4 # MixedTLS ``` ## Default Value 0 ## Remarks Specifies the TLS mode to use. | | | | | --- | --- | --- | | smDefault | 0 | | | smNoTLS | 1 | Do not use TLS | | smExplicitTLS | 2 | Connect to the server without any encryption and then request an SSL session. | | smImplicitTLS | 3 | Connect to the specified port, and establish the SSL session at once. | | smMixedTLS | 4 | Connect to the specified port, and establish the SSL session at once, but allow plain data. | # tls_use_extended_master_secret property Enables the Extended Master Secret Extension, as defined in RFC 7627. ## Syntax ```text def get_tls_use_extended_master_secret() -> bool: ... def set_tls_use_extended_master_secret(value: bool) -> None: ... tls_use_extended_master_secret = property(get_tls_use_extended_master_secret, set_tls_use_extended_master_secret) ``` ## Default Value TRUE ## Remarks Enables the Extended Master Secret Extension, as defined in RFC 7627. # tls_use_session_resumption property Enables or disables the TLS session resumption capability. ## Syntax ```text def get_tls_use_session_resumption() -> bool: ... def set_tls_use_session_resumption(value: bool) -> None: ... tls_use_session_resumption = property(get_tls_use_session_resumption, set_tls_use_session_resumption) ``` ## Default Value FALSE ## Remarks Enables or disables the TLS session resumption capability. # tls_versions property The SSL/TLS versions to enable by default. ## Syntax ```text def get_tls_versions() -> int: ... def set_tls_versions(value: int) -> None: ... tls_versions = property(get_tls_versions, set_tls_versions) ``` ## Default Value 48 ## Remarks The SSL/TLS versions to enable by default. | | | | | --- | --- | --- | | csbSSL2 | 0x01 | SSL 2 | | csbSSL3 | 0x02 | SSL 3 | | csbTLS1 | 0x04 | TLS 1.0 | | csbTLS11 | 0x08 | TLS 1.1 | | csbTLS12 | 0x10 | TLS 1.2 | | csbTLS13 | 0x20 | TLS 1.3 | # tls_client_cert_count property The number of records in the TLSClientCert arrays. ## Syntax ```text def get_tls_client_cert_count() -> int: ... def set_tls_client_cert_count(value: int) -> None: ... tls_client_cert_count = property(get_tls_client_cert_count, set_tls_client_cert_count) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [tls_client_cert_bytes](#tls_client_cert_bytes-property) - [tls_client_cert_handle](#tls_client_cert_handle-property) The array indices start at *0* and end at *tls_client_cert_count - 1*. # tls_client_cert_bytes property Returns the raw certificate data in DER format. ## Syntax ```text def get_tls_client_cert_bytes(tls_client_cert_index: int) -> bytes: ... ``` ## Remarks Returns the raw certificate data in DER format. The *tls_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [tls_client_cert_count](#tls_client_cert_count-property) property. This property is read-only. # tls_client_cert_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_tls_client_cert_handle(tls_client_cert_index: int) -> int: ... def set_tls_client_cert_handle(tls_client_cert_index: int, value: int) -> None: ... ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *tls_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [tls_client_cert_count](#tls_client_cert_count-property) property. # tls_server_cert_count property The number of records in the TLSServerCert arrays. ## Syntax ```text def get_tls_server_cert_count() -> int: ... tls_server_cert_count = property(get_tls_server_cert_count, None) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [tls_server_cert_bytes](#tls_server_cert_bytes-property) - [tls_server_cert_fingerprint](#tls_server_cert_fingerprint-property) - [tls_server_cert_handle](#tls_server_cert_handle-property) - [tls_server_cert_issuer](#tls_server_cert_issuer-property) - [tls_server_cert_issuer_rdn](#tls_server_cert_issuer_rdn-property) - [tls_server_cert_key_algorithm](#tls_server_cert_key_algorithm-property) - [tls_server_cert_key_bits](#tls_server_cert_key_bits-property) - [tls_server_cert_key_usage](#tls_server_cert_key_usage-property) - [tls_server_cert_self_signed](#tls_server_cert_self_signed-property) - [tls_server_cert_serial_number](#tls_server_cert_serial_number-property) - [tls_server_cert_sig_algorithm](#tls_server_cert_sig_algorithm-property) - [tls_server_cert_subject](#tls_server_cert_subject-property) - [tls_server_cert_subject_rdn](#tls_server_cert_subject_rdn-property) - [tls_server_cert_valid_from](#tls_server_cert_valid_from-property) - [tls_server_cert_valid_to](#tls_server_cert_valid_to-property) The array indices start at *0* and end at *tls_server_cert_count - 1*. This property is read-only. # tls_server_cert_bytes property Returns the raw certificate data in DER format. ## Syntax ```text def get_tls_server_cert_bytes(tls_server_cert_index: int) -> bytes: ... ``` ## Remarks Returns the raw certificate data in DER format. The *tls_server_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [tls_server_cert_count](#tls_server_cert_count-property) property. This property is read-only. # tls_server_cert_fingerprint property Contains the fingerprint (a hash imprint) of this certificate. ## Syntax ```text def get_tls_server_cert_fingerprint(tls_server_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks Contains the fingerprint (a hash imprint) of this certificate. While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used. The *tls_server_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [tls_server_cert_count](#tls_server_cert_count-property) property. This property is read-only. # tls_server_cert_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_tls_server_cert_handle(tls_server_cert_index: int) -> int: ... ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *tls_server_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [tls_server_cert_count](#tls_server_cert_count-property) property. This property is read-only. # tls_server_cert_issuer property The common name of the certificate issuer (CA), typically a company name. ## Syntax ```text def get_tls_server_cert_issuer(tls_server_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via [tls_issuer_rdn](#OAuthClient_p_TLSIssuerRDN). The *tls_server_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [tls_server_cert_count](#tls_server_cert_count-property) property. This property is read-only. # tls_server_cert_issuer_rdn property A list of Property=Value pairs that uniquely identify the certificate issuer. ## Syntax ```text def get_tls_server_cert_issuer_rdn(tls_server_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks A list of *Property=Value* pairs that uniquely identify the certificate issuer. Example: */C=US/O=Nationwide CA/CN=Web Certification Authority* The *tls_server_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [tls_server_cert_count](#tls_server_cert_count-property) property. This property is read-only. # tls_server_cert_key_algorithm property Specifies the public key algorithm of this certificate. ## Syntax ```text def get_tls_server_cert_key_algorithm(tls_server_cert_index: int) -> str: ... ``` ## Default Value "0" ## Remarks Specifies the public key algorithm of this certificate. | | | | | --- | --- | --- | | SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | | | SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | | | SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | | | SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA | id-dsa | | | SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | | | SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | | | SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | | | SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | | | SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | | | SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | | | SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | | | SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | | | SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | | | SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | | | SB_CERT_ALGORITHM_EC | id-ecPublicKey | | | SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | | | SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | | | SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | | | SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | | | SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | | | SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | | | SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | | | SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | | | SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | | | SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | | | SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | | | SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | | | SB_CERT_ALGORITHM_EDDSA | id-EdDSA | | | SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig | | | SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 | | | SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 | | | SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 | | | SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 | | | SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 | | | SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 | | | SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 | | Use the [tls_key_bits](#OAuthClient_p_TLSKeyBits), [tls_curve](#OAuthClient_p_TLSCurve), and [tls_public_key_bytes](#OAuthClient_p_TLSPublicKeyBytes) properties to get more details about the key the certificate contains. The *tls_server_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [tls_server_cert_count](#tls_server_cert_count-property) property. This property is read-only. # tls_server_cert_key_bits property Returns the length of the public key in bits. ## Syntax ```text def get_tls_server_cert_key_bits(tls_server_cert_index: int) -> int: ... ``` ## Default Value 0 ## Remarks Returns the length of the public key in bits. This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the [tls_public_key_bytes](#OAuthClient_p_TLSPublicKeyBytes) or [tls_private_key_bytes](#OAuthClient_p_TLSPrivateKeyBytes) property would typically contain auxiliary values, and therefore be longer. The *tls_server_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [tls_server_cert_count](#tls_server_cert_count-property) property. This property is read-only. # tls_server_cert_key_usage property Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. ## Syntax ```text def get_tls_server_cert_key_usage(tls_server_cert_index: int) -> int: ... ``` ## Default Value 0 ## Remarks Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. This value is a bit mask of the following values: | | | | | --- | --- | --- | | ckuUnknown | 0x00000 | Unknown key usage | | ckuDigitalSignature | 0x00001 | Digital signature | | ckuNonRepudiation | 0x00002 | Non-repudiation | | ckuKeyEncipherment | 0x00004 | Key encipherment | | ckuDataEncipherment | 0x00008 | Data encipherment | | ckuKeyAgreement | 0x00010 | Key agreement | | ckuKeyCertSign | 0x00020 | Certificate signing | | ckuCRLSign | 0x00040 | Revocation signing | | ckuEncipherOnly | 0x00080 | Encipher only | | ckuDecipherOnly | 0x00100 | Decipher only | | ckuServerAuthentication | 0x00200 | Server authentication | | ckuClientAuthentication | 0x00400 | Client authentication | | ckuCodeSigning | 0x00800 | Code signing | | ckuEmailProtection | 0x01000 | Email protection | | ckuTimeStamping | 0x02000 | Timestamping | | ckuOCSPSigning | 0x04000 | OCSP signing | | ckuSmartCardLogon | 0x08000 | Smartcard logon | | ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication | | ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC | Set this property before generating the certificate to propagate the key usage flags to the new certificate. The *tls_server_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [tls_server_cert_count](#tls_server_cert_count-property) property. This property is read-only. # tls_server_cert_self_signed property Indicates whether the certificate is self-signed (root) or signed by an external CA. ## Syntax ```text def get_tls_server_cert_self_signed(tls_server_cert_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Indicates whether the certificate is self-signed (root) or signed by an external CA. The *tls_server_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [tls_server_cert_count](#tls_server_cert_count-property) property. This property is read-only. # tls_server_cert_serial_number property Returns the certificate's serial number. ## Syntax ```text def get_tls_server_cert_serial_number(tls_server_cert_index: int) -> bytes: ... ``` ## Remarks Returns the certificate's serial number. The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building. The *tls_server_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [tls_server_cert_count](#tls_server_cert_count-property) property. This property is read-only. # tls_server_cert_sig_algorithm property Indicates the algorithm that was used by the CA to sign this certificate. ## Syntax ```text def get_tls_server_cert_sig_algorithm(tls_server_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks Indicates the algorithm that was used by the CA to sign this certificate. A signature algorithm typically combines hash and public key algorithms together, such as *sha256WithRSAEncryption* or *ecdsa-with-SHA256*. The *tls_server_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [tls_server_cert_count](#tls_server_cert_count-property) property. This property is read-only. # tls_server_cert_subject property The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. ## Syntax ```text def get_tls_server_cert_subject(tls_server_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via [tls_subject_rdn](#OAuthClient_p_TLSSubjectRDN). The *tls_server_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [tls_server_cert_count](#tls_server_cert_count-property) property. This property is read-only. # tls_server_cert_subject_rdn property A list of Property=Value pairs that uniquely identify the certificate holder (subject). ## Syntax ```text def get_tls_server_cert_subject_rdn(tls_server_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks A list of *Property=Value* pairs that uniquely identify the certificate holder (subject). Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data. Example: */C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins*. The *tls_server_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [tls_server_cert_count](#tls_server_cert_count-property) property. This property is read-only. # tls_server_cert_valid_from property The time point at which the certificate becomes valid, in UTC. ## Syntax ```text def get_tls_server_cert_valid_from(tls_server_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The time point at which the certificate becomes valid, in UTC. The *tls_server_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [tls_server_cert_count](#tls_server_cert_count-property) property. This property is read-only. # tls_server_cert_valid_to property The time point at which the certificate expires, in UTC. ## Syntax ```text def get_tls_server_cert_valid_to(tls_server_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The time point at which the certificate expires, in UTC. The *tls_server_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [tls_server_cert_count](#tls_server_cert_count-property) property. This property is read-only. # token_type property Returns the access token type. ## Syntax ```text def get_token_type() -> str: ... token_type = property(get_token_type, None) ``` ## Default Value "" ## Remarks The access token type provides a client with the information on how to use the [access_token](#access_token-property). The understanding of token type is the client's responsibility. Some token types are described, for instance, in [RFC 6750](https://tools.ietf.org/html/rfc6750) and OAuth-HTTP-MAC specifications. This property is read-only. # token_url property Specifies the URL of the token endpoint. ## Syntax ```text def get_token_url() -> str: ... def set_token_url(value: str) -> None: ... token_url = property(get_token_url, set_token_url) ``` ## Default Value "" ## Remarks The token endpoint is used by the client, which needs access to protected resource, to obtain access token from the authorization server. # trusted_cert_count property The number of records in the TrustedCert arrays. ## Syntax ```text def get_trusted_cert_count() -> int: ... def set_trusted_cert_count(value: int) -> None: ... trusted_cert_count = property(get_trusted_cert_count, set_trusted_cert_count) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [trusted_cert_bytes](#trusted_cert_bytes-property) - [trusted_cert_handle](#trusted_cert_handle-property) The array indices start at *0* and end at *trusted_cert_count - 1*. # trusted_cert_bytes property Returns the raw certificate data in DER format. ## Syntax ```text def get_trusted_cert_bytes(trusted_cert_index: int) -> bytes: ... ``` ## Remarks Returns the raw certificate data in DER format. The *trusted_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [trusted_cert_count](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_trusted_cert_handle(trusted_cert_index: int) -> int: ... def set_trusted_cert_handle(trusted_cert_index: int, value: int) -> None: ... ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *trusted_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [trusted_cert_count](#trusted_cert_count-property) property. # username property The connecting user's username (login name). ## Syntax ```text def get_username() -> str: ... def set_username(value: str) -> None: ... username = property(get_username, set_username) ``` ## Default Value "" ## Remarks Assign the user's login name to this property. Use [password](#password-property) to provide the password. The Username and Password properties are used only when [grant_type](#grant_type-property) is *oauthPasswordCredentials*. # authorize method Performs user authorization and gets an access token. ## Syntax ```text def authorize() -> bool: ... ``` ## Remarks Call this method to perform user authorization and get an access token. When the user completes authorization and its data is sent to the server, OAuthClient will fire the [on_wait](#on_wait-event) event periodically, to show how much waiting time is left. Upon successful authorization, the [access_token](#access_token-property) and [expires_at](#expires_at-property) properties are filled. Returns true if the authorization was granted, and false otherwise. # complete_authorization method Completes the authorization routine. ## Syntax ```text def complete_authorization(redirected_data: str) -> None: ... ``` ## Remarks Call this method to complete the OAuth authorization process started earlier. Provide the data received from the OAuth server via the *RedirectedData* parameter. # config method Sets or retrieves a configuration setting. ## Syntax ```text def config(configuration_string: str) -> str: ... ``` ## Remarks config is a generic method available in every class. It is used to set and retrieve [configuration settings](#oauthclient-config-settings) for the class. These 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. To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter). To read (query) the value of a [configuration setting](#oauthclient-config-settings), you must call *Config("PROPERTY")*. The value will be returned as a string. # do_action method Performs an additional action. ## Syntax ```text def do_action(action_id: str, action_params: str) -> str: ... ``` ## Remarks do_action is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time. The unique identifier (case insensitive) of the action is provided in the *ActionID* parameter. *ActionParams* contains the value of a single parameter, or a list of multiple parameters for the action in the form of *PARAM1=VALUE1;PARAM2=VALUE2;...*. Common ActionIDs: | | | | | | --- | --- | --- | --- | | Action | Parameters | Returned value | Description | | ResetTrustedListCache | none | none | Clears the cached list of trusted lists. | | ResetCertificateCache | none | none | Clears the cached certificates. | | ResetCRLCache | none | none | Clears the cached CRLs. | | ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. | | | | | | | --- | --- | --- | --- | | Action | Parameters | Returned value | Description | | StartAuthorization | none | The URL where a web browser should be directed to let the user to authorize. | If the returned value is empty, the access token was automatically renewed with [refresh_token](#refresh_token-property) and no further processing is needed. | | CompleteAuthorization | authorization code | none | Exchanges the authorization code to an access token. | # reset method Resets the class settings. ## Syntax ```text def reset() -> None: ... ``` ## Remarks reset is a generic method available in every class. # start_authorization method Initiates OAuth authorization protocol. ## Syntax ```text def start_authorization() -> str: ... ``` ## Remarks Call this method to initiate the OAuth authorization protocol. Set up the properties of the component as required before calling this method. # on_error event Provides information about errors during authorization operations. ## Syntax ```text class OAuthClientErrorEventParams(object): @property def error_code() -> int: ... @property def description() -> str: ... # In class OAuthClient: @property def on_error() -> Callable[[OAuthClientErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[OAuthClientErrorEventParams], None]) -> None: ... ``` ## Remarks This event is fired in case of exceptional conditions occurred during authorization operations. *ErrorCode* contains an error code and *Description* contains a textual description of the error. # on_external_sign event Handles remote or external signing initiated by the SignExternal method or other source. ## Syntax ```text class OAuthClientExternalSignEventParams(object): @property def operation_id() -> str: ... @property def hash_algorithm() -> str: ... @property def pars() -> str: ... @property def data() -> str: ... @property def signed_data() -> str: ... @signed_data.setter def signed_data(value) -> None: ... # In class OAuthClient: @property def on_external_sign() -> Callable[[OAuthClientExternalSignEventParams], None]: ... @on_external_sign.setter def on_external_sign(event_hook: Callable[[OAuthClientExternalSignEventParams], None]) -> None: ... ``` ## Remarks Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed. The event handler must pass the value of *Data* to the signer, obtain the signature, and pass it back to the class via the *SignedData* parameter. *OperationId* provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. *HashAlgorithm* specifies the hash algorithm being used for the operation, and *Pars* contains algorithm-dependent parameters. The class uses base16 (hex) encoding for the *Data*, *SignedData*, and *Pars* parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing. A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16 A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following: ```text signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); }; ``` # on_launch_browser event Fires to show the login page to the end-user. ## Syntax ```text class OAuthClientLaunchBrowserEventParams(object): @property def url() -> str: ... @property def handled() -> bool: ... @handled.setter def handled(value) -> None: ... # In class OAuthClient: @property def on_launch_browser() -> Callable[[OAuthClientLaunchBrowserEventParams], None]: ... @on_launch_browser.setter def on_launch_browser(event_hook: Callable[[OAuthClientLaunchBrowserEventParams], None]) -> None: ... ``` ## Remarks Subscribe to this event to respond to requests from the component to open the *URL* in the browser. Set *Handled* to true to report that the URL has been opened in the browser. # on_notification event This event notifies the application about an underlying control flow event. ## Syntax ```text class OAuthClientNotificationEventParams(object): @property def event_id() -> str: ... @property def event_param() -> str: ... # In class OAuthClient: @property def on_notification() -> Callable[[OAuthClientNotificationEventParams], None]: ... @on_notification.setter def on_notification(event_hook: Callable[[OAuthClientNotificationEventParams], None]) -> None: ... ``` ## Remarks The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time. The unique identifier of the event is provided in the *EventID* parameter. *EventParam* contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted. This class can fire this event with the following *EventID* values: | | | | --- | --- | | TLSExtensions.PreSharedIdentityHint | TBD | # on_tls_cert_needed event Fires when a remote TLS party requests a client certificate. ## Syntax ```text class OAuthClientTLSCertNeededEventParams(object): @property def host() -> str: ... @property def ca_names() -> str: ... # In class OAuthClient: @property def on_tls_cert_needed() -> Callable[[OAuthClientTLSCertNeededEventParams], None]: ... @on_tls_cert_needed.setter def on_tls_cert_needed(event_hook: Callable[[OAuthClientTLSCertNeededEventParams], None]) -> None: ... ``` ## Remarks This event fires to notify the implementation that a remote TLS server has requested a client certificate. The *Host* parameter identifies the host that makes a request, and the *CANames* parameter (optional, according to the TLS spec) advises on the accepted issuing CAs. Use the tls_client_chain property in response to this event to provide the requested certificate. Please make sure the client certificate includes the associated private key. Note that you may set the certificates before the connection without waiting for this event to fire. This event is preceded by the [on_tls_handshake](#on_tls_handshake-event) event for the given host and, if the certificate was accepted, succeeded by the [on_tls_established](#on_tls_established-event) event. # on_tls_cert_validate event This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. ## Syntax ```text class OAuthClientTLSCertValidateEventParams(object): @property def server_host() -> str: ... @property def server_ip() -> str: ... @property def accept() -> bool: ... @accept.setter def accept(value) -> None: ... # In class OAuthClient: @property def on_tls_cert_validate() -> Callable[[OAuthClientTLSCertValidateEventParams], None]: ... @on_tls_cert_validate.setter def on_tls_cert_validate(event_hook: Callable[[OAuthClientTLSCertValidateEventParams], None]) -> None: ... ``` ## Remarks This event is fired during a TLS handshake. Use the tls_server_chain property to access the certificate chain. In general, classes may contact a number of TLS endpoints during their work, depending on their configuration. *Accept* is assigned in accordance with the outcome of the internal validation check performed by the class, and can be adjusted if needed. # on_tls_established event Fires when a TLS handshake with Host successfully completes. ## Syntax ```text class OAuthClientTLSEstablishedEventParams(object): @property def host() -> str: ... @property def version() -> str: ... @property def ciphersuite() -> str: ... @property def connection_id() -> bytes: ... @property def abort() -> bool: ... @abort.setter def abort(value) -> None: ... # In class OAuthClient: @property def on_tls_established() -> Callable[[OAuthClientTLSEstablishedEventParams], None]: ... @on_tls_established.setter def on_tls_established(event_hook: Callable[[OAuthClientTLSEstablishedEventParams], None]) -> None: ... ``` ## Remarks The class uses this event to notify the application about a successful completion of a TLS handshake. The *Version*, *Ciphersuite*, and *ConnectionId* parameters indicate the security parameters of the new connection. Use the *Abort* parameter if you need to terminate the connection at this stage. # on_tls_handshake event Fires when a new TLS handshake is initiated, before the handshake commences. ## Syntax ```text class OAuthClientTLSHandshakeEventParams(object): @property def host() -> str: ... @property def abort() -> bool: ... @abort.setter def abort(value) -> None: ... # In class OAuthClient: @property def on_tls_handshake() -> Callable[[OAuthClientTLSHandshakeEventParams], None]: ... @on_tls_handshake.setter def on_tls_handshake(event_hook: Callable[[OAuthClientTLSHandshakeEventParams], None]) -> None: ... ``` ## Remarks The class uses this event to notify the application about the start of a new TLS handshake to *Host*. If the handshake is successful, this event will be followed by the [on_tls_established](#on_tls_established-event) event. If the server chooses to request a client certificate, the [on_tls_cert_needed](#on_tls_cert_needed-event) event will also be fired. # on_tls_psk event Notifies the application about the PSK key exchange. ## Syntax ```text class OAuthClientTLSPSKEventParams(object): @property def host() -> str: ... @property def hint() -> str: ... # In class OAuthClient: @property def on_tls_psk() -> Callable[[OAuthClientTLSPSKEventParams], None]: ... @on_tls_psk.setter def on_tls_psk(event_hook: Callable[[OAuthClientTLSPSKEventParams], None]) -> None: ... ``` ## Remarks The class fires this event to notify the application about the beginning of TLS-PSK key exchange with *Host*. The *Hint* parameter may be used by the server to identify the key or service to use. Use the PreSharedKey field of tls_settings to provide the pre-shared key to the component. # on_tls_shutdown event Reports the graceful closure of a TLS connection. ## Syntax ```text class OAuthClientTLSShutdownEventParams(object): @property def host() -> str: ... # In class OAuthClient: @property def on_tls_shutdown() -> Callable[[OAuthClientTLSShutdownEventParams], None]: ... @on_tls_shutdown.setter def on_tls_shutdown(event_hook: Callable[[OAuthClientTLSShutdownEventParams], None]) -> None: ... ``` ## Remarks This event notifies the application about the closure of an earlier established TLS connection. Note that only graceful connection closures are reported. # on_wait event Fired periodically to show how much waiting time is left. ## Syntax ```text class OAuthClientWaitEventParams(object): @property def time_left() -> int: ... @property def stop() -> bool: ... @stop.setter def stop(value) -> None: ... # In class OAuthClient: @property def on_wait() -> Callable[[OAuthClientWaitEventParams], None]: ... @on_wait.setter def on_wait(event_hook: Callable[[OAuthClientWaitEventParams], None]) -> None: ... ``` ## Remarks This event is fired after authorization is started, to show how much time is left to wait for server's response. Waiting can be cancelled by setting the *Stop* parameter to true, which will result in authorization failure. # OAuthClient Config Settings 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](#config-method) method. ### OAuthClient Config Settings **AddOpenIDScope**: Used to set whether the class should add 'openid' to the scope automatically.The class adds 'openid' to the scope automatically when a hybrid [grant_type](#grant_type-property) is specified. Set this property to *false* to not add 'openid' to the scope if it is needed for any reason. By default, it is *true*. **CacheControl**: Optional value for Cache-Control HTTP header field.Specifies an optional value to be used in the Cache-Control header field of HTTP requests. Recommended value: no-store,max-age=0 **CachedCRLMaxAge**: Specifies the maximum age of a cached CRL.Use this setting to specify the maximum number of seconds that may pass since a CRL was added to the global cache. When the cached CRL is older than this value, it is disregarded and a new CRL should be fetched. The default value is 0, which disables the absolute CRL age check. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings. **CachedCRLMaxAgeRatio**: Specifies the maximum age of a cached CRL as a percentage of its remaining lifetime.Use this setting to specify the percentage of the CRL's remaining lifetime, measured from the time the CRL was added to the global cache to the CRL's NextUpdate. When this portion of the remaining lifetime has passed, the cached CRL is disregarded and a new CRL should be fetched. The default value is 0, which disables the CRL ratio check. Values are interpreted in the 0..100 range. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings. **CachedCRLOverlapTime**: Specifies the time period before a cached CRL's NextUpdate when it is considered stale and must be refreshed.Use this setting to specify the number of seconds before the NextUpdate time at which the cached CRL should be disregarded, and a new CRL should be fetched. The default value is 0, which disables the CRL overlap check. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings. This setting is evaluated independently from [CachedCRLMaxAge](#CachedCRLMaxAge) and [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio). If several cached CRL freshness settings are enabled, the cached CRL is used only if it satisfies all of them. **CachedOCSPResponseMaxAge**: Specifies the maximum age of a cached OCSP response.Use this setting to specify the maximum number of seconds that may pass since an OCSP response was added to the global cache. When the cached OCSP response is older than this value, it is disregarded and a new OCSP response should be fetched. The default value is 0, which disables the absolute OCSP response age check. This setting is also used to limit open-ended OCSP responses that do not have NextUpdate. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings. **CachedOCSPResponseMaxAgeRatio**: Specifies the maximum age of a cached OCSP response as a percentage of its remaining lifetime.Use this setting to specify the percentage of the OCSP response's remaining lifetime, measured from the time the OCSP response was added to the global cache to the response's NextUpdate. When this portion of the remaining lifetime has passed, the cached OCSP response is disregarded and a new OCSP response should be fetched. The default value is 0, which disables the OCSP response ratio check. Values are interpreted in the 0..100 range. Open-ended OCSP responses without NextUpdate ignore this setting; use [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge) to limit their age. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings. **CachedOCSPResponseOverlapTime**: Specifies the time period before a cached OCSP response's NextUpdate when it is considered stale and must be refreshed.Use this setting to specify the number of seconds before the NextUpdate time at which the cached OCSP response should be disregarded, and a new OCSP response should be fetched. The default value is 0, which disables the OCSP response overlap check. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings. This setting is evaluated independently from [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge) and [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio). If several cached OCSP response freshness settings are enabled, the cached OCSP response is used only if it satisfies all of them. **DeltaCRLPreference**: Specifies whether complete or delta CRLs are preferred.Use this setting to specify which CRL type should be preferred during TLS certificate revocation checks. The default value is **dcrlpPreferDelta** (0). Supported values: - **dcrlpPreferDelta** (0): retrieve and use delta CRLs when available, falling back to complete CRLs when needed. - **dcrlpPreferComplete** (1): try complete CRLs first, and use delta CRLs only if complete CRLs cannot be retrieved. **EncodeScope**: Used to set whether the class should URL-encode the scope parameter.Some authentication services require scopes to be separated by a plus or other character, and not to be encoded in the URL. Set this property to *false* to prevent such encoding. By default, it is *true*. **EvaluateSystemTrust**: Enables or disables usage of the platform's built-in trust validation facilities.Enable this property to delegate the chain validation to the operating system's native trust evaluation mechanism (e.g. SecTrustEvaluate on Apple platforms). This functionality is currently available on macOS and iOS systems only. This property is enabled by default. **GrantTypeString**: Used to set a custom grant type string.This setting is used to set the *grant_type* parameter manually. This class will still consider the [grant_type](#grant_type-property) property to determine how it will function. **IDToken**: ID Token parameter for JWT.This read-only value returns the id_token parameter (if any) than can be used for JWT operations. **IgnoreSystemTrust**: Whether trusted Windows Certificate Stores should be treated as trusted.Specifies whether, during chain validation, the class should respect the trust to CA certificates as configured in the operating system. In Windows this effectively defines whether the class should trust the certificates residing in the Trusted Root Certification Authorities store. If [IgnoreSystemTrust](#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 the trusted_certificates property) are considered trusted. **ListenURL**: The URL where to listen for redirection from the user web browser.Specifies an URL where the class should wait for incoming connection from the user's web browser. If this value is empty, [redirect_url](#redirect_url-property) is used. This property can be used if an external web server is used to handle the authorization server's response. **LocalServerBaseConfiguration**: Base configuration for the internal TLS server if an HTTPS redirect is used.Selects the base configuration for the TLS settings. Several profiles are on offer, tuned up for different purposes, such as high security or higher compatibility. | | | | | --- | --- | --- | | stpcDefault | 0 | | | stpcCompatible | 1 | | | stpcComprehensiveInsecure | 2 | | | stpcHighlySecure | 3 | | **LocalServerCiphersuites**: Ciphersuites allowed for the internal TLS server if an HTTPS redirect is used.A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the *all* (and *-all*) aliases that allow to blanketly enable or disable all ciphersuites at once. Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by BaseConfiguration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. See the tls_settings.Ciphersuites property for the list of supported ciphersuites. **LocalServerVersions**: The SSL/TLS versions to enable for the internal TLS server if an HTTPS redirect is used.The SSL/TLS versions to enable. By default, TLS 1.2 and TLS 1.3 are enabled. | | | | | --- | --- | --- | | csbSSL2 | 0x01 | SSL 2 | | csbSSL3 | 0x02 | SSL 3 | | csbTLS1 | 0x04 | TLS 1.0 | | csbTLS11 | 0x08 | TLS 1.1 | | csbTLS12 | 0x10 | TLS 1.2 | | csbTLS13 | 0x20 | TLS 1.3 | **PKCEMode**: Proof Key for Code Exchange method to use.Specifies which PKCE method should be used (if any) if [grant_type](#grant_type-property) is ogtAuthorizationCode. | | | | | --- | --- | --- | | none | | Don't use PKCE | | plain | | No transformation should be used | | s256 | | SHA-256 transformation should be used | **RevocationCacheAgePolicy**: Specifies a preset policy for cached CRL and OCSP response freshness settings.Use this setting to configure all cached revocation freshness settings at once. The default value is Disabled. Supported values are case-insensitive: | | | | --- | --- | | Disabled | Sets [CachedCRLOverlapTime](#CachedCRLOverlapTime), [CachedOCSPResponseOverlapTime](#CachedOCSPResponseOverlapTime), [CachedCRLMaxAge](#CachedCRLMaxAge), [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge), [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio), and [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio) to 0. This value is the default. It only disables the cache-age freshness policy; it does not disable revocation checking or use of the revocation cache. | | Default | Applies the component default freshness settings. For this component, Default is equivalent to Disabled. | | Short | Uses crl:43200;50;300,ocsp:1800;50;300. This means: CRL maximum age 12 hours, CRL age ratio 50%, CRL overlap 5 minutes; OCSP response maximum age 30 minutes, OCSP response age ratio 50%, OCSP response overlap 5 minutes. | | Long | Uses crl:518400;50;3600,ocsp:21600;50;3600. This means: CRL maximum age 6 days, CRL age ratio 50%, CRL overlap 1 hour; OCSP response maximum age 6 hours, OCSP response age ratio 50%, OCSP response overlap 1 hour. | | N | Interprets N as an integer number of seconds. The overlap settings are set to N seconds, CRL maximum age is set to N * 144, OCSP response maximum age is set to N * 6, and both ratio settings are set to 50. | | crl:;;,ocsp:;; | Sets the CRL and OCSP response freshness values explicitly. | Ratios must be in the 0..100 range. Maximum age and overlap values must be non-negative. Short and Long are time-scale profiles: Long allows older cached revocation information by increasing maximum ages, but also uses a larger pre-expiry safety margin by increasing overlap times. For individual [CachedCRLOverlapTime](#CachedCRLOverlapTime), [CachedOCSPResponseOverlapTime](#CachedOCSPResponseOverlapTime), [CachedCRLMaxAge](#CachedCRLMaxAge), [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge), [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio), and [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio) settings, a value of 0 disables the corresponding freshness check. The individual settings remain available for advanced configuration and can be used after this setting to override specific values. **StaticDNS**: Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the class. Works only if *UseOwnDNSResolver* is set to *true*. Supported values are: | | | | | --- | --- | --- | | none | | No static DNS rules (default) | | local | | Local static DNS rules | | global | | Global static DNS rules | **StaticIPAddress[domain]**: Gets or sets an IP address for the specified domain name.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 divided by the | (pipe) character. **StaticIPAddresses**: Gets or sets all the static DNS rules.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. **TLSCiphersuites**: Returns the list of ciphersuites activated in the component for the current session.Check this property to enumerate the list of TLS ciphersuites enabled in the component. A good place to do that is OnTLSHandshake event handler. **TLSExtensions**: TBD.TBD **TLSGroups**: Returns the list of TLS key exchange groups enabled in the component.Check this property to enumerate the list of TLS key exchange groups enabled in the component. **TLSPeerExtensions**: TBD.TBD **TLSSessionGroup**: Specifies the group name of TLS sessions to be used for session resumption.Use this property to limit the search of cached 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. **TLSSessionLifetime**: Specifies lifetime in seconds of the cached TLS session.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). **TLSSessionPurgeInterval**: Specifies how often the session cache should remove the expired TLS sessions.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). **TLSVersions**: Returns the list of TLS versions enabled in the component.Check this property to obtain the list of TLS versions enabled in the component, as an integer bitmask. **TolerateMinorChainIssues**: Whether to tolerate minor chain issues.This parameter controls whether the chain validator should tolerate minor technical issues when validating the chain. Those are: - CA, revocation source, TLS key usage requirements are not mandated - Violation of OCSP issuer requirements are ignored - The AuthorityKeyID extension in CRL- and certificate-issuing CAs are ignored (helps with incorrectly renewed certificates) - Basic constraints and name constraints of CA certificates are ignored - Some weaker algorithms are tolerated **UseEnvStorages**: Enables or disables use of the environment storages.Enable this property to make the chain validation module automatically look up missing CA and intermediate certificates in the environment storages. **UseMicrosoftCTL**: Enables or disables the automatic use of the 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 the chain validation module to 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. ### Base Config Settings **ASN1UseGlobalTagCache**: Controls whether ASN.1 module should use a global object cache.This is a performance setting. It is unlikely that you will ever need to adjust it. **AssignSystemSmartCardPins**: Specifies whether CSP-level PINs should be assigned to CNG keys.This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it. **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: | | | | | --- | --- | --- | | off | | No caching (default) | | local | | Local caching | | global | | Global caching | **Cookies**: Gets or sets local cookies for the class.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. **DNSLocalSuffix**: The suffix to assign for TLD names.Use this global setting to adjust the default suffix to assign to top-level domain names. The default is *.local*. **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. **EnableSSHMLKEM**: Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components.Use this setting to enable hybrid key exchange algorithms in client and server SSH and SFTP components. This is a global setting that enables ML-KEM blanketly in all SSH-dependent components. **EnableTLSMLKEM**: Enables support for ML-KEM and hybrid groups in TLS client and server components.Use this setting to enable ML-KEM and hybrid key exchange groups in client and server TLS components. This is a global setting that enables ML-KEM blanketly in all TLS-dependent components. **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". **HardwareCryptoUsePolicy**: The hardware crypto usage policy.This global setting controls the hardware cryptography usage policy. Supported Values: | | | | --- | --- | | auto | Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default). | | enable | Always attempt to use hardware cryptography. If unavailable, exception will be thrown. | | disable | Do not use hardware cryptography. | **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. **HttpVersion**: The HTTP version to use in any inner HTTP client components created.Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use. **IgnoreExpiredMSCTLSigningCert**: Whether to tolerate the expired Windows Update signing certificate.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. **ListDelimiter**: The delimiter character for multi-element lists.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. **LogDestination**: Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped. Supported values are: | | | | | --- | --- | --- | | file | | File | | console | | Console | | systemlog | | System Log (supported for Android only) | | debugger | | Debugger (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: | | | | | --- | --- | --- | | time | | Current time | | level | | Level | | package | | Package name | | module | | Module name | | class | | Class name | | method | | Method name | | threadid | | Thread Id | | contenttype | | Content type | | content | | Content | | all | | All 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-package | | Exclude a package specified in the value | | exclude-module | | Exclude a module specified in the value | | exclude-class | | Exclude a class specified in the value | | exclude-method | | Exclude a method specified in the value | | include-package | | Include a package specified in the value | | include-module | | Include a module specified in the value | | include-class | | Include a class specified in the value | | include-method | | Include 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: | | | | | --- | --- | --- | | none | | No flush (caching only) | | immediate | | Immediate flush (real-time logging) | | maxcount | | Flush 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: | | | | | --- | --- | --- | | none | | None (by default) | | fatal | | Severe errors that cause premature termination. | | error | | Other runtime errors or unexpected conditions. | | warning | | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | | info | | Interesting runtime events (startup/shutdown). | | debug | | Detailed information on flow of through the system. | | trace | | More 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: | | | | | --- | --- | --- | | none | | No rotation | | deleteolder | | Delete older entries from the cache upon reaching LogMaxEventCount | | keepolder | | Keep 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. **OldClientSideRSAFallback**: Specifies whether the SSH client should use a SHA1 fallback.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. **PKICache**: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.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: | | | | --- | --- | | certificate | Enables caching of certificates. | | crl | Enables caching of Certificate Revocation Lists (CRLs). | | ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. | Example (default value): ```text PKICache=certificate,crl,ocsp ``` In this example, the component caches certificates, CRLs, and OCSP responses. **PKICachePath**: Specifies the file system path where cached PKI data is stored.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: ```text PKICachePath=C:\Temp\cache ``` In this example, the cached PKI data is stored in the C:\Temp\cache directory. **ProductVersion**: Returns the version of the SecureBlackbox library.This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision). **ServerSSLDHKeyLength**: Sets the size of the TLS DHE key exchange group.Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server. **StaticDNS**: Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the class. Works only if *UseOwnDNSResolver* is set to *true*. Supported values are: | | | | | --- | --- | --- | | none | | No static DNS rules (default) | | local | | Local static DNS rules | | global | | Global static DNS rules | **StaticIPAddress[domain]**: Gets or sets an IP address for the specified domain name.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 divided by the | (pipe) character. **StaticIPAddresses**: Gets or sets all the static DNS rules.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. **Tag**: Allows to store any custom data.Use this config property to store any custom data. **TLSSessionGroup**: Specifies the group name of TLS sessions to be used for session resumption.Use this property to limit the search of cached 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. **TLSSessionLifetime**: Specifies lifetime in seconds of the cached TLS session.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). **TLSSessionPurgeInterval**: Specifies how often the session cache should remove the expired TLS sessions.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). **UseCRLObjectCaching**: Specifies whether reuse of loaded CRL objects is enabled.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. **UseInternalRandom**: Switches between SecureBlackbox-own and platform PRNGs.Allows to switch between internal/native PRNG implementation and the one provided by the platform. **UseLegacyAdESValidation**: Enables legacy AdES validation mode.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). **UseOCSPResponseObjectCaching**: Specifies whether reuse of loaded OCSP response objects is enabled.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. **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. **UseSystemNativeSizeCalculation**: An internal CryptoAPI access tweak.This is an internal setting. Please do not use it unless instructed by the support team. **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. **XMLRDNDescriptorName[OID]**: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.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: ```text 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: ```text Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER"); ``` Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: ```text Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS"); ``` **XMLRDNDescriptorPriority[OID]**: Specifies the priority of descriptor names associated with a specific OID.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. **XMLRDNDescriptorReverseOrder**: Specifies whether to reverse the order of descriptors in RDN.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). **XMLRDNDescriptorSeparator**: Specifies the separator used between descriptors in RDN.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. # OAuthClient Errors