Client Class

Properties   Methods   Events   Config Settings   Errors  

The Client class is designed for use on mobile devices and facilitates EMV® 3-D Secure authentication.

Syntax

class ipworks3ds.Client

Remarks

The Client class is a counterpart to the 3DS Server class. It is designed for use on mobile devices and supports operations that facilitate EMV® 3-D Secure authentication in both frictionless and challenge flows.

Preparing the Authentication Request

To begin, device specific information must be collected and prepared for transmission to the directory server. This can be done by calling the add_device_param method. Consult the EMV® 3-D Secure Specifications for more details about applicable device parameters for each particular operating system.

The get_auth_request method is used to obtain the request message to be send to the directory server. get_auth_request encrypts the device info and prepares all the data necessary to be sent by the 3DS Server class in the send_auth_request method.

After calling this method, the returned data must be transmitted via a separate secure channel to the server where 3DS Server is being used.

The following properties are required before calling the method:

Calling this method returns required information used by 3DS Server to send the authentication request. Transmit the value returned by this method to the system where 3DS Server is used. The method used to transmit this value is outside the scope of the class.

See send_auth_request for details on sending the authentication request after transmitting the data to the 3DS Server.

Calling this method also populates sdk_transaction_id which uniquely identifies this transaction and must be used in subsequent calls relating to this transaction, such as send_challenge_request.

Interaction With the 3DS Server Class

As mentioned above, the request to the Directory Server must be made by the 3DS Server class which resides on a server under control of the merchant. A web server is required even for app-based authentication both to send the authentication request and to be notified of authentication results later in the flow.

It is expected that a secure channel can be established between the app using the Client class and the server where the 3DS Server class resides in order to transfer information freely.

Sending the Authentication Request

The act of sending the authentication request takes place with the 3DS Server class.

send_auth_request begins the 3-D Secure transaction flow by sending an authentication request to the directory_server_url.

After calling this method, check transaction_status to determine if the cardholder is authenticated (frictionless flow) or further cardholder interaction is required to complete the authentication (challenge flow).

Prior to calling send_auth_request, data must to be collected to facilitate fraud checks by the ACS. The following properties are applicable for both app-based and browser-based flows:

• acquirer_bin (required)
• acquirer_merchant_id (required)
• cardholder_name (required)
• card_number (required)
• directory_server_url (required)
• merchant_category_code (required)
• merchant_country_code (required)
• merchant_name (required)
• message_version (required)
• purchase_amount (required)
• purchase_date (required)
• requestor_id (required)
• requestor_name (required)
• requestor_url (required)
• results_url (required)
• account_type
• authentication_indicator
• BillingAddress*
• cardholder_email
• cardholder_home_phone
• cardholder_mobile_phone
• cardholder_work_phone
• DecoupledMaxTimeout
• DecoupledRequestIndicator
• device_channel
• message_category
• purchase_currency
• purchase_exponent
• ServerOperatorId
• server_transaction_id
• ShippingAddress*
• ThreeRIIndicator

App-Based Flow

In the app-based flow, device specific information is prepared by the 3DS SDK on the customer's device. This is transmitted to the 3DS Server class via a secure channel, the specifics of which are outside the scope of the classs. Set client_auth_request to this data prepared by the 3DS SDK.

Browser-Based Flow

Before calling this method, first check the cached card-range data to determine if a card_range_method_url has been set by the ACS. Card range data may be retrieved by calling request_card_ranges.

If no card_range_method_url is present for the given card, set MethodCompletionIndicator to U.

If a card_range_method_url has been specified by the ACS for the card number, the URL must be loaded in the cardholder's browser to allow the ACS to collect additional browser information for risk-based decision making. See the get_method_data for further details.

Once the method URL invocation is complete, the authentication request may be sent. If the method URL invocation failed, set MethodCompletionIndicator to N before calling send_auth_request.

The following additional properties are applicable in browser-based flow:

• notification_url (required)
• browser_accept_header (required)
• browser_language (required)
• browser_screen_height (required in 2.1.0, required in 2.2.0 and 2.3.1 if BrowserJavaScriptEnabled is true)
• browser_screen_width (required in 2.1.0, required in 2.2.0 and 2.3.1 if BrowserJavaScriptEnabled is true)
• browser_time_zone (required in 2.1.0, required in 2.2.0 and 2.3.1 if BrowserJavaScriptEnabled is true)
• browser_user_agent (required)
• browser_ip_address (conditional)
• browser_java_enabled_val (required in 2.1.0, required in 2.2.0 and 2.3.1 if BrowserJavaScriptEnabled is true)
• browser_java_script_enabled_val (not valid in 2.1.0, required in 2.2.0 and 2.3.1)
• browser_screen_color_depth (required in 2.1.0, required in 2.2.0 and 2.3.1 if BrowserJavaScriptEnabled is true)
• accept_language (2.3.1 only)
• acquirer_country_code (2.3.1 only)

Response Handling

After calling this method the transaction_status property holds the result. Possible values are:

If the transaction is authenticated (Y or A), no further steps are required. The flow is considered frictionless and the 3-D Secure processing is complete. If processing a payment, the authentication_value and authentication_eci values can be included as proof of 3-D Secure authentication.

If the transaction requires a cardholder challenge (C, D or S), further steps are required.

If the transaction is not authenticated, TransactionStatusReason may contain details about the reason.

The following properties are applicable after calling this method:

• authentication_eci
• authentication_value
• transaction_status
• TransactionStatusReason
• CardholderInformation
• acsurl (if challenge required)
• ACSChallengeMandatedIndicator (if challenge required)
• AuthenticationType (if challenge required)
• DecoupledConfirmationIndicator

Response Handling - App-Based Flow

After calling this method, client_auth_response is populated with data to be transmitted back to the 3DS SDK. If a challenge is required, the client_auth_response data is used by the 3DS SDK to start when initiating the challenge process.

The 3DS Server is responsible for indicating to the 3DS SDK the results of the send_auth_request process, and whether or not a challenge is required. Exactly how this is done is outside the scope of the classs themselves. The response to the 3DS SDK over the secure channel should include information on what to do next.

Note: The transaction_status is also populated in the 3DS Server class and may be inspected prior to transmitting client_auth_response back to the 3DS SDK.

Response Handling - Browser-Based Flow

If transaction_status is C, then additional steps are required to complete the authentication. The get_challenge_request method should be called next to obtain data to be sent to the acsurl in an authentication window in the customer's browser. Once authentication is complete, the ACS will post the results to the results_url value that was specified when calling send_auth_request.

See the get_challenge_request method for more details.

If transaction_status is D, then decoupled authentication has been accepted by the ACS. DecoupledConfirmationIndicator will have a value of Y as well. Authentication will happen outside of the 3-D Secure flow and, when complete, the ACS will post the results to the results_url that was specified when calling send_auth_request.

The DecoupledTimeRemaining value, which is calculated based on the DecoupledMaxTimeout value sent in the initial authentication request, can be checked to see the amount of time remaining before decoupled authentication must be completed. If the ACS does not post the results before this value runs out, it can be assumed that decoupled authentication was not successful.

SPC-Based Authentication

SPC (Secure Payment Confirmation) provides a method to perform a challenge using preestablished FIDO credentials when using a Browser. The SPC authentication can be initiated by the 3DS Requestor via an extra AReq/ARes message pair or by the ACS via a standard Browser Challenge Flow.

For an SPC authentication to execute correctly, the following prerequisites apply:

1. The ACS has an enrolled FIDO authenticator on the device for this Cardholder.
2. The 3DS Requestor and/or the ACS have detected that the Cardholder Browser supports the related SPC APIs (allow="payment *; publickey-credentialsget *"). For the ACS, this information can be obtained via the Browser User Agent data element or via data obtained via the 3DS Method.

SPC-based authentication can be enabled with the following additions:

Prior to sending the initial authentication request packet (AReq) using the send_auth_request method, the ThreeDSRequestorSpcSupport configuration setting should be set to True to indicate that SPC is supported by the 3DS Requestor.

If SPC is accepted by the ACS, the resulting transaction_status should be S. The response will also contain a list of enrolled FIDO (WebAuthn) credentials associated with the cardholder, and SPC transaction data. This data is available in the following configuration settings:

• WebAuthnCredentialListCount
• WebAuthnCredentialListWebAuthnCredential
• WebAuthnCredentialListRelyingPartyId
• SPCTransactionAdditionalData
• SPCTransactionChallenge
• SPCTransactionChallengeInfoText
• SPCTransactionCurrency
• SPCTransactionDisplayName
• SPCTransactionIcon
• SPCTransactionIssuerImage
• SPCTransactionIssuerImageDark
• SPCTransactionIssuerImageMonochrome
• SPCTransactionPayeeName
• SPCTransactionPayeeOrigin
• SPCTransactionPSImage
• SPCTransactionPSImageDark
• SPCTransactionPSImageMonochrome
• SPCTransactionTimeout
• SPCTransactionValue

This information is relayed to the 3DS Requestor implementation, and the 3DS Requestor invokes the SPC authentication (SPC API) against the WebAuthn Credential list. The cardholder authenticates using the FIDO authenticator on their device, and the 3DS Requestor retrieves the Assertion Data from the SPC API call.

The 3DS Server is then configured to includes this FIDO Assertion Data is then included in a new authentication request by setting the ReqAuthData[Index] and a ReqAuthMethod[Index] of 09. If the AuthenticationInformation value was saved earlier, it can be set via the same configuration setting. If the 3DS Requestor encounters an error during SPC API invokation, this can be indicated using the SPCIncompletionIndicator.

The send_auth_request method should then be called again to transmit this data to the ACS (by way of the DS) in a second AReq.

When send_auth_request returns, the 3DS Server proceed the same as the regular browser-based flow when the ARes is returned.

When SPC authentication is to be performed, the authenticaton must be completed within 9 minutes. The component will automatically start an internal timer that can be checked using the CheckSPCTimeout configuration setting. This will return the number of seconds left for SPC authentication to complete. If the time has expired before receiving the Assertion Data from the 3DS Requestor, checking this configuration setting will cause the component to automatically send the second AReq message with an SPCIncompletionIndicator value of 03, indicating that SPC authentication timed out.

Note that SPC-based authentication is only available when a message_version of 2.3.1 is used.

Processing the Authentication Response

After the response to the authentication request is received from the 3DS Server class, call check_auth_response to verify and parse the response. See the 3DS Server's send_auth_request method for details about obtaining the response.

Before calling this method, acs_root_certs must be populated with the root certificates used by the ACS to sign the response. This method will validate the signature of the signed content if present.

After calling this method, inspect transaction_status to determine if the transaction requires a challenge. If transaction_status is C, a challenge is required and send_challenge_request should be called to proceed with the challenge flow. If transaction_status is D, decoupled authentication will take place outside of the 3-D Secure flow and the results will be posted to the 3DS Server.

If transaction_status is Y or A, the transaction is complete.

Challenge Interaction

If transaction_status is C, a challenge is required. The challenge takes place between the cardholder and the ACS. During this interaction the class will communicate directly with the ACS from the app where it is used to exchange information.

send_challenge_request begins the challenge flow. send_challenge_request sends the Challenge Request to the ACS when a challenge is required.

When the transaction_status is C after calling check_auth_response, a challenge to the cardholder is required. This method sends the challenge request and parses the response. The ACS may provide multiple challenges to the cardholder during this process. As a result this method may need to be called multiple times throughout the authentication process.

After this method is called, check challenge_complete to determine if the challenge process is complete. If it is complete (True), check transaction_status to determine the outcome. If challenge_complete is False, additional challenge interaction is required.

First Request

The first time this method is called, information about the required challenge is obtained from the ACS. The ACS connection information is automatically set when check_auth_response is called; there is no need to specify any ACS connection information.

All required properties for the first call to this method are automatically set after check_auth_response is called. If the transaction has been canceled, set challenge_cancellation_indicator to inform the ACS.

After calling this method, the ACS will respond with details about the challenge to be presented to the cardholder. The acsui_type property indicates the way the ACS will interact with the cardholder. The challenge_complete property will be False after the first call to this method since the challenge interaction is not yet complete.

The following properties are applicable when acsui_type is Text (01), Single-Select (02), or Multi-Select (03):

• challenge_select_info
• challenge_info_header
• challenge_info_label
• challenge_info_text
• enable_challenge_info_text_indicator
• expandable_information_label
• expandable_information_text
• issuer_image1
• issuer_image2
• issuer_image3
• payment_system_image1
• payment_system_image2
• payment_system_image3
• resend_information_label
• submit_authentication_label
• why_information_label
• why_information_text

Use the values in the above properties to populate values in the native UI in the app. The UI must follow the guidelines defined in the EMV® 3-D Secure specification.

The following properties are applicable when acsui_type is Out-of-Band (04):

• challenge_additional_information
• challenge_info_header
• challenge_info_label
• challenge_info_text
• enable_challenge_info_text_indicator
• expandable_information_label
• expandable_information_text
• issuer_image1
• issuer_image2
• issuer_image3
• oob_continue_label
• payment_system_image1
• payment_system_image2
• payment_system_image3
• resend_information_label
• why_information_label
• why_information_text

Use the values in the above properties to populate values in the native UI in the app. The UI must follow the guidelines defined in the EMV® 3-D Secure specification.

The following properties are applicable when acsui_type is HTML (05):

• acshtml
• acshtml_refresh

In the case of an HTML interaction, the app should create a webview and populate this with the HTML in acshtml.

As per the EMV® 3-D Secure specification, the HTML UI is presented to the cardholder via a web view which remains in control of the app. The app must intercept any remote URL requests made from within the web view, and instead handle them within the app. Preventing the cardholder from making requests in the web view to another server is critical to the security of the environment. According to the EMVCo specification, intercepting these requests has two effects:

• Prevents malicious HTML from redirecting a user to a phishing site.
• Conceptually puts the web view form under the control of the ACS, rather than the app.

• Navigation attempts from within the web view must be captured by the app and handled internally. This includes all requests including images, javascript files, css, etc.
• The web view element is not utilized as a browser, but as a UI element whose content is provided by the ACS.

Second Request

The second time this method is called, the purpose is to provide a response to the ACS. At this point the customer should have responded to the challenge provided by the ACS in the response to the first call. If the transaction has been canceled, set challenge_cancellation_indicator to inform the ACS. The following properties are applicable when calling this method the second time:

• challenge_data_entry
• oob_continuation_indicator

When acsui_type is Text (01) or HTML (05), set challenge_data_entry to the data exactly as it was specified by the cardholder. Do not format or otherwise change the data.

When acsui_type is Single-Select (02), set challenge_data_entry to the name of the selected option. For instance the ACS may provide the user with a selection like:

mobile: **** **** 329
email: s******k**@g***.com

When acsui_type is Multi-Select (03), set challenge_data_entry to a comma-separated list of names of the selected options. For instance if challenge_select_info contains elements with names like chicago_illinois, st_louis_missouri, and portland_oregon, and the user chose two options, the value specified in challenge_data_entry would be chicago_illinois,portland_oregon.

When acsui_type is OOB (04), set oob_continuation_indicator to True to indicate the cardholder has pressed the button signaling their completing of the OOB process.

Completing the Challenge

After calling send_challenge_request a second time with the cardholder's responses, the ACS may require additional challenges. Check the challenge_complete property to determine if the challenge is complete. If False, more challenges are required by the ACS and the same process of displaying the challenge info, collecting the response, and submitting it to the ACS should be performed again.

If challenge_complete is True, the challenge interaction is complete and transaction_status can be inspected to determine whether the transaction was successful.

Note: As part of the challenge completion the ACS also notifies the 3DS Server of the results. This is done by posting the results to the URL defined by the results_url property of the 3DS Server class.

Logging Notes

Logging in the component is handled through the on_log event. This will fire anytime a message is built or a response is parsed, including error messages.

When the on_log event is fired, the message in question is made available via the Message event parameter. Properties such as EphemeralKey and DeviceParams are also available when they are gathered by the Client. The other event arguments are LogType and LogLevel:

The LogType parameter indicates the type of the log entry. Possible values are:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"
• "AReq"
• "ARes"
• "CReq"
• "CRes"
• "RReq"
• "RRes"
• "PReq"
• "PRes"
• "Erro"
• "EphemeralKey"
• "DeviceParams"

It is recommended to output all messages raised in this event to a file for record keeping purposes, or for later debugging issues that may have come up.

The Server and Client components also have on_data_packet_in and on_data_packet_out events that fire anytime a data packet is received or sent, respectively. The entire data packet is then accessible in the DataPacket event parameter. For encrypted packets, this would contain the full encrypted data. This parameter may be inspected for advanced troubleshooting.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

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.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

acshtml Property

HTML provided by the ACS.

Syntax

def get_acshtml() -> str: ...

acshtml = property(get_acshtml, None)

Default Value

""

Remarks

This field contains HTML provided by the ACS in the Challenge Response Message (CRes). This will be populated when the acsui_type is HTML.

As per the EMV® 3-D Secure specification, the HTML UI is presented to the cardholder via a web view which remains in control of the app. The app must intercept any remote URL requests made from within the web view, and instead handle them within the app. Preventing the cardholder from making requests in the web view to another server is critical to the security of the environment. According to the EMVCo specification, intercepting these requests has two effects:

• Prevents malicious HTML from redirecting a user to a phishing site.
• Conceptually puts the web view form under the control of the ACS, rather than the app.

• Navigation attempts from within the web view must be captured by the app and handled internally. This includes all requests including images, javascript files, css, etc.
• The web view element is not utilized as a browser, but as a UI element whose content is provided by the ACS.

This property is read-only.

acshtml_refresh Property

ACS HTML refresh.

Syntax

def get_acshtml_refresh() -> str: ...

acshtml_refresh = property(get_acshtml_refresh, None)

Default Value

""

Remarks

Optional HTML provided by the ACS in response to send_challenge_request when acsui_type is HTML (05).

If the ACS HTML Refresh is present in the CRes message, the app should display this in the web view when the app is moved to the foreground.

This property is read-only.

acs_root_cert_count Property

The number of records in the ACSRootCert arrays.

Syntax

def get_acs_root_cert_count() -> int: ...
def set_acs_root_cert_count(value: int) -> None: ...

acs_root_cert_count = property(get_acs_root_cert_count, set_acs_root_cert_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• acs_root_cert_encoded
• acs_root_cert_store
• acs_root_cert_store_password
• acs_root_cert_store_type
• acs_root_cert_subject

The array indices start at 0 and end at acs_root_cert_count - 1.

acs_root_cert_store Property

The name of the certificate store for the client certificate.

Syntax

def get_acs_root_cert_store(acs_root_cert_index: int) -> bytes: ...
def set_acs_root_cert_store(acs_root_cert_index: int, value: bytes) -> None: ...

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The acs_root_cert_store_type property denotes the type of the certificate store specified by acs_root_cert_store. If the store is password-protected, specify the password in acs_root_cert_store_password.

acs_root_cert_store is used in conjunction with the acs_root_cert_subject property to specify client certificates. If acs_root_cert_store has a value, and acs_root_cert_subject or acs_root_cert_encoded is set, a search for a certificate is initiated. Please see the acs_root_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

The acs_root_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the acs_root_cert_count property.

acs_root_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_acs_root_cert_store_password(acs_root_cert_index: int) -> str: ...
def set_acs_root_cert_store_password(acs_root_cert_index: int, value: str) -> None: ...

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

The acs_root_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the acs_root_cert_count property.

acs_root_cert_store_type Property

The type of certificate store for this certificate.

Syntax

def get_acs_root_cert_store_type(acs_root_cert_index: int) -> int: ...
def set_acs_root_cert_store_type(acs_root_cert_index: int, value: int) -> None: ...

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

The acs_root_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the acs_root_cert_count property.

acs_root_cert_subject Property

The subject of the certificate used for client authentication.

Syntax

def get_acs_root_cert_subject(acs_root_cert_index: int) -> str: ...
def set_acs_root_cert_subject(acs_root_cert_index: int, value: str) -> None: ...

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

The acs_root_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the acs_root_cert_count property.

acs_root_cert_encoded Property

The certificate (PEM/Base64 encoded).

Syntax

def get_acs_root_cert_encoded(acs_root_cert_index: int) -> bytes: ...
def set_acs_root_cert_encoded(acs_root_cert_index: int, value: bytes) -> None: ...

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The acs_root_cert_store and acs_root_cert_subject properties also may be used to specify a certificate.

When acs_root_cert_encoded is set, a search is initiated in the current acs_root_cert_store for the private key of the certificate. If the key is found, acs_root_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, acs_root_cert_subject is set to an empty string.

The acs_root_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the acs_root_cert_count property.

acsui_type Property

UI type rendered by the 3DS SDK.

Syntax

def get_acsui_type() -> int: ...

acsui_type = property(get_acsui_type, None)

Default Value

0

Remarks

This field is returned in the Challenge Response Message (CRes) from the ACS and contains the User Interface type that the 3DS SDK will render. 1 = Text 2 = Single Select 3 = Multi Select 4 = OOB 5 = HTML 6 = HTML OOB 7 = Information

This property is read-only.

challenge_additional_information Property

Challenge additional information text.

Syntax

def get_challenge_additional_information() -> str: ...

challenge_additional_information = property(get_challenge_additional_information, None)

Default Value

""

Remarks

Text provided by the ACS/Issuer to the cardholder during OOB authentication to replace challenge information text and challenge information text indicator in the OOB template.

This property is read-only.

challenge_additional_label Property

Challenge Additional Label.

Syntax

def get_challenge_additional_label() -> str: ...

challenge_additional_label = property(get_challenge_additional_label, None)

Default Value

""

Remarks

UI label for the additional choice button provided by the ACS.

This property is read-only.

challenge_cancellation_indicator Property

Challenge Cancellation Indicator.

Syntax

def get_challenge_cancellation_indicator() -> str: ...
def set_challenge_cancellation_indicator(value: str) -> None: ...

challenge_cancellation_indicator = property(get_challenge_cancellation_indicator, set_challenge_cancellation_indicator)

Default Value

""

Remarks

This field is an indicator informing the ACS and the DS that the authentication has been canceled. This is required to be set if the authentication transaction was canceled by the user. This may also be received in the Results Request from the directory server if the ACS identifies that the authentication transaction was canceled for reasons as indicated.

Possible values include:

challenge_complete Property

Whether or not the challenge cycle is complete.

Syntax

def get_challenge_complete() -> bool: ...

challenge_complete = property(get_challenge_complete, None)

Default Value

FALSE

Remarks

Present in the Challenge Response Message (CRes) and indicates whether the challenge cycle is complete or will require additional messages. If true, the transaction_status will be populated as well.

This property is read-only.

challenge_data_entry Property

Cardholder entered data.

Syntax

def get_challenge_data_entry() -> str: ...
def set_challenge_data_entry(value: str) -> None: ...

challenge_data_entry = property(get_challenge_data_entry, set_challenge_data_entry)

Default Value

""

Remarks

This field contains the data that the cardholder entered into the UI.

When acsui_type is Text (01) or HTML (05), set challenge_data_entry to the data exactly as it was specified by the cardholder. Do not format or otherwise change the data.

When acsui_type is Single-Select (02), set challenge_data_entry to the name of the selected option. For instance the ACS may provide the user with a selection like:

mobile: **** **** 329
email: s******k**@g***.com

When acsui_type is Multi-Select (03), set challenge_data_entry to a comma-separated list of names of the selected options. For instance if challenge_select_info contains elements with names like chicago_illinois, st_louis_missouri, and portland_oregon, and the user chose two options, the value specified in challenge_data_entry would be chicago_illinois,portland_oregon.

challenge_data_entry_two Property

Cardholder entered data.

Syntax

def get_challenge_data_entry_two() -> str: ...
def set_challenge_data_entry_two(value: str) -> None: ...

challenge_data_entry_two = property(get_challenge_data_entry_two, set_challenge_data_entry_two)

Default Value

""

Remarks

This field contains the data that the cardholder entered into the UI.

When acsui_type is Text (01) or HTML (05), set challenge_data_entry to the data exactly as it was specified by the cardholder. Do not format or otherwise change the data.

When acsui_type is Single-Select (02), set challenge_data_entry to the name of the selected option. For instance the ACS may provide the user with a selection like:

mobile: **** **** 329
email: s******k**@g***.com

When acsui_type is Multi-Select (03), set challenge_data_entry to a comma-separated list of names of the selected options. For instance if challenge_select_info contains elements with names like chicago_illinois, st_louis_missouri, and portland_oregon, and the user chose two options, the value specified in challenge_data_entry would be chicago_illinois,portland_oregon.

challenge_entry_box_autofill Property

Indicates if the 3DS SDK enables the autofill option for the Challenge Data Entry.

Syntax

def get_challenge_entry_box_autofill() -> bool: ...

challenge_entry_box_autofill = property(get_challenge_entry_box_autofill, None)

Default Value

FALSE

Remarks

Indicates if the 3DS SDK enables the autofill option for the Challenge Data Entry. When enabled, the 3DS SDK/OS automatically copies the received or saved code or password in the Challenge Data Entry.

This property is read-only.

challenge_entry_box_autofill_type Property

Indicates the type of data expected when the Challenge Data Entry Autofill is active.

Syntax

def get_challenge_entry_box_autofill_type() -> int: ...

challenge_entry_box_autofill_type = property(get_challenge_entry_box_autofill_type, None)

Default Value

0

Remarks

Indicates the type of data expected when the Challenge Data Entry Autofill is active. 01 = SMS OTP 02 = Password

This property is read-only.

challenge_entry_box_keyboard_type Property

Indicates if the 3DS SDK shall display a numeric or alphanumeric keyboard.

Syntax

def get_challenge_entry_box_keyboard_type() -> int: ...

challenge_entry_box_keyboard_type = property(get_challenge_entry_box_keyboard_type, None)

Default Value

0

Remarks

Indicates if the 3DS SDK shall display a numeric or alphanumeric keyboard. 0 - Undefined 1 - Numeric keyboard 2 - Alphanumeric keyboard

This property is read-only.

challenge_entry_box_label Property

Label to specify the expected data entry provided by the ACS.

Syntax

def get_challenge_entry_box_label() -> str: ...

challenge_entry_box_label = property(get_challenge_entry_box_label, None)

Default Value

""

Remarks

Label to specify the expected data entry provided by the ACS.

This property is read-only.

challenge_entry_box_length_max Property

Indicates to the 3DS SDK the maximum length of the challenge data entry.

Syntax

def get_challenge_entry_box_length_max() -> int: ...

challenge_entry_box_length_max = property(get_challenge_entry_box_length_max, None)

Default Value

0

Remarks

Indicates to the 3DS SDK the maximum length of the challenge data entry.

This property is read-only.

challenge_entry_box_masking Property

Indicates that the 3DS SDK shall mask the data entered by the Cardholder.

Syntax

def get_challenge_entry_box_masking() -> bool: ...

challenge_entry_box_masking = property(get_challenge_entry_box_masking, None)

Default Value

FALSE

Remarks

Indicates that the 3DS SDK shall mask the data entered by the Cardholder.

This property is read-only.

challenge_entry_box_masking_toggle Property

Indicates that the 3DS SDK shall display a toggle icon, and display the data entered, if selected by the Cardholder.

Syntax

def get_challenge_entry_box_masking_toggle() -> bool: ...

challenge_entry_box_masking_toggle = property(get_challenge_entry_box_masking_toggle, None)

Default Value

FALSE

Remarks

Indicates that the 3DS SDK shall display a toggle icon, and display the data entered, if selected by the Cardholder.

This property is read-only.

challenge_entry_box_two_autofill Property

Indicates if the 3DS SDK enables the autofill option for the Challenge Data Entry.

Syntax

def get_challenge_entry_box_two_autofill() -> bool: ...

challenge_entry_box_two_autofill = property(get_challenge_entry_box_two_autofill, None)

Default Value

FALSE

Remarks

Indicates if the 3DS SDK enables the autofill option for the Challenge Data Entry. When enabled, the 3DS SDK/OS automatically copies the received or saved code or password in the Challenge Data Entry.

This property is read-only.

challenge_entry_box_two_autofill_type Property

Indicates the type of data expected when the Challenge Data Entry Autofill is active.

Syntax

def get_challenge_entry_box_two_autofill_type() -> int: ...

challenge_entry_box_two_autofill_type = property(get_challenge_entry_box_two_autofill_type, None)

Default Value

0

Remarks

Indicates the type of data expected when the Challenge Data Entry Autofill is active. 01 = SMS OTP 02 = Password

This property is read-only.

challenge_entry_box_two_keyboard_type Property

Indicates if the 3DS SDK shall display a numeric or alphanumeric keyboard.

Syntax

def get_challenge_entry_box_two_keyboard_type() -> int: ...

challenge_entry_box_two_keyboard_type = property(get_challenge_entry_box_two_keyboard_type, None)

Default Value

0

Remarks

Indicates if the 3DS SDK shall display a numeric or alphanumeric keyboard. 0 - Undefined 1 - Numeric keyboard 2 - Alphanumeric keyboard

This property is read-only.

challenge_entry_box_two_label Property

Label to specify the expected data entry provided by the ACS.

Syntax

def get_challenge_entry_box_two_label() -> str: ...

challenge_entry_box_two_label = property(get_challenge_entry_box_two_label, None)

Default Value

""

Remarks

Label to specify the expected data entry provided by the ACS.

This property is read-only.

challenge_entry_box_two_length_max Property

Indicates to the 3DS SDK the maximum length of the challenge data entry.

Syntax

def get_challenge_entry_box_two_length_max() -> int: ...

challenge_entry_box_two_length_max = property(get_challenge_entry_box_two_length_max, None)

Default Value

0

Remarks

Indicates to the 3DS SDK the maximum length of the challenge data entry.

This property is read-only.

challenge_entry_box_two_masking Property

Indicates that the 3DS SDK shall mask the data entered by the Cardholder.

Syntax

def get_challenge_entry_box_two_masking() -> bool: ...

challenge_entry_box_two_masking = property(get_challenge_entry_box_two_masking, None)

Default Value

FALSE

Remarks

Indicates that the 3DS SDK shall mask the data entered by the Cardholder.

This property is read-only.

challenge_entry_box_two_masking_toggle Property

Indicates that the 3DS SDK shall display a toggle icon, and display the data entered, if selected by the Cardholder.

Syntax

def get_challenge_entry_box_two_masking_toggle() -> bool: ...

challenge_entry_box_two_masking_toggle = property(get_challenge_entry_box_two_masking_toggle, None)

Default Value

FALSE

Remarks

Indicates that the 3DS SDK shall display a toggle icon, and display the data entered, if selected by the Cardholder.

This property is read-only.

challenge_info_header Property

Challenge information screen header.

Syntax

def get_challenge_info_header() -> str: ...

challenge_info_header = property(get_challenge_info_header, None)

Default Value

""

Remarks

This field contains the header text for the challenge information screen that is being presented.

This property is read-only.

challenge_info_label Property

Challenge information label.

Syntax

def get_challenge_info_label() -> str: ...

challenge_info_label = property(get_challenge_info_label, None)

Default Value

""

Remarks

This field contains the label to modify the challenge data entry field provided by the issuer. If this field is populated, it should be displayed to the cardholder.

This property is read-only.

challenge_info_text Property

Challenge information text.

Syntax

def get_challenge_info_text() -> str: ...

challenge_info_text = property(get_challenge_info_text, None)

Default Value

""

Remarks

This field contains text provided by the ACS/Issuer to the cardholder during the challenge message exchange. If this field is populated, it should be displayed to the cardholder.

This property is read-only.

challenge_select_info_count Property

The number of records in the ChallengeSelectInfo arrays.

Syntax

def get_challenge_select_info_count() -> int: ...

challenge_select_info_count = property(get_challenge_select_info_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• challenge_select_info_name
• challenge_select_info_value

The array indices start at 0 and end at challenge_select_info_count - 1.

This property is read-only.

challenge_select_info_name Property

The name of the selection option.

Syntax

def get_challenge_select_info_name(challenge_select_info_index: int) -> str: ...

Default Value

""

Remarks

The name of the selection option.

The challenge_select_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the challenge_select_info_count property.

This property is read-only.

challenge_select_info_value Property

The value of the selection option.

Syntax

def get_challenge_select_info_value(challenge_select_info_index: int) -> str: ...

Default Value

""

Remarks

The value of the selection option.

The challenge_select_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the challenge_select_info_count property.

This property is read-only.

data_packet_out Property

Contains the data packet sent to the server.

Syntax

def get_data_packet_out() -> str: ...

data_packet_out = property(get_data_packet_out, None)

Default Value

""

Remarks

After calling either the request_card_ranges, or send_auth_request methods, this property will contain the entire data packet that was sent. Also, after calling the get_challenge_request or get_results_response method, this property will contain the constructed messages. The contents of this property should be logged for each transaction.

This property is read-only.

device_binding_data_entry Property

Device Binding Data Entry.

Syntax

def get_device_binding_data_entry() -> bool: ...
def set_device_binding_data_entry(value: bool) -> None: ...

device_binding_data_entry = property(get_device_binding_data_entry, set_device_binding_data_entry)

Default Value

FALSE

Remarks

Indicator provided by the 3DS SDK to the ACS to confirm whether the Cardholder gives consent to bind the device.

device_binding_information_text Property

Device binding information text.

Syntax

def get_device_binding_information_text() -> str: ...

device_binding_information_text = property(get_device_binding_information_text, None)

Default Value

""

Remarks

Text provided by the ACS to the Cardholder during the Device Binding process.

This property is read-only.

device_param_count Property

The number of records in the DeviceParam arrays.

Syntax

def get_device_param_count() -> int: ...
def set_device_param_count(value: int) -> None: ...

device_param_count = property(get_device_param_count, set_device_param_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• device_param_category
• device_param_field_name
• device_param_value
• device_param_value_type

The array indices start at 0 and end at device_param_count - 1.

device_param_category Property

The category of the parameter.

Syntax

def get_device_param_category(device_param_index: int) -> int: ...
def set_device_param_category(device_param_index: int, value: int) -> None: ...

Default Value

0

Remarks

The category of the parameter. Possible values include:

The device_param_index parameter specifies the index of the item in the array. The size of the array is controlled by the device_param_count property.

device_param_field_name Property

The name of the parameter.

Syntax

def get_device_param_field_name(device_param_index: int) -> str: ...
def set_device_param_field_name(device_param_index: int, value: str) -> None: ...

Default Value

""

Remarks

The name of the parameter.

The device_param_index parameter specifies the index of the item in the array. The size of the array is controlled by the device_param_count property.

device_param_value Property

The value of the parameter.

Syntax

def get_device_param_value(device_param_index: int) -> str: ...
def set_device_param_value(device_param_index: int, value: str) -> None: ...

Default Value

""

Remarks

The value of the parameter.

The device_param_index parameter specifies the index of the item in the array. The size of the array is controlled by the device_param_count property.

device_param_value_type Property

The type of the value.

Syntax

def get_device_param_value_type(device_param_index: int) -> int: ...
def set_device_param_value_type(device_param_index: int, value: int) -> None: ...

Default Value

2

Remarks

The type of the value. Possible values are:

The device_param_index parameter specifies the index of the item in the array. The size of the array is controlled by the device_param_count property.

directory_server_cert_store Property

The name of the certificate store for the client certificate.

Syntax

def get_directory_server_cert_store() -> bytes: ...
def set_directory_server_cert_store(value: bytes) -> None: ...

directory_server_cert_store = property(get_directory_server_cert_store, set_directory_server_cert_store)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The directory_server_cert_store_type property denotes the type of the certificate store specified by directory_server_cert_store. If the store is password-protected, specify the password in directory_server_cert_store_password.

directory_server_cert_store is used in conjunction with the directory_server_cert_subject property to specify client certificates. If directory_server_cert_store has a value, and directory_server_cert_subject or directory_server_cert_encoded is set, a search for a certificate is initiated. Please see the directory_server_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

directory_server_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_directory_server_cert_store_password() -> str: ...
def set_directory_server_cert_store_password(value: str) -> None: ...

directory_server_cert_store_password = property(get_directory_server_cert_store_password, set_directory_server_cert_store_password)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

directory_server_cert_store_type Property

The type of certificate store for this certificate.

Syntax

def get_directory_server_cert_store_type() -> int: ...
def set_directory_server_cert_store_type(value: int) -> None: ...

directory_server_cert_store_type = property(get_directory_server_cert_store_type, set_directory_server_cert_store_type)

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

directory_server_cert_subject Property

The subject of the certificate used for client authentication.

Syntax

def get_directory_server_cert_subject() -> str: ...
def set_directory_server_cert_subject(value: str) -> None: ...

directory_server_cert_subject = property(get_directory_server_cert_subject, set_directory_server_cert_subject)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

directory_server_cert_encoded Property

The certificate (PEM/Base64 encoded).

Syntax

def get_directory_server_cert_encoded() -> bytes: ...
def set_directory_server_cert_encoded(value: bytes) -> None: ...

directory_server_cert_encoded = property(get_directory_server_cert_encoded, set_directory_server_cert_encoded)

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The directory_server_cert_store and directory_server_cert_subject properties also may be used to specify a certificate.

When directory_server_cert_encoded is set, a search is initiated in the current directory_server_cert_store for the private key of the certificate. If the key is found, directory_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, directory_server_cert_subject is set to an empty string.

directory_server_id Property

Value of the Registered Application Provider Identifier (RID) unique to the payment system.

Syntax

def get_directory_server_id() -> str: ...
def set_directory_server_id(value: str) -> None: ...

directory_server_id = property(get_directory_server_id, set_directory_server_id)

Default Value

""

Remarks

Registered Application Provider Identifier (RID) value defined by the ISO 7816-5 standard for uniquely registering such providers. This value is unique to the Payment System involved and must be known by the 3DS Requestor App so that it may be passed to the SDK on when it invokes the createTransaction method within the SDK. Used to identify the directory_server_cert for the given DS which is used by the SDK to encrypt the Device Information. Required when directory_server_cert is an EC key.

directory_server_key_id Property

Directory Server Key Identifier (kid).

Syntax

def get_directory_server_key_id() -> str: ...
def set_directory_server_key_id(value: str) -> None: ...

directory_server_key_id = property(get_directory_server_key_id, set_directory_server_key_id)

Default Value

""

Remarks

Used to specify the Directory Server Key Identifier. There may be multiple keys for each DS, with each key having a unique identifier.

enable_challenge_info_text_indicator Property

Challenge information text indicator.

Syntax

def get_enable_challenge_info_text_indicator() -> bool: ...

enable_challenge_info_text_indicator = property(get_enable_challenge_info_text_indicator, None)

Default Value

FALSE

Remarks

This field indicates when the ACS/Issuer would like a warning icon or similar visual indicator to draw attention to the challenge_info_text that is being displayed. If this field is populated, it should affect the information being displayed to the cardholder.

This property is read-only.

error_packet Property

The error packet.

Syntax

def get_error_packet() -> str: ...

error_packet = property(get_error_packet, None)

Default Value

""

Remarks

If an error is encountered while parsing a received packet using the check_response method, this field will be populated with an error packet to be sent back to the server.

If the message being parsed is an error, this field will be populated with the received error packet itself.

This property is read-only.

expandable_information_label Property

Expandable information label.

Syntax

def get_expandable_information_label() -> str: ...

expandable_information_label = property(get_expandable_information_label, None)

Default Value

""

Remarks

Label displayed to the cardholder for the content in expandable_information_text.

This property is read-only.

expandable_information_text Property

Expandable information text.

Syntax

def get_expandable_information_text() -> str: ...

expandable_information_text = property(get_expandable_information_text, None)

Default Value

""

Remarks

This field contains text provided by the Issuer from the ACS to be displayed to the cardholder for additional information. The format should be an expandable text field.

This property is read-only.

extension_count Property

The number of records in the Extension arrays.

Syntax

def get_extension_count() -> int: ...
def set_extension_count(value: int) -> None: ...

extension_count = property(get_extension_count, set_extension_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• extension_critical
• extension_data
• extension_id
• extension_name

The array indices start at 0 and end at extension_count - 1.

extension_critical Property

Whether the extension is critical.

Syntax

def get_extension_critical(extension_index: int) -> bool: ...
def set_extension_critical(extension_index: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

Whether the extension is critical.

This setting specifies whether the recipient must understand the contents of the extension to interpret the entire message.

The extension_index parameter specifies the index of the item in the array. The size of the array is controlled by the extension_count property.

extension_data Property

The extension data as JSON.

Syntax

def get_extension_data(extension_index: int) -> str: ...
def set_extension_data(extension_index: int, value: str) -> None: ...

Default Value

""

Remarks

The extension data as JSON.

This setting specifies the JSON formatted extension data.

The extension_index parameter specifies the index of the item in the array. The size of the array is controlled by the extension_count property.

extension_id Property

The id of the specified extension.

Syntax

def get_extension_id(extension_index: int) -> str: ...
def set_extension_id(extension_index: int, value: str) -> None: ...

Default Value

""

Remarks

The id of the specified extension.

This setting specifies a unique identifier for the extension.

The extension_index parameter specifies the index of the item in the array. The size of the array is controlled by the extension_count property.

extension_name Property

The extension name.

Syntax

def get_extension_name(extension_index: int) -> str: ...
def set_extension_name(extension_index: int, value: str) -> None: ...

Default Value

""

Remarks

The extension name.

This setting specifies the name of the extension as defined by the extension owner.

The extension_index parameter specifies the index of the item in the array. The size of the array is controlled by the extension_count property.

issuer_image1 Property

Issuer image URL 1.

Syntax

def get_issuer_image1() -> str: ...

issuer_image1 = property(get_issuer_image1, None)

Default Value

""

Remarks

Sent in the initial CRes message from the ACS to the 3DS SDK to provide the URL(s) of the issuer logo or image to be used in the Native UI. before 2.3.1: Medium Density Image in 2.3.1: Default Image

This property is read-only.

issuer_image2 Property

Issuer image URL 2.

Syntax

def get_issuer_image2() -> str: ...

issuer_image2 = property(get_issuer_image2, None)

Default Value

""

Remarks

Sent in the initial CRes message from the ACS to the 3DS SDK to provide the URL(s) of the issuer logo or image to be used in the Native UI. before 2.3.1: High Density Image in 2.3.1: Dark Mode Image

This property is read-only.

issuer_image3 Property

Issuer image URL 3.

Syntax

def get_issuer_image3() -> str: ...

issuer_image3 = property(get_issuer_image3, None)

Default Value

""

Remarks

Sent in the initial CRes message from the ACS to the 3DS SDK to provide the URL(s) of the issuer logo or image to be used in the Native UI. before 2.3.1: Extra High-Density Image in 2.3.1: Monochrome Image

This property is read-only.

message_version Property

Message version.

Syntax

def get_message_version() -> str: ...
def set_message_version(value: str) -> None: ...

message_version = property(get_message_version, set_message_version)

Default Value

"2.1.0"

Remarks

This field indicates the protocol version. This should be the protocol version number of the specification utilized by the system creating this message.

Possible values are:

oob_app_label Property

OOB App label.

Syntax

def get_oob_app_label() -> str: ...

oob_app_label = property(get_oob_app_label, None)

Default Value

""

Remarks

Label to be displayed for the link to the OOB App URL. For example: "Click here to open Your Bank App."

This property is read-only.

oob_app_status Property

OOB App status.

Syntax

def get_oob_app_status() -> int: ...
def set_oob_app_status(value: int) -> None: ...

oob_app_status = property(get_oob_app_status, set_oob_app_status)

Default Value

0

Remarks

Status code indicating the problem type encountered when using the OOB App URL. 1 = Open OOB App URL failed

oob_app_url Property

OOB App label.

Syntax

def get_oob_app_url() -> str: ...

oob_app_url = property(get_oob_app_url, None)

Default Value

""

Remarks

Universal App Link to an authentication app used in the OOB authentication. The OOB App URL will open the appropriate location within the OOB Authentication App.

This property is read-only.

oob_app_url_indicator Property

OOB App URL Indicator.

Syntax

def get_oob_app_url_indicator() -> int: ...
def set_oob_app_url_indicator(value: int) -> None: ...

oob_app_url_indicator = property(get_oob_app_url_indicator, set_oob_app_url_indicator)

Default Value

1

Remarks

Indicates if the 3DS SDK supports the OOB App URL. 01 = Supported 02 = Not supported by the device 03 = Not supported by the 3DS Requestor

oob_continuation_indicator Property

OOB continuation indicator.

Syntax

def get_oob_continuation_indicator() -> int: ...
def set_oob_continuation_indicator(value: int) -> None: ...

oob_continuation_indicator = property(get_oob_continuation_indicator, set_oob_continuation_indicator)

Default Value

0

Remarks

An indicator notifying the ACS that the cardholder has completed the authentication as requested by selecting the continue button in an out-of-band (OOB) authentication method. This is exclusive to the app flow and required when the acsui_type is set to OOB when the user has selected the continue option on the device.

oob_continue_label Property

OOB continuation label.

Syntax

def get_oob_continue_label() -> str: ...

oob_continue_label = property(get_oob_continue_label, None)

Default Value

""

Remarks

Label to be used in the UI for the button that the user selects when they have completed the OOB authentication.

This property is read-only.

payment_system_image1 Property

Payment system image URL 1.

Syntax

def get_payment_system_image1() -> str: ...

payment_system_image1 = property(get_payment_system_image1, None)

Default Value

""

Remarks

Sent in the initial CRes message from the ACS to the 3DS SDK to provide the URL(s) of the directory server or payment system logo or image to be used in the Native UI. before 2.3.1: Medium Density Image in 2.3.1: Default Image

This property is read-only.

payment_system_image2 Property

Payment system image URL 2.

Syntax

def get_payment_system_image2() -> str: ...

payment_system_image2 = property(get_payment_system_image2, None)

Default Value

""

Remarks

Sent in the initial CRes message from the ACS to the 3DS SDK to provide the URL(s) of the directory server or payment system logo or image to be used in the Native UI. before 2.3.1: High Density Image in 2.3.1: Dark Mode Image

This property is read-only.

payment_system_image3 Property

Payment system image URL 3.

Syntax

def get_payment_system_image3() -> str: ...

payment_system_image3 = property(get_payment_system_image3, None)

Default Value

""

Remarks

Sent in the initial CRes message from the ACS to the 3DS SDK to provide the URL(s) of the directory server or payment system logo or image to be used in the Native UI. before 2.3.1: Extra High-Density Image in 2.3.1: Monochrome Image

This property is read-only.

proxy_auth_scheme Property

The type of authorization to perform when connecting to the proxy.

Syntax

def get_proxy_auth_scheme() -> int: ...
def set_proxy_auth_scheme(value: int) -> None: ...

proxy_auth_scheme = property(get_proxy_auth_scheme, set_proxy_auth_scheme)

Default Value

0

Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the proxy_user and proxy_password properties are set.

proxy_auth_scheme should be set to authNone (3) when no authentication is expected.

By default, proxy_auth_scheme is authBasic (0), and if the proxy_user and proxy_password properties are set, the class will attempt basic authentication.

If proxy_auth_scheme is set to authDigest (1), digest authentication will be attempted instead.

If proxy_auth_scheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If proxy_auth_scheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of proxy_user and proxy_password.

proxy_auto_detect Property

Whether to automatically detect and use proxy system settings, if available.

Syntax

def get_proxy_auto_detect() -> bool: ...
def set_proxy_auto_detect(value: bool) -> None: ...

proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect)

Default Value

FALSE

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is False.

proxy_password Property

A password if authentication is to be used for the proxy.

Syntax

def get_proxy_password() -> str: ...
def set_proxy_password(value: str) -> None: ...

proxy_password = property(get_proxy_password, set_proxy_password)

Default Value

""

Remarks

A password if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

proxy_port Property

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

def get_proxy_port() -> int: ...
def set_proxy_port(value: int) -> None: ...

proxy_port = property(get_proxy_port, set_proxy_port)

Default Value

80

Remarks

The Transmission Control Protocol (TCP) port for the proxy proxy_server (default 80). See the description of the proxy_server property for details.

proxy_server Property

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

def get_proxy_server() -> str: ...
def set_proxy_server(value: str) -> None: ...

proxy_server = property(get_proxy_server, set_proxy_server)

Default Value

""

Remarks

If a proxy proxy_server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the proxy_server property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the proxy_server property is set to the corresponding address. If the search is not successful, an error is returned.

proxy_ssl Property

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

def get_proxy_ssl() -> int: ...
def set_proxy_ssl(value: int) -> None: ...

proxy_ssl = property(get_proxy_ssl, set_proxy_ssl)

Default Value

0

Remarks

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

proxy_user Property

A username if authentication is to be used for the proxy.

Syntax

def get_proxy_user() -> str: ...
def set_proxy_user(value: str) -> None: ...

proxy_user = property(get_proxy_user, set_proxy_user)

Default Value

""

Remarks

A username if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

requestor_app_url Property

3DS Requestor App URL.

Syntax

def get_requestor_app_url() -> str: ...
def set_requestor_app_url(value: str) -> None: ...

requestor_app_url = property(get_requestor_app_url, set_requestor_app_url)

Default Value

""

Remarks

3DS Requestor App declaring its URL within the CReq message so that the Authentication app can call the 3DS Requestor App after OOB authentication has occurred. Note: When providing the 3DS Requestor App URL, the 3DS Requestor needs to properly register the URL with the Operating System.

resend_information_label Property

Label for UI button allowing users to request that authentication information be resent.

Syntax

def get_resend_information_label() -> str: ...

resend_information_label = property(get_resend_information_label, None)

Default Value

""

Remarks

Value of text to be displayed on the UI label on the button users click for authentication information to be resent. Sent in CRes if the ACS allows the Cardholder to request such information to be resent. App-based only.

This property is read-only.

sdk_app_id Property

The unique SDK App Id.

Syntax

def get_sdk_app_id() -> str: ...
def set_sdk_app_id(value: str) -> None: ...

sdk_app_id = property(get_sdk_app_id, set_sdk_app_id)

Default Value

""

Remarks

This property must be set to a universally unique Id created for a specific installation of the app on a consumer device. The app is responsible for generating and storing the sdk_app_id for each installation or update. This property must be set before calling get_auth_request.

The value assigned here must be 36 characters and be in the format defined in IETF RFC 4122. For example: 8a880dc0-d2d2-4067-bcb1-b08d1690b26e.

sdk_transaction_id Property

SDK Transaction ID.

Syntax

def get_sdk_transaction_id() -> str: ...
def set_sdk_transaction_id(value: str) -> None: ...

sdk_transaction_id = property(get_sdk_transaction_id, set_sdk_transaction_id)

Default Value

""

Remarks

This field contains the universally unique transaction identifier assigned by the 3DS SDK to identify a single transaction. This is generated by the class when calling the get_auth_request method. Shall be provided to the 3DS Server for the purpose of uniquely identifying this transaction within all messages of the authentication process, beginning with the AReq sent by the Server.

ssl_accept_server_cert_effective_date Property

The date on which this certificate becomes valid.

Syntax

def get_ssl_accept_server_cert_effective_date() -> str: ...

ssl_accept_server_cert_effective_date = property(get_ssl_accept_server_cert_effective_date, None)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

ssl_accept_server_cert_expiration_date Property

The date on which the certificate expires.

Syntax

def get_ssl_accept_server_cert_expiration_date() -> str: ...

ssl_accept_server_cert_expiration_date = property(get_ssl_accept_server_cert_expiration_date, None)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

ssl_accept_server_cert_extended_key_usage Property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_accept_server_cert_extended_key_usage() -> str: ...

ssl_accept_server_cert_extended_key_usage = property(get_ssl_accept_server_cert_extended_key_usage, None)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

ssl_accept_server_cert_fingerprint Property

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

def get_ssl_accept_server_cert_fingerprint() -> str: ...

ssl_accept_server_cert_fingerprint = property(get_ssl_accept_server_cert_fingerprint, None)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

ssl_accept_server_cert_fingerprint_sha1 Property

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

def get_ssl_accept_server_cert_fingerprint_sha1() -> str: ...

ssl_accept_server_cert_fingerprint_sha1 = property(get_ssl_accept_server_cert_fingerprint_sha1, None)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

ssl_accept_server_cert_fingerprint_sha256 Property

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

def get_ssl_accept_server_cert_fingerprint_sha256() -> str: ...

ssl_accept_server_cert_fingerprint_sha256 = property(get_ssl_accept_server_cert_fingerprint_sha256, None)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

ssl_accept_server_cert_issuer Property

The issuer of the certificate.

Syntax

def get_ssl_accept_server_cert_issuer() -> str: ...

ssl_accept_server_cert_issuer = property(get_ssl_accept_server_cert_issuer, None)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

ssl_accept_server_cert_private_key Property

The private key of the certificate (if available).

Syntax

def get_ssl_accept_server_cert_private_key() -> str: ...

ssl_accept_server_cert_private_key = property(get_ssl_accept_server_cert_private_key, None)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The ssl_accept_server_cert_private_key may be available but not exportable. In this case, ssl_accept_server_cert_private_key returns an empty string.

This property is read-only.

ssl_accept_server_cert_private_key_available Property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_accept_server_cert_private_key_available() -> bool: ...

ssl_accept_server_cert_private_key_available = property(get_ssl_accept_server_cert_private_key_available, None)

Default Value

FALSE

Remarks

Whether a ssl_accept_server_cert_private_key is available for the selected certificate. If ssl_accept_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

ssl_accept_server_cert_private_key_container Property

The name of the PrivateKey container for the certificate (if available).

Syntax

def get_ssl_accept_server_cert_private_key_container() -> str: ...

ssl_accept_server_cert_private_key_container = property(get_ssl_accept_server_cert_private_key_container, None)

Default Value

""

Remarks

The name of the ssl_accept_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

ssl_accept_server_cert_public_key Property

The public key of the certificate.

Syntax

def get_ssl_accept_server_cert_public_key() -> str: ...

ssl_accept_server_cert_public_key = property(get_ssl_accept_server_cert_public_key, None)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

ssl_accept_server_cert_public_key_algorithm Property

The textual description of the certificate's public key algorithm.

Syntax

def get_ssl_accept_server_cert_public_key_algorithm() -> str: ...

ssl_accept_server_cert_public_key_algorithm = property(get_ssl_accept_server_cert_public_key_algorithm, None)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_accept_server_cert_public_key_length Property

The length of the certificate's public key (in bits).

Syntax

def get_ssl_accept_server_cert_public_key_length() -> int: ...

ssl_accept_server_cert_public_key_length = property(get_ssl_accept_server_cert_public_key_length, None)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

ssl_accept_server_cert_serial_number Property

The serial number of the certificate encoded as a string.

Syntax

def get_ssl_accept_server_cert_serial_number() -> str: ...

ssl_accept_server_cert_serial_number = property(get_ssl_accept_server_cert_serial_number, None)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

ssl_accept_server_cert_signature_algorithm Property

The text description of the certificate's signature algorithm.

Syntax

def get_ssl_accept_server_cert_signature_algorithm() -> str: ...

ssl_accept_server_cert_signature_algorithm = property(get_ssl_accept_server_cert_signature_algorithm, None)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_accept_server_cert_store Property

The name of the certificate store for the client certificate.

Syntax

def get_ssl_accept_server_cert_store() -> bytes: ...
def set_ssl_accept_server_cert_store(value: bytes) -> None: ...

ssl_accept_server_cert_store = property(get_ssl_accept_server_cert_store, set_ssl_accept_server_cert_store)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_accept_server_cert_store_type property denotes the type of the certificate store specified by ssl_accept_server_cert_store. If the store is password-protected, specify the password in ssl_accept_server_cert_store_password.

ssl_accept_server_cert_store is used in conjunction with the ssl_accept_server_cert_subject property to specify client certificates. If ssl_accept_server_cert_store has a value, and ssl_accept_server_cert_subject or ssl_accept_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_accept_server_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

ssl_accept_server_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_ssl_accept_server_cert_store_password() -> str: ...
def set_ssl_accept_server_cert_store_password(value: str) -> None: ...

ssl_accept_server_cert_store_password = property(get_ssl_accept_server_cert_store_password, set_ssl_accept_server_cert_store_password)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

ssl_accept_server_cert_store_type Property

The type of certificate store for this certificate.

Syntax

def get_ssl_accept_server_cert_store_type() -> int: ...
def set_ssl_accept_server_cert_store_type(value: int) -> None: ...

ssl_accept_server_cert_store_type = property(get_ssl_accept_server_cert_store_type, set_ssl_accept_server_cert_store_type)

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

ssl_accept_server_cert_subject_alt_names Property

Comma-separated lists of alternative subject names for the certificate.

Syntax

def get_ssl_accept_server_cert_subject_alt_names() -> str: ...

ssl_accept_server_cert_subject_alt_names = property(get_ssl_accept_server_cert_subject_alt_names, None)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

ssl_accept_server_cert_thumbprint_md5 Property

The MD5 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_md5() -> str: ...

ssl_accept_server_cert_thumbprint_md5 = property(get_ssl_accept_server_cert_thumbprint_md5, None)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_accept_server_cert_thumbprint_sha1 Property

The SHA-1 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_sha1() -> str: ...

ssl_accept_server_cert_thumbprint_sha1 = property(get_ssl_accept_server_cert_thumbprint_sha1, None)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_accept_server_cert_thumbprint_sha256 Property

The SHA-256 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_sha256() -> str: ...

ssl_accept_server_cert_thumbprint_sha256 = property(get_ssl_accept_server_cert_thumbprint_sha256, None)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_accept_server_cert_usage Property

The text description of UsageFlags .

Syntax

def get_ssl_accept_server_cert_usage() -> str: ...

ssl_accept_server_cert_usage = property(get_ssl_accept_server_cert_usage, None)

Default Value

""

Remarks

The text description of ssl_accept_server_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

ssl_accept_server_cert_usage_flags Property

The flags that show intended use for the certificate.

Syntax

def get_ssl_accept_server_cert_usage_flags() -> int: ...

ssl_accept_server_cert_usage_flags = property(get_ssl_accept_server_cert_usage_flags, None)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_accept_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_accept_server_cert_usage property for a text representation of ssl_accept_server_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

ssl_accept_server_cert_version Property

The certificate's version number.

Syntax

def get_ssl_accept_server_cert_version() -> str: ...

ssl_accept_server_cert_version = property(get_ssl_accept_server_cert_version, None)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

ssl_accept_server_cert_subject Property

The subject of the certificate used for client authentication.

Syntax

def get_ssl_accept_server_cert_subject() -> str: ...
def set_ssl_accept_server_cert_subject(value: str) -> None: ...

ssl_accept_server_cert_subject = property(get_ssl_accept_server_cert_subject, set_ssl_accept_server_cert_subject)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

ssl_accept_server_cert_encoded Property

The certificate (PEM/Base64 encoded).

Syntax

def get_ssl_accept_server_cert_encoded() -> bytes: ...
def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_accept_server_cert_store and ssl_accept_server_cert_subject properties also may be used to specify a certificate.

When ssl_accept_server_cert_encoded is set, a search is initiated in the current ssl_accept_server_cert_store for the private key of the certificate. If the key is found, ssl_accept_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_accept_server_cert_subject is set to an empty string.

ssl_cert_effective_date Property

The date on which this certificate becomes valid.

Syntax

def get_ssl_cert_effective_date() -> str: ...

ssl_cert_effective_date = property(get_ssl_cert_effective_date, None)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

ssl_cert_expiration_date Property

The date on which the certificate expires.

Syntax

def get_ssl_cert_expiration_date() -> str: ...

ssl_cert_expiration_date = property(get_ssl_cert_expiration_date, None)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

ssl_cert_extended_key_usage Property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_cert_extended_key_usage() -> str: ...

ssl_cert_extended_key_usage = property(get_ssl_cert_extended_key_usage, None)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

ssl_cert_fingerprint Property

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

def get_ssl_cert_fingerprint() -> str: ...

ssl_cert_fingerprint = property(get_ssl_cert_fingerprint, None)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

ssl_cert_fingerprint_sha1 Property

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

def get_ssl_cert_fingerprint_sha1() -> str: ...

ssl_cert_fingerprint_sha1 = property(get_ssl_cert_fingerprint_sha1, None)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

ssl_cert_fingerprint_sha256 Property

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

def get_ssl_cert_fingerprint_sha256() -> str: ...

ssl_cert_fingerprint_sha256 = property(get_ssl_cert_fingerprint_sha256, None)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

ssl_cert_issuer Property

The issuer of the certificate.

Syntax

def get_ssl_cert_issuer() -> str: ...

ssl_cert_issuer = property(get_ssl_cert_issuer, None)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

ssl_cert_private_key Property

The private key of the certificate (if available).

Syntax

def get_ssl_cert_private_key() -> str: ...

ssl_cert_private_key = property(get_ssl_cert_private_key, None)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The ssl_cert_private_key may be available but not exportable. In this case, ssl_cert_private_key returns an empty string.

This property is read-only.

ssl_cert_private_key_available Property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_cert_private_key_available() -> bool: ...

ssl_cert_private_key_available = property(get_ssl_cert_private_key_available, None)

Default Value

FALSE

Remarks

Whether a ssl_cert_private_key is available for the selected certificate. If ssl_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

ssl_cert_private_key_container Property

The name of the PrivateKey container for the certificate (if available).

Syntax

def get_ssl_cert_private_key_container() -> str: ...

ssl_cert_private_key_container = property(get_ssl_cert_private_key_container, None)

Default Value

""

Remarks

The name of the ssl_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

ssl_cert_public_key Property

The public key of the certificate.

Syntax

def get_ssl_cert_public_key() -> str: ...

ssl_cert_public_key = property(get_ssl_cert_public_key, None)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

ssl_cert_public_key_algorithm Property

The textual description of the certificate's public key algorithm.

Syntax

def get_ssl_cert_public_key_algorithm() -> str: ...

ssl_cert_public_key_algorithm = property(get_ssl_cert_public_key_algorithm, None)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_cert_public_key_length Property

The length of the certificate's public key (in bits).

Syntax

def get_ssl_cert_public_key_length() -> int: ...

ssl_cert_public_key_length = property(get_ssl_cert_public_key_length, None)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

ssl_cert_serial_number Property

The serial number of the certificate encoded as a string.

Syntax

def get_ssl_cert_serial_number() -> str: ...

ssl_cert_serial_number = property(get_ssl_cert_serial_number, None)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

ssl_cert_signature_algorithm Property

The text description of the certificate's signature algorithm.

Syntax

def get_ssl_cert_signature_algorithm() -> str: ...

ssl_cert_signature_algorithm = property(get_ssl_cert_signature_algorithm, None)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_cert_store Property

The name of the certificate store for the client certificate.

Syntax

def get_ssl_cert_store() -> bytes: ...
def set_ssl_cert_store(value: bytes) -> None: ...

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password-protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

ssl_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_ssl_cert_store_password() -> str: ...
def set_ssl_cert_store_password(value: str) -> None: ...

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

ssl_cert_store_type Property

The type of certificate store for this certificate.

Syntax

def get_ssl_cert_store_type() -> int: ...
def set_ssl_cert_store_type(value: int) -> None: ...

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

ssl_cert_subject_alt_names Property

Comma-separated lists of alternative subject names for the certificate.

Syntax

def get_ssl_cert_subject_alt_names() -> str: ...

ssl_cert_subject_alt_names = property(get_ssl_cert_subject_alt_names, None)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

ssl_cert_thumbprint_md5 Property

The MD5 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_md5() -> str: ...

ssl_cert_thumbprint_md5 = property(get_ssl_cert_thumbprint_md5, None)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_cert_thumbprint_sha1 Property

The SHA-1 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_sha1() -> str: ...

ssl_cert_thumbprint_sha1 = property(get_ssl_cert_thumbprint_sha1, None)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_cert_thumbprint_sha256 Property

The SHA-256 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_sha256() -> str: ...

ssl_cert_thumbprint_sha256 = property(get_ssl_cert_thumbprint_sha256, None)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_cert_usage Property

The text description of UsageFlags .

Syntax

def get_ssl_cert_usage() -> str: ...

ssl_cert_usage = property(get_ssl_cert_usage, None)

Default Value

""

Remarks

The text description of ssl_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

ssl_cert_usage_flags Property

The flags that show intended use for the certificate.

Syntax

def get_ssl_cert_usage_flags() -> int: ...

ssl_cert_usage_flags = property(get_ssl_cert_usage_flags, None)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_cert_usage_flags is a combination of the following flags:

Please see the ssl_cert_usage property for a text representation of ssl_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

ssl_cert_version Property

The certificate's version number.

Syntax

def get_ssl_cert_version() -> str: ...

ssl_cert_version = property(get_ssl_cert_version, None)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

ssl_cert_subject Property

The subject of the certificate used for client authentication.

Syntax

def get_ssl_cert_subject() -> str: ...
def set_ssl_cert_subject(value: str) -> None: ...

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

ssl_cert_encoded Property

The certificate (PEM/Base64 encoded).

Syntax

def get_ssl_cert_encoded() -> bytes: ...
def set_ssl_cert_encoded(value: bytes) -> None: ...

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.

When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.

ssl_server_cert_effective_date Property

The date on which this certificate becomes valid.

Syntax

def get_ssl_server_cert_effective_date() -> str: ...

ssl_server_cert_effective_date = property(get_ssl_server_cert_effective_date, None)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

ssl_server_cert_expiration_date Property

The date on which the certificate expires.

Syntax

def get_ssl_server_cert_expiration_date() -> str: ...

ssl_server_cert_expiration_date = property(get_ssl_server_cert_expiration_date, None)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

ssl_server_cert_extended_key_usage Property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_server_cert_extended_key_usage() -> str: ...

ssl_server_cert_extended_key_usage = property(get_ssl_server_cert_extended_key_usage, None)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

ssl_server_cert_fingerprint Property

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

def get_ssl_server_cert_fingerprint() -> str: ...

ssl_server_cert_fingerprint = property(get_ssl_server_cert_fingerprint, None)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

ssl_server_cert_fingerprint_sha1 Property

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

def get_ssl_server_cert_fingerprint_sha1() -> str: ...

ssl_server_cert_fingerprint_sha1 = property(get_ssl_server_cert_fingerprint_sha1, None)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

ssl_server_cert_fingerprint_sha256 Property

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

def get_ssl_server_cert_fingerprint_sha256() -> str: ...

ssl_server_cert_fingerprint_sha256 = property(get_ssl_server_cert_fingerprint_sha256, None)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

ssl_server_cert_issuer Property

The issuer of the certificate.

Syntax

def get_ssl_server_cert_issuer() -> str: ...

ssl_server_cert_issuer = property(get_ssl_server_cert_issuer, None)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

ssl_server_cert_private_key Property

The private key of the certificate (if available).

Syntax

def get_ssl_server_cert_private_key() -> str: ...

ssl_server_cert_private_key = property(get_ssl_server_cert_private_key, None)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The ssl_server_cert_private_key may be available but not exportable. In this case, ssl_server_cert_private_key returns an empty string.

This property is read-only.

ssl_server_cert_private_key_available Property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_server_cert_private_key_available() -> bool: ...

ssl_server_cert_private_key_available = property(get_ssl_server_cert_private_key_available, None)

Default Value

FALSE

Remarks

Whether a ssl_server_cert_private_key is available for the selected certificate. If ssl_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

ssl_server_cert_private_key_container Property

The name of the PrivateKey container for the certificate (if available).

Syntax

def get_ssl_server_cert_private_key_container() -> str: ...

ssl_server_cert_private_key_container = property(get_ssl_server_cert_private_key_container, None)

Default Value

""

Remarks

The name of the ssl_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

ssl_server_cert_public_key Property

The public key of the certificate.

Syntax

def get_ssl_server_cert_public_key() -> str: ...

ssl_server_cert_public_key = property(get_ssl_server_cert_public_key, None)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

ssl_server_cert_public_key_algorithm Property

The textual description of the certificate's public key algorithm.

Syntax

def get_ssl_server_cert_public_key_algorithm() -> str: ...

ssl_server_cert_public_key_algorithm = property(get_ssl_server_cert_public_key_algorithm, None)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_server_cert_public_key_length Property

The length of the certificate's public key (in bits).

Syntax

def get_ssl_server_cert_public_key_length() -> int: ...

ssl_server_cert_public_key_length = property(get_ssl_server_cert_public_key_length, None)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

ssl_server_cert_serial_number Property

The serial number of the certificate encoded as a string.

Syntax

def get_ssl_server_cert_serial_number() -> str: ...

ssl_server_cert_serial_number = property(get_ssl_server_cert_serial_number, None)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

ssl_server_cert_signature_algorithm Property

The text description of the certificate's signature algorithm.

Syntax

def get_ssl_server_cert_signature_algorithm() -> str: ...

ssl_server_cert_signature_algorithm = property(get_ssl_server_cert_signature_algorithm, None)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_server_cert_store Property

The name of the certificate store for the client certificate.

Syntax

def get_ssl_server_cert_store() -> bytes: ...

ssl_server_cert_store = property(get_ssl_server_cert_store, None)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_server_cert_store_type property denotes the type of the certificate store specified by ssl_server_cert_store. If the store is password-protected, specify the password in ssl_server_cert_store_password.

ssl_server_cert_store is used in conjunction with the ssl_server_cert_subject property to specify client certificates. If ssl_server_cert_store has a value, and ssl_server_cert_subject or ssl_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_server_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

ssl_server_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_ssl_server_cert_store_password() -> str: ...

ssl_server_cert_store_password = property(get_ssl_server_cert_store_password, None)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is read-only.

ssl_server_cert_store_type Property

The type of certificate store for this certificate.

Syntax

def get_ssl_server_cert_store_type() -> int: ...

ssl_server_cert_store_type = property(get_ssl_server_cert_store_type, None)

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

This property is read-only.

ssl_server_cert_subject_alt_names Property

Comma-separated lists of alternative subject names for the certificate.

Syntax

def get_ssl_server_cert_subject_alt_names() -> str: ...

ssl_server_cert_subject_alt_names = property(get_ssl_server_cert_subject_alt_names, None)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

ssl_server_cert_thumbprint_md5 Property

The MD5 hash of the certificate.

Syntax

def get_ssl_server_cert_thumbprint_md5() -> str: ...

ssl_server_cert_thumbprint_md5 = property(get_ssl_server_cert_thumbprint_md5, None)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_server_cert_thumbprint_sha1 Property

The SHA-1 hash of the certificate.

Syntax

def get_ssl_server_cert_thumbprint_sha1() -> str: ...

ssl_server_cert_thumbprint_sha1 = property(get_ssl_server_cert_thumbprint_sha1, None)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_server_cert_thumbprint_sha256 Property

The SHA-256 hash of the certificate.

Syntax

def get_ssl_server_cert_thumbprint_sha256() -> str: ...

ssl_server_cert_thumbprint_sha256 = property(get_ssl_server_cert_thumbprint_sha256, None)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_server_cert_usage Property

The text description of UsageFlags .

Syntax

def get_ssl_server_cert_usage() -> str: ...

ssl_server_cert_usage = property(get_ssl_server_cert_usage, None)

Default Value

""

Remarks

The text description of ssl_server_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

ssl_server_cert_usage_flags Property

The flags that show intended use for the certificate.

Syntax

def get_ssl_server_cert_usage_flags() -> int: ...

ssl_server_cert_usage_flags = property(get_ssl_server_cert_usage_flags, None)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_server_cert_usage property for a text representation of ssl_server_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

ssl_server_cert_version Property

The certificate's version number.

Syntax

def get_ssl_server_cert_version() -> str: ...

ssl_server_cert_version = property(get_ssl_server_cert_version, None)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

ssl_server_cert_subject Property

The subject of the certificate used for client authentication.

Syntax

def get_ssl_server_cert_subject() -> str: ...

ssl_server_cert_subject = property(get_ssl_server_cert_subject, None)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is read-only.

ssl_server_cert_encoded Property

The certificate (PEM/Base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_server_cert_store and ssl_server_cert_subject properties also may be used to specify a certificate.

When ssl_server_cert_encoded is set, a search is initiated in the current ssl_server_cert_store for the private key of the certificate. If the key is found, ssl_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_server_cert_subject is set to an empty string.

This property is read-only.

submit_authentication_label Property

Label for UI button users select to submit authentication.

Syntax

def get_submit_authentication_label() -> str: ...

submit_authentication_label = property(get_submit_authentication_label, None)

Default Value

""

Remarks

Value of text to be displayed on the UI label on the button users click to submit the authentication information they have entered. Sent in CRes if acsui_type is 01 (Text), 02 (Single Select) or 02 (Multi Select). App-based only.

This property is read-only.

timeout Property

A timeout for the class.

Syntax

def get_timeout() -> int: ...
def set_timeout(value: int) -> None: ...

timeout = property(get_timeout, set_timeout)

Default Value

30

Remarks

If the timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use do_events to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If timeout expires, and the operation is not yet complete, the class fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by timeout seconds when any amount of data is successfully sent or received.

The default value for the timeout property is 30 seconds.

toggle_position_indicator Property

Toggle Position Indicator.

Syntax

def get_toggle_position_indicator() -> int: ...

toggle_position_indicator = property(get_toggle_position_indicator, None)

Default Value

0

Remarks

Indicates if the Trust List and/or Device Binding prompt should be presented below or above the action buttons.

This property is read-only.

transaction_status Property

The transaction status from the last parsed message (ARes, RReq, or CRes).

Syntax

def get_transaction_status() -> str: ...

transaction_status = property(get_transaction_status, None)

Default Value

""

Remarks

Indicates whether a transaction qualifies as an authenticated transaction or account verification. Possible values are:

Note: The CRes message can contain only a value of Y or N. Values of D and I are only applicable for 3DS version 2.2.0.

This property is read-only.

use_additional_challenge Property

Whether or not the additional choice button is selected.

Syntax

def get_use_additional_challenge() -> bool: ...
def set_use_additional_challenge(value: bool) -> None: ...

use_additional_challenge = property(get_use_additional_challenge, set_use_additional_challenge)

Default Value

FALSE

Remarks

Indicates to the ACS that the Cardholder selected the additional choice.

use_information_continuation Property

Whether or not the Information Continue button is selected.

Syntax

def get_use_information_continuation() -> bool: ...
def set_use_information_continuation(value: bool) -> None: ...

use_information_continuation = property(get_use_information_continuation, set_use_information_continuation)

Default Value

FALSE

Remarks

Indicator notifying the ACS that the Cardholder selected the Information Continue button in the Information UI template.

whitelisting_data_entry Property

Whitelisting Data Entry.

Syntax

def get_whitelisting_data_entry() -> bool: ...
def set_whitelisting_data_entry(value: bool) -> None: ...

whitelisting_data_entry = property(get_whitelisting_data_entry, set_whitelisting_data_entry)

Default Value

FALSE

Remarks

An indicator provided by the SDK to the ACS to confirm whether whitelisting was opted by the cardholder (true or false). This is required to be sent after a challenge response is received containing whitelisting_information_text.

whitelisting_information_text Property

Whitelisting information text.

Syntax

def get_whitelisting_information_text() -> str: ...

whitelisting_information_text = property(get_whitelisting_information_text, None)

Default Value

""

Remarks

Text provided by the ACS/Issuer to Cardholder during a Whitelisting transaction. For example: "Would you like to add this Merchant to your whitelist?"

If present in the challenge response, this must be displayed by the SDK.

This property is read-only.

why_information_label Property

Label for why information section.

Syntax

def get_why_information_label() -> str: ...

why_information_label = property(get_why_information_label, None)

Default Value

""

Remarks

Label provided by the Issuer for the UI "why" information section. Can be sent in CRes. App-based only.

This property is read-only.

why_information_text Property

Text to explain the authentication task to the user.

Syntax

def get_why_information_text() -> str: ...

why_information_text = property(get_why_information_text, None)

Default Value

""

Remarks

Text provided by the Issuer for UI to explain the authentication task to the user in the "why" information section. Can be sent in CRes. App-based only.

This property is read-only.

add_device_param Method

Adds a device parameter to the collection.

Syntax

def add_device_param(field: str, value: str, value_type: int, category: int) -> None: ...

Remarks

add_device_param adds a new device parameter to the device_params collection. These parameters should be obtained from the consumer device and a full list of available parameters can be found in the EMV® 3-D Secure SDK-Device Information document provided by EMVCo.

The ValueType parameter specifies the type of the value. Possible values are:

• 1 (Array)
• 2 (String)

Most parameters will have a value type of 2 (String), which will contain a single, string value. Some parameters, however, may require an array of strings. For example, the A040 parameter is defined as containing a set of paired Bluetooth devices. All of these devices can be specified via an array like so: client.addDeviceParam("A040", "[\"firstDevice\", \"secondDevice\", \"thirdDevice\"]", 1, 1);

There are four categories of device information parameters:

DV - Data Version

This is the version of the data being specified. This is 1.0 by default, but can be set to a different value as shown below. When setting the data version, only the value of the parameter needs to be specified. client1.AddDeviceParam("", "1.1", 2, 0);

DD - Device Data

This category is used to specify the device parameters collected from the mobile platform. // the device platform is Android client1.AddDeviceParam("C001", "Android", 2, 1); // the device model is an HTC One (M8) client1.AddDeviceParam("C002", "HTCOne_M8", 2, 1);

DPNA - Device Parameter Not Available

This category is used to specify reasons for unavailable device parameters. // IP Address couldn't be specified because of a "market or regional restriction on the parameter." client1.AddDeviceParam("C010", "RE01", 2, 2);

SW - Security Warning

This category of parameter is used to specify security warnings. These are used to let the directory server know of the result of checks made by the application upon initialization. When setting security warning parameters, only the name of the parameter needs to be specified. // the device is jailbroken client1.AddDeviceParam("SW01", "", 2, 3); // A debugger is attached to the app client1.AddDeviceParam("SW04", "", 2, 3);

add_extension Method

Adds an extension to the collection.

Syntax

def add_extension(id: str, name: str, critical: bool, data: str) -> None: ...

Remarks

Data necessary to support requirements not otherwise defined in the 3-D Secure message are carried in Message Extensions. add_extension adds a new extension to the extensions collection.

Note: The maximum number of extensions is 10.

add_request_field Method

Adds a field to the data in the request.

Syntax

def add_request_field(name: str, value: str, value_type: int) -> None: ...

Remarks

This method can be used to extend the requests constructed by the class. When this method is called, the component will add the specified field to the end of the request.

check_auth_response Method

Checks the received packet.

Syntax

def check_auth_response(auth_response: str) -> None: ...

Remarks

After the response to the authentication request is received from the 3DS Server class, call check_auth_response to verify and parse the response. See the 3DS Server's send_auth_request method for details about obtaining the response.

Before calling this method, acs_root_certs must be populated with the root certificates used by the ACS to sign the response. This method will validate the signature of the signed content if present.

After calling this method, inspect transaction_status to determine if the transaction requires a challenge. If transaction_status is C, a challenge is required and send_challenge_request should be called to proceed with the challenge flow. If transaction_status is D, decoupled authentication will take place outside of the 3-D Secure flow and the results will be posted to the 3DS Server.

If transaction_status is Y or A, the transaction is complete.

config Method

Sets or retrieves a configuration setting.

Syntax

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 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, you must call Config("PROPERTY"). The value will be returned as a string.

get_auth_request Method

Prepares data to be sent by the 3DS Server.

Syntax

def get_auth_request() -> str: ...

Remarks

get_auth_request encrypts the device info and prepares all the data necessary to be sent by the 3DS Server class in the send_auth_request method.

After calling this method, the returned data must be transmitted via a separate secure channel to the server where 3DS Server is being used.

The following properties are required before calling the method:

Calling this method returns required information used by 3DS Server to send the authentication request. Transmit the value returned by this method to the system where 3DS Server is used. The method used to transmit this value is outside the scope of the class.

See send_auth_request for details on sending the authentication request after transmitting the data to the 3DS Server.

Calling this method also populates sdk_transaction_id which uniquely identifies this transaction and must be used in subsequent calls relating to this transaction, such as send_challenge_request.

interrupt Method

Interrupts the current action.

Syntax

def interrupt() -> None: ...

Remarks

This method interrupts any processing that the class is currently executing.

reset Method

Clears all properties to their default values.

Syntax

def reset() -> None: ...

Remarks

This method clears all properties to their default values.

reset_transaction_info Method

Resets transaction specific information.

Syntax

def reset_transaction_info() -> None: ...

Remarks

This method must be called between transactions when using the same class instance.

Each transaction that is attempted uses transaction specific values that should not be re-used in subsequent transactions. Call this method to make sure that any transaction specific information is cleared between transactions.

This method resets only the transaction specific information without resetting any other values which have been configured. This allows re-use of the same component instance.

In an App-Based flow the following are reset:

• Internal ephemeral encryption keys
• Values added by add_request_field
• acshtml
• acshtml_refresh
• acsui_type
• challenge_additional_information
• challenge_complete
• challenge_data_entry
• challenge_info_header
• challenge_info_label
• challenge_info_text
• enable_challenge_info_text_indicator
• challenge_select_info
• data_packet_out
• device_params
• error_packet
• expandable_information_label
• expandable_information_text
• issuer_image1
• issuer_image2
• issuer_image3
• oob_continuation_indicator
• oob_continue_label
• payment_system_image1
• payment_system_image2
• payment_system_image3
• resend_information_label
• sdk_transaction_id
• submit_authentication_label
• transaction_status
• why_information_label
• why_information_text
• whitelisting_data_entry
• whitelisting_information_text
• ACSSignedContent
• ACSTransactionId
• ACSURL
• ChallengeCancellationIndicator
• DSTransactionId
• DecoupledRequestIndicator
• IncomingRawExtensions
• OutgoingRawExtensions
• extensions
• IncomingExtensionCount
• IncomingExtensionId
• IncomingExtensionName
• IncomingExtensionCritical
• IncomingExtensionData
• oob_app_label
• oob_app_url
• ResendChallengeInfo
• TransactionStatusReason
• MerchantAppURL

send_challenge_request Method

Builds and sends the Challenge Request in an app-based challenge flow.

Syntax

def send_challenge_request() -> None: ...

Remarks

send_challenge_request sends the Challenge Request to the ACS when a challenge is required.

When the transaction_status is C after calling check_auth_response, a challenge to the cardholder is required. This method sends the challenge request and parses the response. The ACS may provide multiple challenges to the cardholder during this process. As a result this method may need to be called multiple times throughout the authentication process.

After this method is called, check challenge_complete to determine if the challenge process is complete. If it is complete (True), check transaction_status to determine the outcome. If challenge_complete is False, additional challenge interaction is required.

First Request

The first time this method is called, information about the required challenge is obtained from the ACS. The ACS connection information is automatically set when check_auth_response is called; there is no need to specify any ACS connection information.

All required properties for the first call to this method are automatically set after check_auth_response is called. If the transaction has been canceled, set challenge_cancellation_indicator to inform the ACS.

After calling this method, the ACS will respond with details about the challenge to be presented to the cardholder. The acsui_type property indicates the way the ACS will interact with the cardholder. The challenge_complete property will be False after the first call to this method since the challenge interaction is not yet complete.

The following properties are applicable when acsui_type is Text (01), Single-Select (02), or Multi-Select (03):

• challenge_select_info
• challenge_info_header
• challenge_info_label
• challenge_info_text
• enable_challenge_info_text_indicator
• expandable_information_label
• expandable_information_text
• issuer_image1
• issuer_image2
• issuer_image3
• payment_system_image1
• payment_system_image2
• payment_system_image3
• resend_information_label
• submit_authentication_label
• why_information_label
• why_information_text

Use the values in the above properties to populate values in the native UI in the app. The UI must follow the guidelines defined in the EMV® 3-D Secure specification.

The following properties are applicable when acsui_type is Out-of-Band (04):

• challenge_additional_information
• challenge_info_header
• challenge_info_label
• challenge_info_text
• enable_challenge_info_text_indicator
• expandable_information_label
• expandable_information_text
• issuer_image1
• issuer_image2
• issuer_image3
• oob_continue_label
• payment_system_image1
• payment_system_image2
• payment_system_image3
• resend_information_label
• why_information_label
• why_information_text

Use the values in the above properties to populate values in the native UI in the app. The UI must follow the guidelines defined in the EMV® 3-D Secure specification.

The following properties are applicable when acsui_type is HTML (05):

• acshtml
• acshtml_refresh

In the case of an HTML interaction, the app should create a webview and populate this with the HTML in acshtml.

As per the EMV® 3-D Secure specification, the HTML UI is presented to the cardholder via a web view which remains in control of the app. The app must intercept any remote URL requests made from within the web view, and instead handle them within the app. Preventing the cardholder from making requests in the web view to another server is critical to the security of the environment. According to the EMVCo specification, intercepting these requests has two effects:

• Prevents malicious HTML from redirecting a user to a phishing site.
• Conceptually puts the web view form under the control of the ACS, rather than the app.

• Navigation attempts from within the web view must be captured by the app and handled internally. This includes all requests including images, javascript files, css, etc.
• The web view element is not utilized as a browser, but as a UI element whose content is provided by the ACS.

Second Request

The second time this method is called, the purpose is to provide a response to the ACS. At this point the customer should have responded to the challenge provided by the ACS in the response to the first call. If the transaction has been canceled, set challenge_cancellation_indicator to inform the ACS. The following properties are applicable when calling this method the second time:

• challenge_data_entry
• oob_continuation_indicator

When acsui_type is Text (01) or HTML (05), set challenge_data_entry to the data exactly as it was specified by the cardholder. Do not format or otherwise change the data.

When acsui_type is Single-Select (02), set challenge_data_entry to the name of the selected option. For instance the ACS may provide the user with a selection like:

mobile: **** **** 329
email: s******k**@g***.com

When acsui_type is Multi-Select (03), set challenge_data_entry to a comma-separated list of names of the selected options. For instance if challenge_select_info contains elements with names like chicago_illinois, st_louis_missouri, and portland_oregon, and the user chose two options, the value specified in challenge_data_entry would be chicago_illinois,portland_oregon.

When acsui_type is OOB (04), set oob_continuation_indicator to True to indicate the cardholder has pressed the button signaling their completing of the OOB process.

Completing the Challenge

After calling send_challenge_request a second time with the cardholder's responses, the ACS may require additional challenges. Check the challenge_complete property to determine if the challenge is complete. If False, more challenges are required by the ACS and the same process of displaying the challenge info, collecting the response, and submitting it to the ACS should be performed again.

If challenge_complete is True, the challenge interaction is complete and transaction_status can be inspected to determine whether the transaction was successful.

Note: As part of the challenge completion the ACS also notifies the 3DS Server of the results. This is done by posting the results to the URL defined by the results_url property of the 3DS Server class.

on_data_packet_in Event

Fired when receiving a data packet from the server.

Syntax

class ClientDataPacketInEventParams(object):
  @property
  def data_packet() -> bytes: ...

# In class Client:
@property
def on_data_packet_in() -> Callable[[ClientDataPacketInEventParams], None]: ...
@on_data_packet_in.setter
def on_data_packet_in(event_hook: Callable[[ClientDataPacketInEventParams], None]) -> None: ...

Remarks

This event fires when a packet is received. The entire data packet (including all framing and error detection characters) is contained in the DataPacket parameter. This parameter may be inspected for advanced troubleshooting, or to extract additional response properties beyond the scope of this component.

on_data_packet_out Event

Fired when sending a data packet to the server.

Syntax

class ClientDataPacketOutEventParams(object):
  @property
  def data_packet() -> bytes: ...

# In class Client:
@property
def on_data_packet_out() -> Callable[[ClientDataPacketOutEventParams], None]: ...
@on_data_packet_out.setter
def on_data_packet_out(event_hook: Callable[[ClientDataPacketOutEventParams], None]) -> None: ...

Remarks

This event fires right before each data packet is sent. The entire data packet (including all framing and error detection characters) is contained in the DataPacket parameter. This parameter may be inspected for advanced troubleshooting, or may be modified to support additional features beyond the scope of this component.

on_error Event

Information about errors during data delivery.

Syntax

class ClientErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class Client:
@property
def on_error() -> Callable[[ClientErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[ClientErrorEventParams], None]) -> None: ...

Remarks

The on_error event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_log Event

Fires once for each log message.

Syntax

class ClientLogEventParams(object):
  @property
  def log_level() -> int: ...

  @property
  def message() -> str: ...

  @property
  def log_type() -> str: ...

# In class Client:
@property
def on_log() -> Callable[[ClientLogEventParams], None]: ...
@on_log.setter
def on_log(event_hook: Callable[[ClientLogEventParams], None]) -> None: ...

Remarks

Logging in the component is handled through the on_log event. This will fire anytime a message is built or a response is parsed, including error messages.

When the on_log event is fired, the message in question is made available via the Message event parameter. Properties such as EphemeralKey and DeviceParams are also available when they are gathered by the Client. The other event arguments are LogType and LogLevel:

The LogType parameter indicates the type of the log entry. Possible values are:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"
• "AReq"
• "ARes"
• "CReq"
• "CRes"
• "RReq"
• "RRes"
• "PReq"
• "PRes"
• "Erro"
• "EphemeralKey"
• "DeviceParams"

It is recommended to output all messages raised in this event to a file for record keeping purposes, or for later debugging issues that may have come up.

The Server and Client components also have on_data_packet_in and on_data_packet_out events that fire anytime a data packet is received or sent, respectively. The entire data packet is then accessible in the DataPacket event parameter. For encrypted packets, this would contain the full encrypted data. This parameter may be inspected for advanced troubleshooting.

on_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

class ClientSSLServerAuthenticationEventParams(object):
  @property
  def cert_encoded() -> bytes: ...

  @property
  def cert_subject() -> str: ...

  @property
  def cert_issuer() -> str: ...

  @property
  def status() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class Client:
@property
def on_ssl_server_authentication() -> Callable[[ClientSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[ClientSSLServerAuthenticationEventParams], None]) -> None: ...

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

on_ssl_status Event

Fired when secure connection progress messages are available.

Syntax

class ClientSSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class Client:
@property
def on_ssl_status() -> Callable[[ClientSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[ClientSSLStatusEventParams], None]) -> None: ...

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

Client Config Settings

Client Config Settings

<firstlevel>
  <one>value</one>
  <two>
    <item>first</item>
    <item>second</item>
  </two>
  <three>value three</three>
</firstlevel>

{
  "firstlevel": {
    "one": "value",
    "two": ["first", "second"],
    "three": "value three"
  }
}

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Client Errors

Client Errors

HTTP Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

SSL Errors

TCP/IP Errors