dnscrypt 0.1.1

A pure-Rust DNSCrypt v2 client library — sync and async support.
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129

//! Unified error type for `dnscrypto`.

use std::fmt;

/// Errors that can occur during a `DNSCrypt` session.
#[derive(Debug)]
pub enum Error {
    /// A network-level error occurred (UDP/TCP send, receive, or connect).
    Network(String),
    /// The `DNSCrypt` resolver certificate was missing, invalid, or expired.
    CertificateError(String),
    /// Poly1305 authentication of an encrypted DNS packet failed.
    ///
    /// This indicates tampered or corrupted data and should be treated as a
    /// security event.
    AuthenticationFailure,
    /// The decrypted DNS response contained no A record for the queried name.
    NoRecord,
    /// A protocol-level invariant was violated (e.g. wrong magic bytes,
    /// nonce mismatch, or malformed packet structure).
    Protocol(String),
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Network(msg) => write!(f, "DNSCrypt network error: {msg}"),
            Self::CertificateError(msg) => write!(f, "DNSCrypt certificate error: {msg}"),
            Self::AuthenticationFailure => {
                write!(f, "DNSCrypt authentication failure (Poly1305 tag mismatch)")
            }
            Self::NoRecord => write!(f, "DNSCrypt: no A record found in response"),
            Self::Protocol(msg) => write!(f, "DNSCrypt protocol error: {msg}"),
        }
    }
}

impl std::error::Error for Error {}

/// Convert a bare `String` error (from internal helpers) into the most
/// appropriate [`Error`] variant.  Internal helpers still use `String` for
/// ergonomics; this conversion happens at the public API boundary.
impl From<String> for Error {
    fn from(s: String) -> Self {
        // Classify by message prefix emitted by sub-modules.
        if s.contains("authentication") || s.contains("Poly1305") {
            Self::AuthenticationFailure
        } else if s.contains("TCP") || s.contains("UDP") || s.contains("socket") {
            Self::Network(s)
        } else if s.contains("cert") || s.contains("Cert") || s.contains("serial") {
            Self::CertificateError(s)
        } else {
            Self::Protocol(s)
        }
    }
}

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

    #[test]
    fn test_display_messages() {
        assert_eq!(
            Error::Network("timed out".to_string()).to_string(),
            "DNSCrypt network error: timed out"
        );
        assert_eq!(
            Error::CertificateError("expired".to_string()).to_string(),
            "DNSCrypt certificate error: expired"
        );
        assert_eq!(
            Error::AuthenticationFailure.to_string(),
            "DNSCrypt authentication failure (Poly1305 tag mismatch)"
        );
        assert_eq!(
            Error::NoRecord.to_string(),
            "DNSCrypt: no A record found in response"
        );
        assert_eq!(
            Error::Protocol("bad magic".to_string()).to_string(),
            "DNSCrypt protocol error: bad magic"
        );
    }

    #[test]
    fn test_from_string_classification() {
        // Each disjunct below is exercised both as the deciding (first
        // matching) clause and, where it isn't the first alternative, with
        // the earlier alternative(s) absent so short-circuit evaluation
        // still reaches it.
        assert!(matches!(
            Error::from("authentication failed".to_string()),
            Error::AuthenticationFailure
        ));
        assert!(matches!(
            Error::from("Poly1305 tag mismatch".to_string()),
            Error::AuthenticationFailure
        ));
        assert!(matches!(
            Error::from("TCP connect failed: oops".to_string()),
            Error::Network(_)
        ));
        assert!(matches!(
            Error::from("UDP send failed: oops".to_string()),
            Error::Network(_)
        ));
        assert!(matches!(
            Error::from("failed to bind socket".to_string()),
            Error::Network(_)
        ));
        assert!(matches!(
            Error::from("cert serial 1 < cached 2".to_string()),
            Error::CertificateError(_)
        ));
        assert!(matches!(
            Error::from("Certificate expired".to_string()),
            Error::CertificateError(_)
        ));
        assert!(matches!(
            Error::from("duplicate serial number".to_string()),
            Error::CertificateError(_)
        ));
        assert!(matches!(
            Error::from("something else entirely".to_string()),
            Error::Protocol(_)
        ));
    }
}