xmpp_parsers/
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 core::net::IpAddr;
8
9use xso::{AsXml, FromXml};
10
11use crate::jingle_dtls_srtp::Fingerprint;
12use crate::ns;
13
14/// Wrapper element for an ICE-UDP transport.
15#[derive(FromXml, AsXml, Debug, PartialEq, Clone, Default)]
16#[xml(namespace = ns::JINGLE_ICE_UDP, name = "transport")]
17pub struct Transport {
18    /// A Password as defined in ICE-CORE.
19    #[xml(attribute(default))]
20    pwd: Option<String>,
21
22    /// A User Fragment as defined in ICE-CORE.
23    #[xml(attribute(default))]
24    ufrag: Option<String>,
25
26    /// List of candidates for this ICE-UDP session.
27    #[xml(child(n = ..))]
28    candidates: Vec<Candidate>,
29
30    /// Fingerprint of the key used for the DTLS handshake.
31    #[xml(child(default))]
32    fingerprint: Option<Fingerprint>,
33}
34
35impl Transport {
36    /// Create a new ICE-UDP transport.
37    pub fn new() -> Transport {
38        Transport::default()
39    }
40
41    /// Add a candidate to this transport.
42    pub fn add_candidate(mut self, candidate: Candidate) -> Self {
43        self.candidates.push(candidate);
44        self
45    }
46
47    /// Set the DTLS-SRTP fingerprint of this transport.
48    pub fn with_fingerprint(mut self, fingerprint: Fingerprint) -> Self {
49        self.fingerprint = Some(fingerprint);
50        self
51    }
52}
53
54generate_attribute!(
55    /// A Candidate Type as defined in ICE-CORE.
56    Type, "type", {
57        /// Host candidate.
58        Host => "host",
59
60        /// Peer reflexive candidate.
61        Prflx => "prflx",
62
63        /// Relayed candidate.
64        Relay => "relay",
65
66        /// Server reflexive candidate.
67        Srflx => "srflx",
68    }
69);
70
71/// A candidate for an ICE-UDP session.
72#[derive(FromXml, AsXml, Debug, PartialEq, Clone)]
73#[xml(namespace = ns::JINGLE_ICE_UDP, name = "candidate")]
74pub struct Candidate {
75    /// A Component ID as defined in ICE-CORE.
76    #[xml(attribute)]
77    pub component: u8,
78
79    /// A Foundation as defined in ICE-CORE.
80    #[xml(attribute)]
81    pub foundation: String,
82
83    /// An index, starting at 0, that enables the parties to keep track of updates to the
84    /// candidate throughout the life of the session.
85    #[xml(attribute)]
86    pub generation: u8,
87
88    /// A unique identifier for the candidate.
89    #[xml(attribute)]
90    pub id: String,
91
92    /// The Internet Protocol (IP) address for the candidate transport mechanism; this can be
93    /// either an IPv4 address or an IPv6 address.
94    #[xml(attribute)]
95    pub ip: IpAddr,
96
97    /// The port at the candidate IP address.
98    #[xml(attribute)]
99    pub port: u16,
100
101    /// A Priority as defined in ICE-CORE.
102    #[xml(attribute)]
103    pub priority: u32,
104
105    /// The protocol to be used. The only value defined by this specification is "udp".
106    #[xml(attribute)]
107    pub protocol: String,
108
109    /// A related address as defined in ICE-CORE.
110    #[xml(attribute(default, name = "rel-addr"))]
111    pub rel_addr: Option<IpAddr>,
112
113    /// A related port as defined in ICE-CORE.
114    #[xml(attribute(default, name = "rel-port"))]
115    pub rel_port: Option<u16>,
116
117    /// An index, starting at 0, referencing which network this candidate is on for a given
118    /// peer.
119    #[xml(attribute(default))]
120    pub network: Option<u8>,
121
122    /// A Candidate Type as defined in ICE-CORE.
123    #[xml(attribute(name = "type"))]
124    pub type_: Type,
125}
126
127#[cfg(test)]
128mod tests {
129    use super::*;
130    use crate::hashes::Algo;
131    use crate::jingle_dtls_srtp::Setup;
132    use minidom::Element;
133
134    #[cfg(target_pointer_width = "32")]
135    #[test]
136    fn test_size() {
137        assert_size!(Transport, 64);
138        assert_size!(Type, 1);
139        assert_size!(Candidate, 88);
140    }
141
142    #[cfg(target_pointer_width = "64")]
143    #[test]
144    fn test_size() {
145        assert_size!(Transport, 128);
146        assert_size!(Type, 1);
147        assert_size!(Candidate, 128);
148    }
149
150    #[test]
151    fn test_gajim() {
152        let elem: Element = "<transport xmlns='urn:xmpp:jingle:transports:ice-udp:1' pwd='wakMJ8Ydd5rqnPaFerws5o' ufrag='aeXX'>
153    <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'/>
154    <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'/>
155    <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'/>
156    <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'/>
157    <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'/>
158    <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'/>
159    <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'/>
160    <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'/>
161    <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'/>
162    <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'/>
163    <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'/>
164    <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'/>
165    <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'/>
166    <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'/>
167    <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'/>
168    <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'/>
169    <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'/>
170    <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'/>
171</transport>"
172                .parse()
173                .unwrap();
174        let transport = Transport::try_from(elem).unwrap();
175        assert_eq!(transport.pwd.unwrap(), "wakMJ8Ydd5rqnPaFerws5o");
176        assert_eq!(transport.ufrag.unwrap(), "aeXX");
177    }
178
179    #[test]
180    fn test_jitsi_meet() {
181        let elem: Element = "<transport ufrag='2acq51d4p07v2m' pwd='7lk9uul39gckit6t02oavv2r9j' xmlns='urn:xmpp:jingle:transports:ice-udp:1'>
182    <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>
183    <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'/>
184    <candidate type='host' protocol='udp' id='186cb069513c2bbe546192c93cc4ab3b063daeefd' ip='10.15.1.120' component='1' port='10000' foundation='2' generation='0' priority='2130706431' network='0'/>
185    <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'/>
186</transport>"
187                .parse()
188                .unwrap();
189        let transport = Transport::try_from(elem).unwrap();
190        assert_eq!(transport.pwd.unwrap(), "7lk9uul39gckit6t02oavv2r9j");
191        assert_eq!(transport.ufrag.unwrap(), "2acq51d4p07v2m");
192
193        let fingerprint = transport.fingerprint.unwrap();
194        assert_eq!(fingerprint.hash, Algo::Sha_1);
195        assert_eq!(fingerprint.setup, Setup::Actpass);
196        assert_eq!(
197            fingerprint.value,
198            [
199                151, 242, 181, 190, 219, 166, 0, 177, 62, 64, 178, 65, 60, 13, 252, 224, 189, 178,
200                160, 232
201            ]
202        );
203    }
204
205    #[test]
206    fn test_serialize_transport() {
207        let reference: Element =
208            "<transport xmlns='urn:xmpp:jingle:transports:ice-udp:1'><fingerprint xmlns='urn:xmpp:jingle:apps:dtls:0' hash='sha-256' setup='actpass'>02:1A:CC:54:27:AB:EB:9C:53:3F:3E:4B:65:2E:7D:46:3F:54:42:CD:54:F1:7A:03:A2:7D:F9:B0:7F:46:19:B2</fingerprint></transport>"
209                .parse()
210                .unwrap();
211
212        let elem: Element = "<fingerprint xmlns='urn:xmpp:jingle:apps:dtls:0' hash='sha-256' setup='actpass'>02:1A:CC:54:27:AB:EB:9C:53:3F:3E:4B:65:2E:7D:46:3F:54:42:CD:54:F1:7A:03:A2:7D:F9:B0:7F:46:19:B2</fingerprint>"
213                .parse()
214                .unwrap();
215        let fingerprint = Fingerprint::try_from(elem).unwrap();
216
217        let transport = Transport {
218            pwd: None,
219            ufrag: None,
220            candidates: vec![],
221            fingerprint: Some(fingerprint),
222        };
223
224        let serialized: Element = transport.into();
225        assert_eq!(serialized, reference);
226    }
227}
xmpp_parsers/jingle_ice_udp.rs

xmpp_parsers/
jingle_ice_udp.rs
