Client Configuration
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.Client Configuration Settings
AcceptAnyACSCert:
Whether to accept any ACS certificate during signature validation.After calling SendAuthRequest the ACSRootCerts property is used to validate the signature in the response. This setting will force the acceptance of the ACS certificate as valid, regardless of the value in ACSRootCerts.
Use this setting with caution, it should only be enabled when there is a specific reason to do so as it bypasses normal signature validation logic. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ACSRenderingInterface:
Challenge interface type presented to cardholder.This setting specifies the ACS interface that must be used to present the challenge to the cardholder in an app-based flow. This
setting is populated after calling CheckAuthResponse in the Client and SendAuthRequest in the 3DS Server. This is also populated after calling CheckResponse and passing the Results Request Message.
Possible values are:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ACSRenderingUITemplate:
Challenge type presented to cardholder.This setting holds the type of challenge that will be presented to the cardholder in an app-based flow.
This
setting is populated after calling CheckAuthResponse in the Client and SendAuthRequest in the 3DS Server. This is also populated after calling CheckResponse and passing the Results Request Message.
Possible values are:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ACSSignedContent:
String value of the JWS object of the ARes message created by the ACS.Contains the JWS object created by the ACS for the ARes message. The JWS object body contains the ACSURL, the ACS Ephemeral Public Key, and the SDK Ephemeral Public Key (available in the SDKEphemeralPublicKey configuration setting). These values will be used by the Client to confirm the authenticity of the ACS.
This setting is only applicable to the app-based flow and is informational. It does not need to be queried or set in most cases. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ACSTransactionId: Unique transaction identifier assigned by the ACS.This field contains a universally unique transaction identifier assigned by the ACS to identify a single transaction. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ACSURL: ACS URL to which the challenge request is sent.This field contains the fully qualified URL of the ACS to be used for the challenge. This will be populated after the call to CheckAuthResponse method if a challenge is required. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ChallengeResponse: Challenge Response (CRes).This field contains the decrypted Challenge Response Message (CRes) returned from the ACS. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ChallengeTimeRemaining: Amount of time left to complete challenge.This field contains the time remaining to complete the challenge. This is based on the SDKMaxTimeout set when issuing the initial Authorization Request Message. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DeviceRenderingInterface:
SDK Interface Device Rendering Types supported.Types of SDK Interfaces that the device supports for displaying specific challenge user interfaces within the SDK.
Possible values are:
One of the elements comprising the Device Rendering Options which define the SDK UI types that the device supports (along with DeviceRenderingInterface). These Options are required in AReq messages. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DeviceRenderingUIType:
SDK UI Types supported.UI types that the device supports for displaying specific challenge user interfaces within the SDK. Multiple values can be or-ed together to support multiple types. Possible values are:
Note that currently all SDKs need to support all UI types. In the future, however, this may change (for example, smart watches may support a UI Type not yet defined). In light of this, all UI types are enabled by default (31). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DSTransactionId: Directory server transaction ID.Universally unique transaction identifier assigned by the directory server to identify a single transaction. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ErrorCode: Code from the last error message.Code indicating the type of problem identified in the error message. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ErrorDescription: Description from the last error message.Text describing the problem identified in the error message. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ErrorDetail: Additional details from the last error message.Additional detail regarding the problem identified in the error message. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
IncomingExtensionCount: The number of extensions received from the directory server.This setting holds the number of extensions received in the last message from the directory server. The individual extension data can be accessed via the IncomingExtensionId, $rcfgIncomingExtensionName;, IncomingExtensionCritical, and IncomingExtensionData settings. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
IncomingExtensionCritical[Index]: Whether the extension is critical.This setting specifies whether the recipient must understand the contents of the extension to interpret the entire message. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
IncomingExtensionData[Index]: The extension data as JSON.This setting specifies the JSON formatted extension data. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
IncomingExtensionId[Index]: The id of the specified extension.This setting specifies a unique identifier for the extension. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
IncomingExtensionName[Index]: The extension name.This setting specifies the name of the extension as defined by the extension owner. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
IncomingRawExtensions: The full JSON formatted extension data received from the directory server.This setting holds the full JSON formatted extension data that was received in the last message from the directory server. This corresponds to the value for the messageExtension JSON object defined in the specification. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LogLevel:
Level of logging enabled.This config specifies the level of logging enabled in the component. Possible values include:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaskSensitive:
Whether to mask sensitive data in the Log event.This setting controls whether sensitive data is masked in the Log event. When set to True (default)
the ChallengeDataEntry value will be replaced with the value ******.
Note: DataPacketOut will always contain the raw unmasked value regardless of this setting. This setting only applies to the Log event. The default value is True. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MerchantAppURL:
3DS Requestor App URL.Merchant app URL used so the authentication app can call the merchant app after OOB authentication has occurred. This should be set prior to starting the challenge process.
For instance: merchantScheme://appName?transID=b2385523-a66c-4907-ac3c-91848e8c0067 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MessageType:
Type of message that is passed.This field identifies the type of the message being transmitted.
Possible values include:
This setting is read-only. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OOBAppLabel: OOB app label.Label to be displayed for the link to the OOB App URL. For example: "Click here to open Your Bank App." | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OOBAppURL:
OOB app URL.Mobile Deep link to an authentication app used for out-of-band (OOB) authentication. The App URL will open the appropriate location within the application app.
Note: this element has been defined to support future enhancements to the OOB message flow and is not currently used. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OutgoingRawExtensions:
The full JSON formatted extension data sent to the directory server.This setting holds the full JSON formatted extension data that will be included in the next outgoing packet. This corresponds to the value for the messageExtension JSON object defined in the specification.
Note: When sending extension data it is generally recommended to use Extensions instead of this setting. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProtocolVersion: Protocol version identifier.This field indicates the protocol version. This should be the protocol version number of the specification utilized by the system creating this message. By default, this is set to 2.1.0. The most recent version of the protocol is 2.2.0. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ResendChallengeInfo:
Resend challenge information code.This field contains an indicator to the ACS to resend the challenge information code to the cardholder. This is exclusive to the app flow, and is required for Native UI if the cardholder is requesting the ACS to resend challenge information.
Possible values include:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SDKEphemeralPrivateKey:
Private key component of the ephemeral key pair generated by the Client.This setting holds the generated private key of the ephemeral key pair that is generated when GetAuthRequest is called. In most cases this does not need to be queried, however if different
instances of the class are used between GetAuthRequest and SendChallengeRequest this value
must be stored and re-assigned between calls.
If the same instance of the class is used throughout the lifetime of the transaction this setting does not need to be used. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SDKEphemeralPublicKey: Public key component of the ephemeral key pair generated by the Client.This setting holds the public key used to establish session keys between the 3DS SDK and ACS. This is automatically generated when calling GetAuthRequest. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SDKMaxTimeout: SDK Maximum Timeout.Indicates the maximum amount of time (in minutes) for all exchanges. Included in the Authorization Request Message (AReq) sent to the directory server via the SendAuthRequest method. A value of 5 minutes is used by default. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SDKReferenceNumber: Assigned SDK reference number.This setting specifies the SDK reference number assigned by EMVCo when the 3DS SDK is approved. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ServerTransactionId: Unique transaction identifier assigned by the 3DS Server.Universally unique transaction identifier assigned by the 3DS Server to identify a single transaction. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TransactionStatusReason:
Reason for value of TransactionStatus.Provides information on why the Transaction Status field has the specified value. For MessageCategory 01 (PA), always included when TransactionStatus = N, U, or R. For MessageCategory 02 (NPA), as defined by the DS.
Possible values are:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseAESGCM: Whether or not to use AESGCM as the encryption algorithm.By default, the component will use JWS_ENC_ALG_ID_A128CBC_HS256AES when encrypting packets to send to the ACS. Setting this to true will instruct the component to use JWE_ENC_ALG_ID_A128GCM instead. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
XChildCount:
The number of child elements of the current element.The number of child attributes of the current element. The XChild configuration settings will be indexed from 0 to (XChildCount - 1).
The current element is specified via the XPath configuration setting. This configuration setting is read-only. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
XChildName[i]:
The name of the child element.Provides the name of the i'th child element of the current element.
The current element is specified via the XPath configuration setting. This configuration setting is read-only. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
XChildXText[i]:
The inner text of the child element.Provides the inner text of the i'th child element of the current element.
The current element is specified via the XPath configuration setting. This configuration setting is read-only. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
XElement:
The name of the current element.Provides the name of the current element.
The current element is specified via the XPath configuration setting. This configuration setting is read-only. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
XParent:
The parent of the current element.Provides the parent of the current element.
The current element is specified via the XPath configuration setting. This configuration setting is read-only. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
XPath:
Provides a way to point to a specific element in the returned XML or JSON response.The XPath setting allows you to point to specific elements in the XML or JSON response.
When XPath is set to a valid path, XElement points to the name of the element, with XText, XParent, XSubTree, XChildCount, XChildName[i], and XChildXText[i] providing other properties of the element.
XPath SyntaxXPath syntax is available for both XML and JSON documents. An XPath is a series of one or more element accessors separated by the / character, for example: /A/B/C/D. An XPath can be absolute (i.e., it starts with /), or it can be relative to the current XPath location. The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors which proceed it in the overall XPath string:
XPath ExamplesAssuming the following XML response:
<firstlevel> <one>value</one> <two> <item>first</item> <item>second</item> </two> <three>value three</three> </firstlevel> Or, alternatively, the following JSON response:
{ "firstlevel": { "one": "value", "two": ["first", "second"], "three": "value three" } } Here are some examples of valid XPaths:
This is not an exhaustive list by any means, but should provide a general idea of the possibilities. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
XSubTree:
A snapshot of the current element in the document.Provides the entirety of the current element (including its sub-elements).
The current element is specified via the XPath configuration setting. This configuration setting is read-only. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
XText:
The text of the current element.Provides the inner text of the current element.
The current element is specified in the XPath configuration setting. This configuration setting is read-only. |
SSL Configuration Settings
LogSSLPackets:
Controls whether SSL packets are logged when using the internal security API.When the UseInternalSecurityAPI configuration setting is True, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful for debugging purposes.
When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received. Enabling this setting has no effect if UseInternalSecurityAPI is False. | |||||||||||||||||||||||||
OpenSSLCADir:
The path to a directory containing CA certificates.This functionality is available only when the provider is OpenSSL.
The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. | |||||||||||||||||||||||||
OpenSSLCAFile:
Name of the file containing the list of CA's trusted by your application.This functionality is available only when the provider is OpenSSL.
The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by -----BEGIN CERTIFICATE----- ... (CA certificate in base64 encoding) ... -----END CERTIFICATE----- sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. | |||||||||||||||||||||||||
OpenSSLCipherList:
A string that controls the ciphers to be used by SSL.This functionality is available only when the provider is OpenSSL.
The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH". | |||||||||||||||||||||||||
OpenSSLPrngSeedData:
The data to seed the pseudo random number generator (PRNG).This functionality is available only when the provider is OpenSSL.
By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG. | |||||||||||||||||||||||||
ReuseSSLSession:
Determines if the SSL session is reused.
If set to true, the class will reuse the context if and only if the following criteria are met:
| |||||||||||||||||||||||||
SSLCACertFilePaths:
The paths to CA certificate files on Unix/Linux.This setting specifies the paths on disk to CA certificate files on Unix/Linux.
The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found the CA certificates within the file will be loaded and used to determine the validity of server or client certificates. The default value is:
/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem | |||||||||||||||||||||||||
SSLCACerts:
A newline separated list of CA certificate to use during SSL client authentication.This setting specifies one or more CA certificates to be included in the request when performing
SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented
when performing SSL client authentication. The value of this setting is a newline (CrLf) separated list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- | |||||||||||||||||||||||||
SSLCheckCRL:
Whether to check the Certificate Revocation List for the server certificate.This setting specifies whether the class will check the Certificate Revocation List specified by the server certificate. If set to true the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class fails with an error.
When set to false (default) the CRL check will not be performed by the class. | |||||||||||||||||||||||||
SSLCipherStrength:
The minimum cipher strength used for bulk encryption.
This minimum cipher strength largely dependent on the security modules installed
on the system. If the cipher strength specified is not supported,
an error will be returned when connections are initiated.
Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event. Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application. When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting. | |||||||||||||||||||||||||
SSLEnabledCipherSuites:
The cipher suite to be used in an SSL negotiation.The enabled cipher suites to be used in SSL negotiation.
By default, the enabled cipher suites will include all available ciphers ("*"). The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered. Multiple cipher suites are separated by semicolons. Example values when UseInternalSecurityAPI is False (default):
obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");Possible values when UseInternalSecurityAPI is False (default) include:
obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA");Possible values when UseInternalSecurityAPI is True include:
When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:
SSLEnabledCipherSuites is used together with SSLCipherStrength. | |||||||||||||||||||||||||
SSLEnabledProtocols:
Used to enable/disable the supported security protocols.Used to enable/disable the supported security protocols.
Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:
When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList setting. Note: TLS 1.1 and TLS1.2 support are only available starting with Windows 7. Note: Enabling TLS 1.3 will automatically set UseInternalSecurityAPI to True. | |||||||||||||||||||||||||
SSLEnableRenegotiation:
Whether the renegotiation_info SSL extension is supported.This setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API.
This setting is true by default, but can be set to false to disable the extension.
This setting is only applicable when UseInternalSecurityAPI is set to true. | |||||||||||||||||||||||||
SSLIncludeCertChain:
Whether the entire certificate chain is included in the SSLServerAuthentication event.This setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains
the full certificate chain. By default this value is False and only the leaf certificate will be present
in the Encoded parameter of the SSLServerAuthentication event.
If set to True all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
| |||||||||||||||||||||||||
SSLNegotiatedCipher:
Returns the negotiated ciphersuite.Returns the ciphersuite negotiated during the SSL handshake.
Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
| |||||||||||||||||||||||||
SSLNegotiatedCipherStrength:
Returns the negotiated ciphersuite strength.Returns the strength of the ciphersuite negotiated during the SSL handshake.
Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
| |||||||||||||||||||||||||
SSLNegotiatedCipherSuite:
Returns the negotiated ciphersuite.Returns the ciphersuite negotiated during the SSL handshake represented as a single string.
Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
| |||||||||||||||||||||||||
SSLNegotiatedKeyExchange:
Returns the negotiated key exchange algorithm.Returns the key exchange algorithm negotiated during the SSL handshake.
Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
| |||||||||||||||||||||||||
SSLNegotiatedKeyExchangeStrength:
Returns the negotiated key exchange algorithm strength.Returns the strenghth of the key exchange algorithm negotiated during the SSL handshake.
Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
| |||||||||||||||||||||||||
SSLNegotiatedVersion:
Returns the negotiated protocol version.Returns the protocol version negotiated during the SSL handshake.
Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
| |||||||||||||||||||||||||
SSLProvider:
The name of the security provider to use.
Change this setting to use security providers other than the system default.
Use this setting with caution. Disabling SSL security or pointing to the wrong provider could potentially cause serious security vulnerabilities in your application. The special value "*" (default) picks the default SSL provider defined in the system. Note: On Windows systems, the default SSL Provider is "Microsoft Unified Security Protocol Provider" and cannot be changed . | |||||||||||||||||||||||||
SSLSecurityFlags:
Flags that control certificate verification.The following flags are defined (specified in hexadecimal
notation). They can be or-ed together to exclude multiple
conditions:
This functionality is currently not available when the provider is OpenSSL. | |||||||||||||||||||||||||
SSLServerCACerts:
A newline separated list of CA certificate to use during SSL server certificate validation.This setting optionally specifies one or more CA certificates to be used when verifying the server certificate. When verifying the server's certificate the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This setting should only be set if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.
The value of this setting is a newline (CrLf) separated list of certificates. For instance: -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- | |||||||||||||||||||||||||
TLS12SignatureAlgorithms:
Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.This setting specifies the allowed server certificate signature algorithms when UseInternalSecurityAPI is
True and SSLEnabledProtocols is set to allow TLS 1.2.
When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class fails with an error. The format of this value is a comma separated list of hash-signature combinations. For instance:
IPPort.Config("UseInternalSecurityAPI=true");
IPPort.Config("SSLEnabledProtocols=3072"); //TLS 1.2
IPPort.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.
In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent. | |||||||||||||||||||||||||
TLS12SupportedGroups:
The supported groups for ECC.This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1. When using TLS 1.2 and UseInternalSecurityAPI is set to True, the values refer to the supported groups for ECC. The following values are supported:
| |||||||||||||||||||||||||
TLS13KeyShareGroups:
The groups for which to pregenerate key shares.This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange.
The groups specified here will have key share data pregenerated locally before establishing a connection.
This can prevent an additional round trip during the handshake if the group is supported by the server.
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting. Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group. In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so. The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072 The values are ordered from most preferred to least preferred. The following values are supported:
| |||||||||||||||||||||||||
TLS13SignatureAlgorithms:
The allowed certificate signature algorithms.This setting holds a comma separated list of allowed signature algorithms. Possible values are:
| |||||||||||||||||||||||||
TLS13SupportedGroups:
The supported groups for (EC)DHE key exchange.This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange.
This setting should only be modified if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192 The values are ordered from most preferred to least preferred. The following values are supported:
|