Deuxfleurs/garage
48
55
Fork 73
Code Issues 100 Pull requests 15 Releases 30 Wiki Activity
garage/src/api/s3/lifecycle.rs

402 lines
11 KiB
Rust
Raw Normal View History

s3: add xml structures to serialize/deserialize lifecycle configs
2023-08-29 15:44:17 +00:00
use quick_xml::de::from_reader;
use std::sync::Arc;
use hyper::{Body, Request, Response, StatusCode};
use serde::{Deserialize, Serialize};
use crate::s3::error::*;
use crate::s3::xml::{to_xml_with_header, xmlns_tag, IntValue, Value};
use crate::signature::verify_signed_content;
use garage_model::bucket_table::{
lifecycle config: store date as given, try to debug
2023-08-30 18:02:07 +00:00
parse_lifecycle_date, Bucket, LifecycleExpiration as GarageLifecycleExpiration,
s3: add xml structures to serialize/deserialize lifecycle configs
2023-08-29 15:44:17 +00:00
LifecycleFilter as GarageLifecycleFilter, LifecycleRule as GarageLifecycleRule,
};
use garage_model::garage::Garage;
use garage_util::data::*;
pub async fn handle_get_lifecycle(bucket: &Bucket) -> Result<Response<Body>, Error> {
let param = bucket
.params()
.ok_or_internal_error("Bucket should not be deleted at this point")?;
if let Some(lifecycle) = param.lifecycle_config.get() {
lifecycle: implement validation into garage's internal data structure
2023-08-29 16:22:03 +00:00
let wc = LifecycleConfiguration::from_garage_lifecycle_config(lifecycle);
s3: add xml structures to serialize/deserialize lifecycle configs
2023-08-29 15:44:17 +00:00
let xml = to_xml_with_header(&wc)?;
Ok(Response::builder()
.status(StatusCode::OK)
.header(http::header::CONTENT_TYPE, "application/xml")
.body(Body::from(xml))?)
} else {
Ok(Response::builder()
.status(StatusCode::NO_CONTENT)
.body(Body::empty())?)
}
}
pub async fn handle_delete_lifecycle(
garage: Arc<Garage>,
s3 bucket apis: remove redundant call
2023-08-30 21:39:28 +00:00
mut bucket: Bucket,
s3: add xml structures to serialize/deserialize lifecycle configs
2023-08-29 15:44:17 +00:00
) -> Result<Response<Body>, Error> {
s3 bucket apis: remove redundant call
2023-08-30 21:39:28 +00:00
let param = bucket
.params_mut()
.ok_or_internal_error("Bucket should not be deleted at this point")?;
s3: add xml structures to serialize/deserialize lifecycle configs
2023-08-29 15:44:17 +00:00
param.lifecycle_config.update(None);
garage.bucket_table.insert(&bucket).await?;
Ok(Response::builder()
.status(StatusCode::NO_CONTENT)
.body(Body::empty())?)
}
pub async fn handle_put_lifecycle(
garage: Arc<Garage>,
s3 bucket apis: remove redundant call
2023-08-30 21:39:28 +00:00
mut bucket: Bucket,
s3: add xml structures to serialize/deserialize lifecycle configs
2023-08-29 15:44:17 +00:00
req: Request<Body>,
content_sha256: Option<Hash>,
) -> Result<Response<Body>, Error> {
let body = hyper::body::to_bytes(req.into_body()).await?;
if let Some(content_sha256) = content_sha256 {
verify_signed_content(content_sha256, &body[..])?;
}
s3 bucket apis: remove redundant call
2023-08-30 21:39:28 +00:00
let param = bucket
.params_mut()
.ok_or_internal_error("Bucket should not be deleted at this point")?;
s3: add xml structures to serialize/deserialize lifecycle configs
2023-08-29 15:44:17 +00:00
let conf: LifecycleConfiguration = from_reader(&body as &[u8])?;
lifecycle: implement validation into garage's internal data structure
2023-08-29 16:22:03 +00:00
let config = conf
.validate_into_garage_lifecycle_config()
.ok_or_bad_request("Invalid lifecycle configuration")?;
lifecycle config: store date as given, try to debug
2023-08-30 18:02:07 +00:00
lifecycle config: add missing line in merge() and remove tracing
2023-08-30 18:05:53 +00:00
param.lifecycle_config.update(Some(config));
s3: add xml structures to serialize/deserialize lifecycle configs
2023-08-29 15:44:17 +00:00
garage.bucket_table.insert(&bucket).await?;
Ok(Response::builder()
.status(StatusCode::OK)
.body(Body::empty())?)
}
// ---- SERIALIZATION AND DESERIALIZATION TO/FROM S3 XML ----
#[derive(Debug, Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord)]
pub struct LifecycleConfiguration {
#[serde(serialize_with = "xmlns_tag", skip_deserializing)]
pub xmlns: (),
#[serde(rename = "Rule")]
pub lifecycle_rules: Vec<LifecycleRule>,
}
#[derive(Debug, Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord)]
pub struct LifecycleRule {
#[serde(rename = "ID")]
pub id: Option<Value>,
#[serde(rename = "Status")]
pub status: Value,
#[serde(rename = "Filter", default)]
lifecycle: implement validation into garage's internal data structure
2023-08-29 16:22:03 +00:00
pub filter: Option<Filter>,
s3: add xml structures to serialize/deserialize lifecycle configs
2023-08-29 15:44:17 +00:00
#[serde(rename = "Expiration", default)]
pub expiration: Option<Expiration>,
#[serde(rename = "AbortIncompleteMultipartUpload", default)]
pub abort_incomplete_mpu: Option<AbortIncompleteMpu>,
}
#[derive(Debug, Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord, Default)]
pub struct Filter {
#[serde(rename = "And")]
pub and: Option<Box<Filter>>,
#[serde(rename = "Prefix")]
pub prefix: Option<Value>,
#[serde(rename = "ObjectSizeGreaterThan")]
pub size_gt: Option<IntValue>,
#[serde(rename = "ObjectSizeLessThan")]
pub size_lt: Option<IntValue>,
}
#[derive(Debug, Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord)]
pub struct Expiration {
#[serde(rename = "Days")]
pub days: Option<IntValue>,
#[serde(rename = "Date")]
pub at_date: Option<Value>,
}
#[derive(Debug, Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord)]
pub struct AbortIncompleteMpu {
#[serde(rename = "DaysAfterInitiation")]
lifecycle: implement validation into garage's internal data structure
2023-08-29 16:22:03 +00:00
pub days: IntValue,
s3: add xml structures to serialize/deserialize lifecycle configs
2023-08-29 15:44:17 +00:00
}
impl LifecycleConfiguration {
lifecycle: implement validation into garage's internal data structure
2023-08-29 16:22:03 +00:00
pub fn validate_into_garage_lifecycle_config(
self,
) -> Result<Vec<GarageLifecycleRule>, &'static str> {
s3: add xml structures to serialize/deserialize lifecycle configs
2023-08-29 15:44:17 +00:00
let mut ret = vec![];
for rule in self.lifecycle_rules {
ret.push(rule.validate_into_garage_lifecycle_rule()?);
}
Ok(ret)
}
pub fn from_garage_lifecycle_config(config: &[GarageLifecycleRule]) -> Self {
Self {
xmlns: (),
lifecycle_rules: config
.iter()
.map(LifecycleRule::from_garage_lifecycle_rule)
.collect(),
}
}
}
impl LifecycleRule {
lifecycle: implement validation into garage's internal data structure
2023-08-29 16:22:03 +00:00
pub fn validate_into_garage_lifecycle_rule(self) -> Result<GarageLifecycleRule, &'static str> {
let enabled = match self.status.0.as_str() {
"Enabled" => true,
"Disabled" => false,
_ => return Err("invalid value for <Status>"),
};
let filter = self
.filter
.map(Filter::validate_into_garage_lifecycle_filter)
.transpose()?
.unwrap_or_default();
let abort_incomplete_mpu_days = self.abort_incomplete_mpu.map(|x| x.days.0 as usize);
let expiration = self
.expiration
.map(Expiration::validate_into_garage_lifecycle_expiration)
.transpose()?;
Ok(GarageLifecycleRule {
id: self.id.map(|x| x.0),
enabled,
filter,
abort_incomplete_mpu_days,
expiration,
})
s3: add xml structures to serialize/deserialize lifecycle configs
2023-08-29 15:44:17 +00:00
}
pub fn from_garage_lifecycle_rule(rule: &GarageLifecycleRule) -> Self {
lifecycle: implement validation into garage's internal data structure
2023-08-29 16:22:03 +00:00
Self {
id: rule.id.as_deref().map(Value::from),
status: if rule.enabled {
Value::from("Enabled")
} else {
Value::from("Disabled")
},
filter: Filter::from_garage_lifecycle_filter(&rule.filter),
abort_incomplete_mpu: rule
.abort_incomplete_mpu_days
.map(|days| AbortIncompleteMpu {
days: IntValue(days as i64),
}),
expiration: rule
.expiration
.as_ref()
.map(Expiration::from_garage_lifecycle_expiration),
}
}
}
impl Filter {
pub fn count(&self) -> i32 {
fn count<T>(x: &Option<T>) -> i32 {
x.as_ref().map(|_| 1).unwrap_or(0)
}
count(&self.prefix) + count(&self.size_gt) + count(&self.size_lt)
}
pub fn validate_into_garage_lifecycle_filter(
self,
) -> Result<GarageLifecycleFilter, &'static str> {
if self.count() > 0 && self.and.is_some() {
Err("Filter tag cannot contain both <And> and another condition")
} else if let Some(and) = self.and {
if and.and.is_some() {
return Err("Nested <And> tags");
}
Ok(and.internal_into_garage_lifecycle_filter())
} else if self.count() > 1 {
Err("Multiple Filter conditions must be wrapped in an <And> tag")
} else {
Ok(self.internal_into_garage_lifecycle_filter())
}
}
fn internal_into_garage_lifecycle_filter(self) -> GarageLifecycleFilter {
GarageLifecycleFilter {
prefix: self.prefix.map(|x| x.0),
lifecycle worker: implement main functionality
2023-08-30 12:28:48 +00:00
size_gt: self.size_gt.map(|x| x.0 as u64),
size_lt: self.size_lt.map(|x| x.0 as u64),
lifecycle: implement validation into garage's internal data structure
2023-08-29 16:22:03 +00:00
}
}
pub fn from_garage_lifecycle_filter(rule: &GarageLifecycleFilter) -> Option<Self> {
let filter = Filter {
and: None,
prefix: rule.prefix.as_deref().map(Value::from),
size_gt: rule.size_gt.map(|x| IntValue(x as i64)),
size_lt: rule.size_lt.map(|x| IntValue(x as i64)),
};
match filter.count() {
0 => None,
1 => Some(filter),
_ => Some(Filter {
and: Some(Box::new(filter)),
..Default::default()
}),
}
}
}
impl Expiration {
pub fn validate_into_garage_lifecycle_expiration(
self,
) -> Result<GarageLifecycleExpiration, &'static str> {
match (self.days, self.at_date) {
(Some(_), Some(_)) => Err("cannot have both <Days> and <Date> in <Expiration>"),
(None, None) => Err("<Expiration> must contain either <Days> or <Date>"),
(Some(days), None) => Ok(GarageLifecycleExpiration::AfterDays(days.0 as usize)),
lifecycle config: store date as given, try to debug
2023-08-30 18:02:07 +00:00
(None, Some(date)) => {
parse_lifecycle_date(&date.0)?;
Ok(GarageLifecycleExpiration::AtDate(date.0))
}
lifecycle: implement validation into garage's internal data structure
2023-08-29 16:22:03 +00:00
}
}
pub fn from_garage_lifecycle_expiration(exp: &GarageLifecycleExpiration) -> Self {
match exp {
GarageLifecycleExpiration::AfterDays(days) => Expiration {
days: Some(IntValue(*days as i64)),
at_date: None,
},
use a NaiveDate in data model, it serializes to string (iso 8601 format)
2023-08-30 09:24:01 +00:00
GarageLifecycleExpiration::AtDate(date) => Expiration {
lifecycle: implement validation into garage's internal data structure
2023-08-29 16:22:03 +00:00
days: None,
use a NaiveDate in data model, it serializes to string (iso 8601 format)
2023-08-30 09:24:01 +00:00
at_date: Some(Value(date.to_string())),
lifecycle: implement validation into garage's internal data structure
2023-08-29 16:22:03 +00:00
},
}
s3: add xml structures to serialize/deserialize lifecycle configs
2023-08-29 15:44:17 +00:00
}
}
#[cfg(test)]
mod tests {
use super::*;
use quick_xml::de::from_str;
#[test]
fn test_deserialize_lifecycle_config() -> Result<(), Error> {
let message = r#"<?xml version="1.0" encoding="UTF-8"?>
<LifecycleConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
<Rule>
<ID>id1</ID>
<Status>Enabled</Status>
<Filter>
<Prefix>documents/</Prefix>
</Filter>
<AbortIncompleteMultipartUpload>
<DaysAfterInitiation>7</DaysAfterInitiation>
</AbortIncompleteMultipartUpload>
</Rule>
<Rule>
<ID>id2</ID>
<Status>Enabled</Status>
<Filter>
<And>
<Prefix>logs/</Prefix>
<ObjectSizeGreaterThan>1000000</ObjectSizeGreaterThan>
</And>
</Filter>
<Expiration>
<Days>365</Days>
</Expiration>
</Rule>
</LifecycleConfiguration>"#;
let conf: LifecycleConfiguration = from_str(message).unwrap();
let ref_value = LifecycleConfiguration {
xmlns: (),
lifecycle_rules: vec![
LifecycleRule {
id: Some("id1".into()),
status: "Enabled".into(),
lifecycle: implement validation into garage's internal data structure
2023-08-29 16:22:03 +00:00
filter: Some(Filter {
s3: add xml structures to serialize/deserialize lifecycle configs
2023-08-29 15:44:17 +00:00
prefix: Some("documents/".into()),
..Default::default()
}),
lifecycle: implement validation into garage's internal data structure
2023-08-29 16:22:03 +00:00
expiration: None,
abort_incomplete_mpu: Some(AbortIncompleteMpu { days: IntValue(7) }),
s3: add xml structures to serialize/deserialize lifecycle configs
2023-08-29 15:44:17 +00:00
},
LifecycleRule {
id: Some("id2".into()),
status: "Enabled".into(),
lifecycle: implement validation into garage's internal data structure
2023-08-29 16:22:03 +00:00
filter: Some(Filter {
s3: add xml structures to serialize/deserialize lifecycle configs
2023-08-29 15:44:17 +00:00
and: Some(Box::new(Filter {
prefix: Some("logs/".into()),
size_gt: Some(IntValue(1000000)),
..Default::default()
})),
..Default::default()
lifecycle: implement validation into garage's internal data structure
2023-08-29 16:22:03 +00:00
}),
s3: add xml structures to serialize/deserialize lifecycle configs
2023-08-29 15:44:17 +00:00
expiration: Some(Expiration {
days: Some(IntValue(365)),
at_date: None,
}),
abort_incomplete_mpu: None,
},
],
};
assert_eq! {
ref_value,
conf
};
let message2 = to_xml_with_header(&ref_value)?;
let cleanup = |c: &str| c.replace(char::is_whitespace, "");
assert_eq!(cleanup(message), cleanup(&message2));
lifecycle: implement validation into garage's internal data structure
2023-08-29 16:22:03 +00:00
// Check validation
let validated = ref_value
.validate_into_garage_lifecycle_config()
.ok_or_bad_request("invalid xml config")?;
let ref_config = vec![
GarageLifecycleRule {
id: Some("id1".into()),
enabled: true,
filter: GarageLifecycleFilter {
prefix: Some("documents/".into()),
..Default::default()
},
expiration: None,
abort_incomplete_mpu_days: Some(7),
},
GarageLifecycleRule {
id: Some("id2".into()),
enabled: true,
filter: GarageLifecycleFilter {
prefix: Some("logs/".into()),
size_gt: Some(1000000),
..Default::default()
},
expiration: Some(GarageLifecycleExpiration::AfterDays(365)),
abort_incomplete_mpu_days: None,
},
];
assert_eq!(validated, ref_config);
let message3 = to_xml_with_header(&LifecycleConfiguration::from_garage_lifecycle_config(
&validated,
))?;
assert_eq!(cleanup(message), cleanup(&message3));
s3: add xml structures to serialize/deserialize lifecycle configs
2023-08-29 15:44:17 +00:00
Ok(())
}
}
Reference in a new issue Copy permalink