Aventra MyEID PKI Card

Aventra MyEID PKI Card is a cryptographic smart card conforming to common Public Key Infrastructure standards like ISO/IEC-7816 and PKCS#15v1.0 specification. It can be used for various tasks requiring strong cryptography, e. g. logging securely to Windows, encrypting e-mail, authentication, and electronic signatures. The card is also available as a Dual Interface version, compatible with T=CL protocol and also emulating Mifare™. The card is a JavaCard with Aventra MyEID applet that implements the functionality.

The applet implements the FINEID S1 v1.12 specification and it can be configured to include all or any subset of the features specified in FINEID S4-1 or S4-2 specifications. Starting from version 2.2.0 the applet supports both 1024 and 2048 bit RSA keys. From version 3.0.0 (MyEID3) the applet supports keys from 512 bit up to 2048 bit in increments of 64 bits. The applet is fully compatible with JavaCard 2.1.1 and GlobalPlatform 2.0.1 specifications. The new MyEID version 3 (MyEID3) is now released and it uses the new JavaCard 2.2.1 and GlobalPlatform 2.1.1 platform. The new MyEID3 now supports RSA keys from 512 up to 2048 bits in 64 bit increments. MyEID3 supports file sizes up to 32767 bytes and 14 different PIN-codes can be created and used. The number of RSA keys is only limited by the available memory and maximum numbers of files (see PUT DATA: INITIALISE APPLET).

References

The most relevant specifications and standards are:

• ISO/IEC 7816-4
• ISO/IEC 7816-8
• ISO/IEC 7816-9
• JavaCard 2.1.1, MyEID3: 2.2.1
• GlobalPlatform 2.0.1 ' (Open Platform), MyEID3: GlobalPlatform 2.1.1
• FINEID S1 and S4 documentation

This document describes the functionality provided by the Aventra smartcard - which is a PKI container - on the T1C-GCL (Generic Connector Library) implemented version:

• MyEID - reference manual v1.7.36

Retrieve a connected card reader

In order to start with any use case, we need to select a card reader. The targeted reader will be passed as a parameter to the subsequent methods provided. This is part of the core Trust1Connector functionality. More information about core service functionality can be found on the following page: Core Services.

Just as an example, we instantiate a new gcl (local client) and ask for all connected smart card readers:

LibConfig conf = new LibConfig();
conf.setEnvironment(Environment.DEV);
conf.setDsUri(DS_URI);
conf.setOcvUri(OCV_URI);
conf.setGclClientUri(URI_T1C_GCL);
conf.setApiKey(API_KEY);
conf.setHardwarePinPadForced(false);
conf.setDefaultPollingIntervalInSeconds(5);
conf.setDefaultPollingTimeoutInSeconds(10);
conf.setSessionTimeout(60);
T1cClient t1cClient = new T1cClient(conf);
List<GclReader> reader = t1cClient.getCore().getReadersWithInsertedCard();

This will returns us all connected readers:

com.t1t.t1c.GclCard

In the example you'll notice that we are using a Gemalto Ezio Shield reader, and a card has been inserted.

The reader object can be used as parameter in the next steps in order to instantiate an Aventra container object:

AventraContainer container = t1cClient.getAventraContainer(reader);

Applet information

The following call can be done in order to retrieve the Aventra applet information on the card:

List<String> filter = Collections.singeltonList("applet-info");
GclAventraAllData allData = container.getAllData(filter);
GclAventraAppletInfo appletInfo = allData.getAppletInfo();

Example response:

com.t1t.t1c.containers.smartcards.pki.aventra.GclAventraAppletInfo

Certificates

Exposes all the certificates publicly available on the smart card. The following certificates can be found on the card:

• Root certificate
• Signing certificate
• Authentication certificate
• Issuer certificate
• Encryption certificate

T1C-JLIB will return the raw base64 certificate, optionally it can also return an java.security.cert.Certificate object. To enable parsing, parse must be set to true.

Certificate Chain

Root Certificate

Contains the 'root certificate' stored on the smart card.
The service can be called:

T1cCertificate rootCertificate = container.getRootCertificate();

Response:

com.t1t.t1c.model.T1cCertificate

Authentication Certificate

Contains the 'authentication certificate' stored on the smart card. The 'authentication certificate' contains the public key corresponding to the private RSA authentication key. The 'authentication certificate' is needed for pin validation, authentication and signing.
The service can be called:

T1cCertificate authenticationCertificate = containe.getAuthenticationCertificate();

Response:

com.t1t.t1c.model.T1cCertificate

Signing Certificate

Contains the 'non-repudiation certificate' stored on the smart card. The 'non-repudiation certificate' contains the public key corresponding the private RSA non-repudiation key.
The service can be called:

T1cCertificate signingCertificate = container.getSigningCertificate();

Response:

com.t1t.t1c.model.T1cCertificate

Issuer Certificate

The service can be called:

T1cCertificate issuerCertificate = container.getIssuerCertificate();

Response:

com.t1t.t1c.model.T1cCertificate

Encryption Certificate

The service can be called:

T1cCertificate encryptionCertificate = container.getEncryptionCertificate();

Response:

com.t1t.t1c.model.T1cCertificate

Data Filter

Available Data Filters

List<String> filters = container.getAllDataFilters();
AventraAllData allData = container.getAllData();

Response:

com.t1t.t1c.containers.smartcards.pki.aventra.AventraAllData

Filter Certificates

All certificates on the smart card can be dumped at once, or using a filter. In order to read all certificates at once:

AventraAllCertificates allCertificates = container.getAllCertificates

Response:

com.t1t.t1c.containers.smartcards.pki.aventra.AventraAllCertificates

The filter can be used to ask a list of custom data containers. For example, we want to read only the 'root-certificate' and the 'authentication-certificate':

List<String> filter = Arrays.asList("authentication-certificate","signing_certificate");
AventraAllCertificates allCertificates = container.getAllCertificates(filter);

Verify PIN

Without a pinpad

When the native or Java application is responsible for showing the password input, the following request is used to verify a card holder PIN:

Boolean pinVerified = container.verifyPin("1234");

Response:

java.lang.Boolean

With a pinpad

When the pin entry is done on the pin-pad, the following request is used to verify a card holder PIN:

Boolean pinVerified = container.verifyPin();

Response:

java.lang.Boolean

Verify PIN - retries left

After an unsuccesfull PIN verification, the container will throw a com.t1t.t1c.exceptions.VerifyPinException

 Boolean pinVerified = container.verifyPin("1235");

The following exception will be thrown when PIN is wrong:

com.t1t.t1c.exceptions.VerifyPinException

Note that, when the user has at least one retry left, entering a correct PIN resets the PIN retry status.

Reset PIN

When the native or Java application is responsible for showing the password input, the following request is used to reset a PIN using the PUK code when the PIN is blocked:

Boolean pinReset = container.resetPin(
        // The PUK code
        "PUK",
        // The new PIN
        "newPin",
        // The private key reference
        "sign"
);

The allowed values for privateKeyReferenceare authenticate, sign and encrypt. These values allow you to indicate which PIN code you want to reset.

Response:

java.lang.Boolean

The possible "privateKeyReference" values can be retrieved calling:

List<String> values = container.getAllKeyRefs();

Sign Data

Data can be signed using the Aventra smartcard. To do so, the T1C-GCL facilitates in:

• Retrieving the certificate chain (root, intermediate and non-repudiation certificate)
• Perform a sign operation (private key stays on the smart card)
• Return the signed hash

To get the certificates necessary for signature validation in your back-end:

// The leaf certificate will always have 0 as key
Map<Integer, T1cCertificate> signingCertificateChain = container.getSigningCertificateChain();

Response:

java.util.map<java.lang.Integer, com.t1t.t1c.model.T1cCertificate>

Depending on the connected smart card reader. A sign can be executed in 2 modes:

• Using a connected card reader with 'pin-pad' capabilities (keypad and display available)
• Using a connected card reader without 'pin-pad' capabilities (no keypad nor display available)

Security consideration: In order to sign a hash, security considerations prefer using a 'pin-pad'.

Signing algorithm references supported by the card

In order to verify which algorithm can be used for a 'sign' operation, you can call the following method:

List<DigestAlgorithm> signingAlgorithms = container.getAllAlgoRefsForSigning();

Sign Hash

Without a pinpad

When the native or Java application is responsible for showing the password input, the following request is used to sign a given hash:

String signedData = container.sign(
                //data
                "I2e+u/sgy7fYgh+DWA0p2jzXQ7E=",
                //Digest algorithn
                DigestAlgorithm.SHA256,
                //Optional PIN
                "1234"
);

Response is a base64 encoded signed hash:

"W7wqvWA8m9SBALZPxN0qUCZfB1O/WLaM/silenLzSXXmeR+0nzB7hXC/Lc/fMru82m/AAqCuGTYMPKcIpQG6MtZ/SGVpZUA/71jv3D9CatmGYGZc52cpcb7cqOVT7EmhrMtwo/jyUbi/Dy5c8G05owkbgx6QxnLEuTLkfoqsW9Q="

With a pinpad

When the pin entry is done on the pin-pad, the following request is used to sign a given hash:

String signedData = container.sign(
                //data
                "I2e+u/sgy7fYgh+DWA0p2jzXQ7E=",
                //Digest algorithn
                DigestAlgorithm.SHA256
);

Response is a base64 encoded signed hash:

"W7wqvWA8m9SBALZPxN0qUCZfB1O/WLaM/silenLzSXXmeR+0nzB7hXC/Lc/fMru82m/AAqCuGTYMPKcIpQG6MtZ/SGVpZUA/71jv3D9CatmGYGZc52cpcb7cqOVT7EmhrMtwo/jyUbi/Dy5c8G05owkbgx6QxnLEuTLkfoqsW9Q="

The DigestAlgorithm argument can contain the following values: sha1, sha256 and sha512.

The core services lists connected readers, and if they have pin-pad capability. You can find more information in the Core Service documentation on how to verify card reader capabilities.

Calculate Hash

In order to calculate a hash from the data to sign, you need to know the algorithm you will use in order to sign.
You might have noticed the DigestAlgorithm argument provided in the sign request.
The DigestAlgorithm argument can be one of the values: sha1, sha256 and sha512.
For example, we want the following text to be signed using:

This is sample text to demonstrate siging with Aventra smartcard

You can use the following online tool to calculate the SHA1: http://www.sha1-online.com

Hexadecimal result:

OTY4ODM2ODg3ODg3YWViYzdlZDBiMDgwMjQxZGQ5N2M4N2ZlMWRhZQ==

Notice that the length of the SHA1 is always the same.
Now we need to convert the hexadecimal string to a base64-encoded string, another online tool can be used for this example: hex to base64 converter

Base64-encoded result:

OTY4ODM2ODg3ODg3YWViYzdlZDBiMDgwMjQxZGQ5N2M4N2ZlMWRhZQ==

Now we can sign the data:

String signedData = container.sign(
                //data
                "OTY4ODM2ODg3ODg3YWViYzdlZDBiMDgwMjQxZGQ5N2M4N2ZlMWRhZQ==",
                //Digest algorithn
                DigestAlgorithm.SHA256,
                //Optional PIN
                "1234"
);

Result:

"C7SG5eix1+lzMcZXgL0bCL+rLxKhd8ngrSj6mvlgooWH7CloEU13Rj8QiQHdhHnZgAi4Q0fCMIqAc4dn9uW9OP+MRitimRpYZcaDsGrUehPi/JpOD1e+ko7xKZ67ijUU4KTmG4HXc114oJ7xxx3CGL7TNFfvuEphLbbZa+9IZSSnYDOOENJqhggqqu7paSbLJrxC2zaeMxODKb5WSexHnZH6NnLPl2OmvPTYtxiTUMrLbFRsDRAziF6/VQkgM8/xOm+1/9Expv5DSLRY8RQ+wha6/nMlJjx50JszYIj2aBQKp4AOxPVdPewVGEWF4NF9ffrPLrOA2v2d7t5M4q7yxA=="

Authentication

The T1C-GCL is able to authenticate a card holder based on a challenge. The challenge can be:

• provided by an external service
• provided by the smart card

An authentication can be interpreted as a signature use case, the challenge is signed data, that can be validated in a back-end process.

To get the certificates necessary for signature validation in your back-end:

// The leaf certificate will always have 0 as key
Map<Integer, T1cCertificate> signingCertificateChain = container.getAuthenticationCertificateChain();

Authentication algorithm references supported by the card

In order to verify which algorithm can be used for a 'sign' operation, you can call the following method:

List<DigestAlgorithm> authenticationAlgorithms = container.getAllAlgoRefsForAuthentication();

External Challenge

Without a pinpad

An external challenge is provided in the data property of the following example:

String authenticatedData = container.authenticate(
                //data
                "I2e+u/sgy7fYgh+DWA0p2jzXQ7E=",
                //Digest algorithn
                DigestAlgorithm.SHA256,
                //Optional PIN
                "1234"
);

Response:

"W7wqvWA8m9SBALZPxN0qUCZfB1O/WLaM/silenLzSXXmeR+0nzB7hXC/Lc/fMru82m/AAqCuGTYMPKcIpQG6MtZ/SGVpZUA/71jv3D9CatmGYGZc52cpcb7cqOVT7EmhrMtwo/jyUbi/Dy5c8G05owkbgx6QxnLEuTLkfoqsW9Q="

Without a pinpad

An external challenge is provided in the data property of the following example:

String authenticatedData = container.authenticate(
                //data
                "I2e+u/sgy7fYgh+DWA0p2jzXQ7E=",
                //Digest algorithn
                DigestAlgorithm.SHA256
);

Response:

"W7wqvWA8m9SBALZPxN0qUCZfB1O/WLaM/silenLzSXXmeR+0nzB7hXC/Lc/fMru82m/AAqCuGTYMPKcIpQG6MtZ/SGVpZUA/71jv3D9CatmGYGZc52cpcb7cqOVT7EmhrMtwo/jyUbi/Dy5c8G05owkbgx6QxnLEuTLkfoqsW9Q="

The DigestAlgorithm argument can contain the following values: sha1, sha256 and sha512.

Generated Challenge

A server generated challenge can be provided to the JavaScript library.
In order to do so, an additional contract must be provided with the 'OCV API' (Open Certificate Validation API).

The calculated digest of the hash is prefixed with:
DigestInfo ::= SEQUENCE {
      digestAlgorithm AlgorithmIdentifier,
      digest OCTET STRING
  }
Make sure this has been taken into consideration in order to validate the signature in a backend process.