tor-rpc-connect 0.41.0

Common implementation logic for Arti RPC Connect points
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

//! Representations for types of required RPC connections.

use std::sync::Arc;

pub mod cookie;

/// A type of authentication required on an RPC connection.
#[derive(Clone, Debug)]
#[non_exhaustive]
pub enum RpcAuth {
    /// No authentication is expected on the connection:
    /// just being able to make the connection proves that the client is authorized.
    Inherent,
    /// RPC cookie authentication is expected on the connection.
    Cookie {
        /// A secret cookie to use for authentication.
        secret: RpcCookieSource,
        /// The address that the server is listening on,
        /// encoded as a string.
        server_address: String,
    },
}

/// A way to get an RPC cookie: Either in-memory, or by loading it from disk.
///
/// (We defer loading cookies when running as a client,
/// since clients should not actually load cookies from disk
/// until they have received the server's banner message.)
#[derive(Clone, Debug)]
#[non_exhaustive]
pub enum RpcCookieSource {
    /// A cookie that is already loaded.
    Loaded(Arc<cookie::Cookie>),
    /// A cookie that's stored on disk and needs to be loaded.
    Unloaded(cookie::CookieLocation),
}

impl RpcCookieSource {
    /// Try to load this cookie from disk, if it is not already loaded.
    pub fn load(&self) -> Result<Arc<cookie::Cookie>, cookie::CookieAccessError> {
        match self {
            RpcCookieSource::Loaded(cookie) => Ok(Arc::clone(cookie)),
            RpcCookieSource::Unloaded(cookie_location) => Ok(Arc::new(cookie_location.load()?)),
        }
    }
}