-
Notifications
You must be signed in to change notification settings - Fork 72
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update readme to include more info about IsoApplet versions
- Loading branch information
Philip Wendland
committed
Jan 22, 2023
1 parent
fa16e15
commit b22f0ee
Showing
1 changed file
with
27 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,31 +1,41 @@ | ||
General Information | ||
=================== | ||
# General Information | ||
The Java Card IsoApplet (e.g. for use with OpenSC). | ||
The Applet is capable of saving a PKCS#15 file structure and performing PKI related operations using the private key, such as signing or decrypting. | ||
Private keys can be generated directly on the smart card or imported from the host computer. | ||
The import of private keys is disabled in the default security configuration. | ||
The applet targets modern Smartcards with Java Card 3.0.4 or above. | ||
The applet targets modern smartcards with Java Card 3.0.4 or above. | ||
|
||
**Have a look at the wiki for more information:** https://github.com/philipWendland/IsoApplet/wiki | ||
# IsoApplet Version and Smartcard requirements | ||
IsoApplet is maintained in two different versions: one for newer smartcards and a legacy version for older smartcards. | ||
If your smartcard supports the newer version of IsoApplet, you should prefer it. | ||
For both versions, the support of the "requestObjectDeletion()"-mechanism of the Java Card API is recommended to be able to properly delete files. | ||
Also, the javacardx.crypto.Cipher-package needs to be supported by your smart card. | ||
This is very common among Java Card smartcards. | ||
|
||
## New version of IsoApplet (v1) | ||
This version is found on the [main branch](https://github.com/philipWendland/IsoApplet/tree/main). | ||
It targets smartcards with Java Card version >= 3.0.4. | ||
This version requires extended APDUs the be used and supported by your reader and smartcard (javacardx.apdu.ExtendedLength). | ||
If supported by your smart card, the newer version of IsoApplet supports the following additional features: | ||
* RSA keys of 4096 bit length | ||
* RSA PSS signatures | ||
* ECDSA with off-card hashing, which makes ECC actually usable in practice | ||
|
||
Smartcard requirements | ||
====================== | ||
* Minimum Java Card version: | ||
* 2.2.2 for legacy support [main-javacard-v2.2.2](https://github.com/philipWendland/IsoApplet/tree/main-javacard-v2.2.2) | ||
* 3.0.4 for the most recent version | ||
* Implementation of the "requestObjectDeletion()"-mechanism of the Java Card API is recommended to be able to properly delete files. | ||
* Support of javacardx.crypto.Cipher | ||
* Support of javacardx.apdu.ExtendedLength if extended APDUs are to be used | ||
* Support of FP ECC with the corresponding field size if ECDSA is to be used | ||
## Legacy Version of IsoApplet (v0) | ||
The legacy version is found on the [main-javacard-v2.2.2 branch](https://github.com/philipWendland/IsoApplet/tree/main-javacard-v2.2.2) branch. | ||
It targets smartcards with Java Card version >= 2.2.2. | ||
The ECDSA implementation with Java Card version 2.2.2 is hardly usable in practice because it requires on-card hash generation. | ||
If your smartcard implements javacardx.apdu.ExtendedLength and IsoApplet is configured with `DEF_EXT_APDU` in `IsoApplet.java`, you can use extended APDUs. | ||
|
||
Build process | ||
============= | ||
# Build process | ||
This project uses [ant-javacard](https://github.com/martinpaljak/ant-javacard) to build cap-files. | ||
After cloning the IsoApplet repository, all you have to do is: | ||
* Perform `git submodule init && git submodule update` to retrieve the Java Card SDKs, in case you did not `git clone --recursive` to clone this repository. | ||
* Install Apache `ant`, `openjdk-17-jdk-headless` | ||
* Invoke `ant` to produce the cap file. | ||
|
||
Installation | ||
============ | ||
# Installation | ||
Install the CAP-file (IsoApplet.cap) to your Java Card smart card (e.g. with [GlobalPlatformPro](https://github.com/martinpaljak/GlobalPlatformPro)). | ||
|
||
**Have a look at the wiki for more information:** https://github.com/philipWendland/IsoApplet/wiki | ||
|