garage/src/api/api_server.rs

use std::collections::HashMap;
use std::net::SocketAddr;
use std::sync::Arc;

use futures::future::Future;
use hyper::body::{Bytes, HttpBody};
use hyper::server::conn::AddrStream;
use hyper::service::{make_service_fn, service_fn};
use hyper::{Body, Method, Request, Response, Server};

use garage_util::error::Error;

use garage_core::garage::Garage;

use crate::http_util::*;
use crate::signature::check_signature;

use crate::s3_get::{handle_get, handle_head};
use crate::s3_list::handle_list;
use crate::s3_put::{handle_delete, handle_put};

pub type BodyType = Box<dyn HttpBody<Data = Bytes, Error = Error> + Send + Unpin>;

pub async fn run_api_server(
	garage: Arc<Garage>,
	shutdown_signal: impl Future<Output = ()>,
) -> Result<(), Error> {
	let addr = &garage.config.s3_api.api_bind_addr;

	let service = make_service_fn(|conn: &AddrStream| {
		let garage = garage.clone();
		let client_addr = conn.remote_addr();
		async move {
			Ok::<_, Error>(service_fn(move |req: Request<Body>| {
				let garage = garage.clone();
				handler(garage, req, client_addr)
			}))
		}
	});

	let server = Server::bind(&addr).serve(service);

	let graceful = server.with_graceful_shutdown(shutdown_signal);
	info!("API server listening on http://{}", addr);

	graceful.await?;
	Ok(())
}

async fn handler(
	garage: Arc<Garage>,
	req: Request<Body>,
	addr: SocketAddr,
) -> Result<Response<BodyType>, Error> {
	info!("{} {} {}", addr, req.method(), req.uri());
	debug!("{:?}", req);
	match handler_inner(garage, req).await {
		Ok(x) => {
			debug!("{} {:?}", x.status(), x.headers());
			Ok(x)
		}
		Err(e) => {
			let body: BodyType = Box::new(BytesBody::from(format!("{}\n", e)));
			let mut http_error = Response::new(body);
			*http_error.status_mut() = e.http_status_code();
			warn!("Response: error {}, {}", e.http_status_code(), e);
			Ok(http_error)
		}
	}
}

async fn handler_inner(
	garage: Arc<Garage>,
	req: Request<Body>,
) -> Result<Response<BodyType>, Error> {
	let path = req.uri().path().to_string();
	let path = path.trim_start_matches('/');
	let (bucket, key) = match path.find('/') {
		Some(i) => {
			let (bucket, key) = path.split_at(i);
			let key = key.trim_start_matches('/');
			(bucket, Some(key))
		}
		None => (path, None),
	};
	if bucket.len() == 0 {
		return Err(Error::Forbidden(format!(
			"Operations on buckets not allowed"
		)));
	}

	let api_key = check_signature(&garage, &req).await?;
	let allowed = match req.method() {
		&Method::HEAD | &Method::GET => api_key.allow_read(&bucket),
		_ => api_key.allow_write(&bucket),
	};
	if !allowed {
		return Err(Error::Forbidden(format!(
			"Operation is not allowed for this key."
		)));
	}

	if let Some(key) = key {
		match req.method() {
			&Method::HEAD => Ok(handle_head(garage, &bucket, &key).await?),
			&Method::GET => Ok(handle_get(garage, &bucket, &key).await?),
			&Method::PUT => {
				let mime_type = req
					.headers()
					.get(hyper::header::CONTENT_TYPE)
					.map(|x| x.to_str())
					.unwrap_or(Ok("blob"))?
					.to_string();
				let version_uuid =
					handle_put(garage, &mime_type, &bucket, &key, req.into_body()).await?;
				let response = format!("{}\n", hex::encode(version_uuid,));
				Ok(Response::new(Box::new(BytesBody::from(response))))
			}
			&Method::DELETE => {
				let version_uuid = handle_delete(garage, &bucket, &key).await?;
				let response = format!("{}\n", hex::encode(version_uuid,));
				Ok(Response::new(Box::new(BytesBody::from(response))))
			}
			_ => Err(Error::BadRequest(format!("Invalid method"))),
		}
	} else {
		match req.method() {
			&Method::PUT | &Method::HEAD => {
				// If PUT: corresponds to a bucket creation call
				// If we're here, the bucket already exists, so just answer ok
				let empty_body: BodyType = Box::new(BytesBody::from(vec![]));
				let response = Response::builder()
					.header("Location", format!("/{}", bucket))
					.body(empty_body)
					.unwrap();
				Ok(response)
			},
			&Method::DELETE => Err(Error::Forbidden(
				"Cannot delete buckets using S3 api, please talk to Garage directly"
					.into(),
			)),
			&Method::GET => {
				let mut params = HashMap::new();
				if let Some(query) = req.uri().query() {
					let query_pairs = url::form_urlencoded::parse(query.as_bytes());
					for (key, val) in query_pairs {
						params.insert(key.to_lowercase(), val.to_string());
					}
				}
				if ["delimiter", "prefix"]
					.iter()
					.all(|x| params.contains_key(&x.to_string()))
				{
					let delimiter = params.get("delimiter").unwrap();
					let max_keys = params
						.get("max-keys")
						.map(|x| {
							x.parse::<usize>().map_err(|e| {
								Error::BadRequest(format!("Invalid value for max-keys: {}", e))
							})
						})
						.unwrap_or(Ok(1000))?;
					let prefix = params.get("prefix").unwrap();
					Ok(handle_list(garage, bucket, delimiter, max_keys, prefix).await?)
				} else {
					Err(Error::BadRequest(format!(
						"Not a list call, so what is it?"
					)))
				}
			}
			_ => Err(Error::BadRequest(format!("Invalid method"))),
		}
	}
}
Some basic S3 functionnality 2020-04-24 18:47:11 +00:00			`use std::collections::HashMap;`
More aggressive sync timings & improve other stuff 2020-04-19 17:59:59 +00:00			`use std::net::SocketAddr;`
Fix the Sync issue. Details: So the HTTP client future of Hyper is not Sync, thus the stream that read blocks wasn't either. However Hyper's default Body type requires a stream to be Sync for wrap_stream. Solution: reimplement a custom HTTP body type. 2020-04-10 20:01:48 +00:00			`use std::sync::Arc;`
Some more basic work 2020-04-06 17:55:39 +00:00
Fix the Sync issue. Details: So the HTTP client future of Hyper is not Sync, thus the stream that read blocks wasn't either. However Hyper's default Body type requires a stream to be Sync for wrap_stream. Solution: reimplement a custom HTTP body type. 2020-04-10 20:01:48 +00:00			`use futures::future::Future;`
			`use hyper::body::{Bytes, HttpBody};`
Basic workflow for client PUT, next is do actual storage 2020-04-07 22:39:07 +00:00			`use hyper::server::conn::AddrStream;`
Fix the Sync issue. Details: So the HTTP client future of Hyper is not Sync, thus the stream that read blocks wasn't either. However Hyper's default Body type requires a stream to be Sync for wrap_stream. Solution: reimplement a custom HTTP body type. 2020-04-10 20:01:48 +00:00			`use hyper::service::{make_service_fn, service_fn};`
Some basic S3 functionnality 2020-04-24 18:47:11 +00:00			`use hyper::{Body, Method, Request, Response, Server};`
First commit: skeleton for something great 2020-04-05 21:33:42 +00:00
Split code for modular compilation 2020-04-24 10:10:01 +00:00			`use garage_util::error::Error;`
Reorganize code 2020-04-23 17:05:46 +00:00
Split code for modular compilation 2020-04-24 10:10:01 +00:00			`use garage_core::garage::Garage;`
Reorganize code 2020-04-23 17:05:46 +00:00
Split code for modular compilation 2020-04-24 10:10:01 +00:00			`use crate::http_util::*;`
Starting to be S3 compatible 2020-04-24 17:46:52 +00:00			`use crate::signature::check_signature;`
First commit: skeleton for something great 2020-04-05 21:33:42 +00:00
Some basic S3 functionnality 2020-04-24 18:47:11 +00:00			`use crate::s3_get::{handle_get, handle_head};`
			`use crate::s3_list::handle_list;`
			`use crate::s3_put::{handle_delete, handle_put};`

			`pub type BodyType = Box<dyn HttpBody<Data = Bytes, Error = Error> + Send + Unpin>;`
Fix the Sync issue. Details: So the HTTP client future of Hyper is not Sync, thus the stream that read blocks wasn't either. However Hyper's default Body type requires a stream to be Sync for wrap_stream. Solution: reimplement a custom HTTP body type. 2020-04-10 20:01:48 +00:00
			`pub async fn run_api_server(`
			`garage: Arc<Garage>,`
			`shutdown_signal: impl Future<Output = ()>,`
Background task runner that replaces tokio::spawn 2020-04-11 16:51:11 +00:00			`) -> Result<(), Error> {`
Starting to be S3 compatible 2020-04-24 17:46:52 +00:00			`let addr = &garage.config.s3_api.api_bind_addr;`
First commit: skeleton for something great 2020-04-05 21:33:42 +00:00
Fix the Sync issue. Details: So the HTTP client future of Hyper is not Sync, thus the stream that read blocks wasn't either. However Hyper's default Body type requires a stream to be Sync for wrap_stream. Solution: reimplement a custom HTTP body type. 2020-04-10 20:01:48 +00:00			`let service = make_service_fn(\|conn: &AddrStream\| {`
Some work in actually storing things 2020-04-08 20:00:41 +00:00			`let garage = garage.clone();`
Basic workflow for client PUT, next is do actual storage 2020-04-07 22:39:07 +00:00			`let client_addr = conn.remote_addr();`
Some more basic work 2020-04-06 17:55:39 +00:00			`async move {`
			`Ok::<_, Error>(service_fn(move \|req: Request<Body>\| {`
Some work in actually storing things 2020-04-08 20:00:41 +00:00			`let garage = garage.clone();`
			`handler(garage, req, client_addr)`
Some more basic work 2020-04-06 17:55:39 +00:00			`}))`
			`}`
			`});`
First commit: skeleton for something great 2020-04-05 21:33:42 +00:00
Fix the Sync issue. Details: So the HTTP client future of Hyper is not Sync, thus the stream that read blocks wasn't either. However Hyper's default Body type requires a stream to be Sync for wrap_stream. Solution: reimplement a custom HTTP body type. 2020-04-10 20:01:48 +00:00			`let server = Server::bind(&addr).serve(service);`
First commit: skeleton for something great 2020-04-05 21:33:42 +00:00
			`let graceful = server.with_graceful_shutdown(shutdown_signal);`
Pretty logging 2020-04-21 12:54:55 +00:00			`info!("API server listening on http://{}", addr);`
First commit: skeleton for something great 2020-04-05 21:33:42 +00:00
Background task runner that replaces tokio::spawn 2020-04-11 16:51:11 +00:00			`graceful.await?;`
			`Ok(())`
First commit: skeleton for something great 2020-04-05 21:33:42 +00:00			`}`
Basic workflow for client PUT, next is do actual storage 2020-04-07 22:39:07 +00:00
Fix the Sync issue. Details: So the HTTP client future of Hyper is not Sync, thus the stream that read blocks wasn't either. However Hyper's default Body type requires a stream to be Sync for wrap_stream. Solution: reimplement a custom HTTP body type. 2020-04-10 20:01:48 +00:00			`async fn handler(`
			`garage: Arc<Garage>,`
			`req: Request<Body>,`
			`addr: SocketAddr,`
			`) -> Result<Response<BodyType>, Error> {`
Starting to be S3 compatible 2020-04-24 17:46:52 +00:00			`info!("{} {} {}", addr, req.method(), req.uri());`
			`debug!("{:?}", req);`
			`match handler_inner(garage, req).await {`
			`Ok(x) => {`
			`debug!("{} {:?}", x.status(), x.headers());`
			`Ok(x)`
			`}`
Basic workflow for client PUT, next is do actual storage 2020-04-07 22:39:07 +00:00			`Err(e) => {`
Fix the Sync issue. Details: So the HTTP client future of Hyper is not Sync, thus the stream that read blocks wasn't either. However Hyper's default Body type requires a stream to be Sync for wrap_stream. Solution: reimplement a custom HTTP body type. 2020-04-10 20:01:48 +00:00			`let body: BodyType = Box::new(BytesBody::from(format!("{}\n", e)));`
			`let mut http_error = Response::new(body);`
Some progress 2020-04-09 15:32:28 +00:00			`*http_error.status_mut() = e.http_status_code();`
Starting to be S3 compatible 2020-04-24 17:46:52 +00:00			`warn!("Response: error {}, {}", e.http_status_code(), e);`
Some progress 2020-04-09 15:32:28 +00:00			`Ok(http_error)`
Basic workflow for client PUT, next is do actual storage 2020-04-07 22:39:07 +00:00			`}`
			`}`
			`}`

Fix the Sync issue. Details: So the HTTP client future of Hyper is not Sync, thus the stream that read blocks wasn't either. However Hyper's default Body type requires a stream to be Sync for wrap_stream. Solution: reimplement a custom HTTP body type. 2020-04-10 20:01:48 +00:00			`async fn handler_inner(`
			`garage: Arc<Garage>,`
			`req: Request<Body>,`
			`) -> Result<Response<BodyType>, Error> {`
Starting to be S3 compatible 2020-04-24 17:46:52 +00:00			`let path = req.uri().path().to_string();`
			`let path = path.trim_start_matches('/');`
			`let (bucket, key) = match path.find('/') {`
			`Some(i) => {`
			`let (bucket, key) = path.split_at(i);`
Remove leading / in keys; better delimiter handling 2020-04-24 20:28:15 +00:00			`let key = key.trim_start_matches('/');`
Starting to be S3 compatible 2020-04-24 17:46:52 +00:00			`(bucket, Some(key))`
Basic workflow for client PUT, next is do actual storage 2020-04-07 22:39:07 +00:00			`}`
Starting to be S3 compatible 2020-04-24 17:46:52 +00:00			`None => (path, None),`
			`};`
			`if bucket.len() == 0 {`
			`return Err(Error::Forbidden(format!(`
			`"Operations on buckets not allowed"`
			`)));`
			`}`

			`let api_key = check_signature(&garage, &req).await?;`
			`let allowed = match req.method() {`
			`&Method::HEAD \| &Method::GET => api_key.allow_read(&bucket),`
			`_ => api_key.allow_write(&bucket),`
			`};`
			`if !allowed {`
			`return Err(Error::Forbidden(format!(`
			`"Operation is not allowed for this key."`
			`)));`
			`}`

			`if let Some(key) = key {`
			`match req.method() {`
			`&Method::HEAD => Ok(handle_head(garage, &bucket, &key).await?),`
			`&Method::GET => Ok(handle_get(garage, &bucket, &key).await?),`
			`&Method::PUT => {`
			`let mime_type = req`
			`.headers()`
			`.get(hyper::header::CONTENT_TYPE)`
			`.map(\|x\| x.to_str())`
			`.unwrap_or(Ok("blob"))?`
			`.to_string();`
			`let version_uuid =`
			`handle_put(garage, &mime_type, &bucket, &key, req.into_body()).await?;`
			`let response = format!("{}\n", hex::encode(version_uuid,));`
			`Ok(Response::new(Box::new(BytesBody::from(response))))`
			`}`
			`&Method::DELETE => {`
			`let version_uuid = handle_delete(garage, &bucket, &key).await?;`
			`let response = format!("{}\n", hex::encode(version_uuid,));`
			`Ok(Response::new(Box::new(BytesBody::from(response))))`
			`}`
			`_ => Err(Error::BadRequest(format!("Invalid method"))),`
Background task runner that replaces tokio::spawn 2020-04-11 16:51:11 +00:00			`}`
Starting to be S3 compatible 2020-04-24 17:46:52 +00:00			`} else {`
Some basic S3 functionnality 2020-04-24 18:47:11 +00:00			`match req.method() {`
S3 compatibility: fix bucket listing and HEAD and PUT on bucket 2020-04-26 16:22:33 +00:00			`&Method::PUT \| &Method::HEAD => {`
			`// If PUT: corresponds to a bucket creation call`
			`// If we're here, the bucket already exists, so just answer ok`
			`let empty_body: BodyType = Box::new(BytesBody::from(vec![]));`
			`let response = Response::builder()`
			`.header("Location", format!("/{}", bucket))`
			`.body(empty_body)`
			`.unwrap();`
			`Ok(response)`
			`},`
			`&Method::DELETE => Err(Error::Forbidden(`
			`"Cannot delete buckets using S3 api, please talk to Garage directly"`
Some basic S3 functionnality 2020-04-24 18:47:11 +00:00			`.into(),`
			`)),`
			`&Method::GET => {`
			`let mut params = HashMap::new();`
			`if let Some(query) = req.uri().query() {`
			`let query_pairs = url::form_urlencoded::parse(query.as_bytes());`
			`for (key, val) in query_pairs {`
			`params.insert(key.to_lowercase(), val.to_string());`
			`}`
			`}`
			`if ["delimiter", "prefix"]`
			`.iter()`
			`.all(\|x\| params.contains_key(&x.to_string()))`
			`{`
			`let delimiter = params.get("delimiter").unwrap();`
			`let max_keys = params`
			`.get("max-keys")`
			`.map(\|x\| {`
			`x.parse::<usize>().map_err(\|e\| {`
			`Error::BadRequest(format!("Invalid value for max-keys: {}", e))`
			`})`
			`})`
			`.unwrap_or(Ok(1000))?;`
			`let prefix = params.get("prefix").unwrap();`
			`Ok(handle_list(garage, bucket, delimiter, max_keys, prefix).await?)`
			`} else {`
			`Err(Error::BadRequest(format!(`
			`"Not a list call, so what is it?"`
			`)))`
Do not insert deletion marker if there is no object to delete 2020-04-21 14:33:12 +00:00			`}`
			`}`
Some basic S3 functionnality 2020-04-24 18:47:11 +00:00			`_ => Err(Error::BadRequest(format!("Invalid method"))),`
Why is it not Sync?? 2020-04-09 21:45:07 +00:00			`}`
			`}`
			`}`