auths-id 0.1.2

Multi-device identity and attestation crate 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
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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147

use auths_core::error::AuthsErrorInfo;
use thiserror::Error;

#[derive(Debug, Error)]
#[non_exhaustive]
pub enum FreezeError {
    #[error(transparent)]
    Io(#[from] std::io::Error),
    #[error("failed to parse freeze state: {0}")]
    Deserialization(#[from] serde_json::Error),
    #[error("invalid duration format: {0}")]
    InvalidDuration(String),
    #[error("duration must be greater than zero")]
    ZeroDuration,
}

#[derive(Debug, Error)]
#[non_exhaustive]
pub enum StorageError {
    #[cfg(feature = "git-storage")]
    #[error(transparent)]
    Git(#[from] git2::Error),
    #[error("serialization error: {0}")]
    Serialization(#[from] serde_json::Error),
    #[error("I/O error: {0}")]
    Io(#[from] std::io::Error),
    #[error("not found: {0}")]
    NotFound(String),
    #[error("{0}")]
    InvalidData(String),
    #[error("schema validation failed: {0}")]
    SchemaValidation(String),
    #[error("index error: {0}")]
    Index(String),
}

#[derive(Debug, Error)]
#[non_exhaustive]
pub enum InitError {
    #[cfg(feature = "git-storage")]
    #[error(transparent)]
    Git(#[from] git2::Error),
    #[error("KERI operation failed: {0}")]
    Keri(String),
    #[error("key operation failed: {0}")]
    Key(#[from] auths_core::error::AgentError),
    #[error("{0}")]
    InvalidData(String),
    #[error("storage operation failed: {0}")]
    Storage(#[from] StorageError),
    #[error("registry error: {0}")]
    Registry(String),
    #[error("crypto operation failed: {0}")]
    Crypto(String),
    #[error("identity error: {0}")]
    Identity(#[from] crate::identity::helpers::IdentityError),
}

impl AuthsErrorInfo for FreezeError {
    fn error_code(&self) -> &'static str {
        match self {
            Self::Io(_) => "AUTHS-E4001",
            Self::Deserialization(_) => "AUTHS-E4002",
            Self::InvalidDuration(_) => "AUTHS-E4003",
            Self::ZeroDuration => "AUTHS-E4004",
        }
    }

    fn suggestion(&self) -> Option<&'static str> {
        match self {
            Self::Io(_) => Some("Check file permissions and disk space"),
            Self::Deserialization(_) => {
                Some("The freeze state file may be corrupted; try deleting it")
            }
            Self::InvalidDuration(_) => {
                Some("Use a valid duration format (e.g. '30m', '2h', '7d')")
            }
            Self::ZeroDuration => Some("Specify a positive duration"),
        }
    }
}

impl AuthsErrorInfo for StorageError {
    fn error_code(&self) -> &'static str {
        match self {
            #[cfg(feature = "git-storage")]
            Self::Git(_) => "AUTHS-E4101",
            Self::Serialization(_) => "AUTHS-E4102",
            Self::Io(_) => "AUTHS-E4103",
            Self::NotFound(_) => "AUTHS-E4104",
            Self::InvalidData(_) => "AUTHS-E4105",
            Self::SchemaValidation(_) => "AUTHS-E4106",
            Self::Index(_) => "AUTHS-E4107",
        }
    }

    fn suggestion(&self) -> Option<&'static str> {
        match self {
            #[cfg(feature = "git-storage")]
            Self::Git(_) => Some("Check that the Git repository is not corrupted"),
            Self::Serialization(_) => {
                Some("Failed to serialize storage data; this may indicate a version mismatch")
            }
            Self::Io(_) => Some("Check file permissions and disk space"),
            Self::NotFound(_) => Some("Verify the identity or resource exists"),
            Self::InvalidData(_) => Some("The stored data may be corrupted; try re-initializing"),
            Self::SchemaValidation(_) => Some("Ensure data matches the expected schema version"),
            Self::Index(_) => Some("Try rebuilding the index"),
        }
    }
}

impl AuthsErrorInfo for InitError {
    fn error_code(&self) -> &'static str {
        match self {
            #[cfg(feature = "git-storage")]
            Self::Git(_) => "AUTHS-E4201",
            Self::Keri(_) => "AUTHS-E4202",
            Self::Key(_) => "AUTHS-E4203",
            Self::InvalidData(_) => "AUTHS-E4204",
            Self::Storage(_) => "AUTHS-E4205",
            Self::Registry(_) => "AUTHS-E4206",
            Self::Crypto(_) => "AUTHS-E4207",
            Self::Identity(_) => "AUTHS-E4208",
        }
    }

    fn suggestion(&self) -> Option<&'static str> {
        match self {
            #[cfg(feature = "git-storage")]
            Self::Git(_) => Some("Check that the Git repository is accessible"),
            Self::Keri(_) => Some("KERI event processing failed; check identity state"),
            Self::Key(_) => Some("Check keychain access and passphrase"),
            Self::InvalidData(_) => {
                Some("Identity data is malformed; try re-initializing with `auths init`")
            }
            Self::Storage(_) => Some("Check storage backend connectivity"),
            Self::Registry(_) => Some("Check registry backend configuration"),
            Self::Crypto(_) => Some(
                "A cryptographic operation during initialization failed; check your keychain access",
            ),
            Self::Identity(_) => {
                Some("Identity initialization failed; check storage and keychain configuration")
            }
        }
    }
}