Merge pull request #35 from siketyan/release/v0.2.0

chore: Release v0.2.0

Author: siketyan

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "jpki"
 description = "Read certificates, sign and verify documents using your JPKI card."
-version = "0.1.8"
+version = "0.2.0"
 license = "LGPL-2.1-or-later"
 homepage = "https://github.com/siketyan/jpki-rs"
 repository = "https://github.com/siketyan/jpki-rs.git"

README.md

@@ -26,3 +26,11 @@ jpki = "0.1"
 
 ## 💚 Example
 See [jpki-cli](./cli) for an example usage of this crate.
+
+## 🔗 References
+- "Technical Specifications and Utilization Methods of My Number Cards" by Fujitsu Co., Ltd.  
+  https://www.fujitsu.com/jp/documents/about/resources/publications/magazine/backnumber/vol68-4/paper10.pdf"
+- "認証局の運営" by Japan Agency for Local Authority Information Systems  
+  https://www.jpki.go.jp/ca/index.html
+- jpki/myna  
+  https://github.com/jpki/myna

android/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "jpki-android"
 description = "Read certificates, sign and verify documents using your JPKI card."
-version = "0.1.8"
+version = "0.2.0"
 license = "LGPL-2.1-or-later"
 homepage = "https://github.com/siketyan/jpki-rs"
 repository = "https://github.com/siketyan/jpki-rs.git"
@@ -19,5 +19,5 @@ crate-type = ["cdylib"]
 android_log = "0.1.3"
 log = "0.4.14"
 jni = "0.19.0"
-jpki = { version = "0.1", path = "..", features = ["digest"] }
+jpki = { version = "0.2", path = "..", features = ["digest"] }
 thiserror = "1.0"

cli/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "jpki-cli"
 description = "Read certificates, sign and verify documents using your JPKI card."
-version = "0.1.8"
+version = "0.2.0"
 license = "LGPL-2.1-or-later"
 homepage = "https://github.com/siketyan/jpki-rs"
 repository = "https://github.com/siketyan/jpki-rs.git"
@@ -15,7 +15,7 @@ edition = "2021"
 clap = { version = "3.1", features = ["derive"] }
 dialoguer = "0.10"
 hex = "0.4"
-jpki = { version = "0.1", path = "..", features = ["digest"] }
+jpki = { version = "0.2", path = "..", features = ["digest"] }
 pcsc = "2.7"
 thiserror = "1.0"
 tracing = "0.1"

cli/README.md

@@ -22,26 +22,42 @@ Alternatively, build from source using Cargo:
 cargo install jpki-cli
 ```
 
-## 💚 Example
+## 💚 Examples
+### Crypto AP
+Dumps the certificate for digital signature:
+```shell
+jpki-cli read-certificate > certificate.der
+```
+
+If you want the certificate for user authentication, append `--auth`:
+```shell
+jpki-cli read-certificate --auth > certificate.der
+```
+
+Signs the data from stdin using key-pair for digital signature:
+```shell
+cat plain.txt | jpki-cli sign > signature.sig
 ```
-jpki-cli 0.1.8
-Naoki Ikeguchi <me@s6n.jp>
-Read certificates, sign and verify documents using your JPKI card.
 
-USAGE:
-    jpki-cli [OPTIONS] <SUBCOMMAND>
+Verifies the signature using the dumped certificate:
+```shell
+cat plain.txt | jpki-cli verify certificate.der signature.sig
+```
 
-OPTIONS:
-    -a, --auth       Uses the key-pair for user authentication, instead of for digital signature
-    -c, --ca         While reading certificates, reads their CA certificate instead
-    -h, --help       Print help information
-    -V, --version    Print version information
+### Surface AP
+Dumps the photo using PIN B (DoB `YYMMDD` + Expiry `YYYY` + CVC `XXXX`):
+```shell
+jpki-cli surface photo > photo.jpg
+# PIN: YYMMDDYYYYXXXX
+```
 
-SUBCOMMANDS:
-    help                Print this message or the help of the given subcommand(s)
-    read-certificate    Reads a certificate in the JPKI card
-    sign                Writes a signature of the document
-    surface             Reads the surface information from the card. PIN type B (DoB + Expiry +
-                            PIN) is required by default
-    verify              Verifies the signed digest
+Using PIN A (My Number) instead:
+```shell
+jpki-cli surface --all photo > photo.jpg
+# PIN: XXXXYYYYZZZZ
 ```
+
+For list of available data to dump, see the help:
+```shell
+jpki-cli surface --help
+```