diff --git a/.gitignore b/.gitignore index d30f756a..5d12ca97 100644 --- a/.gitignore +++ b/.gitignore @@ -21,3 +21,6 @@ venv/ lib draft-ietf-mls-protocol.xml draft-ietf-mls-protocol.tls + +# AUTH48 temporary artifacts +auth48/rfc9420.gen.xml diff --git a/auth48/Makefile b/auth48/Makefile new file mode 100644 index 00000000..8c0b6d74 --- /dev/null +++ b/auth48/Makefile @@ -0,0 +1,28 @@ +DRAFT=draft-ietf-mls-protocol +RFC=9420 +RFC_ED_URL="https://www.rfc-editor.org/authors/rfc${RFC}.xml" + +.PHONY: prepare gen diff + +init: + curl -s ${RFC_ED_URL} | \ + xmllint --exc-c14n - | \ + xmllint --format - \ + >rfc${RFC}.authors.xml + +gen: rfc${RFC}.gen.xml + +rfc${RFC}.gen.xml: ../${DRAFT}.md + make -C .. ${DRAFT}.xml + mv ../${DRAFT}.xml . + python3 xml-clean.py <${DRAFT}.xml | \ + xmllint --exc-c14n - | \ + xmllint --format - | \ + python3 text-clean.py >rfc${RFC}.gen.xml + rm ${DRAFT}.xml + +diff: rfc${RFC}.authors.xml rfc${RFC}.gen.xml + mvim -d rfc${RFC}.gen.xml rfc${RFC}.authors.xml + +clean: + rm rfc${RFC}.gen.xml diff --git a/auth48/QUESTIONS.md b/auth48/QUESTIONS.md new file mode 100644 index 00000000..0ef52a2c --- /dev/null +++ b/auth48/QUESTIONS.md @@ -0,0 +1,885 @@ +# RFC Editor Questions + +## RLB Notes + +* This document contains the changes from PR#878, which were reviewed by the WG + and approved by the AD: https://github.com/mlswg/mls-protocol/pull/878 + +* I updated Emad Omara's email address and affiliation based on his advice. + +* I noticed a copy/paste error in the IANA considerations, where "where this + credential is defined" was repeated in other registries. + +* Raphael noted that there was inconsistency over whether "ciphersuite" is one + or two words. I have updated the document to use the two-word form, following + the example of RFC 8446. Please check that all instances have been updated + properly. Note that this changed the title of one of the IANA registries, from + "MLS Ciphersuites" to "MLS Cipher Suites". + +* You seem to be deleting commas that do not preced independent clauses. In + most cases cases, the sentence structure is sufficiently complex that these + these commas improve clarity, so I have re-added them. + +* You seem to be adding commas before "as described in..." and similar. This is + almost always incorrect. These references are not "see more details", they + are part of the definition of the thing they are modifying. For example, + "Verify that the credential in the LeafNode is valid as described in Section + X" means that you need to follow the procedure in Section X. (In one + instance, the with-comma version doesn't even parse! "... an init secret + computed, as described in Section X") + +* You seem to be adding comma after one-word introductions like "Here" and + "Hence". These are unnecessary and distracting. + +* The document is inconsistent as to whether a is used inside
. + +## Questions and Answers (Round 1) + +> 1) [rfced] xml2rfc returns a number of warnings and suggest that +> viewBox be used. Please review and let us know if you would like to make +> any updates. +> +> Examples: +> rfc9420.xml(434): Warning: Found SVG with width or height specified, which will make the artwork not scale. Specify a viewBox only to let the artwork scale. +> rfc9420.xml(568): Warning: Found SVG with width or height specified, which will make the artwork not scale. Specify a viewBox only to let the artwork scale. +> ... +> rfc9420.xml(5759): Warning: Found SVG with width or height specified, which will make the artwork not scale. Specify a viewBox only to let the artwork scale. +> rfc9420.xml(8128): Warning: Found SVG with width or height specified, which will make the artwork not scale. Specify a viewBox only to let the artwork scale. +> + +The document's viewBox setting is correct; xml2rfc's default is wrong. Setting +width and height ensures that the SVG's scale and positioning is consistent with +the text across scaling. + + +> 2) [rfced] Please insert any keywords (beyond those that appear in +> the title) for use on https://www.rfc-editor.org/search. + +The authors' XML file now has + + +> 3) [rfced] Section 2. Should the terminology be placed in alphabetical +> order, or do you prefer the current ordering? Please review and +> let us know your preference. +> + +We would prefer to keep the terminology in the existing order. Since there are +some semantic dependencies, having them in this order is clearer. + + +> 4) [rfced] Please review the "type" attribute of each sourcecode +> element in the XML file to ensure correctness. +> +> Note that "tls-presentation" (not "tls") is already considered an +> acceptable "type" per the current list of preferred values +> (https://www.rfc-editor.org/materials/sourcecode-types.txt). Would it make +> sense to update instances of type "tls" to "tls-presentation". Are you +> recommending that "tls" be added as a new type? Note that it is also +> acceptable to leave the "type" attribute not set. +> +> In addition, review each artwork element. Specifically, +> should any artwork element be tagged as sourcecode or another +> element? +> + +Thanks, we were unaware of the `tls-presentation` type. All of the `tls` +instances have been changed to `tls-presentation`. + + +> 5) [rfced] In the html and pdf outputs, the text enclosed in `` is +> output in fixed-width font. In the txt output, there are no changes to the +> font, and the quotation marks have been removed. +> +> In the html and pdf outputs, the text enclosed in `` is output in +> italics. In the txt output, the text enclosed in `` appears with an +> underscore before and after. +> +> Please review carefully and let us know if the output is acceptable or if +> any updates are needed. +> + +Yes, this output matches our expectations. + + +> 6) [rfced] We note that `` is used for superscript, but not for +> all instances. Please review and let us know if you would like to +> use `` for the instances that do not contain the `` element. +> + +We should use `` throughout, removing `` if necessary. I have +attempted to update all of the required occurrences. + + +> 7) [rfced] Would it be correct to say that a member "sends" a Welcome +> message to a new client instead of "broadcasts" it since the +> Welcome is only being distributed to one client? +> +> Original: +> Any member of the group can download a KeyPackage for a new client +> and broadcast Add and Commit messages that the current group will +> use to update their state, and a Welcome message that the new client +> can use to initialize its state and join the group. +> +> Perhaps: +> Any member of the group can download a KeyPackage for a new client +> and broadcast Add and Commit messages that the current group will +> use to update their state, and send a Welcome message that +> the new client can use to initialize its state and join the group. +> + +I have edited this to be serial: "download ... broadcast ... send". + + +> 8) [rfced] Please review whether any of the notes in this document +> should be in the `