PINPAD API - Revision history

Mahong: /* show_text */

2019-07-17T02:46:19Z

show_text

← Older revision		Revision as of 02:46, 17 July 2019
Line 36:		Line 36:
	\| nLineIndex \|\| '''int:''' Line number to display, 0 or 1		\| nLineIndex \|\| '''int:''' Line number to display, 0 or 1
	\|-		\|-
	\| strText \|\| '''char*:''' Text to show~~, String.getBytes()~~		\| strText \|\| '''char*:''' Text to show
	\|-		\|-
	\| nLength \|\| '''int:''' Text length, the length maxsize is 14		\| nLength \|\| '''int:''' Text length, the length maxsize is 14
Line 52:		Line 52:
	\| int \|\| The result code, >= 0, success; <0 [[Error_code\|error code]].		\| int \|\| The result code, >= 0, success; <0 [[Error_code\|error code]].
	\|}		\|}


	=== <big>update_user_key</big> ===		=== <big>update_user_key</big> ===

Mahong at 09:40, 11 March 2019

2019-03-11T09:40:48Z

← Older revision		Revision as of 09:40, 11 March 2019
Line 16:		Line 16:
	<syntaxhighlight lang="c">int pinpad_close()</syntaxhighlight >		<syntaxhighlight lang="c">int pinpad_close()</syntaxhighlight >
	Close the PINPad device.		Close the PINPad device.
	The open and close apis are pair operations. If you don’t want to use this device, you should call the close ~~api~~ to release this device.		The open and close apis are pair operations. If you don’t want to use this device, you should call the close API to release this device.

	{\|class="wizarpostable"		{\|class="wizarpostable"
Line 104:		Line 104:
	\| pCheckValue \|\| '''unsigned char*:''' Check value of user key		\| pCheckValue \|\| '''unsigned char*:''' Check value of user key
	\|-		\|-
	\| nCheckValueLen \|\| '''int:''' Length of new user ~~keyLength~~ of check value, 4 bytes in general		\| nCheckValueLen \|\| '''int:''' Length of new user key length of check value, 4 bytes in general
	\|}		\|}
	{\|		{\|
Line 120:		Line 120:
	=== <big>set_pin_length</big> ===		=== <big>set_pin_length</big> ===
	<syntaxhighlight lang="c">int pinpad_set_pin_length(int nLength, int nFlag)</syntaxhighlight >		<syntaxhighlight lang="c">int pinpad_set_pin_length(int nLength, int nFlag)</syntaxhighlight >
	Set the max or min length of PIN. When you call the calculate_pin_block ~~api~~, the number you can input is no more than the max length.		Set the max or min length of PIN. When you call the calculate_pin_block API, the number you can input is no more than the max length.
	The min length should be >=4, the max length should be <=12		The min length should be >=4, the max length should be <=12

Line 169:		Line 169:
	=== <big>select_key</big> ===		=== <big>select_key</big> ===
	<syntaxhighlight lang="c">int pinpad_select_key(int nKeyType, int nMasterKeyID, int nUserKeyID, int nAlgorith)</syntaxhighlight >		<syntaxhighlight lang="c">int pinpad_select_key(int nKeyType, int nMasterKeyID, int nUserKeyID, int nAlgorith)</syntaxhighlight >
	Select the key before calculate ~~pinblock~~, calculate MAC and encrypt data.		Select the key before calculate pin block, calculate MAC and encrypt data.

	If the keyType is MASTER-SESSION PAIR:		If the keyType is MASTER-SESSION PAIR:
Line 177:		Line 177:
	If the keyType is TDUKPT:		If the keyType is TDUKPT:
	* Keep the user key id as 0, not used.		* Keep the user key id as 0, not used.
	* Set the mater key id to 0-2. The value is same with the index when you inject ~~dukpt~~ key. There are 3 groups of ~~dukpt~~ key, in every group, the driver generate PIN/MAC/DATA key automatically, don’t need to set again.		* Set the mater key id to 0-2. The value is same with the index when you inject DUKPT key. There are 3 groups of DUKPT key, in every group, the driver generate PIN/MAC/DATA key automatically, don’t need to set again.
	{\|class="wizarpostable"		{\|class="wizarpostable"
	\|-		\|-
Line 209:		Line 209:
	The length of card number is normally 13-19.		The length of card number is normally 13-19.

	The max waiting time for PIN input is ~~60s~~, and the two PIN input time span is ~~10s~~, otherwise this API will return error code.		The max waiting time for PIN input is 60 s, and the two PIN input time span is 10 s, otherwise this API will return error code.

	{\|class="wizarpostable"		{\|class="wizarpostable"
Line 412:		Line 412:
	\| nTextLength \|\| '''int：''' Length of plain text		\| nTextLength \|\| '''int：''' Length of plain text
	\|-		\|-
	\| pCipherTextBuffer \|\| '''unsigned char*：''' buffer for saving cipher text, for ~~dukpt~~ encrypt, the buffer data structure is: cipher data + KSN + counter.		\| pCipherTextBuffer \|\| '''unsigned char*：''' buffer for saving cipher text, for DUKPT encrypt, the buffer data structure is: cipher data + KSN + counter.
	\|-		\|-
	\| nCipherTextBufferLength \|\| '''int：''' Length of buffer		\| nCipherTextBufferLength \|\| '''int：''' Length of buffer
Line 418:		Line 418:
	\| nMode \|\| '''int：''' Cipher mode: 0-PINPAD_ENCRYPT_STRING_MODE_EBC; 1-PINPAD_ENCRYPT_STRING_MODE_CBC; 2-PINPAD_ENCRYPT_STRING_MODE_CFB; 3-PINPAD_ENCRYPT_STRING_MODE_OFB; Use NoPadding.		\| nMode \|\| '''int：''' Cipher mode: 0-PINPAD_ENCRYPT_STRING_MODE_EBC; 1-PINPAD_ENCRYPT_STRING_MODE_CBC; 2-PINPAD_ENCRYPT_STRING_MODE_CFB; 3-PINPAD_ENCRYPT_STRING_MODE_OFB; Use NoPadding.
	\|-		\|-
	\| pIV \|\| '''unsigned char*：''' initial vector, only for CBC, CFB, OFB mode, if without IV, set Null, but when using ~~dukpt~~ key, if without IV, set new byte[8].		\| pIV \|\| '''unsigned char*：''' initial vector, only for CBC, CFB, OFB mode, if without IV, set Null, but when using DUKPT key, if without IV, set new byte[8].
	\|-		\|-
	\| nIVLen \|\| '''int：''' length of IV, must be equal to block length according to the algorithm, if ~~withoout~~ IV, set 0, but when using ~~dukpt~~ key, if without IV, set 8.		\| nIVLen \|\| '''int：''' length of IV, must be equal to block length according to the algorithm, if without IV, set 0, but when using DUKPT key, if without IV, set 8.
	\|}		\|}
	{\|		{\|

Mahong: /* encrypt_string_with_mode */

2019-01-02T09:17:50Z

encrypt_string_with_mode

← Older revision		Revision as of 09:17, 2 January 2019
Line 418:		Line 418:
	\| nMode \|\| '''int：''' Cipher mode: 0-PINPAD_ENCRYPT_STRING_MODE_EBC; 1-PINPAD_ENCRYPT_STRING_MODE_CBC; 2-PINPAD_ENCRYPT_STRING_MODE_CFB; 3-PINPAD_ENCRYPT_STRING_MODE_OFB; Use NoPadding.		\| nMode \|\| '''int：''' Cipher mode: 0-PINPAD_ENCRYPT_STRING_MODE_EBC; 1-PINPAD_ENCRYPT_STRING_MODE_CBC; 2-PINPAD_ENCRYPT_STRING_MODE_CFB; 3-PINPAD_ENCRYPT_STRING_MODE_OFB; Use NoPadding.
	\|-		\|-
	\| pIV \|\| '''unsigned char*：''' initial vector, only for CBC, CFB, OFB mode, if without IV, set Null.		\| pIV \|\| '''unsigned char*：''' initial vector, only for CBC, CFB, OFB mode, if without IV, set Null, but when using dukpt key, if without IV, set new byte[8].
	\|-		\|-
	\| nIVLen \|\| '''int：''' length of IV, must be equal to block length according to the algorithm, if withoout IV, set 0.		\| nIVLen \|\| '''int：''' length of IV, must be equal to block length according to the algorithm, if withoout IV, set 0, but when using dukpt key, if without IV, set 8.
	\|}		\|}
	{\|		{\|

Mahong: /* encrypt_string */

2019-01-02T08:51:29Z

encrypt_string

← Older revision		Revision as of 08:51, 2 January 2019
Line 272:		Line 272:
	Encrypt string.		Encrypt string.

	The user key should be a data key whose id is 2 ~~in general~~.		The user key should be a data key whose id is 2 when using Master/Session key.
	The default Mode is ECB/NoPadding.		The default Mode is ECB/NoPadding.

Line 297:		Line 297:
	\| int \|\| The result code, >= 0, success, length of the encrypted data; <0 [[Error_code\|error code]].		\| int \|\| The result code, >= 0, success, length of the encrypted data; <0 [[Error_code\|error code]].
	\|}		\|}


	=== <big>update_cipher_master_key</big> ===		=== <big>update_cipher_master_key</big> ===

Mahong: /* calculate_mac */

2019-01-02T08:51:17Z

calculate_mac

← Older revision		Revision as of 08:51, 2 January 2019
Line 242:		Line 242:
	Calculate the MAC.		Calculate the MAC.

	The user key should be a MAC key whose id is 1 ~~in general~~.		The user key should be a MAC key whose id is 1 when using Master/Session key.
	{\|class="wizarpostable"		{\|class="wizarpostable"
	\|-		\|-
Line 267:		Line 267:
	\| int \|\| The result code, >= 0, success, length of MAC; <0 [[Error_code\|error code]].		\| int \|\| The result code, >= 0, success, length of MAC; <0 [[Error_code\|error code]].
	\|}		\|}


	=== <big>encrypt_string</big> ===		=== <big>encrypt_string</big> ===

Mahong: /* calculate_pin_block */

2019-01-02T08:51:03Z

calculate_pin_block

← Older revision		Revision as of 08:51, 2 January 2019
Line 205:		Line 205:
	Calculate the PIN block of the inputted PIN.		Calculate the PIN block of the inputted PIN.

	You should call select_key at first. The user key should be a PIN key whose id is 0 ~~in general~~.		You should call select_key at first. The user key should be a PIN key whose id is 0 when using Master/Session key.

	The length of card number is normally 13-19.		The length of card number is normally 13-19.
Line 237:		Line 237:
	\| int \|\| The result code, >= 0, success, length of pin block; <0 [[Error_code\|error code]].		\| int \|\| The result code, >= 0, success, length of pin block; <0 [[Error_code\|error code]].
	\|}		\|}


	=== <big>calculate_mac</big> ===		=== <big>calculate_mac</big> ===

Mahong: /* select_key */

2019-01-02T08:48:50Z

select_key

← Older revision		Revision as of 08:48, 2 January 2019
Line 173:		Line 173:
	If the keyType is MASTER-SESSION PAIR:		If the keyType is MASTER-SESSION PAIR:
	* If the device is external PINPad, the user key id is 0-1.		* If the device is external PINPad, the user key id is 0-1.
	* If the terminal device is a ~~WIZARHAND_Q1~~ or Q2, the user key id is 0-2.		* If the terminal device is a Q1 or Q2, the user key id is 0-2. 0 is for PIN key, 1 is for MAC key, 2 is for DATA key.
	* If called before update user key, the user key is encrypted using the algorithm which defined by nAlgorith parameter.		* If called before update user key, the user key is encrypted using the algorithm which defined by nAlgorith parameter.
	If the keyType is TDUKPT:		If the keyType is TDUKPT:
	* Keep the user key id as 0, not used.		* Keep the user key id as 0, not used.
	* Set the mater key id to 0-2.		* Set the mater key id to 0-2. The value is same with the index when you inject dukpt key. There are 3 groups of dukpt key, in every group, the driver generate PIN/MAC/DATA key automatically, don’t need to set again.
	{\|class="wizarpostable"		{\|class="wizarpostable"
	\|-		\|-
Line 200:		Line 200:
	\| int \|\| The result code, >= 0, success; <0 [[Error_code\|error code]].		\| int \|\| The result code, >= 0, success; <0 [[Error_code\|error code]].
	\|}		\|}


	=== <big>calculate_pin_block</big> ===		=== <big>calculate_pin_block</big> ===

Mahong at 03:12, 3 May 2018

2018-05-03T03:12:33Z

Mahong: /* encrypt_string_with_mode */

2018-05-03T03:11:32Z

encrypt_string_with_mode

← Older revision		Revision as of 03:11, 3 May 2018
Line 413:		Line 413:
	\| nCipherTextBufferLength \|\| '''int：''' Length of buffer		\| nCipherTextBufferLength \|\| '''int：''' Length of buffer
	\|-		\|-
	\| nMode \|\| '''int：''' Cipher mode: 0--PINPAD_ENCRYPT_STRING_MODE_EBC;1--PINPAD_ENCRYPT_STRING_MODE_CBC;2--PINPAD_ENCRYPT_STRING_MODE_CFB;3--PINPAD_ENCRYPT_STRING_MODE_OFB;Use NoPadding.		\| nMode \|\| '''int：''' Cipher mode: 0-PINPAD_ENCRYPT_STRING_MODE_EBC; 1-PINPAD_ENCRYPT_STRING_MODE_CBC; 2-PINPAD_ENCRYPT_STRING_MODE_CFB; 3-PINPAD_ENCRYPT_STRING_MODE_OFB; Use NoPadding.
	\|-		\|-
	\| pIV \|\| '''unsigned char*：''' initial vector, only for CBC, CFB, OFB mode, if without IV, set Null.		\| pIV \|\| '''unsigned char*：''' initial vector, only for CBC, CFB, OFB mode, if without IV, set Null.
Line 427:		Line 427:
	! scope="row" colspan="2" \| Returns		! scope="row" colspan="2" \| Returns
	\|-		\|-
	\| int \|\| The result code, >= 0, success; <0 [[Error_code\|error code]].		\| int \|\| The result code, >= 0, success, length of encrypted data; <0 [[Error_code\|error code]].
	\|}		\|}

Mahong: /* update_cipher_master_key_E */

2018-05-03T03:10:14Z

update_cipher_master_key_E

← Older revision		Revision as of 03:10, 3 May 2018
Line 384:		Line 384:
	\| nCheckValueLen \|\| '''int：''' Length of check value		\| nCheckValueLen \|\| '''int：''' Length of check value
	\|-		\|-
	\| algoCheckValue \|\| '''int：''' ~~ALGO_CHECK_VALUE:~~0-- ALGO_CHECK_VALUE_DEFAULT;1-- ALGO_CHECK_VALUE_SE919		\| algoCheckValue \|\| '''int：''' 0-ALGO_CHECK_VALUE_DEFAULT; 1-ALGO_CHECK_VALUE_SE919
	\|}		\|}
	{\|		{\|
Line 396:		Line 396:
	\| int \|\| The result code, >= 0, success; <0 [[Error_code\|error code]].		\| int \|\| The result code, >= 0, success; <0 [[Error_code\|error code]].
	\|}		\|}


	=== <big>encrypt_string_with_mode</big> ===		=== <big>encrypt_string_with_mode</big> ===

← Older revision		Revision as of 03:12, 3 May 2018
Line 200:		Line 200:
	\| int \|\| The result code, >= 0, success; <0 [[Error_code\|error code]].		\| int \|\| The result code, >= 0, success; <0 [[Error_code\|error code]].
	\|}		\|}


	=== <big>calculate_pin_block</big> ===		=== <big>calculate_pin_block</big> ===
Line 237:		Line 238:
	\| int \|\| The result code, >= 0, success, length of pin block; <0 [[Error_code\|error code]].		\| int \|\| The result code, >= 0, success, length of pin block; <0 [[Error_code\|error code]].
	\|}		\|}


	=== <big>calculate_mac</big> ===		=== <big>calculate_mac</big> ===
Line 267:		Line 269:
	\| int \|\| The result code, >= 0, success, length of MAC; <0 [[Error_code\|error code]].		\| int \|\| The result code, >= 0, success, length of MAC; <0 [[Error_code\|error code]].
	\|}		\|}


	=== <big>encrypt_string</big> ===		=== <big>encrypt_string</big> ===
Line 297:		Line 300:
	\| int \|\| The result code, >= 0, success, length of the encrypted data; <0 [[Error_code\|error code]].		\| int \|\| The result code, >= 0, success, length of the encrypted data; <0 [[Error_code\|error code]].
	\|}		\|}


	=== <big>update_cipher_master_key</big> ===		=== <big>update_cipher_master_key</big> ===
Line 326:		Line 330:
	\| int \|\| The result code, >= 0, success; <0 [[Error_code\|error code]].		\| int \|\| The result code, >= 0, success; <0 [[Error_code\|error code]].
	\|}		\|}


	=== <big>update_user_key_with_check_E</big> ===		=== <big>update_user_key_with_check_E</big> ===
Line 364:		Line 369:
	\| int \|\| The result code, >= 0, success; <0 [[Error_code\|error code]].		\| int \|\| The result code, >= 0, success; <0 [[Error_code\|error code]].
	\|}		\|}


	=== <big>update_cipher_master_key_E</big> ===		=== <big>update_cipher_master_key_E</big> ===
Line 396:		Line 402:
	\| int \|\| The result code, >= 0, success; <0 [[Error_code\|error code]].		\| int \|\| The result code, >= 0, success; <0 [[Error_code\|error code]].
	\|}		\|}


	=== <big>encrypt_string_with_mode</big> ===		=== <big>encrypt_string_with_mode</big> ===