[CFRG] Re: Where should test vectors live?

[Orie Steele <[e-mail]>]

Richard beat me to it, but here is another link for including source code
in XML RFCs.

https://authors.ietf.org/rfcxml-vocabulary

I suspect developers would probably prefer direct links to files over
parsing content out of XML or HTML, but that's always an option.

OS


On Thu, Sep 19, 2024, 8:14 PM Richard Barnes <[e-mail]> wrote:

> FWIW, RFC 6716 contains the source code of a reference implementation, and
> instructions for how to extract and build the code from the RFC:
>
> https://datatracker.ietf.org/doc/html/rfc6716#appendix-A.1
>
> You could do a similar thing with test vectors.
>
> On Thu, Sep 19, 2024 at 9:10 PM Watson Ladd <[e-mail]> wrote:
>
>>
>>
>> On Thu, Sep 19, 2024, 5:18 PM Christopher Patton <cpatton=
>> [e-mail]> wrote:
>>
>>> Hi CFRG,
>>>
>>> It occurred to me today that our drafts often have human-friendly test
>>> vectors that look something like this:
>>> https://datatracker.ietf.org/doc/html/rfc9180#appendix-A.1.1
>>>
>>> These aren't super convenient for a machine. In theory you could write a
>>> script that downloads https://www.rfc-editor.org/rfc/rfc9180.txt and
>>> write a parser to pull out the test vectors, but does anyone really do
>>> this? Luckily for RFC 9180 we have a JSON version to work with instead:
>>>
>>> https://raw.githubusercontent.com/cfrg/draft-irtf-cfrg-hpke/refs/heads/master/test-vectors.json
>>>
>>> How do folks feel about pointing to machine readable test vectors from
>>> an RFC in lieu of producing human-friendly, but machine-unfriendly in the
>>> appendix? Suppose for example an RFC had a pointer to a JSON blob somewhere
>>> on datatracker. Is this feasible/desirable?
>>>
>>
>> Why not in ignored elements (not sure how to do)in the XML source? This
>> might take some tools team input.
>>
>>>
>>> Thanks,
>>> Chris P.
>>>
>>> _______________________________________________
>>> CFRG mailing list -- [e-mail]
>>> To unsubscribe send an email to [e-mail]
>>>
>> _______________________________________________
>> CFRG mailing list -- [e-mail]
>> To unsubscribe send an email to [e-mail]
>>
> _______________________________________________
> CFRG mailing list -- [e-mail]
> To unsubscribe send an email to [e-mail]
>