garage-unix-socket/src/api/api_server.rs

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

use futures::future::Future;
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_copy::*;
use crate::s3_delete::*;
use crate::s3_get::*;
use crate::s3_list::*;
use crate::s3_put::*;

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 (bucket, key) = parse_bucket_key(path.as_str())?;
	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."
		)));
	}

	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 let Some(key) = key {
		match req.method() {
			&Method::HEAD => {
				// HeadObject query
				Ok(handle_head(garage, &bucket, &key).await?)
			}
			&Method::GET => {
				// GetObject query
				Ok(handle_get(garage, &bucket, &key).await?)
			}
			&Method::PUT => {
				if params.contains_key(&"partnumber".to_string())
					&& params.contains_key(&"uploadid".to_string())
				{
					// UploadPart query
					let part_number = params.get("partnumber").unwrap();
					let upload_id = params.get("uploadid").unwrap();
					Ok(handle_put_part(garage, req, &bucket, &key, part_number, upload_id).await?)
				} else if req.headers().contains_key("x-amz-copy-source") {
					// CopyObject query
					let copy_source = req.headers().get("x-amz-copy-source").unwrap().to_str()?;
					let (source_bucket, source_key) = parse_bucket_key(copy_source)?;
					if !api_key.allow_read(&source_bucket) {
						return Err(Error::Forbidden(format!(
							"Reading from bucket {} not allowed for this key",
							source_bucket
						)));
					}
					let source_key = match source_key {
						None => return Err(Error::BadRequest(format!("No source key specified"))),
						Some(x) => x,
					};
					Ok(handle_copy(garage, &bucket, &key, &source_bucket, &source_key).await?)
				} else {
					// PutObject query
					Ok(handle_put(garage, req, &bucket, &key).await?)
				}
			}
			&Method::DELETE => {
				if params.contains_key(&"uploadid".to_string()) {
					// AbortMultipartUpload query
					let upload_id = params.get("uploadid").unwrap();
					Ok(handle_abort_multipart_upload(garage, &bucket, &key, upload_id).await?)
				} else {
					// DeleteObject query
					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))))
				}
			}
			&Method::POST => {
				if params.contains_key(&"uploads".to_string()) {
					// CreateMultipartUpload call
					Ok(handle_create_multipart_upload(garage, &req, &bucket, &key).await?)
				} else if params.contains_key(&"uploadid".to_string()) {
					// CompleteMultipartUpload call
					let upload_id = params.get("uploadid").unwrap();
					Ok(
						handle_complete_multipart_upload(garage, req, &bucket, &key, upload_id)
							.await?,
					)
				} else {
					Err(Error::BadRequest(format!(
						"Not a CreateMultipartUpload call, what is it?"
					)))
				}
			}
			_ => Err(Error::BadRequest(format!("Invalid method"))),
		}
	} else {
		match req.method() {
			&Method::PUT | &Method::HEAD => {
				// If PUT: CreateBucket, if HEAD: HeadBucket
				// 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 => {
				// DeleteBucket query
				Err(Error::Forbidden(
					"Cannot delete buckets using S3 api, please talk to Garage directly".into(),
				))
			}
			&Method::GET => {
				if params.contains_key(&"prefix".to_string()) {
					// ListObjects query
					let delimiter = params.get("delimiter").map(|x| x.as_str()).unwrap_or(&"");
					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();
					let urlencode_resp = params
						.get("encoding-type")
						.map(|x| x == "url")
						.unwrap_or(false);
					let marker = params.get("marker").map(String::as_str);
					Ok(handle_list(
						garage,
						bucket,
						delimiter,
						max_keys,
						prefix,
						marker,
						urlencode_resp,
					)
					.await?)
				} else {
					Err(Error::BadRequest(format!(
						"Not a list call, so what is it?"
					)))
				}
			}
			_ => Err(Error::BadRequest(format!("Invalid method"))),
		}
	}
}

fn parse_bucket_key(path: &str) -> Result<(&str, Option<&str>), Error> {
	if !path.starts_with('/') {
		return Err(Error::BadRequest(format!(
			"Invalid path: {}, should start with a /",
			path
		)));
	}
	let path = &path[1..];

	match path.find('/') {
		Some(i) => Ok((&path[..i], Some(&path[i + 1..]))),
		None => Ok((path, None)),
	}
}
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;`
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
Work on API 2020-04-28 10:18:14 +00:00			`use crate::s3_copy::*;`
			`use crate::s3_delete::*;`
Implement multipart uploads 2020-04-26 20:39:32 +00:00			`use crate::s3_get::*;`
			`use crate::s3_list::*;`
			`use crate::s3_put::*;`
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();`
Work on API 2020-04-28 10:18:14 +00:00			`let (bucket, key) = parse_bucket_key(path.as_str())?;`
Starting to be S3 compatible 2020-04-24 17:46:52 +00:00			`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."`
			`)));`
			`}`

Implement multipart uploads 2020-04-26 20:39:32 +00:00			`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());`
			`}`
			`}`

Starting to be S3 compatible 2020-04-24 17:46:52 +00:00			`if let Some(key) = key {`
			`match req.method() {`
Implement multipart uploads 2020-04-26 20:39:32 +00:00			`&Method::HEAD => {`
			`// HeadObject query`
			`Ok(handle_head(garage, &bucket, &key).await?)`
			`}`
			`&Method::GET => {`
			`// GetObject query`
			`Ok(handle_get(garage, &bucket, &key).await?)`
			`}`
Starting to be S3 compatible 2020-04-24 17:46:52 +00:00			`&Method::PUT => {`
Work on API 2020-04-28 10:18:14 +00:00			`if params.contains_key(&"partnumber".to_string())`
			`&& params.contains_key(&"uploadid".to_string())`
Implement multipart uploads 2020-04-26 20:39:32 +00:00			`{`
Abort multipart upload 2020-04-26 20:46:21 +00:00			`// UploadPart query`
Implement multipart uploads 2020-04-26 20:39:32 +00:00			`let part_number = params.get("partnumber").unwrap();`
			`let upload_id = params.get("uploadid").unwrap();`
			`Ok(handle_put_part(garage, req, &bucket, &key, part_number, upload_id).await?)`
Work on API 2020-04-28 10:18:14 +00:00			`} else if req.headers().contains_key("x-amz-copy-source") {`
			`// CopyObject query`
			`let copy_source = req.headers().get("x-amz-copy-source").unwrap().to_str()?;`
			`let (source_bucket, source_key) = parse_bucket_key(copy_source)?;`
			`if !api_key.allow_read(&source_bucket) {`
			`return Err(Error::Forbidden(format!(`
			`"Reading from bucket {} not allowed for this key",`
			`source_bucket`
			`)));`
			`}`
			`let source_key = match source_key {`
			`None => return Err(Error::BadRequest(format!("No source key specified"))),`
			`Some(x) => x,`
			`};`
			`Ok(handle_copy(garage, &bucket, &key, &source_bucket, &source_key).await?)`
Implement multipart uploads 2020-04-26 20:39:32 +00:00			`} else {`
			`// PutObject query`
			`Ok(handle_put(garage, req, &bucket, &key).await?)`
			`}`
Starting to be S3 compatible 2020-04-24 17:46:52 +00:00			`}`
			`&Method::DELETE => {`
Abort multipart upload 2020-04-26 20:46:21 +00:00			`if params.contains_key(&"uploadid".to_string()) {`
			`// AbortMultipartUpload query`
			`let upload_id = params.get("uploadid").unwrap();`
			`Ok(handle_abort_multipart_upload(garage, &bucket, &key, upload_id).await?)`
			`} else {`
			`// DeleteObject query`
			`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))))`
			`}`
Starting to be S3 compatible 2020-04-24 17:46:52 +00:00			`}`
Implement multipart uploads 2020-04-26 20:39:32 +00:00			`&Method::POST => {`
			`if params.contains_key(&"uploads".to_string()) {`
			`// CreateMultipartUpload call`
			`Ok(handle_create_multipart_upload(garage, &req, &bucket, &key).await?)`
			`} else if params.contains_key(&"uploadid".to_string()) {`
Abort multipart upload 2020-04-26 20:46:21 +00:00			`// CompleteMultipartUpload call`
Implement multipart uploads 2020-04-26 20:39:32 +00:00			`let upload_id = params.get("uploadid").unwrap();`
Work on API 2020-04-28 10:18:14 +00:00			`Ok(`
			`handle_complete_multipart_upload(garage, req, &bucket, &key, upload_id)`
			`.await?,`
			`)`
Implement multipart uploads 2020-04-26 20:39:32 +00:00			`} else {`
			`Err(Error::BadRequest(format!(`
			`"Not a CreateMultipartUpload call, what is it?"`
			`)))`
			`}`
			`}`
Starting to be S3 compatible 2020-04-24 17:46:52 +00:00			`_ => 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 => {`
Implement multipart uploads 2020-04-26 20:39:32 +00:00			`// If PUT: CreateBucket, if HEAD: HeadBucket`
S3 compatibility: fix bucket listing and HEAD and PUT on bucket 2020-04-26 16:22:33 +00:00			`// 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)`
Prepare for multipart uploads 2020-04-26 18:55:13 +00:00			`}`
Implement multipart uploads 2020-04-26 20:39:32 +00:00			`&Method::DELETE => {`
			`// DeleteBucket query`
			`Err(Error::Forbidden(`
			`"Cannot delete buckets using S3 api, please talk to Garage directly".into(),`
			`))`
			`}`
Some basic S3 functionnality 2020-04-24 18:47:11 +00:00			`&Method::GET => {`
Work on API 2020-04-28 10:18:14 +00:00			`if params.contains_key(&"prefix".to_string()) {`
Implement multipart uploads 2020-04-26 20:39:32 +00:00			`// ListObjects query`
Work on API 2020-04-28 10:18:14 +00:00			`let delimiter = params.get("delimiter").map(\|x\| x.as_str()).unwrap_or(&"");`
Some basic S3 functionnality 2020-04-24 18:47:11 +00:00			`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();`
Work on API 2020-04-28 10:18:14 +00:00			`let urlencode_resp = params`
			`.get("encoding-type")`
			`.map(\|x\| x == "url")`
			`.unwrap_or(false);`
			`let marker = params.get("marker").map(String::as_str);`
			`Ok(handle_list(`
			`garage,`
			`bucket,`
			`delimiter,`
			`max_keys,`
			`prefix,`
			`marker,`
			`urlencode_resp,`
			`)`
			`.await?)`
Some basic S3 functionnality 2020-04-24 18:47:11 +00:00			`} 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			`}`
			`}`
			`}`
Work on API 2020-04-28 10:18:14 +00:00
			`fn parse_bucket_key(path: &str) -> Result<(&str, Option<&str>), Error> {`
			`if !path.starts_with('/') {`
			`return Err(Error::BadRequest(format!(`
			`"Invalid path: {}, should start with a /",`
			`path`
			`)));`
			`}`
			`let path = &path[1..];`

			`match path.find('/') {`
			`Some(i) => Ok((&path[..i], Some(&path[i + 1..]))),`
			`None => Ok((path, None)),`
			`}`
			`}`