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
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 AddDeviceParam method. Consult the EMV® 3-D Secure Specifications for more details about applicable device parameters for each particular operating system.
The GetAuthRequest method is used to obtain the request message to be send to the directory server. GetAuthRequest encrypts the device info and prepares all the data necessary to be sent by the 3DS Server class in the SendAuthRequest 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:
Property | Description |
DeviceParams | Contains device information parameters. Add parameters via AddDeviceParam. |
DirectoryServerCert | Used to encrypt the device parameters. |
DirectoryServerId | Identifies the DirectoryServerCert within the directory server. |
SDKAppId | A UUID for the specific installation. |
SDKReferenceNumber | An Id assigned by EMVCo to identify the vendor and software version. |
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 SendAuthRequest for details on sending the authentication request after transmitting the data to the 3DS Server.
Calling this method also populates SDKTransactionId which uniquely identifies this transaction and must be used in subsequent calls relating to this transaction, such as SendChallengeRequest.
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.
SendAuthRequest begins the 3-D Secure transaction flow by sending an authentication request to the DirectoryServerURL.
After calling this method, check TransactionStatus to determine if the cardholder is authenticated (frictionless flow) or further cardholder interaction is required to complete the authentication (challenge flow).
Prior to calling SendAuthRequest, 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:
- AcquirerBIN (required)
- AcquirerMerchantId (required)
- CardholderName (required)
- CardNumber (required)
- DirectoryServerURL (required)
- MerchantCategoryCode (required)
- MerchantCountryCode (required)
- MerchantName (required)
- PurchaseAmount (required)
- PurchaseDate (required)
- RequestorId (required)
- RequestorName (required)
- RequestorURL (required)
- ResultsURL (required)
- AccountType
- AuthenticationIndicator
- BillingAddress*
- CardholderEmail
- CardholderHomePhone
- CardholderMobilePhone
- CardholderWorkPhone
- DecoupledMaxTimeout
- DecoupledRequestIndicator
- DeviceChannel
- MessageCategory
- PurchaseCurrency
- PurchaseExponent
- ServerOperatorId
- ServerTransactionId
- 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 ClientAuthRequest 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 CardRangeMethodURL has been set by the ACS. Card range data may be retrieved by calling RequestCardRanges.
If no CardRangeMethodURL is present for the given card, set MethodCompletionIndicator to U.
If a CardRangeMethodURL 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 GetMethodData 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 SendAuthRequest.
The following additional properties are applicable in browser-based flow:
- NotificationURL (required)
- BrowserAcceptHeader (required)
- BrowserLanguage (required)
- BrowserScreenHeight (required in 2.1.0, required in 2.2.0 and 2.3.1 if BrowserJavaScriptEnabled is true)
- BrowserScreenWidth (required in 2.1.0, required in 2.2.0 and 2.3.1 if BrowserJavaScriptEnabled is true)
- BrowserTimeZone (required in 2.1.0, required in 2.2.0 and 2.3.1 if BrowserJavaScriptEnabled is true)
- BrowserUserAgent (required)
- BrowserIPAddress (conditional)
- BrowserJavaEnabledVal (required in 2.1.0, required in 2.2.0 and 2.3.1 if BrowserJavaScriptEnabled is true)
- BrowserJavaScriptEnabledVal (not valid in 2.1.0, required in 2.2.0 and 2.3.1)
- BrowserScreenColorDepth (required in 2.1.0, required in 2.2.0 and 2.3.1 if BrowserJavaScriptEnabled is true)
- AcceptLanguage (2.3.1 only)
- AcquirerCountryCode (2.3.1 only)
Response Handling
After calling this method the TransactionStatus property holds the result. Possible values are:
Transaction Status | Description |
Y | Authenticated successfully |
C | Cardholder challenge required |
N | Not authenticated |
A | Not authenticated, but a proof of authentication attempt was generated in AuthenticationValue |
U | Not authenticated due to technical or other issue |
R | Not authenticated because the issuer is rejecting authentication |
D | Challenge required; decoupled authentication confirmed |
I | Informational only; 3DS Requestor challenge preference acknowledged |
S | Challenge using SPC |
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 AuthenticationValue and AuthenticationECI 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:
- AuthenticationECI
- AuthenticationValue
- TransactionStatus
- TransactionStatusReason
- CardholderInformation
- ACSURL (if challenge required)
- ACSChallengeMandatedIndicator (if challenge required)
- AuthenticationType (if challenge required)
- DecoupledConfirmationIndicator
Response Handling - App-Based Flow
After calling this method, ClientAuthResponse is populated with data to be transmitted back to the 3DS SDK. If a challenge is required, the ClientAuthResponse 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 SendAuthRequest 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 TransactionStatus is also populated in the 3DS Server class and may be inspected prior to transmitting ClientAuthResponse back to the 3DS SDK.
Response Handling - Browser-Based Flow
If TransactionStatus is C, then additional steps are required to complete the authentication. The GetChallengeRequest 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 ResultsURL value that was specified when calling SendAuthRequest.
See the GetChallengeRequest method for more details.
If TransactionStatus 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 ResultsURL that was specified when calling SendAuthRequest.
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:
- The ACS has an enrolled FIDO authenticator on the device for this Cardholder.
- 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 SendAuthRequest method, the ThreeDSRequestorSpcSupport configuration setting should be set to Y to indicate that SPC is supported by the 3DS Requestor.
If SPC is accepted by the ACS, the resulting TransactionStatus 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 and a ReqAuthMethod 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 SendAuthRequest method should then be called again to transmit this data to the ACS (by way of the DS) in a second AReq.
When SendAuthRequest 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 ProtocolVersion 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 CheckAuthResponse to verify and parse the response. See the 3DS Server's SendAuthRequest method for details about obtaining the response.
Before calling this method, ACSRootCerts 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 TransactionStatus to determine if the transaction requires a challenge. If TransactionStatus is C, a challenge is required and SendChallengeRequest should be called to proceed with the challenge flow. If TransactionStatus 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 TransactionStatus is Y or A, the transaction is complete.
Challenge Interaction
If TransactionStatus 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.
SendChallengeRequest begins the challenge flow. SendChallengeRequest sends the Challenge Request to the ACS when a challenge is required.
When the TransactionStatus is C after calling CheckAuthResponse, 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 ChallengeComplete to determine if the challenge process is complete. If it is complete (True), check TransactionStatus to determine the outcome. If ChallengeComplete 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 CheckAuthResponse 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 CheckAuthResponse is called. If the transaction has been canceled, set ChallengeCancellationIndicator to inform the ACS.
After calling this method, the ACS will respond with details about the challenge to be presented to the cardholder. The ACSUIType property indicates the way the ACS will interact with the cardholder. The ChallengeComplete 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 ACSUIType is Text (01), Single-Select (02), or Multi-Select (03):
- ChallengeSelectInfo
- ChallengeInfoHeader
- ChallengeInfoLabel
- ChallengeInfoText
- EnableChallengeInfoTextIndicator
- ExpandableInformationLabel
- ExpandableInformationText
- IssuerImage1
- IssuerImage2
- IssuerImage3
- PaymentSystemImage1
- PaymentSystemImage2
- PaymentSystemImage3
- ResendInformationLabel
- SubmitAuthenticationLabel
- WhyInformationLabel
- WhyInformationText
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 ACSUIType is Out-of-Band (04):
- ChallengeAdditionalInformation
- ChallengeInfoHeader
- ChallengeInfoLabel
- ChallengeInfoText
- EnableChallengeInfoTextIndicator
- ExpandableInformationLabel
- ExpandableInformationText
- IssuerImage1
- IssuerImage2
- IssuerImage3
- OOBContinueLabel
- PaymentSystemImage1
- PaymentSystemImage2
- PaymentSystemImage3
- ResendInformationLabel
- WhyInformationLabel
- WhyInformationText
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 ACSUIType is HTML (05):
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 ChallengeCancellationIndicator to inform the ACS. The following properties are applicable when calling this method the second time:
When ACSUIType is Text (01) or HTML (05), set ChallengeDataEntry to the data exactly as it was specified by the cardholder. Do not format or otherwise change the data.
When ACSUIType is Single-Select (02), set ChallengeDataEntry 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***.comThe value to provide in ChallengeDataEntry is the ChallengeSelectInfoName, i.e. mobile.
When ACSUIType is Multi-Select (03), set ChallengeDataEntry to a comma-separated list of names of the selected options. For instance if ChallengeSelectInfo contains elements with names like chicago_illinois, st_louis_missouri, and portland_oregon, and the user chose two options, the value specified in ChallengeDataEntry would be chicago_illinois,portland_oregon.
When ACSUIType is OOB (04), set OOBContinuationIndicator to True to indicate the cardholder has pressed the button signaling their completing of the OOB process.
Completing the Challenge
After calling SendChallengeRequest a second time with the cardholder's responses, the ACS may require additional challenges. Check the ChallengeComplete 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 ChallengeComplete is True, the challenge interaction is complete and TransactionStatus 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 ResultsURL property of the 3DS Server class.
Logging Notes
Logging in the component is handled through the Log event. This will fire anytime a message is built or a response is parsed, including error messages.
When the 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 DataPacketIn and DataPacketOut 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.
ACSHTML | HTML provided by the ACS. |
ACSHTMLRefresh | ACS HTML refresh. |
ACSRootCertCount | The number of records in the ACSRootCert arrays. |
ACSRootCertEncoded | This is the certificate (PEM/base64 encoded). |
ACSRootCertStore | This is the name of the certificate store for the client certificate. |
ACSRootCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
ACSRootCertStoreType | This is the type of certificate store for this certificate. |
ACSRootCertSubject | This is the subject of the certificate used for client authentication. |
ACSUIType | UI type rendered by the 3DS SDK. |
ChallengeAdditionalInformation | Challenge additional information text. |
ChallengeAdditionalLabel | Challenge Additional Label. |
ChallengeCancellationIndicator | Challenge Cancellation Indicator. |
ChallengeComplete | Whether or not the challenge cycle is complete. |
ChallengeDataEntry | Cardholder entered data. |
ChallengeDataEntryTwo | Cardholder entered data. |
ChallengeEntryBoxAutofill | Indicates if the 3DS SDK enables the autofill option for the Challenge Data Entry. |
ChallengeEntryBoxAutofillType | Indicates the type of data expected when the Challenge Data Entry Autofill is active. |
ChallengeEntryBoxKeyboardType | Indicates if the 3DS SDK shall display a numeric or alphanumeric keyboard. |
ChallengeEntryBoxLabel | Label to specify the expected data entry provided by the ACS. |
ChallengeEntryBoxLengthMax | Indicates to the 3DS SDK the maximum length of the challenge data entry. |
ChallengeEntryBoxMasking | Indicates that the 3DS SDK shall mask the data entered by the Cardholder. |
ChallengeEntryBoxMaskingToggle | Indicates that the 3DS SDK shall display a toggle icon, and display the data entered, if selected by the Cardholder. |
ChallengeEntryBoxTwoAutofill | Indicates if the 3DS SDK enables the autofill option for the Challenge Data Entry. |
ChallengeEntryBoxTwoAutofillType | Indicates the type of data expected when the Challenge Data Entry Autofill is active. |
ChallengeEntryBoxTwoKeyboardType | Indicates if the 3DS SDK shall display a numeric or alphanumeric keyboard. |
ChallengeEntryBoxTwoLabel | Label to specify the expected data entry provided by the ACS. |
ChallengeEntryBoxTwoLengthMax | Indicates to the 3DS SDK the maximum length of the challenge data entry. |
ChallengeEntryBoxTwoMasking | Indicates that the 3DS SDK shall mask the data entered by the Cardholder. |
ChallengeEntryBoxTwoMaskingToggle | Indicates that the 3DS SDK shall display a toggle icon, and display the data entered, if selected by the Cardholder. |
ChallengeInfoHeader | Challenge information screen header. |
ChallengeInfoLabel | Challenge information label. |
ChallengeInfoText | Challenge information text. |
ChallengeSelectInfoCount | The number of records in the ChallengeSelectInfo arrays. |
ChallengeSelectInfoName | The name of the selection option. |
ChallengeSelectInfoValue | The value of the selection option. |
DataPacketOut | Contains the data packet sent to the server. |
DeviceBindingDataEntry | Device Binding Data Entry. |
DeviceBindingInformationText | Device binding information text. |
DeviceParamCount | The number of records in the DeviceParam arrays. |
DeviceParamCategory | The category of the parameter. |
DeviceParamFieldName | The name of the parameter. |
DeviceParamValue | The value of the parameter. |
DeviceParamValueType | The type of the value. |
DirectoryServerCertEncoded | This is the certificate (PEM/base64 encoded). |
DirectoryServerCertStore | This is the name of the certificate store for the client certificate. |
DirectoryServerCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
DirectoryServerCertStoreType | This is the type of certificate store for this certificate. |
DirectoryServerCertSubject | This is the subject of the certificate used for client authentication. |
DirectoryServerId | Value of the Registered Application Provider Identifier (RID) unique to the payment system. |
DirectoryServerKeyId | Directory Server Key Identifier (kid). |
EnableChallengeInfoTextIndicator | Challenge information text indicator. |
ErrorPacket | The error packet. |
ExpandableInformationLabel | Expandable information label. |
ExpandableInformationText | Expandable information text. |
ExtensionCount | The number of records in the Extension arrays. |
ExtensionCritical | Whether the extension is critical. |
ExtensionData | The extension data as JSON. |
ExtensionId | The id of the specified extension. |
ExtensionName | The extension name. |
IssuerImage1 | Issuer image URL 1. |
IssuerImage2 | Issuer image URL 2. |
IssuerImage3 | Issuer image URL 3. |
MessageVersion | Message version. |
OOBAppLabel | OOB App label. |
OOBAppStatus | OOB App status. |
OOBAppURL | OOB App label. |
OOBAppURLIndicator | OOB App URL Indicator. |
OOBContinuationIndicator | OOB continuation indicator. |
OOBContinueLabel | OOB continuation label. |
PaymentSystemImage1 | Payment system image URL 1. |
PaymentSystemImage2 | Payment system image URL 2. |
PaymentSystemImage3 | Payment system image URL 3. |
ProxyAuthScheme | This property is used to tell the class which type of authorization to perform when connecting to the proxy. |
ProxyAutoDetect | This property tells the class whether or not to automatically detect and use proxy system settings, if available. |
ProxyPassword | This property contains a password if authentication is to be used for the proxy. |
ProxyPort | This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80). |
ProxyServer | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
ProxySSL | This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. |
ProxyUser | This property contains a user name, if authentication is to be used for the proxy. |
RequestorAppURL | 3DS Requestor App URL. |
ResendInformationLabel | Label for UI button allowing users to request that authentication information be resent. |
SDKAppId | The unique SDK App Id. |
SDKTransactionId | SDK Transaction ID. |
SSLAcceptServerCertEncoded | This is the certificate (PEM/base64 encoded). |
SSLCertEncoded | This is the certificate (PEM/base64 encoded). |
SSLCertStore | This is the name of the certificate store for the client certificate. |
SSLCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLCertStoreType | This is the type of certificate store for this certificate. |
SSLCertSubject | This is the subject of the certificate used for client authentication. |
SSLServerCertEncoded | This is the certificate (PEM/base64 encoded). |
SubmitAuthenticationLabel | Label for UI button users select to submit authentication. |
Timeout | A timeout for the class. |
TogglePositionIndicator | Toggle Position Indicator. |
TransactionStatus | The transaction status from the last parsed message (ARes, RReq, or CRes). |
UseAdditionalChallenge | Whether or not the additional choice button is selected. |
UseInformationContinuation | Whether or not the Information Continue button is selected. |
WhitelistingDataEntry | Whitelisting Data Entry. |
WhitelistingInformationText | Whitelisting information text. |
WhyInformationLabel | Label for why information section. |
WhyInformationText | Text to explain the authentication task to the user. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
AddDeviceParam | Adds a device parameter to the collection. |
AddExtension | Adds an extension to the collection. |
AddRequestField | Adds a field to the data in the request. |
CheckAuthResponse | Checks the received packet. |
Config | Sets or retrieves a configuration setting. |
GetAuthRequest | Prepares data to be sent by the 3DS Server. |
Interrupt | Interrupts the current action. |
Reset | Clears all properties to their default values. |
ResetTransactionInfo | Resets transaction specific information. |
SendChallengeRequest | Builds and sends the Challenge Request in an app-based challenge flow. |
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.
DataPacketIn | Fired when receiving a data packet from the server. |
DataPacketOut | Fired when sending a data packet to the server. |
Error | Information about errors during data delivery. |
Log | Fires once for each log message. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Shows the progress of the secure connection. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
AcceptAnyACSCert | Whether to accept any ACS certificate during signature validation. |
ACSRenderingDeviceUserInterfaceMode | User interface mode the ACS will present to cardholder. |
ACSRenderingInterface | Challenge interface type presented to cardholder. |
ACSRenderingUITemplate | Challenge type presented to cardholder. |
ACSSignedContent | String value of the JWS object of the ARes message created by the ACS. |
ACSTransactionId | Unique transaction identifier assigned by the ACS. |
ACSURL | ACS URL to which the challenge request is sent. |
ChallengeResponse | Challenge Response (CRes). |
ChallengeTimeRemaining | Amount of time left to complete challenge. |
DeviceRenderingInterface | SDK Interface Device Rendering Types supported. |
DeviceRenderingUIType | SDK UI Types supported. |
DSTransactionId | Directory server transaction ID. |
ErrorCode | Code from the last error message. |
ErrorDescription | Description from the last error message. |
ErrorDetail | Additional details from the last error message. |
IncomingExtensionCount | The number of extensions received from the directory server. |
IncomingExtensionCritical[Index] | Whether the extension is critical. |
IncomingExtensionData[Index] | The extension data as JSON. |
IncomingExtensionId[Index] | The id of the specified extension. |
IncomingExtensionName[Index] | The extension name. |
IncomingRawExtensions | The full JSON formatted extension data received from the directory server. |
LogLevel | Level of logging enabled. |
MaskSensitive | Whether to mask sensitive data in the Log event. |
MerchantAppURL | 3DS Requestor App URL. |
MessageType | Type of message that is passed. |
OutgoingRawExtensions | The full JSON formatted extension data sent to the directory server. |
ProtocolVersion | Protocol version identifier. |
ResendChallengeInfo | Resend challenge information code. |
SdkAppId | SDK App ID. |
SdkAuthenticationType | SDK Authentication Type. |
SDKEphemeralPrivateKey | Private key class of the ephemeral key pair generated by the Client. |
SDKEphemeralPublicKey | Public key class of the ephemeral key pair generated by the Client. |
SDKMaxTimeout | SDK Maximum Timeout. |
SDKReferenceNumber | Assigned SDK reference number. |
SDKTransactionId | SDK Transaction ID. |
ServerTransactionId | Unique transaction identifier assigned by the 3DS Server. |
TransactionStatusReason | Reason for value of TransactionStatus. |
UseAESGCM | Whether or not to use AESGCM as the encryption algorithm. |
XChildCount | The number of child elements of the current element. |
XChildName[i] | The name of the child element. |
XChildXText[i] | The inner text of the child element. |
XElement | The name of the current element. |
XParent | The parent of the current element. |
XPath | Provides a way to point to a specific element in the returned XML or JSON response. |
XSubTree | A snapshot of the current element in the document. |
XText | The text of the current element. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
ACSHTML Property (Client Class)
HTML provided by the ACS.
Syntax
ANSI (Cross Platform) char* GetACSHTML(); Unicode (Windows) LPWSTR GetACSHTML();
char* ipworks3ds_client_getacshtml(void* lpObj);
QString GetACSHTML();
Default Value
""
Remarks
This field contains HTML provided by the ACS in the Challenge Response Message (CRes). This will be populated when the ACSUIType 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.
Data Type
String
ACSHTMLRefresh Property (Client Class)
ACS HTML refresh.
Syntax
ANSI (Cross Platform) char* GetACSHTMLRefresh(); Unicode (Windows) LPWSTR GetACSHTMLRefresh();
char* ipworks3ds_client_getacshtmlrefresh(void* lpObj);
QString GetACSHTMLRefresh();
Default Value
""
Remarks
Optional HTML provided by the ACS in response to SendChallengeRequest when ACSUIType 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.
Data Type
String
ACSRootCertCount Property (Client Class)
The number of records in the ACSRootCert arrays.
Syntax
ANSI (Cross Platform) int GetACSRootCertCount();
int SetACSRootCertCount(int iACSRootCertCount); Unicode (Windows) INT GetACSRootCertCount();
INT SetACSRootCertCount(INT iACSRootCertCount);
int ipworks3ds_client_getacsrootcertcount(void* lpObj);
int ipworks3ds_client_setacsrootcertcount(void* lpObj, int iACSRootCertCount);
int GetACSRootCertCount();
int SetACSRootCertCount(int iACSRootCertCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at ACSRootCertCount - 1.This property is not available at design time.
Data Type
Integer
ACSRootCertEncoded Property (Client Class)
This is the certificate (PEM/base64 encoded).
Syntax
ANSI (Cross Platform) int GetACSRootCertEncoded(int iACSRootCertIndex, char* &lpACSRootCertEncoded, int &lenACSRootCertEncoded);
int SetACSRootCertEncoded(int iACSRootCertIndex, const char* lpACSRootCertEncoded, int lenACSRootCertEncoded); Unicode (Windows) INT GetACSRootCertEncoded(INT iACSRootCertIndex, LPSTR &lpACSRootCertEncoded, INT &lenACSRootCertEncoded);
INT SetACSRootCertEncoded(INT iACSRootCertIndex, LPCSTR lpACSRootCertEncoded, INT lenACSRootCertEncoded);
int ipworks3ds_client_getacsrootcertencoded(void* lpObj, int acsrootcertindex, char** lpACSRootCertEncoded, int* lenACSRootCertEncoded);
int ipworks3ds_client_setacsrootcertencoded(void* lpObj, int acsrootcertindex, const char* lpACSRootCertEncoded, int lenACSRootCertEncoded);
QByteArray GetACSRootCertEncoded(int iACSRootCertIndex);
int SetACSRootCertEncoded(int iACSRootCertIndex, QByteArray qbaACSRootCertEncoded);
Default Value
""
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The ACSRootCertStore and ACSRootCertSubject properties also may be used to specify a certificate.
When ACSRootCertEncoded is set, a search is initiated in the current ACSRootCertStore for the private key of the certificate. If the key is found, ACSRootCertSubject is updated to reflect the full subject of the selected certificate; otherwise, ACSRootCertSubject is set to an empty string.
The ACSRootCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ACSRootCertCount property.
This property is not available at design time.
Data Type
Binary String
ACSRootCertStore Property (Client Class)
This is the name of the certificate store for the client certificate.
Syntax
ANSI (Cross Platform) int GetACSRootCertStore(int iACSRootCertIndex, char* &lpACSRootCertStore, int &lenACSRootCertStore);
int SetACSRootCertStore(int iACSRootCertIndex, const char* lpACSRootCertStore, int lenACSRootCertStore); Unicode (Windows) INT GetACSRootCertStore(INT iACSRootCertIndex, LPSTR &lpACSRootCertStore, INT &lenACSRootCertStore);
INT SetACSRootCertStore(INT iACSRootCertIndex, LPCSTR lpACSRootCertStore, INT lenACSRootCertStore);
int ipworks3ds_client_getacsrootcertstore(void* lpObj, int acsrootcertindex, char** lpACSRootCertStore, int* lenACSRootCertStore);
int ipworks3ds_client_setacsrootcertstore(void* lpObj, int acsrootcertindex, const char* lpACSRootCertStore, int lenACSRootCertStore);
QByteArray GetACSRootCertStore(int iACSRootCertIndex);
int SetACSRootCertStore(int iACSRootCertIndex, QByteArray qbaACSRootCertStore);
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The ACSRootCertStoreType property denotes the type of the certificate store specified by ACSRootCertStore. If the store is password protected, specify the password in ACSRootCertStorePassword.
ACSRootCertStore is used in conjunction with the ACSRootCertSubject property to specify client certificates. If ACSRootCertStore has a value, and ACSRootCertSubject or ACSRootCertEncoded is set, a search for a certificate is initiated. Please see the ACSRootCertSubject property for details.
Designations of certificate stores are platform-dependent.
The following are designations of the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).
The ACSRootCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ACSRootCertCount property.
This property is not available at design time.
Data Type
Binary String
ACSRootCertStorePassword Property (Client Class)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
ANSI (Cross Platform) char* GetACSRootCertStorePassword(int iACSRootCertIndex);
int SetACSRootCertStorePassword(int iACSRootCertIndex, const char* lpszACSRootCertStorePassword); Unicode (Windows) LPWSTR GetACSRootCertStorePassword(INT iACSRootCertIndex);
INT SetACSRootCertStorePassword(INT iACSRootCertIndex, LPCWSTR lpszACSRootCertStorePassword);
char* ipworks3ds_client_getacsrootcertstorepassword(void* lpObj, int acsrootcertindex);
int ipworks3ds_client_setacsrootcertstorepassword(void* lpObj, int acsrootcertindex, const char* lpszACSRootCertStorePassword);
QString GetACSRootCertStorePassword(int iACSRootCertIndex);
int SetACSRootCertStorePassword(int iACSRootCertIndex, QString qsACSRootCertStorePassword);
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 ACSRootCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ACSRootCertCount property.
This property is not available at design time.
Data Type
String
ACSRootCertStoreType Property (Client Class)
This is the type of certificate store for this certificate.
Syntax
ANSI (Cross Platform) int GetACSRootCertStoreType(int iACSRootCertIndex);
int SetACSRootCertStoreType(int iACSRootCertIndex, int iACSRootCertStoreType); Unicode (Windows) INT GetACSRootCertStoreType(INT iACSRootCertIndex);
INT SetACSRootCertStoreType(INT iACSRootCertIndex, INT iACSRootCertStoreType);
Possible Values
CST_USER(0),
CST_MACHINE(1),
CST_PFXFILE(2),
CST_PFXBLOB(3),
CST_JKSFILE(4),
CST_JKSBLOB(5),
CST_PEMKEY_FILE(6),
CST_PEMKEY_BLOB(7),
CST_PUBLIC_KEY_FILE(8),
CST_PUBLIC_KEY_BLOB(9),
CST_SSHPUBLIC_KEY_BLOB(10),
CST_P7BFILE(11),
CST_P7BBLOB(12),
CST_SSHPUBLIC_KEY_FILE(13),
CST_PPKFILE(14),
CST_PPKBLOB(15),
CST_XMLFILE(16),
CST_XMLBLOB(17),
CST_JWKFILE(18),
CST_JWKBLOB(19),
CST_SECURITY_KEY(20),
CST_BCFKSFILE(21),
CST_BCFKSBLOB(22),
CST_PKCS11(23),
CST_AUTO(99)
int ipworks3ds_client_getacsrootcertstoretype(void* lpObj, int acsrootcertindex);
int ipworks3ds_client_setacsrootcertstoretype(void* lpObj, int acsrootcertindex, int iACSRootCertStoreType);
int GetACSRootCertStoreType(int iACSRootCertIndex);
int SetACSRootCertStoreType(int iACSRootCertIndex, int iACSRootCertStoreType);
Default Value
0
Remarks
This is 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:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS11 interface.
To use a security key the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the ACSRootCertStore and set ACSRootCertStorePassword to the PIN. Code Example: SSH Authentication with Security Key
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
The ACSRootCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ACSRootCertCount property.
This property is not available at design time.
Data Type
Integer
ACSRootCertSubject Property (Client Class)
This is the subject of the certificate used for client authentication.
Syntax
ANSI (Cross Platform) char* GetACSRootCertSubject(int iACSRootCertIndex);
int SetACSRootCertSubject(int iACSRootCertIndex, const char* lpszACSRootCertSubject); Unicode (Windows) LPWSTR GetACSRootCertSubject(INT iACSRootCertIndex);
INT SetACSRootCertSubject(INT iACSRootCertIndex, LPCWSTR lpszACSRootCertSubject);
char* ipworks3ds_client_getacsrootcertsubject(void* lpObj, int acsrootcertindex);
int ipworks3ds_client_setacsrootcertsubject(void* lpObj, int acsrootcertindex, const char* lpszACSRootCertSubject);
QString GetACSRootCertSubject(int iACSRootCertIndex);
int SetACSRootCertSubject(int iACSRootCertIndex, QString qsACSRootCertSubject);
Default Value
""
Remarks
This is 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 displayed below.
Field | Meaning |
CN | Common Name. This is commonly a host name like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma it must be quoted.
The ACSRootCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ACSRootCertCount property.
This property is not available at design time.
Data Type
String
ACSUIType Property (Client Class)
UI type rendered by the 3DS SDK.
Syntax
ANSI (Cross Platform) int GetACSUIType(); Unicode (Windows) INT GetACSUIType();
int ipworks3ds_client_getacsuitype(void* lpObj);
int GetACSUIType();
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.
Data Type
Integer
ChallengeAdditionalInformation Property (Client Class)
Challenge additional information text.
Syntax
ANSI (Cross Platform) char* GetChallengeAdditionalInformation(); Unicode (Windows) LPWSTR GetChallengeAdditionalInformation();
char* ipworks3ds_client_getchallengeadditionalinformation(void* lpObj);
QString GetChallengeAdditionalInformation();
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.
Data Type
String
ChallengeAdditionalLabel Property (Client Class)
Challenge Additional Label.
Syntax
ANSI (Cross Platform) char* GetChallengeAdditionalLabel(); Unicode (Windows) LPWSTR GetChallengeAdditionalLabel();
char* ipworks3ds_client_getchallengeadditionallabel(void* lpObj);
QString GetChallengeAdditionalLabel();
Default Value
""
Remarks
UI label for the additional choice button provided by the ACS.
This property is read-only.
Data Type
String
ChallengeCancellationIndicator Property (Client Class)
Challenge Cancellation Indicator.
Syntax
ANSI (Cross Platform) char* GetChallengeCancellationIndicator();
int SetChallengeCancellationIndicator(const char* lpszChallengeCancellationIndicator); Unicode (Windows) LPWSTR GetChallengeCancellationIndicator();
INT SetChallengeCancellationIndicator(LPCWSTR lpszChallengeCancellationIndicator);
char* ipworks3ds_client_getchallengecancellationindicator(void* lpObj);
int ipworks3ds_client_setchallengecancellationindicator(void* lpObj, const char* lpszChallengeCancellationIndicator);
QString GetChallengeCancellationIndicator();
int SetChallengeCancellationIndicator(QString qsChallengeCancellationIndicator);
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:
01 | Cardholder selected "Cancel" |
02 | 3DS Requestor canceled authentication |
03 | Transaction aborted |
04 | Transaction timed out at ACS - other timeouts |
05 | Transaction timed out at ACS - First CReq not received by ACS |
06 | Transaction error |
07 | Unknown |
Data Type
String
ChallengeComplete Property (Client Class)
Whether or not the challenge cycle is complete.
Syntax
ANSI (Cross Platform) int GetChallengeComplete(); Unicode (Windows) BOOL GetChallengeComplete();
int ipworks3ds_client_getchallengecomplete(void* lpObj);
bool GetChallengeComplete();
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 TransactionStatus will be populated as well.
This property is read-only.
Data Type
Boolean
ChallengeDataEntry Property (Client Class)
Cardholder entered data.
Syntax
ANSI (Cross Platform) char* GetChallengeDataEntry();
int SetChallengeDataEntry(const char* lpszChallengeDataEntry); Unicode (Windows) LPWSTR GetChallengeDataEntry();
INT SetChallengeDataEntry(LPCWSTR lpszChallengeDataEntry);
char* ipworks3ds_client_getchallengedataentry(void* lpObj);
int ipworks3ds_client_setchallengedataentry(void* lpObj, const char* lpszChallengeDataEntry);
QString GetChallengeDataEntry();
int SetChallengeDataEntry(QString qsChallengeDataEntry);
Default Value
""
Remarks
This field contains the data that the cardholder entered into the UI.
When ACSUIType is Text (01) or HTML (05), set ChallengeDataEntry to the data exactly as it was specified by the cardholder. Do not format or otherwise change the data.
When ACSUIType is Single-Select (02), set ChallengeDataEntry 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***.comThe value to provide in ChallengeDataEntry is the ChallengeSelectInfoName, i.e. mobile.
When ACSUIType is Multi-Select (03), set ChallengeDataEntry to a comma-separated list of names of the selected options. For instance if ChallengeSelectInfo contains elements with names like chicago_illinois, st_louis_missouri, and portland_oregon, and the user chose two options, the value specified in ChallengeDataEntry would be chicago_illinois,portland_oregon.
Data Type
String
ChallengeDataEntryTwo Property (Client Class)
Cardholder entered data.
Syntax
ANSI (Cross Platform) char* GetChallengeDataEntryTwo();
int SetChallengeDataEntryTwo(const char* lpszChallengeDataEntryTwo); Unicode (Windows) LPWSTR GetChallengeDataEntryTwo();
INT SetChallengeDataEntryTwo(LPCWSTR lpszChallengeDataEntryTwo);
char* ipworks3ds_client_getchallengedataentrytwo(void* lpObj);
int ipworks3ds_client_setchallengedataentrytwo(void* lpObj, const char* lpszChallengeDataEntryTwo);
QString GetChallengeDataEntryTwo();
int SetChallengeDataEntryTwo(QString qsChallengeDataEntryTwo);
Default Value
""
Remarks
This field contains the data that the cardholder entered into the UI.
When ACSUIType is Text (01) or HTML (05), set ChallengeDataEntry to the data exactly as it was specified by the cardholder. Do not format or otherwise change the data.
When ACSUIType is Single-Select (02), set ChallengeDataEntry 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***.comThe value to provide in ChallengeDataEntry is the ChallengeSelectInfoName, i.e. mobile.
When ACSUIType is Multi-Select (03), set ChallengeDataEntry to a comma-separated list of names of the selected options. For instance if ChallengeSelectInfo contains elements with names like chicago_illinois, st_louis_missouri, and portland_oregon, and the user chose two options, the value specified in ChallengeDataEntry would be chicago_illinois,portland_oregon.
Data Type
String
ChallengeEntryBoxAutofill Property (Client Class)
Indicates if the 3DS SDK enables the autofill option for the Challenge Data Entry.
Syntax
ANSI (Cross Platform) int GetChallengeEntryBoxAutofill(); Unicode (Windows) BOOL GetChallengeEntryBoxAutofill();
int ipworks3ds_client_getchallengeentryboxautofill(void* lpObj);
bool GetChallengeEntryBoxAutofill();
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 and not available at design time.
Data Type
Boolean
ChallengeEntryBoxAutofillType Property (Client Class)
Indicates the type of data expected when the Challenge Data Entry Autofill is active.
Syntax
ANSI (Cross Platform) int GetChallengeEntryBoxAutofillType(); Unicode (Windows) INT GetChallengeEntryBoxAutofillType();
int ipworks3ds_client_getchallengeentryboxautofilltype(void* lpObj);
int GetChallengeEntryBoxAutofillType();
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 and not available at design time.
Data Type
Integer
ChallengeEntryBoxKeyboardType Property (Client Class)
Indicates if the 3DS SDK shall display a numeric or alphanumeric keyboard.
Syntax
ANSI (Cross Platform) int GetChallengeEntryBoxKeyboardType(); Unicode (Windows) INT GetChallengeEntryBoxKeyboardType();
int ipworks3ds_client_getchallengeentryboxkeyboardtype(void* lpObj);
int GetChallengeEntryBoxKeyboardType();
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 and not available at design time.
Data Type
Integer
ChallengeEntryBoxLabel Property (Client Class)
Label to specify the expected data entry provided by the ACS.
Syntax
ANSI (Cross Platform) char* GetChallengeEntryBoxLabel(); Unicode (Windows) LPWSTR GetChallengeEntryBoxLabel();
char* ipworks3ds_client_getchallengeentryboxlabel(void* lpObj);
QString GetChallengeEntryBoxLabel();
Default Value
""
Remarks
Label to specify the expected data entry provided by the ACS.
This property is read-only and not available at design time.
Data Type
String
ChallengeEntryBoxLengthMax Property (Client Class)
Indicates to the 3DS SDK the maximum length of the challenge data entry.
Syntax
ANSI (Cross Platform) int GetChallengeEntryBoxLengthMax(); Unicode (Windows) INT GetChallengeEntryBoxLengthMax();
int ipworks3ds_client_getchallengeentryboxlengthmax(void* lpObj);
int GetChallengeEntryBoxLengthMax();
Default Value
0
Remarks
Indicates to the 3DS SDK the maximum length of the challenge data entry.
This property is read-only and not available at design time.
Data Type
Integer
ChallengeEntryBoxMasking Property (Client Class)
Indicates that the 3DS SDK shall mask the data entered by the Cardholder.
Syntax
ANSI (Cross Platform) int GetChallengeEntryBoxMasking(); Unicode (Windows) BOOL GetChallengeEntryBoxMasking();
int ipworks3ds_client_getchallengeentryboxmasking(void* lpObj);
bool GetChallengeEntryBoxMasking();
Default Value
FALSE
Remarks
Indicates that the 3DS SDK shall mask the data entered by the Cardholder.
This property is read-only and not available at design time.
Data Type
Boolean
ChallengeEntryBoxMaskingToggle Property (Client Class)
Indicates that the 3DS SDK shall display a toggle icon, and display the data entered, if selected by the Cardholder.
Syntax
ANSI (Cross Platform) int GetChallengeEntryBoxMaskingToggle(); Unicode (Windows) BOOL GetChallengeEntryBoxMaskingToggle();
int ipworks3ds_client_getchallengeentryboxmaskingtoggle(void* lpObj);
bool GetChallengeEntryBoxMaskingToggle();
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 and not available at design time.
Data Type
Boolean
ChallengeEntryBoxTwoAutofill Property (Client Class)
Indicates if the 3DS SDK enables the autofill option for the Challenge Data Entry.
Syntax
ANSI (Cross Platform) int GetChallengeEntryBoxTwoAutofill(); Unicode (Windows) BOOL GetChallengeEntryBoxTwoAutofill();
int ipworks3ds_client_getchallengeentryboxtwoautofill(void* lpObj);
bool GetChallengeEntryBoxTwoAutofill();
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 and not available at design time.
Data Type
Boolean
ChallengeEntryBoxTwoAutofillType Property (Client Class)
Indicates the type of data expected when the Challenge Data Entry Autofill is active.
Syntax
ANSI (Cross Platform) int GetChallengeEntryBoxTwoAutofillType(); Unicode (Windows) INT GetChallengeEntryBoxTwoAutofillType();
int ipworks3ds_client_getchallengeentryboxtwoautofilltype(void* lpObj);
int GetChallengeEntryBoxTwoAutofillType();
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 and not available at design time.
Data Type
Integer
ChallengeEntryBoxTwoKeyboardType Property (Client Class)
Indicates if the 3DS SDK shall display a numeric or alphanumeric keyboard.
Syntax
ANSI (Cross Platform) int GetChallengeEntryBoxTwoKeyboardType(); Unicode (Windows) INT GetChallengeEntryBoxTwoKeyboardType();
int ipworks3ds_client_getchallengeentryboxtwokeyboardtype(void* lpObj);
int GetChallengeEntryBoxTwoKeyboardType();
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 and not available at design time.
Data Type
Integer
ChallengeEntryBoxTwoLabel Property (Client Class)
Label to specify the expected data entry provided by the ACS.
Syntax
ANSI (Cross Platform) char* GetChallengeEntryBoxTwoLabel(); Unicode (Windows) LPWSTR GetChallengeEntryBoxTwoLabel();
char* ipworks3ds_client_getchallengeentryboxtwolabel(void* lpObj);
QString GetChallengeEntryBoxTwoLabel();
Default Value
""
Remarks
Label to specify the expected data entry provided by the ACS.
This property is read-only and not available at design time.
Data Type
String
ChallengeEntryBoxTwoLengthMax Property (Client Class)
Indicates to the 3DS SDK the maximum length of the challenge data entry.
Syntax
ANSI (Cross Platform) int GetChallengeEntryBoxTwoLengthMax(); Unicode (Windows) INT GetChallengeEntryBoxTwoLengthMax();
int ipworks3ds_client_getchallengeentryboxtwolengthmax(void* lpObj);
int GetChallengeEntryBoxTwoLengthMax();
Default Value
0
Remarks
Indicates to the 3DS SDK the maximum length of the challenge data entry.
This property is read-only and not available at design time.
Data Type
Integer
ChallengeEntryBoxTwoMasking Property (Client Class)
Indicates that the 3DS SDK shall mask the data entered by the Cardholder.
Syntax
ANSI (Cross Platform) int GetChallengeEntryBoxTwoMasking(); Unicode (Windows) BOOL GetChallengeEntryBoxTwoMasking();
int ipworks3ds_client_getchallengeentryboxtwomasking(void* lpObj);
bool GetChallengeEntryBoxTwoMasking();
Default Value
FALSE
Remarks
Indicates that the 3DS SDK shall mask the data entered by the Cardholder.
This property is read-only and not available at design time.
Data Type
Boolean
ChallengeEntryBoxTwoMaskingToggle Property (Client Class)
Indicates that the 3DS SDK shall display a toggle icon, and display the data entered, if selected by the Cardholder.
Syntax
ANSI (Cross Platform) int GetChallengeEntryBoxTwoMaskingToggle(); Unicode (Windows) BOOL GetChallengeEntryBoxTwoMaskingToggle();
int ipworks3ds_client_getchallengeentryboxtwomaskingtoggle(void* lpObj);
bool GetChallengeEntryBoxTwoMaskingToggle();
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 and not available at design time.
Data Type
Boolean
ChallengeInfoHeader Property (Client Class)
Challenge information screen header.
Syntax
ANSI (Cross Platform) char* GetChallengeInfoHeader(); Unicode (Windows) LPWSTR GetChallengeInfoHeader();
char* ipworks3ds_client_getchallengeinfoheader(void* lpObj);
QString GetChallengeInfoHeader();
Default Value
""
Remarks
This field contains the header text for the challenge information screen that is being presented.
This property is read-only.
Data Type
String
ChallengeInfoLabel Property (Client Class)
Challenge information label.
Syntax
ANSI (Cross Platform) char* GetChallengeInfoLabel(); Unicode (Windows) LPWSTR GetChallengeInfoLabel();
char* ipworks3ds_client_getchallengeinfolabel(void* lpObj);
QString GetChallengeInfoLabel();
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.
Data Type
String
ChallengeInfoText Property (Client Class)
Challenge information text.
Syntax
ANSI (Cross Platform) char* GetChallengeInfoText(); Unicode (Windows) LPWSTR GetChallengeInfoText();
char* ipworks3ds_client_getchallengeinfotext(void* lpObj);
QString GetChallengeInfoText();
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.
Data Type
String
ChallengeSelectInfoCount Property (Client Class)
The number of records in the ChallengeSelectInfo arrays.
Syntax
ANSI (Cross Platform) int GetChallengeSelectInfoCount(); Unicode (Windows) INT GetChallengeSelectInfoCount();
int ipworks3ds_client_getchallengeselectinfocount(void* lpObj);
int GetChallengeSelectInfoCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at ChallengeSelectInfoCount - 1.This property is read-only and not available at design time.
Data Type
Integer
ChallengeSelectInfoName Property (Client Class)
The name of the selection option.
Syntax
ANSI (Cross Platform) char* GetChallengeSelectInfoName(int iChallengeSelectInfoIndex); Unicode (Windows) LPWSTR GetChallengeSelectInfoName(INT iChallengeSelectInfoIndex);
char* ipworks3ds_client_getchallengeselectinfoname(void* lpObj, int challengeselectinfoindex);
QString GetChallengeSelectInfoName(int iChallengeSelectInfoIndex);
Default Value
""
Remarks
The name of the selection option.
The ChallengeSelectInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChallengeSelectInfoCount property.
This property is read-only and not available at design time.
Data Type
String
ChallengeSelectInfoValue Property (Client Class)
The value of the selection option.
Syntax
ANSI (Cross Platform) char* GetChallengeSelectInfoValue(int iChallengeSelectInfoIndex); Unicode (Windows) LPWSTR GetChallengeSelectInfoValue(INT iChallengeSelectInfoIndex);
char* ipworks3ds_client_getchallengeselectinfovalue(void* lpObj, int challengeselectinfoindex);
QString GetChallengeSelectInfoValue(int iChallengeSelectInfoIndex);
Default Value
""
Remarks
The value of the selection option.
The ChallengeSelectInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChallengeSelectInfoCount property.
This property is read-only and not available at design time.
Data Type
String
DataPacketOut Property (Client Class)
Contains the data packet sent to the server.
Syntax
ANSI (Cross Platform) char* GetDataPacketOut(); Unicode (Windows) LPWSTR GetDataPacketOut();
char* ipworks3ds_client_getdatapacketout(void* lpObj);
QString GetDataPacketOut();
Default Value
""
Remarks
After calling either the RequestCardRanges, or SendAuthRequest methods, this property will contain the entire data packet that was sent. Also, after calling the GetChallengeRequest or GetResultsResponse method, this property will contain the constructed messages. The contents of this property should be logged for each transaction.
This property is read-only and not available at design time.
Data Type
String
DeviceBindingDataEntry Property (Client Class)
Device Binding Data Entry.
Syntax
ANSI (Cross Platform) int GetDeviceBindingDataEntry();
int SetDeviceBindingDataEntry(int bDeviceBindingDataEntry); Unicode (Windows) BOOL GetDeviceBindingDataEntry();
INT SetDeviceBindingDataEntry(BOOL bDeviceBindingDataEntry);
int ipworks3ds_client_getdevicebindingdataentry(void* lpObj);
int ipworks3ds_client_setdevicebindingdataentry(void* lpObj, int bDeviceBindingDataEntry);
bool GetDeviceBindingDataEntry();
int SetDeviceBindingDataEntry(bool bDeviceBindingDataEntry);
Default Value
FALSE
Remarks
Indicator provided by the 3DS SDK to the ACS to confirm whether the Cardholder gives consent to bind the device.
Data Type
Boolean
DeviceBindingInformationText Property (Client Class)
Device binding information text.
Syntax
ANSI (Cross Platform) char* GetDeviceBindingInformationText(); Unicode (Windows) LPWSTR GetDeviceBindingInformationText();
char* ipworks3ds_client_getdevicebindinginformationtext(void* lpObj);
QString GetDeviceBindingInformationText();
Default Value
""
Remarks
Text provided by the ACS to the Cardholder during the Device Binding process.
This property is read-only.
Data Type
String
DeviceParamCount Property (Client Class)
The number of records in the DeviceParam arrays.
Syntax
ANSI (Cross Platform) int GetDeviceParamCount();
int SetDeviceParamCount(int iDeviceParamCount); Unicode (Windows) INT GetDeviceParamCount();
INT SetDeviceParamCount(INT iDeviceParamCount);
int ipworks3ds_client_getdeviceparamcount(void* lpObj);
int ipworks3ds_client_setdeviceparamcount(void* lpObj, int iDeviceParamCount);
int GetDeviceParamCount();
int SetDeviceParamCount(int iDeviceParamCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at DeviceParamCount - 1.This property is not available at design time.
Data Type
Integer
DeviceParamCategory Property (Client Class)
The category of the parameter.
Syntax
ANSI (Cross Platform) int GetDeviceParamCategory(int iDeviceParamIndex);
int SetDeviceParamCategory(int iDeviceParamIndex, int iDeviceParamCategory); Unicode (Windows) INT GetDeviceParamCategory(INT iDeviceParamIndex);
INT SetDeviceParamCategory(INT iDeviceParamIndex, INT iDeviceParamCategory);
int ipworks3ds_client_getdeviceparamcategory(void* lpObj, int deviceparamindex);
int ipworks3ds_client_setdeviceparamcategory(void* lpObj, int deviceparamindex, int iDeviceParamCategory);
int GetDeviceParamCategory(int iDeviceParamIndex);
int SetDeviceParamCategory(int iDeviceParamIndex, int iDeviceParamCategory);
Default Value
0
Remarks
The category of the parameter. Possible values include:
0 | DV - Data Version |
1 | DD - Device Data |
2 | DPNA - Device Parameter Not Available |
3 | SW - Security Warning |
The DeviceParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DeviceParamCount property.
This property is not available at design time.
Data Type
Integer
DeviceParamFieldName Property (Client Class)
The name of the parameter.
Syntax
ANSI (Cross Platform) char* GetDeviceParamFieldName(int iDeviceParamIndex);
int SetDeviceParamFieldName(int iDeviceParamIndex, const char* lpszDeviceParamFieldName); Unicode (Windows) LPWSTR GetDeviceParamFieldName(INT iDeviceParamIndex);
INT SetDeviceParamFieldName(INT iDeviceParamIndex, LPCWSTR lpszDeviceParamFieldName);
char* ipworks3ds_client_getdeviceparamfieldname(void* lpObj, int deviceparamindex);
int ipworks3ds_client_setdeviceparamfieldname(void* lpObj, int deviceparamindex, const char* lpszDeviceParamFieldName);
QString GetDeviceParamFieldName(int iDeviceParamIndex);
int SetDeviceParamFieldName(int iDeviceParamIndex, QString qsDeviceParamFieldName);
Default Value
""
Remarks
The name of the parameter.
The DeviceParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DeviceParamCount property.
This property is not available at design time.
Data Type
String
DeviceParamValue Property (Client Class)
The value of the parameter.
Syntax
ANSI (Cross Platform) char* GetDeviceParamValue(int iDeviceParamIndex);
int SetDeviceParamValue(int iDeviceParamIndex, const char* lpszDeviceParamValue); Unicode (Windows) LPWSTR GetDeviceParamValue(INT iDeviceParamIndex);
INT SetDeviceParamValue(INT iDeviceParamIndex, LPCWSTR lpszDeviceParamValue);
char* ipworks3ds_client_getdeviceparamvalue(void* lpObj, int deviceparamindex);
int ipworks3ds_client_setdeviceparamvalue(void* lpObj, int deviceparamindex, const char* lpszDeviceParamValue);
QString GetDeviceParamValue(int iDeviceParamIndex);
int SetDeviceParamValue(int iDeviceParamIndex, QString qsDeviceParamValue);
Default Value
""
Remarks
The value of the parameter.
The DeviceParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DeviceParamCount property.
This property is not available at design time.
Data Type
String
DeviceParamValueType Property (Client Class)
The type of the value.
Syntax
ANSI (Cross Platform) int GetDeviceParamValueType(int iDeviceParamIndex);
int SetDeviceParamValueType(int iDeviceParamIndex, int iDeviceParamValueType); Unicode (Windows) INT GetDeviceParamValueType(INT iDeviceParamIndex);
INT SetDeviceParamValueType(INT iDeviceParamIndex, INT iDeviceParamValueType);
Possible Values
VT_OBJECT(0),
VT_ARRAY(1),
VT_STRING(2),
VT_NUMBER(3),
VT_BOOL(4),
VT_NULL(5),
VT_RAW(6)
int ipworks3ds_client_getdeviceparamvaluetype(void* lpObj, int deviceparamindex);
int ipworks3ds_client_setdeviceparamvaluetype(void* lpObj, int deviceparamindex, int iDeviceParamValueType);
int GetDeviceParamValueType(int iDeviceParamIndex);
int SetDeviceParamValueType(int iDeviceParamIndex, int iDeviceParamValueType);
Default Value
2
Remarks
The type of the value. Possible values are:
1 | Array |
2 | String |
The DeviceParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DeviceParamCount property.
This property is not available at design time.
Data Type
Integer
DirectoryServerCertEncoded Property (Client Class)
This is the certificate (PEM/base64 encoded).
Syntax
ANSI (Cross Platform) int GetDirectoryServerCertEncoded(char* &lpDirectoryServerCertEncoded, int &lenDirectoryServerCertEncoded);
int SetDirectoryServerCertEncoded(const char* lpDirectoryServerCertEncoded, int lenDirectoryServerCertEncoded); Unicode (Windows) INT GetDirectoryServerCertEncoded(LPSTR &lpDirectoryServerCertEncoded, INT &lenDirectoryServerCertEncoded);
INT SetDirectoryServerCertEncoded(LPCSTR lpDirectoryServerCertEncoded, INT lenDirectoryServerCertEncoded);
int ipworks3ds_client_getdirectoryservercertencoded(void* lpObj, char** lpDirectoryServerCertEncoded, int* lenDirectoryServerCertEncoded);
int ipworks3ds_client_setdirectoryservercertencoded(void* lpObj, const char* lpDirectoryServerCertEncoded, int lenDirectoryServerCertEncoded);
QByteArray GetDirectoryServerCertEncoded();
int SetDirectoryServerCertEncoded(QByteArray qbaDirectoryServerCertEncoded);
Default Value
""
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The DirectoryServerCertStore and DirectoryServerCertSubject properties also may be used to specify a certificate.
When DirectoryServerCertEncoded is set, a search is initiated in the current DirectoryServerCertStore for the private key of the certificate. If the key is found, DirectoryServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, DirectoryServerCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Binary String
DirectoryServerCertStore Property (Client Class)
This is the name of the certificate store for the client certificate.
Syntax
ANSI (Cross Platform) int GetDirectoryServerCertStore(char* &lpDirectoryServerCertStore, int &lenDirectoryServerCertStore);
int SetDirectoryServerCertStore(const char* lpDirectoryServerCertStore, int lenDirectoryServerCertStore); Unicode (Windows) INT GetDirectoryServerCertStore(LPSTR &lpDirectoryServerCertStore, INT &lenDirectoryServerCertStore);
INT SetDirectoryServerCertStore(LPCSTR lpDirectoryServerCertStore, INT lenDirectoryServerCertStore);
int ipworks3ds_client_getdirectoryservercertstore(void* lpObj, char** lpDirectoryServerCertStore, int* lenDirectoryServerCertStore);
int ipworks3ds_client_setdirectoryservercertstore(void* lpObj, const char* lpDirectoryServerCertStore, int lenDirectoryServerCertStore);
QByteArray GetDirectoryServerCertStore();
int SetDirectoryServerCertStore(QByteArray qbaDirectoryServerCertStore);
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The DirectoryServerCertStoreType property denotes the type of the certificate store specified by DirectoryServerCertStore. If the store is password protected, specify the password in DirectoryServerCertStorePassword.
DirectoryServerCertStore is used in conjunction with the DirectoryServerCertSubject property to specify client certificates. If DirectoryServerCertStore has a value, and DirectoryServerCertSubject or DirectoryServerCertEncoded is set, a search for a certificate is initiated. Please see the DirectoryServerCertSubject property for details.
Designations of certificate stores are platform-dependent.
The following are designations of the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).
Data Type
Binary String
DirectoryServerCertStorePassword Property (Client Class)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
ANSI (Cross Platform) char* GetDirectoryServerCertStorePassword();
int SetDirectoryServerCertStorePassword(const char* lpszDirectoryServerCertStorePassword); Unicode (Windows) LPWSTR GetDirectoryServerCertStorePassword();
INT SetDirectoryServerCertStorePassword(LPCWSTR lpszDirectoryServerCertStorePassword);
char* ipworks3ds_client_getdirectoryservercertstorepassword(void* lpObj);
int ipworks3ds_client_setdirectoryservercertstorepassword(void* lpObj, const char* lpszDirectoryServerCertStorePassword);
QString GetDirectoryServerCertStorePassword();
int SetDirectoryServerCertStorePassword(QString qsDirectoryServerCertStorePassword);
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.
Data Type
String
DirectoryServerCertStoreType Property (Client Class)
This is the type of certificate store for this certificate.
Syntax
ANSI (Cross Platform) int GetDirectoryServerCertStoreType();
int SetDirectoryServerCertStoreType(int iDirectoryServerCertStoreType); Unicode (Windows) INT GetDirectoryServerCertStoreType();
INT SetDirectoryServerCertStoreType(INT iDirectoryServerCertStoreType);
Possible Values
CST_USER(0),
CST_MACHINE(1),
CST_PFXFILE(2),
CST_PFXBLOB(3),
CST_JKSFILE(4),
CST_JKSBLOB(5),
CST_PEMKEY_FILE(6),
CST_PEMKEY_BLOB(7),
CST_PUBLIC_KEY_FILE(8),
CST_PUBLIC_KEY_BLOB(9),
CST_SSHPUBLIC_KEY_BLOB(10),
CST_P7BFILE(11),
CST_P7BBLOB(12),
CST_SSHPUBLIC_KEY_FILE(13),
CST_PPKFILE(14),
CST_PPKBLOB(15),
CST_XMLFILE(16),
CST_XMLBLOB(17),
CST_JWKFILE(18),
CST_JWKBLOB(19),
CST_SECURITY_KEY(20),
CST_BCFKSFILE(21),
CST_BCFKSBLOB(22),
CST_PKCS11(23),
CST_AUTO(99)
int ipworks3ds_client_getdirectoryservercertstoretype(void* lpObj);
int ipworks3ds_client_setdirectoryservercertstoretype(void* lpObj, int iDirectoryServerCertStoreType);
int GetDirectoryServerCertStoreType();
int SetDirectoryServerCertStoreType(int iDirectoryServerCertStoreType);
Default Value
0
Remarks
This is 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:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS11 interface.
To use a security key the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the DirectoryServerCertStore and set DirectoryServerCertStorePassword to the PIN. Code Example: SSH Authentication with Security Key
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
Data Type
Integer
DirectoryServerCertSubject Property (Client Class)
This is the subject of the certificate used for client authentication.
Syntax
ANSI (Cross Platform) char* GetDirectoryServerCertSubject();
int SetDirectoryServerCertSubject(const char* lpszDirectoryServerCertSubject); Unicode (Windows) LPWSTR GetDirectoryServerCertSubject();
INT SetDirectoryServerCertSubject(LPCWSTR lpszDirectoryServerCertSubject);
char* ipworks3ds_client_getdirectoryservercertsubject(void* lpObj);
int ipworks3ds_client_setdirectoryservercertsubject(void* lpObj, const char* lpszDirectoryServerCertSubject);
QString GetDirectoryServerCertSubject();
int SetDirectoryServerCertSubject(QString qsDirectoryServerCertSubject);
Default Value
""
Remarks
This is 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 displayed below.
Field | Meaning |
CN | Common Name. This is commonly a host name like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma it must be quoted.
Data Type
String
DirectoryServerId Property (Client Class)
Value of the Registered Application Provider Identifier (RID) unique to the payment system.
Syntax
ANSI (Cross Platform) char* GetDirectoryServerId();
int SetDirectoryServerId(const char* lpszDirectoryServerId); Unicode (Windows) LPWSTR GetDirectoryServerId();
INT SetDirectoryServerId(LPCWSTR lpszDirectoryServerId);
char* ipworks3ds_client_getdirectoryserverid(void* lpObj);
int ipworks3ds_client_setdirectoryserverid(void* lpObj, const char* lpszDirectoryServerId);
QString GetDirectoryServerId();
int SetDirectoryServerId(QString qsDirectoryServerId);
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 DirectoryServerCert for the given DS which is used by the SDK to encrypt the Device Information. Required when DirectoryServerCert is an EC key.
Data Type
String
DirectoryServerKeyId Property (Client Class)
Directory Server Key Identifier (kid).
Syntax
ANSI (Cross Platform) char* GetDirectoryServerKeyId();
int SetDirectoryServerKeyId(const char* lpszDirectoryServerKeyId); Unicode (Windows) LPWSTR GetDirectoryServerKeyId();
INT SetDirectoryServerKeyId(LPCWSTR lpszDirectoryServerKeyId);
char* ipworks3ds_client_getdirectoryserverkeyid(void* lpObj);
int ipworks3ds_client_setdirectoryserverkeyid(void* lpObj, const char* lpszDirectoryServerKeyId);
QString GetDirectoryServerKeyId();
int SetDirectoryServerKeyId(QString qsDirectoryServerKeyId);
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.
Data Type
String
EnableChallengeInfoTextIndicator Property (Client Class)
Challenge information text indicator.
Syntax
ANSI (Cross Platform) int GetEnableChallengeInfoTextIndicator(); Unicode (Windows) BOOL GetEnableChallengeInfoTextIndicator();
int ipworks3ds_client_getenablechallengeinfotextindicator(void* lpObj);
bool GetEnableChallengeInfoTextIndicator();
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 ChallengeInfoText that is being displayed. If this field is populated, it should affect the information being displayed to the cardholder.
This property is read-only.
Data Type
Boolean
ErrorPacket Property (Client Class)
The error packet.
Syntax
ANSI (Cross Platform) char* GetErrorPacket(); Unicode (Windows) LPWSTR GetErrorPacket();
char* ipworks3ds_client_geterrorpacket(void* lpObj);
QString GetErrorPacket();
Default Value
""
Remarks
If an error is encountered while parsing a received packet using the CheckResponse 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.
Data Type
String
ExpandableInformationLabel Property (Client Class)
Expandable information label.
Syntax
ANSI (Cross Platform) char* GetExpandableInformationLabel(); Unicode (Windows) LPWSTR GetExpandableInformationLabel();
char* ipworks3ds_client_getexpandableinformationlabel(void* lpObj);
QString GetExpandableInformationLabel();
Default Value
""
Remarks
Label displayed to the cardholder for the content in ExpandableInformationText.
This property is read-only.
Data Type
String
ExpandableInformationText Property (Client Class)
Expandable information text.
Syntax
ANSI (Cross Platform) char* GetExpandableInformationText(); Unicode (Windows) LPWSTR GetExpandableInformationText();
char* ipworks3ds_client_getexpandableinformationtext(void* lpObj);
QString GetExpandableInformationText();
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.
Data Type
String
ExtensionCount Property (Client Class)
The number of records in the Extension arrays.
Syntax
ANSI (Cross Platform) int GetExtensionCount();
int SetExtensionCount(int iExtensionCount); Unicode (Windows) INT GetExtensionCount();
INT SetExtensionCount(INT iExtensionCount);
int ipworks3ds_client_getextensioncount(void* lpObj);
int ipworks3ds_client_setextensioncount(void* lpObj, int iExtensionCount);
int GetExtensionCount();
int SetExtensionCount(int iExtensionCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at ExtensionCount - 1.This property is not available at design time.
Data Type
Integer
ExtensionCritical Property (Client Class)
Whether the extension is critical.
Syntax
ANSI (Cross Platform) int GetExtensionCritical(int iExtensionIndex);
int SetExtensionCritical(int iExtensionIndex, int bExtensionCritical); Unicode (Windows) BOOL GetExtensionCritical(INT iExtensionIndex);
INT SetExtensionCritical(INT iExtensionIndex, BOOL bExtensionCritical);
int ipworks3ds_client_getextensioncritical(void* lpObj, int extensionindex);
int ipworks3ds_client_setextensioncritical(void* lpObj, int extensionindex, int bExtensionCritical);
bool GetExtensionCritical(int iExtensionIndex);
int SetExtensionCritical(int iExtensionIndex, bool bExtensionCritical);
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 ExtensionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ExtensionCount property.
This property is not available at design time.
Data Type
Boolean
ExtensionData Property (Client Class)
The extension data as JSON.
Syntax
ANSI (Cross Platform) char* GetExtensionData(int iExtensionIndex);
int SetExtensionData(int iExtensionIndex, const char* lpszExtensionData); Unicode (Windows) LPWSTR GetExtensionData(INT iExtensionIndex);
INT SetExtensionData(INT iExtensionIndex, LPCWSTR lpszExtensionData);
char* ipworks3ds_client_getextensiondata(void* lpObj, int extensionindex);
int ipworks3ds_client_setextensiondata(void* lpObj, int extensionindex, const char* lpszExtensionData);
QString GetExtensionData(int iExtensionIndex);
int SetExtensionData(int iExtensionIndex, QString qsExtensionData);
Default Value
""
Remarks
The extension data as JSON.
This setting specifies the JSON formatted extension data.
The ExtensionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ExtensionCount property.
This property is not available at design time.
Data Type
String
ExtensionId Property (Client Class)
The id of the specified extension.
Syntax
ANSI (Cross Platform) char* GetExtensionId(int iExtensionIndex);
int SetExtensionId(int iExtensionIndex, const char* lpszExtensionId); Unicode (Windows) LPWSTR GetExtensionId(INT iExtensionIndex);
INT SetExtensionId(INT iExtensionIndex, LPCWSTR lpszExtensionId);
char* ipworks3ds_client_getextensionid(void* lpObj, int extensionindex);
int ipworks3ds_client_setextensionid(void* lpObj, int extensionindex, const char* lpszExtensionId);
QString GetExtensionId(int iExtensionIndex);
int SetExtensionId(int iExtensionIndex, QString qsExtensionId);
Default Value
""
Remarks
The id of the specified extension.
This setting specifies a unique identifier for the extension.
The ExtensionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ExtensionCount property.
This property is not available at design time.
Data Type
String
ExtensionName Property (Client Class)
The extension name.
Syntax
ANSI (Cross Platform) char* GetExtensionName(int iExtensionIndex);
int SetExtensionName(int iExtensionIndex, const char* lpszExtensionName); Unicode (Windows) LPWSTR GetExtensionName(INT iExtensionIndex);
INT SetExtensionName(INT iExtensionIndex, LPCWSTR lpszExtensionName);
char* ipworks3ds_client_getextensionname(void* lpObj, int extensionindex);
int ipworks3ds_client_setextensionname(void* lpObj, int extensionindex, const char* lpszExtensionName);
QString GetExtensionName(int iExtensionIndex);
int SetExtensionName(int iExtensionIndex, QString qsExtensionName);
Default Value
""
Remarks
The extension name.
This setting specifies the name of the extension as defined by the extension owner.
The ExtensionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ExtensionCount property.
This property is not available at design time.
Data Type
String
IssuerImage1 Property (Client Class)
Issuer image URL 1.
Syntax
ANSI (Cross Platform) char* GetIssuerImage1(); Unicode (Windows) LPWSTR GetIssuerImage1();
char* ipworks3ds_client_getissuerimage1(void* lpObj);
QString GetIssuerImage1();
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 and not available at design time.
Data Type
String
IssuerImage2 Property (Client Class)
Issuer image URL 2.
Syntax
ANSI (Cross Platform) char* GetIssuerImage2(); Unicode (Windows) LPWSTR GetIssuerImage2();
char* ipworks3ds_client_getissuerimage2(void* lpObj);
QString GetIssuerImage2();
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 and not available at design time.
Data Type
String
IssuerImage3 Property (Client Class)
Issuer image URL 3.
Syntax
ANSI (Cross Platform) char* GetIssuerImage3(); Unicode (Windows) LPWSTR GetIssuerImage3();
char* ipworks3ds_client_getissuerimage3(void* lpObj);
QString GetIssuerImage3();
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 and not available at design time.
Data Type
String
MessageVersion Property (Client Class)
Message version.
Syntax
ANSI (Cross Platform) char* GetMessageVersion();
int SetMessageVersion(const char* lpszMessageVersion); Unicode (Windows) LPWSTR GetMessageVersion();
INT SetMessageVersion(LPCWSTR lpszMessageVersion);
char* ipworks3ds_client_getmessageversion(void* lpObj);
int ipworks3ds_client_setmessageversion(void* lpObj, const char* lpszMessageVersion);
QString GetMessageVersion();
int SetMessageVersion(QString qsMessageVersion);
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:
2.1.0 (Default) | |
2.2.0 | |
2.3.1 |
Data Type
String
OOBAppLabel Property (Client Class)
OOB App label.
Syntax
ANSI (Cross Platform) char* GetOOBAppLabel(); Unicode (Windows) LPWSTR GetOOBAppLabel();
char* ipworks3ds_client_getoobapplabel(void* lpObj);
QString GetOOBAppLabel();
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.
Data Type
String
OOBAppStatus Property (Client Class)
OOB App status.
Syntax
ANSI (Cross Platform) int GetOOBAppStatus();
int SetOOBAppStatus(int iOOBAppStatus); Unicode (Windows) INT GetOOBAppStatus();
INT SetOOBAppStatus(INT iOOBAppStatus);
int ipworks3ds_client_getoobappstatus(void* lpObj);
int ipworks3ds_client_setoobappstatus(void* lpObj, int iOOBAppStatus);
int GetOOBAppStatus();
int SetOOBAppStatus(int iOOBAppStatus);
Default Value
0
Remarks
Status code indicating the problem type encountered when using the OOB App URL. 1 = Open OOB App URL failed
Data Type
Integer
OOBAppURL Property (Client Class)
OOB App label.
Syntax
ANSI (Cross Platform) char* GetOOBAppURL(); Unicode (Windows) LPWSTR GetOOBAppURL();
char* ipworks3ds_client_getoobappurl(void* lpObj);
QString GetOOBAppURL();
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.
Data Type
String
OOBAppURLIndicator Property (Client Class)
OOB App URL Indicator.
Syntax
ANSI (Cross Platform) int GetOOBAppURLIndicator();
int SetOOBAppURLIndicator(int iOOBAppURLIndicator); Unicode (Windows) INT GetOOBAppURLIndicator();
INT SetOOBAppURLIndicator(INT iOOBAppURLIndicator);
int ipworks3ds_client_getoobappurlindicator(void* lpObj);
int ipworks3ds_client_setoobappurlindicator(void* lpObj, int iOOBAppURLIndicator);
int GetOOBAppURLIndicator();
int SetOOBAppURLIndicator(int iOOBAppURLIndicator);
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
Data Type
Integer
OOBContinuationIndicator Property (Client Class)
OOB continuation indicator.
Syntax
ANSI (Cross Platform) int GetOOBContinuationIndicator();
int SetOOBContinuationIndicator(int iOOBContinuationIndicator); Unicode (Windows) INT GetOOBContinuationIndicator();
INT SetOOBContinuationIndicator(INT iOOBContinuationIndicator);
int ipworks3ds_client_getoobcontinuationindicator(void* lpObj);
int ipworks3ds_client_setoobcontinuationindicator(void* lpObj, int iOOBContinuationIndicator);
int GetOOBContinuationIndicator();
int SetOOBContinuationIndicator(int iOOBContinuationIndicator);
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 ACSUIType is set to OOB when the user has selected the continue option on the device.
Data Type
Integer
OOBContinueLabel Property (Client Class)
OOB continuation label.
Syntax
ANSI (Cross Platform) char* GetOOBContinueLabel(); Unicode (Windows) LPWSTR GetOOBContinueLabel();
char* ipworks3ds_client_getoobcontinuelabel(void* lpObj);
QString GetOOBContinueLabel();
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.
Data Type
String
PaymentSystemImage1 Property (Client Class)
Payment system image URL 1.
Syntax
ANSI (Cross Platform) char* GetPaymentSystemImage1(); Unicode (Windows) LPWSTR GetPaymentSystemImage1();
char* ipworks3ds_client_getpaymentsystemimage1(void* lpObj);
QString GetPaymentSystemImage1();
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 and not available at design time.
Data Type
String
PaymentSystemImage2 Property (Client Class)
Payment system image URL 2.
Syntax
ANSI (Cross Platform) char* GetPaymentSystemImage2(); Unicode (Windows) LPWSTR GetPaymentSystemImage2();
char* ipworks3ds_client_getpaymentsystemimage2(void* lpObj);
QString GetPaymentSystemImage2();
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 and not available at design time.
Data Type
String
PaymentSystemImage3 Property (Client Class)
Payment system image URL 3.
Syntax
ANSI (Cross Platform) char* GetPaymentSystemImage3(); Unicode (Windows) LPWSTR GetPaymentSystemImage3();
char* ipworks3ds_client_getpaymentsystemimage3(void* lpObj);
QString GetPaymentSystemImage3();
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 and not available at design time.
Data Type
String
ProxyAuthScheme Property (Client Class)
This property is used to tell the class which type of authorization to perform when connecting to the proxy.
Syntax
ANSI (Cross Platform) int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme); Unicode (Windows) INT GetProxyAuthScheme();
INT SetProxyAuthScheme(INT iProxyAuthScheme);
Possible Values
AUTH_BASIC(0),
AUTH_DIGEST(1),
AUTH_PROPRIETARY(2),
AUTH_NONE(3),
AUTH_NTLM(4),
AUTH_NEGOTIATE(5)
int ipworks3ds_client_getproxyauthscheme(void* lpObj);
int ipworks3ds_client_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);
Default Value
0
Remarks
This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.
ProxyAuthScheme should be set to authNone (3) when no authentication is expected.
By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.
If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.
If ProxyAuthScheme 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 ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.
For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.
Data Type
Integer
ProxyAutoDetect Property (Client Class)
This property tells the class whether or not to automatically detect and use proxy system settings, if available.
Syntax
ANSI (Cross Platform) int GetProxyAutoDetect();
int SetProxyAutoDetect(int bProxyAutoDetect); Unicode (Windows) BOOL GetProxyAutoDetect();
INT SetProxyAutoDetect(BOOL bProxyAutoDetect);
int ipworks3ds_client_getproxyautodetect(void* lpObj);
int ipworks3ds_client_setproxyautodetect(void* lpObj, int bProxyAutoDetect);
bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);
Default Value
FALSE
Remarks
This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.
Data Type
Boolean
ProxyPassword Property (Client Class)
This property contains a password if authentication is to be used for the proxy.
Syntax
ANSI (Cross Platform) char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword); Unicode (Windows) LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);
char* ipworks3ds_client_getproxypassword(void* lpObj);
int ipworks3ds_client_setproxypassword(void* lpObj, const char* lpszProxyPassword);
QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);
Default Value
""
Remarks
This property contains a password if authentication is to be used for the proxy.
If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.
If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.
Data Type
String
ProxyPort Property (Client Class)
This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).
Syntax
ANSI (Cross Platform) int GetProxyPort();
int SetProxyPort(int iProxyPort); Unicode (Windows) INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);
int ipworks3ds_client_getproxyport(void* lpObj);
int ipworks3ds_client_setproxyport(void* lpObj, int iProxyPort);
int GetProxyPort();
int SetProxyPort(int iProxyPort);
Default Value
80
Remarks
This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.
Data Type
Integer
ProxyServer Property (Client Class)
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
Syntax
ANSI (Cross Platform) char* GetProxyServer();
int SetProxyServer(const char* lpszProxyServer); Unicode (Windows) LPWSTR GetProxyServer();
INT SetProxyServer(LPCWSTR lpszProxyServer);
char* ipworks3ds_client_getproxyserver(void* lpObj);
int ipworks3ds_client_setproxyserver(void* lpObj, const char* lpszProxyServer);
QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);
Default Value
""
Remarks
If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.
Data Type
String
ProxySSL Property (Client Class)
This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.
Syntax
ANSI (Cross Platform) int GetProxySSL();
int SetProxySSL(int iProxySSL); Unicode (Windows) INT GetProxySSL();
INT SetProxySSL(INT iProxySSL);
Possible Values
PS_AUTOMATIC(0),
PS_ALWAYS(1),
PS_NEVER(2),
PS_TUNNEL(3)
int ipworks3ds_client_getproxyssl(void* lpObj);
int ipworks3ds_client_setproxyssl(void* lpObj, int iProxySSL);
int GetProxySSL();
int SetProxySSL(int iProxySSL);
Default Value
0
Remarks
This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:
psAutomatic (0) | Default setting. If the URL is an https URL, the class will use the psTunnel option. If the URL is an http URL, the class will use the psNever option. |
psAlways (1) | The connection is always SSL enabled. |
psNever (2) | The connection is not SSL enabled. |
psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. |
Data Type
Integer
ProxyUser Property (Client Class)
This property contains a user name, if authentication is to be used for the proxy.
Syntax
ANSI (Cross Platform) char* GetProxyUser();
int SetProxyUser(const char* lpszProxyUser); Unicode (Windows) LPWSTR GetProxyUser();
INT SetProxyUser(LPCWSTR lpszProxyUser);
char* ipworks3ds_client_getproxyuser(void* lpObj);
int ipworks3ds_client_setproxyuser(void* lpObj, const char* lpszProxyUser);
QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);
Default Value
""
Remarks
This property contains a user name, if authentication is to be used for the proxy.
If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.
If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.
Data Type
String
RequestorAppURL Property (Client Class)
3DS Requestor App URL.
Syntax
ANSI (Cross Platform) char* GetRequestorAppURL();
int SetRequestorAppURL(const char* lpszRequestorAppURL); Unicode (Windows) LPWSTR GetRequestorAppURL();
INT SetRequestorAppURL(LPCWSTR lpszRequestorAppURL);
char* ipworks3ds_client_getrequestorappurl(void* lpObj);
int ipworks3ds_client_setrequestorappurl(void* lpObj, const char* lpszRequestorAppURL);
QString GetRequestorAppURL();
int SetRequestorAppURL(QString qsRequestorAppURL);
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.
Data Type
String
ResendInformationLabel Property (Client Class)
Label for UI button allowing users to request that authentication information be resent.
Syntax
ANSI (Cross Platform) char* GetResendInformationLabel(); Unicode (Windows) LPWSTR GetResendInformationLabel();
char* ipworks3ds_client_getresendinformationlabel(void* lpObj);
QString GetResendInformationLabel();
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.
Data Type
String
SDKAppId Property (Client Class)
The unique SDK App Id.
Syntax
ANSI (Cross Platform) char* GetSDKAppId();
int SetSDKAppId(const char* lpszSDKAppId); Unicode (Windows) LPWSTR GetSDKAppId();
INT SetSDKAppId(LPCWSTR lpszSDKAppId);
char* ipworks3ds_client_getsdkappid(void* lpObj);
int ipworks3ds_client_setsdkappid(void* lpObj, const char* lpszSDKAppId);
QString GetSDKAppId();
int SetSDKAppId(QString qsSDKAppId);
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 SDKAppId for each installation or update. This property must be set before calling GetAuthRequest.
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.
Data Type
String
SDKTransactionId Property (Client Class)
SDK Transaction ID.
Syntax
ANSI (Cross Platform) char* GetSDKTransactionId();
int SetSDKTransactionId(const char* lpszSDKTransactionId); Unicode (Windows) LPWSTR GetSDKTransactionId();
INT SetSDKTransactionId(LPCWSTR lpszSDKTransactionId);
char* ipworks3ds_client_getsdktransactionid(void* lpObj);
int ipworks3ds_client_setsdktransactionid(void* lpObj, const char* lpszSDKTransactionId);
QString GetSDKTransactionId();
int SetSDKTransactionId(QString qsSDKTransactionId);
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 GetAuthRequest 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.
Data Type
String
SSLAcceptServerCertEncoded Property (Client Class)
This is the certificate (PEM/base64 encoded).
Syntax
ANSI (Cross Platform) int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded); Unicode (Windows) INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);
int ipworks3ds_client_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworks3ds_client_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);
QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);
Default Value
""
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.
When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Binary String
SSLCertEncoded Property (Client Class)
This is the certificate (PEM/base64 encoded).
Syntax
ANSI (Cross Platform) int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded); Unicode (Windows) INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);
int ipworks3ds_client_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworks3ds_client_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);
QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);
Default Value
""
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.
When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Binary String
SSLCertStore Property (Client Class)
This is the name of the certificate store for the client certificate.
Syntax
ANSI (Cross Platform) int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore); Unicode (Windows) INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);
int ipworks3ds_client_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworks3ds_client_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);
QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.
SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.
Designations of certificate stores are platform-dependent.
The following are designations of the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).
Data Type
Binary String
SSLCertStorePassword Property (Client Class)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
ANSI (Cross Platform) char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword); Unicode (Windows) LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);
char* ipworks3ds_client_getsslcertstorepassword(void* lpObj);
int ipworks3ds_client_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);
QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);
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.
Data Type
String
SSLCertStoreType Property (Client Class)
This is the type of certificate store for this certificate.
Syntax
ANSI (Cross Platform) int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType); Unicode (Windows) INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);
Possible Values
CST_USER(0),
CST_MACHINE(1),
CST_PFXFILE(2),
CST_PFXBLOB(3),
CST_JKSFILE(4),
CST_JKSBLOB(5),
CST_PEMKEY_FILE(6),
CST_PEMKEY_BLOB(7),
CST_PUBLIC_KEY_FILE(8),
CST_PUBLIC_KEY_BLOB(9),
CST_SSHPUBLIC_KEY_BLOB(10),
CST_P7BFILE(11),
CST_P7BBLOB(12),
CST_SSHPUBLIC_KEY_FILE(13),
CST_PPKFILE(14),
CST_PPKBLOB(15),
CST_XMLFILE(16),
CST_XMLBLOB(17),
CST_JWKFILE(18),
CST_JWKBLOB(19),
CST_SECURITY_KEY(20),
CST_BCFKSFILE(21),
CST_BCFKSBLOB(22),
CST_PKCS11(23),
CST_AUTO(99)
int ipworks3ds_client_getsslcertstoretype(void* lpObj);
int ipworks3ds_client_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);
Default Value
0
Remarks
This is 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:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS11 interface.
To use a security key the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN. Code Example: SSH Authentication with Security Key
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
Data Type
Integer
SSLCertSubject Property (Client Class)
This is the subject of the certificate used for client authentication.
Syntax
ANSI (Cross Platform) char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject); Unicode (Windows) LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);
char* ipworks3ds_client_getsslcertsubject(void* lpObj);
int ipworks3ds_client_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);
QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);
Default Value
""
Remarks
This is 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 displayed below.
Field | Meaning |
CN | Common Name. This is commonly a host name like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma it must be quoted.
Data Type
String
SSLServerCertEncoded Property (Client Class)
This is the certificate (PEM/base64 encoded).
Syntax
ANSI (Cross Platform) int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded); Unicode (Windows) INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);
int ipworks3ds_client_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);
QByteArray GetSSLServerCertEncoded();
Default Value
""
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.
When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.
This property is read-only and not available at design time.
Data Type
Binary String
SubmitAuthenticationLabel Property (Client Class)
Label for UI button users select to submit authentication.
Syntax
ANSI (Cross Platform) char* GetSubmitAuthenticationLabel(); Unicode (Windows) LPWSTR GetSubmitAuthenticationLabel();
char* ipworks3ds_client_getsubmitauthenticationlabel(void* lpObj);
QString GetSubmitAuthenticationLabel();
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 ACSUIType is 01 (Text), 02 (Single Select) or 02 (Multi Select). App-based only.
This property is read-only.
Data Type
String
Timeout Property (Client Class)
A timeout for the class.
Syntax
ANSI (Cross Platform) int GetTimeout();
int SetTimeout(int iTimeout); Unicode (Windows) INT GetTimeout();
INT SetTimeout(INT iTimeout);
int ipworks3ds_client_gettimeout(void* lpObj);
int ipworks3ds_client_settimeout(void* lpObj, int iTimeout);
int GetTimeout();
int SetTimeout(int iTimeout);
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 DoEvents 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.
Please note that by default, all timeouts are inactivity timeouts, i.e. 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.
Data Type
Integer
TogglePositionIndicator Property (Client Class)
Toggle Position Indicator.
Syntax
ANSI (Cross Platform) int GetTogglePositionIndicator(); Unicode (Windows) INT GetTogglePositionIndicator();
int ipworks3ds_client_gettogglepositionindicator(void* lpObj);
int GetTogglePositionIndicator();
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.
Data Type
Integer
TransactionStatus Property (Client Class)
The transaction status from the last parsed message (ARes, RReq, or CRes).
Syntax
ANSI (Cross Platform) char* GetTransactionStatus(); Unicode (Windows) LPWSTR GetTransactionStatus();
char* ipworks3ds_client_gettransactionstatus(void* lpObj);
QString GetTransactionStatus();
Default Value
""
Remarks
Indicates whether a transaction qualifies as an authenticated transaction or account verification. Possible values are:
Y | Authentication/account verification successful. |
N | Not authenticated/account not verified; transaction denied. |
U | Authentication/account verification could not be performed; technical or other problem as indicated in ARes or RReq. |
A | Attempts processing performed; not authenticated/verified, but a proof of attempted authentication/verification is provided. |
C | Challenge required; additional authentication is required using the CReq/CRes. |
R | Authentication/account verification rejected; issuer is rejecting authentication/verification and request that authorization not be attempted. |
D | Challenge required; decoupled authentication confirmed. |
I | Informational only; 3DS Requestor challenge preference acknowledged. |
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.
Data Type
String
UseAdditionalChallenge Property (Client Class)
Whether or not the additional choice button is selected.
Syntax
ANSI (Cross Platform) int GetUseAdditionalChallenge();
int SetUseAdditionalChallenge(int bUseAdditionalChallenge); Unicode (Windows) BOOL GetUseAdditionalChallenge();
INT SetUseAdditionalChallenge(BOOL bUseAdditionalChallenge);
int ipworks3ds_client_getuseadditionalchallenge(void* lpObj);
int ipworks3ds_client_setuseadditionalchallenge(void* lpObj, int bUseAdditionalChallenge);
bool GetUseAdditionalChallenge();
int SetUseAdditionalChallenge(bool bUseAdditionalChallenge);
Default Value
FALSE
Remarks
Indicates to the ACS that the Cardholder selected the additional choice.
Data Type
Boolean
UseInformationContinuation Property (Client Class)
Whether or not the Information Continue button is selected.
Syntax
ANSI (Cross Platform) int GetUseInformationContinuation();
int SetUseInformationContinuation(int bUseInformationContinuation); Unicode (Windows) BOOL GetUseInformationContinuation();
INT SetUseInformationContinuation(BOOL bUseInformationContinuation);
int ipworks3ds_client_getuseinformationcontinuation(void* lpObj);
int ipworks3ds_client_setuseinformationcontinuation(void* lpObj, int bUseInformationContinuation);
bool GetUseInformationContinuation();
int SetUseInformationContinuation(bool bUseInformationContinuation);
Default Value
FALSE
Remarks
Indicator notifying the ACS that the Cardholder selected the Information Continue button in the Information UI template.
Data Type
Boolean
WhitelistingDataEntry Property (Client Class)
Whitelisting Data Entry.
Syntax
ANSI (Cross Platform) int GetWhitelistingDataEntry();
int SetWhitelistingDataEntry(int bWhitelistingDataEntry); Unicode (Windows) BOOL GetWhitelistingDataEntry();
INT SetWhitelistingDataEntry(BOOL bWhitelistingDataEntry);
int ipworks3ds_client_getwhitelistingdataentry(void* lpObj);
int ipworks3ds_client_setwhitelistingdataentry(void* lpObj, int bWhitelistingDataEntry);
bool GetWhitelistingDataEntry();
int SetWhitelistingDataEntry(bool bWhitelistingDataEntry);
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 WhitelistingInformationText.
Data Type
Boolean
WhitelistingInformationText Property (Client Class)
Whitelisting information text.
Syntax
ANSI (Cross Platform) char* GetWhitelistingInformationText(); Unicode (Windows) LPWSTR GetWhitelistingInformationText();
char* ipworks3ds_client_getwhitelistinginformationtext(void* lpObj);
QString GetWhitelistingInformationText();
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.
Data Type
String
WhyInformationLabel Property (Client Class)
Label for why information section.
Syntax
ANSI (Cross Platform) char* GetWhyInformationLabel(); Unicode (Windows) LPWSTR GetWhyInformationLabel();
char* ipworks3ds_client_getwhyinformationlabel(void* lpObj);
QString GetWhyInformationLabel();
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.
Data Type
String
WhyInformationText Property (Client Class)
Text to explain the authentication task to the user.
Syntax
ANSI (Cross Platform) char* GetWhyInformationText(); Unicode (Windows) LPWSTR GetWhyInformationText();
char* ipworks3ds_client_getwhyinformationtext(void* lpObj);
QString GetWhyInformationText();
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.
Data Type
String
AddDeviceParam Method (Client Class)
Adds a device parameter to the collection.
Syntax
ANSI (Cross Platform) int AddDeviceParam(const char* lpszfield, const char* lpszvalue, int ivalueType, int icategory); Unicode (Windows) INT AddDeviceParam(LPCWSTR lpszfield, LPCWSTR lpszvalue, INT ivalueType, INT icategory);
int ipworks3ds_client_adddeviceparam(void* lpObj, const char* lpszfield, const char* lpszvalue, int ivalueType, int icategory);
int AddDeviceParam(const QString& qsfield, const QString& qsvalue, int ivalueType, int icategory);
Remarks
AddDeviceParam adds a new device parameter to the DeviceParams 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);
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
AddExtension Method (Client Class)
Adds an extension to the collection.
Syntax
ANSI (Cross Platform) int AddExtension(const char* lpszId, const char* lpszName, int bCritical, const char* lpszData); Unicode (Windows) INT AddExtension(LPCWSTR lpszId, LPCWSTR lpszName, BOOL bCritical, LPCWSTR lpszData);
int ipworks3ds_client_addextension(void* lpObj, const char* lpszId, const char* lpszName, int bCritical, const char* lpszData);
int AddExtension(const QString& qsId, const QString& qsName, bool bCritical, const QString& qsData);
Remarks
Data necessary to support requirements not otherwise defined in the 3-D Secure message are carried in Message Extensions. AddExtension adds a new extension to the Extensions collection.
Note: The maximum number of extensions is 10.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
AddRequestField Method (Client Class)
Adds a field to the data in the request.
Syntax
ANSI (Cross Platform) int AddRequestField(const char* lpszName, const char* lpszValue, int iValueType); Unicode (Windows) INT AddRequestField(LPCWSTR lpszName, LPCWSTR lpszValue, INT iValueType);
int ipworks3ds_client_addrequestfield(void* lpObj, const char* lpszName, const char* lpszValue, int iValueType);
int AddRequestField(const QString& qsName, const QString& qsValue, int iValueType);
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.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
CheckAuthResponse Method (Client Class)
Checks the received packet.
Syntax
ANSI (Cross Platform) int CheckAuthResponse(const char* lpszauthResponse); Unicode (Windows) INT CheckAuthResponse(LPCWSTR lpszauthResponse);
int ipworks3ds_client_checkauthresponse(void* lpObj, const char* lpszauthResponse);
int CheckAuthResponse(const QString& qsauthResponse);
Remarks
After the response to the authentication request is received from the 3DS Server class, call CheckAuthResponse to verify and parse the response. See the 3DS Server's SendAuthRequest method for details about obtaining the response.
Before calling this method, ACSRootCerts 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 TransactionStatus to determine if the transaction requires a challenge. If TransactionStatus is C, a challenge is required and SendChallengeRequest should be called to proceed with the challenge flow. If TransactionStatus 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 TransactionStatus is Y or A, the transaction is complete.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Config Method (Client Class)
Sets or retrieves a configuration setting.
Syntax
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* ipworks3ds_client_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);
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.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
GetAuthRequest Method (Client Class)
Prepares data to be sent by the 3DS Server.
Syntax
ANSI (Cross Platform) char* GetAuthRequest(); Unicode (Windows) LPWSTR GetAuthRequest();
char* ipworks3ds_client_getauthrequest(void* lpObj);
QString GetAuthRequest();
Remarks
GetAuthRequest encrypts the device info and prepares all the data necessary to be sent by the 3DS Server class in the SendAuthRequest 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:
Property | Description |
DeviceParams | Contains device information parameters. Add parameters via AddDeviceParam. |
DirectoryServerCert | Used to encrypt the device parameters. |
DirectoryServerId | Identifies the DirectoryServerCert within the directory server. |
SDKAppId | A UUID for the specific installation. |
SDKReferenceNumber | An Id assigned by EMVCo to identify the vendor and software version. |
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 SendAuthRequest for details on sending the authentication request after transmitting the data to the 3DS Server.
Calling this method also populates SDKTransactionId which uniquely identifies this transaction and must be used in subsequent calls relating to this transaction, such as SendChallengeRequest.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Interrupt Method (Client Class)
Interrupts the current action.
Syntax
ANSI (Cross Platform) int Interrupt(); Unicode (Windows) INT Interrupt();
int ipworks3ds_client_interrupt(void* lpObj);
int Interrupt();
Remarks
This method interrupts any processing that the class is currently executing.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Reset Method (Client Class)
Clears all properties to their default values.
Syntax
ANSI (Cross Platform) int Reset(); Unicode (Windows) INT Reset();
int ipworks3ds_client_reset(void* lpObj);
int Reset();
Remarks
This method clears all properties to their default values.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ResetTransactionInfo Method (Client Class)
Resets transaction specific information.
Syntax
ANSI (Cross Platform) int ResetTransactionInfo(); Unicode (Windows) INT ResetTransactionInfo();
int ipworks3ds_client_resettransactioninfo(void* lpObj);
int ResetTransactionInfo();
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 AddRequestField
- ACSHTML
- ACSHTMLRefresh
- ACSUIType
- ChallengeAdditionalInformation
- ChallengeComplete
- ChallengeDataEntry
- ChallengeInfoHeader
- ChallengeInfoLabel
- ChallengeInfoText
- EnableChallengeInfoTextIndicator
- ChallengeSelectInfo
- DataPacketOut
- DeviceParams
- ErrorPacket
- ExpandableInformationLabel
- ExpandableInformationText
- IssuerImage1
- IssuerImage2
- IssuerImage3
- OOBContinuationIndicator
- OOBContinueLabel
- PaymentSystemImage1
- PaymentSystemImage2
- PaymentSystemImage3
- ResendInformationLabel
- SDKTransactionId
- SubmitAuthenticationLabel
- TransactionStatus
- WhyInformationLabel
- WhyInformationText
- WhitelistingDataEntry
- WhitelistingInformationText
- ACSSignedContent
- ACSTransactionId
- ACSURL
- ChallengeCancellationIndicator
- DSTransactionId
- DecoupledRequestIndicator
- IncomingRawExtensions
- OutgoingRawExtensions
- Extensions
- IncomingExtensionCount
- IncomingExtensionId
- IncomingExtensionName
- IncomingExtensionCritical
- IncomingExtensionData
- OOBAppLabel
- OOBAppURL
- ResendChallengeInfo
- TransactionStatusReason
- MerchantAppURL
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SendChallengeRequest Method (Client Class)
Builds and sends the Challenge Request in an app-based challenge flow.
Syntax
ANSI (Cross Platform) int SendChallengeRequest(); Unicode (Windows) INT SendChallengeRequest();
int ipworks3ds_client_sendchallengerequest(void* lpObj);
int SendChallengeRequest();
Remarks
SendChallengeRequest sends the Challenge Request to the ACS when a challenge is required.
When the TransactionStatus is C after calling CheckAuthResponse, 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 ChallengeComplete to determine if the challenge process is complete. If it is complete (True), check TransactionStatus to determine the outcome. If ChallengeComplete 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 CheckAuthResponse 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 CheckAuthResponse is called. If the transaction has been canceled, set ChallengeCancellationIndicator to inform the ACS.
After calling this method, the ACS will respond with details about the challenge to be presented to the cardholder. The ACSUIType property indicates the way the ACS will interact with the cardholder. The ChallengeComplete 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 ACSUIType is Text (01), Single-Select (02), or Multi-Select (03):
- ChallengeSelectInfo
- ChallengeInfoHeader
- ChallengeInfoLabel
- ChallengeInfoText
- EnableChallengeInfoTextIndicator
- ExpandableInformationLabel
- ExpandableInformationText
- IssuerImage1
- IssuerImage2
- IssuerImage3
- PaymentSystemImage1
- PaymentSystemImage2
- PaymentSystemImage3
- ResendInformationLabel
- SubmitAuthenticationLabel
- WhyInformationLabel
- WhyInformationText
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 ACSUIType is Out-of-Band (04):
- ChallengeAdditionalInformation
- ChallengeInfoHeader
- ChallengeInfoLabel
- ChallengeInfoText
- EnableChallengeInfoTextIndicator
- ExpandableInformationLabel
- ExpandableInformationText
- IssuerImage1
- IssuerImage2
- IssuerImage3
- OOBContinueLabel
- PaymentSystemImage1
- PaymentSystemImage2
- PaymentSystemImage3
- ResendInformationLabel
- WhyInformationLabel
- WhyInformationText
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 ACSUIType is HTML (05):
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 ChallengeCancellationIndicator to inform the ACS. The following properties are applicable when calling this method the second time:
When ACSUIType is Text (01) or HTML (05), set ChallengeDataEntry to the data exactly as it was specified by the cardholder. Do not format or otherwise change the data.
When ACSUIType is Single-Select (02), set ChallengeDataEntry 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***.comThe value to provide in ChallengeDataEntry is the ChallengeSelectInfoName, i.e. mobile.
When ACSUIType is Multi-Select (03), set ChallengeDataEntry to a comma-separated list of names of the selected options. For instance if ChallengeSelectInfo contains elements with names like chicago_illinois, st_louis_missouri, and portland_oregon, and the user chose two options, the value specified in ChallengeDataEntry would be chicago_illinois,portland_oregon.
When ACSUIType is OOB (04), set OOBContinuationIndicator to True to indicate the cardholder has pressed the button signaling their completing of the OOB process.
Completing the Challenge
After calling SendChallengeRequest a second time with the cardholder's responses, the ACS may require additional challenges. Check the ChallengeComplete 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 ChallengeComplete is True, the challenge interaction is complete and TransactionStatus 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 ResultsURL property of the 3DS Server class.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
DataPacketIn Event (Client Class)
Fired when receiving a data packet from the server.
Syntax
ANSI (Cross Platform) virtual int FireDataPacketIn(ClientDataPacketInEventParams *e);
typedef struct {
const char *DataPacket; int lenDataPacket; int reserved; } ClientDataPacketInEventParams;
Unicode (Windows) virtual INT FireDataPacketIn(ClientDataPacketInEventParams *e);
typedef struct {
LPCSTR DataPacket; INT lenDataPacket; INT reserved; } ClientDataPacketInEventParams;
#define EID_CLIENT_DATAPACKETIN 1 virtual INT IPWORKS3DS_CALL FireDataPacketIn(LPSTR &lpDataPacket, INT &lenDataPacket);
class ClientDataPacketInEventParams { public: const QByteArray &DataPacket(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void DataPacketIn(ClientDataPacketInEventParams *e);
// Or, subclass Client and override this emitter function. virtual int FireDataPacketIn(ClientDataPacketInEventParams *e) {...}
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.
DataPacketOut Event (Client Class)
Fired when sending a data packet to the server.
Syntax
ANSI (Cross Platform) virtual int FireDataPacketOut(ClientDataPacketOutEventParams *e);
typedef struct {
const char *DataPacket; int lenDataPacket; int reserved; } ClientDataPacketOutEventParams;
Unicode (Windows) virtual INT FireDataPacketOut(ClientDataPacketOutEventParams *e);
typedef struct {
LPCSTR DataPacket; INT lenDataPacket; INT reserved; } ClientDataPacketOutEventParams;
#define EID_CLIENT_DATAPACKETOUT 2 virtual INT IPWORKS3DS_CALL FireDataPacketOut(LPSTR &lpDataPacket, INT &lenDataPacket);
class ClientDataPacketOutEventParams { public: const QByteArray &DataPacket(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void DataPacketOut(ClientDataPacketOutEventParams *e);
// Or, subclass Client and override this emitter function. virtual int FireDataPacketOut(ClientDataPacketOutEventParams *e) {...}
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.
Error Event (Client Class)
Information about errors during data delivery.
Syntax
ANSI (Cross Platform) virtual int FireError(ClientErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } ClientErrorEventParams;
Unicode (Windows) virtual INT FireError(ClientErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } ClientErrorEventParams;
#define EID_CLIENT_ERROR 3 virtual INT IPWORKS3DS_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class ClientErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(ClientErrorEventParams *e);
// Or, subclass Client and override this emitter function. virtual int FireError(ClientErrorEventParams *e) {...}
Remarks
The 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.
Log Event (Client Class)
Fires once for each log message.
Syntax
ANSI (Cross Platform) virtual int FireLog(ClientLogEventParams *e);
typedef struct {
int LogLevel;
const char *Message;
const char *LogType; int reserved; } ClientLogEventParams;
Unicode (Windows) virtual INT FireLog(ClientLogEventParams *e);
typedef struct {
INT LogLevel;
LPCWSTR Message;
LPCWSTR LogType; INT reserved; } ClientLogEventParams;
#define EID_CLIENT_LOG 4 virtual INT IPWORKS3DS_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);
class ClientLogEventParams { public: int LogLevel(); const QString &Message(); const QString &LogType(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Log(ClientLogEventParams *e);
// Or, subclass Client and override this emitter function. virtual int FireLog(ClientLogEventParams *e) {...}
Remarks
Logging in the component is handled through the Log event. This will fire anytime a message is built or a response is parsed, including error messages.
When the 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 DataPacketIn and DataPacketOut 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.
SSLServerAuthentication Event (Client Class)
Fired after the server presents its certificate to the client.
Syntax
ANSI (Cross Platform) virtual int FireSSLServerAuthentication(ClientSSLServerAuthenticationEventParams *e);
typedef struct {
const char *CertEncoded; int lenCertEncoded;
const char *CertSubject;
const char *CertIssuer;
const char *Status;
int Accept; int reserved; } ClientSSLServerAuthenticationEventParams;
Unicode (Windows) virtual INT FireSSLServerAuthentication(ClientSSLServerAuthenticationEventParams *e);
typedef struct {
LPCSTR CertEncoded; INT lenCertEncoded;
LPCWSTR CertSubject;
LPCWSTR CertIssuer;
LPCWSTR Status;
BOOL Accept; INT reserved; } ClientSSLServerAuthenticationEventParams;
#define EID_CLIENT_SSLSERVERAUTHENTICATION 5 virtual INT IPWORKS3DS_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);
class ClientSSLServerAuthenticationEventParams { public: const QByteArray &CertEncoded(); const QString &CertSubject(); const QString &CertIssuer(); const QString &Status(); bool Accept(); void SetAccept(bool bAccept); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSLServerAuthentication(ClientSSLServerAuthenticationEventParams *e);
// Or, subclass Client and override this emitter function. virtual int FireSSLServerAuthentication(ClientSSLServerAuthenticationEventParams *e) {...}
Remarks
This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.
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.
SSLStatus Event (Client Class)
Shows the progress of the secure connection.
Syntax
ANSI (Cross Platform) virtual int FireSSLStatus(ClientSSLStatusEventParams *e);
typedef struct {
const char *Message; int reserved; } ClientSSLStatusEventParams;
Unicode (Windows) virtual INT FireSSLStatus(ClientSSLStatusEventParams *e);
typedef struct {
LPCWSTR Message; INT reserved; } ClientSSLStatusEventParams;
#define EID_CLIENT_SSLSTATUS 6 virtual INT IPWORKS3DS_CALL FireSSLStatus(LPSTR &lpszMessage);
class ClientSSLStatusEventParams { public: const QString &Message(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSLStatus(ClientSSLStatusEventParams *e);
// Or, subclass Client and override this emitter function. virtual int FireSSLStatus(ClientSSLStatusEventParams *e) {...}
Remarks
The event is fired for informational and logging purposes only. Used to track the progress of the connection.
Config Settings (Client Class)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.Client Config Settings
Use this setting with caution, it should only be enabled when there is a specific reason to do so as it bypasses normal signature validation logic.
01 | Portrait |
02 | Landscape |
03 | Voice |
04 | Other |
Possible values are:
01 | Native UI |
02 | HTML UI |
Possible values are:
01 | Text |
02 | Single Select |
03 | Multi Select |
04 | OOB |
05 | HTML Other (valid only for HTML UI) |
06 | HTML OOB (valid only for 2.3.1) |
07 | Information (valid only for 2.3.1) |
This setting is only applicable to the app-based flow and is informational. It does not need to be queried or set in most cases.
Possible values are:
01 | Native |
02 | HTML |
03 | Both |
One of the elements comprising the Device Rendering Options which define the SDK UI types that the device supports (along with DeviceRenderingInterface). These Options are required in AReq messages.
01 | Text |
02 | Single Select |
04 | Multi Select |
08 | OOB |
16 | HTML Other |
Note that currently all SDKs need to support all UI types. In the future, however, this may change (for example, smart watches may support a UI Type not yet defined). In light of this, all UI types are enabled by default (31).
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data is logged. |
3 (Debug) | Debug data is logged. |
Note: DataPacketOut will always contain the raw unmasked value regardless of this setting. This setting only applies to the Log event.
The default value is True.
For instance: merchantScheme://appName?transID=b2385523-a66c-4907-ac3c-91848e8c0067
Possible values include:
AReq | Authentication Request Message |
ARes | Authentication Response Message |
CReq | Challenge Request Message |
CRes | Challenge Response Message |
PReq | Preparation Request Message |
PRes | Preparation Response Message |
RReq | Results Request Message |
RRes | Results Response Message |
Erro | Error Message |
This setting is read-only.
Note: When sending extension data it is generally recommended to use Extensions instead of this setting.
Possible values are:
2.1.0 (Default) | |
2.2.0 | |
2.3.1 |
Possible values include:
Y | Resend |
N | Do not resend |
01 | Static Passcode |
02 | SMS OTP |
03 | Key fob or EMV card reader OTP |
04 | App OTP |
05 | OTP Other |
06 | KBA |
07 | OOB Biometrics |
08 | OOB Login |
09 | OOB Other |
10 | Other |
11 | Push Notification |
If the same instance of the class is used throughout the lifetime of the transaction this setting does not need to be used.
Possible values are:
01 | Card authentication failed |
02 | Unknown device |
03 | Unsupported device |
04 | Exceeds authentication frequency limit |
05 | Expired card |
06 | Invalid card number |
07 | Invalid transaction |
08 | No Card record |
09 | Security failure |
10 | Stolen card |
11 | Suspected fraud |
12 | Transaction not permitted to cardholder |
13 | Cardholder not enrolled in service |
14 | Transaction timed out at the ACS |
15 | Low confidence |
16 | Medium confidence |
17 | High confidence |
18 | Very high confidence |
19 | Exceeds ACS maximum challenges |
20 | Non-Payment transaction non supported |
21 | 3RI transaction not supported |
22 | ACS technical issue |
23 | Decoupled Authentication required by ACS but not requested by 3DS Requestor |
24 | 3DS Requestor Decoupled Max Expiry Time exceeded |
25 | Decoupled Authentication was provided insufficient time to authenticate cardholder. ACS will not make attempt |
26 | Authentication attempted but not performed by the cardholder |
27 | Preferred Authentication Method not supported |
28 | Validation of content security policy failed |
29 | Authentication attempted but not completed by the Cardholder. Fall back to Decoupled Authentication |
30 | Authentication completed successfully but additional authentication of the Cardholder required. Reinitiate as Decoupled Authentication |
31-79 | Reserved for future EMVCo use (values invalid until defined by EMVCo) |
80-99 | Reserved for DS use |
The current element is specified via the XPath configuration setting. This configuration setting is read-only.
The current element is specified via the XPath configuration setting. This configuration setting is read-only.
The current element is specified via the XPath configuration setting. This configuration setting is read-only.
The current element is specified via the XPath configuration setting. This configuration setting is read-only.
The current element is specified via the XPath configuration setting. This configuration setting is read-only.
When XPath is set to a valid path, XElement points to the name of the element, with XText, XParent, XSubTree, XChildCount, XChildName[i], and XChildXText[i] providing other properties of the element.
XPath Syntax
XPath syntax is available for both XML and JSON documents. An XPath is a series of one or more element accessors separated by the / character, for example: /A/B/C/D. An XPath can be absolute (i.e., it starts with /), or it can be relative to the current XPath location.
The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors which proceed it in the overall XPath string:
Accessor | Description |
name | The first element with a particular name. Can be *. |
[i] | The i-th element. |
name[i] | The i-th element with a particular name. |
[last()] | The last element. |
[last()-i] | The element i before the last element. |
name[@attrname="attrvalue"] | The first element with a particular name that contains the specified attribute-value pair.
Supports single and double quotes. (XML Only) |
. | The current element. |
.. | The parent element. |
XPath Examples
Assuming the following XML response:
<firstlevel> <one>value</one> <two> <item>first</item> <item>second</item> </two> <three>value three</three> </firstlevel>
Or, alternatively, the following JSON response:
{ "firstlevel": { "one": "value", "two": ["first", "second"], "three": "value three" } }
Here are some examples of valid XPaths:
Description | XML XPath | JSON XPath |
Document root | / | /json |
Specific element | /firstlevel/one | /json/firstlevel/one |
i-th child | /firstlevel/two/item[2] | /json/firstlevel/two/[2] |
This is not an exhaustive list by any means, but should provide a general idea of the possibilities.
The current element is specified via the XPath configuration setting. This configuration setting is read-only.
The current element is specified in the XPath configuration setting. This configuration setting is read-only.
SSL Config Settings
When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.
Enabling this setting has no effect if SSLProvider is set to Platform.
The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by
-----BEGIN CERTIFICATE-----
... (CA certificate in base64 encoding) ...
-----END CERTIFICATE-----
sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".
By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.
If set to true, the class will reuse the context if and only if the following criteria are met:
- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the class is the same.
The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.
The default value is:
/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.
Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.
When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting.
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.
Multiple cipher suites are separated by semicolons.
Example values when SSLProvider is set to Platform:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when SSLProvider is set to Platform include:
- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA");
Possible values when SSLProvider is set to Internal include:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
- TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
- TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
- TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA
When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:
TLS1.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default) |
TLS1.1 | 768 (Hex 300) (Default) |
TLS1 | 192 (Hex C0) (Default) |
SSL3 | 48 (Hex 30) |
SSL2 | 12 (Hex 0C) |
SSLEnabledProtocols - TLS 1.3 Notes
By default when TLS 1.3 is enabled the class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions which are designed to run on Windows SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.
If set to 1 (Platform provider) please be aware of the following notes:
- The platform provider is only available on Windows 11 / Windows Server 2022 and up.
- SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
- If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2 the above restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.
This setting is only applicable when SSLProvider is set to Internal.
If set to True all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values.
Note: This setting is only applicable when SSLProvider is set to Internal.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
0x00000001 | Ignore time validity status of certificate. |
0x00000002 | Ignore time validity status of CTL. |
0x00000004 | Ignore non-nested certificate times. |
0x00000010 | Allow unknown Certificate Authority. |
0x00000020 | Ignore wrong certificate usage. |
0x00000100 | Ignore unknown certificate revocation status. |
0x00000200 | Ignore unknown CTL signer revocation status. |
0x00000400 | Ignore unknown Certificate Authority revocation status. |
0x00000800 | Ignore unknown Root revocation status. |
0x00008000 | Allow test Root certificate. |
0x00004000 | Trust test Root certificate. |
0x80000000 | Ignore non-matching CN (certificate CN not-matching server name). |
This functionality is currently not available when the provider is OpenSSL.
The value of this setting is a newline (CrLf) separated list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class fails with an error.
The format of this value is a comma separated list of hash-signature combinations. For instance:
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.
In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.
In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"
- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
Trappable Errors (Client Class)
Error Handling (C++)
Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Client Errors
601 Could not create ephemeral key. | |
602 Invalid certificate. | |
603 Invalid operation. | |
604 Invalid ClientAuth data. | |
605 The errorCode element in Erro message is invalid. | |
606 Invalid index. | |
1101 Protocol error. Received invalid message. | |
1102 Protocol error. Invalid message version. | |
1201 Protocol error. Missing data element. | |
1202 Protocol error. Unrecognized critical extension. | |
1301 Protocol error. Unrecognized transaction Id. | |
1302 Decryption failed. |
HTTP Errors
118 Firewall Error. Error description contains detailed message. | |
143 Busy executing current method. | |
151 HTTP protocol error. The error message has the server response. | |
152 No server specified in URL | |
153 Specified URLScheme is invalid. | |
155 Range operation is not supported by server. | |
156 Invalid cookie index (out of range). | |
301 Interrupted. | |
302 Can't open AttachedFile. |
The class may also return one of the following error codes, which are inherited from other classes.
TCPClient Errors
100 You cannot change the RemotePort at this time. A connection is in progress. | |
101 You cannot change the RemoteHost (Server) at this time. A connection is in progress. | |
102 The RemoteHost address is invalid (0.0.0.0). | |
104 Already connected. If you want to reconnect, close the current connection first. | |
106 You cannot change the LocalPort at this time. A connection is in progress. | |
107 You cannot change the LocalHost at this time. A connection is in progress. | |
112 You cannot change MaxLineLength at this time. A connection is in progress. | |
116 RemotePort cannot be zero. Please specify a valid service port number. | |
117 You cannot change the UseConnection option while the class is active. | |
135 Operation would block. | |
201 Timeout. | |
211 Action impossible in control's present state. | |
212 Action impossible while not connected. | |
213 Action impossible while listening. | |
301 Timeout. | |
302 Could not open file. | |
434 Unable to convert string to selected CodePage. | |
1105 Already connecting. If you want to reconnect, close the current connection first. | |
1117 You need to connect first. | |
1119 You cannot change the LocalHost at this time. A connection is in progress. | |
1120 Connection dropped by remote host. |
SSL Errors
270 Cannot load specified security library. | |
271 Cannot open certificate store. | |
272 Cannot find specified certificate. | |
273 Cannot acquire security credentials. | |
274 Cannot find certificate chain. | |
275 Cannot verify certificate chain. | |
276 Error during handshake. | |
280 Error verifying certificate. | |
281 Could not find client certificate. | |
282 Could not find server certificate. | |
283 Error encrypting data. | |
284 Error decrypting data. |
TCP/IP Errors
10004 [10004] Interrupted system call. | |
10009 [10009] Bad file number. | |
10013 [10013] Access denied. | |
10014 [10014] Bad address. | |
10022 [10022] Invalid argument. | |
10024 [10024] Too many open files. | |
10035 [10035] Operation would block. | |
10036 [10036] Operation now in progress. | |
10037 [10037] Operation already in progress. | |
10038 [10038] Socket operation on non-socket. | |
10039 [10039] Destination address required. | |
10040 [10040] Message too long. | |
10041 [10041] Protocol wrong type for socket. | |
10042 [10042] Bad protocol option. | |
10043 [10043] Protocol not supported. | |
10044 [10044] Socket type not supported. | |
10045 [10045] Operation not supported on socket. | |
10046 [10046] Protocol family not supported. | |
10047 [10047] Address family not supported by protocol family. | |
10048 [10048] Address already in use. | |
10049 [10049] Can't assign requested address. | |
10050 [10050] Network is down. | |
10051 [10051] Network is unreachable. | |
10052 [10052] Net dropped connection or reset. | |
10053 [10053] Software caused connection abort. | |
10054 [10054] Connection reset by peer. | |
10055 [10055] No buffer space available. | |
10056 [10056] Socket is already connected. | |
10057 [10057] Socket is not connected. | |
10058 [10058] Can't send after socket shutdown. | |
10059 [10059] Too many references, can't splice. | |
10060 [10060] Connection timed out. | |
10061 [10061] Connection refused. | |
10062 [10062] Too many levels of symbolic links. | |
10063 [10063] File name too long. | |
10064 [10064] Host is down. | |
10065 [10065] No route to host. | |
10066 [10066] Directory not empty | |
10067 [10067] Too many processes. | |
10068 [10068] Too many users. | |
10069 [10069] Disc Quota Exceeded. | |
10070 [10070] Stale NFS file handle. | |
10071 [10071] Too many levels of remote in path. | |
10091 [10091] Network subsystem is unavailable. | |
10092 [10092] WINSOCK DLL Version out of range. | |
10093 [10093] Winsock not loaded yet. | |
11001 [11001] Host not found. | |
11002 [11002] Non-authoritative 'Host not found' (try again or check DNS setup). | |
11003 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP. | |
11004 [11004] Valid name, no data record (check DNS setup). |