2021-11-29 10:52:42 +00:00
|
|
|
use std::convert::TryInto;
|
|
|
|
|
2020-11-08 14:04:30 +00:00
|
|
|
use err_derive::Error;
|
2021-11-29 10:52:42 +00:00
|
|
|
use hyper::header::HeaderValue;
|
2022-05-13 11:51:34 +00:00
|
|
|
use hyper::{Body, HeaderMap, StatusCode};
|
2020-11-08 14:04:30 +00:00
|
|
|
|
2022-01-03 12:58:05 +00:00
|
|
|
use garage_model::helper::error::Error as HelperError;
|
2020-11-08 14:04:30 +00:00
|
|
|
use garage_util::error::Error as GarageError;
|
|
|
|
|
2022-05-13 13:04:53 +00:00
|
|
|
use crate::common_error::CommonError;
|
|
|
|
pub use crate::common_error::{OkOrBadRequest, OkOrInternalError};
|
2022-05-13 11:51:34 +00:00
|
|
|
use crate::generic_server::ApiError;
|
2022-05-10 11:16:57 +00:00
|
|
|
use crate::s3::xml as s3_xml;
|
2021-04-27 23:05:40 +00:00
|
|
|
|
2021-03-26 21:32:09 +00:00
|
|
|
/// Errors of this crate
|
2020-11-08 14:04:30 +00:00
|
|
|
#[derive(Debug, Error)]
|
|
|
|
pub enum Error {
|
2022-05-13 13:04:53 +00:00
|
|
|
#[error(display = "{}", _0)]
|
|
|
|
/// Error from common error
|
|
|
|
CommonError(CommonError),
|
2020-11-08 14:04:30 +00:00
|
|
|
|
|
|
|
// Category: cannot process
|
2021-03-26 21:32:09 +00:00
|
|
|
/// No proper api key was used, or the signature was invalid
|
2020-11-08 14:04:30 +00:00
|
|
|
#[error(display = "Forbidden: {}", _0)]
|
|
|
|
Forbidden(String),
|
|
|
|
|
2021-04-27 23:05:40 +00:00
|
|
|
/// Authorization Header Malformed
|
|
|
|
#[error(display = "Authorization header malformed, expected scope: {}", _0)]
|
|
|
|
AuthorizationHeaderMalformed(String),
|
|
|
|
|
2021-03-26 21:32:09 +00:00
|
|
|
/// The object requested don't exists
|
2022-01-05 16:07:36 +00:00
|
|
|
#[error(display = "Key not found")]
|
|
|
|
NoSuchKey,
|
|
|
|
|
|
|
|
/// The bucket requested don't exists
|
|
|
|
#[error(display = "Bucket not found")]
|
|
|
|
NoSuchBucket,
|
|
|
|
|
|
|
|
/// The multipart upload requested don't exists
|
|
|
|
#[error(display = "Upload not found")]
|
|
|
|
NoSuchUpload,
|
|
|
|
|
|
|
|
/// Tried to create a bucket that already exist
|
|
|
|
#[error(display = "Bucket already exists")]
|
|
|
|
BucketAlreadyExists,
|
|
|
|
|
|
|
|
/// Tried to delete a non-empty bucket
|
|
|
|
#[error(display = "Tried to delete a non-empty bucket")]
|
|
|
|
BucketNotEmpty,
|
2020-11-08 14:04:30 +00:00
|
|
|
|
2022-01-11 11:43:46 +00:00
|
|
|
/// Precondition failed (e.g. x-amz-copy-source-if-match)
|
|
|
|
#[error(display = "At least one of the preconditions you specified did not hold")]
|
|
|
|
PreconditionFailed,
|
|
|
|
|
2022-01-12 11:43:33 +00:00
|
|
|
/// Parts specified in CMU request do not match parts actually uploaded
|
|
|
|
#[error(display = "Parts given to CompleteMultipartUpload do not match uploaded parts")]
|
|
|
|
InvalidPart,
|
|
|
|
|
|
|
|
/// Parts given to CompleteMultipartUpload were not in ascending order
|
|
|
|
#[error(display = "Parts given to CompleteMultipartUpload were not in ascending order")]
|
|
|
|
InvalidPartOrder,
|
|
|
|
|
|
|
|
/// In CompleteMultipartUpload: not enough data
|
|
|
|
/// (here we are more lenient than AWS S3)
|
|
|
|
#[error(display = "Proposed upload is smaller than the minimum allowed object size")]
|
|
|
|
EntityTooSmall,
|
|
|
|
|
2020-11-08 14:04:30 +00:00
|
|
|
// Category: bad request
|
2021-04-06 03:25:28 +00:00
|
|
|
/// The request contained an invalid UTF-8 sequence in its path or in other parameters
|
2020-11-08 14:04:30 +00:00
|
|
|
#[error(display = "Invalid UTF-8: {}", _0)]
|
2021-05-02 21:13:08 +00:00
|
|
|
InvalidUtf8Str(#[error(source)] std::str::Utf8Error),
|
2021-02-19 15:44:06 +00:00
|
|
|
|
2021-03-26 21:32:09 +00:00
|
|
|
/// The request used an invalid path
|
2021-02-19 15:44:06 +00:00
|
|
|
#[error(display = "Invalid UTF-8: {}", _0)]
|
2021-05-02 21:13:08 +00:00
|
|
|
InvalidUtf8String(#[error(source)] std::string::FromUtf8Error),
|
2021-02-19 15:44:06 +00:00
|
|
|
|
2021-03-26 21:32:09 +00:00
|
|
|
/// Some base64 encoded data was badly encoded
|
2021-02-19 15:44:06 +00:00
|
|
|
#[error(display = "Invalid base64: {}", _0)]
|
|
|
|
InvalidBase64(#[error(source)] base64::DecodeError),
|
2020-11-08 14:04:30 +00:00
|
|
|
|
2022-05-12 15:10:25 +00:00
|
|
|
/// Bucket name is not valid according to AWS S3 specs
|
|
|
|
#[error(display = "Invalid bucket name")]
|
|
|
|
InvalidBucketName,
|
|
|
|
|
2021-03-26 21:32:09 +00:00
|
|
|
/// The client sent invalid XML data
|
2020-11-08 14:04:30 +00:00
|
|
|
#[error(display = "Invalid XML: {}", _0)]
|
2021-05-02 21:13:08 +00:00
|
|
|
InvalidXml(String),
|
2020-11-08 14:04:30 +00:00
|
|
|
|
2021-03-26 21:32:09 +00:00
|
|
|
/// The client sent a header with invalid value
|
2020-11-08 14:04:30 +00:00
|
|
|
#[error(display = "Invalid header value: {}", _0)]
|
|
|
|
InvalidHeader(#[error(source)] hyper::header::ToStrError),
|
|
|
|
|
2021-03-26 21:32:09 +00:00
|
|
|
/// The client sent a range header with invalid value
|
2020-11-08 14:04:30 +00:00
|
|
|
#[error(display = "Invalid HTTP range: {:?}", _0)]
|
2021-11-29 10:52:42 +00:00
|
|
|
InvalidRange(#[error(from)] (http_range::HttpRangeParseError, u64)),
|
2020-11-08 14:04:30 +00:00
|
|
|
|
2022-05-10 11:16:57 +00:00
|
|
|
/// The client asked for an invalid return format (invalid Accept header)
|
|
|
|
#[error(display = "Not acceptable: {}", _0)]
|
|
|
|
NotAcceptable(String),
|
|
|
|
|
2021-12-06 14:17:47 +00:00
|
|
|
/// The client sent a request for an action not supported by garage
|
|
|
|
#[error(display = "Unimplemented action: {}", _0)]
|
|
|
|
NotImplemented(String),
|
2020-11-08 14:04:30 +00:00
|
|
|
}
|
|
|
|
|
2022-05-13 13:04:53 +00:00
|
|
|
impl<T> From<T> for Error
|
|
|
|
where
|
|
|
|
CommonError: From<T>,
|
|
|
|
{
|
|
|
|
fn from(err: T) -> Self {
|
|
|
|
Error::CommonError(CommonError::from(err))
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-03-16 14:58:40 +00:00
|
|
|
impl From<roxmltree::Error> for Error {
|
|
|
|
fn from(err: roxmltree::Error) -> Self {
|
2021-05-02 21:13:08 +00:00
|
|
|
Self::InvalidXml(format!("{}", err))
|
2021-03-16 14:58:40 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-05-02 20:30:56 +00:00
|
|
|
impl From<quick_xml::de::DeError> for Error {
|
|
|
|
fn from(err: quick_xml::de::DeError) -> Self {
|
2021-05-02 21:13:08 +00:00
|
|
|
Self::InvalidXml(format!("{}", err))
|
2021-05-02 20:30:56 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-01-03 12:58:05 +00:00
|
|
|
impl From<HelperError> for Error {
|
|
|
|
fn from(err: HelperError) -> Self {
|
|
|
|
match err {
|
2022-05-13 13:04:53 +00:00
|
|
|
HelperError::Internal(i) => Self::CommonError(CommonError::InternalError(i)),
|
|
|
|
HelperError::BadRequest(b) => Self::CommonError(CommonError::BadRequest(b)),
|
|
|
|
e => Self::CommonError(CommonError::BadRequest(format!("{}", e))),
|
2022-01-03 12:58:05 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-02-21 22:02:30 +00:00
|
|
|
impl From<multer::Error> for Error {
|
|
|
|
fn from(err: multer::Error) -> Self {
|
2022-05-13 13:04:53 +00:00
|
|
|
Self::bad_request(err)
|
2022-02-21 22:02:30 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-11-08 14:04:30 +00:00
|
|
|
impl Error {
|
2021-04-27 23:05:40 +00:00
|
|
|
pub fn aws_code(&self) -> &'static str {
|
|
|
|
match self {
|
2022-01-05 16:07:36 +00:00
|
|
|
Error::NoSuchKey => "NoSuchKey",
|
|
|
|
Error::NoSuchBucket => "NoSuchBucket",
|
|
|
|
Error::NoSuchUpload => "NoSuchUpload",
|
|
|
|
Error::BucketAlreadyExists => "BucketAlreadyExists",
|
|
|
|
Error::BucketNotEmpty => "BucketNotEmpty",
|
2022-01-11 11:43:46 +00:00
|
|
|
Error::PreconditionFailed => "PreconditionFailed",
|
2022-01-12 11:43:33 +00:00
|
|
|
Error::InvalidPart => "InvalidPart",
|
|
|
|
Error::InvalidPartOrder => "InvalidPartOrder",
|
|
|
|
Error::EntityTooSmall => "EntityTooSmall",
|
2021-04-27 23:05:40 +00:00
|
|
|
Error::Forbidden(_) => "AccessDenied",
|
|
|
|
Error::AuthorizationHeaderMalformed(_) => "AuthorizationHeaderMalformed",
|
2022-01-05 16:07:36 +00:00
|
|
|
Error::NotImplemented(_) => "NotImplemented",
|
2022-05-13 13:04:53 +00:00
|
|
|
Error::CommonError(CommonError::InternalError(
|
2021-10-19 14:16:10 +00:00
|
|
|
GarageError::Timeout
|
|
|
|
| GarageError::RemoteError(_)
|
|
|
|
| GarageError::Quorum(_, _, _, _),
|
2022-05-13 13:04:53 +00:00
|
|
|
)) => "ServiceUnavailable",
|
|
|
|
Error::CommonError(
|
|
|
|
CommonError::InternalError(_) | CommonError::Hyper(_) | CommonError::Http(_),
|
|
|
|
) => "InternalError",
|
2021-04-27 23:05:40 +00:00
|
|
|
_ => "InvalidRequest",
|
|
|
|
}
|
|
|
|
}
|
2022-05-13 12:30:30 +00:00
|
|
|
|
2022-05-13 13:04:53 +00:00
|
|
|
pub fn internal_error<M: ToString>(msg: M) -> Self {
|
|
|
|
Self::CommonError(CommonError::InternalError(GarageError::Message(
|
|
|
|
msg.to_string(),
|
|
|
|
)))
|
|
|
|
}
|
|
|
|
|
2022-05-13 12:30:30 +00:00
|
|
|
pub fn bad_request<M: ToString>(msg: M) -> Self {
|
2022-05-13 13:04:53 +00:00
|
|
|
Self::CommonError(CommonError::BadRequest(msg.to_string()))
|
2022-05-13 12:30:30 +00:00
|
|
|
}
|
2022-05-13 11:51:34 +00:00
|
|
|
}
|
2021-04-27 23:05:40 +00:00
|
|
|
|
2022-05-13 11:51:34 +00:00
|
|
|
impl ApiError for Error {
|
|
|
|
/// Get the HTTP status code that best represents the meaning of the error for the client
|
|
|
|
fn http_status_code(&self) -> StatusCode {
|
|
|
|
match self {
|
2022-05-13 13:04:53 +00:00
|
|
|
Error::CommonError(c) => c.http_status_code(),
|
2022-05-13 11:51:34 +00:00
|
|
|
Error::NoSuchKey | Error::NoSuchBucket | Error::NoSuchUpload => StatusCode::NOT_FOUND,
|
|
|
|
Error::BucketNotEmpty | Error::BucketAlreadyExists => StatusCode::CONFLICT,
|
|
|
|
Error::PreconditionFailed => StatusCode::PRECONDITION_FAILED,
|
|
|
|
Error::Forbidden(_) => StatusCode::FORBIDDEN,
|
|
|
|
Error::NotAcceptable(_) => StatusCode::NOT_ACCEPTABLE,
|
|
|
|
Error::InvalidRange(_) => StatusCode::RANGE_NOT_SATISFIABLE,
|
|
|
|
Error::NotImplemented(_) => StatusCode::NOT_IMPLEMENTED,
|
|
|
|
_ => StatusCode::BAD_REQUEST,
|
|
|
|
}
|
2021-04-27 23:05:40 +00:00
|
|
|
}
|
2021-11-29 10:52:42 +00:00
|
|
|
|
2022-05-13 11:51:34 +00:00
|
|
|
fn add_http_headers(&self, header_map: &mut HeaderMap<HeaderValue>) {
|
2021-11-29 10:52:42 +00:00
|
|
|
use hyper::header;
|
|
|
|
#[allow(clippy::single_match)]
|
|
|
|
match self {
|
|
|
|
Error::InvalidRange((_, len)) => {
|
|
|
|
header_map.append(
|
|
|
|
header::CONTENT_RANGE,
|
|
|
|
format!("bytes */{}", len)
|
|
|
|
.try_into()
|
|
|
|
.expect("header value only contain ascii"),
|
|
|
|
);
|
|
|
|
}
|
|
|
|
_ => (),
|
|
|
|
}
|
|
|
|
}
|
2022-05-13 11:51:34 +00:00
|
|
|
|
|
|
|
fn http_body(&self, garage_region: &str, path: &str) -> Body {
|
|
|
|
let error = s3_xml::Error {
|
|
|
|
code: s3_xml::Value(self.aws_code().to_string()),
|
|
|
|
message: s3_xml::Value(format!("{}", self)),
|
|
|
|
resource: Some(s3_xml::Value(path.to_string())),
|
|
|
|
region: Some(s3_xml::Value(garage_region.to_string())),
|
|
|
|
};
|
|
|
|
Body::from(s3_xml::to_xml_with_header(&error).unwrap_or_else(|_| {
|
|
|
|
r#"
|
|
|
|
<?xml version="1.0" encoding="UTF-8"?>
|
|
|
|
<Error>
|
|
|
|
<Code>InternalError</Code>
|
|
|
|
<Message>XML encoding of error failed</Message>
|
|
|
|
</Error>
|
|
|
|
"#
|
|
|
|
.into()
|
|
|
|
}))
|
|
|
|
}
|
2020-11-08 14:04:30 +00:00
|
|
|
}
|