forked from usnistgov/ACVP
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathacvp_sub_kdf135_srtp.xml
614 lines (590 loc) · 21.8 KB
/
acvp_sub_kdf135_srtp.xml
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
<?xml version="1.0" encoding="US-ASCII"?>
<!DOCTYPE rfc SYSTEM "rfc2629.dtd" [
<!ENTITY RFC2119 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.2119.xml">
]>
<?xml-stylesheet type='text/xsl' href='rfc2629.xslt' ?>
<!-- used by XSLT processors -->
<!-- For a complete list and description of processing instructions (PIs),
please see http://xml.resource.org/authoring/README.html. -->
<!-- Below are generally applicable Processing Instructions (PIs) that most I-Ds might want to use.
(Here they are set differently than their defaults in xml2rfc v1.32) -->
<?rfc strict="yes" ?>
<!-- give errors regarding ID-nits and DTD validation -->
<!-- control the table of contents (ToC) -->
<?rfc toc="yes"?>
<!-- generate a ToC -->
<?rfc tocdepth="4"?>
<!-- the number of levels of subsections in ToC. default: 3 -->
<!-- control references -->
<?rfc symrefs="yes"?>
<!-- use symbolic references tags, i.e, [RFC2119] instead of [1] -->
<?rfc sortrefs="yes" ?>
<!-- sort the reference entries alphabetically -->
<!-- control vertical white space
(using these PIs as follows is recommended by the RFC Editor) -->
<?rfc compact="yes" ?>
<!-- do not start each main section on a new page -->
<?rfc subcompact="no" ?>
<!-- keep one blank line between list items -->
<!-- end of list of popular I-D processing instructions -->
<rfc category="info" docName="draft-ietf-acvp-subkdf135-srtp-1.0" ipr="trust200902">
<!-- category values: std, bcp, info, exp, and historic
ipr values: full3667, noModification3667, noDerivatives3667
you can add the attributes updates="NNNN" and obsoletes="NNNN"
they will automatically be output with "(if approved)" -->
<!-- ***** FRONT MATTER ***** -->
<front>
<!-- The abbreviated title is used in the page header - it is only necessary if the
full title is longer than 39 characters -->
<title abbrev="Sym Alg JSON">ACVP SRTP Key Derivation Function Algorithm JSON Specification</title>
<!-- add 'role="editor"' below for the editors if appropriate -->
<!-- Another author who claims to be an editor -->
<author fullname="Barry Fussell" initials="B.F." role="editor" surname="Fussell">
<organization>Cisco Systems, Inc.</organization>
<address>
<postal>
<street>170 West Tasman Dr.</street>
<!-- Reorder these if your country does things differently -->
<city>San Jose</city>
<region>CA</region>
<code>95134</code>
<country>USA</country>
</postal>
<email>[email protected]</email>
<!-- uri and facsimile elements may also be added -->
</address>
</author>
<date month="August" year="2018" />
<!-- If the month and year are both specified and are the current ones, xml2rfc will fill
in the current day for you. If only the current year is specified, xml2rfc will fill
in the current day and month for you. If the year is not the current one, it is
necessary to specify at least a month (xml2rfc assumes day="1" if not specified for the
purpose of calculating the expiry date). With drafts it is normally sufficient to
specify just the year. -->
<!-- Meta-data Declarations -->
<area>General</area>
<workgroup>TBD</workgroup>
<!-- WG name at the upperleft corner of the doc,
IETF is fine for individual submissions.
If this element is not present, the default is "Network Working Group",
which is used by the RFC Editor as a nod to the history of the IETF. -->
<keyword>acvp</keyword>
<keyword>crypto</keyword>
<!-- Keywords will be incorporated into HTML output
files in a meta tag but they have no effect on text or nroff
output. If you submit your draft to the RFC Editor, the
keywords will be used for the search engine. -->
<abstract>
<t>This document defines the JSON schema for using SP800-135 SRTP KDF algorithms with the ACVP specification.</t>
</abstract>
</front>
<middle>
<section title="Introduction">
<t>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 SRTP KDF algorithms using ACVP.</t>
<section title="Requirements Language">
<t>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
<xref target="RFC2119">RFC 2119</xref>.
</t>
</section>
</section>
<section anchor="caps_reg" title="Capabilities Registration">
<t>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 the constructs for advertising support of SP800-135 SRTP KDF algorithms to the ACVP server.</t>
<t>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.</t>
<section anchor="prereq_algs" title="Required Prerequisite Algorithms for KDF135 SRTP Validations">
<t>Some KDF135 algorithm implementations rely on other cryptographic primitives. For example, SRTP 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:</t>
<texttable anchor="rereqs_table" title="Required Prerequisite Algorithms JSON Values">
<ttcol align="left">JSON Value</ttcol>
<ttcol align="left">Description</ttcol>
<ttcol align="left">JSON type</ttcol>
<ttcol align="left">Valid Values</ttcol>
<ttcol align="left">Optional</ttcol>
<c>algorithm</c>
<c>a prerequisite algorithm</c>
<c>value</c>
<c>AES</c>
<c>No</c>
<c/>
<c/>
<c/>
<c/>
<c/>
<c>valValue</c>
<c>algorithm validation number</c>
<c>value</c>
<c>actual number or "same"</c>
<c>No</c>
<c/>
<c/>
<c/>
<c/>
<c/>
<c>prereqAlgVal</c>
<c>prerequistie algorithm validation</c>
<c>object with algorithm and valValue properties</c>
<c>see above</c>
<c>No</c>
<c/>
<c/>
<c/>
<c/>
<c/>
<c>prereqVals</c>
<c>prerequistie algorithm validations</c>
<c>array of prereqAlgVal objects</c>
<c>see above</c>
<c>No</c>
</texttable>
</section>
<section anchor="cap_ex" title="KDF135 SRTP Algorithm Capabilities JSON Values">
<t>Each algorithm capability advertised is a self-contained JSON object using the following values.</t>
<texttable anchor="caps_table" title="SP800-135 SRTP KDF Algorithm Capabilities JSON Values">
<ttcol align="left">JSON Value</ttcol>
<ttcol align="left">Description</ttcol>
<ttcol align="left">JSON type</ttcol>
<ttcol align="left">Valid Values</ttcol>
<ttcol align="left">Optional</ttcol>
<c>algorithm</c>
<c>The KDF to be validated</c>
<c>value</c>
<c>"kdf-components"</c>
<c>No</c>
<c/>
<c/>
<c/>
<c/>
<c/>
<c>mode</c>
<c>The KDF-Component to be validated</c>
<c>value</c>
<c>"srtp"</c>
<c>No</c>
<c/>
<c/>
<c/>
<c/>
<c/>
<c>revision</c>
<c>The algorithm testing revision to use.</c>
<c>value</c>
<c>"1.0"</c>
<c>No</c>
<c/>
<c/>
<c/>
<c/>
<c/>
<c>prereqVals</c>
<c>Prerequisite algorithm validations</c>
<c>array of prereqAlgVal objects</c>
<c>See
<xref target="prereq_algs" />
</c>
<c>No</c>
<c/>
<c/>
<c/>
<c/>
<c/>
<c>aesKeyLength</c>
<c>AES Key sizes the IUT supports</c>
<c>array</c>
<c>Any non-empty subset of {128, 192, 256}.</c>
<c>No</c>
<c/>
<c/>
<c/>
<c/>
<c/>
<c>supportsZeroKdr</c>
<c>Whether or not the IUT supports an empty KDR</c>
<c>boolean</c>
<c>true/false</c>
<c>No</c>
<c/>
<c/>
<c/>
<c/>
<c/>
<c>kdrExponent</c>
<c>Key Derivation Rate as an exponent of 2. So a supported value of 3, corresponds to an actual KDF of 2^3 or "04" in hex, as the third least significant bit is a 1.</c>
<c>array</c>
<c>integers from 1 to 24 inclusive</c>
<c>No</c>
</texttable>
<t>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.</t>
</section>
</section>
<section anchor="test_vectors" title="Test Vectors">
<t>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 SRTP KDF algorithms.</t>
<t>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. </t>
<texttable anchor="vs_top_table" title="Vector Set JSON Object">
<ttcol align="left">JSON Value</ttcol>
<ttcol align="left">Description</ttcol>
<ttcol align="left">JSON type</ttcol>
<c>acvVersion</c>
<c>Protocol version identifier</c>
<c>value</c>
<c/>
<c/>
<c/>
<c>vsId</c>
<c>Unique numeric identifier for the vector set</c>
<c>value</c>
<c/>
<c/>
<c/>
<c>algorithm</c>
<c>"kdf-components"</c>
<c>value</c>
<c/>
<c/>
<c/>
<c>mode</c>
<c>"srtp"</c>
<c>value</c>
<c/>
<c/>
<c/>
<c>revision</c>
<c>"1.0"</c>
<c>value</c>
<c/>
<c/>
<c/>
<c>testGroups</c>
<c>Array of test group JSON objects, which are defined in
<xref target="tgjs" />
</c>
<c>array</c>
</texttable>
<section title="Test Groups JSON Schema" anchor="tgjs">
<t>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.</t>
<t> The KDF test group for SRTP is as follows:</t>
<texttable anchor="vs_tg_table5" title="Vector Group JSON Object">
<ttcol align="left">JSON Value</ttcol>
<ttcol align="left">Description</ttcol>
<ttcol align="left">JSON type</ttcol>
<ttcol align="left">Optional</ttcol>
<c>tgId</c>
<c>Numeric identifier for the test group, unique across the entire vector set.</c>
<c>value</c>
<c>No</c>
<c/>
<c/>
<c/>
<c/>
<c>aesKeyLength</c>
<c>The AES Key Length used in the test group.</c>
<c>value</c>
<c>No</c>
<c/>
<c/>
<c/>
<c/>
<c>kdr</c>
<c>The Key Derivation Rate used</c>
<c>value</c>
<c>No</c>
<c/>
<c/>
<c/>
<c/>
<c>tests</c>
<c>Array of individual test vector JSON objects, which are defined in
<xref target="tvjs" />
</c>
<c>array</c>
<c>No</c>
<c/>
<c/>
<c/>
<c/>
</texttable>
</section>
<section title="Test Case JSON Schema" anchor="tvjs">
<t>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 SRTP KDF test vector.</t>
<texttable anchor="vs_tc_table5" title="Test Case JSON Object">
<ttcol align="left">JSON Value</ttcol>
<ttcol align="left">Description</ttcol>
<ttcol align="left">JSON type</ttcol>
<ttcol align="left">Optional</ttcol>
<c>tcId</c>
<c>Numeric identifier for the test case, unique across the entire vector set.</c>
<c>value</c>
<c>No</c>
<c/>
<c/>
<c/>
<c/>
<c>masterKey</c>
<c>Master key value</c>
<c>value</c>
<c>No</c>
<c/>
<c/>
<c/>
<c/>
<c>masterSalt</c>
<c>Master salt value</c>
<c>value</c>
<c>No</c>
<c/>
<c/>
<c/>
<c/>
<c>index</c>
<c>Index value for SCTP</c>
<c>value</c>
<c>No</c>
<c/>
<c/>
<c/>
<c/>
<c>srtcpIndex</c>
<c>Index value for SRTCP</c>
<c>value</c>
<c>No</c>
</texttable>
</section>
</section>
<section anchor="vector_responses" title="Test Vector Responses">
<t>After the ACVP client downloads and processes a vector set, it must send the response vectors back to the ACVP server. The following table describes the JSON object that represents a vector set response.</t>
<texttable anchor="vr_top_table" title="Vector Set Response JSON Object">
<ttcol align="left">JSON Value</ttcol>
<ttcol align="left">Description</ttcol>
<ttcol align="left">JSON type</ttcol>
<c>acvVersion</c>
<c>Protocol version identifier</c>
<c>value</c>
<c/>
<c/>
<c/>
<c>vsId</c>
<c>Unique numeric identifier for the vector set</c>
<c>value</c>
<c/>
<c/>
<c/>
<c>testGroups</c>
<c>Array of JSON objects that represent each test vector group. See <xref target="vr_group_table"/>
</c>
<c>array</c>
<c/>
<c/>
<c/>
</texttable>
<t>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.</t>
<texttable anchor="vr_group_table" title="Vector Set Group Response JSON Object">
<ttcol align="left">JSON Value</ttcol>
<ttcol align="left">Description</ttcol>
<ttcol align="left">JSON type</ttcol>
<c>tgId</c>
<c>The test group Id</c>
<c>value</c>
<c/>
<c/>
<c/>
<c>tests</c>
<c>The tests associated to the group specified in tgId</c>
<c>value</c>
<c/>
<c/>
<c/>
</texttable>
<t>The following table describes the JSON object that represents a vector set response for SRTP.</t>
<texttable anchor="vr_top_table5" title="Vector Set Response JSON Object">
<ttcol align="left">JSON Value</ttcol>
<ttcol align="left">Description</ttcol>
<ttcol align="left">JSON type</ttcol>
<c>tcId</c>
<c>Numeric identifier for the test case, unique across the entire vector set.</c>
<c>value</c>
<c/>
<c/>
<c/>
<c>srtpKe</c>
<c>SRTP encryption key</c>
<c>value</c>
<c/>
<c/>
<c/>
<c>srtpKa</c>
<c>SRTP authentication key</c>
<c>value</c>
<c/>
<c/>
<c/>
<c>srtpKs</c>
<c>SRTP salting key</c>
<c>value</c>
<c/>
<c/>
<c/>
<c>srtcpKe</c>
<c>SRTCP encryption key</c>
<c>value</c>
<c/>
<c/>
<c/>
<c>srtcpKa</c>
<c>SRTCP authentication key</c>
<c>value</c>
<c/>
<c/>
<c/>
<c>srtcpKs</c>
<c>SRTCP salting key</c>
<c>value</c>
<c/>
<c/>
<c/>
</texttable>
</section>
<!-- This PI places the pagebreak correctly (before the section title) in the text output. -->
<section anchor="Acknowledgements" title="Acknowledgements">
<t>TBD...</t>
</section>
<!-- Possibly a 'Contributors' section ... -->
<section anchor="IANA" title="IANA Considerations">
<t>This memo includes no request to IANA.</t>
</section>
<section anchor="Security" title="Security Considerations">
<t>Security considerations are addressed by the ACVP specification.</t>
</section>
</middle>
<!-- *****BACK MATTER ***** -->
<back>
<references title="Normative References">
<!--?rfc include="http://xml.resource.org/public/rfc/bibxml/reference.RFC.2119.xml"?--> &RFC2119;
<reference anchor="ACVP">
<!-- the following is the minimum to make xml2rfc happy -->
<front>
<title>ACVP Specification</title>
<author initials="authInitials" surname="authSurName">
<organization>NIST</organization>
</author>
<date year="2016" />
</front>
</reference>
</references>
<section anchor="app-reg-ex" title="Example SP800-135 SRTP KDF Capabilities JSON Object">
<t>The following is a example JSON object advertising support for SHA-256.</t>
<figure>
<artwork>
<![CDATA[
{
"algorithm": "kdf-components",
"mode": "srtp",
"revision": "1.0",
"prereqVals": [
{
"algorithm": "AES",
"valValue": "123456"
}
],
"aesKeyLength": [
128,
192,
256
],
"supportsZeroKdr": true,
"kdrExponent": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24
]
}
]]>
</artwork>
</figure>
</section>
<section anchor="app-vs-ex" title="Example Test Vectors JSON Object">
<t>The following is a example JSON object for SP800-135 SRTP KDF test vectors sent from the ACVP server to the crypto module.</t>
<figure>
<artwork>
<![CDATA[
[
{
"acvVersion": <acvp-version>
},
{
"vsId": 1564,
"algorithm": "kdf-components",
"mode": "srtp",
"revision": "1.0",
"testGroups": [
{
"tgId": 1,
"kdr": "00",
"aesKeyLength": 128,
"tests": [
{
"tcId": 1,
"masterKey": "AD16913E52D9C2A6D8E1D3CB90E4FDAD",
"masterSalt": "2AB06C2BCC07C7AF364F3BE6EAEC",
"index": "B18C1C4ED637",
"srtcpIndex": "20FB9BB3"
}
]
}
]
}
]
]]>
</artwork>
</figure>
</section>
<section anchor="app-results-ex" title="Example Test Results JSON Object">
<t>The following is a example JSON object for SP800-135 SRTP KDF test results sent from the crypto module to the ACVP server.</t>
<figure>
<artwork>
<![CDATA[
[{
"acvVersion": <acvp-version>
},
{
"vsId": 1564,
"testGroups": [{
"tgId": 1,
"tests": [{
"tcId": 1,
"srtpKe": "94AD7DB37D198F049375BD461E90D9E5",
"srtpKa": "51E18978366B7EFF4E3EE57DCBC50636AAF19F39",
"srtpKs": "7157797656C383BD69192B036C0A",
"srtcpKe": "5707D07782D6FE0030635106A487D97C",
"srtcpKa": "097ECF3E2965DF071180F5F126C2D54A548B902F",
"srtcpKs": "72DF8546DDB209875A5209786E4B"
}]
}]
}
]
]]>
</artwork>
</figure>
</section>
</back>
</rfc>