aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJ08nY2018-01-14 15:43:01 +0100
committerJ08nY2018-01-14 15:43:01 +0100
commit8dabbb965f40ff384e3545c9844435b701ed3fda (patch)
treec332a3d197b0a3a6cc1bc7c3d17aa3f76e260707 /docs
parentaeb322e1da26dcfc83762d9bc8df83667a22282a (diff)
downloadECTester-8dabbb965f40ff384e3545c9844435b701ed3fda.tar.gz
ECTester-8dabbb965f40ff384e3545c9844435b701ed3fda.tar.zst
ECTester-8dabbb965f40ff384e3545c9844435b701ed3fda.zip
Diffstat (limited to 'docs')
-rw-r--r--docs/FORMAT.md30
-rw-r--r--docs/TESTS.md20
2 files changed, 33 insertions, 17 deletions
diff --git a/docs/FORMAT.md b/docs/FORMAT.md
index b68db39..849a62c 100644
--- a/docs/FORMAT.md
+++ b/docs/FORMAT.md
@@ -1,7 +1,10 @@
# Format
-CSV based, little-endian hexadecimal values.
+ECTester mostly reads/outputs data in either human-readable format or using CSV.
## Curves
+Input files for the `-c/--curve` option should be in CSV, little-endian hexadecimal format.
+Output of the `-e/--export` option will also be in this format.
+
### Prime field
`p,a,b,gx,gy,n,h`
@@ -9,6 +12,8 @@ CSV based, little-endian hexadecimal values.
`m,e1,e2,e3,a,b,gx,gy,n,h`
## Key material
+Input files for the `-k/--key`, `-pub/--public` and `-priv/--private` options should be in CSV, little-endian hexadecimal format.
+
### Keypair
`wx,wy,s`
@@ -18,7 +23,7 @@ CSV based, little-endian hexadecimal values.
### Private key
`s`
-# Notation
+### Notation
- `p` - prime F_p
- `m` - binary field exponent F_2^m
- `e1` - largest exponent of the field polynomial
@@ -32,4 +37,23 @@ CSV based, little-endian hexadecimal values.
- `h` - the base-point cofactor
- `wx` - the x coordinate of the public key
- `wy` - the y coordinate of th public key
- - `s` - the private key value \ No newline at end of file
+ - `s` - the private key value
+
+## Key generation output(CSV)
+Output of the `-g/--generate` option.
+
+`index;time;pubW;privS`
+
+## KeyAgreement output(CSV)
+Output of the `-dh/--ecdh` option.
+
+`index;time;pubW;privS;secret`
+
+## Signature output(CSV)
+Output of the `-dsa/--ecdsa` option.
+
+`index;time;signature`
+
+## Test runs
+By default test runs are output in a human readable format, however YAML and XML is also supported and can be selected
+by using the `-o/--output` option.
diff --git a/docs/TESTS.md b/docs/TESTS.md
index 21298dc..c4f38dc 100644
--- a/docs/TESTS.md
+++ b/docs/TESTS.md
@@ -11,29 +11,21 @@ confirmation before running, be cautious.**
## Default
Tests the default curves present on the card. These might not be present or the card might not even support ECC.
-Tests keypair allocation, generation, ECDH and ECDSA. ECDH is first tested with two valid generated keypairs, then a with a
-public key that is corrupted in various ways, these tests should fail.
+Tests keypair allocation, generation, ECDH and ECDSA. ECDH is first tested with two valid generated keypairs, then
+with a compressed public key to test support for compressed points.
This test suite is run if no argument is provided to `-t / --test`.
-Supports the `-nc / --named-curve` option so you can specify a category of curves or a curve to use if the card doesn't
-have default curves preset.
-
For example:
```bash
-java -jar ECTester.jar -nc secg -a -fp -t
-```
-tests all(`-a`), prime field(`-fp`) SECG curves, using the default test suite.
-
-```bash
-java -jar ECTester.jar -u -a -f2m -t
+java -jar ECTester.jar -a -fp -t
```
-tests all(`-a`), binary field(`-f2m`), custom(`-u`) curves.
+tests all(`-a`), prime field(`-fp`), using the default test suite.
```bash
-java -jar ECTester.jar -b 128 -fp -t
+java -jar ECTester.jar-a -f2m -t
```
-tests a 128 bit(`-b`), prime field(`-fp`) curve, (if a default one is present).
+tests all(`-a`), binary field(`-f2m`), curves.
## Test-Vectors
Tests using known test vectors provided by NIST/SECG/Brainpool: