Towards Validated HTTP Implementation

Mohammed Al-Sahaf

Some people are already familiar with the content of this post, as I’ve already discussed it on the HTTP WG mailing list and the HTTP Workshop, but I’m going to write it down here for everybody else who isn’t yet aware.

It started with a user of Caddy reporting warnings found by REDBot (caddyserver/caddy#5849). Matt Holt fixed the warnings promptly. We’ve had thoughts about how to improve Caddy testing situation, but the issue reported by the user brought other concerns on the table: How do we prevent recurrence? And are we violating the HTTP specification unknowingly? Answering the first question is easy: add a test case. Answering the second question is more difficult. This is where the quest started.

The top aim on my mind was how do we test Caddy effectively. I opted for developing a declarative test suite PoC-ed in caddy/pull#6255. The PoC was a success, and I’m slowly chipping away at the test suite. I mentioned the possiblity of translating REDBot validations into the same declarative test suite to be part of the CI pipeline ensuring consitent execution and behavior. One user asked why not make the parts translated from REDBot an independent project since they’re common expectations of all HTTP implementations. I declined at first, but something possessed me a few weeks later, and I sent out an email to the HTTP WG mailing list with the subject Declarative HTTP Test Suite. I will not reproduce the thread and its branches here, and I recommend going through them because the feedback was valuable.

The proposal evolved into a talk at the HTTP Workshop where I presented the talk “Do you speak HTTP?”. The talk summarizes the mailinglist thread and meant to provoke the discussion amongst the attendees on the best way forward. Daniel Stenberg gives a great one-paragraph summary of the talk and the discussion in his blog post. As Daniel said, the general sense was “yes”, with nuance on the implementation. The general recommendation was to create specialized test suites with narrow scope, which is a lesson learned from the success of structured-field-tests and cache-tests. The test suite should be defined in an inter-operable format to facilitate execution across implementations regardless of the language.

To start, these few challenges have to be resolved for this initiatives to move forward:

  1. Extracting the requriements from the IETF RFCs
  2. Developing the scopes
  3. Developing the declarative format for the test cases, possibly different format as suitable for the scope
  4. Developing a test execution framework/tool
  5. Translating the requirements extracted at step 1 into the declarative format defined in step 3

To get going, with a hint from Martin Thomson, I cowboy-coded a tool that reads the RFC XML, picks out and groups the requirements per keyword per section, and output them into a directory tree per the RFC sections and text files per the requirements’ keyword. Here’s the result of running the tool on RFC 9110:

Beware, you'll see the bemazed with 692 lines.
  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
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
rfcs
├── 9110
│   ├── README.md
│   ├── data
│   └── text
│       ├── 10-context
│       │   ├── section-10.1.1-14-field-expect
│       │   │   └── MUST.txt
│       │   ├── section-10.1.1-16-field-expect
│       │   │   └── MUST NOT.txt
│       │   ├── section-10.1.1-17-field-expect
│       │   │   └── MUST.txt
│       │   ├── section-10.1.1-19-field-expect
│       │   │   └── MAY.txt
│       │   ├── section-10.1.1-5-field-expect
│       │   │   └── MAY.txt
│       │   ├── section-10.1.2-5-field-from
│       │   │   └── SHOULD NOT.txt
│       │   ├── section-10.1.2-6-field-from
│       │   │   └── SHOULD.txt
│       │   ├── section-10.1.2-7-field-from
│       │   │   └── SHOULD NOT.txt
│       │   ├── section-10.1.3-1-field-referer
│       │   │   └── MUST NOT.txt
│       │   ├── section-10.1.3-10-field-referer
│       │   │   └── SHOULD NOT.txt
│       │   ├── section-10.1.3-7-field-referer
│       │   │   └── MUST.txt
│       │   ├── section-10.1.3-8-field-referer
│       │   │   └── MAY.txt
│       │   ├── section-10.1.3-9-field-referer
│       │   │   ├── MUST NOT.txt
│       │   │   └── SHOULD NOT.txt
│       │   ├── section-10.1.4-6-field-te
│       │   │   └── MUST.txt
│       │   ├── section-10.1.5-1-field-user-agent
│       │   │   └── SHOULD.txt
│       │   ├── section-10.1.5-5-field-user-agent
│       │   │   ├── MUST NOT.txt
│       │   │   ├── SHOULD NOT.txt
│       │   │   └── SHOULD.txt
│       │   ├── section-10.1.5-8-field-user-agent
│       │   │   ├── SHOULD NOT.txt
│       │   │   └── SHOULD.txt
│       │   ├── section-10.2.1-5-field-allow
│       │   │   ├── MAY.txt
│       │   │   └── MUST.txt
│       │   ├── section-10.2.1-6-field-allow
│       │   │   └── MUST NOT.txt
│       │   ├── section-10.2.2-5-field-location
│       │   │   └── MUST.txt
│       │   ├── section-10.2.4-1-field-server
│       │   │   └── MAY.txt
│       │   └── section-10.2.4-6-field-server
│       │       ├── SHOULD NOT.txt
│       │       └── SHOULD.txt
│       ├── 11-authentication
│       │   ├── section-11.2-4-auth-params
│       │   │   └── MUST.txt
│       │   ├── section-11.4-3-credentials
│       │   │   └── SHOULD.txt
│       │   ├── section-11.4-4-credentials
│       │   │   └── SHOULD.txt
│       │   ├── section-11.5-3-protection-space
│       │   │   └── MAY.txt
│       │   ├── section-11.5-5-protection-space
│       │   │   └── MUST.txt
│       │   ├── section-11.6.1-3-field-www-authenticate
│       │   │   ├── MAY.txt
│       │   │   └── MUST.txt
│       │   ├── section-11.6.1-4-field-www-authenticate
│       │   │   └── MUST NOT.txt
│       │   ├── section-11.6.2-4-field-authorization
│       │   │   └── MUST NOT.txt
│       │   ├── section-11.7.1-1-field-proxy-authenticate
│       │   │   └── MUST.txt
│       │   └── section-11.7.2-3-field-proxy-authorization
│       │       └── MAY.txt
│       ├── 12-content-negotiation
│       │   ├── section-12.1-2-proactive-negotiation
│       │   │   └── MAY.txt
│       │   ├── section-12.4.2-4-quality-values
│       │   │   └── MUST NOT.txt
│       │   ├── section-12.5.1-6-field-accept
│       │   │   └── SHOULD.txt
│       │   ├── section-12.5.2-3-field-accept-charset
│       │   │   └── MAY.txt
│       │   ├── section-12.5.3-12-field-accept-encoding
│       │   │   └── SHOULD.txt
│       │   ├── section-12.5.3-15-field-accept-encoding
│       │   │   └── MUST NOT.txt
│       │   ├── section-12.5.3-6-field-accept-encoding
│       │   │   └── MAY.txt
│       │   ├── section-12.5.4-9-field-accept-language
│       │   │   └── MUST NOT.txt
│       │   ├── section-12.5.5-10-field-vary
│       │   │   └── SHOULD.txt
│       │   ├── section-12.5.5-4-field-vary
│       │   │   └── MUST NOT.txt
│       │   └── section-12.5.5-9.1.1-field-vary
│       │       └── MUST NOT.txt
│       ├── 13-conditional-requests
│       │   ├── section-13.1.1-10-field-if-match
│       │   │   ├── MAY.txt
│       │   │   └── MUST NOT.txt
│       │   ├── section-13.1.1-12-field-if-match
│       │   │   └── MAY.txt
│       │   ├── section-13.1.1-13-field-if-match
│       │   │   └── MAY.txt
│       │   ├── section-13.1.1-2-field-if-match
│       │   │   └── MUST.txt
│       │   ├── section-13.1.1-7-field-if-match
│       │   │   └── MUST.txt
│       │   ├── section-13.1.2-11-field-if-none-match
│       │   │   ├── MUST NOT.txt
│       │   │   └── MUST.txt
│       │   ├── section-13.1.2-2-field-if-none-match
│       │   │   └── MUST.txt
│       │   ├── section-13.1.2-6-field-if-none-match
│       │   │   └── SHOULD.txt
│       │   ├── section-13.1.2-8-field-if-none-match
│       │   │   └── MUST.txt
│       │   ├── section-13.1.3-12-field-if-modified-since
│       │   │   └── SHOULD.txt
│       │   ├── section-13.1.3-15-field-if-modified-since
│       │   │   ├── SHOULD NOT.txt
│       │   │   └── SHOULD.txt
│       │   ├── section-13.1.3-5-field-if-modified-since
│       │   │   └── MUST.txt
│       │   ├── section-13.1.3-6-field-if-modified-since
│       │   │   └── MUST.txt
│       │   ├── section-13.1.3-7-field-if-modified-since
│       │   │   └── MUST.txt
│       │   ├── section-13.1.3-8-field-if-modified-since
│       │   │   └── MUST.txt
│       │   ├── section-13.1.4-10-field-if-unmodified-since
│       │   │   └── MUST.txt
│       │   ├── section-13.1.4-13-field-if-unmodified-since
│       │   │   ├── MAY.txt
│       │   │   └── MUST NOT.txt
│       │   ├── section-13.1.4-15-field-if-unmodified-since
│       │   │   └── MAY.txt
│       │   ├── section-13.1.4-16-field-if-unmodified-since
│       │   │   └── MAY.txt
│       │   ├── section-13.1.4-5-field-if-unmodified-since
│       │   │   └── MUST.txt
│       │   ├── section-13.1.4-6-field-if-unmodified-since
│       │   │   └── MUST.txt
│       │   ├── section-13.1.4-7-field-if-unmodified-since
│       │   │   └── MUST.txt
│       │   ├── section-13.1.4-8-field-if-unmodified-since
│       │   │   └── MUST.txt
│       │   ├── section-13.1.5-13-field-if-range
│       │   │   ├── MUST.txt
│       │   │   └── SHOULD.txt
│       │   ├── section-13.1.5-6-field-if-range
│       │   │   ├── MUST NOT.txt
│       │   │   └── MUST.txt
│       │   ├── section-13.1.5-7-field-if-range
│       │   │   └── MUST NOT.txt
│       │   ├── section-13.1.5-8-field-if-range
│       │   │   └── MUST.txt
│       │   ├── section-13.2.1-1-when-to-evaluate
│       │   │   └── MUST.txt
│       │   ├── section-13.2.1-2-when-to-evaluate
│       │   │   ├── MUST NOT.txt
│       │   │   └── MUST.txt
│       │   └── section-13.2.2-2-precedence
│       │       └── MUST.txt
│       ├── 14-range-requests
│       │   ├── section-14-2-range-requests
│       │   │   └── OPTIONAL.txt
│       │   ├── section-14.1.2-13-byte-ranges
│       │   │   └── MUST.txt
│       │   ├── section-14.2-11-field-range
│       │   │   └── SHOULD.txt
│       │   ├── section-14.2-13-field-range
│       │   │   └── SHOULD.txt
│       │   ├── section-14.2-3-field-range
│       │   │   └── MAY.txt
│       │   ├── section-14.2-4-field-range
│       │   │   └── MUST.txt
│       │   ├── section-14.2-5-field-range
│       │   │   ├── MAY.txt
│       │   │   └── MUST.txt
│       │   ├── section-14.2-6-field-range
│       │   │   ├── MAY.txt
│       │   │   └── SHOULD NOT.txt
│       │   ├── section-14.2-7-field-range
│       │   │   └── MAY.txt
│       │   ├── section-14.2-8-field-range
│       │   │   └── SHOULD.txt
│       │   ├── section-14.3-11-field-accept-ranges
│       │   │   └── MAY.txt
│       │   ├── section-14.3-6-field-accept-ranges
│       │   │   └── MAY.txt
│       │   ├── section-14.3-7-field-accept-ranges
│       │   │   └── MUST NOT.txt
│       │   ├── section-14.3-8-field-accept-ranges
│       │   │   └── MAY.txt
│       │   ├── section-14.4-10-field-content-range
│       │   │   └── MUST NOT.txt
│       │   ├── section-14.4-11-field-content-range
│       │   │   └── SHOULD.txt
│       │   ├── section-14.4-3-field-content-range
│       │   │   ├── MUST NOT.txt
│       │   │   └── SHOULD.txt
│       │   ├── section-14.4-4-field-content-range
│       │   │   └── MUST.txt
│       │   ├── section-14.4-5-field-content-range
│       │   │   └── SHOULD.txt
│       │   └── section-14.5-2-partial-PUT
│       │       └── SHOULD.txt
│       ├── 15-status-codes
│       │   ├── section-15-4-status-codes
│       │   │   └── MUST.txt
│       │   ├── section-15-6-status-codes
│       │   │   └── SHOULD.txt
│       │   ├── section-15.2-1-status-1xx
│       │   │   └── MUST NOT.txt
│       │   ├── section-15.2-3-status-1xx
│       │   │   ├── MAY.txt
│       │   │   └── MUST.txt
│       │   ├── section-15.2-4-status-1xx
│       │   │   └── MUST.txt
│       │   ├── section-15.2.2-1-status-101
│       │   │   └── MUST.txt
│       │   ├── section-15.3.1-5-status-200
│       │   │   └── SHOULD.txt
│       │   ├── section-15.3.6-3-status-205
│       │   │   └── MUST NOT.txt
│       │   ├── section-15.3.7-3-status-206
│       │   │   └── MUST.txt
│       │   ├── section-15.3.7-4-status-206
│       │   │   └── MUST.txt
│       │   ├── section-15.3.7-6-status-206
│       │   │   ├── MUST.txt
│       │   │   └── SHOULD NOT.txt
│       │   ├── section-15.3.7.1-1-partial-single
│       │   │   └── MUST.txt
│       │   ├── section-15.3.7.2-1-partial-multipart
│       │   │   ├── MUST NOT.txt
│       │   │   └── MUST.txt
│       │   ├── section-15.3.7.2-2-partial-multipart
│       │   │   ├── MUST.txt
│       │   │   └── SHOULD.txt
│       │   ├── section-15.3.7.2-4-partial-multipart
│       │   │   └── MAY.txt
│       │   ├── section-15.3.7.2-5-partial-multipart
│       │   │   ├── MAY.txt
│       │   │   └── MUST NOT.txt
│       │   ├── section-15.3.7.2-6-partial-multipart
│       │   │   ├── MUST.txt
│       │   │   └── SHOULD.txt
│       │   ├── section-15.3.7.3-2-combining-byte-ranges
│       │   │   └── MAY.txt
│       │   ├── section-15.3.7.3-4-combining-byte-ranges
│       │   │   └── MUST.txt
│       │   ├── section-15.3.7.3-5-combining-byte-ranges
│       │   │   └── MUST.txt
│       │   ├── section-15.4-4-status-3xx
│       │   │   └── MAY.txt
│       │   ├── section-15.4-5-status-3xx
│       │   │   └── SHOULD.txt
│       │   ├── section-15.4-7-status-3xx
│       │   │   └── SHOULD.txt
│       │   ├── section-15.4.1-2-status-300
│       │   │   ├── MAY.txt
│       │   │   └── SHOULD.txt
│       │   ├── section-15.4.1-3-status-300
│       │   │   ├── MAY.txt
│       │   │   └── SHOULD.txt
│       │   ├── section-15.4.2-2-status-301
│       │   │   ├── MAY.txt
│       │   │   └── SHOULD.txt
│       │   ├── section-15.4.2-3.1-status-301
│       │   │   └── MAY.txt
│       │   ├── section-15.4.3-2-status-302
│       │   │   ├── MAY.txt
│       │   │   └── SHOULD.txt
│       │   ├── section-15.4.3-3.1-status-302
│       │   │   └── MAY.txt
│       │   ├── section-15.4.5-2-status-304
│       │   │   └── MUST.txt
│       │   ├── section-15.4.5-4-status-304
│       │   │   └── SHOULD NOT.txt
│       │   ├── section-15.4.5-5-status-304
│       │   │   └── SHOULD.txt
│       │   ├── section-15.4.8-1-status-307
│       │   │   └── MUST NOT.txt
│       │   ├── section-15.4.8-2-status-307
│       │   │   ├── MAY.txt
│       │   │   └── SHOULD.txt
│       │   ├── section-15.4.9-2-status-308
│       │   │   ├── MAY.txt
│       │   │   └── SHOULD.txt
│       │   ├── section-15.5-1-status-4xx
│       │   │   └── SHOULD.txt
│       │   ├── section-15.5.10-1-status-409
│       │   │   └── SHOULD.txt
│       │   ├── section-15.5.12-1-status-411
│       │   │   └── MAY.txt
│       │   ├── section-15.5.14-1-status-413
│       │   │   └── MAY.txt
│       │   ├── section-15.5.14-2-status-413
│       │   │   ├── MAY.txt
│       │   │   └── SHOULD.txt
│       │   ├── section-15.5.17-3-status-416
│       │   │   └── SHOULD.txt
│       │   ├── section-15.5.2-1-status-401
│       │   │   └── MUST.txt
│       │   ├── section-15.5.2-2-status-401
│       │   │   ├── MAY.txt
│       │   │   └── SHOULD.txt
│       │   ├── section-15.5.20-2-status-421
│       │   │   └── MAY.txt
│       │   ├── section-15.5.20-3-status-421
│       │   │   └── MUST NOT.txt
│       │   ├── section-15.5.22-1-status-426
│       │   │   └── MUST.txt
│       │   ├── section-15.5.4-2-status-403
│       │   │   ├── MAY.txt
│       │   │   └── SHOULD NOT.txt
│       │   ├── section-15.5.4-3-status-403
│       │   │   └── MAY.txt
│       │   ├── section-15.5.6-1-status-405
│       │   │   └── MUST.txt
│       │   ├── section-15.5.7-2-status-406
│       │   │   ├── MAY.txt
│       │   │   └── SHOULD.txt
│       │   ├── section-15.5.8-1-status-407
│       │   │   ├── MAY.txt
│       │   │   └── MUST.txt
│       │   ├── section-15.5.9-2-status-408
│       │   │   └── MAY.txt
│       │   ├── section-15.6-1-status-5xx
│       │   │   └── SHOULD.txt
│       │   ├── section-15.6.4-1-status-503
│       │   │   └── MAY.txt
│       │   └── section-15.6.6-1-status-505
│       │       └── SHOULD.txt
│       ├── 2-conformance
│       │   ├── section-2.2-5-requirements-notation
│       │   │   └── MUST NOT.txt
│       │   ├── section-2.2-7-requirements-notation
│       │   │   └── MAY.txt
│       │   ├── section-2.3-1-length-requirements
│       │   │   └── SHOULD.txt
│       │   ├── section-2.3-3-length-requirements
│       │   │   └── MUST.txt
│       │   ├── section-2.4-1-error-handling
│       │   │   └── MUST.txt
│       │   └── section-2.4-2-error-handling
│       │       └── MAY.txt
│       ├── 3-terminology
│       │   ├── section-3.3-5-connections
│       │   │   └── MUST NOT.txt
│       │   └── section-3.8-1-caches
│       │       └── MAY.txt
│       ├── 4-uri
│       │   ├── section-4.1-5-uri-references
│       │   │   └── RECOMMENDED.txt
│       │   ├── section-4.2.1-4-http-uri
│       │   │   ├── MUST NOT.txt
│       │   │   └── MUST.txt
│       │   ├── section-4.2.2-4-https-uri
│       │   │   ├── MUST NOT.txt
│       │   │   └── MUST.txt
│       │   ├── section-4.2.2-6-https-uri
│       │   │   └── MUST.txt
│       │   ├── section-4.2.3-7-uri-comparison
│       │   │   ├── MAY.txt
│       │   │   └── SHOULD NOT.txt
│       │   ├── section-4.2.4-3-http-userinfo
│       │   │   └── MUST NOT.txt
│       │   ├── section-4.2.4-4-http-userinfo
│       │   │   └── SHOULD.txt
│       │   ├── section-4.3.2-3-http-origin
│       │   │   └── MAY.txt
│       │   ├── section-4.3.3-7-https-origin
│       │   │   └── MAY.txt
│       │   ├── section-4.3.4-1-https-verify
│       │   │   └── MUST.txt
│       │   ├── section-4.3.4-2-https-verify
│       │   │   └── MUST.txt
│       │   ├── section-4.3.4-3-https-verify
│       │   │   └── MUST NOT.txt
│       │   └── section-4.3.4-6-https-verify
│       │       ├── MAY.txt
│       │       ├── MUST.txt
│       │       └── SHOULD.txt
│       ├── 5-fields
│       │   ├── section-5.1-6-fields-names
│       │   │   ├── MUST.txt
│       │   │   └── SHOULD.txt
│       │   ├── section-5.3-1-fields-order
│       │   │   └── MAY.txt
│       │   ├── section-5.3-2-fields-order
│       │   │   └── MUST NOT.txt
│       │   ├── section-5.3-3-fields-order
│       │   │   └── MUST NOT.txt
│       │   ├── section-5.3-6-fields-order
│       │   │   └── MUST NOT.txt
│       │   ├── section-5.4-2-fields-limits
│       │   │   └── MUST.txt
│       │   ├── section-5.4-3-fields-limits
│       │   │   └── MAY.txt
│       │   ├── section-5.5-3-fields-values
│       │   │   └── MUST.txt
│       │   ├── section-5.5-4-fields-values
│       │   │   └── SHOULD.txt
│       │   ├── section-5.5-5-fields-values
│       │   │   ├── MAY.txt
│       │   │   └── MUST.txt
│       │   ├── section-5.6.1.1-1-abnf-extension-sender
│       │   │   └── MUST NOT.txt
│       │   ├── section-5.6.1.2-1-abnf-extension-recipient
│       │   │   └── MUST.txt
│       │   ├── section-5.6.3-2-whitespace
│       │   │   ├── SHOULD NOT.txt
│       │   │   └── SHOULD.txt
│       │   ├── section-5.6.3-3-whitespace
│       │   │   └── SHOULD.txt
│       │   ├── section-5.6.3-4-whitespace
│       │   │   └── MAY.txt
│       │   ├── section-5.6.3-5-whitespace
│       │   │   ├── MUST NOT.txt
│       │   │   └── MUST.txt
│       │   ├── section-5.6.3-6-whitespace
│       │   │   └── MAY.txt
│       │   ├── section-5.6.4-3-quoted-strings
│       │   │   └── MUST.txt
│       │   ├── section-5.6.4-5-quoted-strings
│       │   │   └── SHOULD NOT.txt
│       │   ├── section-5.6.7-17-http-date
│       │   │   └── MUST NOT.txt
│       │   ├── section-5.6.7-18-http-date
│       │   │   └── MUST.txt
│       │   └── section-5.6.7-7-http-date
│       │       └── MUST.txt
│       ├── 6-message-abstraction
│       │   ├── section-6-6-message-abstraction
│       │   │   └── MUST.txt
│       │   ├── section-6.2-5-message-control-data
│       │   │   ├── MUST NOT.txt
│       │   │   └── SHOULD.txt
│       │   ├── section-6.2-6-message-control-data
│       │   │   └── MAY.txt
│       │   ├── section-6.2-7-message-control-data
│       │   │   ├── MUST NOT.txt
│       │   │   └── SHOULD.txt
│       │   ├── section-6.2-8-message-control-data
│       │   │   └── SHOULD.txt
│       │   ├── section-6.5.1-2-trailers-limitations
│       │   │   └── MUST NOT.txt
│       │   ├── section-6.5.1-3-trailers-limitations
│       │   │   └── MUST NOT.txt
│       │   ├── section-6.5.1-5-trailers-limitations
│       │   │   └── SHOULD NOT.txt
│       │   ├── section-6.5.2-2-trailers-processing
│       │   │   └── MUST.txt
│       │   ├── section-6.5.2-3-trailers-processing
│       │   │   └── MAY.txt
│       │   ├── section-6.6.1-10-field-date
│       │   │   └── MAY.txt
│       │   ├── section-6.6.1-5-field-date
│       │   │   └── SHOULD.txt
│       │   ├── section-6.6.1-6-field-date
│       │   │   ├── MAY.txt
│       │   │   └── MUST.txt
│       │   ├── section-6.6.1-7-field-date
│       │   │   └── MUST NOT.txt
│       │   ├── section-6.6.1-8-field-date
│       │   │   └── MUST.txt
│       │   ├── section-6.6.1-9-field-date
│       │   │   └── MAY.txt
│       │   └── section-6.6.2-4-field-trailer
│       │       └── SHOULD.txt
│       ├── 7-routing
│       │   ├── section-7.1-6-target-resource
│       │   │   └── MUST NOT.txt
│       │   ├── section-7.2-4-field-host
│       │   │   ├── MUST.txt
│       │   │   └── SHOULD.txt
│       │   ├── section-7.4-3-routing-reject
│       │   │   └── MUST.txt
│       │   ├── section-7.5-3-response-correlation
│       │   │   └── SHOULD.txt
│       │   ├── section-7.6-3-message-forwarding
│       │   │   └── MUST.txt
│       │   ├── section-7.6-4-message-forwarding
│       │   │   └── MUST NOT.txt
│       │   ├── section-7.6.1-4-field-connection
│       │   │   └── MUST.txt
│       │   ├── section-7.6.1-5-field-connection
│       │   │   └── MUST.txt
│       │   ├── section-7.6.1-7-field-connection
│       │   │   └── SHOULD.txt
│       │   ├── section-7.6.1-9-field-connection
│       │   │   └── MUST NOT.txt
│       │   ├── section-7.6.2-4-field-max-forwards
│       │   │   ├── MUST NOT.txt
│       │   │   └── MUST.txt
│       │   ├── section-7.6.2-5-field-max-forwards
│       │   │   └── MAY.txt
│       │   ├── section-7.6.3-10-field-via
│       │   │   ├── SHOULD NOT.txt
│       │   │   └── SHOULD.txt
│       │   ├── section-7.6.3-11-field-via
│       │   │   └── MAY.txt
│       │   ├── section-7.6.3-15-field-via
│       │   │   ├── MUST NOT.txt
│       │   │   └── SHOULD NOT.txt
│       │   ├── section-7.6.3-4-field-via
│       │   │   ├── MAY.txt
│       │   │   └── MUST.txt
│       │   ├── section-7.6.3-6-field-via
│       │   │   └── MAY.txt
│       │   ├── section-7.6.3-7-field-via
│       │   │   └── MAY.txt
│       │   ├── section-7.7-3-message-transformations
│       │   │   ├── MAY.txt
│       │   │   └── MUST NOT.txt
│       │   ├── section-7.7-4-message-transformations
│       │   │   └── MUST NOT.txt
│       │   ├── section-7.7-5-message-transformations
│       │   │   └── MUST NOT.txt
│       │   ├── section-7.7-6-message-transformations
│       │   │   └── MAY.txt
│       │   ├── section-7.7-7-message-transformations
│       │   │   └── SHOULD NOT.txt
│       │   ├── section-7.8-11-field-upgrade
│       │   │   └── MUST NOT.txt
│       │   ├── section-7.8-14-field-upgrade
│       │   │   └── MUST.txt
│       │   ├── section-7.8-15-field-upgrade
│       │   │   └── MUST.txt
│       │   ├── section-7.8-2-field-upgrade
│       │   │   └── MAY.txt
│       │   ├── section-7.8-4-field-upgrade
│       │   │   └── SHOULD.txt
│       │   ├── section-7.8-5-field-upgrade
│       │   │   ├── MAY.txt
│       │   │   ├── MUST NOT.txt
│       │   │   └── MUST.txt
│       │   ├── section-7.8-6-field-upgrade
│       │   │   └── MUST.txt
│       │   └── section-7.8-7-field-upgrade
│       │       └── MAY.txt
│       ├── 8-representation-data-and-metadata
│       │   ├── section-8.3-5-field-content-type
│       │   │   ├── MAY.txt
│       │   │   └── SHOULD.txt
│       │   ├── section-8.3.1-4-media-type
│       │   │   └── MAY.txt
│       │   ├── section-8.3.3-1-multipart-types
│       │   │   └── MUST.txt
│       │   ├── section-8.4-5-field-content-encoding
│       │   │   ├── MUST.txt
│       │   │   └── SHOULD NOT.txt
│       │   ├── section-8.4-9-field-content-encoding
│       │   │   └── MAY.txt
│       │   ├── section-8.4.1.1-1-compress-coding
│       │   │   └── SHOULD.txt
│       │   ├── section-8.4.1.3-1-gzip-coding
│       │   │   └── SHOULD.txt
│       │   ├── section-8.5-6-field-content-language
│       │   │   └── MAY.txt
│       │   ├── section-8.5-9-field-content-language
│       │   │   └── MAY.txt
│       │   ├── section-8.6-10-field-content-length
│       │   │   └── MUST.txt
│       │   ├── section-8.6-12-field-content-length
│       │   │   └── MUST NOT.txt
│       │   ├── section-8.6-13-field-content-length
│       │   │   ├── MAY.txt
│       │   │   └── MUST NOT.txt
│       │   ├── section-8.6-5-field-content-length
│       │   │   ├── SHOULD NOT.txt
│       │   │   └── SHOULD.txt
│       │   ├── section-8.6-6-field-content-length
│       │   │   ├── MAY.txt
│       │   │   └── MUST NOT.txt
│       │   ├── section-8.6-7-field-content-length
│       │   │   ├── MAY.txt
│       │   │   └── MUST NOT.txt
│       │   ├── section-8.6-8-field-content-length
│       │   │   └── MUST NOT.txt
│       │   ├── section-8.6-9-field-content-length
│       │   │   └── SHOULD.txt
│       │   ├── section-8.7-5-field-content-location
│       │   │   └── MAY.txt
│       │   ├── section-8.7-9-field-content-location
│       │   │   ├── MAY.txt
│       │   │   ├── MUST NOT.txt
│       │   │   └── MUST.txt
│       │   ├── section-8.8.1-7-weak-and-strong-validators
│       │   │   └── SHOULD.txt
│       │   ├── section-8.8.2.1-1-lastmod-generation
│       │   │   └── SHOULD.txt
│       │   ├── section-8.8.2.1-3-lastmod-generation
│       │   │   └── SHOULD.txt
│       │   ├── section-8.8.2.1-4-lastmod-generation
│       │   │   ├── MUST NOT.txt
│       │   │   └── MUST.txt
│       │   ├── section-8.8.2.1-5-lastmod-generation
│       │   │   └── MUST NOT.txt
│       │   ├── section-8.8.3-7-field-etag
│       │   │   └── MUST.txt
│       │   ├── section-8.8.3-8-field-etag
│       │   │   └── MAY.txt
│       │   └── section-8.8.3.1-3-entity-tag-generation
│       │       └── SHOULD.txt
│       └── 9-methods
│           ├── section-9.1-10-method-overview
│           │   └── SHOULD.txt
│           ├── section-9.1-9-method-overview
│           │   ├── MUST.txt
│           │   └── OPTIONAL.txt
│           ├── section-9.2.1-5-safe-methods
│           │   └── SHOULD.txt
│           ├── section-9.2.1-6-safe-methods
│           │   └── MUST.txt
│           ├── section-9.2.2-4-idempotent-methods
│           │   └── SHOULD NOT.txt
│           ├── section-9.2.2-7-idempotent-methods
│           │   ├── MUST NOT.txt
│           │   └── SHOULD NOT.txt
│           ├── section-9.3.1-6-GET
│           │   └── SHOULD NOT.txt
│           ├── section-9.3.1-7-GET
│           │   └── MAY.txt
│           ├── section-9.3.2-1-HEAD
│           │   └── MUST NOT.txt
│           ├── section-9.3.2-2-HEAD
│           │   ├── MAY.txt
│           │   └── SHOULD.txt
│           ├── section-9.3.2-3-HEAD
│           │   └── SHOULD NOT.txt
│           ├── section-9.3.2-4-HEAD
│           │   └── MAY.txt
│           ├── section-9.3.3-4-POST
│           │   └── SHOULD.txt
│           ├── section-9.3.3-6-POST
│           │   └── MAY.txt
│           ├── section-9.3.4-10-PUT
│           │   ├── MAY.txt
│           │   ├── MUST.txt
│           │   └── SHOULD.txt
│           ├── section-9.3.4-2-PUT
│           │   └── MUST.txt
│           ├── section-9.3.4-3-PUT
│           │   └── SHOULD.txt
│           ├── section-9.3.4-7-PUT
│           │   └── SHOULD.txt
│           ├── section-9.3.4-8-PUT
│           │   └── MUST NOT.txt
│           ├── section-9.3.5-4-DELETE
│           │   └── SHOULD.txt
│           ├── section-9.3.5-6-DELETE
│           │   └── SHOULD NOT.txt
│           ├── section-9.3.6-11-CONNECT
│           │   └── SHOULD.txt
│           ├── section-9.3.6-12-CONNECT
│           │   ├── MUST NOT.txt
│           │   └── MUST.txt
│           ├── section-9.3.6-2-CONNECT
│           │   └── MUST.txt
│           ├── section-9.3.6-4-CONNECT
│           │   └── MUST.txt
│           ├── section-9.3.6-6-CONNECT
│           │   └── MAY.txt
│           ├── section-9.3.6-8-CONNECT
│           │   └── MUST.txt
│           ├── section-9.3.7-4-OPTIONS
│           │   └── SHOULD.txt
│           ├── section-9.3.7-5-OPTIONS
│           │   ├── MAY.txt
│           │   └── MUST NOT.txt
│           ├── section-9.3.7-6-OPTIONS
│           │   └── MUST.txt
│           ├── section-9.3.8-1-TRACE
│           │   └── SHOULD.txt
│           ├── section-9.3.8-2-TRACE
│           │   ├── MUST NOT.txt
│           │   └── SHOULD.txt
│           └── section-9.3.8-4-TRACE
│               └── MUST NOT.txt
├── rfc-index.xsd
└── rfc9110.xml

317 directories, 373 files

I believe the structure makes facilitates the discussion of the initiative and the scoping by making the present keywords in each section clear. The rfcs/9110/data directory is meant to contain the test suite, though the exact structure is still to be determined.

Now we’re here. We have the rough implementation of a tool extracting the requirements from RFCs. We have the requirements of RFC 9110 extracted and broken down. The next steps are to define the scopes, the data format definition per scope, the test execution engine (if necessary, present an PoC at minimum), and then the laborious work of translating of requiremnts into test cases may commence. The experts of each area of the RFC are invited to weigh in on the scoping and the data format definition.

The code and the discussion will be on GitHub. The repository is here.

meme

P.S.: I have not abandoned Kadeessh (formerly Caddy-SSH). Life was busy with personal events and an intense project at $DAYJOB. I’m still interested in the Kadeessh and will try to work on it when I can.