acme-types 0.1.1

Types for implementing ACME (RFC 8555) providers and clients
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
148
149
150
151
152
153
154
155
156
157
158
159

#[cfg(feature = "json")]
use serde::{Deserialize, Serialize};

pub use super::Identifier as NewAuthorization;

#[cfg(feature = "json")]
impl NewAuthorization {
    /// Deserializes a NewAuthorization object from a JSON str
    pub fn from_str(s: &str) -> Result<NewAuthorization, serde_json::error::Error> {
        serde_json::from_str(s)
    }

    /// Serializes a NewAuthorization object to a JSON String
    pub fn to_string(&self) -> Result<String, serde_json::error::Error> {
        serde_json::to_string(self)
    }
}

/// Defines an ACME authorization resource
///
/// For more information, refer to [RFC 8555 § 7.1.4](https://datatracker.ietf.org/doc/html/rfc8555#section-7.1.4)
#[derive(Clone, Debug)]
#[cfg_attr(feature = "json", derive(Serialize, Deserialize))]
pub struct Authorization {
    /// Authorization identifier
    pub identifier: super::Identifier,
    /// Authorization status
    pub status: AuthorizationStatus,
    /// Authorization expiration time
    pub expires: Option<String>,
    /// Authorization challenge objects
    pub challenges: Vec<Challenge>,
    /// Present and true for authorizations for a domain name containing a wildcard
    pub wildcard: Option<bool>,
}

#[cfg(feature = "json")]
impl Authorization {
    /// Deserializes an Authorization object from a JSON str
    pub fn from_str(s: &str) -> Result<Authorization, serde_json::error::Error> {
        serde_json::from_str(s)
    }

    /// Serializes an Authorization object to a JSON String
    pub fn to_string(&self) -> Result<String, serde_json::error::Error> {
        serde_json::to_string(self)
    }
}

/// Defines an update to an Authorization resource.
///
/// This can be used when the ACME client wishes to relinquish authorization to issue certificates for an identifier.
///
/// For more information, refer to [RFC 8555 § 7.5.2](https://datatracker.ietf.org/doc/html/rfc8555#section-7.5.2)
#[derive(Clone, Debug)]
#[cfg_attr(feature = "json", derive(Serialize, Deserialize))]
pub struct AuthorizationUpdate {
    /// Authorization status
    pub status: AuthorizationStatus,
}

#[cfg(feature = "json")]
impl AuthorizationUpdate {
    /// Deserializes an AuthorizationUpdate object from a JSON str
    pub fn from_str(s: &str) -> Result<AuthorizationUpdate, serde_json::error::Error> {
        serde_json::from_str(s)
    }

    /// Serializes an AuthorizationUpdate object to a JSON String
    pub fn to_string(&self) -> Result<String, serde_json::error::Error> {
        serde_json::to_string(self)
    }
}

/// Defines an ACME authorization challenge object
///
/// For more information, refer to [RFC 8555 § 7.1.5](https://datatracker.ietf.org/doc/html/rfc8555#section-7.1.5)
#[derive(Clone, Debug)]
#[cfg_attr(feature = "json", derive(Serialize, Deserialize))]
pub struct Challenge {
    /// URL to respond to challenge
    pub url: String,
    /// Challenge type
    #[cfg_attr(feature = "json", serde(rename = "type"))]
    pub type_: ChallengeType,
    /// Current status of the challenge
    pub status: ChallengeStatus,
    /// Optional challenge token - this may or may not be present depending on the challenge type
    ///
    /// For more information, refer to [RFC 8555 § 8.1](https://datatracker.ietf.org/doc/html/rfc8555#section-8.1)
    pub token: Option<String>,
    /// Time at which the challenge was validated
    pub validated: Option<String>,
    /// Error(s) encountered during challenge validation
    pub error: Option<super::Error>,
}

#[cfg(feature = "json")]
impl Challenge {
    /// Deserializes a Challenge object from a JSON str
    pub fn from_str(s: &str) -> Result<Challenge, serde_json::error::Error> {
        serde_json::from_str(s)
    }

    /// Serializes a Challenge object to a JSON String
    pub fn to_string(&self) -> Result<String, serde_json::error::Error> {
        serde_json::to_string(self)
    }
}

/// Challenge resource status values
///
/// For more information, refer to [RFC 8555 § 7.1.6](https://datatracker.ietf.org/doc/html/rfc8555#section-7.1.6)
#[derive(Clone, Debug)]
#[cfg_attr(feature = "json", derive(Serialize, Deserialize))]
pub enum ChallengeStatus {
    #[cfg_attr(feature = "json", serde(rename = "pending"))]
    Pending,
    #[cfg_attr(feature = "json", serde(rename = "processing"))]
    Processing,
    #[cfg_attr(feature = "json", serde(rename = "valid"))]
    Valid,
    #[cfg_attr(feature = "json", serde(rename = "invalid"))]
    Invalid,
}

/// Challenge resource type values
///
/// For more information, refer to [RFC 8555 § 8](https://datatracker.ietf.org/doc/html/rfc8555#section-8)
#[derive(Clone, Debug)]
#[cfg_attr(feature = "json", derive(Serialize, Deserialize))]
pub enum ChallengeType {
    /// For more information about http-01 challenges, refer to [RFC 8555 § 8.3](https://datatracker.ietf.org/doc/html/rfc8555#section-8.3)
    #[cfg_attr(feature = "json", serde(rename = "http-01"))]
    Http01,
    /// For more information about dns-01 challenges, refer to [RFC 8555 § 8.4](https://datatracker.ietf.org/doc/html/rfc8555#section-8.4)
    #[cfg_attr(feature = "json", serde(rename = "dns-01"))]
    Dns01,
}

/// Authorization resource status values
///
/// For more information, refer to [RFC 8555 § 7.1.6](https://datatracker.ietf.org/doc/html/rfc8555#section-7.1.6)
#[derive(Clone, Debug)]
#[cfg_attr(feature = "json", derive(Serialize, Deserialize))]
pub enum AuthorizationStatus {
    #[cfg_attr(feature = "json", serde(rename = "pending"))]
    Pending,
    #[cfg_attr(feature = "json", serde(rename = "expired"))]
    Expired,
    #[cfg_attr(feature = "json", serde(rename = "deactivated"))]
    Deactivated,
    #[cfg_attr(feature = "json", serde(rename = "revoked"))]
    Revoked,
    #[cfg_attr(feature = "json", serde(rename = "valid"))]
    Valid,
    #[cfg_attr(feature = "json", serde(rename = "invalid"))]
    Invalid,
}