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>
196 lines
4.9 KiB
Rust
196 lines
4.9 KiB
Rust
use std::sync::Arc;
|
|
|
|
use async_trait::async_trait;
|
|
|
|
use futures::future::Future;
|
|
use hyper::{Body, Method, Request, Response};
|
|
|
|
use opentelemetry::{trace::SpanRef, KeyValue};
|
|
|
|
use garage_util::error::Error as GarageError;
|
|
|
|
use garage_model::garage::Garage;
|
|
|
|
use crate::generic_server::*;
|
|
use crate::k2v::error::*;
|
|
|
|
use crate::signature::payload::check_payload_signature;
|
|
use crate::signature::streaming::*;
|
|
|
|
use crate::helpers::*;
|
|
use crate::k2v::batch::*;
|
|
use crate::k2v::index::*;
|
|
use crate::k2v::item::*;
|
|
use crate::k2v::router::Endpoint;
|
|
use crate::s3::cors::*;
|
|
|
|
pub struct K2VApiServer {
|
|
garage: Arc<Garage>,
|
|
}
|
|
|
|
pub(crate) struct K2VApiEndpoint {
|
|
bucket_name: String,
|
|
endpoint: Endpoint,
|
|
}
|
|
|
|
impl K2VApiServer {
|
|
pub async fn run(
|
|
garage: Arc<Garage>,
|
|
shutdown_signal: impl Future<Output = ()>,
|
|
) -> Result<(), GarageError> {
|
|
if let Some(cfg) = &garage.config.k2v_api {
|
|
let bind_addr = cfg.api_bind_addr;
|
|
|
|
ApiServer::new(
|
|
garage.config.s3_api.s3_region.clone(),
|
|
K2VApiServer { garage },
|
|
)
|
|
.run_server(bind_addr, shutdown_signal)
|
|
.await
|
|
} else {
|
|
Ok(())
|
|
}
|
|
}
|
|
}
|
|
|
|
#[async_trait]
|
|
impl ApiHandler for K2VApiServer {
|
|
const API_NAME: &'static str = "k2v";
|
|
const API_NAME_DISPLAY: &'static str = "K2V";
|
|
|
|
type Endpoint = K2VApiEndpoint;
|
|
type Error = Error;
|
|
|
|
fn parse_endpoint(&self, req: &Request<Body>) -> Result<K2VApiEndpoint, Error> {
|
|
let (endpoint, bucket_name) = Endpoint::from_request(req)?;
|
|
|
|
Ok(K2VApiEndpoint {
|
|
bucket_name,
|
|
endpoint,
|
|
})
|
|
}
|
|
|
|
async fn handle(
|
|
&self,
|
|
req: Request<Body>,
|
|
endpoint: K2VApiEndpoint,
|
|
) -> Result<Response<Body>, Error> {
|
|
let K2VApiEndpoint {
|
|
bucket_name,
|
|
endpoint,
|
|
} = endpoint;
|
|
let garage = self.garage.clone();
|
|
|
|
// The OPTIONS method is procesed early, before we even check for an API key
|
|
if let Endpoint::Options = endpoint {
|
|
return Ok(handle_options_s3api(garage, &req, Some(bucket_name))
|
|
.await
|
|
.ok_or_bad_request("Error handling OPTIONS")?);
|
|
}
|
|
|
|
let (api_key, mut content_sha256) = check_payload_signature(&garage, "k2v", &req).await?;
|
|
let api_key = api_key
|
|
.ok_or_else(|| Error::forbidden("Garage does not support anonymous access yet"))?;
|
|
|
|
let req = parse_streaming_body(
|
|
&api_key,
|
|
req,
|
|
&mut content_sha256,
|
|
&garage.config.s3_api.s3_region,
|
|
"k2v",
|
|
)?;
|
|
|
|
let bucket_id = garage
|
|
.bucket_helper()
|
|
.resolve_bucket(&bucket_name, &api_key)
|
|
.await?;
|
|
let bucket = garage
|
|
.bucket_helper()
|
|
.get_existing_bucket(bucket_id)
|
|
.await?;
|
|
|
|
let allowed = match endpoint.authorization_type() {
|
|
Authorization::Read => api_key.allow_read(&bucket_id),
|
|
Authorization::Write => api_key.allow_write(&bucket_id),
|
|
Authorization::Owner => api_key.allow_owner(&bucket_id),
|
|
_ => unreachable!(),
|
|
};
|
|
|
|
if !allowed {
|
|
return Err(Error::forbidden("Operation is not allowed for this key."));
|
|
}
|
|
|
|
// Look up what CORS rule might apply to response.
|
|
// Requests for methods different than GET, HEAD or POST
|
|
// are always preflighted, i.e. the browser should make
|
|
// an OPTIONS call before to check it is allowed
|
|
let matching_cors_rule = match *req.method() {
|
|
Method::GET | Method::HEAD | Method::POST => find_matching_cors_rule(&bucket, &req)
|
|
.ok_or_internal_error("Error looking up CORS rule")?,
|
|
_ => None,
|
|
};
|
|
|
|
let resp = match endpoint {
|
|
Endpoint::DeleteItem {
|
|
partition_key,
|
|
sort_key,
|
|
} => handle_delete_item(garage, req, bucket_id, &partition_key, &sort_key).await,
|
|
Endpoint::InsertItem {
|
|
partition_key,
|
|
sort_key,
|
|
} => handle_insert_item(garage, req, bucket_id, &partition_key, &sort_key).await,
|
|
Endpoint::ReadItem {
|
|
partition_key,
|
|
sort_key,
|
|
} => handle_read_item(garage, &req, bucket_id, &partition_key, &sort_key).await,
|
|
Endpoint::PollItem {
|
|
partition_key,
|
|
sort_key,
|
|
causality_token,
|
|
timeout,
|
|
} => {
|
|
handle_poll_item(
|
|
garage,
|
|
&req,
|
|
bucket_id,
|
|
partition_key,
|
|
sort_key,
|
|
causality_token,
|
|
timeout,
|
|
)
|
|
.await
|
|
}
|
|
Endpoint::ReadIndex {
|
|
prefix,
|
|
start,
|
|
end,
|
|
limit,
|
|
reverse,
|
|
} => handle_read_index(garage, bucket_id, prefix, start, end, limit, reverse).await,
|
|
Endpoint::InsertBatch {} => handle_insert_batch(garage, bucket_id, req).await,
|
|
Endpoint::ReadBatch {} => handle_read_batch(garage, bucket_id, req).await,
|
|
Endpoint::DeleteBatch {} => handle_delete_batch(garage, bucket_id, req).await,
|
|
Endpoint::Options => unreachable!(),
|
|
};
|
|
|
|
// If request was a success and we have a CORS rule that applies to it,
|
|
// add the corresponding CORS headers to the response
|
|
let mut resp_ok = resp?;
|
|
if let Some(rule) = matching_cors_rule {
|
|
add_cors_headers(&mut resp_ok, rule)
|
|
.ok_or_internal_error("Invalid bucket CORS configuration")?;
|
|
}
|
|
|
|
Ok(resp_ok)
|
|
}
|
|
}
|
|
|
|
impl ApiEndpoint for K2VApiEndpoint {
|
|
fn name(&self) -> &'static str {
|
|
self.endpoint.name()
|
|
}
|
|
|
|
fn add_span_attributes(&self, span: SpanRef<'_>) {
|
|
span.set_attribute(KeyValue::new("bucket", self.bucket_name.clone()));
|
|
}
|
|
}
|