aboutsummaryrefslogtreecommitdiff
path: root/src/web/web_server.rs
blob: 80d2feb9c0ef944910e20cc1dbcbabc24febffba (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
use std::{borrow::Cow, convert::Infallible, net::SocketAddr, sync::Arc};

use futures::future::Future;

use hyper::{
	header::{HeaderValue, HOST},
	server::conn::AddrStream,
	service::{make_service_fn, service_fn},
	Body, Method, Request, Response, Server,
};

use crate::error::*;

use garage_api::error::{Error as ApiError, OkOrBadRequest, OkOrInternalError};
use garage_api::helpers::{authority_to_host, host_to_bucket};
use garage_api::s3_cors::{add_cors_headers, find_matching_cors_rule, handle_options_for_bucket};
use garage_api::s3_get::{handle_get, handle_head};

use garage_model::garage::Garage;

use garage_table::*;
use garage_util::error::Error as GarageError;

/// Run a web server
pub async fn run_web_server(
	garage: Arc<Garage>,
	shutdown_signal: impl Future<Output = ()>,
) -> Result<(), GarageError> {
	let addr = &garage.config.s3_web.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();
				handle_request(garage, req, client_addr)
			}))
		}
	});

	let server = Server::bind(addr).serve(service);
	let graceful = server.with_graceful_shutdown(shutdown_signal);
	info!("Web server listening on http://{}", addr);

	graceful.await?;
	Ok(())
}

async fn handle_request(
	garage: Arc<Garage>,
	req: Request<Body>,
	addr: SocketAddr,
) -> Result<Response<Body>, Infallible> {
	info!("{} {} {}", addr, req.method(), req.uri());
	match serve_file(garage, &req).await {
		Ok(res) => {
			debug!("{} {} {}", req.method(), req.uri(), res.status());
			Ok(res)
		}
		Err(error) => {
			info!(
				"{} {} {} {}",
				req.method(),
				req.uri(),
				error.http_status_code(),
				error
			);
			Ok(error_to_res(error))
		}
	}
}

fn error_to_res(e: Error) -> Response<Body> {
	// If we are here, it is either that:
	// - there was an error before trying to get the requested URL
	//   from the bucket (e.g. bucket not found)
	// - there was an error processing the request and (the request
	//   was a HEAD request or we couldn't get the error document)
	// We do NOT enter this code path when returning the bucket's
	// error document (this is handled in serve_file)
	let body = Body::from(format!("{}\n", e));
	let mut http_error = Response::new(body);
	*http_error.status_mut() = e.http_status_code();
	e.add_headers(http_error.headers_mut());
	http_error
}

async fn serve_file(garage: Arc<Garage>, req: &Request<Body>) -> Result<Response<Body>, Error> {
	// Get http authority string (eg. [::1]:3902 or garage.tld:80)
	let authority = req
		.headers()
		.get(HOST)
		.ok_or_bad_request("HOST header required")?
		.to_str()?;

	// Get bucket
	let host = authority_to_host(authority)?;
	let root = &garage.config.s3_web.root_domain;

	let bucket_name = host_to_bucket(&host, root).unwrap_or(&host);
	let bucket_id = garage
		.bucket_alias_table
		.get(&EmptyKey, &bucket_name.to_string())
		.await?
		.map(|x| x.state.take())
		.flatten()
		.ok_or(Error::NotFound)?;

	// Check bucket isn't deleted and has website access enabled
	let bucket = garage
		.bucket_table
		.get(&EmptyKey, &bucket_id)
		.await?
		.ok_or(Error::NotFound)?;

	let website_config = bucket
		.params()
		.ok_or(Error::NotFound)?
		.website_config
		.get()
		.as_ref()
		.ok_or(Error::NotFound)?;

	// Get path
	let path = req.uri().path().to_string();
	let index = &website_config.index_document;
	let key = path_to_key(&path, index)?;

	debug!(
		"Selected bucket: \"{}\" {:?}, selected key: \"{}\"",
		bucket_name, bucket_id, key
	);

	let ret_doc = match *req.method() {
		Method::OPTIONS => handle_options_for_bucket(req, &bucket),
		Method::HEAD => handle_head(garage.clone(), req, bucket_id, &key, None).await,
		Method::GET => handle_get(garage.clone(), req, bucket_id, &key, None).await,
		_ => Err(ApiError::BadRequest("HTTP method not supported".into())),
	}
	.map_err(Error::from);

	match ret_doc {
		Err(error) => {
			// For a HEAD or OPTIONS method, and for non-4xx errors,
			// we don't return the error document as content,
			// we return above and just return the error message
			// by relying on err_to_res that is called when we return an Err.
			if *req.method() == Method::HEAD
				|| *req.method() == Method::OPTIONS
				|| !error.http_status_code().is_client_error()
			{
				return Err(error);
			}

			// If no error document is set: just return the error directly
			let error_document = match &website_config.error_document {
				Some(ed) => ed.trim_start_matches('/').to_owned(),
				None => return Err(error),
			};

			// We want to return the error document
			// Create a fake HTTP request with path = the error document
			let req2 = Request::builder()
				.uri(format!("http://{}/{}", host, &error_document))
				.body(Body::empty())
				.unwrap();

			match handle_get(garage, &req2, bucket_id, &error_document, None).await {
				Ok(mut error_doc) => {
					// The error won't be logged back in handle_request,
					// so log it here
					info!(
						"{} {} {} {}",
						req.method(),
						req.uri(),
						error.http_status_code(),
						error
					);

					*error_doc.status_mut() = error.http_status_code();
					error.add_headers(error_doc.headers_mut());

					// Preserve error message in a special header
					for error_line in error.to_string().split('\n') {
						if let Ok(v) = HeaderValue::from_bytes(error_line.as_bytes()) {
							error_doc.headers_mut().append("X-Garage-Error", v);
						}
					}

					Ok(error_doc)
				}
				Err(error_doc_error) => {
					warn!(
						"Couldn't get error document {} for bucket {:?}: {}",
						error_document, bucket_id, error_doc_error
					);
					Err(error)
				}
			}
		}
		Ok(mut resp) => {
			// Maybe add CORS headers
			if let Some(rule) = find_matching_cors_rule(&bucket, req)? {
				add_cors_headers(&mut resp, rule)
					.ok_or_internal_error("Invalid bucket CORS configuration")?;
			}
			Ok(resp)
		}
	}
}

/// Path to key
///
/// Convert the provided path to the internal key
/// When a path ends with "/", we append the index name to match traditional web server behavior
/// which is also AWS S3 behavior.
fn path_to_key<'a>(path: &'a str, index: &str) -> Result<Cow<'a, str>, Error> {
	let path_utf8 = percent_encoding::percent_decode_str(path).decode_utf8()?;

	if !path_utf8.starts_with('/') {
		return Err(Error::BadRequest(
			"Path must start with a / (slash)".to_string(),
		));
	}

	match path_utf8.chars().last() {
		None => unreachable!(),
		Some('/') => {
			let mut key = String::with_capacity(path_utf8.len() + index.len());
			key.push_str(&path_utf8[1..]);
			key.push_str(index);
			Ok(key.into())
		}
		Some(_) => match path_utf8 {
			Cow::Borrowed(pu8) => Ok((&pu8[1..]).into()),
			Cow::Owned(pu8) => Ok((&pu8[1..]).to_string().into()),
		},
	}
}

#[cfg(test)]
mod tests {
	use super::*;

	#[test]
	fn path_to_key_test() -> Result<(), Error> {
		assert_eq!(path_to_key("/file%20.jpg", "index.html")?, "file .jpg");
		assert_eq!(path_to_key("/%20t/", "index.html")?, " t/index.html");
		assert_eq!(path_to_key("/", "index.html")?, "index.html");
		assert_eq!(path_to_key("/hello", "index.html")?, "hello");
		assert!(path_to_key("", "index.html").is_err());
		assert!(path_to_key("i/am/relative", "index.html").is_err());
		Ok(())
	}
}