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
use super::*;
use crate::errors::*;
use crate::mdns::*;
use crate::network_type::*;
use crate::url::*;

use util::vnet::net::*;
use util::Error;

use std::time::Duration;

// DEFAULT_CHECK_INTERVAL is the interval at which the agent performs candidate checks in the connecting phase
pub(crate) const DEFAULT_CHECK_INTERVAL: Duration = Duration::from_millis(200);

// keepalive_interval used to keep candidates alive
pub(crate) const DEFAULT_KEEPALIVE_INTERVAL: Duration = Duration::from_secs(2);

// DEFAULT_DISCONNECTED_TIMEOUT is the default time till an Agent transitions disconnected
pub(crate) const DEFAULT_DISCONNECTED_TIMEOUT: Duration = Duration::from_secs(5);

// DEFAULT_FAILED_TIMEOUT is the default time till an Agent transitions to failed after disconnected
pub(crate) const DEFAULT_FAILED_TIMEOUT: Duration = Duration::from_secs(25);

// wait time before nominating a host candidate
pub(crate) const DEFAULT_HOST_ACCEPTANCE_MIN_WAIT: Duration = Duration::from_secs(0);

// wait time before nominating a srflx candidate
pub(crate) const DEFAULT_SRFLX_ACCEPTANCE_MIN_WAIT: Duration = Duration::from_millis(500);

// wait time before nominating a prflx candidate
pub(crate) const DEFAULT_PRFLX_ACCEPTANCE_MIN_WAIT: Duration = Duration::from_millis(1000);

// wait time before nominating a relay candidate
pub(crate) const DEFAULT_RELAY_ACCEPTANCE_MIN_WAIT: Duration = Duration::from_millis(2000);

// max binding request before considering a pair failed
pub(crate) const DEFAULT_MAX_BINDING_REQUESTS: u16 = 7;

// the number of bytes that can be buffered before we start to error
pub(crate) const MAX_BUFFER_SIZE: usize = 1000 * 1000; // 1MB

// wait time before binding requests can be deleted
pub(crate) const MAX_BINDING_REQUEST_TIMEOUT: Duration = Duration::from_millis(4000);

pub(crate) fn default_candidate_types() -> Vec<CandidateType> {
    vec![
        CandidateType::Host,
        CandidateType::ServerReflexive,
        CandidateType::Relay,
    ]
}

pub(crate) type InterfaceFilterFn = Box<dyn (Fn(&str) -> bool) + Send + Sync>;

// AgentConfig collects the arguments to ice.Agent construction into
// a single structure, for future-proofness of the interface
#[derive(Default)]
pub struct AgentConfig {
    pub urls: Vec<Url>,

    // port_min and port_max are optional. Leave them 0 for the default UDP port allocation strategy.
    pub port_min: u16,
    pub port_max: u16,

    // local_ufrag and local_pwd values used to perform connectivity
    // checks.  The values MUST be unguessable, with at least 128 bits of
    // random number generator output used to generate the password, and
    // at least 24 bits of output to generate the username fragment.
    pub local_ufrag: String,
    pub local_pwd: String,

    // multicast_dns_mode controls mDNS behavior for the ICE agent
    pub multicast_dns_mode: MulticastDnsMode,

    // multicast_dns_host_name controls the hostname for this agent. If none is specified a random one will be generated
    pub multicast_dns_host_name: String,

    // disconnected_timeout defaults to 5 seconds when this property is nil.
    // If the duration is 0, the ICE Agent will never go to disconnected
    pub disconnected_timeout: Option<Duration>,

    // failed_timeout defaults to 25 seconds when this property is nil.
    // If the duration is 0, we will never go to failed.
    pub failed_timeout: Option<Duration>,

    // keepalive_interval determines how often should we send ICE
    // keepalives (should be less then connectiontimeout above)
    // when this is nil, it defaults to 10 seconds.
    // A keepalive interval of 0 means we never send keepalive packets
    pub keepalive_interval: Option<Duration>,

    // network_types is an optional configuration for disabling or enabling
    // support for specific network types.
    pub network_types: Vec<NetworkType>,

    // candidate_types is an optional configuration for disabling or enabling
    // support for specific candidate types.
    pub candidate_types: Vec<CandidateType>,

    //LoggerFactory logging.LoggerFactory

    // check_interval controls how often our internal task loop runs when
    // in the connecting state. Only useful for testing.
    pub check_interval: Duration,

    // max_binding_requests is the max amount of binding requests the agent will send
    // over a candidate pair for validation or nomination, if after max_binding_requests
    // the candidate is yet to answer a binding request or a nomination we set the pair as failed
    pub max_binding_requests: Option<u16>,

    pub is_controlling: bool,

    // lite agents do not perform connectivity check and only provide host candidates.
    pub lite: bool,

    // nat1to1ipcandidate_type is used along with nat1to1ips to specify which candidate type
    // the 1:1 NAT IP addresses should be mapped to.
    // If unspecified or CandidateTypeHost, nat1to1ips are used to replace host candidate IPs.
    // If CandidateTypeServerReflexive, it will insert a srflx candidate (as if it was dervied
    // from a STUN server) with its port number being the one for the actual host candidate.
    // Other values will result in an error.
    pub nat_1to1_ip_candidate_type: CandidateType,

    // nat1to1ips contains a list of public IP addresses that are to be used as a host
    // candidate or srflx candidate. This is used typically for servers that are behind
    // 1:1 D-NAT (e.g. AWS EC2 instances) and to eliminate the need of server reflexisive
    // candidate gathering.
    pub nat_1to1_ips: Vec<String>,

    // host_acceptance_min_wait specify a minimum wait time before selecting host candidates
    pub host_acceptance_min_wait: Option<Duration>,
    // host_acceptance_min_wait specify a minimum wait time before selecting srflx candidates
    pub srflx_acceptance_min_wait: Option<Duration>,
    // host_acceptance_min_wait specify a minimum wait time before selecting prflx candidates
    pub prflx_acceptance_min_wait: Option<Duration>,
    // host_acceptance_min_wait specify a minimum wait time before selecting relay candidates
    pub relay_acceptance_min_wait: Option<Duration>,

    // Net is the our abstracted network interface for internal development purpose only
    // (see github.com/pion/transport/vnet)
    pub net: Option<Arc<Net>>,

    // interface_filter is a function that you can use in order to  whitelist or blacklist
    // the interfaces which are used to gather ICE candidates.
    pub interface_filter: Option<InterfaceFilterFn>,

    // insecure_skip_verify controls if self-signed certificates are accepted when connecting
    // to TURN servers via TLS or DTLS
    pub insecure_skip_verify: bool,
}

impl AgentConfig {
    // init_with_defaults populates an agent and falls back to defaults if fields are unset
    pub(crate) fn init_with_defaults(&self, a: &mut AgentInternal) {
        if let Some(max_binding_requests) = self.max_binding_requests {
            a.max_binding_requests = max_binding_requests;
        } else {
            a.max_binding_requests = DEFAULT_MAX_BINDING_REQUESTS;
        }

        if let Some(host_acceptance_min_wait) = self.host_acceptance_min_wait {
            a.host_acceptance_min_wait = host_acceptance_min_wait;
        } else {
            a.host_acceptance_min_wait = DEFAULT_HOST_ACCEPTANCE_MIN_WAIT;
        }

        if let Some(srflx_acceptance_min_wait) = self.srflx_acceptance_min_wait {
            a.srflx_acceptance_min_wait = srflx_acceptance_min_wait;
        } else {
            a.srflx_acceptance_min_wait = DEFAULT_SRFLX_ACCEPTANCE_MIN_WAIT;
        }

        if let Some(prflx_acceptance_min_wait) = self.prflx_acceptance_min_wait {
            a.prflx_acceptance_min_wait = prflx_acceptance_min_wait;
        } else {
            a.prflx_acceptance_min_wait = DEFAULT_PRFLX_ACCEPTANCE_MIN_WAIT;
        }

        if let Some(relay_acceptance_min_wait) = self.relay_acceptance_min_wait {
            a.relay_acceptance_min_wait = relay_acceptance_min_wait;
        } else {
            a.relay_acceptance_min_wait = DEFAULT_RELAY_ACCEPTANCE_MIN_WAIT;
        }

        if let Some(disconnected_timeout) = self.disconnected_timeout {
            a.disconnected_timeout = disconnected_timeout;
        } else {
            a.disconnected_timeout = DEFAULT_DISCONNECTED_TIMEOUT;
        }

        if let Some(failed_timeout) = self.failed_timeout {
            a.failed_timeout = failed_timeout;
        } else {
            a.failed_timeout = DEFAULT_FAILED_TIMEOUT;
        }

        if let Some(keepalive_interval) = self.keepalive_interval {
            a.keepalive_interval = keepalive_interval;
        } else {
            a.keepalive_interval = DEFAULT_KEEPALIVE_INTERVAL;
        }

        if self.check_interval == Duration::from_secs(0) {
            a.check_interval = DEFAULT_CHECK_INTERVAL;
        } else {
            a.check_interval = self.check_interval;
        }
    }

    pub(crate) fn init_ext_ip_mapping(
        &self,
        mdns_mode: MulticastDnsMode,
        candidate_types: &[CandidateType],
    ) -> Result<Option<ExternalIpMapper>, Error> {
        if let Some(ext_ip_mapper) =
            ExternalIpMapper::new(self.nat_1to1_ip_candidate_type, &self.nat_1to1_ips)?
        {
            if ext_ip_mapper.candidate_type == CandidateType::Host {
                if mdns_mode == MulticastDnsMode::QueryAndGather {
                    return Err(ERR_MULTICAST_DNS_WITH_NAT_1TO1_IP_MAPPING.to_owned());
                }
                let mut candi_host_enabled = false;
                for candi_type in candidate_types {
                    if *candi_type == CandidateType::Host {
                        candi_host_enabled = true;
                        break;
                    }
                }
                if !candi_host_enabled {
                    return Err(ERR_INEFFECTIVE_NAT_1TO1_IP_MAPPING_HOST.to_owned());
                }
            } else if ext_ip_mapper.candidate_type == CandidateType::ServerReflexive {
                let mut candi_srflx_enabled = false;
                for candi_type in candidate_types {
                    if *candi_type == CandidateType::ServerReflexive {
                        candi_srflx_enabled = true;
                        break;
                    }
                }
                if !candi_srflx_enabled {
                    return Err(ERR_INEFFECTIVE_NAT_1TO1_IP_MAPPING_SRFLX.to_owned());
                }
            }

            Ok(Some(ext_ip_mapper))
        } else {
            Ok(None)
        }
    }
}