jingle_ice_udp.rs

  1// Copyright (c) 2019 Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
  2//
  3// This Source Code Form is subject to the terms of the Mozilla Public
  4// License, v. 2.0. If a copy of the MPL was not distributed with this
  5// file, You can obtain one at http://mozilla.org/MPL/2.0/.
  6
  7use crate::jingle_dtls_srtp::Fingerprint;
  8use std::net::IpAddr;
  9
 10generate_element!(
 11    /// Wrapper element for an ICE-UDP transport.
 12    Transport, "transport", JINGLE_ICE_UDP,
 13    attributes: [
 14        /// A Password as defined in ICE-CORE.
 15        pwd: Option<String> = "pwd",
 16
 17        /// A User Fragment as defined in ICE-CORE.
 18        ufrag: Option<String> = "ufrag",
 19    ],
 20    children: [
 21        /// List of candidates for this ICE-UDP session.
 22        candidates: Vec<Candidate> = ("candidate", JINGLE_ICE_UDP) => Candidate,
 23
 24        /// Fingerprint of the key used for the DTLS handshake.
 25        fingerprint: Option<Fingerprint> = ("fingerprint", JINGLE_DTLS) => Fingerprint
 26    ]
 27);
 28
 29generate_attribute!(
 30    /// A Candidate Type as defined in ICE-CORE.
 31    Type, "type", {
 32        /// Host candidate.
 33        Host => "host",
 34
 35        /// Peer reflexive candidate.
 36        Prflx => "prflx",
 37
 38        /// Relayed candidate.
 39        Relay => "relay",
 40
 41        /// Server reflexive candidate.
 42        Srflx => "srflx",
 43    }
 44);
 45
 46generate_element!(
 47    /// A candidate for an ICE-UDP session.
 48    Candidate, "candidate", JINGLE_ICE_UDP,
 49    attributes: [
 50        /// A Component ID as defined in ICE-CORE.
 51        component: Required<u8> = "component",
 52
 53        /// A Foundation as defined in ICE-CORE.
 54        foundation: Required<u8> = "foundation",
 55
 56        /// An index, starting at 0, that enables the parties to keep track of updates to the
 57        /// candidate throughout the life of the session.
 58        generation: Required<u8> = "generation",
 59
 60        /// A unique identifier for the candidate.
 61        id: Required<String> = "id",
 62
 63        /// The Internet Protocol (IP) address for the candidate transport mechanism; this can be
 64        /// either an IPv4 address or an IPv6 address.
 65        ip: Required<IpAddr> = "ip",
 66
 67        /// An index, starting at 0, referencing which network this candidate is on for a given
 68        /// peer.
 69        network: Required<u8> = "network",
 70
 71        /// The port at the candidate IP address.
 72        port: Required<u16> = "port",
 73
 74        /// A Priority as defined in ICE-CORE.
 75        priority: Required<u32> = "priority",
 76
 77        /// The protocol to be used. The only value defined by this specification is "udp".
 78        protocol: Required<String> = "protocol",
 79
 80        /// A related address as defined in ICE-CORE.
 81        rel_addr: Option<IpAddr> = "rel-addr",
 82
 83        /// A related port as defined in ICE-CORE.
 84        rel_port: Option<u16> = "rel-port",
 85
 86        /// A Candidate Type as defined in ICE-CORE.
 87        type_: Required<Type> = "type",
 88    ]
 89);
 90
 91#[cfg(test)]
 92mod tests {
 93    use super::*;
 94    use minidom::Element;
 95    use std::convert::TryFrom;
 96    use crate::hashes::Algo;
 97    use crate::jingle_dtls_srtp::Setup;
 98
 99    #[cfg(target_pointer_width = "32")]
100    #[test]
101    fn test_size() {
102        assert_size!(Transport, 68);
103        assert_size!(Type, 1);
104        assert_size!(Candidate, 80);
105    }
106
107    #[cfg(target_pointer_width = "64")]
108    #[test]
109    fn test_size() {
110        assert_size!(Transport, 136);
111        assert_size!(Type, 1);
112        assert_size!(Candidate, 104);
113    }
114
115    #[test]
116    fn test_gajim() {
117        let elem: Element = "
118<transport xmlns='urn:xmpp:jingle:transports:ice-udp:1' pwd='wakMJ8Ydd5rqnPaFerws5o' ufrag='aeXX'>
119    <candidate xmlns='urn:xmpp:jingle:transports:ice-udp:1' component='2' foundation='1' generation='0' id='11b72719-6a1b-4c51-8ae6-9f1538047568' ip='192.168.0.12' network='0' port='56715' priority='1010828030' protocol='tcp' type='host'/>
120    <candidate xmlns='urn:xmpp:jingle:transports:ice-udp:1' component='2' foundation='1' generation='0' id='7e07b22d-db50-4e17-9ed9-eafeb96f4f63' ip='192.168.0.12' network='0' port='0' priority='1015022334' protocol='tcp' type='host'/>
121    <candidate xmlns='urn:xmpp:jingle:transports:ice-udp:1' component='2' foundation='1' generation='0' id='431de362-c45f-40a8-bf10-9ed898a71d86' ip='192.168.0.12' network='0' port='36480' priority='2013266428' protocol='udp' type='host'/>
122    <candidate xmlns='urn:xmpp:jingle:transports:ice-udp:1' component='1' foundation='1' generation='0' id='b1197df3-abca-413b-99ee-3660d91bcfa7' ip='192.168.0.12' network='0' port='50387' priority='1010828031' protocol='tcp' type='host'/>
123    <candidate xmlns='urn:xmpp:jingle:transports:ice-udp:1' component='1' foundation='1' generation='0' id='adaf3a85-3a57-4df0-a2d8-0c7d28d3ca01' ip='192.168.0.12' network='0' port='0' priority='1015022335' protocol='tcp' type='host'/>
124    <candidate xmlns='urn:xmpp:jingle:transports:ice-udp:1' component='1' foundation='1' generation='0' id='ef4e0a62-81f2-4fe3-87ae-46cb5d1d1e1d' ip='192.168.0.12' network='0' port='43132' priority='2013266429' protocol='udp' type='host'/>
125    <candidate xmlns='urn:xmpp:jingle:transports:ice-udp:1' component='1' foundation='1' generation='0' id='51891e8a-4c1e-4540-b173-8637aeb0143c' ip='fe80::24eb:646f:7d78:cb6' network='0' port='38881' priority='2013266431' protocol='udp' type='host'/>
126    <candidate xmlns='urn:xmpp:jingle:transports:ice-udp:1' component='1' foundation='1' generation='0' id='73f82655-eb84-4fa1-b05c-1ea76f695d32' ip='fe80::24eb:646f:7d78:cb6' network='0' port='0' priority='1015023103' protocol='tcp' type='host'/>
127    <candidate xmlns='urn:xmpp:jingle:transports:ice-udp:1' component='1' foundation='1' generation='0' id='a2a8fa62-6f2e-41e8-b218-ba095540d60f' ip='fe80::24eb:646f:7d78:cb6' network='0' port='55819' priority='1010828799' protocol='tcp' type='host'/>
128    <candidate xmlns='urn:xmpp:jingle:transports:ice-udp:1' component='1' foundation='1' generation='0' id='23e66735-9515-414c-81ad-2455569a57f8' ip='2a01:e35:2e2f:fbb0:43aa:33b5:5535:8905' network='0' port='39967' priority='2013266430' protocol='udp' type='host'/>
129    <candidate xmlns='urn:xmpp:jingle:transports:ice-udp:1' component='1' foundation='1' generation='0' id='9a8dff18-e138-4fb2-a956-89d71216da84' ip='2a01:e35:2e2f:fbb0:43aa:33b5:5535:8905' network='0' port='0' priority='1015022079' protocol='tcp' type='host'/>
130    <candidate xmlns='urn:xmpp:jingle:transports:ice-udp:1' component='1' foundation='1' generation='0' id='f0c73ac3-9b7d-4032-abe3-6dd9a57d0f03' ip='2a01:e35:2e2f:fbb0:43aa:33b5:5535:8905' network='0' port='37487' priority='1010827775' protocol='tcp' type='host'/>
131    <candidate xmlns='urn:xmpp:jingle:transports:ice-udp:1' component='2' foundation='1' generation='0' id='a6199a00-34df-46f5-a608-847b75c5250e' ip='fe80::24eb:646f:7d78:cb6' network='0' port='43521' priority='2013266430' protocol='udp' type='host'/>
132    <candidate xmlns='urn:xmpp:jingle:transports:ice-udp:1' component='2' foundation='1' generation='0' id='83bc2600-39ce-4c9e-8b0b-cc7aa7e6a293' ip='fe80::24eb:646f:7d78:cb6' network='0' port='0' priority='1015023102' protocol='tcp' type='host'/>
133    <candidate xmlns='urn:xmpp:jingle:transports:ice-udp:1' component='2' foundation='1' generation='0' id='7e3606ca-46de-4de8-8802-068dd69ef01a' ip='fe80::24eb:646f:7d78:cb6' network='0' port='52279' priority='1010828798' protocol='tcp' type='host'/>
134    <candidate xmlns='urn:xmpp:jingle:transports:ice-udp:1' component='2' foundation='1' generation='0' id='a7c2472a-8462-412c-a64c-d3528f0abfa4' ip='2a01:e35:2e2f:fbb0:43aa:33b5:5535:8905' network='0' port='34088' priority='2013266429' protocol='udp' type='host'/>
135    <candidate xmlns='urn:xmpp:jingle:transports:ice-udp:1' component='2' foundation='1' generation='0' id='5a12c345-9643-4d2c-b770-695ec6affcaf' ip='2a01:e35:2e2f:fbb0:43aa:33b5:5535:8905' network='0' port='0' priority='1015022078' protocol='tcp' type='host'/>
136    <candidate xmlns='urn:xmpp:jingle:transports:ice-udp:1' component='2' foundation='1' generation='0' id='67f65b0b-8cee-421a-9f37-1f2ca2211c87' ip='2a01:e35:2e2f:fbb0:43aa:33b5:5535:8905' network='0' port='39431' priority='1010827774' protocol='tcp' type='host'/>
137</transport>"
138                .parse()
139                .unwrap();
140        let transport = Transport::try_from(elem).unwrap();
141        assert_eq!(transport.pwd.unwrap(), "wakMJ8Ydd5rqnPaFerws5o");
142        assert_eq!(transport.ufrag.unwrap(), "aeXX");
143    }
144
145    #[test]
146    fn test_jitsi_meet() {
147        let elem: Element = "
148<transport ufrag='2acq51d4p07v2m' pwd='7lk9uul39gckit6t02oavv2r9j' xmlns='urn:xmpp:jingle:transports:ice-udp:1'>
149    <fingerprint hash='sha-1' setup='actpass' xmlns='urn:xmpp:jingle:apps:dtls:0'>97:F2:B5:BE:DB:A6:00:B1:3E:40:B2:41:3C:0D:FC:E0:BD:B2:A0:E8</fingerprint>
150    <candidate type='host' protocol='udp' id='186cb069513c2bbe546192c93cc4ab3b05ab0d426' ip='2a05:d014:fc7:54a1:8bfc:7248:3d1c:51a4' component='1' port='10000' foundation='1' generation='0' priority='2130706431' network='0'/>
151    <candidate type='host' protocol='udp' id='186cb069513c2bbe546192c93cc4ab3b063daeefd' ip='10.15.1.120' component='1' port='10000' foundation='2' generation='0' priority='2130706431' network='0'/>
152    <candidate rel-port='10000' type='srflx' protocol='udp' id='186cb069513c2bbe546192c93cc4ab3b05d449db8' ip='3.120.176.51' component='1' port='10000' foundation='3' generation='0' network='0' priority='1677724415' rel-addr='10.15.1.120'/>
153</transport>"
154                .parse()
155                .unwrap();
156        let transport = Transport::try_from(elem).unwrap();
157        assert_eq!(transport.pwd.unwrap(), "7lk9uul39gckit6t02oavv2r9j");
158        assert_eq!(transport.ufrag.unwrap(), "2acq51d4p07v2m");
159
160        let fingerprint = transport.fingerprint.unwrap();
161        assert_eq!(fingerprint.hash, Algo::Sha_1);
162        assert_eq!(fingerprint.setup, Setup::Actpass);
163        assert_eq!(fingerprint.value, [151, 242, 181, 190, 219, 166, 0, 177, 62, 64, 178, 65, 60, 13, 252, 224, 189, 178, 160, 232]);
164    }
165}