tari_comms 5.3.1

A peer-to-peer messaging system
Documentation 
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

// Copyright 2019, 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::io;

use multiaddr::Multiaddr;
use tokio::net::TcpStream;

use super::Transport;
use crate::{
    transports::{SocksConfig, SocksTransport, TcpTransport, dns::TorDnsResolver, predicate::is_onion_address},
    types::TransportProtocol,
    utils::network::supports_ipv6,
};

/// Transport implementation for TCP with Tor support
#[derive(Clone, Default)]
pub struct TcpWithTorTransport {
    socks_transport: Option<SocksTransport>,
    tcp_transport: TcpTransport,
    supported_protocols: Vec<TransportProtocol>,
}

impl TcpWithTorTransport {
    /// Sets the SOCKS address to the Tor proxy to use for onion and DNS address resolution
    pub fn set_tor_socks_proxy(&mut self, socks_config: SocksConfig) -> &mut Self {
        self.socks_transport = Some(SocksTransport::new(socks_config.clone()));
        // Resolve DNS using the tor proxy
        self.tcp_transport.set_dns_resolver(TorDnsResolver::new(socks_config));
        if !self.supported_protocols.contains(&TransportProtocol::Onion) {
            self.supported_protocols.push(TransportProtocol::Onion);
        }
        self
    }

    /// Create a new TcpTransport with the Tor socks proxy enabled
    pub fn with_tor_socks_proxy(socks_config: SocksConfig) -> Self {
        let mut transport = Self::default();
        transport.set_tor_socks_proxy(socks_config);
        transport
    }

    /// Create a new TcpTransport
    pub fn new() -> Self {
        let mut supported_protocols = vec![TransportProtocol::Ipv4];
        if supports_ipv6() {
            supported_protocols.push(TransportProtocol::Ipv6);
        }
        Self {
            supported_protocols,
            ..Default::default()
        }
    }

    pub fn tcp_transport_mut(&mut self) -> &mut TcpTransport {
        &mut self.tcp_transport
    }
}

#[crate::async_trait]
impl Transport for TcpWithTorTransport {
    type Error = io::Error;
    type Listener = <TcpTransport as Transport>::Listener;
    type Output = TcpStream;

    async fn listen(&self, addr: &Multiaddr) -> Result<(Self::Listener, Multiaddr), Self::Error> {
        self.tcp_transport.listen(addr).await
    }

    async fn dial(&self, addr: &Multiaddr) -> Result<Self::Output, Self::Error> {
        if addr.is_empty() {
            return Err(io::Error::new(
                io::ErrorKind::InvalidInput,
                format!("Invalid address '{addr}'"),
            ));
        }

        if is_onion_address(addr) {
            match self.socks_transport {
                Some(ref transport) => {
                    let socket = transport.dial(addr).await?;
                    Ok(socket)
                },
                None => Err(io::Error::other(
                    "Tor SOCKS proxy is not set for TCP transport. Cannot dial peer with onion addresses.".to_owned(),
                )),
            }
        } else {
            let socket = self.tcp_transport.dial(addr).await?;
            Ok(socket)
        }
    }

    fn supported_protocols(&self) -> Vec<TransportProtocol> {
        self.supported_protocols.clone()
    }
}