MIME-Version: 1.0
References: 
 <CAG2Zi20N98cxpgjfRe6gWw1SQEoux+5P3NhLBFUfUHk_udYeFg@mail.gmail.com>
In-Reply-To: 
 <CAG2Zi20N98cxpgjfRe6gWw1SQEoux+5P3NhLBFUfUHk_udYeFg@mail.gmail.com>
From: Orie Steele <orie@transmute.industries>
Date: Thu, 19 Sep 2024 20:03:34 -0500
Message-ID: 
 <CAN8C-_KDTg2ZatR7tf0K9e19Xz24CrMF06_vB8fc0ZioqZ+oeA@mail.gmail.com>
To: Christopher Patton <cpatton=40cloudflare.com@dmarc.ietf.org>
Content-Type: multipart/alternative; boundary="000000000000764b740622829c6a"
Message-ID-Hash: CRLGIXIJ2OR4VVXY4RIB6L7DDWCMT7NE
CC: CFRG <cfrg@irtf.org>
Precedence: list
Subject: =?utf-8?q?=5BCFRG=5D_Re=3A_Where_should_test_vectors_live=3F?=
Archived-At: 
 <https://mailarchive.ietf.org/arch/msg/cfrg/in7ldlH7dZs5AwlYgWXhEjG2UQo>

--000000000000764b740622829c6a
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable

I like the idea of hosting machine readable test vectors.

The COSE WG has a collection of files under the working group GitHub
organization.

The is also
https://www.iana.org/assignments/yang-parameters/yang-parameters.xhtml

And...
https://www.iana.org/assignments/xml-registry/schema/location-type.xsd

So perhaps there is some possibility of hosting test vectors with IANA.

I would want to ensure that the references made in RFCs are not changed
after publication.

You could consider publishing the hash of the files along with the
references in an appendix.

Hosting the files in a version control system and referencing them that way
seems like the least effort.

OS


On Thu, Sep 19, 2024, 7:17=E2=80=AFPM Christopher Patton <cpatton=3D
40cloudflare.com@dmarc.ietf.org> 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/ma=
ster/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 somewhe=
re
> on datatracker. Is this feasible/desirable?
>
> Thanks,
> Chris P.
>
> _______________________________________________
> CFRG mailing list -- cfrg@irtf.org
> To unsubscribe send an email to cfrg-leave@irtf.org
>

--000000000000764b740622829c6a
Content-Type: text/html; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable

<div dir=3D"auto">I like the idea of hosting machine readable test vectors.=
<div dir=3D"auto"><br></div><div dir=3D"auto">The COSE WG has a collection =
of files under the working group GitHub organization.</div><div dir=3D"auto=
"><br></div><div dir=3D"auto">The is also=C2=A0<a href=3D"https://www.iana.=
org/assignments/yang-parameters/yang-parameters.xhtml" target=3D"_blank" re=
l=3D"noreferrer">https://www.iana.org/assignments/yang-parameters/yang-para=
meters.xhtml</a></div><div dir=3D"auto"><br></div><div dir=3D"auto">And...=
=C2=A0<a href=3D"https://www.iana.org/assignments/xml-registry/schema/locat=
ion-type.xsd">https://www.iana.org/assignments/xml-registry/schema/location=
-type.xsd</a></div><div dir=3D"auto"><br></div><div dir=3D"auto">So perhaps=
 there is some possibility of hosting test vectors with IANA.</div><div dir=
=3D"auto"><br></div><div dir=3D"auto">I would want to ensure that the refer=
ences made in RFCs are not changed after publication.</div><div dir=3D"auto=
"><br></div><div dir=3D"auto">You could consider publishing the hash of the=
 files along with the references in an appendix.</div><div dir=3D"auto"><br=
></div><div dir=3D"auto">Hosting the files in a version control system and =
referencing them that way seems like the least effort.</div><div dir=3D"aut=
o"><br></div><div dir=3D"auto">OS</div><div dir=3D"auto"><br></div></div><b=
r><div class=3D"gmail_quote"><div dir=3D"ltr" class=3D"gmail_attr">On Thu, =
Sep 19, 2024, 7:17=E2=80=AFPM Christopher Patton &lt;cpatton=3D<a href=3D"m=
ailto:40cloudflare.com@dmarc.ietf.org" rel=3D"noreferrer noreferrer" target=
=3D"_blank">40cloudflare.com@dmarc.ietf.org</a>&gt; wrote:<br></div><blockq=
uote class=3D"gmail_quote" style=3D"margin:0 0 0 .8ex;border-left:1px #ccc =
solid;padding-left:1ex"><div dir=3D"ltr"><div>Hi CFRG,</div><div><br></div>=
<div>It occurred to me today that our drafts often have human-friendly test=
 vectors that look something like this:</div><div><a href=3D"https://datatr=
acker.ietf.org/doc/html/rfc9180#appendix-A.1.1" rel=3D"noreferrer noreferre=
r noreferrer" target=3D"_blank">https://datatracker.ietf.org/doc/html/rfc91=
80#appendix-A.1.1</a></div><div><br></div><div>These aren&#39;t super conve=
nient for a machine. In theory you could write a script that downloads <a h=
ref=3D"https://www.rfc-editor.org/rfc/rfc9180.txt" rel=3D"noreferrer norefe=
rrer noreferrer" target=3D"_blank">https://www.rfc-editor.org/rfc/rfc9180.t=
xt</a> and write a parser to pull out the test vectors, but does anyone rea=
lly do this? Luckily for RFC 9180 we have a JSON version to work with inste=
ad:</div><div><a href=3D"https://raw.githubusercontent.com/cfrg/draft-irtf-=
cfrg-hpke/refs/heads/master/test-vectors.json" rel=3D"noreferrer noreferrer=
 noreferrer" target=3D"_blank">https://raw.githubusercontent.com/cfrg/draft=
-irtf-cfrg-hpke/refs/heads/master/test-vectors.json</a></div><div><br></div=
><div>How do folks feel about pointing to machine readable test vectors fro=
m 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 somewher=
e on datatracker. Is this feasible/desirable?</div><div><br></div><div>Than=
ks,</div><div>Chris P.<br></div><br></div>
_______________________________________________<br>
CFRG mailing list -- <a href=3D"mailto:cfrg@irtf.org" rel=3D"noreferrer nor=
eferrer noreferrer" target=3D"_blank">cfrg@irtf.org</a><br>
To unsubscribe send an email to <a href=3D"mailto:cfrg-leave@irtf.org" rel=
=3D"noreferrer noreferrer noreferrer" target=3D"_blank">cfrg-leave@irtf.org=
</a><br>
</blockquote></div>

--000000000000764b740622829c6a--