forked from Deuxfleurs/garage
Alex
382e74c798
**Spec:** - [x] Start writing - [x] Specify all layout endpoints - [x] Specify all endpoints for operations on keys - [x] Specify all endpoints for operations on key/bucket permissions - [x] Specify all endpoints for operations on buckets - [x] Specify all endpoints for operations on bucket aliases View rendered spec at <https://git.deuxfleurs.fr/Deuxfleurs/garage/src/branch/admin-api/doc/drafts/admin-api.md> **Code:** - [x] Refactor code for admin api to use common api code that was created for K2V **General endpoints:** - [x] Metrics - [x] GetClusterStatus - [x] ConnectClusterNodes - [x] GetClusterLayout - [x] UpdateClusterLayout - [x] ApplyClusterLayout - [x] RevertClusterLayout **Key-related endpoints:** - [x] ListKeys - [x] CreateKey - [x] ImportKey - [x] GetKeyInfo - [x] UpdateKey - [x] DeleteKey **Bucket-related endpoints:** - [x] ListBuckets - [x] CreateBucket - [x] GetBucketInfo - [x] DeleteBucket - [x] PutBucketWebsite - [x] DeleteBucketWebsite **Operations on key/bucket permissions:** - [x] BucketAllowKey - [x] BucketDenyKey **Operations on bucket aliases:** - [x] GlobalAliasBucket - [x] GlobalUnaliasBucket - [x] LocalAliasBucket - [x] LocalUnaliasBucket **And also:** - [x] Separate error type for the admin API (this PR includes a quite big refactoring of error handling) - [x] Add management of website access - [ ] Check that nothing is missing wrt what can be done using the CLI - [ ] Improve formatting of the spec - [x] Make sure everyone is cool with the API design Fix #231 Fix #295 Co-authored-by: Alex Auvolat <alex@adnab.me> Reviewed-on: Deuxfleurs/garage#298 Co-authored-by: Alex <alex@adnab.me> Co-committed-by: Alex <alex@adnab.me>
362 lines
9.4 KiB
Rust
362 lines
9.4 KiB
Rust
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::*;
|
|
use garage_model::garage::Garage;
|
|
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_helper()
|
|
.get_existing_bucket(bucket_id)
|
|
.await?;
|
|
|
|
let param = bucket.params_mut().unwrap();
|
|
|
|
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_helper()
|
|
.get_existing_bucket(bucket_id)
|
|
.await?;
|
|
|
|
let param = bucket.params_mut().unwrap();
|
|
|
|
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::bad_request(
|
|
"Bad XML: can't have RedirectAllRequestsTo and other fields",
|
|
));
|
|
}
|
|
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::bad_request(
|
|
"Bad XML: error document specified but empty",
|
|
))
|
|
} else {
|
|
Ok(())
|
|
}
|
|
}
|
|
}
|
|
|
|
impl Suffix {
|
|
pub fn validate(&self) -> Result<(), Error> {
|
|
if self.suffix.0.is_empty() | self.suffix.0.contains('/') {
|
|
Err(Error::bad_request(
|
|
"Bad XML: index document is empty or contains /",
|
|
))
|
|
} 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::bad_request("Bad XML: invalid protocol"));
|
|
}
|
|
}
|
|
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::bad_request(
|
|
"Bad XML: both ReplaceKeyPrefixWith and ReplaceKeyWith are set",
|
|
));
|
|
}
|
|
if !has_prefix {
|
|
return Err(Error::bad_request(
|
|
"Bad XML: ReplaceKeyPrefixWith is set, but KeyPrefixEquals isn't",
|
|
));
|
|
}
|
|
}
|
|
if let Some(ref protocol) = self.protocol {
|
|
if protocol.0 != "http" && protocol.0 != "https" {
|
|
return Err(Error::bad_request("Bad XML: invalid protocol"));
|
|
}
|
|
}
|
|
// 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(())
|
|
}
|
|
}
|