summaryrefslogtreecommitdiff
path: root/docs/FORMAT.md
diff options
context:
space:
mode:
authorJ08nY2018-01-23 17:31:15 +0100
committerJ08nY2018-01-23 17:31:15 +0100
commitcb6c6b8b1274fe5a340c4317a4b015ea0ef15396 (patch)
tree864a54dcdf07da33cd139312c8b0ee693e1a0eff /docs/FORMAT.md
parent6c46a27a52854aee24f7a37e74002bd6f4485723 (diff)
parentc581e39e539e6dadb49d9f83f563ab2b375f6e0b (diff)
downloadECTester-af9bf190fa55a2498b9dd2b6d136daf0306e3edd.tar.gz
ECTester-af9bf190fa55a2498b9dd2b6d136daf0306e3edd.tar.zst
ECTester-af9bf190fa55a2498b9dd2b6d136daf0306e3edd.zip
Diffstat (limited to 'docs/FORMAT.md')
-rw-r--r--docs/FORMAT.md30
1 files changed, 27 insertions, 3 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.