1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
use std::{
    error::Error,
    fmt::{self, Display, Formatter},
    net::SocketAddr,
};

use crate::AgentRole;

/// Candidate type.
#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
pub enum CandidateKind {
    Host,
    ServerReflexive,
    PeerReflexive,
    Relayed,
}

/// Local candidate.
#[derive(Copy, Clone)]
pub struct LocalCandidate {
    channel: usize,
    component: u8,
    kind: CandidateKind,
    base: SocketAddr,
    addr: SocketAddr,
    foundation: u32,
    priority: u32,
}

impl LocalCandidate {
    /// Calculate local candidate priority for a given component ID, candidate
    /// type and the candidate base address.
    #[inline]
    pub const fn calculate_priority(component: u8, kind: CandidateKind, base: SocketAddr) -> u32 {
        let type_preference = match kind {
            CandidateKind::Host => 126,
            CandidateKind::PeerReflexive => 110,
            CandidateKind::ServerReflexive => 100,
            CandidateKind::Relayed => 0,
        };

        let local_preference = if matches!(base, SocketAddr::V6(_)) {
            65_535
        } else {
            65_534
        };

        type_preference << 24 | local_preference << 8 | (255 - component as u32)
    }

    /// Create a new host candidate.
    #[inline]
    pub const fn host(channel: usize, component: u8, addr: SocketAddr) -> Self {
        Self {
            channel,
            component,
            kind: CandidateKind::Host,
            base: addr,
            addr,
            foundation: 0,
            priority: Self::calculate_priority(component, CandidateKind::Host, addr),
        }
    }

    /// Create a new server-reflexive candidate.
    #[inline]
    pub const fn server_reflexive(
        channel: usize,
        component: u8,
        base: SocketAddr,
        addr: SocketAddr,
    ) -> Self {
        Self {
            channel,
            component,
            kind: CandidateKind::ServerReflexive,
            base,
            addr,
            foundation: 0,
            priority: Self::calculate_priority(component, CandidateKind::ServerReflexive, base),
        }
    }

    /// Create a new peer-reflexive candidate.
    #[inline]
    pub const fn peer_reflexive(
        channel: usize,
        component: u8,
        base: SocketAddr,
        addr: SocketAddr,
    ) -> Self {
        Self {
            channel,
            component,
            kind: CandidateKind::PeerReflexive,
            base,
            addr,
            foundation: 0,
            priority: Self::calculate_priority(component, CandidateKind::PeerReflexive, base),
        }
    }

    /// Create a new relayed candidate.
    #[inline]
    pub const fn relayed(channel: usize, component: u8, addr: SocketAddr) -> Self {
        // NOTE: addr and base are the same for relayed candidates because we
        // do not use a specific local transport address to deliver data to the
        // corresponding TURN server (i.e. the local address can be arbitrary)
        Self {
            channel,
            component,
            kind: CandidateKind::Relayed,
            base: addr,
            addr,
            foundation: 0,
            priority: Self::calculate_priority(component, CandidateKind::Relayed, addr),
        }
    }

    /// Create a new candidate with a given foundation value.
    #[inline]
    pub fn with_foundation(mut self, foundation: u32) -> Self {
        self.foundation = foundation;
        self
    }

    /// Get index of the (media) channel this candidate belongs to.
    #[inline]
    pub fn channel(&self) -> usize {
        self.channel
    }

    /// Get component ID of the component this candidate belongs to.
    ///
    /// # Note
    /// Unlike the component ID definition in RFC 5245, this component ID is
    /// zero-based. In order to get the RFC 5245 component ID (e.g. to create
    /// a session description), you need to add one to this number.
    #[inline]
    pub fn component(&self) -> u8 {
        self.component
    }

    /// Get type of the candidate.
    #[inline]
    pub fn kind(&self) -> CandidateKind {
        self.kind
    }

    /// Get the base address.
    #[inline]
    pub fn base(&self) -> SocketAddr {
        self.base
    }

    /// Get the address.
    #[inline]
    pub fn addr(&self) -> SocketAddr {
        self.addr
    }

    /// Get candidate priority.
    #[inline]
    pub fn priority(&self) -> u32 {
        self.priority
    }

    /// Get the foundation.
    #[inline]
    pub fn foundation(&self) -> u32 {
        self.foundation
    }
}

/// Remote candidate.
#[derive(Clone)]
pub struct RemoteCandidate {
    channel: usize,
    component: u8,
    kind: CandidateKind,
    addr: SocketAddr,
    foundation: String,
    priority: u32,
}

impl RemoteCandidate {
    /// Create a new remote candidate.
    ///
    /// # Note
    /// Unlike the component ID definition in RFC 5245, this component ID is
    /// zero-based. If you're creating a new remote candidate from an RFC 5245
    /// component ID (e.g. from a session description), make sure to subtract
    /// one.
    #[inline]
    pub fn new<T>(
        channel: usize,
        component: u8,
        kind: CandidateKind,
        addr: SocketAddr,
        foundation: T,
        priority: u32,
    ) -> Self
    where
        T: ToString,
    {
        Self {
            channel,
            component,
            kind,
            addr,
            foundation: foundation.to_string(),
            priority,
        }
    }

    /// Create a new peer-reflexive remote candidate.
    #[inline]
    pub fn peer_reflexive(channel: usize, component: u8, addr: SocketAddr, priority: u32) -> Self {
        Self {
            channel,
            component,
            kind: CandidateKind::PeerReflexive,
            addr,
            foundation: addr.to_string(),
            priority,
        }
    }

    /// Get index of the (media) channel this candidate belongs to.
    #[inline]
    pub fn channel(&self) -> usize {
        self.channel
    }

    /// Get component ID of the component this candidate belongs to.
    #[inline]
    pub fn component(&self) -> u8 {
        self.component
    }

    /// Get type of the candidate.
    #[inline]
    pub fn kind(&self) -> CandidateKind {
        self.kind
    }

    /// Get the address.
    #[inline]
    pub fn addr(&self) -> SocketAddr {
        self.addr
    }

    /// Get candidate priority.
    #[inline]
    pub fn priority(&self) -> u32 {
        self.priority
    }

    /// Get the foundation.
    #[inline]
    pub fn foundation(&self) -> &str {
        &self.foundation
    }
}

/// Local-remote candidate pair.
#[derive(Clone)]
pub struct CandidatePair {
    local: LocalCandidate,
    remote: RemoteCandidate,
    foundation: String,
}

impl CandidatePair {
    /// Create a new candidate pair.
    pub fn new(
        local: LocalCandidate,
        remote: RemoteCandidate,
    ) -> Result<Self, InvalidCandidatePair> {
        if local.channel != remote.channel || local.component != remote.component {
            return Err(InvalidCandidatePair);
        }

        let local_addr = local.addr();

        match remote.addr() {
            SocketAddr::V4(_) if local_addr.is_ipv4() => (),
            SocketAddr::V6(_) if local_addr.is_ipv6() => (),
            _ => return Err(InvalidCandidatePair),
        }

        let foundation = format!("{}:{}", local.foundation(), remote.foundation());

        let res = Self {
            local,
            remote,
            foundation,
        };

        Ok(res)
    }

    /// Get the local candidate.
    pub fn local(&self) -> &LocalCandidate {
        &self.local
    }

    /// Get the remote candidate.
    pub fn remote(&self) -> &RemoteCandidate {
        &self.remote
    }

    /// Get the pair priority.
    pub fn priority(&self, local_role: AgentRole) -> u64 {
        let (g, d) = match local_role {
            AgentRole::Controlling => (self.local.priority(), self.remote.priority()),
            AgentRole::Controlled => (self.remote.priority(), self.local.priority()),
        };

        let min = g.min(d) as u64;
        let max = g.max(d) as u64;

        (min << 32) + (max << 1) + u64::from(g > d)
    }

    /// Get the component ID.
    pub fn component(&self) -> u8 {
        self.remote.component()
    }

    /// Get foundation of the pair.
    pub fn foundation(&self) -> &str {
        &self.foundation
    }
}

/// Invalid candidate pair.
#[derive(Debug, Copy, Clone)]
pub struct InvalidCandidatePair;

impl Display for InvalidCandidatePair {
    fn fmt(&self, f: &mut Formatter) -> fmt::Result {
        f.write_str("the given local and remote candidates do not form a pair")
    }
}

impl Error for InvalidCandidatePair {}