tari_comms 5.3.0-pre.10

// 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::{borrow::Cow, fmt, num::NonZeroU16};

use derivative::Derivative;

use crate::tor::control_client::{
    commands::TorCommand,
    error::TorClientError,
    parsers,
    parsers::ParseError,
    response::ResponseLine,
    types::{KeyBlob, KeyType, PortMapping, PrivateKey},
};

#[derive(Debug, Copy, Clone)]
pub enum AddOnionFlag {
    /// The server should not include the newly generated private key as part of the response.
    DiscardPK,
    /// Do not associate the newly created Onion Service to the current control connection.
    Detach,
    /// Client authorization is required using the "basic" method (v2 only).
    BasicAuth,
    /// Add a non-anonymous Single Onion Service. Tor checks this flag matches its configured hidden service anonymity
    /// mode.
    NonAnonymous,
    /// Close the circuit is the maximum streams allowed is reached.
    MaxStreamsCloseCircuit,
}

impl fmt::Display for AddOnionFlag {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        use AddOnionFlag::{BasicAuth, Detach, DiscardPK, MaxStreamsCloseCircuit, NonAnonymous};
        match self {
            DiscardPK => write!(f, "DiscardPK"),
            Detach => write!(f, "Detach"),
            BasicAuth => write!(f, "BasicAuth"),
            NonAnonymous => write!(f, "NonAnonymous"),
            MaxStreamsCloseCircuit => write!(f, "MaxStreamsCloseCircuit"),
        }
    }
}

/// The ADD_ONION command.
///
/// This command instructs Tor to create onion hidden services.
pub struct AddOnion<'a> {
    key_type: KeyType,
    key_blob: KeyBlob<'a>,
    flags: Vec<AddOnionFlag>,
    port_mapping: PortMapping,
    num_streams: Option<NonZeroU16>,
}

impl<'a> AddOnion<'a> {
    pub fn new(
        key_type: KeyType,
        key_blob: KeyBlob<'a>,
        flags: Vec<AddOnionFlag>,
        port_mapping: PortMapping,
        num_streams: Option<NonZeroU16>,
    ) -> Self {
        Self {
            key_type,
            key_blob,
            flags,
            port_mapping,
            num_streams,
        }
    }
}

impl TorCommand for AddOnion<'_> {
    type Error = TorClientError;
    type Output = AddOnionResponse;

    fn to_command_string(&self) -> Result<String, Self::Error> {
        let mut s = String::from("ADD_ONION ");

        s.push_str(self.key_type.as_tor_repr());
        s.push(':');
        s.push_str(self.key_blob.as_tor_repr());

        if !self.flags.is_empty() {
            let flags = self.flags.iter().map(|f| f.to_string()).collect::<Vec<_>>().join(",");
            s.push_str(&format!(" Flags={flags}"));
        }

        if let Some(num_streams) = self.num_streams {
            s.push_str(&format!(" NumStreams={num_streams}"));
        }

        s.push_str(&format!(
            " Port={},{}",
            self.port_mapping.onion_port(),
            self.port_mapping.proxied_address()
        ));

        Ok(s)
    }

    fn parse_responses(&self, mut responses: Vec<ResponseLine>) -> Result<Self::Output, Self::Error> {
        let last_response = responses.pop().ok_or(TorClientError::UnexpectedEof)?;
        if let Some(err) = last_response.err() {
            if err.contains("Onion address collision") {
                return Err(TorClientError::OnionAddressCollision);
            }
            return Err(TorClientError::TorCommandFailed(err.to_owned()));
        }

        let mut service_id = None;
        let mut private_key = None;

        for response in responses {
            let (key, values) = parsers::key_value(&response.value)?;
            let value = values.into_iter().next().ok_or(TorClientError::KeyValueNoValue)?;
            match &*key {
                "ServiceID" => {
                    service_id = Some(value.into_owned());
                },
                "PrivateKey" => {
                    let mut split = value.split(':');
                    let key = split
                        .next()
                        .ok_or_else(|| ParseError("PrivateKey field was empty".to_string()))?;

                    let value = split
                        .next()
                        .map(|v| Cow::from(v.to_owned()))
                        .ok_or_else(|| ParseError("Failed to parse private key".to_string()))?;

                    private_key = match key {
                        "ED25519-V3" => Some(PrivateKey::Ed25519V3(value.into_owned())),
                        "RSA1024" => Some(PrivateKey::Rsa1024(value.into_owned())),
                        k => {
                            return Err(
                                ParseError(format!("Server returned unrecognised private key type '{k}'")).into(),
                            );
                        },
                    };
                },
                _ => {
                    // Ignore key's we don't understand
                },
            }
        }

        let service_id = service_id.ok_or(TorClientError::AddOnionNoServiceId)?;

        Ok(AddOnionResponse {
            service_id,
            private_key,
            onion_port: self.port_mapping.onion_port(),
        })
    }
}

impl fmt::Display for AddOnion<'_> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "ADD_ONION (KeyType={} KeyBlob={} Flags={} PortMapping={})",
            self.key_type.as_tor_repr(),
            self.key_blob,
            self.flags.iter().fold(String::new(), |acc, f| format!("{acc}, {f}")),
            self.port_mapping
        )
    }
}

#[derive(Derivative, Clone)]
#[derivative(Debug)]
pub struct AddOnionResponse {
    pub(crate) service_id: String,
    #[derivative(Debug = "ignore")]
    pub(crate) private_key: Option<PrivateKey>,
    pub(crate) onion_port: u16,
}

#[cfg(test)]
mod test {
    use super::*;

    #[test]
    fn to_command_string() {
        let key = "this-is-a-key".to_string();
        let command = AddOnion::new(
            KeyType::New,
            KeyBlob::String(&key),
            vec![],
            PortMapping::from_port(9090),
            None,
        );
        assert_eq!(
            command.to_command_string().unwrap(),
            format!("ADD_ONION NEW:{key} Port=9090,127.0.0.1:9090")
        );
    }
}