From 2abc59f61ea68af03256127e27b310b7f2026c0a Mon Sep 17 00:00:00 2001 From: J08nY Date: Mon, 17 Dec 2018 14:17:44 +0100 Subject: Update README. --- README.md | 154 ++++++++++++++++++++++++++++++++++++-------------------------- 1 file changed, 90 insertions(+), 64 deletions(-) diff --git a/README.md b/README.md index d23922d..4a04671 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ See `java -jar ECTesterReader.jar -h`, `java -jar ECTesterReader.jar -ls` and [D -V,--version Print version info. -h,--help Print help. -ln,--list-named Print the list of supported named - curves and keys, (CurveDB and KeyDB). + curves and keys. -ls,--list-suites List supported test suites. -e,--export Export the defaut curve parameters of the card(if any). @@ -53,46 +53,40 @@ See `java -jar ECTesterReader.jar -h`, `java -jar ECTesterReader.jar -ls` and [D -t,--test Test ECC support. Optionally specify a test number to run only a part of a test suite. : - - default - - compression - - invalid - - twist - - degenerate - - cofactor - - wrong - - signature - - composite - - test-vectors - - edge-cases - - miscellaneous + - default: + - compression: + - invalid: + - twist: + - degenerate: + - cofactor: + - wrong: + - signature: + - composite: + - test-vectors: + - edge-cases: + - miscellaneous: -dh,--ecdh Do EC KeyAgreement (ECDH...), [count] times. -dsa,--ecdsa Sign data with ECDSA, [count] times. -nf,--info Get applet info. - -b,--bit-size Set curve size. -fp,--prime-field Use a prime field. -f2m,--binary-field Use a binary field. - -nc,--named-curve Use a named curve, from CurveDB: -c,--curve Use curve from file (field,a,b,gx,gy,r,k). -u,--custom Use a custom curve (applet-side embedded, SECG curves). - -npub,--named-public Use public key from KeyDB: -pub,--public Use public key from file (wx,wy). - -npriv,--named-private Use private key from KeyDB: -priv,--private Use private key from file (s). - - -nk,--named-key Use KeyPair from KeyDB: - -k,--key Use KeyPair from file  + -nk,--named-key Use keyPair from KeyDB: + -k,--key Use keyPair from file  (wx,wy,s). - -i,--input Input from file , for ECDSA signing. -o,--output Output into file . The @@ -103,9 +97,18 @@ See `java -jar ECTesterReader.jar -h`, `java -jar ECTesterReader.jar -ls` and [D -v,--verbose Turn on verbose logging. --format Output format to use. One of: text,yml,xml. - + --fixed Generate key(s) only once, keep them + for later operations. + --fixed-private Generate private key only once, keep + it for later ECDH. + --fixed-public Generate public key only once, keep + it for later ECDH. -f,--fresh Generate fresh keys (set domain parameters before every generation). + --time Output better timing values, by + running command in dry run mode and + normal mode, and subtracting the + two. --cleanup Send the cleanup command trigerring JCSystem.requestObjectDeletion() after some operations. @@ -113,10 +116,10 @@ See `java -jar ECTesterReader.jar -h`, `java -jar ECTesterReader.jar -ls` and [D instead of using a terminal. -y,--yes Accept all warnings and prompts. -ka,--ka-type Set KeyAgreement object [type], - corresponds to JavaCard KeyAgreement + corresponds to JC.KeyAgreement constants. -sig,--sig-type Set Signature object [type], - corresponds to JavaCard Signature + corresponds to JC.Signature constants. -C,--color Print stuff with color, requires ANSI terminal. @@ -298,58 +301,81 @@ To install, place them in `${java.home}/jre/lib/security/`. ### Options ``` -usage: ECTesterStandalone.jar [-V] [-h] [-C] - [ (ecdh [-b ] [-nc ] [-cn ] [-t ] [--key-type ] [-n ]) | - (ecdsa [-b ] [-nc ] [-cn ] [-t ] [-n ] [-f ]) | - (export [-b ] [-t ]) | - (generate [-b ] [-nc ] [-cn ] [-n ] [-t ]) | - (list-data [what]) | - (list-libs) | - (list-suites) | - (test [-b ] [-nc ] [-cn ] [-gt ] [-kt ] [-st ] [-f ] [--key-type ] - ) ] - [lib] - - ecdh: | Perform EC based KeyAgreement. | - -b,--bits What size of curve to use. - -nc,--named-curve Use a named curve, from CurveDB: - -cn,--curve-name Use a named curve, search from curves - supported by the library: - -t,--type Set KeyAgreement object [type]. - --key-type Set the key [algorithm] for which the key - should be derived in KeyAgreements with - KDF. Default is "AES". - -n,--amount Do ECDH [amount] times. - - ecdsa: | Perform EC based Signature. | - -b,--bits What size of curve to use. - -nc,--named-curve Use a named curve, from CurveDB: - -cn,--curve-name Use a named curve, search from curves - supported by the library: - -t,--type Set Signature object [type]. - -n,--amount Do ECDSA [amount] times. - -f,--file Input [file] to sign. - - export: | Export default curve parameters. | +usage: ECTesterStandalone.jar [-V] [-h ] [-C] [ +(ecdh [-b ] [-nc ] [-cn ] [-o ] [-t ] [--key-type ] [-n ] + [-npriv ] [--fixed-private] [-npub ] [--fixed-public]) | +(ecdsa [-b ] [-nc ] [-cn ] [-o ] [-npriv ] [-npub ] [-t ] + [-n ] [-f ]) | +(export [-b ] [-o ] [-t ]) | +(generate [-b ] [-nc ] [-cn ] [-o ] [-n ] [-t ]) | +(list-data [what]) | +(list-libs) | +(list-suites) | +(test [-b ] [-nc ] [-cn ] [-gt ] [-kt ] [-st ] [-f ] [--key-type ] ) ] +[lib] + + -V,--version Print version info. + -h,--help Print help(about ). + -C,--color Print stuff with color, requires ANSI terminal. + [lib] What library to use. + + ecdh: | Perform EC based KeyAgreement. | + -b,--bits What size of curve to use. + -nc,--named-curve Use a named curve, from CurveDB: + + -cn,--curve-name Use a named curve, search from curves + supported by the library: + -o,--output Output into file . + -t,--type Set KeyAgreement object [type]. + --key-type Set the key [algorithm] for which the + key should be derived in + KeyAgreements with KDF. Default is + "AES". + -n,--amount Do ECDH [amount] times. + -npriv,--named-private Use a named private key, from + CurveDB: + --fixed-private Perform ECDH with fixed private key. + -npub,--named-public Use a named public key, from CurveDB: + + --fixed-public Perform ECDH with fixed public key. + + ecdsa: | Perform EC based Signature. | + -b,--bits What size of curve to use. + -nc,--named-curve Use a named curve, from CurveDB: + + -cn,--curve-name Use a named curve, search from curves + supported by the library: + -o,--output Output into file . + -npriv,--named-private Use a named private key, from + CurveDB: + -npub,--named-public Use a named public key, from CurveDB: + + -t,--type Set Signature object [type]. + -n,--amount Do ECDSA [amount] times. + -f,--file Input [file] to sign. + + export: | Export default curve parameters. | -b,--bits What size of curve to use. + -o,--output Output into file . -t,--type Set KeyPair object [type]. - generate: | Generate EC keypairs. | + generate: | Generate EC keypairs. | -b,--bits What size of curve to use. -nc,--named-curve Use a named curve, from CurveDB: -cn,--curve-name Use a named curve, search from curves supported by the library: + -o,--output Output into file . -n,--amount Generate [amount] of EC keys. -t,--type Set KeyPairGenerator object [type]. - list-data: | List/show contained EC domain parameters/keys. | - [what] what to list. + list-data: | List/show contained EC domain parameters/keys. | + [what] what to list. - list-libs: | List supported libraries. | + list-libs: | List supported libraries. | - list-suites: | List supported test suites. | + list-suites: | List supported test suites. | - test: | Test a library. | + test: | Test a library. | -b,--bits What size of curve to use. -nc,--named-curve Use a named curve, from CurveDB: -cn,--curve-name Use a named curve, search from curves @@ -362,6 +388,6 @@ usage: ECTesterStandalone.jar [-V] [-h] [-C] --key-type Set the key [algorithm] for which the key should be derived in KeyAgreements with KDF. Default is "AES". - The test suite to run. + The test suite to run. ``` -- cgit v1.2.3-70-g09d2