tari_comms 5.4.0-pre.0

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

// 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.

mod builder;
pub use builder::{HiddenServiceBuilder, HiddenServiceBuilderError, HsFlags};

mod controller;
pub use controller::{HiddenServiceController, HiddenServiceControllerError};

mod proxy_opts;
use std::fmt;

use derivative::Derivative;
pub use proxy_opts::TorProxyOpts;
use serde_derive::{Deserialize, Serialize};
use tari_shutdown::OptionalShutdownSignal;

use crate::{
    multiaddr::Multiaddr,
    tor::{PrivateKey, TorClientError},
};

/// Handle for a Tor Hidden Service. This handle keeps the session to the Tor control port alive.
/// Once this is dropped, the hidden service will cease to be accessible.
#[derive(Clone)]
pub struct HiddenService {
    /// The identity of the hidden service
    pub(super) identity: TorIdentity,
    /// The address where incoming traffic to the `onion_addr` will be forwarded to.
    pub(super) proxied_addr: Multiaddr,
    /// Shutdown signal for hidden service
    pub(super) shutdown_signal: OptionalShutdownSignal,
}

impl HiddenService {
    pub fn get_onion_address(&self) -> Multiaddr {
        // service_id should always come from the tor control server, so the length can be relied on
        multiaddr_from_service_id_and_port(self.service_id(), self.identity.onion_port)
            .expect("failed to create onion address from HiddenService service_id and onion_port")
    }

    pub fn service_id(&self) -> &str {
        &self.identity.service_id
    }

    pub fn proxied_address(&self) -> &Multiaddr {
        &self.proxied_addr
    }

    pub fn tor_identity(&self) -> &TorIdentity {
        &self.identity
    }
}

fn multiaddr_from_service_id_and_port(service_id: &str, onion_port: u16) -> Result<Multiaddr, TorClientError> {
    const ONION_V2_LEN: usize = 16;
    const ONION_V3_LEN: usize = 56;
    match service_id.len() {
        ONION_V2_LEN => format!("/onion/{service_id}:{onion_port}")
            .parse()
            .map_err(|_| TorClientError::InvalidServiceId),
        ONION_V3_LEN => {
            // This will fail until this PR is released (https://github.com/libp2p/rust-libp2p/pull/1354)
            format!("/onion3/{service_id}:{onion_port}")
                .parse()
                .map_err(|_| TorClientError::InvalidServiceId)
        },
        _ => Err(TorClientError::InvalidServiceId),
    }
}

#[derive(Clone, Derivative, Serialize, Deserialize)]
#[derivative(Debug)]
pub struct TorIdentity {
    #[derivative(Debug = "ignore")]
    pub private_key: PrivateKey,
    pub service_id: String,
    pub onion_port: u16,
}

impl TorIdentity {
    pub fn try_get_onion_address(&self) -> Result<Multiaddr, TorClientError> {
        multiaddr_from_service_id_and_port(&self.service_id, self.onion_port)
    }
}

impl fmt::Display for TorIdentity {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        writeln!(f, "Service ID: {}", self.service_id)?;
        writeln!(f, "Port: {}", self.onion_port)?;

        Ok(())
    }
}