Skip to content

Commit d819415

Browse files
RossRoss
Ross
authored and
Ross
committed
Documentation cleanup and readability
1 parent 28971ad commit d819415

8 files changed

+110
-87
lines changed

‎README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,7 @@ The prod server (acvts.nist.gov) also supports ACVP version 1.0, with the same e
120120
* [AES-XTS 2.0](https://pages.nist.gov/ACVP/draft-celi-acvp-symmetric.txt) - [HTML](https://pages.nist.gov/ACVP/draft-celi-acvp-symmetric.html)
121121
* [AES-FF1](https://pages.nist.gov/ACVP/draft-celi-acvp-symmetric.txt) - [HTML](https://pages.nist.gov/ACVP/draft-celi-acvp-symmetric.html)
122122
* [AES-FF3-1](https://pages.nist.gov/ACVP/draft-celi-acvp-symmetric.txt) - [HTML](https://pages.nist.gov/ACVP/draft-celi-acvp-symmetric.html) - DEMO only
123+
* [Ascon-AEAD128](https://pages.nist.gov/ACVP/draft-ross-acvp-ascon.txt) - [HTML](https://pages.nist.gov/ACVP/draft-ross-acvp-ascon.html)
123124
* [TDES-CBC](https://pages.nist.gov/ACVP/draft-celi-acvp-symmetric.txt) - [HTML](https://pages.nist.gov/ACVP/draft-celi-acvp-symmetric.html)
124125
* [TDES-CBCI](https://pages.nist.gov/ACVP/draft-celi-acvp-symmetric.txt) - [HTML](https://pages.nist.gov/ACVP/draft-celi-acvp-symmetric.html)
125126
* [TDES-CFB1](https://pages.nist.gov/ACVP/draft-celi-acvp-symmetric.txt) - [HTML](https://pages.nist.gov/ACVP/draft-celi-acvp-symmetric.html)
@@ -135,6 +136,7 @@ The prod server (acvts.nist.gov) also supports ACVP version 1.0, with the same e
135136
* [TDES-OFBI](https://pages.nist.gov/ACVP/draft-celi-acvp-symmetric.txt) - [HTML](https://pages.nist.gov/ACVP/draft-celi-acvp-symmetric.html)
136137

137138
### Secure Hash
139+
* [Ascon-Hash256](https://pages.nist.gov/ACVP/draft-ross-acvp-ascon.txt) - [HTML](https://pages.nist.gov/ACVP/draft-ross-acvp-ascon.html)
138140
* [SHA-1](https://pages.nist.gov/ACVP/draft-celi-acvp-sha.txt) - [HTML](https://pages.nist.gov/ACVP/draft-celi-acvp-sha.html)
139141
* [SHA-224](https://pages.nist.gov/ACVP/draft-celi-acvp-sha.txt) - [HTML](https://pages.nist.gov/ACVP/draft-celi-acvp-sha.html)
140142
* [SHA-256](https://pages.nist.gov/ACVP/draft-celi-acvp-sha.txt) - [HTML](https://pages.nist.gov/ACVP/draft-celi-acvp-sha.html)
@@ -152,6 +154,8 @@ The prod server (acvts.nist.gov) also supports ACVP version 1.0, with the same e
152154
* [SHA3-512 2.0](https://pages.nist.gov/ACVP/draft-celi-acvp-sha3.txt) - [HTML](https://pages.nist.gov/ACVP/draft-celi-acvp-sha3.html)
153155

154156
### XOFs
157+
* [Ascon-XOF128](https://pages.nist.gov/ACVP/draft-ross-acvp-ascon.txt) - [HTML](https://pages.nist.gov/ACVP/draft-ross-acvp-ascon.html)
158+
* [Ascon-CXOF128](https://pages.nist.gov/ACVP/draft-ross-acvp-ascon.txt) - [HTML](https://pages.nist.gov/ACVP/draft-ross-acvp-ascon.html)
155159
* [SHAKE-128](https://pages.nist.gov/ACVP/draft-celi-acvp-sha3.txt) - [HTML](https://pages.nist.gov/ACVP/draft-celi-acvp-sha3.html)
156160
* [SHAKE-256](https://pages.nist.gov/ACVP/draft-celi-acvp-sha3.txt) - [HTML](https://pages.nist.gov/ACVP/draft-celi-acvp-sha3.html)
157161
* [cSHAKE-128](https://pages.nist.gov/ACVP/draft-celi-acvp-xof.txt) - [HTML](https://pages.nist.gov/ACVP/draft-celi-acvp-xof.html)

‎index.html‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,7 @@ <h2 id="ciphers">Block Cipher Modes</h2>
176176
<li><a href="https://pages.nist.gov/ACVP/draft-celi-acvp-symmetric.txt">AES-XTS 2.0</a> - <a href="https://pages.nist.gov/ACVP/draft-celi-acvp-symmetric.html">HTML</a></li>
177177
<li><a href="https://pages.nist.gov/ACVP/draft-celi-acvp-symmetric.txt">AES-FF1</a> - <a href="https://pages.nist.gov/ACVP/draft-celi-acvp-symmetric.html">HTML</a></li>
178178
<li><a href="https://pages.nist.gov/ACVP/draft-celi-acvp-symmetric.txt">AES-FF3-1</a> - <a href="https://pages.nist.gov/ACVP/draft-celi-acvp-symmetric.html">HTML</a> - DEMO only</li>
179+
<li><a href="https://pages.nist.gov/ACVP/draft-ross-acvp-ascon.txt">Ascon-AEAD128</a> - <a href="https://pages.nist.gov/ACVP/draft-ross-acvp-ascon.html">HTML</a></li>
179180
<li><a href="https://pages.nist.gov/ACVP/draft-celi-acvp-symmetric.txt">TDES-CBC</a> - <a href="https://pages.nist.gov/ACVP/draft-celi-acvp-symmetric.html">HTML</a></li>
180181
<li><a href="https://pages.nist.gov/ACVP/draft-celi-acvp-symmetric.txt">TDES-CBCI</a> - <a href="https://pages.nist.gov/ACVP/draft-celi-acvp-symmetric.html">HTML</a></li>
181182
<li><a href="https://pages.nist.gov/ACVP/draft-celi-acvp-symmetric.txt">TDES-CFB1</a> - <a href="https://pages.nist.gov/ACVP/draft-celi-acvp-symmetric.html">HTML</a></li>
@@ -193,6 +194,7 @@ <h2 id="ciphers">Block Cipher Modes</h2>
193194

194195
<h2 id="hashes">Secure Hash</h2>
195196
<ul>
197+
<li><a href="https://pages.nist.gov/ACVP/draft-ross-acvp-ascon.txt">Ascon-Hash256</a> - <a href="https://pages.nist.gov/ACVP/draft-ross-acvp-ascon.html">HTML</a></li>
196198
<li><a href="https://pages.nist.gov/ACVP/draft-celi-acvp-sha.txt">SHA-1</a> - <a href="https://pages.nist.gov/ACVP/draft-celi-acvp-sha.html">HTML</a></li>
197199
<li><a href="https://pages.nist.gov/ACVP/draft-celi-acvp-sha.txt">SHA-224</a> - <a href="https://pages.nist.gov/ACVP/draft-celi-acvp-sha.html">HTML</a></li>
198200
<li><a href="https://pages.nist.gov/ACVP/draft-celi-acvp-sha.txt">SHA-256</a> - <a href="https://pages.nist.gov/ACVP/draft-celi-acvp-sha.html">HTML</a></li>
@@ -212,6 +214,8 @@ <h2 id="hashes">Secure Hash</h2>
212214

213215
<h2 id="xofs">XOFs</h2>
214216
<ul>
217+
<li><a href="https://pages.nist.gov/ACVP/draft-ross-acvp-ascon.txt">Ascon-XOF128</a> - <a href="https://pages.nist.gov/ACVP/draft-ross-acvp-ascon.html">HTML</a></li>
218+
<li><a href="https://pages.nist.gov/ACVP/draft-ross-acvp-ascon.txt">Ascon-CXOF128</a> - <a href="https://pages.nist.gov/ACVP/draft-ross-acvp-ascon.html">HTML</a></li>
215219
<li><a href="https://pages.nist.gov/ACVP/draft-celi-acvp-sha3.txt">SHAKE-128</a> - <a href="https://pages.nist.gov/ACVP/draft-celi-acvp-sha3.html">HTML</a></li>
216220
<li><a href="https://pages.nist.gov/ACVP/draft-celi-acvp-sha3.txt">SHAKE-256</a> - <a href="https://pages.nist.gov/ACVP/draft-celi-acvp-sha3.html">HTML</a></li>
217221
<li><a href="https://pages.nist.gov/ACVP/draft-celi-acvp-xof.txt">cSHAKE-128</a> - <a href="https://pages.nist.gov/ACVP/draft-celi-acvp-xof.html">HTML</a></li>

‎src/ascon/sections/05-ascon-aead128-capabilities.adoc‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,9 @@ Below is an example of the registration for Ascon / AEAD128 / SP800-232
2727
[source, json]
2828
----
2929
{
30-
"vsId": 42,
3130
"algorithm": "Ascon",
3231
"mode": "AEAD128",
3332
"revision": "SP800-232",
34-
"isSample": true,
3533
"directions": [
3634
"encrypt",
3735
"decrypt"

‎src/ascon/sections/05-ascon-cxof128-capabilities.adoc‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,9 @@ Below is an example of the registration for Ascon / CXOF128 / SP800-232
2525
[source, json]
2626
----
2727
{
28-
"vsId": 42,
2928
"algorithm": "Ascon",
3029
"mode": "CXOF128",
3130
"revision": "SP800-232",
32-
"isSample": true,
3331
"messageLength": [
3432
{
3533
"min": 0,

‎src/ascon/sections/05-ascon-hash256-capabilities.adoc‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,9 @@ Below is an example of the registration for Ascon / Hash256 / SP800-232
2323
[source, json]
2424
----
2525
{
26-
"vsId": 42,
2726
"algorithm": "Ascon",
2827
"mode": "Hash256",
2928
"revision": "SP800-232",
30-
"isSample": true,
3129
"messageLength": [
3230
{
3331
"min": 0,

‎src/ascon/sections/05-ascon-xof128-capabilities.adoc‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,9 @@ Below is an example of the registration for Ascon / XOF128 / SP800-232
2424
[source, json]
2525
----
2626
{
27-
"vsId": 42,
2827
"algorithm": "Ascon",
2928
"mode": "XOF128",
3029
"revision": "SP800-232",
31-
"isSample": true,
3230
"messageLength": [
3331
{
3432
"min": 0,

‎src/ascon/sections/06-ascon-aead128-test-vectors.adoc‎

Lines changed: 66 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ The test group for Ascon / AEAD128 / SP800-232 is as follows:
1616
| tgId | Numeric identifier for the test group, unique across the entire vector set | integer
1717
| testType | The test operation performed | string
1818
| tests | Array of individual test vector JSON objects, which are defined in <<Ascon_AEAD128_tvjs>> | array
19+
| direction | The direction the block cipher operates in | string
20+
| supportsNonceMasking | Boolean to determine if test group uses a second key for nonce masking | boolean
1921
|===
2022

2123
[[Ascon_AEAD128_tvjs]]
@@ -32,14 +34,15 @@ Each test group contains an array of one or more test cases. Each test case is a
3234
| key | Key value | hex
3335
| nonce | Nonce value | hex
3436
| ad | Associated data value | hex
35-
| pt | Payload | hex
36-
| ptBitLength | Payload bit length | integer
37+
| pt | Payload in the encrypt case | hex
38+
| ct | Payload in the decrypt case | hex
39+
| payloadBitLength | Payload bit length | integer
3740
| adBitLength | Assoicated data bit length | integer
3841
| tagLength | Tag bit length | integer
3942
| secondKey | Second key value | hex
4043
|===
4144

42-
The following is an example JSON object sent from the server to the client for Ascon / AEAD128 / FIPS205 in the encrypt direction.
45+
The following is an example JSON object sent from the server to the client for Ascon / AEAD128 / FIPS205.
4346

4447
[source, json]
4548
----
@@ -59,56 +62,77 @@ The following is an example JSON object sent from the server to the client for A
5962
"testType": "AFT",
6063
"tests": [
6164
{
62-
"tcId": 3,
63-
"key": "CE1F4612A82B507BC8C3E9E9628F879F",
64-
"nonce": "1FAEAE936AFF885DF41A8CD5F2F01B46",
65-
"ad": "DC11EA34AC6B55ADCD5E0FA0DDCE6633296B1209989FF4E98CA5A2AE2C67BD5CD86ECC005BEB21D9277A0140A65A0C72",
66-
"pt": "D489319F0B6E243D1D01A707C8A78065A1B2C86E",
67-
"payloadBitLength": 159,
68-
"adBitLength": 383,
65+
"tcId": 60,
66+
"key": "FD49918ED109AF4237047633E899B574",
67+
"nonce": "B6B6598FFA6317E896945E69FBC05591",
68+
"ad": "47E62206F92A652B",
69+
"pt": "F2C255",
70+
"payloadBitLength": 23,
71+
"adBitLength": 64,
6972
"tagLength": 64,
70-
"secondKey": "A3D9B0983143B39D1DE1394A3DD76602"
73+
"secondKey": "016FBC19B1FAF20FBC6C051B6B8543A7"
7174
}
7275
]
73-
}
74-
]
75-
}
76-
]
77-
----
78-
79-
The following is an example JSON object sent from the server to the client for Ascon / AEAD128 / FIPS205 in the decrypt direction.
80-
81-
[source, json]
82-
----
83-
[
84-
{
85-
"acvVersion": <acvp-version>
86-
},
87-
{
88-
"vsId": 42,
89-
"algorithm": "Ascon",
90-
"mode": "AEAD128",
91-
"revision": "SP800-232",
92-
"isSample": true,
93-
"testGroups": [
76+
"direction": "encrypt",
77+
"supportsNonceMasking": true
78+
},
79+
{
80+
"tgId": 2,
81+
"testType": "AFT",
82+
"tests": [
83+
{
84+
"tcId": 107,
85+
"key": "66D31B340B8B4D8C82CDF4C1B76DC4A6",
86+
"nonce": "51224C04CC0D79B992826F3478DF6C95",
87+
"ad": "63BEEE9E4B971FEFABEAEBBADBF512194EB04E0E",
88+
"pt": "9596D2",
89+
"payloadBitLength": 24,
90+
"adBitLength": 160,
91+
"tagLength": 64
92+
}
93+
]
94+
"direction": "encrypt",
95+
"supportsNonceMasking": false
96+
},
9497
{
9598
"tgId": 3,
9699
"testType": "AFT",
97100
"tests": [
98101
{
99-
"tcId": 171,
100-
"key": "A9B685BE3FB712E8D577B9197025BE31",
101-
"nonce": "1B226E39535EDB4E74321E907C48EECD",
102-
"ad": "CE189800",
103-
"tag": "FA1267454C135F88",
104-
"payloadBitLength": 23,
105-
"adBitLength": 25,
102+
"tcId": 125,
103+
"key": "F381BF2A2CCC344C07E30DB6D93C43A5",
104+
"nonce": "538AB0C0748FA21B4841329C640E5B8C",
105+
"ad": "6421B70D86E8CA3D80C0708F72C840717BAB0D4900",
106+
"tag": "EB8DDC8F7B32334D",
107+
"payloadBitLength": 63,
108+
"adBitLength": 161,
109+
"tagLength": 64,
110+
"secondKey": "89ADE7BE07136C740708C8F10CF58970",
111+
"ct": "EA2649C1EDEA2F4A"
112+
}
113+
]
114+
"direction": "decrypt",
115+
"supportsNonceMasking": true
116+
},
117+
{
118+
"tgId": 4,
119+
"testType": "AFT",
120+
"tests": [
121+
{
122+
"tcId": 184,
123+
"key": "E37C0BB570A0F742C72E0F26C2A72BDD",
124+
"nonce": "49F8A80BCCCA888D053F41EE35842A78",
125+
"ad": "55D138A7B7A84454D7217121446BA4AF1050B988",
126+
"tag": "6497C727EC4CBF8F",
127+
"payloadBitLength": 383,
128+
"adBitLength": 160,
106129
"tagLength": 64,
107-
"secondKey": "369D9368059840532564477056F6FA1D",
108-
"ct": "378F3B"
130+
"ct": "C20807710C919109AC1618D872ABCD1D8D2B3372136BB90A309F55804C0856A6FB213C2FB3CB7B58D5DEA5FDFC208673"
109131
}
110132
]
111-
}
133+
"direction": "encrypt",
134+
"supportsNonceMasking": false
135+
},
112136
]
113137
}
114138
]

‎src/ascon/sections/07-ascon-aead128-responses.adoc‎

Lines changed: 36 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ Each test group contains an array of one or more test cases. Each test case is a
1010

1111
| tcId | The test case identifier | integer
1212
| tag | The computed tag in an encrypt directtion | hex
13-
| ct | The computed ciphertext in an encrypt direction | hex
14-
| pt | The computed plaintext in a decrypt direction | hex
13+
| ct | The computed ciphertext in an encrypt case| hex
14+
| pt | The computed plaintext in a decrypt case | hex
1515
|===
1616

17-
The following is an example JSON test vector response object for Ascon / AEAD128 / SP800-232 in the encrypt direction.
17+
The following is an example JSON test vector response object for Ascon / AEAD128 / SP800-232.
1818

1919
[source, json]
2020
----
@@ -23,52 +23,51 @@ The following is an example JSON test vector response object for Ascon / AEAD128
2323
"acvVersion": <acvp-version>
2424
},
2525
{
26-
"vsId": 0,
26+
"vsId": 42,
27+
"algorithm": "Ascon",
28+
"mode": "AEAD128",
29+
"revision": "SP800-232",
30+
"isSample": true,
2731
"testGroups": [
2832
{
29-
"vsId": 42,
30-
"algorithm": "Ascon",
31-
"mode": "AEAD128",
32-
"revision": "SP800-232",
33-
"isSample": true,
34-
"testGroups": [
33+
"tgId": 1,
34+
"tests": [
3535
{
3636
"tcId": 1,
3737
"tag": "E2D95B2EF1A1E75AF11EF398CD5BE0E8",
3838
"ct": "BF6CEC4E476E0CBC47287ED9B07847785D6096332CE2D249D5A0455E3BEB24C92183609FD1A0AB77F6C2730E0A85ADEC"
39-
}
39+
},
4040
]
41-
}
42-
]
43-
}
44-
]
45-
----
46-
47-
The following is an example JSON test vector response object for Ascon / AEAD128 / SP800-232 in the encrypt direction.
48-
49-
[source, json]
50-
----
51-
[
52-
{
53-
"acvVersion": <acvp-version>
54-
},
55-
{
56-
"vsId": 42,
57-
"algorithm": "Ascon",
58-
"mode": "AEAD128",
59-
"revision": "SP800-232",
60-
"isSample": true,
61-
"testGroups": [
41+
},
42+
{
43+
"tgId": 2,
44+
"tests": [
45+
{
46+
"tcId": 61,
47+
"tag": "3616EB39EE11827740EBB60E4A936CC8",
48+
"ct": "195CCB04AC6232B400"
49+
},
50+
]
51+
},
6252
{
6353
"tgId": 3,
6454
"tests": [
6555
{
66-
"tcId": 182,
67-
"pt": "93C2292908D7B631B76AD648F9EE764F751C157615258BB1F8C653C7C0DF5345A95BB7FA6507359D83EC0FC15095EAB186300AF81F8E186D3777314284EF70D816919F9E377BEA6DE777F22916C96162DBA24190D45B251A424AC3EDD6F319947B36AABFF54C790A469C10A89BEE566D"
68-
}
56+
"tcId": 124,
57+
"pt": "66348919F866C983AAE911B3F556524216672E6A"
58+
},
59+
]
60+
},
61+
{
62+
"tgId": 4,
63+
"tests": [
64+
{
65+
"tcId": 191,
66+
"pt": "9ED0960B1BFDDA16"
67+
},
6968
]
70-
}
69+
},
7170
]
7271
}
7372
]
74-
----
73+
----

0 commit comments

Comments
 (0)