auths-core 0.1.3

Core cryptography and keychain integration for Auths
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

use auths_crypto::AuthsErrorInfo;
use thiserror::Error;

/// Errors that can occur during the pairing protocol.
///
/// Wraps protocol-level errors from `auths-pairing-protocol` and adds
/// transport-specific variants used by the CLI.
#[derive(Debug, Error)]
#[non_exhaustive]
pub enum PairingError {
    /// A protocol-level error (expired token, bad signature, etc.).
    #[error(transparent)]
    Protocol(#[from] auths_pairing_protocol::ProtocolError),

    /// QR code generation failed.
    #[error("QR code generation failed: {0}")]
    QrCodeFailed(String),

    /// Network error during relay communication.
    #[error("Relay error: {0}")]
    RelayError(String),

    /// Local LAN server error.
    #[error("Local server error: {0}")]
    LocalServerError(String),

    /// mDNS advertisement or discovery error.
    #[error("mDNS error: {0}")]
    MdnsError(String),

    /// No peer found on the local network.
    #[error("No peer found on local network")]
    NoPeerFound,

    /// LAN pairing timed out waiting for a response.
    #[error("LAN pairing timed out")]
    LanTimeout,
}

impl AuthsErrorInfo for PairingError {
    fn error_code(&self) -> &'static str {
        match self {
            Self::Protocol(_) => "AUTHS-E3201",
            Self::QrCodeFailed(_) => "AUTHS-E3202",
            Self::RelayError(_) => "AUTHS-E3203",
            Self::LocalServerError(_) => "AUTHS-E3204",
            Self::MdnsError(_) => "AUTHS-E3205",
            Self::NoPeerFound => "AUTHS-E3206",
            Self::LanTimeout => "AUTHS-E3207",
        }
    }

    fn suggestion(&self) -> Option<&'static str> {
        match self {
            Self::NoPeerFound => Some("Ensure both devices are on the same network"),
            Self::LanTimeout => Some("Check your network and try again"),
            Self::RelayError(_) => Some("Check your internet connection"),
            Self::Protocol(_) => Some("Ensure both devices are running compatible auths versions"),
            Self::QrCodeFailed(_) => {
                Some("QR code generation failed; try `auths device pair --mode relay` instead")
            }
            Self::LocalServerError(_) => {
                Some("The local pairing server failed to start; check that the port is available")
            }
            Self::MdnsError(_) => {
                Some("mDNS discovery failed; try `auths device pair --mode relay` instead")
            }
        }
    }
}

impl From<serde_json::Error> for PairingError {
    fn from(e: serde_json::Error) -> Self {
        PairingError::Protocol(auths_pairing_protocol::ProtocolError::Serialization(
            e.to_string(),
        ))
    }
}