From 1d4e21f57fd124f264eff8c942c81f673a1438c1 Mon Sep 17 00:00:00 2001 From: Georg Lukas Date: Wed, 7 Oct 2020 11:38:20 +0200 Subject: [PATCH 01/22] XEP-0308: modernize LMC sending rules --- xep-0308.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xep-0308.xml b/xep-0308.xml index fcdf87d5..0a83e17e 100644 --- a/xep-0308.xml +++ b/xep-0308.xml @@ -80,7 +80,7 @@ ... ]]> -

It is expected that clients will not send message corrections to clients that do not support them, as non-supporting clients will render these as duplicate (corrected) messages. There may be environments (particularly within a &xep0045; MUC room) where it is unknown whether some or all recipients support this extension, and implementors could choose to allow or disallow sending in such cases, as is appropriate for the intended deployments. It is suggested that when the support of recipients is not known a sending client will make the user aware of the potential for duplicate messages to be interpreted by the recipients.

+

Message corrections sent to clients that do not support them will be rendered as duplicate (corrected) messages. In most Instant Messaging environments (particularly within a &xep0045; room, but also with a recipient having multiple clients using &xep0280; and &xep0313;) it is unknown whether some or all receiving devices support this extension. It is suggested that in these situations a client will allow sending corrections, but will make the user aware of the potential for duplicate messages to be interpreted by the recipients. In restricted environments, implementors could choose to allow or disallow sending in such cases, as is appropriate for the intended deployments.

When a user indicates to the client that he wants to correct the most recently sent message to a contact, the client will resend the corrected message with a new id, and with the replace payload refering to the previous message by id. The receiving client then treats the newly received payloads as completely replacing all payloads of the original message.

From 7b1f463d2fc6ff5b36fff6dd8c17bb7686b864f1 Mon Sep 17 00:00:00 2001 From: Georg Lukas Date: Wed, 14 Oct 2020 16:49:22 +0200 Subject: [PATCH 02/22] XEP-0308: weasel-word the weasel-wording some more --- xep-0308.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xep-0308.xml b/xep-0308.xml index 0a83e17e..23578edb 100644 --- a/xep-0308.xml +++ b/xep-0308.xml @@ -80,7 +80,7 @@ ... ]]> -

Message corrections sent to clients that do not support them will be rendered as duplicate (corrected) messages. In most Instant Messaging environments (particularly within a &xep0045; room, but also with a recipient having multiple clients using &xep0280; and &xep0313;) it is unknown whether some or all receiving devices support this extension. It is suggested that in these situations a client will allow sending corrections, but will make the user aware of the potential for duplicate messages to be interpreted by the recipients. In restricted environments, implementors could choose to allow or disallow sending in such cases, as is appropriate for the intended deployments.

+

Message corrections sent to clients that do not support them will be rendered as duplicate (corrected) messages. In most Instant Messaging environments (particularly within a &xep0045; room, but also with a recipient having multiple clients using &xep0280; and &xep0313;) it is unknown whether some or all receiving devices support this extension. It is suggested that a client should always allow sending corrections, but may make the user aware of the potential for duplicate messages to be interpreted by the recipients. In restricted environments, implementors could choose to allow or disallow sending in such cases, as is appropriate for the intended deployments.

When a user indicates to the client that he wants to correct the most recently sent message to a contact, the client will resend the corrected message with a new id, and with the replace payload refering to the previous message by id. The receiving client then treats the newly received payloads as completely replacing all payloads of the original message.

From ca1a1a48e1a1e255c5ac4c817d27ee22a9df2fa0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jonas=20Sch=C3=A4fer?= Date: Wed, 14 Oct 2020 16:53:48 +0200 Subject: [PATCH 03/22] XEP-0352: Accept as Draft --- xep-0352.xml | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/xep-0352.xml b/xep-0352.xml index 3502747a..46e67ac1 100644 --- a/xep-0352.xml +++ b/xep-0352.xml @@ -10,7 +10,7 @@ This document defines a way for the client to indicate its active/inactive state. &LEGALNOTICE; 0352 - Proposed + Draft 2020-08-18 2017-12-21 2017-11-15 @@ -28,6 +28,12 @@ csi &mwild; + + 1.0.0 + 2020-10-14 + XEP Editor (jsc) + Accepted as Draft as per Council vote from 2020-08-26. + 0.3.0 2018-11-08 From b96c1415655c2648bdae32e70b7eb6708e33df0b Mon Sep 17 00:00:00 2001 From: Daniel Gultsch Date: Fri, 16 Oct 2020 12:21:13 +0200 Subject: [PATCH 04/22] XEP-0443: added section about a/v calls --- xep-0443.xml | 58 +++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 57 insertions(+), 1 deletion(-) diff --git a/xep-0443.xml b/xep-0443.xml index f4c62126..318d4cde 100644 --- a/xep-0443.xml +++ b/xep-0443.xml @@ -114,7 +114,7 @@

The following changes were made to the Compliance Suites since &xep0423;:

    -
  • TODO
    • +
  • Introduced new category for A/V Calling.
 @@ -457,6 +457,62 @@
  • &xep0286;
    •  + +

    + To be considered XMPP A/V calling compliant, all features from the core + compliance category must be met, as well as all features in this suite. +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FeatureCore ServerCore ClientAdvanced ServerAdvanced ClientProviders
    Call SetupN/A&yes;N/A&yes;&xep0167;, &xep0353;
    TransportN/A&yes;N/A&yes;&xep0176;
    EncryptionN/A&yes;N/A&yes;&xep0320;
    STUN/TURN server discovery&yes;&yes;&yes;&yes;&xep0215;
    Quality and Performance improvementsN/A&no;N/A&yes;&xep0293;, &xep0294;, &xep0338;, &xep0339;
    +

    This section outlines the protocol specifications that are relevant for From 1a5db6ffc06f48e86e38eb6ae8587c960d156ef1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jonas=20Sch=C3=A4fer?= Date: Tue, 20 Oct 2020 16:22:01 +0200 Subject: [PATCH 05/22] XEP-0443: Add revision block --- xep-0443.xml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/xep-0443.xml b/xep-0443.xml index 318d4cde..3ce85d04 100644 --- a/xep-0443.xml +++ b/xep-0443.xml @@ -62,6 +62,12 @@ georg@op-co.de georg@yax.im + + 0.2.0 + 2020-10-20 + dg + Added section about A/V calls + 0.1.0 2020-10-06 From e228dc943183bd4893edd369e55bd13b6f3692a4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jonas=20Sch=C3=A4fer?= Date: Tue, 20 Oct 2020 16:25:06 +0200 Subject: [PATCH 06/22] XEP-0443: Issue Last Call Council vote from 2020-10-14. --- xep-0443.xml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/xep-0443.xml b/xep-0443.xml index 3ce85d04..76f7d0ee 100644 --- a/xep-0443.xml +++ b/xep-0443.xml @@ -22,7 +22,8 @@ &LEGALNOTICE; 0443 - Experimental + Proposed + 2020-11-03 Standards Track Standards From 93850218c00a5c673d660ddf6a886455bff37bc9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jonas=20Sch=C3=A4fer?= Date: Tue, 20 Oct 2020 16:26:51 +0200 Subject: [PATCH 07/22] Move XEPs which have LCs from previous council to Deferred MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit It makes no sense to re-issue the LC for this council, it won’t end properly anyway. --- xep-0292.xml | 2 +- xep-0353.xml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/xep-0292.xml b/xep-0292.xml index a049ff27..2f93e6b1 100644 --- a/xep-0292.xml +++ b/xep-0292.xml @@ -10,7 +10,7 @@ This document specifies an XMPP extension for use of the vCard4 XML format in XMPP systems, with the intent of obsoleting the vcard-temp format. &LEGALNOTICE; 0292 - Proposed + Deferred 2019-02-19 Standards Track Standards diff --git a/xep-0353.xml b/xep-0353.xml index 401d3714..8c971b82 100644 --- a/xep-0353.xml +++ b/xep-0353.xml @@ -10,7 +10,7 @@ This specification provides a way for the initiator of a Jingle session to propose sending an invitation in an XMPP message stanza, thus taking advantage of message delivery semantics instead of sending IQ stanzas to all of the responder's online resources or choosing a particular online resource. &LEGALNOTICE; 0353 - Proposed + Deferred 2019-08-13 Standards Track Standards From c8cbe59684f90788df31b53b9421c7bca52fb3a4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jonas=20Sch=C3=A4fer?= Date: Tue, 20 Oct 2020 16:27:57 +0200 Subject: [PATCH 08/22] XEP-0411: Accept as Draft --- xep-0411.xml | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/xep-0411.xml b/xep-0411.xml index 8812e32e..fd02ebd3 100644 --- a/xep-0411.xml +++ b/xep-0411.xml @@ -10,7 +10,7 @@ This specification describes a method to migrate to PEP based bookmarks without loosing compatibility with client that still use Private XML. &LEGALNOTICE; 0411 - Proposed + Draft 2020-10-14 Standards Track Standards @@ -29,6 +29,12 @@ daniel@gultsch.de daniel@gultsch.de + + 1.0.0 + 2020-10-20 + XEP Editor (jsc) + Accepted as Draft by vote of Council on 2020-10-14. + 0.2.1 2020-05-25 From ba8176e3288ab105301ddff38bc749ad3a7c830a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jonas=20Sch=C3=A4fer?= Date: Tue, 20 Oct 2020 16:30:20 +0200 Subject: [PATCH 09/22] XEP-0308: Add revision block --- xep-0308.xml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/xep-0308.xml b/xep-0308.xml index 23578edb..cfeb8c63 100644 --- a/xep-0308.xml +++ b/xep-0308.xml @@ -21,6 +21,12 @@ message-correct &ksmith; + + 1.2.0 + 2020-10-20 + gl +

    Reword note about how to handle LMC in cases where it is not clear that all recipients support it.

    + 1.1.0 2019-05-15 From c5074f81571c6bfc664786b4a9cff548c04ed723 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jonas=20Sch=C3=A4fer?= Date: Tue, 20 Oct 2020 16:45:20 +0200 Subject: [PATCH 10/22] Do not run the main CI for MRs We do not want to run the main CI if the fork happens to use the main branch, too. --- .gitlab-ci.yml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 52abb9d5..485260a2 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -10,6 +10,8 @@ stages: - make html inbox-html inbox-xml pdf xeplist refs xml - bash tools/ci-prune-build.sh rules: + - if: '$CI_PIPELINE_SOURCE == "merge_request_event"' + when: never - if: '$CI_COMMIT_REF_NAME =~ /^main$/' when: always - when: never @@ -37,6 +39,8 @@ stages: - 'docker push "$IMAGE_REF"' - 'docker push "$LATEST_REF"' rules: + - if: '$CI_PIPELINE_SOURCE == "merge_request_event"' + when: never - if: '$CI_COMMIT_REF_NAME =~ /^main$/' when: on_success - when: never @@ -52,6 +56,8 @@ stages: - state/ key: attic-state rules: + - if: '$CI_PIPELINE_SOURCE == "merge_request_event"' + when: never - if: '$CI_COMMIT_REF_NAME =~ /^main$/' when: on_success - when: never @@ -67,6 +73,8 @@ stages: - state/ key: announce-state rules: + - if: '$CI_PIPELINE_SOURCE == "merge_request_event"' + when: never - if: '$CI_COMMIT_REF_NAME =~ /^main$/' when: on_success - when: never From 6c314ca34cb374451589ae45fe95cf0c2d0faf34 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jonas=20Sch=C3=A4fer?= Date: Fri, 23 Oct 2020 17:21:03 +0200 Subject: [PATCH 11/22] Update docs --- README.md | 388 ++------------------------------------------- docs/MODERATION.md | 39 +++++ docs/PROCESSING.md | 203 ++++++++++++++++++++++++ docs/README.md | 39 +++++ docs/REPOSITORY.md | 34 ++++ docs/TRIAGING.md | 154 ++++++++++++++++++ 6 files changed, 478 insertions(+), 379 deletions(-) create mode 100644 docs/MODERATION.md create mode 100644 docs/PROCESSING.md create mode 100644 docs/README.md create mode 100644 docs/REPOSITORY.md create mode 100644 docs/TRIAGING.md diff --git a/README.md b/README.md index 5d67c04d..3e68bd8b 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,9 @@ XMPP Extension Protocols (XEPs) =============================== +About +----- + This repository is used to manage work on XMPP Extension Protocols (XEPs), which are the specifications produced by the XMPP Standards Foundation (XSF). See http://xmpp.org/ for details. The rendered @@ -11,6 +14,9 @@ documents can be found here: https://xmpp.org/extensions/ +Contribution +------------ + Please use this repository to raise issues and submit pull requests: https://github.com/xsf/xeps/issues @@ -19,7 +25,7 @@ https://github.com/xsf/xeps/pulls For in-depth technical discussion, please post to the standards@xmpp.org email list: -http://mail.jabber.org/mailman/listinfo/standards +https://mail.jabber.org/mailman/listinfo/standards To submit a new proposal for consideration as a XEP, please read this page: @@ -29,387 +35,11 @@ https://xmpp.org/about/standards-process.html#submitting-a-xep [XEP-0001: XMPP Extension Protocols](https://xmpp.org/extensions/xep-0001.html) defines the standards process followed by the XMPP Standards Foundation. -Building XEPs -------------- - -You'll need xmllint and xsltproc. - -On Ubuntu, you can install them with `sudo apt install libxml2-utils xsltproc` - -To build a single XEP as HTML simply run: - - make xep-xxxx.html - -To build PDFs, you'll need to install [TeXML](http://getfo.org/texml/) (probably -in a Python 2 virtual environment). -You can then build PDFs with: - - make xep-xxxx.pdf - -To change the output directory, set the variable `OUTDIR`, eg. - - OUTDIR=/tmp/xeps make all - -For more information try `make help`. - -Using Docker ------------- - -A full set of HTML and PDFs can be generated inside a docker container, with no -dependencies on the host other than Docker itself, and served by nginx in the -container. To build the template `make docker`, to run it `make testdocker` -(serves on http://localhost:3080), and to stop/delete it afterwards `make -stopdocker` - - -Gardening (Issue triaging by non-editors) ------------------------------------------ - -For new PRs, anyone with permission may perform gardening tasks. -The [Go wiki] summarizes "gardening" as: - -> the background maintenance tasks done to keep the project healthy & growing & -> nice looking. - -In this repo, gardening is mostly triaging issues. -An issue is considered triaged when an editor has been assigned to it. -Untriaged issues that are in need of attention can be found using the following -filter: [`is:open is:pr no:assignee`] - -To triage new issues or PRs, see the [Triaging a PR][#triaging-a-pr] section below. - Editor -====== +------ -The XMPP Extensions Editor (or, for short, XEP Editor) manages the XMPP -extensions process as defined in XMPP Extension Protocols ([XEP-0001]). -In addition, the XEP Editor functions as the XMPP Registrar as defined in XMPP -Registrar Function ([XEP-0053]). -Read those documents first, since this README focuses on mechanics instead of -philosophy or policy. +Documentation for Editors is in the [docs](docs/) folder. -All PRs -------- - -For all PRs, start by ensuring that the IP release has been signed and that CI -has run and no issues were detected before merging. - - -Triaging a PR -------------- - -If the PR is not touching a XEP, this guide does not apply. If the PR touches -multiple XEPs, go through the steps for each XEP and exit at the first which -applies. - -1. Is the PR a ProtoXEP? - - 1. Does the PR touch existing XEPs? Close as [invalid] and ask the Opener - to split the two things. - - 2. Add the [ProtoXEP] and [Ready to Merge] labels. - 3. Stop. - -2. Sanity checks - - 1. Ensure that all XEPs are mentioned in the title as `XEP-XXXX`. E.g. `XEP-0084, XEP-0123: something`. - 2. Continue. - -3. Are the changes *for all XEPs* purely editorial? - - 1. Add the [Editorial Change] and [Ready to Merge] labels. - 2. If the PR does not add a revision block, add the [Needs Version Block] label. - 3. If the PR adds a revision block and does not only bump the patch-level (third) version number part, add the [Needs Version Block] label and a comment explaining the situation. - 4. Stop. - -4. Is the XEP **not** in Experimental state? - - (Changes to Non—Experimental XEPs need approval by the approving body as - defined in the XEP file itself.) - - 1. Add the [Needs Council]/[Needs Board] label. - 2. Send an email to the council chair and/or announce the PR in [The Council Room]. - 3. If the PR does not add a revision block, add the [Needs Version Block] label. - 4. If the PR adds a revision block and does not bump the minor-level (second) version number part, add the [Needs Version Block] label and a comment explaining the situation. - 5. Stop. - -5. Is the XEP in Experimental state and the PR opener is not an author of the - XEP? - - 1. If the PR does not a revision block, add the [Needs Version Block] label. - 2. If the PR adds a revision block and does not bump the minor-level (second) version number part, add the [Needs Version Block] label and a comment explaining the situation. - 3. If the issue has not been discussed on the standards list *or* if - the authors have not been involved in the discussion *or* the author - has not explicitly ACKed the PR: - - 1. Make sure the standards@ discussion (if it exists) is linked in the - PR. - 2. Add the [Needs Author] label. - 3. Stop. - -6. Mark the PR as [Ready to Merge]. - -Discussions ------------ - -Technical discussions SHOULD NOT happen in the xeps repository. If you see a -discussion evolve into technical (as opposed to editorial) matters, do the -following (I haven’t tried that myself yet, so feel especially free to improve -the process): - -1. Lock the conversation. -2. Copy the technical discussion parts into an email to standards@. My - preferred format for this would be something along the lines of: - - Subject: XEP-1234: [insert PR subject here, or something more appropriate] - - There was some discussion on the xeps repository an XEP-1234, which got - technical. I moved this discussion to standards@ so that the whole - community is aware of the issue and can participate. - - @user1 wrote: - > quote user1 here ... - - @user2 wrote: - > quote user2 here ... - - Remove clearly editorial discussion and mark the removal with ``[…]``. - -3. Add the [Needs List Discussion] label to the PR and link the standards@ - thread you just created. Remove other labels (such as [Needs Author]). - -4. Monitor the thread; when the discussion is resolved, the PR opener will - usually prepare an update. Unlock the conversation to allow editorial - discussion to continue, if needed. Remove the [Needs List Discussion] label - and re-triage the PR as described above. - - **Note:** The locking is mostly used here as a tool to avoid a race - condition, not to exclude people from participating. (It would be - unfortunate if you had to add more comments to your already-sent email.) - Feel free to unlock at some point during the list discussion when you’re - sure that all participants have taken note of the move. - - -General notes on making changes -------------------------------- - -This section has some hints on the python scripts which help you doing the -more tedious tasks of sending emails and properly archiving XEPs. - -*Before* you start working on merging a Pull Request: - -* Ideally, you have the [xep-attic] repository cloned next to the xeps - repository. - -* Before starting to prepare a merge and push, ensure that you have the XEP - metadata up-to-date locally: - - $ make build/xeplist.xml - -* Make a copy of the metadata: - - $ cp build/xeplist.xml tools/old-xeplist.xml - - (avoid putting random XML files in the xeps root directory, the build - tooling might mistake them as XEPs; so we put it somewhere else.) - -*While* you’re working on a Pull Request: - -* Use the lokal docker build to ensure that everything is syntactically - correct. The process is described above in "Using Docker". - -When you have *merged* the Pull Request and the change went through to the -webserver (see also the [Docker Build] to track the build progress): - -* Send out the emails. First ensure that the new metadata is up-to-date: - - $ make build/xeplist.xml - - Check that the emails which will be sent are correct (the ``--dry-run`` - switch prevents the tool from actually sending emails): - - $ ./tools/send-updates.py --dry-run tools/old-xeplist.xml build/xeplist.xml standards@xmpp.org - - (See also the ``--help`` output for more information.) - - Once you’ve verified that the correct emails will be sent, actually send - them using (note the missing ``--dry-run`` flag): - - $ ./tools/send-updates.py tools/old-xeplist.xml build/xeplist.xml standards@xmpp.org - - A few tips: - - 1. You can also test-send them to your own address by replacing - ``standards@xmpp.org`` with your own address. - 2. To avoid having to enter your email account details every time, use a - configuration file. Invoke the tool with ``--help`` for more - information and ask [jonasw]/[@horazont] if things are still unclear. - - If the tool misbehaves, pester [jonasw]/[@horazont] about it. - -* Don’t forget to archive the new versions of the XEPs. If you have the - [xep-attic] cloned next to the xeps repository, you can simply run: - - $ ./tools/archive.py tools/old-xeplist.xml build/xeplist.xml - - Otherwise, you will have to explicitly give the path to the attic: - - $ ./tools/archive.py --attic /path/to/xep-attic/content/ tools/old-xeplist.xml build/xeplist.xml - - (note that the path must point to the ``content`` subdirectory of the - [xep-attic].) - - Don’t forget to commit & push the changes to [xep-attic]. - - -New ProtoXEPs -------------- - -- Make sure the protoxep is in the `inbox/` tree and has a name that does not - start with "xep-" (you may change this or ask the author to change it). -- Make sure the version is `0.0.1` and the status is `ProtoXEP` (you may fix - this or ask the author to fix it). -- You may want to build the protoxep locally and ensure the HTML and PDF look - okay. -- Merge the PR as described in "Merging a PR". Once the email has been sent, - continue here. -- Create a card for the protoxep on the [Council Trello] under "Proposed - Agendums". -- Attach the PR to the card and link the generated HTML. -- Comment on the PR with a link to the card, thanking the author for their - submission and letting them know that their XEP will be voted on within the - next two weeks. -- If the council forgets and doesn't vote on the protoxep, pester them until - they do. -- If the council rejects the XEP, you're done (leave the XEP in the inbox and - inform the author of the councils decision). Otherwise, see - "Promoting a ProtoXEP". - - -Promoting a ProtoXEP --------------------- - -- It is easiest to start a new branch, in case you screw something up on the way. -- Once the council approves a ProtoXEP, *copy* it out of the inbox and into the - root, assigning it the next available number in the XEP series. -- Modify the `` element in the XML file to match. -- Set the version to `0.1` and the initials to `XEP Editor: xyz` (replacing "xyz" with your own initials). -- Remove the `` element from the XML file if it is included. -- Set the status to `Experimental`. -- Add a reference to the XEP in `xep.ent`. -- Make a commit. -- Treat your branch as you would treat a [Ready to Merge] PR in "Merging a PR". - (you don’t need to create another branch though.) - - -Promoting XEPs --------------- - -Ensure that the following sections exist (if not, ask the author to add them -before promoting the XEP): - -- Security Considerations -- IANA Considerations -- XMPP Registrar Considerations -- XML Schema (for protocol specifications) - -You can also refer to `xep-template.xml` for a recommended list of sections and -whether or not they are required. -For a helpful graph of how XEP promotion works, see [XEP-0001]. - - -Deferring XEPs --------------- - -Before Deferring XEPs, read the "General notes on making changes" section. - -XEPs get deferred after 12 months of inactivity. There is a tool which handles -that process automatically, if it is invoked regularly. - -First of all, you need an up-to-date ``xeplist.xml``: - - make build/xeplist.xml - -To get a list of XEPs which need to be deferred (without changing anything), -run: - - ./tools/deferrals.py -v - -To apply the deferrals, make a new feature branch and execute: - - ./tools/deferrals.py -m 'initials' - -where you replace ``initials`` with your editor initials so that it is obvious -who made the change (those initials will be used in the revision block). - -This will modify the XEPs in-place. It uses heuristics for incrementing the -version number, finding and inserting the revision block as well as changing -the status. Yes, it involves regular expressions (because we don’t want to -fully re-write the XML to keep the diffs minimal). It is thus vital that you -**use `git diff` to ensure that the changes are sane**. If the changes -are sane, make a commit and merge to master as described in "Merging a PR", -in accordance with the "General notes on making changes". - - -Merging a PR ------------- - -Before Merging a PR, read the "General notes on making changes" section. - -When you get to the point that the PR is [Ready to Merge], do the following: - -1. Create a new branch off master called ``feature/xep-1234`` (if the PR - touches multiple XEPs, I call it ``feature/xep-0678,xep-0789``). - -2. Merge all [Ready to Merge] PRs which affect the XEP(s) into that branch. - -3. Resolve conflicts. - -4. If the PRs introduced multiple revision blocks, squash it down to a single - revision block. Set "XEP Editor (initials)" as author of the revision block - and add the initials of the original PR authors to the changelog entries. - (If that doesn’t make sense to you, you’ll find plenty examples in the - XEPs.) - -5. Ensure that everything builds by performing a full docker build (see above). - - (Once the docker build reaches the point where the XEPs are built, you can - switch branches and work on another PR.) - -6. If the build passes, check that the generated files look sane by running the - docker container. - -7. Merge the PR into master. If you are working on independent changes to - multiple XEPs, you can merge them all in one go. - -8. If you merged multiple things into master, re-do the docker build check. - -9. Push. - -10. Go back to "General notes on making changes". - - - -[XEP-0001]: https://xmpp.org/extensions/xep-0001.html -[XEP-0053]: https://xmpp.org/extensions/xep-0053.html -[Editor Trello]: https://trello.com/b/gwcOFnCr -[Council Trello]: https://trello.com/b/ww7zWMlI -[Needs Council]: https://github.com/xsf/xeps/labels/Needs%20Council -[Needs Board]: https://github.com/xsf/xeps/labels/Needs%20Board -[ProtoXEP]: https://github.com/xsf/xeps/labels/ProtoXEP -[Go wiki]: https://golang.org/wiki/Gardening -[`is:open is:pr no:assignee`]: https://github.com/xsf/xeps/pulls?utf8=%E2%9C%93&q=is%3Aopen%20is%3Apr%20no%3Aassignee%20 -[Needs Author]: https://github.com/xsf/xeps/labels/Needs%20Author -[Ready to Merge]: https://github.com/xsf/xeps/labels/Ready%20to%20Merge -[Needs List Discussion]: https://github.com/xsf/xeps/labels/Needs%20List%20Discussion -[Needs Version Block]: https://github.com/xsf/xeps/labels/Needs%20Version%20Block -[Editorial Change]: https://github.com/xsf/xeps/labels/Editorial%20Change -[xep-attic]: https://github.com/xsf/xep-attic -[Docker Build]: https://hub.docker.com/r/xmppxsf/xeps/builds/ -[@horazont]: https://github.com/horazont/ -[jonasw]: https://wiki.xmpp.org/web/User:Jwi -[The Council Room]: xmpp:council@muc.xmpp.org?join - [modeline]: # ( vim: set fenc=utf-8 ff=unix spell spl=en textwidth=80: ) diff --git a/docs/MODERATION.md b/docs/MODERATION.md new file mode 100644 index 00000000..dc8a421d --- /dev/null +++ b/docs/MODERATION.md @@ -0,0 +1,39 @@ +# Moderation + +## Discussions + +Technical discussions SHOULD NOT happen in the xeps repository. If you see a +discussion evolve into technical (as opposed to editorial) matters, do the +following: + +1. Lock the conversation. +2. Copy the technical discussion parts into an email to standards@. My + preferred format for this would be something along the lines of: + + Subject: [insert PR title here, or something more appropriate] + + There was some discussion on the xeps repository an XEP-1234, which got + technical. I moved this discussion to standards@ so that the whole + community is aware of the issue and can participate. + + @user1 wrote: + > quote user1 here ... + + @user2 wrote: + > quote user2 here ... + + Remove clearly editorial discussion and mark the removal with ``[…]``. + +3. Add the [Needs List Discussion] label to the PR and link the standards@ + thread you just created. Remove other labels (such as [Needs Author]). + +4. Monitor the thread; when the discussion is resolved, the PR opener will + usually prepare an update. Unlock the conversation to allow editorial + discussion to continue, if needed. Remove the [Needs List Discussion] label + and re-triage the PR as described above. + + **Note:** The locking is mostly used here as a tool to avoid a race + condition, not to exclude people from participating. (It would be + unfortunate if you had to add more comments to your already-sent email.) + Feel free to unlock at some point during the list discussion when you’re + sure that all participants have taken note of the move. diff --git a/docs/PROCESSING.md b/docs/PROCESSING.md new file mode 100644 index 00000000..10b52448 --- /dev/null +++ b/docs/PROCESSING.md @@ -0,0 +1,203 @@ +# Processing a PR + +## General notes on making changes + +This section has some hints on the python scripts which help you doing the +more tedious tasks of sending emails and properly archiving XEPs. + +### Before you start working on merging a Pull Request + +* Ideally, you have the [xep-attic] repository cloned next to the xeps + repository. + +* Before starting to prepare a merge and push, ensure that you have the XEP + metadata up-to-date locally: + + $ make build/xeplist.xml + +* Make a copy of the metadata: + + $ cp build/xeplist.xml tools/old-xeplist.xml + + (avoid putting random XML files in the xeps root directory, the build + tooling might mistake them as XEPs; so we put it somewhere else.) + +### While you’re working on a Pull Request + +* Use the local docker build to ensure that everything is syntactically + correct. The process is described above in "Using Docker". + +### After merging the Pull Request + +When you have *merged* the Pull Request and the change went through to the +webserver (see also the [Docker Build] to track the build progress): + +* Send out the emails. First ensure that the new metadata is up-to-date: + + $ make build/xeplist.xml + + Check that the emails which will be sent are correct (the ``--dry-run`` + switch prevents the tool from actually sending emails): + + $ ./tools/send-updates.py --dry-run tools/old-xeplist.xml build/xeplist.xml standards@xmpp.org + + (See also the ``--help`` output for more information.) + + Once you’ve verified that the correct emails will be sent, actually send + them using (note the missing ``--dry-run`` flag): + + $ ./tools/send-updates.py tools/old-xeplist.xml build/xeplist.xml standards@xmpp.org + + A few tips: + + 1. You can also test-send them to your own address by replacing + ``standards@xmpp.org`` with your own address. + 2. To avoid having to enter your email account details every time, use a + configuration file. Invoke the tool with ``--help`` for more + information and ask [jonas’]/[@horazont] if things are still unclear. + + If the tool misbehaves, pester [jonas’]/[@horazont] about it. + +* Don’t forget to archive the new versions of the XEPs. If you have the + [xep-attic] cloned next to the xeps repository, you can simply run: + + $ ./tools/archive.py tools/old-xeplist.xml build/xeplist.xml + + Otherwise, you will have to explicitly give the path to the attic: + + $ ./tools/archive.py --attic /path/to/xep-attic/content/ tools/old-xeplist.xml build/xeplist.xml + + (note that the path must point to the ``content`` subdirectory of the + [xep-attic].) + + Don’t forget to commit & push the changes to [xep-attic]. + + +## New ProtoXEPs + +- Make sure the protoxep is in the `inbox/` tree and has a name that does not + start with "xep-" (you may change this or ask the author to change it). +- Make sure the version is `0.0.1` and the status is `ProtoXEP` (you may fix + this or ask the author to fix it). +- You may want to build the protoxep locally and ensure the HTML and PDF look + okay. +- Merge the PR as described in "Merging a PR". Once the email has been sent, + continue here. +- Create a card for the protoxep on the [Council Trello] under "Proposed + Agendums". +- Attach the PR to the card and link the generated HTML. +- Comment on the PR with a link to the card, thanking the author for their + submission and letting them know that their XEP will be voted on within the + next two weeks. +- If the council forgets and doesn't vote on the protoxep, pester them until + they do. +- If the council rejects the XEP, you're done (leave the XEP in the inbox and + inform the author of the councils decision). Otherwise, see + "Promoting a ProtoXEP". + + +## Promoting a ProtoXEP to Experimental + +- It is easiest to start a new branch, in case you screw something up on the way. +- Once the council approves a ProtoXEP, *copy* it out of the inbox and into the + root, assigning it the next available number in the XEP series. +- Modify the `` element in the XML file to match. +- Set the version to `0.1` and the initials to `XEP Editor: xyz` (replacing "xyz" with your own initials). +- Remove the `` element from the XML file if it is included. +- Set the status to `Experimental`. +- Add a reference to the XEP in `xep.ent`. +- Make a commit. +- Treat your branch as you would treat a [Ready to Merge] PR in "Merging a PR". + (you don’t need to create another branch though.) + + +## Promoting XEPs beyond Experimental + +Ensure that the following sections exist (if not, ask the author to add them +before promoting the XEP): + +- Security Considerations +- IANA Considerations +- XMPP Registrar Considerations +- XML Schema (for protocol specifications) + +You can also refer to `xep-template.xml` for a recommended list of sections and +whether or not they are required. +For a helpful graph of how XEP promotion works, see [XEP-0001]. + + +## Deferring XEPs + +Before Deferring XEPs, read the "General notes on making changes" section. + +XEPs get deferred after 12 months of inactivity. There is a tool which handles +that process automatically, if it is invoked regularly. + +First of all, you need an up-to-date ``xeplist.xml``: + + make build/xeplist.xml + +To get a list of XEPs which need to be deferred (without changing anything), +run: + + ./tools/deferrals.py -v + +To apply the deferrals, make a new feature branch and execute: + + ./tools/deferrals.py -m 'initials' + +where you replace ``initials`` with your editor initials so that it is obvious +who made the change (those initials will be used in the revision block). + +This will modify the XEPs in-place. It uses heuristics for incrementing the +version number, finding and inserting the revision block as well as changing +the status. Yes, it involves regular expressions (because we don’t want to +fully re-write the XML to keep the diffs minimal). It is thus vital that you +**use `git diff` to ensure that the changes are sane**. If the changes +are sane, make a commit and merge to master as described in "Merging a PR", +in accordance with the "General notes on making changes". + + +## Merging a PR + +Before Merging a PR, read the "General notes on making changes" section. + +When you get to the point that the PR is [Ready to Merge], do the following: + +1. Create a new branch off master called ``feature/xep-1234`` (if the PR + touches multiple XEPs, I call it ``feature/xep-0678,xep-0789``). + +2. Merge all [Ready to Merge] PRs which affect the XEP(s) into that branch. + +3. Resolve conflicts. + +4. If the PRs introduced multiple revision blocks, squash it down to a single + revision block. Set "XEP Editor (initials)" as author of the revision block + and add the initials of the original PR authors to the changelog entries. + (If that doesn’t make sense to you, you’ll find plenty examples in the + XEPs.) + +5. Ensure that everything builds by performing a full docker build (see above). + + (Once the docker build reaches the point where the XEPs are built, you can + switch branches and work on another PR.) + +6. If the build passes, check that the generated files look sane by running the + docker container. + +7. Merge the PR into master. If you are working on independent changes to + multiple XEPs, you can merge them all in one go. + +8. If you merged multiple things into master, re-do the docker build check. + +9. Push. + +10. Go back to "General notes on making changes". + +[XEP-0001]: https://xmpp.org/extensions/xep-0001.html +[Ready to Merge]: https://github.com/xsf/xeps/labels/Ready%20to%20Merge +[Council Trello]: https://trello.com/b/ww7zWMlI +[xep-attic]: https://github.com/xsf/xep-attic +[Docker Build]: https://hub.docker.com/r/xmppxsf/xeps/builds/ +[@horazont]: https://github.com/horazont/ +[jonas’]: https://wiki.xmpp.org/web/User:Jwi diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..b9b4a2be --- /dev/null +++ b/docs/README.md @@ -0,0 +1,39 @@ +Editor Guide +============ + +The XMPP Extensions Editor (or, for short, XEP Editor) manages the XMPP +extensions process as defined in XMPP Extension Protocols ([XEP-0001]). +In addition, the XEP Editor functions as the XMPP Registrar as defined in XMPP +Registrar Function ([XEP-0053]). +Read those documents first, since this README focuses on mechanics instead of +philosophy or policy. + + +This is the entrypoint definitive guide for Editors. + +- [Using the repository](REPOSITORY.md) + + Information about how to build XEPs and how the repository is laid out. + + + +- [Triaging](TRIAGING.md) + + Rules for labelling and guiding inbound Pull Requests (Merge Requests). + +- [Processing](PROCESSING.md) + + Rules and guidelines for processing inbound Pull Requests (Merge Requests) + towards master/main. + +- [Moderation](MODERATION.md) + + Rules and guidelines for moderating the discussions in the PRs. + + +[XEP-0053]: https://xmpp.org/extensions/xep-0053.html diff --git a/docs/REPOSITORY.md b/docs/REPOSITORY.md new file mode 100644 index 00000000..1bf28b8f --- /dev/null +++ b/docs/REPOSITORY.md @@ -0,0 +1,34 @@ +Using the repository +==================== + +Building XEPs +------------- + +You'll need xmllint and xsltproc. + +On Ubuntu, you can install them with `sudo apt install libxml2-utils xsltproc` + +To build a single XEP as HTML simply run: + + make xep-xxxx.html + +To build PDFs, you'll need to install [TeXML](http://getfo.org/texml/) (probably +in a Python 2 virtual environment). +You can then build PDFs with: + + make xep-xxxx.pdf + +To change the output directory, set the variable `OUTDIR`, eg. + + OUTDIR=/tmp/xeps make all + +For more information try `make help`. + +Using Docker +------------ + +A full set of HTML and PDFs can be generated inside a docker container, with no +dependencies on the host other than Docker itself, and served by nginx in the +container. To build the template `make docker`, to run it `make testdocker` +(serves on http://localhost:3080), and to stop/delete it afterwards `make +stopdocker` diff --git a/docs/TRIAGING.md b/docs/TRIAGING.md new file mode 100644 index 00000000..992de116 --- /dev/null +++ b/docs/TRIAGING.md @@ -0,0 +1,154 @@ +# Triaging a PR + +## Dramatis Personae + +- Author: Generally the author of the PR or MR. +- XEP Author: The Author of the XEP. +- Approving Body: Either the XMPP Council or the XSF Board. Which of those two + can be determined by looking at the `` tag of the respective XEP. +- Processing Editor: The Editor which ultimately merges a PR to master. + +## Labels + +### Approval categories + +- [Needs Council]: The changes need approval by the XMPP Council. +- [Needs Board]: The changes need approval by the XSF Board. +- [Needs Author]: The changes need approval by the XEP Author. +- [Needs List Discussion]: The changes need more discussion on the standards@ + (or, in rare cases, members@) mailing lists; in general, there should be a + link to a mailing list thread in those PRs. +- [Editorial Change]: The changes do not need approval by anyone except the + Editor. + +### Process categories + +- [ProtoXEP]: The PR adds a new XEP to the inbox. +- [Ready to Merge]: The PR can be worked on by a Processing Editor. Note that + this does **not** imply that no further changes are needed. +- [Needs Version Block]: A version block needs to be added or modified before + the changes can enter master. +- [Needs Editor Action]: The Processing Editor needs to do something while + merging the PR, aside of or in addition to modifying a version block. +- [invalid]: The changes cannot be processed as-is at all; the PR is closed + without merge and without being handed to an approver. + +## Process + +### A General Note + +Some of the cases where the below process suggests to ask the Author to do +something can also be handled by the Processing Editor. If it is realistic +that the workload for the Editors would be reduced by handling the task +themselves, use the [Needs Editor Action] label an an explanatory comment +instead. + +### "Flowchart" + +If the PR is not touching a XEP, this guide does not apply. + +1. Is the PR a ProtoXEP? + + 1. Does the PR touch existing XEPs? Close as [invalid] and ask the Author + to split the two things. + + 2. Validate that the `` makes sense for the content (consult + [XEP-0001] if necessary). If it does not make sense, either add a + comment to let the Processing Editor know (adding the + [Needs Editor Action] label) or ask the Author to correct the problem. + 3. Add the [ProtoXEP] and [Ready to Merge] labels. + 4. Make sure the title of the PR is `XEP-XXXX: Title of the new XEP`. + 5. Stop. + +2. Sanity checks + + 1. Ensure that all XEPs are mentioned in the title as `XEP-XXXX`. E.g. `XEP-0084, XEP-0123: something`. + 2. Continue. + +3. Are the changes *for all XEPs* purely editorial? + + Editorial changes are changes which do not touch normative language and + which do not change the meaning of the text. When in doubt, treat as + non-Editorial. + + 1. Add the [Editorial Change] and [Ready to Merge] labels. + 2. If the PR does not add a revision block, add the [Needs Version Block] + label. + 3. If the PR adds a revision block and does not only bump the patch-level + (third) version number part, add the [Needs Version Block] label and a + comment explaining the situation. + 4. Stop. + +4. Does the PR touch more than one XEP? + + In general, we want to avoid PRs which touch multiple XEPs or which do + multiple non-Editorial changes at once. This is because the approving body + may disagree with part of the PR, which causes extra work. + + Suggest the author to split the PR for that reason, unless it seems + realistic or obvious that the changes need to be done together to make + sense (an example is updating multiple XEPs which belong together, such + as the MIX family). + +4. Is the XEP **not** in Experimental state? + + Changes to Non—Experimental XEPs need approval by the approving body as + defined in the XEP file itself. + + 1. Add the [Needs Council]/[Needs Board] label. To know which, check the + `` of the XEPs. If the touched XEPs have different approvers + go back to the previous step and closely examine if the PR should not + be split; it is very likely that it should be split in this situation. + If so, tag as [invalid] and inform the author, asking them to do a + split. + 2. **For Council:** Send an email to the council chair and/or announce the + PR in [The Council Room]. + **For Board:** Send an email to info@xmpp.org and/or talk directly to + Board members. + 3. If the PR does not add a revision block, add the [Needs Version Block] + label. + 4. If the PR adds a revision block and does not bump the minor-level + (second) version number part, add the [Needs Version Block] label and a + comment explaining the situation for the next Editor (the Author does + not need to do anything here). + 5. Stop. + +5. Is the XEP in Experimental state and the PR opener is not an author of the + XEP? + + Changes to Experimental XEPs are approved by the XEP Authors themselves. + If the PR touches multiple XEPs and the XEP Authors do not overlap, ask + the Author to split the PR. + + 1. If the PR does not a revision block, add the [Needs Version Block] + label. + 2. If the PR adds a revision block and does not bump the minor-level + (second) version number part, add the [Needs Version Block] label and a + comment explaining the situation for the Processing Editor. + 3. If the issue has not been discussed on the standards list *or* if + the XEP Author has not been involved in the discussion *or* the + XEP Author has not explicitly ACKed the PR: + + 1. Make sure the standards@ discussion (if it exists) is linked in the + PR. + 2. Add the [Needs Author] label. + 3. Try to make the XEP Author aware of the change. If you do not know + a GitHub handle of the XEP Author, use the contact info available + for each author in either the XEP or in xep.ent. + 4. Stop. + + 4. Otherwise, mark the PR as [Ready to Merge], linking the XEP Author’s + approval for documentation purposes. + +6. Mark the PR as [Ready to Merge]. + +[ProtoXEP]: https://github.com/xsf/xeps/labels/ProtoXEP +[Ready to Merge]: https://github.com/xsf/xeps/labels/Ready%20to%20Merge +[Needs Author]: https://github.com/xsf/xeps/labels/Needs%20Author +[Needs List Discussion]: https://github.com/xsf/xeps/labels/Needs%20List%20Discussion +[Needs Version Block]: https://github.com/xsf/xeps/labels/Needs%20Version%20Block +[Needs Editor Action]: https://github.com/xsf/xeps/labels/Needs%20Editor%20Action +[Editorial Change]: https://github.com/xsf/xeps/labels/Editorial%20Change +[Needs Council]: https://github.com/xsf/xeps/labels/Needs%20Council +[Needs Board]: https://github.com/xsf/xeps/labels/Needs%20Board +[invalid]: https://github.com/xsf/xeps/labels/invalid From 414ba1d860cffe4530144c78ae420043939c89cb Mon Sep 17 00:00:00 2001 From: Georg Lukas Date: Wed, 28 Oct 2020 21:00:10 +0100 Subject: [PATCH 12/22] ProtoXEP: Pre-Authenticated In-Band Registration --- inbox/ibr-token.xml | 193 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 193 insertions(+) create mode 100644 inbox/ibr-token.xml diff --git a/inbox/ibr-token.xml b/inbox/ibr-token.xml new file mode 100644 index 00000000..b5b512e7 --- /dev/null +++ b/inbox/ibr-token.xml @@ -0,0 +1,193 @@ + + +%ents; +]> + + +
    + Pre-Authenticated In-Band Registration + This document extends the In-Band-Registration protocol to use + invitation tokens, e.g. for registering accounts on non-public + servers. + + &LEGALNOTICE; + xxxx + ProtoXEP + Standards Track + Standards + Council + + XMPP Core + XEP-0077 + XEP-0147 + XEP-0379 + XEP-0401 + + + + ibr-token + + Georg + Lukas + + + 0.1.0 + 2020-10-28 + gl + First version based on XEP-0401. + +
    + +

    There are two typical mechanisms to register an account on an XMPP server:

    +
      +
    • Out-of-band account creation, after which the account JID and password + need to be manually entered into an XMPP client, and
      • +
    • &xep0077; (IBR) where an account is created and fully configured right + from the XMPP client.
      • +
    +

    The IBR mechanism is much more convenient for users, but also opens up + the server to abuse, e.g. due to the mass-registration of spam bot + accounts. Captchas, while heavily impacting well-intentioned users, are + not a reliable mechanism to prevent abuse. This specification allows to + restrict the IBR mechanism by requiring a registration token, e.g. for + giving users access to a private server, without exposing their password + to the server administrator.

    +

    This specification is part of a series of documents aiming at improving + user onboarding:

    +
      +
    • &xep0379; to automatically accept roster subscriptions based on a + token.
      • +
    • &xep0401; to generate tokens that can be used for authenticating IBR.
      • +
    +

    While this specification is designed to work together with &xep0401;, it + can be used with invitation tokens obtained by any other mechanism. XMPP + URIs can then be used out-of-band to deliver the invitation to a new user.

    +

    A client that obtains such an XMPP URI should allow the user to register + an XMPP account with the server that generated the URI.

    +     + + +

    A client that implements this specification needs to understand the + &xep0147; specification, to make use of the register query + action and the preauth parameter. Three URI formats + are defined.

    + +

    An invitation to register an account can contain a specific XMPP + address (with a pre-defined user account name) to be registered. A + client should populate the address field in the IBR dialog with this + address and disallow changing the address.

    + xmpp:juliet@example.com?register;preauth=TOKEN +     + + +

    An invitation to register an account can contain just the server domain + to register on. A client should populate the address field in the IBR + dialog with this domain and allow entering the desired account name.

    + xmpp:example.com?register;preauth=TOKEN +     + + +

    A contact invitation with a registration token (&xep0379;) might + indicate that the token can also be used to register an account on that + server (ibr=y). If the receiving client already has an account + configured, it may skip account registration and simply add the contact + as defined in XEP-0379. The client may also register a new + account on the domain of the proposed contact, allowing the user to + enter the desired account name.

    + xmpp:romeo@example.com?roster;preauth=TOKEN;ibr=y +     +     + + +

    While a registration URI is an indication that the respective server + supports Pre-Authenticated IBR, a URI might be manipulated and is not + guaranteed to be reliable.

    +

    Therefore, when performing the account creation, the client needs to + ensure that the server supports the Pre-Authenticated IBR protocol, as denoted by + the <register xmlns='urn:xmpp:invite'> + stream feature:

    + + + EXTERNAL + SCRAM-SHA-1-PLUS + SCRAM-SHA-1 + PLAIN + + + + +]]> +     + +

    In order to allow invited users to register on a server, the + registration processs as defined in &xep0077; needs to be extended. The + invited user's client needs to connect to the server and check that the + invitation stream feature + (<register xmlns='urn:xmpp:invite'>) is present. + After that, the client initiates the registration flow by sending the + preauth token to the server:

    + + + +]]> +

    Upon receiving the preauth request, the server must validate that the + token is acceptable for account registration. However, single-use tokens + MUST NOT be considered used until the actual registration has succeeded. +

    +

    In addition, if the token has an expiration time, it MUST only be + checked at this point. Subsequent actions performed by the client during + the current session that require a valid token MUST NOT be rejected due + to token expiry. +

    +

    If the token is acceptable, the server responds with success, and + indicates the client may now proceed with account registration: +

    + +]]> +

    If the token provided by the client was unknown, invalid or expired, the + server should return an appropriate error to the client:

    + + + + The provided token is invalid or expired + + +]]> +

    In the success case, the client proceeds with registration as defined in + &xep0077;. If the token is rejected by the server, the client still MAY + attempt to perform IBR if the server allows that.

    +     + +

    If a username was specified when creating an invitation token, the + server SHOULD NOT create an account on the server until the invitee + actually registers it with the corresponding token. + The server MUST reserve the username at least until the corresponding + token expires.

    +     + + +

    If the invitee opens an invitation URI with ibr=y and + chooses to create a new account, the client SHOULD pre-fill the + inviter JID's domain part as the new account's domain. The client MAY + provide a mechanism to enter or choose a different server, though.

    +     +     + +

    See security considerations in &xep0379;.

    +     + +

    This document requires no interaction with &IANA;.

    +     + +

    This document only makes use of the XMPP URI elements defined in + &xep0401;

    +     + +

    REQUIRED for protocol specifications.

    +     +     From 62b7f1e4992f40bd4f1151e8ae8c8e38f9edbed6 Mon Sep 17 00:00:00 2001 From: Melvin Keskin Date: Sat, 31 Oct 2020 20:55:20 +0100 Subject: [PATCH 13/22] XEP-0420: Fix misspelling of 'whose' --- xep-0420.xml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/xep-0420.xml b/xep-0420.xml index e7fa388f..ce950363 100644 --- a/xep-0420.xml +++ b/xep-0420.xml @@ -112,19 +112,19 @@ &time; Timestamp - Prevent replay attacks using old messages. This element MUST have one attribute 'stamp', whos value is a timestamp following the format described in &xep0082;. The timestamp represents the time at which the message was encrypted by the sender. + Prevent replay attacks using old messages. This element MUST have one attribute 'stamp', whose value is a timestamp following the format described in &xep0082;. The timestamp represents the time at which the message was encrypted by the sender. Receiving clients MUST check whether the difference between the timestamp and the sending time derived from the stanza itself lays within a reasonable margin. The client SHOULD use the content of the timestamp element when displaying the send date of the message &to; Recipient of the message - Prevent spoofing of the recipient. This element MUST have one attribute 'jid', whos value is the JID of the intended recipient. + Prevent spoofing of the recipient. This element MUST have one attribute 'jid', whose value is the JID of the intended recipient. Receiving clients MUST check, if the JID matches the to attribute of the enclosing stanza and otherwise alert the user/reject the message &from; Sender of the message - Prevent spoofing of the sender. This element MUST have one attribute 'jid', whos value is the JID of the sender of the message. + Prevent spoofing of the sender. This element MUST have one attribute 'jid', whose value is the JID of the sender of the message. Receiving clients MUST check, if the value matches the from attribute of the enclosing stanza and otherwise alert the user/reject the message From e82b0f054d976ebaba371609b89956ba11515daa Mon Sep 17 00:00:00 2001 From: Melvin Keskin Date: Sun, 26 Apr 2020 14:28:58 +0200 Subject: [PATCH 14/22] MIX: Correct indentation, sentences and examples --- xep-0369.xml | 6 +++--- xep-0405.xml | 8 ++++---- xep-0407.xml | 8 ++++---- 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/xep-0369.xml b/xep-0369.xml index cf7e8c40..82d9a36b 100644 --- a/xep-0369.xml +++ b/xep-0369.xml @@ -1007,7 +1007,7 @@

    - MIX Join and Leave communication goes through the clients server. The full specification of client interaction with the client's server is specified in MIX-PAM. This specification shows the protocol between the user's server and the MIX server and sets out behaviour of the MIX server. + MIX Join and Leave communication goes through the client's server. The full specification of client interaction with the client's server is specified in MIX-PAM. This specification shows the protocol between the user's server and the MIX server and sets out behaviour of the MIX server.

    @@ -1116,11 +1116,11 @@ ]]>

    - A user MAY specify a nick when joining the channel. Channels MAY have mandatory nicks, which is default behavior. Therefore it will generally be necessary to include a nick when joining an channel. If nick is missing on a channel where nick is mandatory, the join MUST be rejected. Other error cases are dealt with below with the nick management commands. Where a nick is specified, the join will only complete if the nick is accepted. The nick used MUST be reported back in the join result. + A user MAY specify a nick when joining the channel. Channels MAY have mandatory nicks, which is default behavior. Therefore it will generally be necessary to include a nick when joining a channel. If nick is missing on a channel where nick is mandatory, the join MUST be rejected. Other error cases are dealt with below with the nick management commands. Where a nick is specified, the join will only complete if the nick is accepted. The nick used MUST be reported back in the join result.

    -

    Users generally remain in a channel for an extended period of time. In particular the user remains as a participant the channel when the user goes offline. Note that this is different to &xep0045;, where the client leaves a room when going offline. So, leaving a MIX channel is a permanent action for a user across all clients. In order to leave a channel, the user's server sends a MIX "leave" command to the channel, as specified in MIX-PAM. The leave command is encoded as a <leave/> child element of <iq/> element. The <leave/> element is qualified by the 'urn:xmpp:mix:core:1' namespace. The following example shows a leave request to a MIX channel.

    +

    Users generally remain in a channel for an extended period of time. In particular the user remains as a participant of the channel when the user goes offline. Note that this is different to &xep0045;, where the client leaves a room when going offline. So, leaving a MIX channel is a permanent action for a user across all clients. In order to leave a channel, the user's server sends a MIX "leave" command to the channel, as specified in MIX-PAM. The leave command is encoded as a <leave/> child element of <iq/> element. The <leave/> element is qualified by the 'urn:xmpp:mix:core:1' namespace. The following example shows a leave request to a MIX channel.

    Harpier cries: 'tis time, 'tis time. - - thirdwitch - hag66@shakespeare.example + + thirdwitch + hag66@shakespeare.example @@ -506,7 +506,7 @@ This approach enables flexible support of multiple clients for a MIX channel pa     -

    It is useful for a MIX client to know which roster members are MIX channels, as this will facilitate convenient presentation of subscribed MIX channels to the user. A MIX client MAY request that the server return this additional information that annotates roster elements with MIX capability. The server MUST return the additional information. The request is made by extending the standard roster get request by adding a child element <annotate/> to the <query/> element. The <annotate/> element is qualified by the ‘urn:xmpp:mix:roster:0' namespace.

    +

    It is useful for a MIX client to know which roster members are MIX channels, as this will facilitate convenient presentation of subscribed MIX channels to the user. A MIX client MAY request that the server returns this additional information that annotates roster elements with MIX capability. The server MUST return the additional information. The request is made by extending the standard roster get request by adding a child element <annotate/> to the <query/> element. The <annotate/> element is qualified by the ‘urn:xmpp:mix:roster:0' namespace.

    Invitation by reference, as described in the previous section, is a convenient approach to invite a user to join a channel that the user has permission to join. This section describes the approach used when the inviter has permission to grant rights for the invitee to become a channel participant. This might be because the inviter is an administrator of the channel or the channel or if the inviter is a channel participant and the channel allows invitation by participants (this channel capability is controlled by the channel configuration variable 'Participation Addition by Invitation from Participant'). Invitation by reference is used to avoid cluttering the allowed node with JIDs of users who are invited to join, but do not accept the invitation. - When a channel participant(the inviter) invites another user (the invitee) to join a channel, the following sequence of steps is followed: + When a channel participant (the inviter) invites another user (the invitee) to join a channel, the following sequence of steps is followed:

      @@ -230,7 +230,7 @@
    1. The invitee MAY send a response to the inviter, indicating if the invitation was accepted or declined.

    - The first step is for the inviter to request an invitation from the channel. The invitation contains inviter, invitee and a token. The channel will evaluate if the inviter has rights to issue the invitation. This will be because the inviter is a channel administrator or if the inviter is a channel participant and the channel allows invitation by participants. If the inviter has rights to make the invitation, the channel will return a token. The token is a string that the channel can subsequently use to validate an invitation. The format of the token is not specified in this standard. The encoded token MAY reflect a validity time. The invitation request is encoded as an <invite/> child element of an <iq/> element. The <invite/> element is qualified by the 'urn:xmpp:mix:misc:0' namespace. <invite/> contains an <invitation/> child element, which contain <inviter/>, <invitee/>, <channel/> and <token/> child elements. + The first step is for the inviter to request an invitation from the channel. The invitation contains inviter, invitee and a token. The channel will evaluate if the inviter has rights to issue the invitation. This will be because the inviter is a channel administrator or if the inviter is a channel participant and the channel allows invitation by participants. If the inviter has rights to make the invitation, the channel will return a token. The token is a string that the channel can subsequently use to validate an invitation. The format of the token is not specified in this standard. The encoded token MAY reflect a validity time. The invitation request is encoded as an <invite/> child element of an <iq/> element. The <invite/> element is qualified by the 'urn:xmpp:mix:misc:0' namespace. <invite/> contains an <invitation/> child element, which contains <inviter/>, <invitee/>, <channel/> and <token/> child elements.

    - Would you like to join the coven? + Would you like to join the coven? hag66@shakespeare.example cat@shakespeare.example coven@mix.shakespeare.example ABCDEF - + ]]>

    The invitation can now be used by the invitee to join a channel. The <invitation/> child element is simply added to the standard channel <join/> element, so that the channel can validate the invitation using the token. If the allowed node is present and the invitee is not matched against any item, the channel MUST add the invitee to the allowed node as part of the join.

    Date: Mon, 4 May 2020 20:29:56 +0200 Subject: [PATCH 15/22] XEP-0359: Correct example caption --- xep-0359.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xep-0359.xml b/xep-0359.xml index f58e9631..55e0135a 100644 --- a/xep-0359.xml +++ b/xep-0359.xml @@ -127,7 +127,7 @@

    Some use cases require the originating entity, e.g. a client, to generate the stanza ID. In this case, the client MUST use the &origin-id; element extension element qualified by the 'urn:xmpp:sid:0' namespace. Note that originating entities often want to conceal their XMPP address and therefore the &origin-id; element has no 'by' attribute.

    - From 55a8b66e21a681170c7c77c76c48c6e3cb88ca19 Mon Sep 17 00:00:00 2001 From: Martin Dosch Date: Sun, 1 Nov 2020 12:21:32 +0100 Subject: [PATCH 16/22] Treat XEPs in Deferred state the same as in Experimental state. --- docs/TRIAGING.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/docs/TRIAGING.md b/docs/TRIAGING.md index 992de116..dbe82654 100644 --- a/docs/TRIAGING.md +++ b/docs/TRIAGING.md @@ -90,10 +90,10 @@ If the PR is not touching a XEP, this guide does not apply. sense (an example is updating multiple XEPs which belong together, such as the MIX family). -4. Is the XEP **not** in Experimental state? +4. Is the XEP **not** in Experimental or Deferred state? - Changes to Non—Experimental XEPs need approval by the approving body as - defined in the XEP file itself. + Changes to Non—Experimental or non-Deferred XEPs need approval by the + approving body as defined in the XEP file itself. 1. Add the [Needs Council]/[Needs Board] label. To know which, check the `` of the XEPs. If the touched XEPs have different approvers @@ -111,10 +111,10 @@ If the PR is not touching a XEP, this guide does not apply. (second) version number part, add the [Needs Version Block] label and a comment explaining the situation for the next Editor (the Author does not need to do anything here). - 5. Stop. + 6. Stop. -5. Is the XEP in Experimental state and the PR opener is not an author of the - XEP? +5. Is the XEP in Experimental or Deferred state and the PR opener is not an + author of the XEP? Changes to Experimental XEPs are approved by the XEP Authors themselves. If the PR touches multiple XEPs and the XEP Authors do not overlap, ask @@ -137,7 +137,9 @@ If the PR is not touching a XEP, this guide does not apply. for each author in either the XEP or in xep.ent. 4. Stop. - 4. Otherwise, mark the PR as [Ready to Merge], linking the XEP Author’s + 4. If the XEP is in Deferred state and the changes are not purely editorial, + add a note to move the XEP to Experimental state. + 5. Otherwise, mark the PR as [Ready to Merge], linking the XEP Author’s approval for documentation purposes. 6. Mark the PR as [Ready to Merge]. From d6b210ea534b3044b48ba92eac18ae8f2b803490 Mon Sep 17 00:00:00 2001 From: Martin Dosch Date: Sun, 1 Nov 2020 12:28:26 +0100 Subject: [PATCH 17/22] Add tag [Needs Editor Action] for non-editorial changes to deferred XEPs. --- docs/TRIAGING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/TRIAGING.md b/docs/TRIAGING.md index dbe82654..68b07b9c 100644 --- a/docs/TRIAGING.md +++ b/docs/TRIAGING.md @@ -138,7 +138,8 @@ If the PR is not touching a XEP, this guide does not apply. 4. Stop. 4. If the XEP is in Deferred state and the changes are not purely editorial, - add a note to move the XEP to Experimental state. + add a note to move the XEP to Experimental state and mark the PR as + [Needs Editor Action]. 5. Otherwise, mark the PR as [Ready to Merge], linking the XEP Author’s approval for documentation purposes. From b9160265f4a3239619cd79832d684c7f387b6190 Mon Sep 17 00:00:00 2001 From: Martin Dosch Date: Sun, 1 Nov 2020 12:33:27 +0100 Subject: [PATCH 18/22] Change no longer appropriate wording. --- docs/TRIAGING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/TRIAGING.md b/docs/TRIAGING.md index 68b07b9c..5715b182 100644 --- a/docs/TRIAGING.md +++ b/docs/TRIAGING.md @@ -140,8 +140,8 @@ If the PR is not touching a XEP, this guide does not apply. 4. If the XEP is in Deferred state and the changes are not purely editorial, add a note to move the XEP to Experimental state and mark the PR as [Needs Editor Action]. - 5. Otherwise, mark the PR as [Ready to Merge], linking the XEP Author’s - approval for documentation purposes. + 5. Mark the PR as [Ready to Merge], linking the XEP Author’s approval for + documentation purposes. 6. Mark the PR as [Ready to Merge]. From 66fb96fd1733e28941526c413eed8bb7c9e3a4a6 Mon Sep 17 00:00:00 2001 From: Martin Dosch Date: Sun, 1 Nov 2020 12:42:43 +0100 Subject: [PATCH 19/22] Change order of steps for Experimental/Deferred XEPs. --- docs/TRIAGING.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/TRIAGING.md b/docs/TRIAGING.md index 5715b182..d7438a08 100644 --- a/docs/TRIAGING.md +++ b/docs/TRIAGING.md @@ -125,7 +125,10 @@ If the PR is not touching a XEP, this guide does not apply. 2. If the PR adds a revision block and does not bump the minor-level (second) version number part, add the [Needs Version Block] label and a comment explaining the situation for the Processing Editor. - 3. If the issue has not been discussed on the standards list *or* if + 3. If the XEP is in Deferred state and the changes are not purely editorial, + add a note to move the XEP to Experimental state and mark the PR as + [Needs Editor Action]. + 4. If the issue has not been discussed on the standards list *or* if the XEP Author has not been involved in the discussion *or* the XEP Author has not explicitly ACKed the PR: @@ -137,11 +140,8 @@ If the PR is not touching a XEP, this guide does not apply. for each author in either the XEP or in xep.ent. 4. Stop. - 4. If the XEP is in Deferred state and the changes are not purely editorial, - add a note to move the XEP to Experimental state and mark the PR as - [Needs Editor Action]. - 5. Mark the PR as [Ready to Merge], linking the XEP Author’s approval for - documentation purposes. + 5. Otherwise, mark the PR as [Ready to Merge], linking the XEP Author’s + approval for documentation purposes. 6. Mark the PR as [Ready to Merge]. From 8c16649ff47f65c51528963fbafec495785b6766 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jonas=20Sch=C3=A4fer?= Date: Tue, 3 Nov 2020 16:45:15 +0100 Subject: [PATCH 20/22] XEP-{0369,0405,407}: add revision block --- xep-0369.xml | 6 ++++++ xep-0405.xml | 6 ++++++ xep-0407.xml | 6 ++++++ 3 files changed, 18 insertions(+) diff --git a/xep-0369.xml b/xep-0369.xml index 82d9a36b..6f3e2401 100644 --- a/xep-0369.xml +++ b/xep-0369.xml @@ -35,6 +35,12 @@ MIX-CORE &ksmithisode; &skille; + + 0.14.5 + 2020-11-03 + gh/@melvo +

    Fix various typos

     +     0.14.4 2020-03-26 diff --git a/xep-0405.xml b/xep-0405.xml index 84ae2b0d..c9886d31 100644 --- a/xep-0405.xml +++ b/xep-0405.xml @@ -38,6 +38,12 @@ MIX-PAM &ksmithisode; &skille; + + 0.5.1 + 2020-11-03 + gh/@melvo +

    Fix various typos

     +     0.5.0 2019-09-30 diff --git a/xep-0407.xml b/xep-0407.xml index 7a137c03..4ed18a1b 100644 --- a/xep-0407.xml +++ b/xep-0407.xml @@ -36,6 +36,12 @@ MIX-MISC &ksmithisode; &skille; + + 0.1.2 + 2020-11-03 + gh/@melvo +

    Fix various typos

     +     0.1.1 2018-11-03 From 04dec157dbc28781d1653a20a0124f56505463b4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jonas=20Sch=C3=A4fer?= Date: Tue, 3 Nov 2020 16:47:01 +0100 Subject: [PATCH 21/22] XEP-0420: add revision block --- xep-0420.xml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/xep-0420.xml b/xep-0420.xml index ce950363..d4dec42b 100644 --- a/xep-0420.xml +++ b/xep-0420.xml @@ -30,6 +30,12 @@ SCE &paulschaub; + + 0.3.1 + 2020-11-03 + gh/@melvo +

    Fix misspelling of 'whose'

     +     0.3.0 2020-07-03 From e61637d0b13b8462ba6bdbc5ba42718addaf1bbf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jonas=20Sch=C3=A4fer?= Date: Tue, 3 Nov 2020 16:48:16 +0100 Subject: [PATCH 22/22] XEP-0359: add revision block --- xep-0359.xml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/xep-0359.xml b/xep-0359.xml index 55e0135a..c3f6e493 100644 --- a/xep-0359.xml +++ b/xep-0359.xml @@ -24,6 +24,12 @@ stanza-id &flow; + + 0.6.1 + 2020-11-03 + gh/@melvo +

    Correct example caption

     +     0.6.0 2018-10-01