End-to-end encryption between XMPP clients and mutual authentication between a client and a server are desirable goals for the XMPP network. To enable these features, typically an XMPP user will need to possess a public key (or multiple keys), along with an associated private key that is not made public. The goal of this document is to provide simple methods for the exchange of public keys among XMPP users -- specifically, data formats that enable an XMPP entity to complete the following use cases:
This document assumes that each user will have a privately-generated key. A user might have more than one key (e.g., different keys for different clients) and the user's key might be signed by other entities, such as a certification authority (CA) or another user. However, the simplest case is a single key per user.
We define three payload elements:
An entity MAY support only public key publishing (the 'urn:xmpp:pubkey:2' namespace) and not support revocations and attestations.
A single public key is contained in a <pubkey/> element qualified by the 'urn:xmpp:pubkey:2' namespace (see Namespace Versioning regarding the possibility of incrementing the version number), for which the defined child elements are as follows:
|<begin/>||The UTC DateTime before which the key shall not be considered valid, formatted according to XMPP Date and Time Profiles (XEP-0082) .|
|<end/>||The UTC DateTime after which the key shall not be considered valid, formatted according to XEP-0082.|
|<jid/>||The XMPP address associated with this key.|
|<rsakey/>||An element with three defined children for the modulus, public exponent, and fingerprint, where the input string to the hash function is the concatenation of the begin date, the end date, the JID, the string representation of the modulus, and the string representation of the public exponent, all encoded according to UTF-8 -- e.g., Base64(SHA-256(UTF8-encode(begin + end + jid + str(modulus) + str(exponent))).|
|<uri/>||A URI at which the key can be retrieved outside the XMPP network; this element is OPTIONAL.|
The children of the <rsakey/> element are as follows.
|<modulus/>||A large random number used as input to encryption and signing operations.|
|<publicExponent/>||The public exponent used as input to encryption and signing operations; RECOMMENDED to be "65537".|
|<print/>||A fingerprint for the key, where the algorithm used to generate the fingerprint is specified by the 'algo' attribute (whose default value is "sha-256").|
An example follows.
A user can revoke his own key. The revocation is contained in a <revoke/> element qualified by the 'urn:xmpp:revoke:2' namespace (see Namespace Versioning regarding the possibility of incrementing the version number), for which the defined child elements are as follows:
|<key/>||The public key that was revoked.|
|<keyprint/>||The fingerprint of the public key that was revoked, where the algorithm is specified by the 'algo' attribute (which defaults to "sha-256").|
|<signature/>||A signature for the revocation, as described below.|
|<revocationprint/>||The fingerprint of the key that was used to sign the revocation, where the algorithm is specified by the 'algo' attribute (which defaults to "sha-256").|
|<revocationtime/>||The UTC DateTime at which the key was revoked, formatted according to XEP-0082.|
The data that is signed MUST be the revoked public key (i.e., the XML character data of the <key/> element), the fingerprint of the revoked public key (i.e., the XML character data of the <keyprint/> element), the fingerprint of the key used to sign the revocation (i.e., the XML character data of the <revocationprint/> element), and the time of the revocation (i.e., the XML character data of the <revocationtime/> element), concatenated together with no spaces or other additional characters.
As an example, consider a revocation of the key from Example 1, where the fingerprint of the revoked key is 13475c8e27399908b4447d7c52ab30822872832eba3a654f0d80e07fb4157673, the fingerprint of the key used to sign the revocation is becb78566783166f4a1a7c64e28dae288fe1a0f2825f6b593b336ce186c6b056, and the time of the revocation is 2009-12-14T20:49:16Z. The string to be signed would be as follows (where line breaks are not significant).
An example follows.
Whether in the context of the public key infrastructure (PKI) or a web of trust, a user might want to publish signed copies of his public key, where the signer might be another user or a trusted third party such as a certification authority (CA). The signing key could even be another key owned by the user (e.g., a primary key used to sign a secondary key associated with a particular device controlled by the user). Furthermore, the signing material might be an RSA key, a DSA key, an X.509 certificate, an OpenPGP key, or any other format.
Each signed copy is contained in an <attest/> element qualified by the 'urn:xmpp:attest:2' namespace (see Namespace Versioning regarding the possibility of incrementing the version number), for which the defined child elements are as follows:
|<keyprint/>||The fingerprint of the key that was signed, where the algorithm is specified by the 'algo' attribute (which defaults to "sha-256").|
|<signature/>||The signature itself, as described below.|
|<signerjid/>||The XMPP address of the signer.|
|<signerprint/>||The fingerprint of the signer's key, where the algorithm is specified by the 'algo' attribute (which defaults to "sha-256").|
|<signtime/>||The UTC DateTime at which the key was signed, formatted according to XEP-0082.|
The data that is signed MUST be the user's public key (i.e., the XML character data of the <key/> element), the fingerprint of the user's public key (i.e., the XML character data of the <keyprint/> element), the signer's JID (i.e., the XML character data of the <signerjid/> element), the fingerprint of the signer's key (i.e., the XML character data of the <signerprint/> element), and the time of the attestation (i.e., the XML character data of the <signtime/> element), concatenated together with no spaces or other additional characters.
As an example, consider an attestation of the key from Example 1, where the signer's JID is email@example.com, the fingerprint of the signer's key is "becb78566783166f4a1a7c64e28dae288fe1a0f2825f6b593b336ce186c6b056", and the time of the attestation is 2009-12-14T18:43:00Z. The string to be signed would be as follows (where line breaks are not significant).
A user SHOULD publish public keys, attestations, and revocations via Personal Eventing Protocol (XEP-0163) , in particular adhering to the best practices defined in Best Practices for Persistent Storage of Public Data via Publish-Subscribe (XEP-0222) .
Any other authorized entity can then receive notifications related to the user's public keys, and retrieve keys, attestations, and revocations.
If the user has only one public key (the simplest and most common case), then the pubkey PEP node SHOULD have only one item, with an ItemID of "current".
If it is not possible for the user to publish his key via PEP, or for a contact to retrieve the user's key via PEP, the contact MAY request the user's key directly by sending an <iq/> of type 'get' to the user's particular full JID, containing an empty <pubkey/> element qualified by the 'urn:xmpp:pubkey:2' namespace (see Namespace Versioning regarding the possibility of incrementing the version number).
The receiving client then return its public key (which might be different from the overall key for the user, e.g. a key for only a particular device).
An entity might need to send its public key to another entity, for example if it has generated a new key but does not have a way to publish the new key (or does not wish to publish the key in a world-readable fashion). In this case the entity MAY include the key directly in a <message/> stanza.
There are several situations in which it is helpful for an entity to signal that it is currently generating a key. For example, a client that does not have access to permanent storage might generate a key on startup, but key generation might not be complete when the client sends initial presence upon establishing an XMPP session. In this case the client might signal support for the public key format in the entity capabilities data that it includes in its initial presence broadcast, but also include an indication that it is currently generating a key.
After key generation is complete, the entity could publish the new key to the appropriate PEP node (if available) and send updated presence without the <generating/> extension.
To advertise its support for public keys, revocations, and attestations, when replying to Service Discovery (XEP-0030)  information requests an entity MUST return features for 'urn:xmpp:pubkey:2', 'urn:xmpp:revoke:2', and 'urn:xmpp:attest:2' respectively.
In order for an application to determine whether an entity supports this protocol, where possible it SHOULD use the dynamic, presence-based profile of service discovery defined in Entity Capabilities (XEP-0115) . However, if an application has not received entity capabilities information from an entity, it SHOULD use explicit service discovery instead.
The reliable association between a user or entity and its public keys is beyond the scope of this document. However, each client SHOULD maintain its own secure library of the public keys it associates with other users.
This document requires no interaction with the Internet Assigned Numbers Authority (IANA) .
This specification defines the following XML namespaces:
Upon advancement of this specification to a status of Draft, the XMPP Registrar  shall add these namespaces to the registry located at <https://xmpp.org/registrar/namespaces.html>, as described in Section 4 of XMPP Registrar Function (XEP-0053) .
If the protocol defined in this specification undergoes a revision that is not fully backwards-compatible with an older version, the XMPP Registrar shall increment the protocol version number found at the end of the XML namespaces defined herein, as described in Section 4 of XEP-0053.
This document in other formats: XML PDF
This XMPP Extension Protocol is copyright © 1999 – 2020 by the XMPP Standards Foundation (XSF).
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.
## 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. ##
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.
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).
The Extensible Messaging and Presence Protocol (XMPP) is defined in the XMPP Core (RFC 6120) and XMPP IM (RFC 6121) specifications contributed by the XMPP Standards Foundation to the Internet Standards Process, which is managed by the Internet Engineering Task Force in accordance with RFC 2026. Any protocol defined in this document has been developed outside the Internet Standards Process and is to be understood as an extension to XMPP rather than as an evolution, development, or modification of XMPP itself.
The primary venue for discussion of XMPP Extension Protocols is the <firstname.lastname@example.org> discussion list.
Discussion on other xmpp.org discussion lists might also be appropriate; see <http://xmpp.org/about/discuss.shtml> for a complete list.
Errata can be sent to <email@example.com>.
The following requirements keywords as used in this document are to be interpreted as described in RFC 2119: "MUST", "SHALL", "REQUIRED"; "MUST NOT", "SHALL NOT"; "SHOULD", "RECOMMENDED"; "SHOULD NOT", "NOT RECOMMENDED"; "MAY", "OPTIONAL".
1. XML Signature Syntax and Processing <http://www.w3.org/TR/2002/REC-xmldsig-core-20020212/>.
7. The Internet Assigned Numbers Authority (IANA) is the central coordinator for the assignment of unique parameter values for Internet protocols, such as port numbers and URI schemes. For further information, see <http://www.iana.org/>.
8. The XMPP Registrar maintains a list of reserved protocol namespaces as well as registries of parameters used in the context of XMPP extension protocols approved by the XMPP Standards Foundation. For further information, see <https://xmpp.org/registrar/>.
Note: Older versions of this specification might be available at http://xmpp.org/extensions/attic/
Defined an RSA-specific child element of the pubkey element to contain the modulus, public exponent, and fingerprint directly (rather than a DER-encoded format that depends on ASN.1); specified that the public exponent should be 65537; clarified the fingerprint generation method and updated all of the fingerprint formats to enable hash agility; incremented namespaces from version 1 to version 2.
Updated the fingerprint generation method to hash over the begin date, end date, JID, and public key (not just the key itself).
Removed presence extension for generated state (implied by lack of generating flag).
Added back example of sending public key in a message; defined presence extension to signal key generation in progress.
Major revision; split into three namespaces and three corresponding PEP nodes, one each for public keys, attestations, and revocations; iterated the version number for public keys to urn:xmpp:pubkey:1; added detailed data to each node payload; removed some use cases to simply the protocol.
Required specification of an algorithm for elements with hashes; removed fingerprint in <keyinfo/>; added sign request; added guidelines for key management; improved examples; changed namespace from urn:xmpp:tmp:pubkey to urn:xmpp:pubkey:0.
Change KeyInfo element from W3C XML Signature to ASCII and add signature support
Changed temporary namespace per XEP-0053 procedures; corrected several small errors in the text and examples.
More clearly explained node creation and key publication workflows.
Merged node creation and first publish examples; recommended the value of each <KeyName/> element and id attribute is set to the key fingerprint; added fprint element and more examples
Added jid attribute and send use case; changed namespace
Specified that PEP nodes SHOULD be persistent
Replaced pubkey and key elements with the KeyInfo element defined in W3C XML Signature