moparisthebest/xeps
1
0
Fork 0
mirror of https://github.com/moparisthebest/xeps synced 2024-11-12 04:15:00 -05:00
Code Issues Releases Wiki Activity

XEP-0389: major updates to add more flexibility

Browse Source 
Zash reached out to me to ask if extensible IBR could be made compatible
with XEP-0401: Easy User Onboarding. While working on a solution to this
I decided it would also be nice if it could also allow the user to pick
between several flows (eg. "Verify by Phone" vs  "Verify by SMS").
After working this up I came to realize that the current version of the
spec could not be used to replace XEP-0077 as it is used by XEP-0045 and
other XEPs because I wasn't using routeable stanzas that could be sent
to components and had no way to discover support other than during
stream feature negotation.

This patch set turned into an overhaul of the proposal to fix all these
problems and move the spec back out of experimental.
This commit is contained in:
Sam Whited 2020-04-19 15:15:43 -04:00
parent 357497d259
commit 0f6f0ad9eb
1 changed files with 134 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

198
xep-0389.xml
View File

@ -18,7 +18,7 @@
</abstract> </abstract>
&LEGALNOTICE; &LEGALNOTICE;
<number>0389</number> <number>0389</number>
<status>Deferred</status> <status>Experimental</status>
<type>Standards Track</type> <type>Standards Track</type>
<sig>Standards</sig> <sig>Standards</sig>
<approver>Council</approver> <approver>Council</approver>
@ -31,6 +31,18 @@
<supersededby/> <supersededby/>
<shortname>ibr2</shortname> <shortname>ibr2</shortname>
&sam; &sam;
<revision>
<version>0.3.0</version>
<date>2020-04-19</date>
<initials>ssw</initials>
<remark>
<ul>
<li>Move back to experimental.</li>
<li>Add IQ variant of registration/recovery.</li>
<li>Allow client to select between multiple flows.</li>
</ul>
</remark>
</revision>
<revision> <revision>
<version>0.2.0</version> <version>0.2.0</version>
<date>2018-10-01</date> <date>2018-10-01</date>
@ -42,9 +54,7 @@
<date>2017-03-16</date> <date>2017-03-16</date>
<initials>XEP Editor (ssw)</initials> <initials>XEP Editor (ssw)</initials>
<remark> <remark>
<ul> Move to experimental.
<li>Move to experimental.</li>
</ul>
</remark> </remark>
</revision> </revision>
<revision> <revision>
@ -67,9 +77,9 @@
</header> </header>
<section1 topic='Introduction' anchor='intro'> <section1 topic='Introduction' anchor='intro'>
<p> <p>
Historically, registering with an XMPP service has been difficult. Each Historically, registering with an XMPP service has been difficult.
server either used customized out-of-band registration mechanisms such as Each server either used customized out-of-band registration mechanisms such
web forms which were difficult to discover, or they used &xep0077; which as web forms which were difficult to discover, or they used &xep0077; which
could easily be abused by spammers to register large numbers of accounts and could easily be abused by spammers to register large numbers of accounts and
which allowed for only limited extensibility. which allowed for only limited extensibility.
</p> </p>
@ -101,27 +111,12 @@
A client MUST be able to use the same mechanism to register an account and A client MUST be able to use the same mechanism to register an account and
to recover a forgotten password (subject to server policy). to recover a forgotten password (subject to server policy).
</li> </li>
<li>
A client MUST be able to register with a server as well as external
components.
</li>
</ul> </ul>
</section1> </section1>
<section1 topic='Glossary' anchor='glossary'>
<dl>
<di>
<dt>Proof-of-work (PoW)</dt>
<dd>
A proof-of-work protocol requires that a client perform a
computationally intense task which is easily verified by the server.
</dd>
</di>
<di>
<dt>Proof-of-possession (PoP)</dt>
<dd>
A proof-of-possession protocol requires that a client prove that they
have posession of some resource (eg. a shared secret, or a valid mobile
phone number).
</dd>
</di>
</dl>
</section1>
<section1 topic='Use Cases' anchor='usecases'> <section1 topic='Use Cases' anchor='usecases'>
<ul> <ul>
<li> <li>
@ -130,9 +125,8 @@
proof-of-work function before registration is completed. proof-of-work function before registration is completed.
</li> </li>
<li> <li>
As a server operator I want to prevent zombie machines from registering As a server operator I want to prevent bots from registering accounts so I
for accounts so I require that registrants submit a form which requires require that registrants submit a form which requires user interaction.
user interaction.
</li> </li>
<li> <li>
As a user I do not want to lose access to my account if I forget my As a user I do not want to lose access to my account if I forget my
@ -154,6 +148,7 @@
</ul> </ul>
</section1> </section1>
<section1 topic='Discovering Support' anchor='disco'> <section1 topic='Discovering Support' anchor='disco'>
<section2 topic='Stream Feature'>
<p> <p>
If a server supports registering for or recovering an account using If a server supports registering for or recovering an account using
Extensible IBR, it MUST inform the connecting client when returning stream Extensible IBR, it MUST inform the connecting client when returning stream
@ -164,7 +159,7 @@
recovery. recovery.
The register and recovery features are always voluntary-to-negotiate. The register and recovery features are always voluntary-to-negotiate.
The registration and recovery features MUST NOT be advertised before The registration and recovery features MUST NOT be advertised before
encryption has been negotiated, eg. using direct-TLS or STARTTLS. encryption has been negotiated, eg. using direct TLS or opportunistic TLS.
They SHOULD be advertised at the same time as the SASL authentication They SHOULD be advertised at the same time as the SASL authentication
feature, meaning that after registration or recovery is completed SASL feature, meaning that after registration or recovery is completed SASL
authentication can proceed. authentication can proceed.
@ -173,13 +168,30 @@
For recovery or registration, the server MUST include a list of all For recovery or registration, the server MUST include a list of all
challenge types which the client may receive during the course of challenge types which the client may receive during the course of
registering or recovering an account. registering or recovering an account.
The purpose of this list is to allow clients to detect if registration These are grouped into "flows" and let the client pick a registration
requires a challenge type which the client does not support, so servers workflow that only contains challenges which the client supports.
SHOULD only include each type once; the list is merely informative, and Each &lt;flow/&gt; element MUST have a unique "id" attribute which is used
should not be relied upon by clients except to ensure that all mechanisms by the client to identify the flow being selected.
are supported. They must also have at least one &lt;name/&gt; element containing a short,
This list should comprise &lt;challenge/&gt; elements containing a string human readable description of the flow.
that uniquely identifies the type of challenge being issued. If multiple &lt;name/&gt; elements are present they MUST have unique values
for the "xml:lang" attribute.
Clients MAY use the name element to show the different flows to the user and
ask them to pick between them.
Each flow must also contain a list of &lt;challenge/&gt; elements
representing the various challenges that must be completed to complete the
registration or recovery flow.
Each &lt;challenge/&gt; element contains a string that uniquely (within the
given parent element) identifies the type of challenge that will be offered.
If a flow would offer the same challenge twice (eg. two dataforms asking for
different data), the challenge SHOULD only be listed once in the flow
element.
</p>
<p>
For example, a server may advertise a "Verify with SMS" flow and a "Verify
by Phone Call" flow that both show a dataform asking for a phone number
and then a second dataform asking for a token provided to the user in a
text message or phone call depending on which flow the user selects.
</p> </p>
<example caption="Host Advertises Stream Features"><![CDATA[ <example caption="Host Advertises Stream Features"><![CDATA[
<stream:features> <stream:features>
@ -190,23 +202,67 @@
<mechanism>PLAIN</mechanism> <mechanism>PLAIN</mechanism>
</mechanisms> </mechanisms>
<register xmlns='urn:xmpp:register:0'> <register xmlns='urn:xmpp:register:0'>
<challenge>jabber:x:data'</challenge> <flow id="0">
<challenge>pow-example</challenge> <name>Verify with SMS</name>
<challenge>jabber:x:data</challenge>
</flow>
<flow id="1">
<name>Verify by Phone Call</name>
<challenge>jabber:x:data</challenge>
</flow>
<flow id="2">
<name>Verify with the web</name>
<challenge>jabber:x:data</challenge>
<challenge>jabber:x:oob</challenge>
</flow>
</register> </register>
<recovery xmlns='urn:xmpp:register:0'> <recovery xmlns='urn:xmpp:register:0'>
<challenge>jabber:x:oob</challenge> <flow id="0">
<name>Visit Password Recovery Site</name>
<challenge>jabber:x:oob</challenge>
</flow>
</recovery> </recovery>
</stream:features>]]></example> </stream:features>]]></example>
</section2>
<section2 topic='Service Discovery'>
<p>
Clients, servers, and other services such as components that support
Extensible IBR after stream negotiation is complete MUST advertise the
fact by including a feature of "urn::xmpp:register:0" in response to
&xep0030; information requests and in their &xep0115; profiles.
</p>
<example caption='Disco response'><![CDATA[
<feature var='urn:xmpp:register:0' />]]></example>
</section2>
</section1> </section1>
<section1 topic='Challenges' anchor='challenge'> <section1 topic='Challenges' anchor='challenge'>
<p> <p>
A client selects the registration or recovery feature for negotiation by A client selects the registration or recovery feature for negotiation by
replying with an empty element of the same name and namespace. replying with an element of the same name and namespace.
For example, to attempt account recovery the client would send a The element MUST contain a &lt;flow&gt; element that MUST have an "id"
&lt;recovery&gt; element qualified by the 'urn:xmpp:register:0' namespace. attribute matching one of the flows advertised by the server.
For example, to select the "Verify by Phone Call" registration flow from
the previous example, the client would reply with:
</p> </p>
<example caption="Client selects a recovery flow"><![CDATA[
<register xmlns='urn:xmpp:register:0'>
<flow id="1"/>
</register>]]></example>
<p> <p>
The server then replies with a challenge. If the client is initiating registration or recovery after a stream has
already been initiated it uses the same registration element wrapped in an
IQ of type "set".
</p>
<example caption="Client selects a recovery flow after stream negotiation"><![CDATA[
<iq type="set" id="foo">
<recovery xmlns='urn:xmpp:register:0'>
<flow id="0"/>
</recovery>
</iq>]]></example>
<p>
The server then replies to the IQ or feature selection with a challenge.
If replying to an IQ, the challenge must be wrapped in an IQ of type
"result".
Challenges take the form of a &lt;challenge/&gt; element qualified by the Challenges take the form of a &lt;challenge/&gt; element qualified by the
'urn:xmpp:register:0' namespace with a 'type' attribute containing the 'urn:xmpp:register:0' namespace with a 'type' attribute containing the
challenge type and containing a challenge data payload. challenge type and containing a challenge data payload.
@ -275,41 +331,55 @@
</x> </x>
</response> </response>
]]></example> ]]></example>
</section1>
<section1 topic='Completing Registration or Recovery' anchor='completion'>
<p> <p>
If after receiving a challenge a client does not wish to continue If after receiving a challenge or response a client or server does not wish
registration or recovery, it may send an empty &lt;cancel&gt; element to continue registration or recovery, it may send an empty &lt;cancel/&gt;
qualified by the 'urn:xmpp:register:0' namespace. element qualified by the 'urn:xmpp:register:0' namespace.
This informs the server that registration is complete. This informs the client or server that registration is complete.
This is the same as submitting a data form of type 'cancel' in response to a This is the same as submitting a data form of type 'cancel' in response to a
data form challenge. data form challenge.
</p> </p>
<example caption='User Cancels Registration or Recovery'><![CDATA[ <example caption='User Cancels Registration or Recovery'><![CDATA[
<cancel xmlns='urn:xmpp:register:0'/> <cancel xmlns='urn:xmpp:register:0'/>]]></example>
]]></example>
</section1>
<section1 topic='Completing Registration or Recovery' anchor='completion'>
<p> <p>
If the client submits invalid data, or the server wishes to cancel for some If the IQ based registration or recovery flow is being used and the server
other reason, it may reply with an empty &lt;cancel/&gt; element qualified wishes to cancel the flow, it MAY respond to any IQ from the client with the
by the 'urn:xmpp:register:0' namespace. cancel element and type "result".
If the client successfully completes the challenge, the server MAY return an </p>
empty &lt;success/&gt; element qualified by the 'urn:xmpp:register:0' <example caption='Server cancels rquest'><![CDATA[
namespace, at which point it may continue with the stream negotiation <iq type="result" id="bar">
process. <cancel xmlns='urn:xmpp:register:0'/>
</iq>]]></example>
<p>
If the client successfully completes all required challenges during stream
negotiation the server MUST return an empty &lt;success/&gt; element
qualified by the 'urn:xmpp:register:0' namespace, at which point it may
continue with the stream negotiation process.
If the server needs more information, for example, in the previous challenge If the server needs more information, for example, in the previous challenge
the user entered an email and now the server wishes to ask for a code that the user entered an email and now the server wishes to ask for a code that
was sent to that email, the server MAY send another challenge. was sent to that email, the server MAY send another challenge.
</p> </p>
<example caption='Server indicates success during steam negotiation'><![CDATA[
<success xmlns='urn:xmpp:register:0'/>]]></example>
<p>
If the IQ based flow is being used and the server wishes to indicate success
it sends an empty IQ response of type "result".
</p>
<example caption='Server indicates success after stream negotation'><![CDATA[
<iq type="result" id="bar" />]]></example>
</section1> </section1>
<section1 topic='Internationalization Considerations' anchor='i18n'> <section1 topic='Internationalization Considerations' anchor='i18n'>
<p> <p>
When providing instructions in a data form the server SHOULD use the When providing instructions in a data form, or in the name element of a
language specified in the XML stream's current xml:lang, or the closest registration or recovery flow, the server SHOULD use the language specified
language for which the server has a translation (eg. based on mutual in the XML stream's current xml:lang, or the closest language for which the
intelligibility between scripts and languages). server has a translation (eg. based on mutual intelligibility between
scripts and languages).
</p> </p>
<p> <p>
For more information about language tags and matching, see &bcp47; For more information about language tags and matching, see &bcp47;.
</p> </p>
</section1> </section1>
<section1 topic='Security Considerations' anchor='security'> <section1 topic='Security Considerations' anchor='security'>