XMPP | M. Miller |
Internet-Draft | Cisco Systems, Inc. |
Intended status: Standards Track | February 25, 2013 |
Expires: August 29, 2013 |
End-to-End Object Encryption and Signatures for the Extensible Messaging and Presence Protocol (XMPP)
draft-miller-xmpp-e2e-05
This document defines a method of encrypting and signing objects (often referred to as stanzas) for the Extensible Messaging and Presence Protocol (XMPP).
This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."
This Internet-Draft will expire on August 29, 2013.
Copyright (c) 2013 IETF Trust and the persons identified as the document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.
End-to-end protection and authentication of traffic sent over the Extensible Messaging and Presence Protocol [RFC6120] is a desirable goal. Requirements and a threat analysis for XMPP encryption are provided in [E2E-REQ]. Many possible approaches to meet those (or similar) requirements have been proposed over the years, including methods based on PGP, S/MIME, SIGMA, and TLS.
Most proposals have not been able to support multiple end-points for a given recipient. As more devices support XMPP, it becomes more desirable to allow an entity to communicate with another in a more secure manner, regardless of the number of agents the entity is employing. This document specifies an approach for encrypting and signing communications between two entities which each might have multiple end-points.
This document inherits XMPP-related terminology from [RFC6120], JSON Web Algorithms (JWA)-related terminology from [JOSE-JWA], JSON Web Encryption (JWE)-related terminology from [JOSE-JWE], and JSON Web Key (JWK)-related terminology from [JOSE-JWK]. Security-related terms are to be understood in the sense defined in [RFC4949].
The capitalized key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC2119].
If an agent supports receiving end-to-end object encryption, it MUST advertise that fact in its responses to [XEP-0030] information ("disco#info") requests by returning a feature of "urn:ietf:params:xml:ns:xmpp-e2e:6:encryption".
<iq xmlns='jabber:client' id='disco1' to='romeo@montegue.lit/garden' type='result'> <query xmlns='http://jabber.org/protocol/disco#info'> ... <feature xmlns='urn:ietf:params:xml:ns:xmpp-e2e:6:encryption'/> ... </query> </iq>
To facilitate discovery, an agent SHOULD also include [XEP-0115] information in any directed or broadcast presence updates.
The process that a sending agent follows for securing stanzas is the same regardless of the form of stanza (i.e., <iq/>, <message/>, or <presence/>).
First, the sending agent prepares and retains the following:
For a given plaintext stanza (S), the sending agent performs the following:
If the receiving agent does not understand the protocol, it MUST do one and only one of the following: (1) ignore the <e2e/> extension, (2) ignore the entire stanza, or (3) return a <service-unavailable/> error to the sender, as described in [RFC6120].
NOTE: If the inbound stanza is an <iq/>, the receiving agent MUST return an error to the sending agent, to comply with the exchanging of IQ stanzas in [RFC6121].
Upon receipt of an encrypted stanza, the receiving agent performs the following:
At step 1, if the receiving agent is unable to obtain the CMK, or the receiving agent could not otherwise determine the additional information, it MAY return a <bad-request/> error to the sending agent (as described in [RFC6120]), optionally supplemented by an application-specific error condition element of <insufficient-information/>:
<message xmlns='jabber:client' from='juliet@capulet.lit/balcony' id='fJZd9WFIIwNjFctT' to='romeo@montegue.lit/garden' type='chat'> <e2e xmlns='urn:ietf:params:xml:ns:xmpp-e2e:6' id='835c92a8-94cd-4e96-b3f3-b2e75a438f92'> <encheader>[XML character data]</encheader> <cmk>[XML character data]</cmk> <iv>[XML character data]</iv> <data>[XML character data]</data> <mac>[XML character data]</mac> </e2e> <error type='modify'> <bad-request xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> <insufficient-information xmlns='urn:ietf:params:xml:ns:xmpp-e2e:6'/> </error> </message>
In addition to returning an error, the receiving agent SHOULD NOT present the stanza to the intended recipient (human or application) and SHOULD provide some explicit alternate processing of the stanza (which MAY be to display a message informing the recipient that it has received a stanza that cannot be decrypted).
At step 2, if the receiving agent is unable to successfully decrypt the stanza, the receiving agent SHOULD return a <bad-request/> error to the sending agent (as described in [RFC6120]), optionally supplemented by an application-specific error condition element of <decryption-failed/> (previously defined in [RFC3923]):
<message xmlns='jabber:client' from='juliet@capulet.lit/balcony' id='fJZd9WFIIwNjFctT' to='romeo@montegue.lit/garden' type='chat'> <e2e xmlns='urn:ietf:params:xml:ns:xmpp-e2e:6' id='835c92a8-94cd-4e96-b3f3-b2e75a438f92'> <encheader>[XML character data]</encheader> <cmk>[XML character data]</cmk> <iv>[XML character data]</iv> <data>[XML character data]</data> <mac>[XML character data]</mac> </e2e> <error type='modify'> <bad-request xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> <decryption-failed xmlns='urn:ietf:params:xml:ns:xmpp-e2e:6'/> </error> </message>
In addition to returning an error, the receiving agent SHOULD NOT present the stanza to the intended recipient (human or application) and SHOULD provide some explicit alternate processing of the stanza (which MAY be to display a message informing the recipient that it has received a stanza that cannot be decrypted).
At step 4, if the stanza is successfully decrypted but the timestamp fails the checks outlined in Section 7, the receiving agent MAY return a <not-acceptable/> error to the sender (as described in [RFC6120]), optionally supplemented by an application-specific error condition element of <bad-timestamp/> (previously defined in [RFC3923]):
<message xmlns='jabber:client' from='juliet@capulet.lit/balcony' id='fJZd9WFIIwNjFctT' to='romeo@montegue.lit/garden' type='chat'> <e2e xmlns='urn:ietf:params:xml:ns:xmpp-e2e:6' id='835c92a8-94cd-4e96-b3f3-b2e75a438f92'> <encheader>[XML character data]</encheader> <cmk>[XML character data]</cmk> <iv>[XML character data]</iv> <data>[XML character data]</data> <mac>[XML character data]</mac> </e2e> <error type='modify'> <bad-request xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> <bad-timestamp xmlns='urn:ietf:params:xml:ns:xmpp-e2e:6'/> </error> </message>
If the receiving agent successfully decrypted the payload, it MUST NOT return a stanza error.
If the payload is an <iq/> of type "get" or "set", and the response to this <iq/> is of type "error", the receiving agent MUST send the encrypted response wrapped in an <iq/> of type "result", to prevent exposing information about the payload.
NOTE: unless otherwise indicated, all line breaks are included for readability.
The sending agent begins with the plaintext version of the <message/> stanza 'S':
<message xmlns='jabber:client' from='juliet@capulet.lit/balcony' to='romeo@montegue.lit' type='chat'> <thread>35740be5-b5a4-4c4e-962a-a03b14ed92f4</thread> <body> But to be frank, and give it thee again. And yet I wish but for the thing I have. My bounty is as boundless as the sea, My love as deep; the more I give to thee, The more I have, for both are infinite. </body> </message>
and the following prerequisites:
The sending agent performs steps 1, 2, and 3 from Section 3.2.2 to generate the envelope:
<forwarded xmlns='urn:xmpp:forward:0'> <delay xmlns='urn:xmpp:delay' stamp='1492-05-12T20:07:37.012Z'/> <message xmlns='jabber:client' from='juliet@capulet.lit/balcony' to='romeo@montegue.lit' type='chat'> <thread>35740be5-b5a4-4c4e-962a-a03b14ed92f4</thread> <body> But to be frank, and give it thee again. And yet I wish but for the thing I have. My bounty is as boundless as the sea, My love as deep; the more I give to thee, The more I have, for both are infinite. </body> </message> </forwarded>
Then the sending agent performs steps 4 through 7 (with Content Master Key as "upIjc_ePSomSETgi0DEnXsoT8ZEGf0QxsSHr_eDZRnlkJAJBFyenb6tm1WDAoqFD7-BHBtWqO5hOJlj2oxlDwQ", base64url encoded) to generate the [JOSE-JWE] outputs:
JWE Header
{ "alg":"A256KW", "enc":"A256CBC+HS512", "kid":"835c92a8-94cd-4e96-b3f3-b2e75a438f92" }
JWE Encrypted Key
4ui5xwE1gEYjuptNgSIaMFlwWrAOxMqBkaplTxeJ6b2iT8kQP2HHy5PYpqqmDxl QgT5I5rO9mgAD7AUJ9Lx35fGdi5CMiRww
JWE Initialization Vector
B7waCj2vF_sLaJfe-1GHrA
JWE Ciphertext
UYbe-ziNGBL74581rynr9MWu0Ble_6M5LFCH9xOYXgALtlDih28Ilmf-Rs68uaZ sOND-7Ii9zK4H4XBwJjxaUlDGChZPWdwotRZdQKt9ZLpiQmjkzrQgKVQqyexP6m qhfWRHutEKgs6vR32O2P98J-4LAWoUza5qYCZHP5NCogLUBVKi-v-vGpHDKBG_S w3ejHSXuZOEZtyXShL2d6EXOhEzft8ViaTUKhiBCLz1q39hI5TsPdS7NPHGQDUX Db_gSw8yVCiJgxcSbfWJKj9v_zIZgxawZby6-qif7vTIizluirnSTRO-5-2xM_n sJEpG7ZOqofzp_WKLPkOQfa8roYGp61R5BK2M3q9LKM6y1XlMrtYFyPWH70bVPC S_kOMrrn_48G7zmPEl-2SZWrBj4llu0oPzO2EU4uh3ipb_xUwkPPQfTkwxEdcdl Cbi4FFIQtw81_7bPwZ3m799O_-aPspkk4uFn_cKayeN3XKf8T-i9pYPWYEOugGq GU3H0I-jfwvqt2K6GGctoXWD6-d56WFlLhv4v6qGPT5C30vO-xM22BU9nwc-rff 4Q7cFBBM_7ciZrrTQf_PBjBhWS_pTYsmIUL-h7dwhcgQ1LEdgpqAWbZ23aMDWx- RSQSkRY6OlPYKkbrXUbXHWxlgb5B76eA
JWE Integrity Value
G5csTEYKIXipYM1Ey4_4JSUeHpgpd8lMvYxTHwPvSd7w916w0Q8VQekY1tz8VnA DJ751V6YiJ295_3jQUphxmQ
Then the sending agent performs steps 8 and 9, and sends the following:
<message xmlns='jabber:client' from='juliet@capulet.lit/balcony' id='fJZd9WFIIwNjFctT' to='romeo@montegue.lit' type='chat'> <e2e xmlns='urn:ietf:params:xml:ns:xmpp-e2e:6' type='enc' id='835c92a8-94cd-4e96-b3f3-b2e75a438f92'> <encheader> eyJhbGciOiJBMjU2S1ciLCJlbmMiOiJBMjU2Q0JDK0hTNTEyIiwia2lkI joiODM1YzkyYTgtOTRjZC00ZTk2LWIzZjMtYjJlNzVhNDM4ZjkyIn0 </encheader> <cmk> 4ui5xwE1gEYjuptNgSIaMFlwWrAOxMqBkaplTxeJ6b2iT8kQP2HHy5PYp qqmDxlQgT5I5rO9mgAD7AUJ9Lx35fGdi5CMiRww </cmk> <iv> B7waCj2vF_sLaJfe-1GHrA </iv> <data> UYbe-ziNGBL74581rynr9MWu0Ble_6M5LFCH9xOYXgALtlDih28Ilmf-R s68uaZsOND-7Ii9zK4H4XBwJjxaUlDGChZPWdwotRZdQKt9ZLpiQmjkzr QgKVQqyexP6mqhfWRHutEKgs6vR32O2P98J-4LAWoUza5qYCZHP5NCogL UBVKi-v-vGpHDKBG_Sw3ejHSXuZOEZtyXShL2d6EXOhEzft8ViaTUKhiB CLz1q39hI5TsPdS7NPHGQDUXDb_gSw8yVCiJgxcSbfWJKj9v_zIZgxawZ by6-qif7vTIizluirnSTRO-5-2xM_nsJEpG7ZOqofzp_WKLPkOQfa8roY Gp61R5BK2M3q9LKM6y1XlMrtYFyPWH70bVPCS_kOMrrn_48G7zmPEl-2S ZWrBj4llu0oPzO2EU4uh3ipb_xUwkPPQfTkwxEdcdlCbi4FFIQtw81_7b PwZ3m799O_-aPspkk4uFn_cKayeN3XKf8T-i9pYPWYEOugGqGU3H0I-jf wvqt2K6GGctoXWD6-d56WFlLhv4v6qGPT5C30vO-xM22BU9nwc-rff4Q7 cFBBM_7ciZrrTQf_PBjBhWS_pTYsmIUL-h7dwhcgQ1LEdgpqAWbZ23aMD Wx-RSQSkRY6OlPYKkbrXUbXHWxlgb5B76eA </data> <mac> G5csTEYKIXipYM1Ey4_4JSUeHpgpd8lMvYxTHwPvSd7w916w0Q8VQekY1 tz8VnADJ751V6YiJ295_3jQUphxmQ </mac> </e2e> </message>
If an agent supports receiving end-to-end object signatures, it MUST advertise that fact in its responses to [XEP-0030] information ("disco#info") requests by returning a feature of "urn:ietf:params:xml:ns:xmpp-e2e:6:signatures".
<iq xmlns='jabber:client' id='disco1' to='romeo@montegue.lit/garden' type='result'> <query xmlns='http://jabber.org/protocol/disco#info'> ... <feature xmlns='urn:ietf:params:xml:ns:xmpp-e2e:6:signatures'/> ... </query> </iq>
To facilitate discovery, an agent SHOULD also include [XEP-0115] information in any directed or broadcast presence updates.
The basic process that a sending agent follows for authenticating stanzas is the same regardless of the kind of stanza (i.e., <iq/>, <message/>, or <presence/>).
For a given plaintext stanza (S), the sending agent performs the following:
If the receiving agent does not understand the protocol, it MUST do one and only one of the following: (1) ignore the <e2e/> extension, (2) ignore the entire stanza, or (3) return a <service-unavailable/> error to the sender, as described in [RFC6120].
NOTE: If the inbound stanza is an <iq/>, the receiving agent MUST return an error to the sending agent, to comply with the exchanging of IQ stanzas in [RFC6121].
Upon receipt of a signed stanza, the receiving agent performs the following:
At step 1, if the receiving agent does not have the key used to sign the stanza, or the receiving agent could not otherwise determine it, it MAY return a <bad-request/> error to the sending agent (as described in [RFC6120]), optionally supplemented by an application-specific error condition element of <insufficient-information/>:
<message xmlns='jabber:client' from='juliet@capulet.lit/balcony' id='fJZd9WFIIwNjFctT' to='romeo@montegue.lit/garden' type='chat'> <e2e xmlns='urn:ietf:params:xml:ns:xmpp-e2e:6' type='sig'> <sigheader>[XML character data]</sigheader> <data>[XML character data]</data> <sig>[XML character data]</sig> </e2e> <error type='modify'> <bad-request xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> <insufficient-information xmlns='urn:ietf:params:xml:ns:xmpp-e2e:6'/> </error> </message>
In addition to returning an error, the receiving agent SHOULD NOT present the stanza to the intended recipient (human or application) and SHOULD provide some explicit alternate processing of the stanza (which MAY be to display a message informing the recipient that it has received a stanza that cannot be verified).
At step 2, if the receiving agent is unable to successfully verify the stanza, the receiving agent SHOULD return a <bad-request/> error to the sending agent (as described in [RFC6120]), optionally supplemented by an application-specific error condition element of <verification-failed/>:
<message xmlns='jabber:client' from='juliet@capulet.lit/balcony' id='fJZd9WFIIwNjFctT' to='romeo@montegue.lit/garden' type='chat'> <e2e xmlns='urn:ietf:params:xml:ns:xmpp-e2e:6' type='sig'> <sigheader>[XML character data]</sigheader> <data>[XML character data]</data> <sig>[XML character data]</sig> </e2e> <error type='modify'> <bad-request xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> <verification-failed xmlns='urn:ietf:params:xml:ns:xmpp-e2e:6'/> </error> </message>
In addition to returning an error, the receiving agent SHOULD NOT present the stanza to the intended recipient (human or application) and SHOULD provide some explicit alternate processing of the stanza (which MAY be to display a message informing the recipient that it has received a stanza that cannot be verified).
At step 4, if the stanza is successfully verified but the timestamp fails the checks outlined in Section 7, the receiving agent MAY return a <not-acceptable/> error to the sender (as described in [RFC6120]), optionally supplemented by an application-specific error condition element of <bad-timestamp/> (previously defined in [RFC3923]):
<message xmlns='jabber:client' from='juliet@capulet.lit/balcony' id='fJZd9WFIIwNjFctT' to='romeo@montegue.lit/garden' type='chat'> <e2e xmlns='urn:ietf:params:xml:ns:xmpp-e2e:6' type='sig'> <sigheader>[XML character data]</sigheader> <data>[XML character data]</data> <sig>[XML character data]</sig> </e2e> <error type='modify'> <not-acceptable xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> <bad-timestamp xmlns='urn:ietf:params:xml:ns:xmpp-e2e:6'/> </error> </message>
If the receiving agent successfully verified the payload, it SHOULD NOT return a stanza error. However, if the signed stanza is an <iq/> of type "get" or "set", the response MAY be sent unsigned if the receiving agent does not have an appropriate public-private key-pair.
Otherwise, the receiving agent SHOULD send the <iq/> response signed as per Section 4.2.1, with the 'type' attribute set to the value "result", even if the response to the signed <iq/> stanza is of type "error". The error applies to the signed stanza, not the wrapping stanza.
NOTE: unless otherwise indicated, all line breaks are included for readability.
The sending agent beings with the plaintext version of <message/> stanza 'S':
<message xmlns='jabber:client' from='juliet@capulet.lit/balcony' to='romeo@montegue.lit' type='chat'> <thread>35740be5-b5a4-4c4e-962a-a03b14ed92f4</thread> <body> But to be frank, and give it thee again. And yet I wish but for the thing I have. My bounty is as boundless as the sea, My love as deep; the more I give to thee, The more I have, for both are infinite. </body> </message>
Then the sending agent performs steps 1, 2, and 3 from Section 4.2.1 generate the envelope M:
<forwarded xmlns='urn:xmpp:forward:0'> <delay xmlns='urn:xmpp:delay' stamp='1492-05-12T20:07:37.012Z'/> <message xmlns='jabber:client' from='juliet@capulet.lit/balcony' to='romeo@montegue.lit' type='chat'> <thread>35740be5-b5a4-4c4e-962a-a03b14ed92f4</thread> <body> But to be frank, and give it thee again. And yet I wish but for the thing I have. My bounty is as boundless as the sea, My love as deep; the more I give to thee, The more I have, for both are infinite. </body> </message> </forwarded>
Then the sending agent performs steps 4, 5, and 6 to generate the [JOSE-JWS] outputs:
JWS Header (before base64url encoding)
{ "alg":"RS512", "kid":"juliet@capulet.lit" }
JWS Payload
PGZvcndhcmRlZCB4bWxucz0idXJuOnhtcHA6Zm9yd2FyZDowIj48ZGVsYXkgeG1 sbnM9InVybjp4bXBwOmRlbGF5IiBzdGFtcD0iMTQ5Mi0wNTEyVDIwOjA3OjM3Lj AxMloiLz48bWVzc2FnZSB4bWxucz0iamFiYmVyOmNsaWVudCIgZnJvbT0ianVsa WV0QGNhcHVsZXQubGl0L2JhbGNvbnkiIHRvPSJyb21lb0Btb250ZWd1ZS5saXQi IHR5cGU9ImNoYXQiPjx0aHJlYWQ-MzU3NDBiZTUtYjVhNC00YzRlLTk2MmEtYTA zYjE0ZWQ5MmY0PC90aHJlYWQ-PGJvZHk-QnV0IHRvIGJlIGZyYW5rLCBhbmQgZ2 l2ZSBpdCB0aGVlIGFnYWluLiBBbmQgeWV0IEkgd2lzaCBidXQgZm9yIHRoZSB0a GluZyBJIGhhdmUuIE15IGJvdW50eSBpcyBhcyBib3VuZGxlc3MgYXMgdGhlIHNl YSwgTXkgbG92ZSBhcyBkZWVwOyB0aGUgbW9yZSBJIGdpdmUgdG8gdGhlZSwgVGh lIG1vcmUgSSBoYXZlLCBmb3IgYm90aCBhcmUgaW5maW5pdGUuPC9ib2R5PjwvbW Vzc2FnZT48L2ZvcndhcmRlZD4
JWS Signature
Mq4m-7qP05rxyvHinQ4GGvApKKmjGJaCbQHO1I_5P4gmIcn1gAan_4l2nIHXHyU FPpT3OLpLwEaaAbuo6jPRYdC3J4VjpOWoBy1usAtjHgzgZvs4QLzynCkZ_NQoqE OwXWe-Wl8KF11w0J2DePcORcELl5L4E6cdBVHxwJ36lmsPWSNiBcT9n2F41kZR0 -xs0SniHT8LBu9zE0zuerVvlI-FqE1yTAC49v-f3vahrcyaJHVvb-I4SAMm76Sz dcCPCGEU8mKD1USDtuuWM84GwYLxYuhHOvZVtf_qMHY6ajfr9Fz3Hvc1r7WQLV8 wi79H3eDoOEqXf_epTeCldOfIrA
Then the sending agent performs steps 7 and 8 and sends the following:
<message xmlns='jabber:client' from='juliet@capulet.lit/balcony' id='6aAWpciGV98qaegk' to='romeo@montegue.lit' type='cat'> <e2e xmlns='urn:ietf:params:xml:ns:xmpp-e2e:6' type='sig'> <sigheader> eyJhbGciOiJSUzUxMiIsImtpZCI6Imp1bGlldEBjYXB1bGV0LmxpdCJ9 </sigheader> <data> PGZvcndhcmRlZCB4bWxucz0idXJuOnhtcHA6Zm9yd2FyZDowIj48ZGVsY XkgeG1sbnM9InVybjp4bXBwOmRlbGF5IiBzdGFtcD0iMTQ5Mi0wNTEyVD IwOjA3OjM3LjAxMloiLz48bWVzc2FnZSB4bWxucz0iamFiYmVyOmNsaWV udCIgZnJvbT0ianVsaWV0QGNhcHVsZXQubGl0L2JhbGNvbnkiIHRvPSJy b21lb0Btb250ZWd1ZS5saXQiIHR5cGU9ImNoYXQiPjx0aHJlYWQ-MzU3N DBiZTUtYjVhNC00YzRlLTk2MmEtYTAzYjE0ZWQ5MmY0PC90aHJlYWQ-PG JvZHk-QnV0IHRvIGJlIGZyYW5rLCBhbmQgZ2l2ZSBpdCB0aGVlIGFnYWl uLiBBbmQgeWV0IEkgd2lzaCBidXQgZm9yIHRoZSB0aGluZyBJIGhhdmUu IE15IGJvdW50eSBpcyBhcyBib3VuZGxlc3MgYXMgdGhlIHNlYSwgTXkgb G92ZSBhcyBkZWVwOyB0aGUgbW9yZSBJIGdpdmUgdG8gdGhlZSwgVGhlIG 1vcmUgSSBoYXZlLCBmb3IgYm90aCBhcmUgaW5maW5pdGUuPC9ib2R5Pjw vbWVzc2FnZT48L2ZvcndhcmRlZD4 </data> <sig> Mq4m-7qP05rxyvHinQ4GGvApKKmjGJaCbQHO1I_5P4gmIcn1gAan_4l2n IHXHyUFPpT3OLpLwEaaAbuo6jPRYdC3J4VjpOWoBy1usAtjHgzgZvs4QL zynCkZ_NQoqEOwXWe-Wl8KF11w0J2DePcORcELl5L4E6cdBVHxwJ36lms PWSNiBcT9n2F41kZR0-xs0SniHT8LBu9zE0zuerVvlI-FqE1yTAC49v-f 3vahrcyaJHVvb-I4SAMm76SzdcCPCGEU8mKD1USDtuuWM84GwYLxYuhHO vZVtf_qMHY6ajfr9Fz3Hvc1r7WQLV8wi79H3eDoOEqXf_epTeCldOfIrA </sig> </e2e> </message>
Because of the dynamic nature of XMPP stanza routing, the protocol does not exchange session keys as part of the encrypted stanza. Instead, a separate protocol is used by receiving agents to request a particular session key from the sending agent.
Before a SMK can be requested, the receiving agent MUST have at least one public key for which it also has the private key. The public key(s) are provided to the sending agent as part of this process.
To request a SMK, the receiving agent performs the following:
If the sending agent approves the request, it performs the following steps:
If the sending agent does not approve the request, it sends an <iq/> stanza of type "error" and containing the reason for denying the request:
NOTE: unless otherwise indicated, all line breaks are included for readability.
To begin a key request, the receiving agent performs step 1 from Section 5.1 to generate the [JOSE-JWK]:
{ "keys": [{ "kty":"RSA", "kid":"romeo@montegue.lit/garden", "n":"vtqejkMF01h8oKEaHfHEYO0C2jM7eISbbSvNs0SNItYWO6GbjpJf N4ldXw2vpVRdysnwU3zk6o2_SD0YCH1WgeuI0QK1knMTDdNSXx52e1c4BTw hlA8iHuutTWmpBqesn1GNZmqB3jYsJOkVBYwCJtkB9APaBvk0itlRtizjCf 1HHnau7nGStyshgu8-srxi_d8rC5TTLSB_zT1i6fP8fwDloemXOtC0U65by 5P-1ZHxaf_bD8fpjps6gwSgdkZKMJAI0bOWZWuMpp2ntqa0wLB7Ndxb2Ijr eog_s5ssAoSiXDVdoswSbp36ZP-1lnCk2j-vZ4qbhaFg5bZtgt-gwQ", "e":"AQAB" }] }
Then the receiving agent performs step 2 to generate the <keyreq/>:
<keyreq xmlns='urn:ietf:params:xml:ns:xmpp-e2e:6' id='835c92a8-94cd-4e96-b3f3-b2e75a438f92'> <pkey> eyJrZXlzIjpbeyJrdHkiOiJSU0EiLCJraWQiOiJyb21lb0Btb250ZWd1ZS5 saXQvZ2FyZGVuIiwibiI6InZ0cWVqa01GMDFoOG9LRWFIZkhFWU8wQzJqTT dlSVNiYlN2TnMwU05JdFlXTzZHYmpwSmZONGxkWHcydnBWUmR5c253VTN6a zZvMl9TRDBZQ0gxV2dldUkwUUsxa25NVERkTlNYeDUyZTFjNEJUd2hsQThp SHV1dFRXbXBCcWVzbjFHTlptcUIzallzSk9rVkJZd0NKdGtCOUFQYUJ2azB pdGxSdGl6akNmMUhIbmF1N25HU3R5c2hndTgtc3J4aV9kOHJDNVRUTFNCX3 pUMWk2ZlA4ZndEbG9lbVhPdEMwVTY1Ynk1UC0xWkh4YWZfYkQ4ZnBqcHM2Z 3dTZ2RrWktNSkFJMGJPV1pXdU1wcDJudHFhMHdMQjdOZHhiMklqcmVvZ19z NXNzQW9TaVhEVmRvc3dTYnAzNlpQLTFsbkNrMmotdlo0cWJoYUZnNWJadGd 0LWd3USIsImUiOiJBUUFCIn1dfQ </pkey> </keyreq>
Then the receiving agent performs step 3 and sends the following:
<iq xmlns='jabber:client' from='romeo@montegue.lit/garden' id='xdJbWMA+' to='juliet@capulet.lit/balcony' type='get'> <keyreq xmlns='urn:ietf:params:xml:ns:xmpp-e2e:6' id='835c92a8-94cd-4e96-b3f3-b2e75a438f92'> <pkey> eyJrZXlzIjpbeyJrdHkiOiJSU0EiLCJraWQiOiJyb21lb0Btb250ZWd1Z S5saXQvZ2FyZGVuIiwibiI6InZ0cWVqa01GMDFoOG9LRWFIZkhFWU8wQz JqTTdlSVNiYlN2TnMwU05JdFlXTzZHYmpwSmZONGxkWHcydnBWUmR5c25 3VTN6azZvMl9TRDBZQ0gxV2dldUkwUUsxa25NVERkTlNYeDUyZTFjNEJU d2hsQThpSHV1dFRXbXBCcWVzbjFHTlptcUIzallzSk9rVkJZd0NKdGtCO UFQYUJ2azBpdGxSdGl6akNmMUhIbmF1N25HU3R5c2hndTgtc3J4aV9kOH JDNVRUTFNCX3pUMWk2ZlA4ZndEbG9lbVhPdEMwVTY1Ynk1UC0xWkh4YWZ fYkQ4ZnBqcHM2Z3dTZ2RrWktNSkFJMGJPV1pXdU1wcDJudHFhMHdMQjdO ZHhiMklqcmVvZ19zNXNzQW9TaVhEVmRvc3dTYnAzNlpQLTFsbkNrMmotd lo0cWJoYUZnNWJadGd0LWd3USIsImUiOiJBUUFCIn1dfQ </pkey> </keyreq> </iq>
If the sending agent accepts this key request, it performs step 1 from Section 5.2 to generate JWK representation of the SMK:
{ "kty":"oct", "kid":"835c92a8-94cd-4e96-b3f3-b2e75a438f92", "oct":"xWtdjhYsH4Va_9SfYSefsJfZu03m5RrbXo_UavxxeU8" }
Then the sending agent performs steps 2 and 3 to generate the protected SMK:
JWE Header (before base64url encoding)
{ "alg":"RSA-OAEP", "enc":"A256CBC+HS512", "kid":"romeo@montegue.lit/garden" }
JWE Encrypted Key
UeoVeGcZP-VsLu1PVj3NNWkmmEF7H2Nl_mHWscOuT_vYn-4ub2NEnRy4dzyycgx ny6jmRPpNiGJB6AfI4TYZvrjig5dubv4uG7phCvKYVI3uaUU58Fc9H_o-BTmNv2 rUT-RGt6YYLW97ZJp5ZcA2l-KxykcxaRYC4Sv_UOS3Kqo0sVx5u7tolE6SbMnUH etg91Gc9pVVa1XX-wz4ZrcA6V8zf8pCtmc4WyDMFx8RYYXR_5Qvax-TzOJUL2eA r3OQsf3KNh58WvvzcwAKTmR214QmZCxI_A5mIqoog0H0uV987P9yw1wFfsmg7z- Y2Ed7Blp-zLOvXEQKU9FM-vjBnA
JWE Initialization Vector
eiXTO21DNqFnCTQkLAoAtA
JWE Ciphertext
e8sZiRvKLPOUjmFwOYhvrZMQYzW1yglg6mTnazJU_rF7mXTBIieNZCd7hDrlrdG SxqqUgh6N1O2QBLygf2PtWDmHHjn1aLncx6qlGf0UOxCCXUBfBIhZgFH5YX1i3_ VSsNUDEoIKTGA21EnamOqa1A
JWE Integrity Value
WQzHj3j30Qo7VakMM42t-X1omQVGyebd3No9ZFGPQNUwEWONjIcZ89_wFBhZFdd kc8i_qtXi-9XPmSVei3A_Jw
Then the sending agent performs step 4 to generate the <keyreq/> response:
<keyreq xmlns='urn:ietf:params:xml:ns:xmpp-e2e:6' id='835c92a8-94cd-4e96-b3f3-b2e75a438f92'> <encheader> eyJhbGciOiJSU0EtT0FFUCIsImVuYyI6IkEyNTZDQkMrSFM1MTIiLCJraWQ iOiJyb21lb0Btb250ZWd1ZS5saXQvZ2FyZGVuIn0 </encheader> <cmk> UeoVeGcZP-VsLu1PVj3NNWkmmEF7H2Nl_mHWscOuT_vYn-4ub2NEnRy4dzy ycgxny6jmRPpNiGJB6AfI4TYZvrjig5dubv4uG7phCvKYVI3uaUU58Fc9H_ o-BTmNv2rUT-RGt6YYLW97ZJp5ZcA2l-KxykcxaRYC4Sv_UOS3Kqo0sVx5u 7tolE6SbMnUHetg91Gc9pVVa1XX-wz4ZrcA6V8zf8pCtmc4WyDMFx8RYYXR _5Qvax-TzOJUL2eAr3OQsf3KNh58WvvzcwAKTmR214QmZCxI_A5mIqoog0H 0uV987P9yw1wFfsmg7z-Y2Ed7Blp-zLOvXEQKU9FM-vjBnA </cmk> <iv> eiXTO21DNqFnCTQkLAoAtA </iv> <data> e8sZiRvKLPOUjmFwOYhvrZMQYzW1yglg6mTnazJU_rF7mXTBIieNZCd7hDr lrdGSxqqUgh6N1O2QBLygf2PtWDmHHjn1aLncx6qlGf0UOxCCXUBfBIhZgF H5YX1i3_VSsNUDEoIKTGA21EnamOqa1A </data> <mac> WQzHj3j30Qo7VakMM42t-X1omQVGyebd3No9ZFGPQNUwEWONjIcZ89_wFBh ZFddkc8i_qtXi-9XPmSVei3A_Jw </mac> </keyreq>
Then the sending agent performs step 5 and sends the following:
<iq xmlns='jabber:client' from='juliet@capulet.lit/balcony' id='xdJbWMA+' to='romeo@montegue.lit/garden' type='result'> <keyreq xmlns='urn:ietf:params:xml:ns:xmpp-e2e:6' id='835c92a8-94cd-4e96-b3f3-b2e75a438f92'> <encheader> eyJhbGciOiJSU0EtT0FFUCIsImVuYyI6IkEyNTZDQkMrSFM1MTIiLCJraWQ iOiJyb21lb0Btb250ZWd1ZS5saXQvZ2FyZGVuIn0 </encheader> <cmk> UeoVeGcZP-VsLu1PVj3NNWkmmEF7H2Nl_mHWscOuT_vYn-4ub2NEnRy4dzy ycgxny6jmRPpNiGJB6AfI4TYZvrjig5dubv4uG7phCvKYVI3uaUU58Fc9H_ o-BTmNv2rUT-RGt6YYLW97ZJp5ZcA2l-KxykcxaRYC4Sv_UOS3Kqo0sVx5u 7tolE6SbMnUHetg91Gc9pVVa1XX-wz4ZrcA6V8zf8pCtmc4WyDMFx8RYYXR _5Qvax-TzOJUL2eAr3OQsf3KNh58WvvzcwAKTmR214QmZCxI_A5mIqoog0H 0uV987P9yw1wFfsmg7z-Y2Ed7Blp-zLOvXEQKU9FM-vjBnA </cmk> <iv> eiXTO21DNqFnCTQkLAoAtA </iv> <data> e8sZiRvKLPOUjmFwOYhvrZMQYzW1yglg6mTnazJU_rF7mXTBIieNZCd7hDr lrdGSxqqUgh6N1O2QBLygf2PtWDmHHjn1aLncx6qlGf0UOxCCXUBfBIhZgF H5YX1i3_VSsNUDEoIKTGA21EnamOqa1A </data> <mac> WQzHj3j30Qo7VakMM42t-X1omQVGyebd3No9ZFGPQNUwEWONjIcZ89_wFBh ZFddkc8i_qtXi-9XPmSVei3A_Jw </mac> </keyreq> </iq>
The individual processes for encrypting and signing can be nested; the output of each process a complete stanza that could then be performed with the other. An implementation MUST be able to process one level of nesting (e.g., an encrypted stanza nested within a signed stanza), and SHOULD handle multiple levels within reasonable limits for the receiving agent.
Timestamps are included to help prevent replay attacks. All timestamps MUST conform to [XEP-0082] and be presented as UTC with no offset, and SHOULD include the seconds and fractions of a second to three digits. Absent a local adjustment to the sending agent's perceived time or the underlying clock time, the sending agent MUST ensure that the timestamps it sends to the receiver increase monotonically (if necessary by incrementing the seconds fraction in the timestamp if the clock returns the same time for multiple requests). The following rules apply to the receiving agent:
Note the foregoing assumes the stanza is received while the receiving agent is online; see Section 9 for offline storage considerations.
The following limitations and caveats apply:
The server makes its best effort to deliver stanzas. When the receiving agent is offline at the time of delivery, the server might store the message until the recipient is next online (offline storage does not apply to <iq/> or <presence/> stanzas, only <message/> stanzas). The following need to be considered:
All algorithms that MUST be implemented for [JOSE-JWE] and [JOSE-JWS] also MUST be implemented for this specification. However, this specification further mandates the use of the following:
The recipient's server might store any <message/> stanzas received until the recipient is next available; this duration could be anywhere from a few minutes to several months.
A sender SHOULD NOT use the same SMK for stanzas intended for different recipients, as determined by the localpart and domainpart of the recipient's JID.
A sender MAY re-use a SMK for several stanzas to the same recipient. In this case, the SID remains the same, but the sending agent MUST generate a new CMK and IV for each encrypted stanza. The sender SHOULD periodically generate a new SMK (and its associated SID); however, this specification does not mandate any specific algorithms or processes.
In the case of <message/> stanzas, a sending agent might generate a new SMK each time it generates a new ThreadID, as outlined in [XEP-0201].
A number of URN sub-namespaces of encrypted and/or signed content for the Extensible Messaging and Presence Protocol (XMPP) is defined as follows.
[E2E-REQ] | Saint-Andre, P., "Requirements for End-to-End Encryption in the Extensible Messaging and Presence Protocol (XMPP)", Internet-Draft draft-saintandre-xmpp-e2e-requirements-01, March 2010. |
[JOSE-JWA] | Jones, M., "JSON Web Algorithms (JWA)", Internet-Draft draft-ietf-jose-json-web-algorithms-08, December 2012. |
[JOSE-JWE] | Jones, M., Rescola, E. and J. Hildebrand, "JSON Web Encryption (JWE)", Internet-Draft draft-ietf-jose-json-web-encryption-08, December 2012. |
[JOSE-JWK] | Jones, M., "JSON Web Key (JWK)", Internet-Draft draft-ietf-jose-json-web-key-08, December 2012. |
[JOSE-JPSK] | Jones, M., "JSON Private and Symmetric Key", Internet-Draft draft-jones-jose-json-private-and-symmetric-key-00, December 2012. |
[JOSE-JWS] | Jones, M., Bradley, J. and N. Sakimura, "JSON Web Signature (JWS)", Internet-Draft draft-ietf-jose-json-web-signature-08, December 2012. |
[JOSE-KEYPROTECT] | Miller, M., "Using JSON Web Encryption (JWE) for Protecting JSON Web Key (JWK) Objects", Internet-Draft draft-miller-jose-jwe-protected-jwk-00, February 2013. |
[RFC2119] | Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997. |
[RFC4648] | Josefsson, S., "The Base16, Base32, and Base64 Data Encodings", RFC 4648, October 2006. |
[RFC4949] | Shirey, R., "Internet Security Glossary, Version 2", RFC 4949, August 2007. |
[RFC6120] | Saint-Andre, P., "Extensible Messaging and Presence Protocol (XMPP): Core", RFC 6120, March 2011. |
[RFC6121] | Saint-Andre, P., "Extensible Messaging and Presence Protocol (XMPP): Instant Messaging and Presence", RFC 6121, March 2011. |
[XEP-0030] | Eatmon, R., Hildebrand, J., Millard, P. and P. Saint-Andre, "Service Discovery", XSF XEP 0030, June 2006. |
[XEP-0082] | Saint-Andre, P., "XMPP Date and Time Profiles", XSF XEP 0082, May 2003. |
[XEP-0115] | Hildebrand, J., Troncon, R. and P. Saint-Andre, "Entity Capabilities", XSF XEP 0115, February 2008. |
[XEP-0203] | Saint-Andre, P., "Delayed Delivery", XSF XEP 0203, September 2009. |
[XEP-0297] | Wild, M. and K. Smith, "Stanza Forwarding", XSF XEP 0297, July 2012. |
[RFC3610] | Whiting, D., Housley, R. and N. Ferguson, "Counter with CBC-MAC (CCM)", RFC 3923, September 2003. |
[RFC3923] | Saint-Andre, P., "End-to-End Signing and Object Encryption for the Extensible Messaging and Presence Protocol (XMPP)", RFC 3923, October 2004. |
[RFC4086] | Eastlake, D., Schiller, J. and S. Crocker, "Randomness Requirements for Security", RFC 4086, June 2005. |
[XEP-0160] | Saint-Andre, P., "Best Practices for Handling Offline Messages", XSF XEP 0160, January 2006. |
[XEP-0201] | Saint-Andre, P., Paterson, I. and K. Smith, "Best Practices for Message Threads", XSF XEP 0203, November 2010. |
The following XML schema is descriptive, not normative.
<?xml version='1.0' encoding='UTF-8'?> <xs:schema xmlns:xs='http://www.w3.org/2001/XMLSchema' targetNamespace='urn:ietf:params:xml:ns:xmpp-e2e:6' xmlns='urn:ietf:params:xml:ns:xmpp-e2e:6' elementFormDefault='qualified'> <xs:element name='e2e'> <xs:complexType> <xs:attribute name='id' type='xs:string' use='optional'/> <xs:attribute name='type'use='required'> <xs:simpleType> <xs:restriction base='xs:NMTOKEN'> <xs:enumeration value='enc'/> <xs:enumeration value='sig'/> </xs:restriction> </xs:simpleType> </xs:attribute> <xs:sequence> <xs:element ref='header' minOccurs='1' maxOccurs='1'/> <xs:element ref='cmk' minOccurs='1' maxOccurs='1'/> <xs:element ref='iv' minOccurs=1' maxOccurs='1'/> <xs:element ref='data' minOccurs='1' maxOccurs='1'/> <xs:element ref='mac' minOccurs='1' maxOccurs='1'/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name='keyreq'> <xs:complexType> <xs:attribute name='id' type='xs:string' use='required'/> <xs:sequence> <xs:element ref='pkey' minOccurs='0' maxOccurs='1'/> <xs:element ref='header' minOccurs='0' maxOccurs='1'/> <xs:element ref='cmk' minOccurs='1' maxOccurs='1'/> <xs:element ref='iv' minOccurs=1' maxOccurs='1'/> <xs:element ref='data' minOccurs='1' maxOccurs='1'/> <xs:element ref='mac' minOccurs='1' maxOccurs='1'/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name='cmk'> <xs:complexType> <xs:simpleType> <xs:extension base='xs:string'> </xs:extension> </xs:simpleType> </xs:complexType> </xs:element> <xs:element name='iv'> <xs:complexType> <xs:simpleType> <xs:extension base='xs:string'> </xs:extension> </xs:simpleType> </xs:complexType> </xs:element> <xs:element name='data'> <xs:complexType> <xs:simpleType> <xs:extension base='xs:string'> </xs:extension> </xs:simpleType> </xs:complexType> </xs:element> <xs:element name='encheader'> <xs:complexType> <xs:simpleType> <xs:extension base='xs:string'> </xs:extension> </xs:simpleType> </xs:complexType> </xs:element> <xs:element name='mac'> <xs:complexType> <xs:simpleType> <xs:extension base='xs:string'> </xs:extension> </xs:simpleType> </xs:complexType> </xs:element> <xs:element name='pkey'> <xs:complexType> <xs:simpleType> <xs:extension base='xs:string'> </xs:extension> </xs:simpleType> </xs:complexType> </xs:element> <xs:element name='sigheader'> <xs:complexType> <xs:simpleType> <xs:extension base='xs:string'> </xs:extension> </xs:simpleType> </xs:complexType> </xs:element> <xs:element name='bad-timestamp' type='empty'/> <xs:element name='decryption-failed' type='empty'/> <xs:element name='insufficient-information' type='empty'/> <xs:element name='verification-failed' type='empty'/> <xs:simpleType name='empty'> <xs:restriction base='xs:string'> <xs:enumeration value=''/> </xs:restriction> </xs:simpleType> </xs:schema>
Thanks to Richard Barnes, Andrew Biggs, and Ben Schumacher for their feedback.