diff --git a/xep-0391.xml b/xep-0391.xml new file mode 100644 index 00000000..a9bdb71a --- /dev/null +++ b/xep-0391.xml @@ -0,0 +1,308 @@ + + + +%ents; +]> + + +
+ Jingle Encrypted Transports + This specification defines a method that allows to use established encryption schemes for end-to-end encryption of Jingle transports. + &LEGALNOTICE; + 0391 + Experimental + Standards Track + Standards + Council + + XEP-0234 + + + + jet + + jingle + http://xmpp.org/schemas/jingle.xsd + + + jingle:errors + http://xmpp.org/schemas/jingle-errors.xsd + + + jingle + + Paul + Schaub + vanitasvitae@riseup.net + vanitasvitae@jabberhead.tk + + + 0.1 + 2017-09-27 + XEP Editor: jwi +

Accepted as Experimental by Council.

+
+ + 0.0.1 + 2017-06-12 + vv +

First draft

+
+
+ +

Jingle Encrypted Transports (JET) strives to provide a modular and easily extensible way to wrap Jingle Transports in an additional end-to-end encryption layer. The focus of this specification lays on being modular. It should be possible to extend existing Jingle use scenarios with end-to-end encryption by simply adding a JET element to the negotiation.

+
+ +

JET uses multiple encryption layers, so it is necessary to declare a distinct denomination for the different keys involved.

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
DesignationAbbrevationUsage
Transport KeyTK(Symmetric) key that is used to encrypt/decrypt the bytestreams sent/received through Jingle transports. This key encrypts the data two entities want to exchange. Examples for TK can be found under "Ciphers".
Initialization VectorIVInitialization vector that is used together with TK.
Transport SecretTSSerialization of TK and TI.
Envelope ElementEEOutput element of an established end-to-end encryption method when encrypting TS.
+
+ +

Lets assume Romeo wants to initiate an encrypted Jingle session with Juliet. Prior to the Jingle session initiation, an already existing, established and (ideally) authenticated end-to-end encryption session between Romeo and Juliet MUST exist. This session is needed to transfer the Transport Secret from Romeo to Juliet.

+

When this precondition is met, Romeo initially generates a transport key (TK) and associated initialization vector (IV). These will later be used by the sender to encrypt, and respectively by the recipient to decrypt data that is exchanged. This protocol defines a set of usable ciphers from which Romeo might choose. TK and IV are serialized to create the transport secret (TS).

+

Next Romeo uses her established encryption session with Juliet to encrypt TS. The resulting envelope element (EE) will be part of the Jingle session initiation as child of the JET &secret; element.

+

When Juliet receives Romeos session request, she decrypts EE to retrieve TS, from which she can deserialize TK and IV. Now she and Romeo can go on with the session negotiation. Once the session is established, data can be encrypted and exchanged. Both parties MUST keep a copy of TS in cache until the Jingle session is ended.

+
+ +

&xep0234; has the disadvantage, that transmitted files are not encrypted (aside from regular TLS transport encryption), which means that intermediate nodes like XMPP/proxy server(s) have access to the transferred data. Considering that end-to-end encryption becomes more and more important to protect free speech and personal expression, this is a major flaw that needs to be addressed.

+

In order to initiate an encrypted file transfer, the initiator includes a JET &secret; in the Jingle file transfer request.

+ + +

In this scenario Romeo wants to send an encrypted text file over to Juliet. First, he generates a fresh AES-256 transport key and IV. TK and IV are serialized into TS which is then encrypted using Romeos end-to-end-encryption session with Juliet.

+

The resulting envelope element (EE) is sent as part of the security element along with the rest of the jingle stanza over to Juliet.

+ + + + + + 1969-07-21T02:56:15Z + This is a test. If this were a real file... + text/plain + test.txt + + 6144 + w0mcJylzCn+AfvuGdqkty2+KP48= + + + + + + + + BASE64-ENCODED-ENCRYPTED-SECRET + + + + +]]> + +

Juliet decrypts the envelope element (EE) using her session with Romeo to retrieve TS from which she deserializes TK and IV. Both Juliet and Romeo then carry on with the session negotiation as described in &xep0234;. Before Romeo starts transmitting the file, he encrypts it using TK and IV. He then transmitts the encrypted file over to Juliet.

+

When Juliet received the file, she uses the TK and IV to decrypt the received file.

+
+ + +

Juliet might want to request a file transfer from Romeo. This can be the case, when Romeo hosts the file. In order to do so, she sends generates TK and IV, creates TS from those and encrypts TS with an encryption method of her choice to get EE. TK and IV will be used by Romeo to encrypt the requested file before sending it to Juliet.

+ + + + + + w0mcJylzCn+AfvuGdqkty2+KP48= + + + + + + + + BASE64-ENCODED-ENCRYPTED-SECRET + + + + +]]> +
+ + +

&xep0234; defines a way for parties to request ranged transfers. This can be used to resume interrupted transfers etc. In case of an interrupted transfer, the receiving party might be able to decrypt parts of the received file. When requesting a resumption of the transfer, the recipient therefore can use the index of the last successfully decrypted byte of the file as offset in the ranged transfer. Since a resumed transfer takes place in a new session, the old transport secret might no longer be available to either party. For that reason the receiver creates a new TS for the session-initiation. The sending party then encrypts and sends only the requested parts of the file.

+ + + + + + + w0mcJylzCn+AfvuGdqkty2+KP48= + + + + + + + + + BASE64-ENCODED-ENCRYPTED-SECRET + + + + +]]> +
+ +
+ + +

In order to encrypt the transported bytestream, the initiator must transmit a cipher key to the responder. There are multiple options available:

+ + + + + + + + + + + + + + + + + + + + + + +
NamespaceTypeLength (bits)ParametersSerialization
urn:xmpp:ciphers:aes-128-gcm-nopadding:0AES128GCM/NoPadding128BitKey::96BitIV
urn:xmpp:ciphers:aes-256-gcm-nopadding:0AES256GCM/NoPadding256BitKey::96BitIV
+

The column 'serialization' describes, how the key and iv are serialized. "::" means plain concatenation of byte arrays.

+
+ + +

To advertise its support for the Jingle Encrypted Transports, when replying to service discovery information ("disco#info") requests an entity MUST return URNs for any version, or extension of this protocol that the entity supports -- e.g., "urn:xmpp:jingle:jet:0" for this version, or "urn:xmpp:jingle:jet-stub:0" for a stub encryption method &VNOTE;.

+ + +]]> + + + + + +]]> +

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 &xep0115;. However, if an application has not received entity capabilities information from an entity, it SHOULD use explicit service discovery instead.

+
+ + +

The initiator SHOULD NOT use the generated key TK as IV, but instead generate a seperate random IV.

+

Instead of falling back to unencrypted transfer in case something goes wrong, implementations MUST instead abort the Jingle session, informing the user.

+

IMPORTANT: This approach does not deal with metadata. In case of &xep0234;, an attacker with access to the sent stanzas can for example still see the name of the file and other information included in the <file/> element.

+

The responder MUST check, whether the envelope element belongs to the initiator to prevent MitM attacks

+
+ + +

This is only a rough draft and there is still a ton of questions left to be answered. Here is a small non-exhaustive list of things I can think of:

+ +
+ + + +
diff --git a/xep.ent b/xep.ent index 2f87609e..e1ec9c6a 100644 --- a/xep.ent +++ b/xep.ent @@ -1446,3 +1446,4 @@ IANA Service Location Protocol, Version 2 (SLPv2) Templates Extensible SASL Profile (XEP-0388) XEP-0388: Extensible SASL Profile <https://xmpp.org/extensions/xep-0388.html>." > Extensible In-Band Registration (XEP-0389) XEP-0389: Extensible In-Band Registration <https://xmpp.org/extensions/xep-0389.html>." > Entity Capabilities 2.0 (XEP-0390) XEP-0390: Entity Capabilities 2.0 <https://xmpp.org/extensions/xep-0390.html>." > +Jingle Encrypted Transports (XEP-0391) XEP-0391: Jingle Encrypted Transports <https://xmpp.org/extensions/xep-0391.html>." >