c0de/SmartPGP
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
c0de 2023-08-26 16:02:53 -05:00
parent c289445f9f
commit c59f9618ba
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -84,16 +84,16 @@ The repository contains several directories:
## Prerequisites ## Prerequisites
- JavaCard Development Kit 3.0.1 (or above) from
[Oracle website](http://www.oracle.com/technetwork/java/embedded/javacard/downloads/index.html); - A Java compiler
- A device compliant with JavaCard 3.0.1 (or above) with enough - A device compliant with JavaCard 3.0.1 (or above) with enough
available resources to hold the code (approximately 23 kB of available resources to hold the code (approximately 23 kB of
non-volatile memory), persistent data (approximately 10 kB of non-volatile memory), persistent data (approximately 10 kB of
non-volatile memory) and volatile data (approximately 2 kB of RAM). non-volatile memory) and volatile data (approximately 2 kB of RAM).
- The [pyscard](https://pypi.org/project/pyscard/) and [pyasn1](https://pypi.org/project/pyasn1/) <!-- - The [pyscard](https://pypi.org/project/pyscard/) and [pyasn1](https://pypi.org/project/pyasn1/)
Python libraries for `smartcard-cli`. Python libraries for `smartcard-cli`. -->
## Importing RSA keys above 2048 bits (3072 or 4096 bits) ## Importing RSA keys above 2048 bits (3072 or 4096 bits)
@ -135,16 +135,12 @@ resource consumption by tweaking the following variables:
## Building the CAP file ## Building the CAP file
- Set path to the JavaCard Development Kit: - (Optional) Edit the `build.xml` file and replace the `APPLET_AID`
`export JC_HOME="your/path/to/javacardkit"` with your a unique value. Alternatively, set the
- (Optional) Edit the `build.xml` file and replace the `0xAF:0xAF`
bytes in the `APPLET_AID` with your own manufacturer identifier (see
section 4.2.1 of OpenPGP card specification). Alternatively, set the
right AID instance bytes during applet installation. right AID instance bytes during applet installation.
Generate the AID using [this tool](https://c0de.dev/c0de/SmartPGP-AID-Generator)
- Execute `ant` with no parameter will produce the CAP file in - Execute `ant` with no parameter to build `SmartPGPApplet.cap`
`SmartPGPApplet.cap`.
## Installing the CAP file ## Installing the CAP file
@ -157,3 +153,7 @@ Be careful to use a valid AID according to the OpenPGP card
specification (see section 4.2.1) for each card (`-create <AID>` with specification (see section 4.2.1) for each card (`-create <AID>` with
GlobalPlatformPro) GlobalPlatformPro)
Example Installation commands:
- `gp --install SmartPGPApplet.cap --default`
- `gp --install SmartPGPApplet.cap --create <AID>`