siwx 0.3.0

Sign In with X
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

use std::fmt;

/// Errors produced by siwx operations.
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum SiwxError {
    /// The `domain` field is missing or malformed.
    #[error("invalid domain: {0}")]
    InvalidDomain(String),

    /// The `address` field does not conform to the expected format.
    #[error("invalid address: {0}")]
    InvalidAddress(String),

    /// The `uri` field is not a valid RFC 3986 URI.
    #[error("invalid uri: {0}")]
    InvalidUri(String),

    /// A timestamp field is not valid RFC 3339.
    #[error("invalid timestamp: {0}")]
    InvalidTimestamp(String),

    /// The `nonce` field is missing or malformed.
    #[error("invalid nonce: {0}")]
    InvalidNonce(String),

    /// The `statement` field contains a forbidden `\n` character.
    #[error("invalid statement: {0}")]
    InvalidStatement(String),

    /// The message has expired (`expiration_time` is in the past).
    #[error("message expired")]
    Expired,

    /// The message is not yet valid (`not_before` is in the future).
    #[error("message not yet valid")]
    NotYetValid,

    /// A required field is missing or the overall format is wrong.
    #[error("invalid message format: {0}")]
    InvalidFormat(String),

    /// Signature bytes are malformed or the wrong length.
    #[error("invalid signature: {0}")]
    InvalidSignature(String),

    /// The cryptographic verification did not succeed.
    #[error("verification failed: {0}")]
    VerificationFailed(String),
}

impl SiwxError {
    /// Convenience helper: creates [`SiwxError::InvalidFormat`] from any
    /// [`Display`](fmt::Display) value.
    pub(crate) fn invalid_format(msg: impl fmt::Display) -> Self {
        Self::InvalidFormat(msg.to_string())
    }
}