Return-Path: X-Original-To: cfrg@ietfa.amsl.com Delivered-To: cfrg@ietfa.amsl.com Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id D573BC1840CB for ; Fri, 20 Sep 2024 15:36:26 -0700 (PDT) X-Virus-Scanned: amavisd-new at amsl.com X-Spam-Flag: NO X-Spam-Score: -2.104 X-Spam-Level: X-Spam-Status: No, score=-2.104 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIMWL_WL_MED=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, HTML_MESSAGE=0.001, RCVD_IN_ZEN_BLOCKED_OPENDNS=0.001, SPF_HELO_NONE=0.001, SPF_NONE=0.001, T_SCC_BODY_TEXT_LINE=-0.01, URIBL_BLOCKED=0.001, URIBL_DBL_BLOCKED_OPENDNS=0.001, URIBL_ZEN_BLOCKED_OPENDNS=0.001] autolearn=ham autolearn_force=no Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (2048-bit key) header.d=cloudflare.com Received: from mail.ietf.org ([50.223.129.194]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id wlgOp9iAv6cH for ; Fri, 20 Sep 2024 15:36:22 -0700 (PDT) Received: from mail-qt1-x82d.google.com (mail-qt1-x82d.google.com [IPv6:2607:f8b0:4864:20::82d]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits) key-exchange X25519 server-signature ECDSA (P-256) server-digest SHA256) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id E373BC1840C1 for ; Fri, 20 Sep 2024 15:36:22 -0700 (PDT) Received: by mail-qt1-x82d.google.com with SMTP id d75a77b69052e-45821eb62daso13529181cf.3 for ; Fri, 20 Sep 2024 15:36:22 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=cloudflare.com; s=google09082023; t=1726871781; x=1727476581; darn=irtf.org; h=cc:to:subject:message-id:date:from:in-reply-to:references :mime-version:from:to:cc:subject:date:message-id:reply-to; bh=qXkN6f78AXYeFGIhiQBtIxyz4WU570uoR63od0+zZAw=; b=VdyHf0JwBNlKXf22nEJdrqAanPaAiiPXiYCrK78u+MtyriCP2Yfx0Z3s/YJK+jVGDs y0gRtiVRdNb9gigIBUdbZ6DLLe4pR1NMeljzMavWJXKlj4joRKeOwWJisFB/ZkTlNtt6 Lnv3xf+islK/bpkCtOa1gElsO8Ng3cAWIVmSNzBBlz/u6KBrEBbhQOww1BzxtCBTtwuE MphzQkrVlmmNjdvY6xVlG6fAHjqcoYNWOV7Rd537tJ8+ozRgjLdptxGEFJskQguuQnnt gorE2NmtDd6/QKWtfIKdaZf84DK+6GVXv5yS240WhmPz1GG1GDOC73MTAY7YVUCx8oFK iETw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1726871782; x=1727476582; h=cc:to:subject:message-id:date:from:in-reply-to:references :mime-version:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=qXkN6f78AXYeFGIhiQBtIxyz4WU570uoR63od0+zZAw=; b=tGYiB2RO1dMcEFf4i68UTJYT2TYUSU7L7KsVhXVSki9ULtPGd3ir0C34eX+Y/Xq9c2 nrh0munsNgLPUy+PNb6g6XxtOvufP0G+kfx4eRdxjP2n1jgWQAW7mFkOMtCVLbVNard6 QcW8w/rfNYG9h7GCp7oskLpY4lqysbF7Q+tYH/7b7w1c0hHKL5TyNfpVPhz10ZcVBaRC wRezoNMoEYK9EylvIKNjrVrjUiuDAu9C+ezDem0VOfaAgqsmc8QhVhO6WrZgS6l9tNHC w5CBLVc+KAnqppFGlAgr63L9kJX4BqxwQis0MiC96VXCMw3bC/cDuQSi88WlIMYWP2O1 oq/w== X-Forwarded-Encrypted: i=1; AJvYcCXklxoYQXUHjLYWIHm9toKuhofrNsCPTJbzkGI8MItDNTOn041DaNrf2oOBttJCAxlgwwfC@irtf.org X-Gm-Message-State: AOJu0Yy9ogqvJ4Bu4A1CXAzbgb+0fPk/JbCS9RHY3BVvvx4qmVeaNrsj 0PWGAwxipRpg02dUT68kbuXZZOoWVkXxm+RxkLZKasu7RIcFz6fTPR17I+FjSDAYWezH+M9zxk2 AaEg4p/PFP75c4J4kmDzy5yvy963SHz9ksMYE0g== X-Google-Smtp-Source: AGHT+IHxaqm6bN1wl4lOa0CTGRQaWqZdoyBMEABM3W37OVaht8uCa6+fF8dCNT7016wQxkX43gh9tN0mMKxjPbmE+xQ= X-Received: by 2002:a05:622a:d1:b0:458:3cc4:74fb with SMTP id d75a77b69052e-45b2053c5bcmr50344391cf.37.1726871781596; Fri, 20 Sep 2024 15:36:21 -0700 (PDT) MIME-Version: 1.0 References: <967BBF38-8C46-4ADC-BE41-47CAE7B7A235@csperkins.org> In-Reply-To: From: Christopher Patton Date: Fri, 20 Sep 2024 15:36:09 -0700 Message-ID: To: Jean Mahoney Content-Type: multipart/alternative; boundary="0000000000001d7f7a062294ab0f" Message-ID-Hash: WBP4ZWN3NOCZRVADI7IQSCM2C4TPPZEE X-Message-ID-Hash: WBP4ZWN3NOCZRVADI7IQSCM2C4TPPZEE X-MailFrom: cpatton@cloudflare.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; header-match-cfrg.irtf.org-0; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header CC: Colin Perkins , CFRG , RFC Editor X-Mailman-Version: 3.3.9rc4 Precedence: list Subject: =?utf-8?q?=5BCFRG=5D_Re=3A_Where_should_test_vectors_live=3F?= List-Id: Crypto Forum Research Group Archived-At: List-Archive: List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: --0000000000001d7f7a062294ab0f Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Jean, Thanks for confirming! Chris P. On Fri, Sep 20, 2024 at 2:55=E2=80=AFPM Jean Mahoney wr= ote: > Hi Colin, > > On 9/20/24 2:00 PM, Colin Perkins wrote: > > Hi, > > > > For links from RFCs to GitHub, I=E2=80=99ve copied the RFC Editor to ge= t a > > definitive ruling. My feeling is that we wouldn=E2=80=99t want links to= personal > > GitHub pages, but it might make sense to link to GitHub repos owned by > > the research group since they=E2=80=99re perhaps more likely to be long= -term > > stable. Presumably the github links would be informative rather than > > normative? > > [JM] Yes, GitHub repos may be referenced informatively. Please see > > > If you choose to include test vectors within a document, we recommend > that they be labeled (or if you are > writing in kramdown-rfc: ~~~ test-vectors). This label can help a reader > extract the content. More info on sourcecode types may be found here: > > > For an example of an RFC that includes test vectors in the document and > also provides an informative GitHub reference, please see > https://www.rfc-editor.org/rfc/rfc9605#appendix-C > > Best regards, > RFC Editor/jm > > > > > For the additional resources, look at > > https://datatracker.ietf.org/doc/draft-ietf-lamps-csr-attestation/ > > or > > https://datatracker.ietf.org/doc/draft-irtf-cfrg-aegis-aead/ > > for > > examples (in the Document section). The datatracker lets you, where I > > think =E2=80=9Cyou=E2=80=9D is the relevant RG/WG chair, specify the fo= llowing for each > > draft: faq, github_org, github_repo, github_username, gitlab_repo, > > gitlab_username, jabber_log, jabber_room, mailing_list, > > mailing_list_archive, related_implementations, repo, slack, tracker, > > webpage, wiki, yc_entry, yc_impact, zulip (each can occur multiple > times). > > > > Cheers, > > Colin > > > > > > > > On 20 Sep 2024, at 18:28, Christopher Patton wrote: > > > > Colin, > > > > What would be the contents of the "Additional resources" field? > > Would it just be a link to GitHub? Ideally the RFC itself would tel= l > > you where to get test vectors: do you think it's inappropriate for > > the RFC itself to link to GitHub? > > > > Chris P. > > > > On Fri, Sep 20, 2024 at 10:03=E2=80=AFAM Colin Perkins > > wrote: > > > > Hi, > > > > The datatracker has an =E2=80=9CAdditional resources=E2=80=9D f= ield for each > > draft, that can be used to cross-reference to GitHub repos, etc= . > > > > Colin > > > > > > On 20 Sep 2024, at 1:17, Christopher Patton 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 > > < > 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 wor= k > > with instead: > > > https://raw.githubusercontent.com/cfrg/draft-irtf-cfrg-hpke/refs/heads/ma= ster/test-vectors.json > < > 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, bu= t > > machine-unfriendly in the appendix? Suppose for example an > > RFC had a pointer to a JSON blob somewhere 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 > > > > > --0000000000001d7f7a062294ab0f Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable
Jean,

Thanks for confirming!=

Chris P.

On Fri, Sep 20, 2024 at 2:55=E2= =80=AFPM Jean Mahoney <jmahoney@ams= l.com> wrote:
Hi Colin,

On 9/20/24 2:00 PM, Colin Perkins wrote:
> Hi,
>
> For links from RFCs to GitHub, I=E2=80=99ve copied the RFC Editor to g= et a
> definitive ruling. My feeling is that we wouldn=E2=80=99t want links t= o personal
> GitHub pages, but it might make sense to link to GitHub repos owned by=
> the research group since they=E2=80=99re perhaps more likely to be lon= g-term
> stable. Presumably the github links would be informative rather than <= br> > normative?

[JM] Yes, GitHub repos may be referenced informatively. Please see
<https://www.rfc-editor.org/styleguide/par= t2/#ref_repo>

If you choose to include test vectors within a document, we recommend
that they be labeled <sourcecode type=3D"test-vectors"> (or= if you are
writing in kramdown-rfc: ~~~ test-vectors). This label can help a reader extract the content. More info on sourcecode types may be found here:
<https://www.rfc-editor.org/rpc= /wiki/doku.php?id=3Dsourcecode-types>

For an example of an RFC that includes test vectors in the document and also provides an informative GitHub reference, please see
https://www.rfc-editor.org/rfc/rfc9605#appendix-C

Best regards,
RFC Editor/jm

>
> For the additional resources, look at
> https://datatracker.ietf.org/= doc/draft-ietf-lamps-csr-attestation/
> <https://datatracker.ietf.= org/doc/draft-ietf-lamps-csr-attestation/> or
> https://datatracker.ietf.org/doc/dr= aft-irtf-cfrg-aegis-aead/
> <https://datatracker.ietf.org/do= c/draft-irtf-cfrg-aegis-aead/> for
> examples (in the Document section). The datatracker lets you, where I =
> think =E2=80=9Cyou=E2=80=9D is the relevant RG/WG chair, specify the f= ollowing for each
> draft: faq, github_org, github_repo, github_username, gitlab_repo, > gitlab_username, jabber_log, jabber_room, mailing_list,
> mailing_list_archive, related_implementations, repo, slack, tracker, <= br> > webpage, wiki, yc_entry, yc_impact, zulip (each can occur multiple tim= es).
>
> Cheers,
> Colin
>
>
>
> On 20 Sep 2024, at 18:28, Christopher Patton wrote:
>
>=C2=A0 =C2=A0 =C2=A0Colin,
>
>=C2=A0 =C2=A0 =C2=A0What would be the contents of the "Additional = resources" field?
>=C2=A0 =C2=A0 =C2=A0Would it just be a link to GitHub? Ideally the RFC = itself would tell
>=C2=A0 =C2=A0 =C2=A0you where to get test vectors: do you think it'= s inappropriate for
>=C2=A0 =C2=A0 =C2=A0the RFC itself to link to GitHub?
>
>=C2=A0 =C2=A0 =C2=A0Chris P.
>
>=C2=A0 =C2=A0 =C2=A0On Fri, Sep 20, 2024 at 10:03=E2=80=AFAM Colin Perk= ins <csp@csperkin= s.org
>=C2=A0 =C2=A0 =C2=A0<mailto:csp@csperkins.org>> wrote:
>
>=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0Hi,
>
>=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0The datatracker has an =E2=80=9CAddit= ional resources=E2=80=9D field for each
>=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0draft, that can be used to cross-refe= rence to GitHub repos, etc.
>
>=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0Colin
>
>
>=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0On 20 Sep 2024, at 1:17, Christopher = Patton wrote:
>
>=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0Hi CFRG,
>
>=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0It occurred to me today= that our drafts often have
>=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0human-friendly test vec= tors that look something like this:
>=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0https://datatracker.ietf.org/doc/html/rfc9180#appendix-A.1.1
>=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0<https://datatracker.ietf.org/doc/html/rfc9180#appendix-A.1.= 1>
>
>=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0These aren't super = convenient for a machine. In theory you
>=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0could write a script th= at downloads
>=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0https:= //www.rfc-editor.org/rfc/rfc9180.txt
>=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0<ht= tps://www.rfc-editor.org/rfc/rfc9180.txt> and write a
>=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0parser to pull out the = test vectors, but does anyone really
>=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0do this? Luckily for RF= C 9180 we have a JSON version to work
>=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0with instead:
>=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0https://raw.githubuserconten= t.com/cfrg/draft-irtf-cfrg-hpke/refs/heads/master/test-vectors.json <= ;http= s://raw.githubusercontent.com/cfrg/draft-irtf-cfrg-hpke/refs/heads/master/t= est-vectors.json>
>
>=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0How do folks feel about= pointing to machine readable test
>=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0vectors from an RFC in = lieu of producing human-friendly, but
>=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0machine-unfriendly in t= he appendix? Suppose for example an
>=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0RFC had a pointer to a = JSON blob somewhere on datatracker.
>=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0Is this feasible/desira= ble?
>
>=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0Thanks,
>=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0Chris P.
>
>=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0_______________________= ________________________
>=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0CFRG mailing list -- cfrg@irtf.org <mail= to:cfrg@irtf.org>=
>=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0To unsubscribe send an = email to cfrg-leav= e@irtf.org
>=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0<mailto:cfrg-leave@irtf.org> >
--0000000000001d7f7a062294ab0f--