Class PACE

Object
   |
   +--PACE

class PACE

This class implements the PACE protocol
Defined in pace.js

Field Detail

algo

Object algo

crypto

Object crypto

domparam

Object domparam

sym

Object sym

symalgo

Object symalgo

version

Object version

bsi_de

<static> Object bsi_de

id_IS

<static> Object id_IS

id_PACE

<static> Object id_PACE

id_PACE_ECDH_GM

<static> Object id_PACE_ECDH_GM

id_PACE_ECDH_GM_3DES_CBC_CBC

<static> Object id_PACE_ECDH_GM_3DES_CBC_CBC

id_PACE_ECDH_GM_AES_CBC_CMAC_128

<static> Object id_PACE_ECDH_GM_AES_CBC_CMAC_128

id_PACE_ECDH_GM_AES_CBC_CMAC_192

<static> Object id_PACE_ECDH_GM_AES_CBC_CMAC_192

id_PACE_ECDH_GM_AES_CBC_CMAC_256

<static> Object id_PACE_ECDH_GM_AES_CBC_CMAC_256

id_roles

<static> Object id_roles

PACE

PACE(<Crypto> crypto, <ByteString> algo, domparam, <Number> version)

Create a PACE protocol object

Parameters:
crypto - the crypto provider
algo - the algorithm OID
version - protocol version (1 or 2)
domainparam - the key object holding ECC domain parameter

calculateAuthenticationToken

ByteString calculateAuthenticationToken()

Calculate the authentication token over the public key received from the other side

Returns:
the MAC over the authentication data

decryptNonce

void decryptNonce(encnonce)

Decrypt and store nonce using PACE key.

Parameters:
nonce - the encrypted nonce

deriveKey

Key deriveKey(<ByteString> input, <Number> counter, nonce)

Derive key from input parameter, counter and optional nonce

Parameters:
input - the first part of the hash input
counter - the counter value
the - optional nonce inserted between the input and the counter

Returns:
the key object

generateEphemeralKeyPair

Key generateEphemeralKeyPair(domainParameter)

Generate ephemeral ECC key pair.

Parameters:
domainParameter - the domain parameter for the key pair

Returns:
the ephemeral public key

getEncryptedNonce

ByteString getEncryptedNonce()

Generate nonce and encrypt using PACE key.

Returns:
the encrypted nonce

getEphemeralPublicKey

ByteString getEphemeralPublicKey()

Returns the ephemeral public key based on the new domain parameter

Returns:
the encoded public key

getMappingData

ByteString getMappingData()

Generates and returns the mapping data for this instance

Returns:
the mapping data

getSymmetricAlgorithm

Number getSymmetricAlgorithm()

Return algorithm type

Returns:
Either Key.DES or Key.AES

hasMapping

Boolean hasMapping()

Returns true, if the mapping has been performed.

Returns:
true if the mapping has been performed

hasNonce

Boolean hasNonce()

Returns true, if the nonce is known.

Returns:
true if the nonce is known

performKeyAgreement

void performKeyAgreement(<ByteString> publicKey)

Performs the mapping operation with mapping data from the other side

Parameters:
publicKey - the public key in encoded format

performMapping

void performMapping(mappingData)

Performs the mapping operation with mapping data from the other side

setPassword

Object setPassword(<ByteString> pwd)

Set the password and derive the PACE key.

Parameters:
pwd - the PACE password (Hash Value for MRZ and ASCII string for others)

Returns:
the PACE key.

toString

Object toString()

Returns a human readable presentation of the current pace state. return {String} the object information

verifyAuthenticationToken

Boolean verifyAuthenticationToken(authToken)

Calculate and verify the authentication token over the public key received from the other side

Parameters:
the - MAC over the authentication data

Returns:
true if the MAC is valid

encodePublicKey

<static> ASN1 encodePublicKey(<String> oid, <Key> key, <Boolean> withDP)

Encode an ECC public key in the format defined by the EAC 2.0 specification

Parameters:
oid - the object identifier to encode
key - the EC public key
withDP - true to encode domain parameter as well

Returns:
the ASN1 encoded public key object

keyToString

<static> String keyToString(key)

Describe key

Parameters:
the - key

Returns:
the string describing the key

stripLeadingZeros

<static> ByteString stripLeadingZeros(<ByteString> value)

Strips leading zeros of a ByteString

Parameters:
value - the ByteString value

Returns:
the stripped ByteString object, may be an empty ByteString