1
//! Types and traits for converting objects to addresses which
2
//! Tor can connect to.
3

            
4
use crate::StreamPrefs;
5
use crate::err::ErrorDetail;
6
use std::fmt::Display;
7
use std::net::{IpAddr, Ipv4Addr, Ipv6Addr, SocketAddr, SocketAddrV4, SocketAddrV6};
8
use std::str::FromStr;
9
use thiserror::Error;
10
use tor_basic_utils::StrExt;
11
use tor_error::{ErrorKind, HasKind};
12

            
13
#[cfg(feature = "onion-service-client")]
14
use tor_hscrypto::pk::{HSID_ONION_SUFFIX, HsId};
15

            
16
/// Fake plastic imitation of some of the `tor-hs*` functionality
17
#[cfg(not(feature = "onion-service-client"))]
18
pub(crate) mod hs_dummy {
19
    use super::*;
20
    use tor_error::internal;
21
    use void::Void;
22

            
23
    /// Parsed hidden service identity - uninhabited, since not supported
24
    #[derive(Debug, Clone)]
25
    pub(crate) struct HsId(pub(crate) Void);
26

            
27
    impl PartialEq for HsId {
28
        fn eq(&self, _other: &Self) -> bool {
29
            void::unreachable(self.0)
30
        }
31
    }
32
    impl Eq for HsId {}
33

            
34
    /// Duplicates `tor-hscrypto::pk::HSID_ONION_SUFFIX`, ah well
35
    pub(crate) const HSID_ONION_SUFFIX: &str = ".onion";
36

            
37
    /// Must not be used other than for actual `.onion` addresses
38
    impl FromStr for HsId {
39
        type Err = ErrorDetail;
40

            
41
        fn from_str(s: &str) -> Result<Self, Self::Err> {
42
            if !s.ends_with(HSID_ONION_SUFFIX) {
43
                return Err(internal!("non-.onion passed to dummy HsId::from_str").into());
44
            }
45

            
46
            Err(ErrorDetail::OnionAddressNotSupported)
47
        }
48
    }
49
}
50
#[cfg(not(feature = "onion-service-client"))]
51
use hs_dummy::*;
52

            
53
// ----------------------------------------------------------------------
54

            
55
/// An object that can be converted to a [`TorAddr`] with a minimum of risk.
56
///
57
/// Typically, this trait will be implemented for a hostname or service name.
58
///
59
/// Don't implement this trait for IP addresses and similar types; instead,
60
/// implement [`DangerouslyIntoTorAddr`] for those.  (The trouble with accepting
61
/// IP addresses is that, in order to get an IP address, most programs will do a
62
/// local hostname lookup, which will leak the target address to the DNS
63
/// resolver. The `DangerouslyIntoTorAddr` trait provides a contract for careful
64
/// programs to say, "I have gotten this IP address from somewhere safe."  This
65
/// trait is for name-based addressing and similar, which _usually_ gets its
66
/// addresses from a safer source.)
67
///
68
/// [*See also: the `TorAddr` documentation.*](TorAddr)
69
///
70
/// # Design note
71
///
72
/// We use a separate trait here, instead of using `Into<TorAddr>` or
73
/// `TryInto<TorAddr>`, because `IntoTorAddr` implies additional guarantees
74
/// relating to privacy risk.  The separate trait alerts users that something
75
/// tricky is going on here, and encourages them to think twice before
76
/// implementing `IntoTorAddr` for their own types.
77
pub trait IntoTorAddr {
78
    /// Try to make a [`TorAddr`] to represent connecting to this
79
    /// address.
80
    fn into_tor_addr(self) -> Result<TorAddr, TorAddrError>;
81
}
82

            
83
/// An object that can be converted to a [`TorAddr`], but which it
84
/// might be risky to get in the first place if you're hoping for
85
/// anonymity.
86
///
87
/// For example, you can use this trait to convert a [`SocketAddr`]
88
/// into a [`TorAddr`], and it's safe to do that conversion.  But
89
/// where did you get the [`SocketAddr`] in the first place?  If it
90
/// comes from a local DNS lookup, then you have leaked the address
91
/// you were resolving to your DNS resolver, and probably your ISP.
92
///
93
/// [*See also: the `TorAddr` documentation.*](TorAddr)
94
pub trait DangerouslyIntoTorAddr {
95
    /// Try to make a [`TorAddr`] to represent connecting to `self`.
96
    ///
97
    /// By calling this function, the caller asserts that `self` was
98
    /// obtained from some secure, private mechanism, and **not** from a local
99
    /// DNS lookup or something similar.
100
    fn into_tor_addr_dangerously(self) -> Result<TorAddr, TorAddrError>;
101
}
102

            
103
/// An address object that you can connect to over the Tor network.
104
///
105
/// When you're making a connection with Tor, you shouldn't do your DNS
106
/// lookups locally: that would leak your target address to your DNS server.
107
/// Instead, it's better to use a combination of a hostname and a port
108
/// directly.
109
///
110
/// The preferred way to create a `TorAddr` is via the [`IntoTorAddr`] trait,
111
/// using a hostname and a port (or a string containing a hostname and a
112
/// port).  It's also okay to use an IP and Port there, but only if they come
113
/// from some source _other than_ a local DNS lookup.
114
///
115
/// In order to discourage local hostname lookups, the functions that
116
/// construct a [`TorAddr`] from [`IpAddr`], [`SocketAddr`], and so
117
/// forth are labeled as "dangerous".
118
///
119
/// # Examples
120
///
121
/// Making a `TorAddr` from various "safe" sources:
122
///
123
/// ```rust
124
/// # use anyhow::Result;
125
/// # fn main() -> Result<()> {
126
/// use arti_client::IntoTorAddr;
127
///
128
/// let example_from_tuple = ("example.com", 80).into_tor_addr()?;
129
/// let example_from_string = "example.com:80".into_tor_addr()?;
130
///
131
/// assert_eq!(example_from_tuple, example_from_string);
132
/// # Ok(())
133
/// # }
134
/// ```
135
///
136
/// Making a `TorAddr` from an IP address and port:
137
///
138
/// > **Warning:** This example is only safe because we're not doing a DNS lookup; rather, the
139
/// > intent is to connect to a hardcoded IP address.
140
/// > If you're using [`DangerouslyIntoTorAddr`], pay careful attention to where your IP addresses
141
/// > are coming from, and whether there's a risk of information leakage.
142
///
143
/// ```rust
144
/// # use anyhow::Result;
145
/// # fn main() -> Result<()> {
146
/// use arti_client::DangerouslyIntoTorAddr;
147
/// use std::net::{IpAddr, SocketAddr};
148
///
149
/// let quad_one_dns: SocketAddr = "1.1.1.1:53".parse()?;
150
/// let addr_from_socketaddr = quad_one_dns.into_tor_addr_dangerously()?;
151
///
152
/// let quad_one_ip: IpAddr = "1.1.1.1".parse()?;
153
/// let addr_from_tuple = (quad_one_ip, 53).into_tor_addr_dangerously()?;
154
///
155
/// assert_eq!(addr_from_socketaddr, addr_from_tuple);
156
/// # Ok(())
157
/// # }
158
/// ```
159
#[derive(Debug, Clone, Eq, PartialEq)]
160
pub struct TorAddr {
161
    /// The target host.
162
    host: Host,
163
    /// The target port number.
164
    port: u16,
165
}
166

            
167
/// How to make a stream to this `TorAddr`?
168
///
169
/// This is a separate type, returned from `address.rs` to `client.rs`,
170
/// so that we can test our "how to make a connection" logic and policy,
171
/// in isolation, without a whole Tor client.
172
#[derive(Debug, PartialEq, Eq)]
173
pub(crate) enum StreamInstructions {
174
    /// Create an exit circuit suitable for port, and then make a stream to `hostname`
175
    Exit {
176
        /// Hostname
177
        hostname: String,
178
        /// Port
179
        port: u16,
180
    },
181
    /// Create a hidden service connection to hsid, and then make a stream to `hostname`
182
    ///
183
    /// `HsId`, and therefore this variant, is uninhabited, unless the feature is enabled
184
    Hs {
185
        /// The target hidden service
186
        hsid: HsId,
187
        /// The hostname (used for subdomains, sent to the peer)
188
        hostname: String,
189
        /// Port
190
        port: u16,
191
    },
192
}
193

            
194
/// How to resolve this Tor host address into IP address(es)
195
#[derive(PartialEq, Eq, Debug)]
196
pub(crate) enum ResolveInstructions {
197
    /// Create an exit circuit without port restrictions, and ask the exit
198
    Exit(String),
199
    /// Simply return this
200
    Return(Vec<IpAddr>),
201
}
202

            
203
impl TorAddr {
204
    /// Construct a TorAddr from its constituent parts, rejecting it if the
205
    /// port is zero.
206
110
    fn new(host: Host, port: u16) -> Result<Self, TorAddrError> {
207
110
        if port == 0 {
208
2
            Err(TorAddrError::BadPort)
209
        } else {
210
108
            Ok(TorAddr { host, port })
211
        }
212
110
    }
213

            
214
    /// Construct a `TorAddr` from any object that implements
215
    /// [`IntoTorAddr`].
216
58
    pub fn from<A: IntoTorAddr>(addr: A) -> Result<Self, TorAddrError> {
217
58
        addr.into_tor_addr()
218
58
    }
219
    /// Construct a `TorAddr` from any object that implements
220
    /// [`DangerouslyIntoTorAddr`].
221
    ///
222
    /// See [`DangerouslyIntoTorAddr`] for an explanation of why the
223
    /// style of programming supported by this function is dangerous
224
    /// to use.
225
14
    pub fn dangerously_from<A: DangerouslyIntoTorAddr>(addr: A) -> Result<Self, TorAddrError> {
226
14
        addr.into_tor_addr_dangerously()
227
14
    }
228

            
229
    /// Return true if this is an IP address (rather than a hostname).
230
10
    pub fn is_ip_address(&self) -> bool {
231
10
        matches!(&self.host, Host::Ip(_))
232
10
    }
233

            
234
    /// If this TorAddr is an explicit IP address, return a reference to that [`IpAddr`].
235
    pub fn as_ip_address(&self) -> Option<&IpAddr> {
236
        match &self.host {
237
            Host::Ip(a) => Some(a),
238
            _ => None,
239
        }
240
    }
241

            
242
    /// Get instructions for how to make a stream to this address
243
18
    pub(crate) fn into_stream_instructions(
244
18
        self,
245
18
        cfg: &crate::config::ClientAddrConfig,
246
18
        prefs: &StreamPrefs,
247
18
    ) -> Result<StreamInstructions, ErrorDetail> {
248
18
        self.enforce_config(cfg, prefs)?;
249

            
250
16
        let port = self.port;
251
16
        Ok(match self.host {
252
6
            Host::Hostname(hostname) => StreamInstructions::Exit { hostname, port },
253
2
            Host::Ip(ip) => StreamInstructions::Exit {
254
2
                hostname: ip.to_string(),
255
2
                port,
256
2
            },
257
8
            Host::Onion(onion) => {
258
                // The HS is identified by the last two domain name components
259
8
                let rhs = onion
260
8
                    .rmatch_indices('.')
261
8
                    .nth(1)
262
9
                    .map(|(i, _)| i + 1)
263
8
                    .unwrap_or(0);
264
8
                let rhs = &onion[rhs..];
265
8
                let hsid = rhs.parse()?;
266
8
                StreamInstructions::Hs {
267
8
                    hsid,
268
8
                    port,
269
8
                    hostname: onion,
270
8
                }
271
            }
272
        })
273
18
    }
274

            
275
    /// Get instructions for how to make a stream to this address
276
14
    pub(crate) fn into_resolve_instructions(
277
14
        self,
278
14
        cfg: &crate::config::ClientAddrConfig,
279
14
        prefs: &StreamPrefs,
280
14
    ) -> Result<ResolveInstructions, ErrorDetail> {
281
        // We defer enforcing the config until we see if this is a .onion,
282
        // in which case it's always doomed and we want to return *our* error,
283
        // not any problem with the configuration or preferences.
284
        // But we must *calculate* the error now because instructions consumes self.
285
14
        let enforce_config_result = self.enforce_config(cfg, prefs);
286

            
287
        // This IEFE is so that any use of `return` doesn't bypass
288
        // checking the enforce_config result
289
16
        let instructions = (move || {
290
14
            Ok(match self.host {
291
2
                Host::Hostname(hostname) => ResolveInstructions::Exit(hostname),
292
2
                Host::Ip(ip) => ResolveInstructions::Return(vec![ip]),
293
10
                Host::Onion(_) => return Err(ErrorDetail::OnionAddressResolveRequest),
294
            })
295
10
        })()?;
296

            
297
4
        let () = enforce_config_result?;
298

            
299
4
        Ok(instructions)
300
14
    }
301

            
302
    /// Return true if the `host` in this address is local.
303
56
    fn is_local(&self) -> bool {
304
56
        self.host.is_local()
305
56
    }
306

            
307
    /// Give an error if this address doesn't conform to the rules set in
308
    /// `cfg`.
309
56
    fn enforce_config(
310
56
        &self,
311
56
        cfg: &crate::config::ClientAddrConfig,
312
56
        #[allow(unused_variables)] // will only be used in certain configurations
313
56
        prefs: &StreamPrefs,
314
56
    ) -> Result<(), ErrorDetail> {
315
56
        if !cfg.allow_local_addrs && self.is_local() {
316
2
            return Err(ErrorDetail::LocalAddress);
317
54
        }
318

            
319
54
        if let Host::Hostname(addr) = &self.host {
320
16
            if !is_valid_hostname(addr) {
321
                // This ought not to occur, because it violates Host's invariant
322
2
                return Err(ErrorDetail::InvalidHostname);
323
14
            }
324
14
            if addr.ends_with_ignore_ascii_case(HSID_ONION_SUFFIX) {
325
                // This ought not to occur, because it violates Host's invariant
326
2
                return Err(ErrorDetail::OnionAddressNotSupported);
327
12
            }
328
38
        }
329

            
330
50
        if let Host::Onion(_name) = &self.host {
331
            cfg_if::cfg_if! {
332
                if #[cfg(feature = "onion-service-client")] {
333
26
                    if !prefs.connect_to_onion_services.as_bool().unwrap_or(cfg.allow_onion_addrs) {
334
4
                        return Err(ErrorDetail::OnionAddressDisabled);
335
22
                    }
336
                } else {
337
                    return Err(ErrorDetail::OnionAddressNotSupported);
338
                }
339
            }
340
24
        }
341

            
342
46
        Ok(())
343
56
    }
344
}
345

            
346
impl std::fmt::Display for TorAddr {
347
28
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
348
20
        match self.host {
349
10
            Host::Ip(IpAddr::V6(addr)) => write!(f, "[{}]:{}", addr, self.port),
350
18
            _ => write!(f, "{}:{}", self.host, self.port),
351
        }
352
28
    }
353
}
354

            
355
/// An error created while making or using a [`TorAddr`].
356
//
357
// NOTE: Unlike ErrorDetail, this is a `pub` enum: Do not make breaking changes
358
// to it, or expose lower-level errors in it, without careful consideration!
359
#[derive(Debug, Error, Clone, Eq, PartialEq)]
360
#[non_exhaustive]
361
pub enum TorAddrError {
362
    /// Tried to parse a string that can never be interpreted as a valid host.
363
    #[error("String can never be a valid hostname")]
364
    InvalidHostname,
365
    /// Tried to parse a string as an `address:port`, but it had no port.
366
    #[error("No port found in string")]
367
    NoPort,
368
    /// Tried to parse a port that wasn't a valid nonzero `u16`.
369
    #[error("Could not parse port")]
370
    BadPort,
371
}
372

            
373
impl HasKind for TorAddrError {
374
6
    fn kind(&self) -> ErrorKind {
375
        use ErrorKind as EK;
376
        use TorAddrError as TAE;
377

            
378
6
        match self {
379
2
            TAE::InvalidHostname => EK::InvalidStreamTarget,
380
2
            TAE::NoPort => EK::InvalidStreamTarget,
381
2
            TAE::BadPort => EK::InvalidStreamTarget,
382
        }
383
6
    }
384
}
385

            
386
/// A host that Tor can connect to: either a hostname or an IP address.
387
//
388
// We use `String` in here, and pass that directly to (for example)
389
// `HsId::from_str`, or `begin_stream`.
390
// In theory we could use a couple of newtypes or something, but
391
//  * The stringly-typed `HsId::from_str` call (on a string known to end `.onion`)
392
//    appears precisely in `into_stream_instructions` which knows what it's doing;
393
//  * The stringly-typed .onion domain name must be passed in the
394
//    StreamInstructions so that we can send it to the HS for its vhosting.
395
#[derive(Clone, Debug, Eq, PartialEq)]
396
enum Host {
397
    /// A hostname.
398
    ///
399
    /// This variant should never be used if the `Ip`
400
    /// variant could be used instead.
401
    /// Ie, it must not be a stringified IP address.
402
    ///
403
    /// Likewise, this variant must *not* be used for a `.onion` address.
404
    /// Even if we have `.onion` support compiled out, we use the `Onion` variant for that.
405
    ///
406
    /// But, this variant might *not* be on the public internet.
407
    /// For example, it might be `localhost`.
408
    Hostname(String),
409
    /// An IP address.
410
    Ip(IpAddr),
411
    /// The address of a hidden service (`.onion` service).
412
    ///
413
    /// We haven't validated that the base32 makes any kind of sense, yet.
414
    /// We do that when we try to connect.
415
    Onion(String),
416
}
417

            
418
impl FromStr for Host {
419
    type Err = TorAddrError;
420
68
    fn from_str(s: &str) -> Result<Host, TorAddrError> {
421
68
        if s.ends_with_ignore_ascii_case(".onion") && is_valid_hostname(s) {
422
18
            Ok(Host::Onion(s.to_owned()))
423
50
        } else if let Ok(ip_addr) = s.parse() {
424
12
            Ok(Host::Ip(ip_addr))
425
38
        } else if is_valid_hostname(s) {
426
            // TODO(nickm): we might someday want to reject some kinds of bad
427
            // hostnames here, rather than when we're about to connect to them.
428
            // But that would be an API break, and maybe not what people want.
429
            // Maybe instead we should have a method to check whether a hostname
430
            // is "bad"? Not sure; we'll need to decide the right behavior here.
431
36
            Ok(Host::Hostname(s.to_owned()))
432
        } else {
433
2
            Err(TorAddrError::InvalidHostname)
434
        }
435
68
    }
436
}
437

            
438
impl Host {
439
    /// Return true if this address is one that is "internal": that is,
440
    /// relative to the particular host that is resolving it.
441
68
    fn is_local(&self) -> bool {
442
20
        match self {
443
22
            Host::Hostname(name) => name.eq_ignore_ascii_case("localhost"),
444
            // TODO: use is_global once it's stable, perhaps.
445
            // NOTE: Contrast this with is_sufficiently_private in tor-hsproxy,
446
            // which has a different purpose. Also see #1159.
447
            // The purpose of _this_ test is to find addresses that cannot
448
            // meaningfully be connected to over Tor, and that the exit
449
            // will not accept.
450
10
            Host::Ip(IpAddr::V4(ip)) => ip.is_loopback() || ip.is_private(),
451
10
            Host::Ip(IpAddr::V6(ip)) => ip.is_loopback(),
452
26
            Host::Onion(_) => false,
453
        }
454
68
    }
455
}
456

            
457
impl std::fmt::Display for Host {
458
18
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
459
18
        match self {
460
6
            Host::Hostname(s) => Display::fmt(s, f),
461
10
            Host::Ip(ip) => Display::fmt(ip, f),
462
2
            Host::Onion(onion) => Display::fmt(onion, f),
463
        }
464
18
    }
465
}
466

            
467
impl IntoTorAddr for TorAddr {
468
8
    fn into_tor_addr(self) -> Result<TorAddr, TorAddrError> {
469
8
        Ok(self)
470
8
    }
471
}
472

            
473
impl<A: IntoTorAddr + Clone> IntoTorAddr for &A {
474
2
    fn into_tor_addr(self) -> Result<TorAddr, TorAddrError> {
475
2
        self.clone().into_tor_addr()
476
2
    }
477
}
478

            
479
impl IntoTorAddr for &str {
480
80
    fn into_tor_addr(self) -> Result<TorAddr, TorAddrError> {
481
80
        if let Ok(sa) = SocketAddr::from_str(self) {
482
40
            TorAddr::new(Host::Ip(sa.ip()), sa.port())
483
        } else {
484
40
            let (host, port) = self.rsplit_once(':').ok_or(TorAddrError::NoPort)?;
485
38
            let host = host.parse()?;
486
36
            let port = port.parse().map_err(|_| TorAddrError::BadPort)?;
487
34
            TorAddr::new(host, port)
488
        }
489
80
    }
490
}
491

            
492
impl IntoTorAddr for String {
493
4
    fn into_tor_addr(self) -> Result<TorAddr, TorAddrError> {
494
4
        self[..].into_tor_addr()
495
4
    }
496
}
497

            
498
impl FromStr for TorAddr {
499
    type Err = TorAddrError;
500
16
    fn from_str(s: &str) -> Result<Self, TorAddrError> {
501
16
        s.into_tor_addr()
502
16
    }
503
}
504

            
505
impl IntoTorAddr for (&str, u16) {
506
18
    fn into_tor_addr(self) -> Result<TorAddr, TorAddrError> {
507
18
        let (host, port) = self;
508
18
        let host = host.parse()?;
509
18
        TorAddr::new(host, port)
510
18
    }
511
}
512

            
513
impl IntoTorAddr for (String, u16) {
514
2
    fn into_tor_addr(self) -> Result<TorAddr, TorAddrError> {
515
2
        let (host, port) = self;
516
2
        (&host[..], port).into_tor_addr()
517
2
    }
518
}
519

            
520
impl<T: DangerouslyIntoTorAddr + Clone> DangerouslyIntoTorAddr for &T {
521
2
    fn into_tor_addr_dangerously(self) -> Result<TorAddr, TorAddrError> {
522
2
        self.clone().into_tor_addr_dangerously()
523
2
    }
524
}
525

            
526
impl DangerouslyIntoTorAddr for (IpAddr, u16) {
527
6
    fn into_tor_addr_dangerously(self) -> Result<TorAddr, TorAddrError> {
528
6
        let (addr, port) = self;
529
6
        TorAddr::new(Host::Ip(addr), port)
530
6
    }
531
}
532

            
533
impl DangerouslyIntoTorAddr for (Ipv4Addr, u16) {
534
4
    fn into_tor_addr_dangerously(self) -> Result<TorAddr, TorAddrError> {
535
4
        let (addr, port) = self;
536
4
        TorAddr::new(Host::Ip(addr.into()), port)
537
4
    }
538
}
539

            
540
impl DangerouslyIntoTorAddr for (Ipv6Addr, u16) {
541
4
    fn into_tor_addr_dangerously(self) -> Result<TorAddr, TorAddrError> {
542
4
        let (addr, port) = self;
543
4
        TorAddr::new(Host::Ip(addr.into()), port)
544
4
    }
545
}
546

            
547
impl DangerouslyIntoTorAddr for SocketAddr {
548
2
    fn into_tor_addr_dangerously(self) -> Result<TorAddr, TorAddrError> {
549
2
        let (addr, port) = (self.ip(), self.port());
550
2
        (addr, port).into_tor_addr_dangerously()
551
2
    }
552
}
553

            
554
impl DangerouslyIntoTorAddr for SocketAddrV4 {
555
2
    fn into_tor_addr_dangerously(self) -> Result<TorAddr, TorAddrError> {
556
2
        let (addr, port) = (self.ip(), self.port());
557
2
        (*addr, port).into_tor_addr_dangerously()
558
2
    }
559
}
560

            
561
impl DangerouslyIntoTorAddr for SocketAddrV6 {
562
2
    fn into_tor_addr_dangerously(self) -> Result<TorAddr, TorAddrError> {
563
2
        let (addr, port) = (self.ip(), self.port());
564
2
        (*addr, port).into_tor_addr_dangerously()
565
2
    }
566
}
567

            
568
/// Check whether `hostname` is a valid hostname or not.
569
///
570
/// (Note that IPv6 addresses don't follow these rules.)
571
88
fn is_valid_hostname(hostname: &str) -> bool {
572
88
    hostname_validator::is_valid(hostname)
573
88
}
574

            
575
#[cfg(test)]
576
mod test {
577
    // @@ begin test lint list maintained by maint/add_warning @@
578
    #![allow(clippy::bool_assert_comparison)]
579
    #![allow(clippy::clone_on_copy)]
580
    #![allow(clippy::dbg_macro)]
581
    #![allow(clippy::mixed_attributes_style)]
582
    #![allow(clippy::print_stderr)]
583
    #![allow(clippy::print_stdout)]
584
    #![allow(clippy::single_char_pattern)]
585
    #![allow(clippy::unwrap_used)]
586
    #![allow(clippy::unchecked_time_subtraction)]
587
    #![allow(clippy::useless_vec)]
588
    #![allow(clippy::needless_pass_by_value)]
589
    //! <!-- @@ end test lint list maintained by maint/add_warning @@ -->
590
    use super::*;
591

            
592
    #[test]
593
    fn test_error_kind() {
594
        use tor_error::ErrorKind as EK;
595

            
596
        assert_eq!(
597
            TorAddrError::InvalidHostname.kind(),
598
            EK::InvalidStreamTarget
599
        );
600
        assert_eq!(TorAddrError::NoPort.kind(), EK::InvalidStreamTarget);
601
        assert_eq!(TorAddrError::BadPort.kind(), EK::InvalidStreamTarget);
602
    }
603

            
604
    /// Make a `StreamPrefs` with `.onion` enabled, if cfg-enabled
605
    fn mk_stream_prefs() -> StreamPrefs {
606
        let prefs = crate::StreamPrefs::default();
607

            
608
        #[cfg(feature = "onion-service-client")]
609
        let prefs = {
610
            let mut prefs = prefs;
611
            prefs.connect_to_onion_services(tor_config::BoolOrAuto::Explicit(true));
612
            prefs
613
        };
614

            
615
        prefs
616
    }
617

            
618
    #[test]
619
    fn validate_hostname() {
620
        // Valid hostname tests
621
        assert!(is_valid_hostname("torproject.org"));
622
        assert!(is_valid_hostname("Tor-Project.org"));
623
        assert!(is_valid_hostname("example.onion"));
624
        assert!(is_valid_hostname("some.example.onion"));
625

            
626
        // Invalid hostname tests
627
        assert!(!is_valid_hostname("-torproject.org"));
628
        assert!(!is_valid_hostname("_torproject.org"));
629
        assert!(!is_valid_hostname("tor_project1.org"));
630
        assert!(!is_valid_hostname("iwanna$money.org"));
631
    }
632

            
633
    #[test]
634
    fn validate_addr() {
635
        use crate::err::ErrorDetail;
636
        fn val<A: IntoTorAddr>(addr: A) -> Result<TorAddr, ErrorDetail> {
637
            let toraddr = addr.into_tor_addr()?;
638
            toraddr.enforce_config(&Default::default(), &mk_stream_prefs())?;
639
            Ok(toraddr)
640
        }
641

            
642
        assert!(val("[2001:db8::42]:20").is_ok());
643
        assert!(val(("2001:db8::42", 20)).is_ok());
644
        assert!(val(("198.151.100.42", 443)).is_ok());
645
        assert!(val("198.151.100.42:443").is_ok());
646
        assert!(val("www.torproject.org:443").is_ok());
647
        assert!(val(("www.torproject.org", 443)).is_ok());
648

            
649
        // When HS disabled, tested elsewhere, see: stream_instructions, prefs_onion_services
650
        #[cfg(feature = "onion-service-client")]
651
        {
652
            assert!(val("example.onion:80").is_ok());
653
            assert!(val(("example.onion", 80)).is_ok());
654

            
655
            match val("eweiibe6tdjsdprb4px6rqrzzcsi22m4koia44kc5pcjr7nec2rlxyad.onion:443") {
656
                Ok(TorAddr {
657
                    host: Host::Onion(_),
658
                    ..
659
                }) => {}
660
                x => panic!("{x:?}"),
661
            }
662
        }
663

            
664
        assert!(matches!(
665
            val("-foobar.net:443"),
666
            Err(ErrorDetail::InvalidHostname)
667
        ));
668
        assert!(matches!(
669
            val("www.torproject.org"),
670
            Err(ErrorDetail::Address(TorAddrError::NoPort))
671
        ));
672

            
673
        assert!(matches!(
674
            val("192.168.0.1:80"),
675
            Err(ErrorDetail::LocalAddress)
676
        ));
677
        assert!(matches!(
678
            val(TorAddr::new(Host::Hostname("foo@bar".to_owned()), 553).unwrap()),
679
            Err(ErrorDetail::InvalidHostname)
680
        ));
681
        assert!(matches!(
682
            val(TorAddr::new(Host::Hostname("foo.onion".to_owned()), 80).unwrap()),
683
            Err(ErrorDetail::OnionAddressNotSupported)
684
        ));
685
    }
686

            
687
    #[test]
688
    fn local_addrs() {
689
        fn is_local_hostname(s: &str) -> bool {
690
            let h: Host = s.parse().unwrap();
691
            h.is_local()
692
        }
693

            
694
        assert!(is_local_hostname("localhost"));
695
        assert!(is_local_hostname("loCALHOST"));
696
        assert!(is_local_hostname("127.0.0.1"));
697
        assert!(is_local_hostname("::1"));
698
        assert!(is_local_hostname("192.168.0.1"));
699

            
700
        assert!(!is_local_hostname("www.example.com"));
701
    }
702

            
703
    #[test]
704
    fn is_ip_address() {
705
        fn ip(s: &str) -> bool {
706
            TorAddr::from(s).unwrap().is_ip_address()
707
        }
708

            
709
        assert!(ip("192.168.0.1:80"));
710
        assert!(ip("[::1]:80"));
711
        assert!(ip("[2001:db8::42]:65535"));
712
        assert!(!ip("example.com:80"));
713
        assert!(!ip("example.onion:80"));
714
    }
715

            
716
    #[test]
717
    fn stream_instructions() {
718
        use StreamInstructions as SI;
719

            
720
        fn sap(s: &str) -> Result<StreamInstructions, ErrorDetail> {
721
            TorAddr::from(s)
722
                .unwrap()
723
                .into_stream_instructions(&Default::default(), &mk_stream_prefs())
724
        }
725

            
726
        assert_eq!(
727
            sap("[2001:db8::42]:9001").unwrap(),
728
            SI::Exit {
729
                hostname: "2001:db8::42".to_owned(),
730
                port: 9001
731
            },
732
        );
733
        assert_eq!(
734
            sap("example.com:80").unwrap(),
735
            SI::Exit {
736
                hostname: "example.com".to_owned(),
737
                port: 80
738
            },
739
        );
740

            
741
        {
742
            let b32 = "eweiibe6tdjsdprb4px6rqrzzcsi22m4koia44kc5pcjr7nec2rlxyad";
743
            let onion = format!("sss1234.www.{}.onion", b32);
744
            let got = sap(&format!("{}:443", onion));
745

            
746
            #[cfg(feature = "onion-service-client")]
747
            assert_eq!(
748
                got.unwrap(),
749
                SI::Hs {
750
                    hsid: format!("{}.onion", b32).parse().unwrap(),
751
                    hostname: onion,
752
                    port: 443,
753
                }
754
            );
755

            
756
            #[cfg(not(feature = "onion-service-client"))]
757
            assert!(matches!(got, Err(ErrorDetail::OnionAddressNotSupported)));
758
        }
759
    }
760

            
761
    #[test]
762
    fn resolve_instructions() {
763
        use ResolveInstructions as RI;
764

            
765
        fn sap(s: &str) -> Result<ResolveInstructions, ErrorDetail> {
766
            TorAddr::from(s)
767
                .unwrap()
768
                .into_resolve_instructions(&Default::default(), &Default::default())
769
        }
770

            
771
        assert_eq!(
772
            sap("[2001:db8::42]:9001").unwrap(),
773
            RI::Return(vec!["2001:db8::42".parse().unwrap()]),
774
        );
775
        assert_eq!(
776
            sap("example.com:80").unwrap(),
777
            RI::Exit("example.com".to_owned()),
778
        );
779
        assert!(matches!(
780
            sap("example.onion:80"),
781
            Err(ErrorDetail::OnionAddressResolveRequest),
782
        ));
783
    }
784

            
785
    #[test]
786
    fn bad_ports() {
787
        assert_eq!(
788
            TorAddr::from("www.example.com:squirrel"),
789
            Err(TorAddrError::BadPort)
790
        );
791
        assert_eq!(
792
            TorAddr::from("www.example.com:0"),
793
            Err(TorAddrError::BadPort)
794
        );
795
    }
796

            
797
    #[test]
798
    fn prefs_onion_services() {
799
        use crate::err::ErrorDetailDiscriminants;
800
        use ErrorDetailDiscriminants as EDD;
801
        use ErrorKind as EK;
802
        use tor_error::{ErrorKind, HasKind as _};
803

            
804
        #[allow(clippy::redundant_closure)] // for symmetry with prefs_of, below, and clarity
805
        let prefs_def = || StreamPrefs::default();
806

            
807
        let addr: TorAddr = "eweiibe6tdjsdprb4px6rqrzzcsi22m4koia44kc5pcjr7nec2rlxyad.onion:443"
808
            .parse()
809
            .unwrap();
810

            
811
        fn map(
812
            got: Result<impl Sized, ErrorDetail>,
813
        ) -> Result<(), (ErrorDetailDiscriminants, ErrorKind)> {
814
            got.map(|_| ())
815
                .map_err(|e| (ErrorDetailDiscriminants::from(&e), e.kind()))
816
        }
817

            
818
        let check_stream = |prefs, expected| {
819
            let got = addr
820
                .clone()
821
                .into_stream_instructions(&Default::default(), &prefs);
822
            assert_eq!(map(got), expected, "{prefs:?}");
823
        };
824
        let check_resolve = |prefs| {
825
            let got = addr
826
                .clone()
827
                .into_resolve_instructions(&Default::default(), &prefs);
828
            // This should be OnionAddressResolveRequest no matter if .onion is compiled in or enabled.
829
            // Since compiling it in, or enabling it, won't help.
830
            let expected = Err((EDD::OnionAddressResolveRequest, EK::NotImplemented));
831
            assert_eq!(map(got), expected, "{prefs:?}");
832
        };
833

            
834
        cfg_if::cfg_if! {
835
            if #[cfg(feature = "onion-service-client")] {
836
                use tor_config::BoolOrAuto as B;
837
                let prefs_of = |yn| {
838
                    let mut prefs = StreamPrefs::default();
839
                    prefs.connect_to_onion_services(yn);
840
                    prefs
841
                };
842
                check_stream(prefs_def(), Ok(()));
843
                check_stream(prefs_of(B::Auto), Ok(()));
844
                check_stream(prefs_of(B::Explicit(true)), Ok(()));
845
                check_stream(prefs_of(B::Explicit(false)), Err((EDD::OnionAddressDisabled, EK::ForbiddenStreamTarget)));
846

            
847
                check_resolve(prefs_def());
848
                check_resolve(prefs_of(B::Auto));
849
                check_resolve(prefs_of(B::Explicit(true)));
850
                check_resolve(prefs_of(B::Explicit(false)));
851
            } else {
852
                check_stream(prefs_def(), Err((EDD::OnionAddressNotSupported, EK::FeatureDisabled)));
853

            
854
                check_resolve(prefs_def());
855
            }
856
        }
857
    }
858

            
859
    #[test]
860
    fn convert_safe() {
861
        fn check<A: IntoTorAddr>(a: A, s: &str) {
862
            let a1 = TorAddr::from(a).unwrap();
863
            let a2 = s.parse().unwrap();
864
            assert_eq!(a1, a2);
865
            assert_eq!(&a1.to_string(), s);
866
        }
867

            
868
        check(("www.example.com", 8000), "www.example.com:8000");
869
        check(
870
            TorAddr::from(("www.example.com", 8000)).unwrap(),
871
            "www.example.com:8000",
872
        );
873
        check(
874
            TorAddr::from(("www.example.com", 8000)).unwrap(),
875
            "www.example.com:8000",
876
        );
877
        let addr = "[2001:db8::0042]:9001".to_owned();
878
        check(&addr, "[2001:db8::42]:9001");
879
        check(addr, "[2001:db8::42]:9001");
880
        check(("2001:db8::0042".to_owned(), 9001), "[2001:db8::42]:9001");
881
        check(("example.onion", 80), "example.onion:80");
882
    }
883

            
884
    #[test]
885
    fn convert_dangerous() {
886
        fn check<A: DangerouslyIntoTorAddr>(a: A, s: &str) {
887
            let a1 = TorAddr::dangerously_from(a).unwrap();
888
            let a2 = TorAddr::from(s).unwrap();
889
            assert_eq!(a1, a2);
890
            assert_eq!(&a1.to_string(), s);
891
        }
892

            
893
        let ip: IpAddr = "203.0.133.6".parse().unwrap();
894
        let ip4: Ipv4Addr = "203.0.133.7".parse().unwrap();
895
        let ip6: Ipv6Addr = "2001:db8::42".parse().unwrap();
896
        let sa: SocketAddr = "203.0.133.8:80".parse().unwrap();
897
        let sa4: SocketAddrV4 = "203.0.133.8:81".parse().unwrap();
898
        let sa6: SocketAddrV6 = "[2001:db8::43]:82".parse().unwrap();
899

            
900
        // This tests impl DangerouslyIntoTorAddr for &T
901
        #[allow(clippy::needless_borrow)]
902
        #[allow(clippy::needless_borrows_for_generic_args)]
903
        check(&(ip, 443), "203.0.133.6:443");
904
        check((ip, 443), "203.0.133.6:443");
905
        check((ip4, 444), "203.0.133.7:444");
906
        check((ip6, 445), "[2001:db8::42]:445");
907
        check(sa, "203.0.133.8:80");
908
        check(sa4, "203.0.133.8:81");
909
        check(sa6, "[2001:db8::43]:82");
910
    }
911
}