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

// Copyright 2020, The Tari Project
//
// Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
// following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
// disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
// following disclaimer in the documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote
// products derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
// USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

use std::fmt;
use tari_comms::{multiaddr::Multiaddr, socks, tor, transports::SocksConfig};

#[derive(Debug, Clone)]
pub enum TransportType {
    /// Use a memory transport. This transport recognises /memory addresses primarily used for local testing.
    Memory { listener_address: Multiaddr },
    /// Use a TcpTransport. This transport can connect to TCP/IP and DNS addresses.
    Tcp {
        listener_address: Multiaddr,
        /// The optional SOCKS proxy to use when connecting to Tor onion addresses
        tor_socks_config: Option<SocksConfig>,
    },
    /// This does not directly map to a transport, but will configure comms to run over a tor hidden service using the
    /// Tor proxy. This transport can connect to TCP/IP, onion v2, onion v3 and DNS addresses.
    Tor(TorConfig),
    /// Use a SOCKS5 proxy transport. This transport can connect to anything that the SOCKS proxy supports.
    Socks {
        socks_config: SocksConfig,
        listener_address: Multiaddr,
    },
}

#[derive(Debug, Clone)]
pub struct TorConfig {
    /// The Tor control server address
    pub control_server_addr: Multiaddr,
    /// Authentication for the Tor control server
    pub control_server_auth: tor::Authentication,
    /// The private key and service ID for the Tor hidden service. If not supplied, a new address and private key will
    /// be generated
    pub identity: Option<Box<tor::TorIdentity>>,
    /// The onion -> local address mapping to use.
    pub port_mapping: tor::PortMapping,
    /// If Some, this address is used as the SOCKS5 server. If None, the address is obtained from the tor control port.
    pub socks_address_override: Option<Multiaddr>,
    /// Authentication for the Tor SOCKS5 proxy
    pub socks_auth: socks::Authentication,
}

impl fmt::Display for TorConfig {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "control_server_addr = {}, control_server_auth = {}, {}, socks_address_override = {:?}",
            self.control_server_addr, self.control_server_auth, self.port_mapping, self.socks_address_override
        )
    }
}