cypheraddr 0.4.1

Network address types supporting proxying, mixnets, P2P with minimalistic dependencies (part of cyphernet suite)
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
117
118
119
120
121
122
123

// Set of libraries for privacy-preserving networking apps
//
// SPDX-License-Identifier: Apache-2.0
//
// Designed and written in 2019-2026 by Dr. Maxim Orlovsky <orlovsky@cyphernet.io>
//
// Copyright 2022-2026 Cyphernet Labs, Institute for Distributed and Cognitive Computing.
// All rights reserved.
//
// Copyright (C) 2021-2025 Dr Maxim Orlovsky.
// All rights under the above copyrights are reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
// in compliance with the License. You may obtain a copy of the License at
//
//        http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software distributed under the License
// is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
// or implied. See the License for the specific language governing permissions and limitations under
// the License.

use std::net::{IpAddr, ToSocketAddrs};

#[cfg(feature = "dns")]
use crate::InetHost;
use crate::{Addr, Host, HostName, NetAddr};

/// A hack to apply feature gates to the generic defaults
#[cfg(feature = "dns")]
type DefaultAddr = NetAddr<InetHost>;
#[cfg(not(feature = "dns"))]
type DefaultAddr = NetAddr<IpAddr>;

/// An host which should be accessed via a proxy - or accessed directly.
#[derive(Clone, PartialEq, Eq, Hash, Debug, From)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[non_exhaustive]
pub enum ProxiedHost<P: ToSocketAddrs + Addr = DefaultAddr> {
    #[cfg(feature = "dns")]
    #[from]
    #[from(IpAddr)]
    #[from(std::net::Ipv4Addr)]
    #[from(std::net::Ipv6Addr)]
    Native(InetHost),

    #[cfg(not(feature = "dns"))]
    #[from(IpAddr)]
    #[from(std::net::Ipv4Addr)]
    #[from(std::net::Ipv6Addr)]
    Native(IpAddr),

    Ip(IpAddr, P),

    #[cfg(feature = "dns")]
    Dns(String, P),

    #[cfg(feature = "tor")]
    Tor(super::tor::OnionAddrV3, P),

    #[cfg(feature = "i2p")]
    I2p(super::i2p::I2pAddr, P),

    #[cfg(feature = "nym")]
    Nym(super::nym::NymAddr, P),
}

impl<P: ToSocketAddrs + Addr> Host for ProxiedHost<P> {
    fn requires_proxy(&self) -> bool { !matches!(self, ProxiedHost::Native(_)) }
}

impl<P: ToSocketAddrs + Addr> ProxiedHost<P> {
    pub fn with_proxy(host: HostName, proxy: P) -> Self {
        match host {
            HostName::Ip(ip) => ProxiedHost::Ip(ip, proxy),
            #[cfg(feature = "dns")]
            HostName::Dns(dns) => ProxiedHost::Dns(dns, proxy),
            #[cfg(feature = "tor")]
            HostName::Tor(tor) => ProxiedHost::Tor(tor, proxy),
            #[cfg(feature = "i2p")]
            HostName::I2p(i2p) => ProxiedHost::I2p(i2p, proxy),
            #[cfg(feature = "nym")]
            HostName::Nym(nym) => ProxiedHost::Nym(nym, proxy),
        }
    }

    pub fn proxy(&self) -> Option<&P> {
        match self {
            ProxiedHost::Native(_) => None,
            ProxiedHost::Ip(_, proxy) => Some(proxy),
            #[cfg(feature = "dns")]
            ProxiedHost::Dns(_, proxy) => Some(proxy),
            #[cfg(feature = "tor")]
            ProxiedHost::Tor(_, proxy) => Some(proxy),
            #[cfg(feature = "i2p")]
            ProxiedHost::I2p(_, proxy) => Some(proxy),
            #[cfg(feature = "nym")]
            ProxiedHost::Nym(_, proxy) => Some(proxy),
        }
    }
}

/// An address which must be accessed through proxy. Usually this is SOCLS5
/// proxy, but at the type level there is no information about the specific
/// proxy type which should be used (however they may contained within the
/// generic type parameter `A`).
#[derive(Clone, Ord, PartialOrd, Eq, PartialEq, Hash, Debug)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct ProxiedAddr<A: Addr = NetAddr<HostName>> {
    #[cfg(feature = "dns")]
    pub proxy_addr: NetAddr<InetHost>,
    #[cfg(not(feature = "dns"))]
    pub proxy_addr: std::net::SocketAddr,
    pub remote_addr: A,
}

impl<A: Addr> Host for ProxiedAddr<A> {
    fn requires_proxy(&self) -> bool { self.remote_addr.requires_proxy() }
}

impl<A: Addr> Addr for ProxiedAddr<A> {
    fn port(&self) -> u16 { self.remote_addr.port() }
}