tower_http/auth/add_authorization.rs
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 257 258 259 260 261 262 263 264 265 266 267
//! Add authorization to requests using the [`Authorization`] header.
//!
//! [`Authorization`]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization
//!
//! # Example
//!
//! ```
//! use tower_http::validate_request::{ValidateRequestHeader, ValidateRequestHeaderLayer};
//! use tower_http::auth::AddAuthorizationLayer;
//! use http::{Request, Response, StatusCode, header::AUTHORIZATION};
//! use tower::{Service, ServiceExt, ServiceBuilder, service_fn, BoxError};
//! use http_body_util::Full;
//! use bytes::Bytes;
//! # async fn handle(request: Request<Full<Bytes>>) -> Result<Response<Full<Bytes>>, BoxError> {
//! # Ok(Response::new(Full::default()))
//! # }
//!
//! # #[tokio::main]
//! # async fn main() -> Result<(), BoxError> {
//! # let service_that_requires_auth = ValidateRequestHeader::basic(
//! # tower::service_fn(handle),
//! # "username",
//! # "password",
//! # );
//! let mut client = ServiceBuilder::new()
//! // Use basic auth with the given username and password
//! .layer(AddAuthorizationLayer::basic("username", "password"))
//! .service(service_that_requires_auth);
//!
//! // Make a request, we don't have to add the `Authorization` header manually
//! let response = client
//! .ready()
//! .await?
//! .call(Request::new(Full::default()))
//! .await?;
//!
//! assert_eq!(StatusCode::OK, response.status());
//! # Ok(())
//! # }
//! ```
use base64::Engine as _;
use http::{HeaderValue, Request, Response};
use std::{
convert::TryFrom,
task::{Context, Poll},
};
use tower_layer::Layer;
use tower_service::Service;
const BASE64: base64::engine::GeneralPurpose = base64::engine::general_purpose::STANDARD;
/// Layer that applies [`AddAuthorization`] which adds authorization to all requests using the
/// [`Authorization`] header.
///
/// See the [module docs](crate::auth::add_authorization) for an example.
///
/// You can also use [`SetRequestHeader`] if you have a use case that isn't supported by this
/// middleware.
///
/// [`Authorization`]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization
/// [`SetRequestHeader`]: crate::set_header::SetRequestHeader
#[derive(Debug, Clone)]
pub struct AddAuthorizationLayer {
value: HeaderValue,
}
impl AddAuthorizationLayer {
/// Authorize requests using a username and password pair.
///
/// The `Authorization` header will be set to `Basic {credentials}` where `credentials` is
/// `base64_encode("{username}:{password}")`.
///
/// Since the username and password is sent in clear text it is recommended to use HTTPS/TLS
/// with this method. However use of HTTPS/TLS is not enforced by this middleware.
pub fn basic(username: &str, password: &str) -> Self {
let encoded = BASE64.encode(format!("{}:{}", username, password));
let value = HeaderValue::try_from(format!("Basic {}", encoded)).unwrap();
Self { value }
}
/// Authorize requests using a "bearer token". Commonly used for OAuth 2.
///
/// The `Authorization` header will be set to `Bearer {token}`.
///
/// # Panics
///
/// Panics if the token is not a valid [`HeaderValue`].
pub fn bearer(token: &str) -> Self {
let value =
HeaderValue::try_from(format!("Bearer {}", token)).expect("token is not valid header");
Self { value }
}
/// Mark the header as [sensitive].
///
/// This can for example be used to hide the header value from logs.
///
/// [sensitive]: https://docs.rs/http/latest/http/header/struct.HeaderValue.html#method.set_sensitive
#[allow(clippy::wrong_self_convention)]
pub fn as_sensitive(mut self, sensitive: bool) -> Self {
self.value.set_sensitive(sensitive);
self
}
}
impl<S> Layer<S> for AddAuthorizationLayer {
type Service = AddAuthorization<S>;
fn layer(&self, inner: S) -> Self::Service {
AddAuthorization {
inner,
value: self.value.clone(),
}
}
}
/// Middleware that adds authorization all requests using the [`Authorization`] header.
///
/// See the [module docs](crate::auth::add_authorization) for an example.
///
/// You can also use [`SetRequestHeader`] if you have a use case that isn't supported by this
/// middleware.
///
/// [`Authorization`]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization
/// [`SetRequestHeader`]: crate::set_header::SetRequestHeader
#[derive(Debug, Clone)]
pub struct AddAuthorization<S> {
inner: S,
value: HeaderValue,
}
impl<S> AddAuthorization<S> {
/// Authorize requests using a username and password pair.
///
/// The `Authorization` header will be set to `Basic {credentials}` where `credentials` is
/// `base64_encode("{username}:{password}")`.
///
/// Since the username and password is sent in clear text it is recommended to use HTTPS/TLS
/// with this method. However use of HTTPS/TLS is not enforced by this middleware.
pub fn basic(inner: S, username: &str, password: &str) -> Self {
AddAuthorizationLayer::basic(username, password).layer(inner)
}
/// Authorize requests using a "bearer token". Commonly used for OAuth 2.
///
/// The `Authorization` header will be set to `Bearer {token}`.
///
/// # Panics
///
/// Panics if the token is not a valid [`HeaderValue`].
pub fn bearer(inner: S, token: &str) -> Self {
AddAuthorizationLayer::bearer(token).layer(inner)
}
define_inner_service_accessors!();
/// Mark the header as [sensitive].
///
/// This can for example be used to hide the header value from logs.
///
/// [sensitive]: https://docs.rs/http/latest/http/header/struct.HeaderValue.html#method.set_sensitive
#[allow(clippy::wrong_self_convention)]
pub fn as_sensitive(mut self, sensitive: bool) -> Self {
self.value.set_sensitive(sensitive);
self
}
}
impl<S, ReqBody, ResBody> Service<Request<ReqBody>> for AddAuthorization<S>
where
S: Service<Request<ReqBody>, Response = Response<ResBody>>,
{
type Response = S::Response;
type Error = S::Error;
type Future = S::Future;
fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
self.inner.poll_ready(cx)
}
fn call(&mut self, mut req: Request<ReqBody>) -> Self::Future {
req.headers_mut()
.insert(http::header::AUTHORIZATION, self.value.clone());
self.inner.call(req)
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::test_helpers::Body;
use crate::validate_request::ValidateRequestHeaderLayer;
use http::{Response, StatusCode};
use std::convert::Infallible;
use tower::{BoxError, Service, ServiceBuilder, ServiceExt};
#[tokio::test]
async fn basic() {
// service that requires auth for all requests
let svc = ServiceBuilder::new()
.layer(ValidateRequestHeaderLayer::basic("foo", "bar"))
.service_fn(echo);
// make a client that adds auth
let mut client = AddAuthorization::basic(svc, "foo", "bar");
let res = client
.ready()
.await
.unwrap()
.call(Request::new(Body::empty()))
.await
.unwrap();
assert_eq!(res.status(), StatusCode::OK);
}
#[tokio::test]
async fn token() {
// service that requires auth for all requests
let svc = ServiceBuilder::new()
.layer(ValidateRequestHeaderLayer::bearer("foo"))
.service_fn(echo);
// make a client that adds auth
let mut client = AddAuthorization::bearer(svc, "foo");
let res = client
.ready()
.await
.unwrap()
.call(Request::new(Body::empty()))
.await
.unwrap();
assert_eq!(res.status(), StatusCode::OK);
}
#[tokio::test]
async fn making_header_sensitive() {
let svc = ServiceBuilder::new()
.layer(ValidateRequestHeaderLayer::bearer("foo"))
.service_fn(|request: Request<Body>| async move {
let auth = request.headers().get(http::header::AUTHORIZATION).unwrap();
assert!(auth.is_sensitive());
Ok::<_, Infallible>(Response::new(Body::empty()))
});
let mut client = AddAuthorization::bearer(svc, "foo").as_sensitive(true);
let res = client
.ready()
.await
.unwrap()
.call(Request::new(Body::empty()))
.await
.unwrap();
assert_eq!(res.status(), StatusCode::OK);
}
async fn echo(req: Request<Body>) -> Result<Response<Body>, BoxError> {
Ok(Response::new(req.into_body()))
}
}