apx_core 0.22.0

APx core primitives
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

use std::net::{Ipv4Addr, Ipv6Addr};

use idna::{domain_to_ascii_cow, AsciiDenyList, Errors as IdnaError};

/// Returns `true` if hostname is an IPv6 literal (enclosed in square brackets)
pub fn is_ipv6_hostname(hostname: &str) -> bool {
    hostname.strip_prefix('[')
        .and_then(|value| value.strip_suffix(']'))
        .is_some_and(|address| address.parse::<Ipv6Addr>().is_ok())
}

/// Returns the ASCII representation of a host name
pub fn encode_hostname(hostname: &str) -> Result<String, IdnaError> {
    if is_ipv6_hostname(hostname) {
        Ok(hostname.to_string())
    } else {
        domain_to_ascii_cow(hostname.as_bytes(), AsciiDenyList::URL)
            .map(|output| output.to_string())
    }
}

pub fn is_onion(hostname: &str) -> bool {
    hostname.ends_with(".onion")
}

pub fn is_i2p(hostname: &str) -> bool {
    hostname.ends_with(".i2p")
}

/// Attempts to guess the URI scheme (http or https) for the given hostname
pub fn guess_protocol(hostname: &str) -> &'static str {
    if hostname == "localhost" {
        return "http";
    };
    if hostname.parse::<Ipv4Addr>().is_ok() {
        return "http";
    };
    if is_ipv6_hostname(hostname) {
        return "http";
    };
    if hostname.ends_with(".onion") ||
        hostname.ends_with(".i2p") ||
        hostname.ends_with(".loki")
    {
        // Tor / I2P
        "http"
    } else {
        // Use HTTPS by default
        "https"
    }
}

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

    #[test]
    fn test_is_ipv6_hostname() {
        assert!(is_ipv6_hostname("[319:3cf0:dd1d:47b9:20c:29ff:fe2c:39be]"));
        assert!(!is_ipv6_hostname("319:3cf0:dd1d:47b9:20c:29ff:fe2c:39be"));
        assert!(!is_ipv6_hostname(""));
    }

    #[test]
    fn test_encode_hostname() {
        let hostname = "räksmörgås.josefsson.org";
        let encoded = encode_hostname(hostname).unwrap();
        assert_eq!(encoded, "xn--rksmrgs-5wao1o.josefsson.org");

        let reencoded = encode_hostname(&encoded).unwrap();
        assert_eq!(reencoded, encoded);
    }

    #[test]
    fn test_encode_hostname_ipv4() {
        let hostname = "127.0.0.1";
        let encoded = encode_hostname(hostname).unwrap();
        assert_eq!(encoded, hostname);
    }

    #[test]
    fn test_encode_hostname_ipv6() {
        let hostname = "[319:3cf0:dd1d:47b9:20c:29ff:fe2c:39be]";
        let encoded = encode_hostname(hostname).unwrap();
        assert_eq!(encoded, hostname);
    }

    #[test]
    fn test_guess_protocol() {
        assert_eq!(
            guess_protocol("example.org"),
            "https",
        );
        assert_eq!(
            guess_protocol("2gzyxa5ihm7nsggfxnu52rck2vv4rvmdlkiu3zzui5du4xyclen53wid.onion"),
            "http",
        );
        assert_eq!(
            guess_protocol("zzz.i2p"),
            "http",
        );
        // Yggdrasil
        assert_eq!(
            guess_protocol("[319:3cf0:dd1d:47b9:20c:29ff:fe2c:39be]"),
            "http",
        );
        // localhost
        assert_eq!(
            guess_protocol("127.0.0.1"),
            "http",
        );
    }
}