forked from usnistgov/ACVP
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathacvp_sub_kdf135_snmp.txt
616 lines (388 loc) · 22.9 KB
/
acvp_sub_kdf135_snmp.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
TBD B. Fussell, Ed.
Internet-Draft Cisco Systems, Inc.
Intended status: Informational August 1, 2018
Expires: February 2, 2019
ACVP SNMP Key Derivation Function Algorithm JSON Specification
draft-ietf-acvp-subkdf135-snmp-1.0
Abstract
This document defines the JSON schema for using SP800-135 SNMP KDF
algorithms with the ACVP specification.
Status of This Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on February 2, 2019.
Copyright Notice
Copyright (c) 2018 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
Fussell Expires February 2, 2019 [Page 1]
Internet-Draft Sym Alg JSON August 2018
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1. Requirements Language . . . . . . . . . . . . . . . . . . 2
2. Capabilities Registration . . . . . . . . . . . . . . . . . . 2
2.1. Required Prerequisite Algorithms for KDF135 SNMP
Validations . . . . . . . . . . . . . . . . . . . . . . . 3
2.2. KDF135 SNMP Algorithm Capabilities JSON Values . . . . . 4
3. Test Vectors . . . . . . . . . . . . . . . . . . . . . . . . 5
3.1. Test Groups JSON Schema . . . . . . . . . . . . . . . . . 5
3.2. Test Case JSON Schema . . . . . . . . . . . . . . . . . . 6
4. Test Vector Responses . . . . . . . . . . . . . . . . . . . . 6
5. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 8
6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 8
7. Security Considerations . . . . . . . . . . . . . . . . . . . 8
8. Normative References . . . . . . . . . . . . . . . . . . . . 8
Appendix A. Example SP800-135 SNMP KDF Capabilities JSON Object 8
Appendix B. Example Test Vectors JSON Object . . . . . . . . . . 9
Appendix C. Example Test Results JSON Object . . . . . . . . . . 10
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 10
1. Introduction
The Automated Crypto Validation Protocol (ACVP) defines a mechanism
to automatically verify the cryptographic implementation of a
software or hardware crypto module. The ACVP specification defines
how a crypto module communicates with an ACVP server, including
crypto capabilities negotiation, session management, authentication,
vector processing and more. The ACVP specification does not define
algorithm specific JSON constructs for performing the crypto
validation. A series of ACVP sub-specifications define the
constructs for testing individual crypto algorithms. Each sub-
specification addresses a specific class of crypto algorithms. This
sub-specification defines the JSON constructs for testing SP800-135
SNMP KDF algorithms using ACVP.
1.1. Requirements Language
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted in RFC 2119 [RFC2119].
2. Capabilities Registration
ACVP requires crypto modules to register their capabilities. This
allows the crypto module to advertise support for specific
algorithms, notifying the ACVP server which algorithms need test
vectors generated for the validation process. This section describes
Fussell Expires February 2, 2019 [Page 2]
Internet-Draft Sym Alg JSON August 2018
the constructs for advertising support of SP800-135 SNMP KDF
algorithms to the ACVP server.
The algorithm capabilities are advertised as JSON objects within the
'algorithms' value of the ACVP registration message. The
'algorithms' value is an array, where each array element is an
individual JSON object defined in this section. The 'algorithms'
value is part of the 'capability_exchange' element of the ACVP JSON
registration message. See the ACVP specification for details on the
registration message. Each KDF algorithm capability advertised is a
self-contained JSON object.
2.1. Required Prerequisite Algorithms for KDF135 SNMP Validations
Some KDF135 algorithm implementations rely on other cryptographic
primitives. For example, SNMP uses an underlying SHA algorithm.
Each of these underlying algorithm primitives must be validated,
either separately or as part of the same submission. ACVP provides a
mechanism for specifying the required prerequisites:
+--------------+--------------+---------------+----------+----------+
| JSON Value | Description | JSON type | Valid | Optional |
| | | | Values | |
+--------------+--------------+---------------+----------+----------+
| algorithm | a | value | SHA | No |
| | prerequisite | | | |
| | algorithm | | | |
| | | | | |
| valValue | algorithm | value | actual | No |
| | validation | | number | |
| | number | | or | |
| | | | "same" | |
| | | | | |
| prereqAlgVal | prerequistie | object with | see | No |
| | algorithm | algorithm and | above | |
| | validation | valValue | | |
| | | properties | | |
| | | | | |
| prereqVals | prerequistie | array of | see | No |
| | algorithm | prereqAlgVal | above | |
| | validations | objects | | |
+--------------+--------------+---------------+----------+----------+
Table 1: Required Prerequisite Algorithms JSON Values
Fussell Expires February 2, 2019 [Page 3]
Internet-Draft Sym Alg JSON August 2018
2.2. KDF135 SNMP Algorithm Capabilities JSON Values
Each algorithm capability advertised is a self-contained JSON object
using the following values.
+-------------+------------+-------------+----------------+---------+
| JSON Value | Descriptio | JSON type | Valid Values | Optiona |
| | n | | | l |
+-------------+------------+-------------+----------------+---------+
| algorithm | The KDF to | value | "kdf- | No |
| | be | | components" | |
| | validated | | | |
| | | | | |
| mode | The KDF- | value | "snmp" | No |
| | Component | | | |
| | to be | | | |
| | validated | | | |
| | | | | |
| revision | The | value | "1.0" | No |
| | algorithm | | | |
| | testing | | | |
| | revision | | | |
| | to use. | | | |
| | | | | |
| prereqVals | Prerequisi | array of pr | See | No |
| | te | ereqAlgVal | Section 2.1 | |
| | algorithm | objects | | |
| | validation | | | |
| | s | | | |
| | | | | |
| engineId | Two | array | hex between 9 | No |
| | distinct | | and 32 bytes | |
| | engine IDs | | | |
| | in hexadec | | | |
| | imal | | | |
| | | | | |
| passwordLen | Password | domain | Lengths must | No |
| gth | lengths in | | be between 64 | |
| | bits, | | and 8192 bits. | |
| | supported | | | |
| | by the IUT | | | |
+-------------+------------+-------------+----------------+---------+
Table 2: SP800-135 SNMP KDF Algorithm Capabilities JSON Values
Note: Some optional values are required depending on the algorithm.
Failure to provide these values will result in the ACVP server
returning an error to the ACVP client during registration.
Fussell Expires February 2, 2019 [Page 4]
Internet-Draft Sym Alg JSON August 2018
3. Test Vectors
The ACVP server provides test vectors to the ACVP client, which are
then processed and returned to the ACVP server for validation. A
typical ACVP validation session would require multiple test vector
sets to be downloaded and processed by the ACVP client. Each test
vector set represents an individual Key Derivation Function (KDF),
such as SNMP, SSH, etc. This section describes the JSON schema for a
test vector set used with SP800-135 SNMP KDF algorithms.
The test vector set JSON schema is a multi-level hierarchy that
contains meta data for the entire vector set as well as individual
test vectors to be processed by the ACVP client.The following table
describes the JSON elements at the top level of the hierarchy.
+------------+---------------------------------------------+--------+
| JSON Value | Description | JSON |
| | | type |
+------------+---------------------------------------------+--------+
| acvVersion | Protocol version identifier | value |
| | | |
| vsId | Unique numeric identifier for the vector | value |
| | set | |
| | | |
| algorithm | "kdf-components" | value |
| | | |
| mode | "snmp" | value |
| | | |
| revision | "1.0" | value |
| | | |
| testGroups | Array of test group JSON objects, which are | array |
| | defined in Section 3.1 | |
+------------+---------------------------------------------+--------+
Table 3: Vector Set JSON Object
3.1. Test Groups JSON Schema
The testGroups element at the top level in the test vector JSON
object is an array of test groups. Test vectors are grouped into
similar test cases to reduce the amount of data transmitted in the
vector set. For instance, all test vectors that use the same key
size would be grouped together. The Test Group JSON object contains
meta data that applies to all test vectors within the group. The
following table describes the secure hash JSON elements of the Test
Group JSON object.
The KDF test group for SNMP is as follows:
Fussell Expires February 2, 2019 [Page 5]
Internet-Draft Sym Alg JSON August 2018
+----------------+-------------------------------+-------+----------+
| JSON Value | Description | JSON | Optional |
| | | type | |
+----------------+-------------------------------+-------+----------+
| tgId | Numeric identifier for the | value | No |
| | test group, unique across the | | |
| | entire vector set. | | |
| | | | |
| engineId | engine ID as hexadecimal | value | No |
| | string | | |
| | | | |
| passwordLength | Length of password | value | No |
| | | | |
| tests | Array of individual test | array | No |
| | vector JSON objects, which | | |
| | are defined in Section 3.2 | | |
| | | | |
+----------------+-------------------------------+-------+----------+
Table 4: Vector Group JSON Object
3.2. Test Case JSON Schema
Each test group contains an array of one or more test cases. Each
test case is a JSON object that represents a single test vector to be
processed by the ACVP client. The following table describes the JSON
elements for each SP800-135 SNMP KDF test vector.
+----------+--------------------------------+------------+----------+
| JSON | Description | JSON type | Optional |
| Value | | | |
+----------+--------------------------------+------------+----------+
| tcId | Numeric identifier for the | value | No |
| | test case, unique across the | | |
| | entire vector set. | | |
| | | | |
| password | Password value | ascii | No |
| | | value. | |
| | | A-Za-z. | |
+----------+--------------------------------+------------+----------+
Table 5: Test Case JSON Object
4. Test Vector Responses
After the ACVP client downloads and processes a vector set, it must
send the response vectors back to the ACVP server. The following
Fussell Expires February 2, 2019 [Page 6]
Internet-Draft Sym Alg JSON August 2018
table describes the JSON object that represents a vector set
response.
+------------+---------------------------------------------+--------+
| JSON Value | Description | JSON |
| | | type |
+------------+---------------------------------------------+--------+
| acvVersion | Protocol version identifier | value |
| | | |
| vsId | Unique numeric identifier for the vector | value |
| | set | |
| | | |
| testGroups | Array of JSON objects that represent each | array |
| | test vector group. See | |
| | Table 7 | |
| | | |
+------------+---------------------------------------------+--------+
Table 6: Vector Set Response JSON Object
The testGroups section is used to organize the ACVP client response
in a similar manner to how it receives vectors. Several algorithms
SHALL require the client to send back group level properties in their
response. This structure helps accommodate that.
+-----------+--------------------------------------------+----------+
| JSON | Description | JSON |
| Value | | type |
+-----------+--------------------------------------------+----------+
| tgId | The test group Id | value |
| | | |
| tests | The tests associated to the group | value |
| | specified in tgId | |
| | | |
+-----------+--------------------------------------------+----------+
Table 7: Vector Set Group Response JSON Object
The following table describes the JSON object that represents a
vector set response for SNMP.
Fussell Expires February 2, 2019 [Page 7]
Internet-Draft Sym Alg JSON August 2018
+-----------+---------------------------------------------+---------+
| JSON | Description | JSON |
| Value | | type |
+-----------+---------------------------------------------+---------+
| tcId | Numeric identifier for the test case, | value |
| | unique across the entire vector set. | |
| | | |
| sharedKey | Shared key value | value |
| | | (hex) |
| | | |
+-----------+---------------------------------------------+---------+
Table 8: Vector Set Response JSON Object
5. Acknowledgements
TBD...
6. IANA Considerations
This memo includes no request to IANA.
7. Security Considerations
Security considerations are addressed by the ACVP specification.
8. Normative References
[ACVP] authSurName, authInitials., "ACVP Specification", 2016.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>.
Appendix A. Example SP800-135 SNMP KDF Capabilities JSON Object
The following is a example JSON object advertising support for SNMP.
Fussell Expires February 2, 2019 [Page 8]
Internet-Draft Sym Alg JSON August 2018
{
"algorithm": "kdf-components",
"mode": "snmp",
"revision" "1.0",
"prereqVals": [
{
"algorithm": "SHA",
"valValue": "123456"
},
{
"algorithm": "DRBG",
"valValue": "123456"
}
],
"engineId": [
"12345678912345678900",
"abcdef0123456789abcdef1234567890"
],
"passwordLength": [
64,
8192
]
}
Appendix B. Example Test Vectors JSON Object
The following is a example JSON object for SP800-135 SNMP KDF test
vectors sent from the ACVP server to the crypto module.
Fussell Expires February 2, 2019 [Page 9]
Internet-Draft Sym Alg JSON August 2018
[{
"acvVersion": <acvp-version>
},
{
"vsId": 1564,
"algorithm": "kdf-components",
"mode": "snmp",
"revision": "1.0",
"testGroups": [{
"tgId": 1,
"engineId": "12345678912345678900",
"passwordLength": 64,
"tests": [{
"tcId": 1,
"password": "HkrWlnWjflyJTgvYFhvCQpsZLWDfcmdaZrBwSMRbsiKlKxldmeEohaWrSrkoJRhT"
}]
}]
}
]
Appendix C. Example Test Results JSON Object
The following is a example JSON object for SP800-135 SNMP KDF test
results sent from the crypto module to the ACVP server.
[{
"acvVersion": <acvp-version>
},
{
"vsId": 1564,
"testGroups": [{
"tgId": 1,
"tests": [{
"tcId": 1,
"sharedKey": "DC775617098106487650FA45E9E1CCDF1CF6EB32"
}]
}]
}
]
Author's Address
Fussell Expires February 2, 2019 [Page 10]
Internet-Draft Sym Alg JSON August 2018
Barry Fussell (editor)
Cisco Systems, Inc.
170 West Tasman Dr.
San Jose, CA 95134
USA
Email: [email protected]
Fussell Expires February 2, 2019 [Page 11]