Re: [Xml-sg-cmt] question on sourcecode type="test-vectors"
Robert Sparks <rjsparks@nostrum.com> Tue, 26 April 2022 23:12 UTC
Return-Path: <rjsparks@nostrum.com>
X-Original-To: xml-sg-cmt@ietfa.amsl.com
Delivered-To: xml-sg-cmt@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id D00B9C1854A2 for <xml-sg-cmt@ietfa.amsl.com>; Tue, 26 Apr 2022 16:12:19 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -3.936
X-Spam-Level:
X-Spam-Status: No, score=-3.936 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, NICE_REPLY_A=-1.857, T_SPF_HELO_PERMERROR=0.01, T_SPF_PERMERROR=0.01, URIBL_BLOCKED=0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (1024-bit key) header.d=nostrum.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 WxLuWOjls3PM for <xml-sg-cmt@ietfa.amsl.com>; Tue, 26 Apr 2022 16:12:15 -0700 (PDT)
Received: from nostrum.com (raven-v6.nostrum.com [IPv6:2001:470:d:1130::1]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 7C034C18549F for <xml-sg-cmt@ietf.org>; Tue, 26 Apr 2022 16:12:15 -0700 (PDT)
Received: from [192.168.1.114] ([47.186.48.51]) (authenticated bits=0) by nostrum.com (8.17.1/8.16.1) with ESMTPSA id 23QNCDE8025868 (version=TLSv1.3 cipher=TLS_AES_256_GCM_SHA384 bits=256 verify=NO) for <xml-sg-cmt@ietf.org>; Tue, 26 Apr 2022 18:12:14 -0500 (CDT) (envelope-from rjsparks@nostrum.com)
DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=nostrum.com; s=default; t=1651014734; bh=Xrc6JdRWangJ6UiF48P6LY4E1bNofvacUv/E33g5sDY=; h=Date:Subject:To:References:From:In-Reply-To; b=RzR3gBW3O5naP8MJSBoWZscKhqm7v6Jjwqcwj4SV350pmRPh3VuU+DfwPj5rELnDu oIzhzY8yreK27tKcRdtUAC7m48cIBq/RImqAinlFr2/9ea/m+Bgiq5GQ94guaJcKlI E5ke42TabM9M8+T/Bn3r0IS8OF9Hj86NHzBhWHa4=
X-Authentication-Warning: raven.nostrum.com: Host [47.186.48.51] claimed to be [192.168.1.114]
Message-ID: <9e57234d-1f28-e8ce-132c-22d21dc98346@nostrum.com>
Date: Tue, 26 Apr 2022 18:12:08 -0500
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:91.0) Gecko/20100101 Thunderbird/91.8.1
Content-Language: en-US
To: xml-sg-cmt@ietf.org
References: <66806B6E-AEF2-4D4E-B3AD-66E7117EB3DC@amsl.com> <f76577a7-72c6-a2ff-61a2-caf836cf5d03@taugh.com> <d01ec942-e56b-4146-0e0b-3e44da9c47e3@taugh.com>
From: Robert Sparks <rjsparks@nostrum.com>
In-Reply-To: <d01ec942-e56b-4146-0e0b-3e44da9c47e3@taugh.com>
Content-Type: text/plain; charset="UTF-8"; format="flowed"
Content-Transfer-Encoding: 8bit
Archived-At: <https://mailarchive.ietf.org/arch/msg/xml-sg-cmt/BUcbl-o_KcE5Bs68KQI6iZMp0ZE>
Subject: Re: [Xml-sg-cmt] question on sourcecode type="test-vectors"
X-BeenThere: xml-sg-cmt@ietf.org
X-Mailman-Version: 2.1.34
Precedence: list
List-Id: Working list for the xml and style guide change management team <xml-sg-cmt.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/xml-sg-cmt>, <mailto:xml-sg-cmt-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/xml-sg-cmt/>
List-Post: <mailto:xml-sg-cmt@ietf.org>
List-Help: <mailto:xml-sg-cmt-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/xml-sg-cmt>, <mailto:xml-sg-cmt-request@ietf.org?subject=subscribe>
X-List-Received-Date: Tue, 26 Apr 2022 23:12:19 -0000
These things aren't mime-types, otherwise we would just have adopted mime markup. Having what you have to _do_ with a name be document agnostic doesn't strike me as the right barrier. This document demonstrates that labeling these things clearly, so that (yes custom) code can pull these out using xml tools is _helpful_. It would be an even stronger demonstration if there were other sourcecode blocks with a different type, but I can envision such a thing easily enough. I would certainly have used them back when we did the sip-certs draft (with its worked examples). Throwing away that semantic hint by putting these in artwork seems ruinous to me. RjS On 4/26/22 5:40 PM, John R Levine wrote: >>> Any recommendation on best markup? Potential paths include: >>> a) leave as they are >>> b) change all to <artwork> >>> c) change all to <sourcecode> without type set >> >> Looks like artwork to me. It's a bunch of examples but nothing that >> looks machine parsed. > > Having seen Robert's note, I agree you could write a special purpose > thing to process these particular examples, but you could do that with > a lot of examples. If we say it's "test-vector" that says to me that > future things marked test-vector could be parsed the same way which > seems unlikely. > > R's, > John > >>> When asked to review the sourcecode type, the author wrote: >>>> As to the sourcecode mark in in each entry, there are separate >>>> components: an initial sequence number (ISN), a traffic key, the >>>> output of a packet dump, and the MAC (message authentication code). >>>> None of these are actually “sourcecode”. I don’t know what portions >>>> qualify as a “test-vector”. So I don’t know whether this marking is >>>> correct or how best to adjust it if not. >>> >>> >>> Thanks, >>> Alice >>> -- >>> >>> Examples of how type="test-vectors" has been used in the past (full >>> list below): >>> >>> https://www.rfc-editor.org/rfc/rfc9048.html#appendix-D >>> https://www.rfc-editor.org/rfc/rfc9180.html#appendix-A.1.1 (and lots >>> more) >>> https://www.rfc-editor.org/rfc/rfc9189.html#appendix-A.1.1.1 (and a >>> few more) >>> (It becomes <pre class="sourcecode lang-test-vectors"> in the HTML >>> file.) >>> >>> [files in www.rfc-editor.org/in-notes/prerelease/] >>> >>> rfc8696.notprepped.xml: <sourcecode >>> type="test-vectors">< = fdcbc20c, >>> rfc8891.notprepped.xml: <sourcecode >>> type="test-vectors"><![CDATA[K = >>> ffeeddccbbaa99887766554433221100f0f1f2f3f4f5f6f7f8f9fafbfcfdfeff,]]></sourcecode> >>> rfc8891.notprepped.xml: <sourcecode >>> type="test-vectors"><![CDATA[K_1 = ffeeddcc, >>> rfc8891.notprepped.xml: <sourcecode >>> type="test-vectors"><![CDATA[ >>> rfc8891.notprepped.xml: <sourcecode >>> type="test-vectors"><![CDATA[(a_1, a_0) = (fedcba98, 76543210), >>> rfc8891.notprepped.xml: <sourcecode >>> type="test-vectors"><![CDATA[b = G^*[K_32]G[K_31]...G[K_1](a_1, a_0) >>> = 4ee901e5c2d8ca3d.]]></sourcecode> >>> rfc8891.notprepped.xml: <sourcecode >>> type="test-vectors"><![CDATA[b = 4ee901e5c2d8ca3d,]]></sourcecode> >>> rfc8891.notprepped.xml: <sourcecode >>> type="test-vectors"><![CDATA[(b_1, b_0) = (4ee901e5, c2d8ca3d), >>> rfc8891.notprepped.xml: <sourcecode >>> type="test-vectors"><![CDATA[a = G^*[K_1]G[K_2]...G[K_32](b_1, b_0) >>> = fedcba9876543210.]]></sourcecode> >>> rfc9048.notprepped.xml: <sourcecode type="test-vectors"><![CDATA[ >>> rfc9048.notprepped.xml: <sourcecode type="test-vectors"><![CDATA[ >>> rfc9048.notprepped.xml: <sourcecode type="test-vectors"><![CDATA[ >>> rfc9048.notprepped.xml: <sourcecode type="test-vectors"><![CDATA[ >>> rfc9106.notprepped.xml:<sourcecode type="test-vectors"> >>> rfc9106.notprepped.xml:<sourcecode type="test-vectors"> >>> rfc9106.notprepped.xml:<sourcecode type="test-vectors"> >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9180.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9227.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9227.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9227.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9227.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9227.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9227.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9227.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> rfc9227.notprepped.xml: <sourcecode name="" >>> type="test-vectors"><![CDATA[ >>> >> >> Regards, >> John Levine, johnl@taugh.com, Taughannock Networks, Trumansburg NY >> Please consider the environment before reading this e-mail. >> https://jl.ly >> >> > > Regards, > John Levine, johnl@taugh.com, Taughannock Networks, Trumansburg NY > Please consider the environment before reading this e-mail. https://jl.ly >
- [Xml-sg-cmt] question on sourcecode type="test-ve… Alice Russo
- Re: [Xml-sg-cmt] question on sourcecode type="tes… Robert Sparks
- Re: [Xml-sg-cmt] question on sourcecode type="tes… John R Levine
- Re: [Xml-sg-cmt] question on sourcecode type="tes… John R Levine
- Re: [Xml-sg-cmt] question on sourcecode type="tes… Robert Sparks
- Re: [Xml-sg-cmt] question on sourcecode type="tes… Robert Sparks
- Re: [Xml-sg-cmt] question on sourcecode type="tes… John R Levine
- Re: [Xml-sg-cmt] question on sourcecode type="tes… Robert Sparks
- Re: [Xml-sg-cmt] question on sourcecode type="tes… Julian Reschke
- Re: [Xml-sg-cmt] question on sourcecode type="tes… John R Levine
- Re: [Xml-sg-cmt] question on sourcecode type="tes… Julian Reschke
- Re: [Xml-sg-cmt] question on sourcecode type="tes… Alice Russo
- Re: [Xml-sg-cmt] question on sourcecode type="tes… John R Levine
- Re: [Xml-sg-cmt] question on sourcecode type="tes… Robert Sparks
- Re: [Xml-sg-cmt] question on sourcecode type="tes… Carsten Bormann