Re: [Xml-sg-cmt] question on sourcecode type="test-vectors"

Robert Sparks <rjsparks@nostrum.com> Thu, 28 April 2022 17:03 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 33A02C15E6E8 for <xml-sg-cmt@ietfa.amsl.com>; Thu, 28 Apr 2022 10:03:12 -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 9X9J7RHnqj8K for <xml-sg-cmt@ietfa.amsl.com>; Thu, 28 Apr 2022 10:03:08 -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 88CD2C159A22 for <xml-sg-cmt@ietf.org>; Thu, 28 Apr 2022 10:03:08 -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 23SH33nl067011 (version=TLSv1.3 cipher=TLS_AES_256_GCM_SHA384 bits=256 verify=NO); Thu, 28 Apr 2022 12:03:04 -0500 (CDT) (envelope-from rjsparks@nostrum.com)
DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=nostrum.com; s=default; t=1651165384; bh=jM0qg1diLRzpfimCfgCUasyJ2y84NNFjgpHlv/g4TY0=; h=Date:Subject:To:Cc:References:From:In-Reply-To; b=K6RjDZOPBn99CxutibXrB7o8B0JewgHGI9mVgZozs0g+cWfxcMQ6zlMKdxPnMJ5LL 56YHxGj8XyJmQcVOgFDRh2SO4uyvhR+2s7CIdGMPlK1ZcTS+XMaQFpuv38hufraEhA 49tWRq9CCV4HxZATz98UKeOQ+yWgAMb1cln/QY9A=
X-Authentication-Warning: raven.nostrum.com: Host [47.186.48.51] claimed to be [192.168.1.114]
Message-ID: <72767aa0-3847-e4bf-e6da-54935ace1e7f@nostrum.com>
Date: Thu, 28 Apr 2022 12:02:58 -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: John R Levine <johnl@taugh.com>, Alice Russo <arusso@amsl.com>
Cc: "xml-sg-cmt@ietf.org" <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> <9e57234d-1f28-e8ce-132c-22d21dc98346@nostrum.com> <f7f194e3-dd67-e662-21e8-0298d31750f3@taugh.com> <e656a5dd-3130-d550-1744-8df09034a9f3@nostrum.com> <BE9373BB-7A42-40F6-99E4-3F7BEC3C1B23@amsl.com> <1ff4ad28-48f4-9686-b648-78b31d7f4be9@taugh.com>
From: Robert Sparks <rjsparks@nostrum.com>
In-Reply-To: <1ff4ad28-48f4-9686-b648-78b31d7f4be9@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/oy-c_KSD2sgxXrwc2_kKcKQM-Ug>
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: Thu, 28 Apr 2022 17:03:12 -0000

On 4/28/22 11:59 AM, John R Levine wrote:
>>> would wfm, but futureproofing might argue for rfcnnnn-test-vector.
>>>
>>> (Generalizing for some future nnnn having multiple things to test: 
>>> rfcnnnn-simplealg-test-vector, rfcnnnn-mti-test-vector, ...)
>>
>> FWIW, seems there's some precedent for "a more descriptive type" 
>> (without the RFC number):
>>
>> rfc8998.notprepped.xml:      <section anchor="sm4-gcm-test-vectors" 
>> numbered="true" toc="default">
>> rfc8998.notprepped.xml:      <section anchor="sm4-ccm-test-vectors" 
>> numbered="true" toc="default">
>> rfc9106.notprepped.xml:      <section anchor="argon2d-test-vectors" 
>> numbered="true" toc="default">
>> rfc9106.notprepped.xml:      <section anchor="argon2i-test-vectors" 
>> numbered="true" toc="default">
>> rfc9106.notprepped.xml:      <section anchor="argon2id-test-vectors" 
>> numbered="true" toc="default">
>
> I realize we're into bikeshed territory, but I'd rather have the test 
> vector name describe what's being tested than the RFC in which they 
> were defned.  If RFC1234 defines something, and then RFC3456 adds some 
> new options, are the test vectors rfc1234-test-vector or 
> rfc3456-test-vector or something else?

You're calling out exactly why I half-heartedly suggested having the rfc 
number in the name, but there are clearly other ways that such things 
could be disambiguated.

Julian pointed out that the import thing here is that there is _some_ 
label. I'm still bouncing on how hard to push that this kind of thing 
always be sourcecode now, but I think it's not doing harm in the 
concrete question we're asking for the soon to be rfc.

RjS

>
> Regards,
> John Levine, johnl@taugh.com, Taughannock Networks, Trumansburg NY
> Please consider the environment before reading this e-mail. https://jl.ly