1use error_support::{ErrorHandling, GetErrorHandling};
6use rc_crypto::hawk;
7use std::string;
8
9#[derive(Debug, thiserror::Error)]
14pub enum FxaError {
15 #[error("authentication error")]
20 Authentication,
21 #[error("network error")]
24 Network,
25 #[error("no authentication flow was active")]
31 NoExistingAuthFlow,
32 #[error("the requested authentication flow was not active")]
40 WrongAuthFlow,
41 #[error("Origin mismatch")]
46 OriginMismatch,
47 #[error("The sync scoped key was missing")]
49 SyncScopedKeyMissingInServerResponse,
50 #[error("panic in native code")]
54 Panic,
55 #[error("other error: {0}")]
57 Other(String),
58}
59
60#[derive(Debug, thiserror::Error)]
63pub enum Error {
64 #[error("Server asked the client to back off, please wait {0} seconds to try again")]
65 BackoffError(u64),
66
67 #[error("Unknown OAuth State")]
68 UnknownOAuthState,
69
70 #[error("Multiple OAuth scopes requested")]
71 MultipleScopesRequested,
72
73 #[error("No cached token for scope {0}")]
74 NoCachedToken(String),
75
76 #[error("No cached scoped keys for scope {0}")]
77 NoScopedKey(String),
78
79 #[error("No stored refresh token")]
80 NoRefreshToken,
81
82 #[error("No stored session token")]
83 NoSessionToken,
84
85 #[error("No stored migration data")]
86 NoMigrationData,
87
88 #[error("No stored current device id")]
89 NoCurrentDeviceId,
90
91 #[error("Device target is unknown (Device ID: {0})")]
92 UnknownTargetDevice(String),
93
94 #[error("Api client error {0}")]
95 ApiClientError(&'static str),
96
97 #[error("Illegal state: {0}")]
98 IllegalState(&'static str),
99
100 #[error("Unknown command: {0}")]
101 UnknownCommand(String),
102
103 #[error("Send Tab diagnosis error: {0}")]
104 SendTabDiagnosisError(&'static str),
105
106 #[error("Cannot xor arrays with different lengths: {0} and {1}")]
107 XorLengthMismatch(usize, usize),
108
109 #[error("Origin mismatch: {0}")]
110 OriginMismatch(String),
111
112 #[error("Remote key and local key mismatch")]
113 MismatchedKeys,
114
115 #[error("The sync scoped key was missing in the server response")]
116 SyncScopedKeyMissingInServerResponse,
117
118 #[error("Client: {0} is not allowed to request scope: {1}")]
119 ScopeNotAllowed(String, String),
120
121 #[error("Unsupported command: {0}")]
122 UnsupportedCommand(&'static str),
123
124 #[error("Missing URL parameter: {0}")]
125 MissingUrlParameter(&'static str),
126
127 #[error("Null pointer passed to FFI")]
128 NullPointer,
129
130 #[error("Invalid buffer length: {0}")]
131 InvalidBufferLength(i32),
132
133 #[error("Too many calls to auth introspection endpoint")]
134 AuthCircuitBreakerError,
135
136 #[error("Remote server error: '{code}' '{errno}' '{error}' '{message}' '{info}'")]
137 RemoteError {
138 code: u64,
139 errno: u64,
140 error: String,
141 message: String,
142 info: String,
143 },
144
145 #[error("Crypto/NSS error: {0}")]
147 CryptoError(#[from] rc_crypto::Error),
148
149 #[error("http-ece encryption error: {0}")]
150 EceError(#[from] rc_crypto::ece::Error),
151
152 #[error("Hex decode error: {0}")]
153 HexDecodeError(#[from] hex::FromHexError),
154
155 #[error("Base64 decode error: {0}")]
156 Base64Decode(#[from] base64::DecodeError),
157
158 #[error("JSON error: {0}")]
159 JsonError(#[from] serde_json::Error),
160
161 #[error("JWCrypto error: {0}")]
162 JwCryptoError(#[from] jwcrypto::JwCryptoError),
163
164 #[error("UTF8 decode error: {0}")]
165 UTF8DecodeError(#[from] string::FromUtf8Error),
166
167 #[error("Network error: {0}")]
168 RequestError(#[from] viaduct::Error),
169
170 #[error("Malformed URL error: {0}")]
171 MalformedUrl(#[from] url::ParseError),
172
173 #[error("Unexpected HTTP status: {0}")]
174 UnexpectedStatus(#[from] viaduct::UnexpectedStatus),
175
176 #[error("Sync15 error: {0}")]
177 SyncError(#[from] sync15::Error),
178
179 #[error("HAWK error: {0}")]
180 HawkError(#[from] hawk::Error),
181
182 #[error("Integer conversion error: {0}")]
183 IntegerConversionError(#[from] std::num::TryFromIntError),
184
185 #[error("Command not found by fxa")]
186 CommandNotFound,
187
188 #[error("Invalid Push Event")]
189 InvalidPushEvent,
190
191 #[error("Invalid state transition: {0}")]
192 InvalidStateTransition(String),
193
194 #[error("Internal error in the state machine: {0}")]
195 StateMachineLogicError(String),
196}
197
198impl GetErrorHandling for Error {
201 type ExternalError = FxaError;
202
203 fn get_error_handling(&self) -> ErrorHandling<Self::ExternalError> {
204 match self {
205 Error::RemoteError { code: 401, .. }
206 | Error::NoRefreshToken
207 | Error::NoScopedKey(_)
208 | Error::NoCachedToken(_) => {
209 ErrorHandling::convert(FxaError::Authentication).log_warning()
210 }
211 Error::RequestError(_) => ErrorHandling::convert(FxaError::Network).log_warning(),
212 Error::SyncScopedKeyMissingInServerResponse => {
213 ErrorHandling::convert(FxaError::SyncScopedKeyMissingInServerResponse)
214 .report_error("fxa-client-scoped-key-missing")
215 }
216 Error::UnknownOAuthState => {
217 ErrorHandling::convert(FxaError::NoExistingAuthFlow).log_warning()
218 }
219 Error::BackoffError(_) => ErrorHandling::convert(FxaError::Other(self.to_string()))
220 .report_error("fxa-client-backoff"),
221 Error::InvalidStateTransition(_) | Error::StateMachineLogicError(_) => {
222 ErrorHandling::convert(FxaError::Other(self.to_string()))
223 .report_error("fxa-state-machine-error")
224 }
225 Error::OriginMismatch(_) => ErrorHandling::convert(FxaError::OriginMismatch),
226 _ => ErrorHandling::convert(FxaError::Other(self.to_string()))
227 .report_error("fxa-client-other-error"),
228 }
229 }
230}