aboutsummaryrefslogtreecommitdiff
path: root/src/api/s3_website.rs
diff options
context:
space:
mode:
authorAlex <alex@adnab.me>2022-05-10 13:16:57 +0200
committerAlex <alex@adnab.me>2022-05-10 13:16:57 +0200
commit5768bf362262f78376af14517c4921941986192e (patch)
treeb4baf3051eade0f63649443278bb3a3f4c38ec25 /src/api/s3_website.rs
parentdef78c5e6f5da37a0d17b5652c525fbeccbc2e86 (diff)
downloadgarage-5768bf362262f78376af14517c4921941986192e.tar.gz
garage-5768bf362262f78376af14517c4921941986192e.zip
First implementation of K2V (#293)
**Specification:** View spec at [this URL](https://git.deuxfleurs.fr/Deuxfleurs/garage/src/branch/k2v/doc/drafts/k2v-spec.md) - [x] Specify the structure of K2V triples - [x] Specify the DVVS format used for causality detection - [x] Specify the K2V index (just a counter of number of values per partition key) - [x] Specify single-item endpoints: ReadItem, InsertItem, DeleteItem - [x] Specify index endpoint: ReadIndex - [x] Specify multi-item endpoints: InsertBatch, ReadBatch, DeleteBatch - [x] Move to JSON objects instead of tuples - [x] Specify endpoints for polling for updates on single values (PollItem) **Implementation:** - [x] Table for K2V items, causal contexts - [x] Indexing mechanism and table for K2V index - [x] Make API handlers a bit more generic - [x] K2V API endpoint - [x] K2V API router - [x] ReadItem - [x] InsertItem - [x] DeleteItem - [x] PollItem - [x] ReadIndex - [x] InsertBatch - [x] ReadBatch - [x] DeleteBatch **Testing:** - [x] Just a simple Python script that does some requests to check visually that things are going right (does not contain parsing of results or assertions on returned values) - [x] Actual tests: - [x] Adapt testing framework - [x] Simple test with InsertItem + ReadItem - [x] Test with several Insert/Read/DeleteItem + ReadIndex - [x] Test all combinations of return formats for ReadItem - [x] Test with ReadBatch, InsertBatch, DeleteBatch - [x] Test with PollItem - [x] Test error codes - [ ] Fix most broken stuff - [x] test PollItem broken randomly - [x] when invalid causality tokens are given, errors should be 4xx not 5xx **Improvements:** - [x] Descending range queries - [x] Specify - [x] Implement - [x] Add test - [x] Batch updates to index counter - [x] Put K2V behind `k2v` feature flag Co-authored-by: Alex Auvolat <alex@adnab.me> Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/293 Co-authored-by: Alex <alex@adnab.me> Co-committed-by: Alex <alex@adnab.me>
Diffstat (limited to 'src/api/s3_website.rs')
-rw-r--r--src/api/s3_website.rs369
1 files changed, 0 insertions, 369 deletions
diff --git a/src/api/s3_website.rs b/src/api/s3_website.rs
deleted file mode 100644
index b464dd45..00000000
--- a/src/api/s3_website.rs
+++ /dev/null
@@ -1,369 +0,0 @@
-use quick_xml::de::from_reader;
-use std::sync::Arc;
-
-use hyper::{Body, Request, Response, StatusCode};
-use serde::{Deserialize, Serialize};
-
-use crate::error::*;
-use crate::s3_xml::{to_xml_with_header, xmlns_tag, IntValue, Value};
-use crate::signature::verify_signed_content;
-
-use garage_model::bucket_table::*;
-use garage_model::garage::Garage;
-use garage_table::*;
-use garage_util::data::*;
-
-pub async fn handle_get_website(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(website) = param.website_config.get() {
- let wc = WebsiteConfiguration {
- xmlns: (),
- error_document: website.error_document.as_ref().map(|v| Key {
- key: Value(v.to_string()),
- }),
- index_document: Some(Suffix {
- suffix: Value(website.index_document.to_string()),
- }),
- redirect_all_requests_to: None,
- routing_rules: None,
- };
- 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_website(
- garage: Arc<Garage>,
- bucket_id: Uuid,
-) -> Result<Response<Body>, Error> {
- let mut bucket = garage
- .bucket_table
- .get(&EmptyKey, &bucket_id)
- .await?
- .ok_or(Error::NoSuchBucket)?;
-
- let param = bucket
- .params_mut()
- .ok_or_internal_error("Bucket should not be deleted at this point")?;
-
- param.website_config.update(None);
- garage.bucket_table.insert(&bucket).await?;
-
- Ok(Response::builder()
- .status(StatusCode::NO_CONTENT)
- .body(Body::empty())?)
-}
-
-pub async fn handle_put_website(
- garage: Arc<Garage>,
- bucket_id: Uuid,
- 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[..])?;
- }
-
- let mut bucket = garage
- .bucket_table
- .get(&EmptyKey, &bucket_id)
- .await?
- .ok_or(Error::NoSuchBucket)?;
-
- let param = bucket
- .params_mut()
- .ok_or_internal_error("Bucket should not be deleted at this point")?;
-
- let conf: WebsiteConfiguration = from_reader(&body as &[u8])?;
- conf.validate()?;
-
- param
- .website_config
- .update(Some(conf.into_garage_website_config()?));
- garage.bucket_table.insert(&bucket).await?;
-
- Ok(Response::builder()
- .status(StatusCode::OK)
- .body(Body::empty())?)
-}
-
-#[derive(Debug, Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord)]
-pub struct WebsiteConfiguration {
- #[serde(serialize_with = "xmlns_tag", skip_deserializing)]
- pub xmlns: (),
- #[serde(rename = "ErrorDocument")]
- pub error_document: Option<Key>,
- #[serde(rename = "IndexDocument")]
- pub index_document: Option<Suffix>,
- #[serde(rename = "RedirectAllRequestsTo")]
- pub redirect_all_requests_to: Option<Target>,
- #[serde(rename = "RoutingRules")]
- pub routing_rules: Option<Vec<RoutingRule>>,
-}
-
-#[derive(Debug, Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord)]
-pub struct RoutingRule {
- #[serde(rename = "RoutingRule")]
- pub inner: RoutingRuleInner,
-}
-
-#[derive(Debug, Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord)]
-pub struct RoutingRuleInner {
- #[serde(rename = "Condition")]
- pub condition: Option<Condition>,
- #[serde(rename = "Redirect")]
- pub redirect: Redirect,
-}
-
-#[derive(Debug, Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord)]
-pub struct Key {
- #[serde(rename = "Key")]
- pub key: Value,
-}
-
-#[derive(Debug, Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord)]
-pub struct Suffix {
- #[serde(rename = "Suffix")]
- pub suffix: Value,
-}
-
-#[derive(Debug, Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord)]
-pub struct Target {
- #[serde(rename = "HostName")]
- pub hostname: Value,
- #[serde(rename = "Protocol")]
- pub protocol: Option<Value>,
-}
-
-#[derive(Debug, Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord)]
-pub struct Condition {
- #[serde(rename = "HttpErrorCodeReturnedEquals")]
- pub http_error_code: Option<IntValue>,
- #[serde(rename = "KeyPrefixEquals")]
- pub prefix: Option<Value>,
-}
-
-#[derive(Debug, Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord)]
-pub struct Redirect {
- #[serde(rename = "HostName")]
- pub hostname: Option<Value>,
- #[serde(rename = "Protocol")]
- pub protocol: Option<Value>,
- #[serde(rename = "HttpRedirectCode")]
- pub http_redirect_code: Option<IntValue>,
- #[serde(rename = "ReplaceKeyPrefixWith")]
- pub replace_prefix: Option<Value>,
- #[serde(rename = "ReplaceKeyWith")]
- pub replace_full: Option<Value>,
-}
-
-impl WebsiteConfiguration {
- pub fn validate(&self) -> Result<(), Error> {
- if self.redirect_all_requests_to.is_some()
- && (self.error_document.is_some()
- || self.index_document.is_some()
- || self.routing_rules.is_some())
- {
- return Err(Error::BadRequest(
- "Bad XML: can't have RedirectAllRequestsTo and other fields".to_owned(),
- ));
- }
- if let Some(ref ed) = self.error_document {
- ed.validate()?;
- }
- if let Some(ref id) = self.index_document {
- id.validate()?;
- }
- if let Some(ref rart) = self.redirect_all_requests_to {
- rart.validate()?;
- }
- if let Some(ref rrs) = self.routing_rules {
- for rr in rrs {
- rr.inner.validate()?;
- }
- }
-
- Ok(())
- }
-
- pub fn into_garage_website_config(self) -> Result<WebsiteConfig, Error> {
- if self.redirect_all_requests_to.is_some() {
- Err(Error::NotImplemented(
- "S3 website redirects are not currently implemented in Garage.".into(),
- ))
- } else if self.routing_rules.map(|x| !x.is_empty()).unwrap_or(false) {
- Err(Error::NotImplemented(
- "S3 routing rules are not currently implemented in Garage.".into(),
- ))
- } else {
- Ok(WebsiteConfig {
- index_document: self
- .index_document
- .map(|x| x.suffix.0)
- .unwrap_or_else(|| "index.html".to_string()),
- error_document: self.error_document.map(|x| x.key.0),
- })
- }
- }
-}
-
-impl Key {
- pub fn validate(&self) -> Result<(), Error> {
- if self.key.0.is_empty() {
- Err(Error::BadRequest(
- "Bad XML: error document specified but empty".to_owned(),
- ))
- } else {
- Ok(())
- }
- }
-}
-
-impl Suffix {
- pub fn validate(&self) -> Result<(), Error> {
- if self.suffix.0.is_empty() | self.suffix.0.contains('/') {
- Err(Error::BadRequest(
- "Bad XML: index document is empty or contains /".to_owned(),
- ))
- } else {
- Ok(())
- }
- }
-}
-
-impl Target {
- pub fn validate(&self) -> Result<(), Error> {
- if let Some(ref protocol) = self.protocol {
- if protocol.0 != "http" && protocol.0 != "https" {
- return Err(Error::BadRequest("Bad XML: invalid protocol".to_owned()));
- }
- }
- Ok(())
- }
-}
-
-impl RoutingRuleInner {
- pub fn validate(&self) -> Result<(), Error> {
- let has_prefix = self
- .condition
- .as_ref()
- .and_then(|c| c.prefix.as_ref())
- .is_some();
- self.redirect.validate(has_prefix)
- }
-}
-
-impl Redirect {
- pub fn validate(&self, has_prefix: bool) -> Result<(), Error> {
- if self.replace_prefix.is_some() {
- if self.replace_full.is_some() {
- return Err(Error::BadRequest(
- "Bad XML: both ReplaceKeyPrefixWith and ReplaceKeyWith are set".to_owned(),
- ));
- }
- if !has_prefix {
- return Err(Error::BadRequest(
- "Bad XML: ReplaceKeyPrefixWith is set, but KeyPrefixEquals isn't".to_owned(),
- ));
- }
- }
- if let Some(ref protocol) = self.protocol {
- if protocol.0 != "http" && protocol.0 != "https" {
- return Err(Error::BadRequest("Bad XML: invalid protocol".to_owned()));
- }
- }
- // TODO there are probably more invalide cases, but which ones?
- Ok(())
- }
-}
-
-#[cfg(test)]
-mod tests {
- use super::*;
-
- use quick_xml::de::from_str;
-
- #[test]
- fn test_deserialize() -> Result<(), Error> {
- let message = r#"<?xml version="1.0" encoding="UTF-8"?>
-<WebsiteConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
- <ErrorDocument>
- <Key>my-error-doc</Key>
- </ErrorDocument>
- <IndexDocument>
- <Suffix>my-index</Suffix>
- </IndexDocument>
- <RedirectAllRequestsTo>
- <HostName>garage.tld</HostName>
- <Protocol>https</Protocol>
- </RedirectAllRequestsTo>
- <RoutingRules>
- <RoutingRule>
- <Condition>
- <HttpErrorCodeReturnedEquals>404</HttpErrorCodeReturnedEquals>
- <KeyPrefixEquals>prefix1</KeyPrefixEquals>
- </Condition>
- <Redirect>
- <HostName>gara.ge</HostName>
- <Protocol>http</Protocol>
- <HttpRedirectCode>303</HttpRedirectCode>
- <ReplaceKeyPrefixWith>prefix2</ReplaceKeyPrefixWith>
- <ReplaceKeyWith>fullkey</ReplaceKeyWith>
- </Redirect>
- </RoutingRule>
- </RoutingRules>
-</WebsiteConfiguration>"#;
- let conf: WebsiteConfiguration = from_str(message).unwrap();
- let ref_value = WebsiteConfiguration {
- xmlns: (),
- error_document: Some(Key {
- key: Value("my-error-doc".to_owned()),
- }),
- index_document: Some(Suffix {
- suffix: Value("my-index".to_owned()),
- }),
- redirect_all_requests_to: Some(Target {
- hostname: Value("garage.tld".to_owned()),
- protocol: Some(Value("https".to_owned())),
- }),
- routing_rules: Some(vec![RoutingRule {
- inner: RoutingRuleInner {
- condition: Some(Condition {
- http_error_code: Some(IntValue(404)),
- prefix: Some(Value("prefix1".to_owned())),
- }),
- redirect: Redirect {
- hostname: Some(Value("gara.ge".to_owned())),
- protocol: Some(Value("http".to_owned())),
- http_redirect_code: Some(IntValue(303)),
- replace_prefix: Some(Value("prefix2".to_owned())),
- replace_full: Some(Value("fullkey".to_owned())),
- },
- },
- }]),
- };
- 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));
-
- Ok(())
- }
-}
generated by cgit v1.2.3 (git 2.25.1) at 2024-09-20 11:47:23 +0000