XEP-XXXX: Client Key Support

3.1 Client Registration¶

Client registration requests a Client Key from the server. It is typically used to speed reauthentication during a session, and to elide a full reauthentication at the start of a subsequent session.

In order to register and obtain a Client Key, a client sends an <iq/> of type "set" containing an XML representation of the data required, within a <register/> element qualified by the 'urn:xmpp:client-key:0' namespace, containing four elements in any order. Descriptions of values are here informative; the canonical definition is in draft-cridland-kitten-clientkey-00.txt.

<id/> has a text value of the ClientID, a suitable identifier for the client instance, unique within the scope of the authenticated (<localpart@domain.tld> or <domain.tld>).

<name/> has a text value of the Client Name, a human-readable name for the client instance.

<key/> has a text value of the ValidationKey, encoded using Base 64. Implementors are strongly advised to take careful note of the requirements of the ValidationKey as discussed in draft-cridland-kitten-clientkey-00.txt.

<ttl/> has a text value containing a integer string representation of the number of seconds the Client Key is requested to last for.

In the following example, the ValidationKey is H("Random"), and the TTL is for 30 days - a reasonable "Remember this client" option.

<iq type='set' id='123456'>
  <register xmlns='urn:xmpp:client-key:0'>
    <id>213456-987123-123987</iq>
    <name>SuperChatBiscuit on Honest Pete's Mobile OS</name>
    <key>WNiIwIqlYfNw44zul2EhUyqIPXE=</key>
    <ttl>2592000</ttl>
  </register>
</iq>
      

The server responds with two items of information in a <registered/> element qualified by the 'urn:xmpp:client-key:0' namespace. The EncryptedSecret is contained within a <encrypted-secret/> element as a base64-encoded value, and the <expiry/> element contains a timestamp for expiry.

<iq type='result' id='123456'>
  <registered xmlns='urn:xmpp:client-key:0'>
    <encrypted-secret>WNiIwIqlYfNw44zul2EhUyqIPXE=</encrypted-secret>
    <expiry>2017-10-15T12:00:00Z</expiry>
  </registered>
</iq>

Note that the expiry time might not be 30 days simply because the client has requested it - the server is free to shorten expiry times.

3.2 Key Revocation¶

Any authenticated client may revoke a key belonging to the same user by sending an <iq/> of type "set" containing a <revoke/> element qualified by the 'urn:xmpp:client-key:0' namespace, containing a <key/> element whose text value is the ClientID corresponding to the key to be revoked.

<iq type='set' id='123456'>
  <revoke xmlns='urn:xmpp:client-key:0'>
    <id>213456-987123-123987</iq>
  </revoke>
</iq>
      

3.3 Key Enumeration¶

Any authenticated client may enumerate keys belonging to the same user by sending an <iq/> of type "get" containing a <list/> element qualified by the 'urn:xmpp:client-key:0' namespace.

<iq type='get' id='123456'>
  <list xmlns='urn:xmpp:client-key:0'/>
</iq>
      

The server responds with an <iq/> of type 'result', containing the <list/> element qualified by the 'urn:xmpp:client-key:0' namespace. This element contains a sequence of <key/> elements each containing (in any order) the <id/>, <name/> and <expiry/> elements as in registration.

<iq type='result' id='123456'>
  <list xmlns='urn:xmpp:client-key:0'>
    <key>
      <id>213456-987123-123987</iq>
      <name>SuperChatBiscuit on Honest Pete's Mobile OS</name>
      <expiry>2017-10-15T12:00:00Z</expiry>
    </key>
    <key>
      <id>313456-987123-123987</iq>
      <name>SuperChatChocolate on Honest Bob's Mobile OS</name>
      <expiry>2018-01-08T12:00:00Z</expiry>
    </key>
  </list>
</iq>
      

Copyright

This XMPP Extension Protocol is copyright © 1999 – 2024 by the XMPP Standards Foundation (XSF).

Permissions

Permission is hereby granted, free of charge, to any person obtaining a copy of this specification (the "Specification"), to make use of the Specification without restriction, including without limitation the rights to implement the Specification in a software program, deploy the Specification in a network service, and copy, modify, merge, publish, translate, distribute, sublicense, or sell copies of the Specification, and to permit persons to whom the Specification is furnished to do so, subject to the condition that the foregoing copyright notice and this permission notice shall be included in all copies or substantial portions of the Specification. Unless separate permission is granted, modified works that are redistributed shall not contain misleading information regarding the authors, title, number, or publisher of the Specification, and shall not claim endorsement of the modified works by the authors, any organization or project to which the authors belong, or the XMPP Standards Foundation.

Disclaimer of Warranty

## NOTE WELL: This Specification is provided on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. ##

Limitation of Liability

In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall the XMPP Standards Foundation or any author of this Specification be liable for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising from, out of, or in connection with the Specification or the implementation, deployment, or other use of the Specification (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if the XMPP Standards Foundation or such author has been advised of the possibility of such damages.

IPR Conformance

This XMPP Extension Protocol has been contributed in full conformance with the XSF's Intellectual Property Rights Policy (a copy of which can be found at <https://xmpp.org/about/xsf/ipr-policy> or obtained by writing to XMPP Standards Foundation, P.O. Box 787, Parker, CO 80134 USA).

Visual Presentation

The HTML representation (you are looking at) is maintained by the XSF. It is based on the YAML CSS Framework, which is licensed under the terms of the CC-BY-SA 2.0 license.

1. XEP-0388: Extensible SASL Profile <https://xmpp.org/extensions/xep-0388.html>.