Oberthur ID-One Cosmo v7-n PKI Card
The ID-One Cosmo V7-n is part of the Oberthur family of cryptographic modules called ID-One Cosmo V7. Modules within
this family share the same functionalities and the description of the ID-One Cosmo V7 applies to all versions including the “-n” subject to this validation.
This document describes the functionality provided by the Oberthur ID-One smartcard - which is a PKI container - on the T1C-GCL (Generic Connector Library) implemented version:
- ID-One Cosmo V7-n; FIPS 140-2 Security Policy
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);
List<GclReader> reader = t1cClient.getCore().getReadersWithInsertedCard();
This will returns us all connected readers:
Name | Description | Example Value | Type |
---|---|---|---|
id |
The reader ID | "2e49386c82131cc1" | java.lang.String |
name |
The reader name | "Gemalto Ezio Shield" | java.lang.String |
pinpad |
The presence of a hardware PIN-pad | false | java.lang.Boolean |
card |
The inserted card | see below | com.t1t.t1c.core.GclCard |
com.t1t.t1c.GclCard
Name | Description | Example Value | Type |
---|---|---|---|
atr |
Answer to Reset | "3BF51800008131FE454D794549449A" | java.lang.String |
description |
List of descriptions | ["Oberthur Cosmo v7 IAS ECC"] | java.util.List<java.lang.String> |
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:
OberthurContainer container = t1cClient.getOberthurContainer(reader);
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
Name | Description | Example Value | Type |
---|---|---|---|
base64 |
The base64 encoded certificate | ""MIIFjjCCA3agAwI...rTBDdrlEWVaLrY+M+xeIctrC0WnP7u4xg==" | java.lang.String |
parsed |
The decoded certificate | N/A | java.security.cert.Certificate |
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 singing.
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
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:
OberthurAllData allData = container.getAllData();
Response:
com.t1t.t1c.containers.smartcards.pki.oberthur.OberthurAllData
Name | Description | Example Value | Type |
---|---|---|---|
rootCertificate |
The root certificate | See above | com.t1t.t1c.model.T1cCertificate |
issuerCertificate |
The issuer certificate | See above | com.t1t.t1c.model.T1cCertificate |
signingCertificate |
The signing certificate | See above | com.t1t.t1c.model.T1cCertificate |
authenticationCertificate |
The authentication certificate | See above | com.t1t.t1c.model.T1cCertificate |
encryptionCertificate |
The encryption certificate | See above | com.t1t.t1c.model.T1cCertificate |
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 = container.getAllDataFilters();
OberthurAllData allData = container.getAllData(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
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
Name | Description | Example Value | Type |
---|---|---|---|
message |
The message | "Wrong pin, 2 tries remaining" | java.lang.String |
retriesLeft |
The amount of retries left | 2 | java.lang.Integer |
Note that, when the user has at least one retry left, entering a correct PIN resets the PIN retry status
.
Pinpad support
It is not possible to verify a pin directly on a card reader as the Oberthur card has a length of maximum 64 characters while a pinpad only supports 8 characters.
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
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="
The DigestAlgorithm argument can contain the following values: sha1 and sha256.
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 algorithm_reference
property provided in the sign
request.
The algorithm_reference
can be one of the values: sha1 and sha256.
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
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="
The DigestAlgorithm argument can contain the following values: sha1 and sha256.
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.