Re: [CFRG] [EXT] Re: Adoption Call: Guidelines for Writing Cryptography Specifications

Thom Wiggers <thom@thomwiggers.nl> Wed, 21 June 2023 06:20 UTC

Return-Path: <thom@thomwiggers.nl>
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 D95FDC151086 for <cfrg@ietfa.amsl.com>; Tue, 20 Jun 2023 23:20:04 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.096
X-Spam-Level:
X-Spam-Status: No, score=-2.096 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, HTML_MESSAGE=0.001, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_ZEN_BLOCKED_OPENDNS=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-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 (1024-bit key) header.d=thomwiggers.nl
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 3bOgMNzaLT4t for <cfrg@ietfa.amsl.com>; Tue, 20 Jun 2023 23:20:01 -0700 (PDT)
Received: from mail-pj1-x102f.google.com (mail-pj1-x102f.google.com [IPv6:2607:f8b0:4864:20::102f]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 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 06F6AC14CEFF for <cfrg@ietf.org>; Tue, 20 Jun 2023 23:20:00 -0700 (PDT)
Received: by mail-pj1-x102f.google.com with SMTP id 98e67ed59e1d1-25eb3db3004so2550195a91.0 for <cfrg@ietf.org>; Tue, 20 Jun 2023 23:20:00 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=thomwiggers.nl; s=google; t=1687328400; x=1689920400; h=cc:to:subject:message-id:date:from:in-reply-to:references :mime-version:from:to:cc:subject:date:message-id:reply-to; bh=DuHGUw2YSyrLgCFm6EXmbxYL3V7krUeGv6vZZu5/4Y0=; b=C5fQNJLNlFP6ghYhhy88c18x4TdOc25uoCwEX0hWPwAgxmoeNG15nAJaJMw6h+2Z4x bGkCVhsDOVt2mm3KsAAelIfX8nzS7+L8tygnBb4bqYug7GxBgQaPSaL7089IAO++koZh jO/4XmPdllEuSZ+nSSTyP4HgLKkZzK2OKyOSM=
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1687328400; x=1689920400; 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=DuHGUw2YSyrLgCFm6EXmbxYL3V7krUeGv6vZZu5/4Y0=; b=F1vSOm2z97sOsg3X5zxBKo8LtC32ssfuGtJbCC5dvT0UWg0RqwenGCAhMPta0uD8sT FVsEtevx56gcnVVq6h1iFNRiosbuw1+Y5QqbECDCGQskSk6JJHCQ0XYcVdxvgysaxcmz To7arGEOo6yWJlg8ObuxbILuXgL1CitVQkfyos3OCi0Jphd8t8xAUxhiNTlBKmOmfDx4 mdDUem/8sDNUJoqpZYzZqzPIR1s/4zwMtNPwXhBotxdkixHLpEveHEktQ3W8ug4g55Jn q2v9IFgjv79hmebe6G0sDCR64BaLyC8RUzRXKAK4BjHwcBNf+RXq9LikeGcCbW0lOg4d MzUA==
X-Gm-Message-State: AC+VfDwl4ceEGAbzRK70vpVUtCs9gn2OEBpknBHTOYCc4m4Le5bGJckj OdFmiTkxMnVFFqj1ZGN0g/cJ1f+Bv4V765usryI6gg==
X-Google-Smtp-Source: ACHHUZ4Jp2s0j28RsLb2uxGcU276u1dLRbWf+oTh4PBXXuweFWOYyLX2XM0PwXBHsQ6vLHVj2/SEiEzoxajG2g3d7kc=
X-Received: by 2002:a17:90a:4e:b0:25b:b2ba:2ff4 with SMTP id 14-20020a17090a004e00b0025bb2ba2ff4mr9130967pjb.17.1687328400179; Tue, 20 Jun 2023 23:20:00 -0700 (PDT)
MIME-Version: 1.0
References: <CAMr0u6=oLzn1SzzuO5X4aLw2neRf=bqMJpMOB4h3ERTO4Ao-WA@mail.gmail.com> <CABzBS7nOGDXdLkrKECbBxVorpko7_efFcVZXpA_978xiKLRFBQ@mail.gmail.com> <DA6A8482-B9B2-422B-A8AF-1FC296037601@ll.mit.edu>
In-Reply-To: <DA6A8482-B9B2-422B-A8AF-1FC296037601@ll.mit.edu>
From: Thom Wiggers <thom@thomwiggers.nl>
Date: Wed, 21 Jun 2023 08:19:43 +0200
Message-ID: <CABzBS7kGy=v9k0fJSq+JKawpBpASUQAjvcKMtAJ_fxgcVPk48g@mail.gmail.com>
To: "Blumenthal, Uri - 0553 - MITLL" <uri@ll.mit.edu>
Cc: "Stanislav V. Smyshlyaev" <smyshsv@gmail.com>, "<cfrg@ietf.org>" <cfrg@ietf.org>, "cfrg-chairs@ietf.org" <cfrg-chairs@ietf.org>
Content-Type: multipart/alternative; boundary="000000000000e99aad05fe9dc1b1"
Archived-At: <https://mailarchive.ietf.org/arch/msg/cfrg/78szwLh5H_eLAXYfwuxZvJp5eD4>
Subject: Re: [CFRG] [EXT] Re: Adoption Call: Guidelines for Writing Cryptography Specifications
X-BeenThere: cfrg@irtf.org
X-Mailman-Version: 2.1.39
Precedence: list
List-Id: Crypto Forum Research Group <cfrg.irtf.org>
List-Unsubscribe: <https://www.irtf.org/mailman/options/cfrg>, <mailto:cfrg-request@irtf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/cfrg/>
List-Post: <mailto:cfrg@irtf.org>
List-Help: <mailto:cfrg-request@irtf.org?subject=help>
List-Subscribe: <https://www.irtf.org/mailman/listinfo/cfrg>, <mailto:cfrg-request@irtf.org?subject=subscribe>
X-List-Received-Date: Wed, 21 Jun 2023 06:20:04 -0000

Hi Uri,

Op di 20 jun 2023 om 18:45 schreef Blumenthal, Uri - 0553 - MITLL <
uri@ll.mit.edu>:

> >> For example, when describing group operations using multiplicative
> notation,
> >> the multiplication symbol * should be used instead of the x symbol.
> >
> > Say, some field uses another notation; e.g. [k]P for scalar
> multiplication
> > in elliptic curves.
>
> Respectfully disagree. While some respected publications do use [k]P
> notation, other respected publications and textbooks do use k*P for scalar
> multiplication in EC.
>

Of course, this was just the first example that came to mind; surely there
are better examples. And of course, many in mathematics leave out
multiplication symbols altogether.

>
> > Should authors stick with what is familiar in the context of their
> specification,
> > or should they try to be consistent with the recommendations in this
> draft?
>
> I see no harm in following recommendations of this draft - though it's not
> a normative reference, aka - it shouldn't be enforced.
>

I guess that my main point is that this draft might want to, albeit phrased
softer and differently, say something similar to rule 6 in Orwell's rules
for writing (which have significant overlap with the draft, now that I see
them side-by-side); thus avoiding (less-experienced) authors/editors
enforcing it by themselves.


>    1. Never use a metaphor, simile, or other figure of speech which you
>    are used to seeing in print.
>    2. Never use a long word where a short one will do.
>    3. If it is possible to cut a word out, always cut it out.
>    4. Never use the passive where you can use the active.
>    5. Never use a foreign phrase, a scientific word, or a jargon word if
>    you can think of an everyday English equivalent.
>    6. Break any of these rules sooner than say anything outright
>    barbarous.
>
> But again, this suggestion is really one of the few things I could think
of that might be useful to consider; the draft is well-rounded.

Cheers,

Thom


>
> TNX
>