2017-07-14 03:03:45 +00:00
|
|
|
|
//! [![Build Status](https://travis-ci.org/lawliet89/rocket_cors.svg)](https://travis-ci.org/lawliet89/rocket_cors)
|
|
|
|
|
//! [![Dependency Status](https://dependencyci.com/github/lawliet89/rocket_cors/badge)](https://dependencyci.com/github/lawliet89/rocket_cors)
|
|
|
|
|
//! [![Repository](https://img.shields.io/github/tag/lawliet89/rocket_cors.svg)](https://github.com/lawliet89/rocket_cors)
|
|
|
|
|
//! <!-- [![Crates.io](https://img.shields.io/crates/v/rocket_cors.svg)](https://crates.io/crates/rocket_cors) -->
|
|
|
|
|
//! <!-- [![Documentation](https://docs.rs/rocket_cors/badge.svg)](https://docs.rs/rocket_cors) -->
|
2017-07-13 07:37:15 +00:00
|
|
|
|
//!
|
2017-07-14 03:03:45 +00:00
|
|
|
|
//! - Documentation: stable | [master branch](https://lawliet89.github.io/rocket_cors)
|
2017-07-13 07:37:15 +00:00
|
|
|
|
//!
|
2017-07-14 03:03:45 +00:00
|
|
|
|
//! Cross-origin resource sharing (CORS) for [Rocket](https://rocket.rs/) applications
|
|
|
|
|
//!
|
|
|
|
|
//! ## Requirements
|
|
|
|
|
//!
|
|
|
|
|
//! - Nightly Rust
|
|
|
|
|
//! - Rocket > 0.3
|
2017-07-13 07:37:15 +00:00
|
|
|
|
//!
|
2017-07-14 03:03:45 +00:00
|
|
|
|
//! ### Nightly Rust
|
2017-07-13 07:37:15 +00:00
|
|
|
|
//!
|
2017-07-14 03:03:45 +00:00
|
|
|
|
//! Rocket requires nightly Rust. You should probably install Rust with
|
|
|
|
|
//! [rustup](https://www.rustup.rs/), then override the code directory to use nightly instead of
|
|
|
|
|
//! stable. See
|
|
|
|
|
//! [installation instructions](https://rocket.rs/guide/getting-started/#installing-rust).
|
2017-07-13 07:37:15 +00:00
|
|
|
|
//!
|
2017-07-14 03:03:45 +00:00
|
|
|
|
//! In particular, `rocket_cors` is currently targetted for `nightly-2017-07-13`.
|
2017-07-13 07:37:15 +00:00
|
|
|
|
//!
|
2017-07-14 03:03:45 +00:00
|
|
|
|
//! ### Rocket > 0.3
|
2017-07-13 07:37:15 +00:00
|
|
|
|
//!
|
2017-07-14 03:03:45 +00:00
|
|
|
|
//! Rocket > 0.3 is needed. At this moment, `0.3` is not released, and this crate will not be
|
|
|
|
|
//! published
|
|
|
|
|
//! to Crates.io until Rocket 0.3 is released to Crates.io.
|
2017-07-13 07:37:15 +00:00
|
|
|
|
//!
|
2017-07-14 03:03:45 +00:00
|
|
|
|
//! We currently tie this crate to revision
|
|
|
|
|
//! [aa51fe0](https://github.com/SergioBenitez/Rocket/tree/aa51fe0) of Rocket.
|
2017-07-13 07:37:15 +00:00
|
|
|
|
//!
|
2017-07-14 03:03:45 +00:00
|
|
|
|
//! ## Installation
|
2017-07-13 07:37:15 +00:00
|
|
|
|
//!
|
2017-07-14 03:03:45 +00:00
|
|
|
|
//! <!-- Add the following to Cargo.toml:
|
2017-07-13 07:37:15 +00:00
|
|
|
|
//!
|
2017-07-14 03:03:45 +00:00
|
|
|
|
//! ```toml
|
|
|
|
|
//! rocket_cors = "0.0.6"
|
|
|
|
|
//! ``` -->
|
|
|
|
|
//!
|
|
|
|
|
//! To use the latest `master` branch, for example:
|
|
|
|
|
//!
|
|
|
|
|
//! ```toml
|
|
|
|
|
//! rocket_cors = { git = "https://github.com/lawliet89/rocket_cors", branch = "master" }
|
2017-07-13 07:37:15 +00:00
|
|
|
|
//! ```
|
2017-07-14 03:03:45 +00:00
|
|
|
|
//!
|
2017-07-13 07:37:15 +00:00
|
|
|
|
|
|
|
|
|
#![allow(
|
|
|
|
|
legacy_directory_ownership,
|
|
|
|
|
missing_copy_implementations,
|
|
|
|
|
missing_debug_implementations,
|
|
|
|
|
unknown_lints,
|
|
|
|
|
unsafe_code,
|
|
|
|
|
)]
|
|
|
|
|
#![deny(
|
|
|
|
|
const_err,
|
|
|
|
|
dead_code,
|
|
|
|
|
deprecated,
|
|
|
|
|
exceeding_bitshifts,
|
|
|
|
|
fat_ptr_transmutes,
|
|
|
|
|
improper_ctypes,
|
|
|
|
|
missing_docs,
|
|
|
|
|
mutable_transmutes,
|
|
|
|
|
no_mangle_const_items,
|
|
|
|
|
non_camel_case_types,
|
|
|
|
|
non_shorthand_field_patterns,
|
|
|
|
|
non_upper_case_globals,
|
|
|
|
|
overflowing_literals,
|
|
|
|
|
path_statements,
|
|
|
|
|
plugin_as_library,
|
|
|
|
|
private_no_mangle_fns,
|
|
|
|
|
private_no_mangle_statics,
|
|
|
|
|
stable_features,
|
|
|
|
|
trivial_casts,
|
|
|
|
|
trivial_numeric_casts,
|
|
|
|
|
unconditional_recursion,
|
|
|
|
|
unknown_crate_types,
|
|
|
|
|
unreachable_code,
|
|
|
|
|
unused_allocation,
|
|
|
|
|
unused_assignments,
|
|
|
|
|
unused_attributes,
|
|
|
|
|
unused_comparisons,
|
|
|
|
|
unused_extern_crates,
|
|
|
|
|
unused_features,
|
|
|
|
|
unused_imports,
|
|
|
|
|
unused_import_braces,
|
|
|
|
|
unused_qualifications,
|
|
|
|
|
unused_must_use,
|
|
|
|
|
unused_mut,
|
|
|
|
|
unused_parens,
|
|
|
|
|
unused_results,
|
|
|
|
|
unused_unsafe,
|
|
|
|
|
unused_variables,
|
|
|
|
|
variant_size_differences,
|
|
|
|
|
warnings,
|
|
|
|
|
while_true,
|
|
|
|
|
)]
|
|
|
|
|
|
|
|
|
|
#![cfg_attr(test, feature(plugin, custom_derive))]
|
|
|
|
|
#![cfg_attr(test, plugin(rocket_codegen))]
|
|
|
|
|
#![doc(test(attr(allow(unused_variables), deny(warnings))))]
|
|
|
|
|
|
|
|
|
|
#[macro_use]
|
|
|
|
|
extern crate log;
|
|
|
|
|
#[macro_use]
|
|
|
|
|
extern crate rocket;
|
2017-07-14 03:16:07 +00:00
|
|
|
|
// extern crate serde;
|
2017-07-13 07:37:15 +00:00
|
|
|
|
#[macro_use]
|
|
|
|
|
extern crate serde_derive;
|
|
|
|
|
extern crate unicase;
|
|
|
|
|
extern crate url;
|
|
|
|
|
extern crate url_serde;
|
|
|
|
|
|
|
|
|
|
#[cfg(test)]
|
|
|
|
|
extern crate hyper;
|
|
|
|
|
|
|
|
|
|
use std::collections::{HashSet, HashMap};
|
|
|
|
|
use std::error;
|
|
|
|
|
use std::fmt;
|
|
|
|
|
use std::ops::Deref;
|
|
|
|
|
use std::str::FromStr;
|
|
|
|
|
|
|
|
|
|
use rocket::request::{self, Request, FromRequest};
|
|
|
|
|
use rocket::response::{self, Responder};
|
|
|
|
|
use rocket::http::{Method, Status};
|
|
|
|
|
use rocket::Outcome;
|
|
|
|
|
use unicase::UniCase;
|
|
|
|
|
|
|
|
|
|
#[cfg(test)]
|
|
|
|
|
#[macro_use]
|
|
|
|
|
mod test_macros;
|
|
|
|
|
|
|
|
|
|
/// CORS related error
|
|
|
|
|
#[derive(Debug)]
|
|
|
|
|
pub enum Error {
|
|
|
|
|
/// The HTTP request header `Origin` is required but was not provided
|
|
|
|
|
MissingOrigin,
|
|
|
|
|
/// The HTTP request header `Origin` could not be parsed correctly.
|
|
|
|
|
BadOrigin(url::ParseError),
|
|
|
|
|
/// The request header `Access-Control-Request-Method` is required but is missing
|
|
|
|
|
MissingRequestMethod,
|
|
|
|
|
/// The request header `Access-Control-Request-Method` has an invalid value
|
|
|
|
|
BadRequestMethod(rocket::Error),
|
|
|
|
|
/// The request header `Access-Control-Request-Headers` is required but is missing.
|
|
|
|
|
MissingRequestHeaders,
|
|
|
|
|
/// Origin is not allowed to make this request
|
|
|
|
|
OriginNotAllowed,
|
|
|
|
|
/// Requested method is not allowed
|
|
|
|
|
MethodNotAllowed,
|
|
|
|
|
/// One or more headers requested are not allowed
|
|
|
|
|
HeadersNotAllowed,
|
2017-07-14 03:03:45 +00:00
|
|
|
|
/// Credentials are allowed, but the Origin is set to "*". This is not allowed by W3C
|
|
|
|
|
///
|
|
|
|
|
/// This is a misconfiguration. Check the docuemntation for `Options`.
|
|
|
|
|
CredentialsWithWildcardOrigin,
|
2017-07-13 07:37:15 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
impl error::Error for Error {
|
|
|
|
|
fn description(&self) -> &str {
|
|
|
|
|
match *self {
|
|
|
|
|
Error::MissingOrigin => "The request header `Origin` is required but is missing",
|
|
|
|
|
Error::BadOrigin(_) => "The request header `Origin` contains an invalid URL",
|
|
|
|
|
Error::MissingRequestMethod => {
|
|
|
|
|
"The request header `Access-Control-Request-Method` \
|
|
|
|
|
is required but is missing"
|
|
|
|
|
}
|
|
|
|
|
Error::BadRequestMethod(_) => {
|
|
|
|
|
"The request header `Access-Control-Request-Method` has an invalid value"
|
|
|
|
|
}
|
|
|
|
|
Error::MissingRequestHeaders => {
|
|
|
|
|
"The request header `Access-Control-Request-Headers` \
|
|
|
|
|
is required but is missing"
|
|
|
|
|
}
|
|
|
|
|
Error::OriginNotAllowed => "Origin is not allowed to request",
|
|
|
|
|
Error::MethodNotAllowed => "Method is not allowed",
|
|
|
|
|
Error::HeadersNotAllowed => "Headers are not allowed",
|
2017-07-14 03:03:45 +00:00
|
|
|
|
Error::CredentialsWithWildcardOrigin => {
|
|
|
|
|
"Credentials are allowed, but the Origin is set to \"*\". \
|
|
|
|
|
This is not allowed by W3C"
|
|
|
|
|
}
|
|
|
|
|
|
2017-07-13 07:37:15 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
fn cause(&self) -> Option<&error::Error> {
|
|
|
|
|
match *self {
|
|
|
|
|
Error::BadOrigin(ref e) => Some(e),
|
|
|
|
|
_ => Some(self),
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
impl fmt::Display for Error {
|
|
|
|
|
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
|
|
|
|
match *self {
|
|
|
|
|
Error::BadOrigin(ref e) => fmt::Display::fmt(e, f),
|
|
|
|
|
Error::BadRequestMethod(ref e) => fmt::Debug::fmt(e, f),
|
|
|
|
|
_ => write!(f, "{}", error::Error::description(self)),
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
impl<'r> Responder<'r> for Error {
|
|
|
|
|
fn respond_to(self, _: &Request) -> Result<response::Response<'r>, Status> {
|
|
|
|
|
error_!("CORS Error: {:?}", self);
|
|
|
|
|
Err(match self {
|
|
|
|
|
Error::MissingOrigin | Error::OriginNotAllowed | Error::MethodNotAllowed |
|
|
|
|
|
Error::HeadersNotAllowed => Status::Forbidden,
|
2017-07-14 03:03:45 +00:00
|
|
|
|
Error::CredentialsWithWildcardOrigin => Status::InternalServerError,
|
2017-07-13 07:37:15 +00:00
|
|
|
|
_ => Status::BadRequest,
|
|
|
|
|
})
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// A wrapped `url::Url` to allow for deserialization
|
|
|
|
|
#[derive(Eq, PartialEq, Clone, Hash, Debug, Serialize, Deserialize)]
|
|
|
|
|
pub struct Url(
|
|
|
|
|
#[serde(with = "url_serde")]
|
|
|
|
|
url::Url
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
impl fmt::Display for Url {
|
|
|
|
|
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
|
|
|
|
self.0.fmt(f)
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
impl Deref for Url {
|
|
|
|
|
type Target = url::Url;
|
|
|
|
|
|
|
|
|
|
fn deref(&self) -> &Self::Target {
|
|
|
|
|
&self.0
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
impl FromStr for Url {
|
|
|
|
|
type Err = url::ParseError;
|
|
|
|
|
|
|
|
|
|
fn from_str(input: &str) -> Result<Self, Self::Err> {
|
|
|
|
|
let url = url::Url::from_str(input)?;
|
|
|
|
|
Ok(Url(url))
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
impl<'a, 'r> FromRequest<'a, 'r> for Url {
|
|
|
|
|
type Error = Error;
|
|
|
|
|
|
|
|
|
|
fn from_request(request: &'a Request<'r>) -> request::Outcome<Self, Error> {
|
|
|
|
|
match request.headers().get_one("Origin") {
|
|
|
|
|
Some(origin) => {
|
|
|
|
|
match Self::from_str(origin) {
|
|
|
|
|
Ok(origin) => Outcome::Success(origin),
|
|
|
|
|
Err(e) => Outcome::Failure((Status::BadRequest, Error::BadOrigin(e))),
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
None => Outcome::Forward(()),
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2017-07-14 03:16:07 +00:00
|
|
|
|
|
2017-07-13 07:37:15 +00:00
|
|
|
|
/// The `Origin` request header used in CORS
|
|
|
|
|
pub type Origin = Url;
|
|
|
|
|
|
|
|
|
|
/// The `Access-Control-Request-Method` request header
|
|
|
|
|
#[derive(Debug)]
|
|
|
|
|
pub struct AccessControlRequestMethod(pub Method);
|
|
|
|
|
|
|
|
|
|
impl FromStr for AccessControlRequestMethod {
|
|
|
|
|
type Err = rocket::Error;
|
|
|
|
|
|
|
|
|
|
fn from_str(method: &str) -> Result<Self, Self::Err> {
|
|
|
|
|
Ok(AccessControlRequestMethod(Method::from_str(method)?))
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
impl<'a, 'r> FromRequest<'a, 'r> for AccessControlRequestMethod {
|
|
|
|
|
type Error = Error;
|
|
|
|
|
|
|
|
|
|
fn from_request(request: &'a Request<'r>) -> request::Outcome<Self, Error> {
|
|
|
|
|
match request.headers().get_one("Access-Control-Request-Method") {
|
|
|
|
|
Some(request_method) => {
|
|
|
|
|
match Self::from_str(request_method) {
|
|
|
|
|
Ok(request_method) => Outcome::Success(request_method),
|
|
|
|
|
Err(e) => Outcome::Failure((Status::BadRequest, Error::BadRequestMethod(e))),
|
|
|
|
|
}
|
|
|
|
|
}
|
2017-07-14 03:03:45 +00:00
|
|
|
|
None => Outcome::Forward(()),
|
2017-07-13 07:37:15 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2017-07-14 03:03:45 +00:00
|
|
|
|
type HeaderFieldName = UniCase<String>;
|
|
|
|
|
type HeaderFieldNamesSet = HashSet<HeaderFieldName>;
|
2017-07-13 07:37:15 +00:00
|
|
|
|
|
|
|
|
|
/// The `Access-Control-Request-Headers` request header
|
|
|
|
|
#[derive(Debug)]
|
|
|
|
|
pub struct AccessControlRequestHeaders(pub HeaderFieldNamesSet);
|
|
|
|
|
|
|
|
|
|
/// Will never fail
|
|
|
|
|
impl FromStr for AccessControlRequestHeaders {
|
|
|
|
|
type Err = ();
|
|
|
|
|
|
|
|
|
|
/// Will never fail
|
|
|
|
|
fn from_str(headers: &str) -> Result<Self, Self::Err> {
|
|
|
|
|
if headers.trim().is_empty() {
|
|
|
|
|
return Ok(AccessControlRequestHeaders(HashSet::new()));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
let set: HeaderFieldNamesSet = headers
|
|
|
|
|
.split(',')
|
|
|
|
|
.map(|header| UniCase(header.trim().to_string()))
|
|
|
|
|
.collect();
|
|
|
|
|
Ok(AccessControlRequestHeaders(set))
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
impl<'a, 'r> FromRequest<'a, 'r> for AccessControlRequestHeaders {
|
|
|
|
|
type Error = Error;
|
|
|
|
|
|
|
|
|
|
fn from_request(request: &'a Request<'r>) -> request::Outcome<Self, Error> {
|
|
|
|
|
match request.headers().get_one("Access-Control-Request-Headers") {
|
|
|
|
|
Some(request_headers) => {
|
|
|
|
|
match Self::from_str(request_headers) {
|
|
|
|
|
Ok(request_headers) => Outcome::Success(request_headers),
|
|
|
|
|
Err(()) => {
|
|
|
|
|
unreachable!("`AccessControlRequestHeaders::from_str` should never fail")
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
2017-07-14 03:03:45 +00:00
|
|
|
|
None => Outcome::Forward(()),
|
2017-07-13 07:37:15 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2017-07-14 03:03:45 +00:00
|
|
|
|
/// An enum signifying that some of type T is allowed, or `All` (everything is allowed).
|
2017-07-13 07:37:15 +00:00
|
|
|
|
#[derive(Clone, Debug, Serialize, Deserialize)]
|
|
|
|
|
#[serde(untagged)]
|
2017-07-14 03:03:45 +00:00
|
|
|
|
pub enum AllOrSome<T> {
|
|
|
|
|
/// Everything is allowed. Usually equivalent to the "*" value.
|
2017-07-13 07:37:15 +00:00
|
|
|
|
All,
|
2017-07-14 03:03:45 +00:00
|
|
|
|
/// Only some of `T` is allowed
|
|
|
|
|
Some(T),
|
2017-07-13 07:37:15 +00:00
|
|
|
|
}
|
|
|
|
|
|
2017-07-14 03:03:45 +00:00
|
|
|
|
impl<T> Default for AllOrSome<T> {
|
2017-07-13 07:37:15 +00:00
|
|
|
|
fn default() -> Self {
|
2017-07-14 03:03:45 +00:00
|
|
|
|
AllOrSome::All
|
2017-07-13 07:37:15 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2017-07-14 03:03:45 +00:00
|
|
|
|
impl AllOrSome<HashSet<Url>> {
|
|
|
|
|
/// New `AllOrSome` from a list of URL strings.
|
|
|
|
|
/// Returns a tuple where the first element is the struct `AllOrSome`,
|
2017-07-13 07:37:15 +00:00
|
|
|
|
/// and the second element
|
|
|
|
|
/// is a map of strings which failed to parse into URLs and their associated parse errors.
|
|
|
|
|
pub fn new_from_str_list(urls: &[&str]) -> (Self, HashMap<String, url::ParseError>) {
|
|
|
|
|
let (ok_set, error_map): (Vec<_>, Vec<_>) = urls.iter()
|
|
|
|
|
.map(|s| (s.to_string(), Url::from_str(s)))
|
|
|
|
|
.partition(|&(_, ref r)| r.is_ok());
|
|
|
|
|
|
|
|
|
|
let error_map = error_map
|
|
|
|
|
.into_iter()
|
|
|
|
|
.map(|(s, r)| (s.to_string(), r.unwrap_err()))
|
|
|
|
|
.collect();
|
|
|
|
|
|
|
|
|
|
let ok_set = ok_set.into_iter().map(|(_, r)| r.unwrap()).collect();
|
|
|
|
|
|
2017-07-14 03:03:45 +00:00
|
|
|
|
(AllOrSome::Some(ok_set), error_map)
|
2017-07-13 07:37:15 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2017-07-14 03:03:45 +00:00
|
|
|
|
/// Configuration options to for building CORS preflight or actual responses.
|
|
|
|
|
///
|
|
|
|
|
/// [`Default`](https://doc.rust-lang.org/std/default/trait.Default.html) is implemented for this
|
|
|
|
|
/// struct. The default for each field is described in the docuementation for the field.
|
|
|
|
|
#[derive(Clone, Debug)]
|
2017-07-13 07:37:15 +00:00
|
|
|
|
pub struct Options {
|
|
|
|
|
/// Origins that are allowed to make requests.
|
|
|
|
|
/// Will be verified against the `Origin` request header.
|
2017-07-14 03:03:45 +00:00
|
|
|
|
///
|
|
|
|
|
/// When `All` is set, and `send_wildcard` is set, "*" will be sent in
|
|
|
|
|
/// the `Access-Control-Allow-Origin` response header. Otherwise, the client's `Origin` request
|
|
|
|
|
/// header will be echoed back in the `Access-Control-Allow-Origin` response header.
|
|
|
|
|
///
|
|
|
|
|
/// When `Some` is set, the client's `Origin` request header will be checked in a
|
|
|
|
|
/// case-sensitive manner.
|
|
|
|
|
///
|
|
|
|
|
/// This is the `list of origins` in the
|
|
|
|
|
/// [Resource Processing Model](https://www.w3.org/TR/cors/#resource-processing-model).
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
// #[serde(default)]
|
|
|
|
|
pub allowed_origins: AllOrSome<HashSet<Url>>,
|
|
|
|
|
/// The list of methods which the allowed origins are allowed to access for
|
|
|
|
|
/// non-simple requests.
|
|
|
|
|
///
|
|
|
|
|
/// This is the `list of methods` in the
|
|
|
|
|
/// [Resource Processing Model](https://www.w3.org/TR/cors/#resource-processing-model).
|
|
|
|
|
///
|
|
|
|
|
/// Defaults to `[GET, HEAD, POST, OPTIONS, PUT, PATCH, DELETE]`
|
|
|
|
|
// #[serde(default = "Options::default_allowed_methods")]
|
2017-07-13 07:37:15 +00:00
|
|
|
|
pub allowed_methods: HashSet<Method>,
|
2017-07-14 03:03:45 +00:00
|
|
|
|
/// The list of header field names which can be used when this resource is accessed by allowed
|
|
|
|
|
/// origins.
|
|
|
|
|
///
|
|
|
|
|
/// If `All` is set, whatever is requested by the client in `Access-Control-Request-Headers`
|
|
|
|
|
/// will be echoed back in the `Access-Control-Allow-Headers` header.
|
|
|
|
|
///
|
|
|
|
|
/// This is the `list of headers` in the
|
|
|
|
|
/// [Resource Processing Model](https://www.w3.org/TR/cors/#resource-processing-model).
|
|
|
|
|
///
|
|
|
|
|
/// Defaults to `All`.
|
2017-07-14 03:16:07 +00:00
|
|
|
|
// #[serde(default)]
|
2017-07-14 03:03:45 +00:00
|
|
|
|
pub allowed_headers: AllOrSome<HashSet<HeaderFieldName>>,
|
|
|
|
|
/// Allows users to make authenticated requests.
|
|
|
|
|
/// If true, injects the `Access-Control-Allow-Credentials` header in responses.
|
|
|
|
|
/// This allows cookies and credentials to be submitted across domains.
|
|
|
|
|
///
|
|
|
|
|
/// This **CANNOT** be used in conjunction with `allowed_origins` set to `All` and
|
|
|
|
|
/// `send_wildcard` set to `true`. Depending on the mode of usage, this will either result
|
|
|
|
|
/// in an `Error::CredentialsWithWildcardOrigin` error during Rocket launch or runtime.
|
|
|
|
|
///
|
|
|
|
|
/// Defaults to `false`.
|
2017-07-14 03:16:07 +00:00
|
|
|
|
// #[serde(default)]
|
2017-07-13 07:37:15 +00:00
|
|
|
|
pub allow_credentials: bool,
|
2017-07-14 03:03:45 +00:00
|
|
|
|
/// The list of headers which are safe to expose to the API of a CORS API specification.
|
|
|
|
|
/// This corresponds to the `Access-Control-Expose-Headers` responde header.
|
|
|
|
|
///
|
|
|
|
|
/// This is the `list of exposed headers` in the
|
|
|
|
|
/// [Resource Processing Model](https://www.w3.org/TR/cors/#resource-processing-model).
|
|
|
|
|
///
|
|
|
|
|
/// This defaults to an empty set.
|
2017-07-14 03:16:07 +00:00
|
|
|
|
// #[serde(default)]
|
2017-07-13 07:37:15 +00:00
|
|
|
|
pub expose_headers: HashSet<String>,
|
2017-07-14 03:03:45 +00:00
|
|
|
|
/// The maximum time for which this CORS request maybe cached. This value is set as the
|
|
|
|
|
/// `Access-Control-Max-Age` header.
|
|
|
|
|
///
|
|
|
|
|
/// This defaults to `None` (unset).
|
2017-07-14 03:16:07 +00:00
|
|
|
|
// #[serde(default)]
|
2017-07-13 07:37:15 +00:00
|
|
|
|
pub max_age: Option<usize>,
|
2017-07-14 03:03:45 +00:00
|
|
|
|
/// If true, and the `allowed_origins` parameter is `All`, a wildcard
|
|
|
|
|
/// `Access-Control-Allow-Origin` response header is sent, rather than the request’s
|
|
|
|
|
/// `Origin` header.
|
|
|
|
|
///
|
|
|
|
|
/// This is the `supports credentials flag` in the
|
|
|
|
|
/// [Resource Processing Model](https://www.w3.org/TR/cors/#resource-processing-model).
|
|
|
|
|
///
|
|
|
|
|
/// This **CANNOT** be used in conjunction with `allowed_origins` set to `All` and
|
|
|
|
|
/// `allow_credentials` set to `true`. Depending on the mode of usage, this will either result
|
|
|
|
|
/// in an `Error::CredentialsWithWildcardOrigin` error during Rocket launch or runtime.
|
|
|
|
|
///
|
|
|
|
|
/// Defaults to `false`.
|
2017-07-14 03:16:07 +00:00
|
|
|
|
// #[serde(default)]
|
2017-07-14 03:03:45 +00:00
|
|
|
|
pub send_wildcard: bool,
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
impl Default for Options {
|
|
|
|
|
fn default() -> Self {
|
|
|
|
|
Self {
|
|
|
|
|
allowed_origins: Default::default(),
|
|
|
|
|
allowed_methods: Self::default_allowed_methods(),
|
|
|
|
|
allowed_headers: Default::default(),
|
|
|
|
|
allow_credentials: Default::default(),
|
|
|
|
|
expose_headers: Default::default(),
|
|
|
|
|
max_age: Default::default(),
|
|
|
|
|
send_wildcard: Default::default(),
|
|
|
|
|
}
|
|
|
|
|
}
|
2017-07-13 07:37:15 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
impl Options {
|
2017-07-14 03:03:45 +00:00
|
|
|
|
fn default_allowed_methods() -> HashSet<Method> {
|
|
|
|
|
vec![
|
|
|
|
|
Method::Get,
|
|
|
|
|
Method::Head,
|
|
|
|
|
Method::Post,
|
|
|
|
|
Method::Options,
|
|
|
|
|
Method::Put,
|
|
|
|
|
Method::Patch,
|
|
|
|
|
Method::Delete,
|
|
|
|
|
].into_iter()
|
|
|
|
|
.collect()
|
|
|
|
|
}
|
|
|
|
|
|
2017-07-13 07:37:15 +00:00
|
|
|
|
/// Construct a preflight response based on the options. Will return an `Err`
|
2017-07-14 03:03:45 +00:00
|
|
|
|
/// if any of the preflight checks fail.
|
|
|
|
|
///
|
|
|
|
|
/// This implementation references the
|
|
|
|
|
/// [W3C recommendation](https://www.w3.org/TR/cors/#resource-preflight-requests).
|
|
|
|
|
pub fn preflight<'r, R: Responder<'r>>(
|
2017-07-13 07:37:15 +00:00
|
|
|
|
&self,
|
2017-07-14 03:03:45 +00:00
|
|
|
|
responder: R,
|
2017-07-13 07:37:15 +00:00
|
|
|
|
origin: Option<Origin>,
|
2017-07-14 03:03:45 +00:00
|
|
|
|
method: Option<AccessControlRequestMethod>,
|
|
|
|
|
headers: Option<AccessControlRequestHeaders>,
|
|
|
|
|
) -> Result<Response<R>, Error> {
|
2017-07-13 07:37:15 +00:00
|
|
|
|
|
2017-07-14 03:03:45 +00:00
|
|
|
|
let response = Response::new(responder);
|
2017-07-13 07:37:15 +00:00
|
|
|
|
|
2017-07-14 03:03:45 +00:00
|
|
|
|
// Note: All header parse failures are dealt with in the `FromRequest` trait implementation
|
2017-07-13 07:37:15 +00:00
|
|
|
|
|
2017-07-14 03:03:45 +00:00
|
|
|
|
// 1. If the Origin header is not present terminate this set of steps.
|
|
|
|
|
// The request is outside the scope of this specification.
|
|
|
|
|
let origin = match origin {
|
|
|
|
|
None => {
|
|
|
|
|
// Not a CORS request
|
|
|
|
|
return Ok(response);
|
2017-07-13 07:37:15 +00:00
|
|
|
|
}
|
2017-07-14 03:03:45 +00:00
|
|
|
|
Some(origin) => origin,
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
// 2. If the value of the Origin header is not a case-sensitive match for any of the values
|
|
|
|
|
// in list of origins do not set any additional headers and terminate this set of steps.
|
|
|
|
|
let response = response.allowed_origin(
|
|
|
|
|
&origin,
|
|
|
|
|
&self.allowed_origins,
|
|
|
|
|
self.send_wildcard,
|
|
|
|
|
)?;
|
|
|
|
|
|
|
|
|
|
// 3. Let `method` be the value as result of parsing the Access-Control-Request-Method
|
|
|
|
|
// header.
|
|
|
|
|
// If there is no Access-Control-Request-Method header or if parsing failed,
|
|
|
|
|
// do not set any additional headers and terminate this set of steps.
|
|
|
|
|
// The request is outside the scope of this specification.
|
|
|
|
|
|
|
|
|
|
let method = method.ok_or_else(|| Error::MissingRequestMethod)?;
|
|
|
|
|
|
|
|
|
|
// 4. Let header field-names be the values as result of parsing the
|
|
|
|
|
// Access-Control-Request-Headers headers.
|
|
|
|
|
// If there are no Access-Control-Request-Headers headers
|
|
|
|
|
// let header field-names be the empty list.
|
|
|
|
|
// If parsing failed do not set any additional headers and terminate this set of steps.
|
|
|
|
|
// The request is outside the scope of this specification.
|
|
|
|
|
|
|
|
|
|
// 5. If method is not a case-sensitive match for any of the values in list of methods
|
|
|
|
|
// do not set any additional headers and terminate this set of steps.
|
|
|
|
|
|
|
|
|
|
let response = response.allowed_methods(
|
|
|
|
|
&method,
|
|
|
|
|
self.allowed_methods.clone(),
|
|
|
|
|
)?;
|
|
|
|
|
|
|
|
|
|
// 6. If any of the header field-names is not a ASCII case-insensitive match for any of the
|
|
|
|
|
// values in list of headers do not set any additional headers and terminate this set of
|
|
|
|
|
// steps.
|
|
|
|
|
let response = if let Some(headers) = headers {
|
|
|
|
|
response.allowed_headers(&headers, &self.allowed_headers)?
|
|
|
|
|
} else {
|
|
|
|
|
response
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
// 7. If the resource supports credentials add a single Access-Control-Allow-Origin header,
|
|
|
|
|
// with the value of the Origin header as value, and add a
|
|
|
|
|
// single Access-Control-Allow-Credentials header with the case-sensitive string "true" as
|
|
|
|
|
// value.
|
|
|
|
|
// Otherwise, add a single Access-Control-Allow-Origin header,
|
|
|
|
|
// with either the value of the Origin header or the string "*" as value.
|
|
|
|
|
// Note: The string "*" cannot be used for a resource that supports credentials.
|
|
|
|
|
|
|
|
|
|
let response = response.credentials(self.allow_credentials)?;
|
|
|
|
|
|
|
|
|
|
// 8. Optionally add a single Access-Control-Max-Age header
|
|
|
|
|
// with as value the amount of seconds the user agent is allowed to cache the result of the
|
|
|
|
|
// request.
|
|
|
|
|
let response = response.max_age(self.max_age);
|
|
|
|
|
|
|
|
|
|
// 9. If method is a simple method this step may be skipped.
|
|
|
|
|
// Add one or more Access-Control-Allow-Methods headers consisting of
|
|
|
|
|
// (a subset of) the list of methods.
|
|
|
|
|
// If a method is a simple method it does not need to be listed, but this is not prohibited.
|
|
|
|
|
// Since the list of methods can be unbounded,
|
|
|
|
|
// simply returning the method indicated by Access-Control-Request-Method
|
|
|
|
|
// (if supported) can be enough.
|
|
|
|
|
|
|
|
|
|
// Done above
|
|
|
|
|
|
|
|
|
|
// 10. If each of the header field-names is a simple header and none is Content-Type,
|
|
|
|
|
// this step may be skipped.
|
|
|
|
|
// Add one or more Access-Control-Allow-Headers headers consisting of (a subset of)
|
|
|
|
|
// the list of headers.
|
|
|
|
|
// If a header field name is a simple header and is not Content-Type,
|
|
|
|
|
// it is not required to be listed. Content-Type is to be listed as only a
|
|
|
|
|
// subset of its values makes it qualify as simple header.
|
|
|
|
|
// Since the list of headers can be unbounded, simply returning supported headers
|
|
|
|
|
// from Access-Control-Allow-Headers can be enough.
|
|
|
|
|
|
|
|
|
|
// Done above -- we do not do anything special with simple headers
|
|
|
|
|
|
|
|
|
|
Ok(response)
|
2017-07-13 07:37:15 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Respond to a request based on the settings.
|
|
|
|
|
/// If the `Origin` is not provided, then this request was not made by a browser and there is no
|
|
|
|
|
/// CORS enforcement.
|
|
|
|
|
pub fn respond<'r, R: Responder<'r>>(
|
|
|
|
|
&self,
|
|
|
|
|
responder: R,
|
|
|
|
|
origin: Option<Origin>,
|
|
|
|
|
) -> Result<Response<R>, Error> {
|
2017-07-14 03:03:45 +00:00
|
|
|
|
let response = Response::new(responder);
|
2017-07-13 07:37:15 +00:00
|
|
|
|
|
2017-07-14 03:03:45 +00:00
|
|
|
|
// Note: All header parse failures are dealt with in the `FromRequest` trait implementation
|
|
|
|
|
|
|
|
|
|
// 1. If the Origin header is not present terminate this set of steps.
|
|
|
|
|
// The request is outside the scope of this specification.
|
|
|
|
|
let origin = match origin {
|
|
|
|
|
None => {
|
|
|
|
|
// Not a CORS request
|
|
|
|
|
return Ok(response);
|
|
|
|
|
}
|
|
|
|
|
Some(origin) => origin,
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
// 2. If the value of the Origin header is not a case-sensitive match for any of the values
|
|
|
|
|
// in list of origins, do not set any additional headers and terminate this set of steps.
|
|
|
|
|
// Always matching is acceptable since the list of origins can be unbounded.
|
|
|
|
|
|
|
|
|
|
let response = response.allowed_origin(
|
|
|
|
|
&origin,
|
|
|
|
|
&self.allowed_origins,
|
|
|
|
|
self.send_wildcard,
|
|
|
|
|
)?;
|
|
|
|
|
|
|
|
|
|
// 3. If the resource supports credentials add a single Access-Control-Allow-Origin header,
|
|
|
|
|
// with the value of the Origin header as value, and add a
|
|
|
|
|
// single Access-Control-Allow-Credentials header with the case-sensitive string "true" as
|
|
|
|
|
// value.
|
|
|
|
|
// Otherwise, add a single Access-Control-Allow-Origin header,
|
|
|
|
|
// with either the value of the Origin header or the string "*" as value.
|
|
|
|
|
// Note: The string "*" cannot be used for a resource that supports credentials.
|
|
|
|
|
|
|
|
|
|
let response = response.credentials(self.allow_credentials)?;
|
|
|
|
|
|
|
|
|
|
// 4. If the list of exposed headers is not empty add one or more
|
|
|
|
|
// Access-Control-Expose-Headers headers, with as values the header field names given in
|
|
|
|
|
// the list of exposed headers.
|
|
|
|
|
// By not adding the appropriate headers resource can also clear the preflight result cache
|
|
|
|
|
// of all entries where origin is a case-sensitive match for the value of the Origin header
|
|
|
|
|
// and url is a case-sensitive match for the URL of the resource.
|
|
|
|
|
|
|
|
|
|
let response = response.exposed_headers(
|
|
|
|
|
self.expose_headers
|
|
|
|
|
.iter()
|
|
|
|
|
.map(|s| &**s)
|
|
|
|
|
.collect::<Vec<&str>>()
|
|
|
|
|
.as_slice(),
|
|
|
|
|
);
|
|
|
|
|
Ok(response)
|
2017-07-13 07:37:15 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// A CORS Response which wraps another struct which implements `Responder`. You will typically
|
|
|
|
|
/// use [`Options`] instead to verify and build the response instead of this directly.
|
|
|
|
|
/// See module level documentation for usage examples.
|
2017-07-14 05:29:54 +00:00
|
|
|
|
///
|
|
|
|
|
/// If the wrapped `Responder` already has the `Access-Control-Allow-Origin` header set,
|
|
|
|
|
/// this responder will leave the response untouched.
|
|
|
|
|
/// This allows for chaining of several CORS responders.
|
|
|
|
|
///
|
|
|
|
|
/// Otherwise, the following headers may be set for the final Rocket `Response`, overwriting any
|
|
|
|
|
/// existing headers defined:
|
|
|
|
|
///
|
|
|
|
|
/// - `Access-Control-Allow-Origin`
|
|
|
|
|
/// - `Access-Control-Expose-Headers`
|
|
|
|
|
/// - `Access-Control-Max-Age`
|
|
|
|
|
/// - `Access-Control-Allow-Credentials`
|
|
|
|
|
/// - `Access-Control-Allow-Methods`
|
|
|
|
|
/// - `Access-Control-Allow-Headers`
|
|
|
|
|
/// - `Vary`
|
2017-07-13 07:37:15 +00:00
|
|
|
|
pub struct Response<R> {
|
|
|
|
|
responder: R,
|
2017-07-14 03:03:45 +00:00
|
|
|
|
allow_origin: Option<AllOrSome<String>>,
|
2017-07-13 07:37:15 +00:00
|
|
|
|
allow_methods: HashSet<Method>,
|
|
|
|
|
allow_headers: HeaderFieldNamesSet,
|
|
|
|
|
allow_credentials: bool,
|
|
|
|
|
expose_headers: HeaderFieldNamesSet,
|
|
|
|
|
max_age: Option<usize>,
|
2017-07-14 03:03:45 +00:00
|
|
|
|
vary_origin: bool,
|
2017-07-13 07:37:15 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
impl<'r, R: Responder<'r>> Response<R> {
|
2017-07-14 03:03:45 +00:00
|
|
|
|
/// Consumes the responder and return an empty `Response`
|
|
|
|
|
fn new(responder: R) -> Self {
|
2017-07-13 07:37:15 +00:00
|
|
|
|
Self {
|
2017-07-14 03:03:45 +00:00
|
|
|
|
allow_origin: None,
|
2017-07-13 07:37:15 +00:00
|
|
|
|
allow_headers: HashSet::new(),
|
|
|
|
|
allow_methods: HashSet::new(),
|
2017-07-14 03:03:45 +00:00
|
|
|
|
responder,
|
2017-07-13 07:37:15 +00:00
|
|
|
|
allow_credentials: false,
|
|
|
|
|
expose_headers: HashSet::new(),
|
|
|
|
|
max_age: None,
|
2017-07-14 03:03:45 +00:00
|
|
|
|
vary_origin: false,
|
2017-07-13 07:37:15 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
2017-07-14 03:03:45 +00:00
|
|
|
|
|
|
|
|
|
/// Consumes the `Response` and return an altered response with origin and `vary_origin` set
|
|
|
|
|
fn origin(mut self, origin: &str, vary_origin: bool) -> Self {
|
|
|
|
|
self.allow_origin = Some(AllOrSome::Some(origin.to_string()));
|
|
|
|
|
self.vary_origin = vary_origin;
|
|
|
|
|
self
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Consumes the `Response` and return an altered response with origin set to "*"
|
|
|
|
|
fn any(self) -> Self {
|
|
|
|
|
self.origin("*", false)
|
|
|
|
|
}
|
|
|
|
|
|
2017-07-13 07:37:15 +00:00
|
|
|
|
/// Consumes the responder and based on the provided list of allowed origins,
|
|
|
|
|
/// check if the requested origin is allowed.
|
|
|
|
|
/// Useful for pre-flight and during requests
|
2017-07-14 03:03:45 +00:00
|
|
|
|
fn allowed_origin(
|
|
|
|
|
self,
|
2017-07-13 07:37:15 +00:00
|
|
|
|
origin: &Origin,
|
2017-07-14 03:03:45 +00:00
|
|
|
|
allowed_origins: &AllOrSome<HashSet<Url>>,
|
|
|
|
|
send_wildcard: bool,
|
2017-07-13 07:37:15 +00:00
|
|
|
|
) -> Result<Self, Error> {
|
2017-07-14 03:03:45 +00:00
|
|
|
|
let origin = origin.origin().unicode_serialization();
|
2017-07-13 07:37:15 +00:00
|
|
|
|
match *allowed_origins {
|
2017-07-14 03:03:45 +00:00
|
|
|
|
// Always matching is acceptable since the list of origins can be unbounded.
|
|
|
|
|
AllOrSome::All => {
|
|
|
|
|
if send_wildcard {
|
|
|
|
|
Ok(self.any())
|
|
|
|
|
} else {
|
|
|
|
|
Ok(self.origin(&origin, true))
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
AllOrSome::Some(ref allowed_origins) => {
|
2017-07-13 07:37:15 +00:00
|
|
|
|
let allowed_origins: HashSet<_> = allowed_origins
|
|
|
|
|
.iter()
|
|
|
|
|
.map(|o| o.origin().unicode_serialization())
|
|
|
|
|
.collect();
|
|
|
|
|
let _ = allowed_origins.get(&origin).ok_or_else(
|
|
|
|
|
|| Error::OriginNotAllowed,
|
|
|
|
|
)?;
|
2017-07-14 03:03:45 +00:00
|
|
|
|
Ok(self.origin(&origin, false))
|
2017-07-13 07:37:15 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2017-07-14 03:03:45 +00:00
|
|
|
|
/// Consumes the Response and validate whether credentials can be allowed
|
|
|
|
|
fn credentials(mut self, value: bool) -> Result<Self, Error> {
|
|
|
|
|
if value {
|
|
|
|
|
if let Some(AllOrSome::All) = self.allow_origin {
|
|
|
|
|
Err(Error::CredentialsWithWildcardOrigin)?;
|
|
|
|
|
}
|
|
|
|
|
}
|
2017-07-13 07:37:15 +00:00
|
|
|
|
|
|
|
|
|
self.allow_credentials = value;
|
2017-07-14 03:03:45 +00:00
|
|
|
|
Ok(self)
|
2017-07-13 07:37:15 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Consumes the CORS, set expose_headers to
|
|
|
|
|
/// passed headers and returns changed CORS
|
2017-07-14 03:03:45 +00:00
|
|
|
|
fn exposed_headers(mut self, headers: &[&str]) -> Self {
|
2017-07-13 07:37:15 +00:00
|
|
|
|
self.expose_headers = headers.into_iter().map(|s| s.to_string().into()).collect();
|
|
|
|
|
self
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Consumes the CORS, set max_age to
|
|
|
|
|
/// passed value and returns changed CORS
|
2017-07-14 03:03:45 +00:00
|
|
|
|
fn max_age(mut self, value: Option<usize>) -> Self {
|
2017-07-13 07:37:15 +00:00
|
|
|
|
self.max_age = value;
|
|
|
|
|
self
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Consumes the CORS, set allow_methods to
|
|
|
|
|
/// passed methods and returns changed CORS
|
|
|
|
|
fn methods(mut self, methods: HashSet<Method>) -> Self {
|
|
|
|
|
self.allow_methods = methods;
|
|
|
|
|
self
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Consumes the CORS, check if requested method is allowed.
|
|
|
|
|
/// Useful for pre-flight checks
|
2017-07-14 03:03:45 +00:00
|
|
|
|
fn allowed_methods(
|
2017-07-13 07:37:15 +00:00
|
|
|
|
self,
|
|
|
|
|
method: &AccessControlRequestMethod,
|
|
|
|
|
allowed_methods: HashSet<Method>,
|
|
|
|
|
) -> Result<Self, Error> {
|
|
|
|
|
let &AccessControlRequestMethod(ref request_method) = method;
|
|
|
|
|
if !allowed_methods.iter().any(|m| m == request_method) {
|
|
|
|
|
Err(Error::MethodNotAllowed)?
|
|
|
|
|
}
|
2017-07-14 03:03:45 +00:00
|
|
|
|
|
|
|
|
|
// TODO: Subset to route? Or just the method requested for?
|
2017-07-13 07:37:15 +00:00
|
|
|
|
Ok(self.methods(allowed_methods))
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Consumes the CORS, set allow_headers to
|
|
|
|
|
/// passed headers and returns changed CORS
|
|
|
|
|
fn headers(mut self, headers: &[&str]) -> Self {
|
|
|
|
|
self.allow_headers = headers.into_iter().map(|s| s.to_string().into()).collect();
|
|
|
|
|
self
|
|
|
|
|
}
|
|
|
|
|
|
2017-07-14 03:03:45 +00:00
|
|
|
|
/// Consumes the CORS, check if requested headers are allowed.
|
2017-07-13 07:37:15 +00:00
|
|
|
|
/// Useful for pre-flight checks
|
2017-07-14 03:03:45 +00:00
|
|
|
|
fn allowed_headers(
|
2017-07-13 07:37:15 +00:00
|
|
|
|
self,
|
|
|
|
|
headers: &AccessControlRequestHeaders,
|
2017-07-14 03:03:45 +00:00
|
|
|
|
allowed_headers: &AllOrSome<HashSet<HeaderFieldName>>,
|
2017-07-13 07:37:15 +00:00
|
|
|
|
) -> Result<Self, Error> {
|
|
|
|
|
let &AccessControlRequestHeaders(ref headers) = headers;
|
2017-07-14 03:03:45 +00:00
|
|
|
|
|
|
|
|
|
match *allowed_headers {
|
|
|
|
|
AllOrSome::All => {}
|
|
|
|
|
AllOrSome::Some(ref allowed_headers) => {
|
|
|
|
|
if !headers.is_empty() && !headers.is_subset(allowed_headers) {
|
|
|
|
|
Err(Error::HeadersNotAllowed)?
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
};
|
|
|
|
|
|
2017-07-13 07:37:15 +00:00
|
|
|
|
Ok(
|
|
|
|
|
self.headers(
|
2017-07-14 03:03:45 +00:00
|
|
|
|
headers
|
2017-07-13 07:37:15 +00:00
|
|
|
|
.iter()
|
|
|
|
|
.map(|s| &**s.deref())
|
|
|
|
|
.collect::<Vec<&str>>()
|
|
|
|
|
.as_slice(),
|
|
|
|
|
),
|
|
|
|
|
)
|
|
|
|
|
}
|
|
|
|
|
|
2017-07-14 05:29:54 +00:00
|
|
|
|
/// Builds a `rocket::Response` from this struct containing only the CORS headers.
|
2017-07-14 03:03:45 +00:00
|
|
|
|
#[allow(unused_results)]
|
2017-07-14 05:29:54 +00:00
|
|
|
|
fn build(&self) -> response::Response<'r> {
|
|
|
|
|
let mut builder = response::Response::build();
|
2017-07-14 03:03:45 +00:00
|
|
|
|
|
|
|
|
|
let origin = match self.allow_origin {
|
|
|
|
|
None => {
|
|
|
|
|
// This is not a CORS response
|
2017-07-14 05:29:54 +00:00
|
|
|
|
return builder.finalize();
|
2017-07-14 03:03:45 +00:00
|
|
|
|
}
|
2017-07-14 05:29:54 +00:00
|
|
|
|
Some(ref origin) => origin,
|
2017-07-14 03:03:45 +00:00
|
|
|
|
};
|
|
|
|
|
|
2017-07-14 05:29:54 +00:00
|
|
|
|
let origin = match *origin {
|
|
|
|
|
AllOrSome::All => "*".to_string(),
|
|
|
|
|
AllOrSome::Some(ref origin) => origin.to_string(),
|
2017-07-14 03:03:45 +00:00
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
builder.raw_header("Access-Control-Allow-Origin", origin);
|
2017-07-13 07:37:15 +00:00
|
|
|
|
|
|
|
|
|
if self.allow_credentials {
|
2017-07-14 03:03:45 +00:00
|
|
|
|
builder.raw_header("Access-Control-Allow-Credentials", "true");
|
2017-07-13 07:37:15 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if !self.expose_headers.is_empty() {
|
|
|
|
|
let headers: Vec<String> = self.expose_headers
|
2017-07-14 05:29:54 +00:00
|
|
|
|
.iter()
|
2017-07-13 07:37:15 +00:00
|
|
|
|
.map(|s| s.deref().to_string())
|
|
|
|
|
.collect();
|
|
|
|
|
let headers = headers.join(", ");
|
|
|
|
|
|
2017-07-14 03:03:45 +00:00
|
|
|
|
builder.raw_header("Access-Control-Expose-Headers", headers);
|
2017-07-13 07:37:15 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if !self.allow_headers.is_empty() {
|
|
|
|
|
let headers: Vec<String> = self.allow_headers
|
2017-07-14 05:29:54 +00:00
|
|
|
|
.iter()
|
2017-07-13 07:37:15 +00:00
|
|
|
|
.map(|s| s.deref().to_string())
|
|
|
|
|
.collect();
|
|
|
|
|
let headers = headers.join(", ");
|
|
|
|
|
|
2017-07-14 03:03:45 +00:00
|
|
|
|
builder.raw_header("Access-Control-Allow-Headers", headers);
|
2017-07-13 07:37:15 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
if !self.allow_methods.is_empty() {
|
2017-07-14 05:29:54 +00:00
|
|
|
|
let methods: Vec<_> = self.allow_methods.iter().map(|m| m.as_str()).collect();
|
2017-07-13 07:37:15 +00:00
|
|
|
|
let methods = methods.join(", ");
|
|
|
|
|
|
2017-07-14 03:03:45 +00:00
|
|
|
|
builder.raw_header("Access-Control-Allow-Methods", methods);
|
2017-07-13 07:37:15 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if self.max_age.is_some() {
|
|
|
|
|
let max_age = self.max_age.unwrap();
|
2017-07-14 03:03:45 +00:00
|
|
|
|
builder.raw_header("Access-Control-Max-Age", max_age.to_string());
|
2017-07-13 07:37:15 +00:00
|
|
|
|
}
|
|
|
|
|
|
2017-07-14 03:03:45 +00:00
|
|
|
|
if self.vary_origin {
|
|
|
|
|
builder.raw_header("Vary", "Origin");
|
|
|
|
|
}
|
|
|
|
|
|
2017-07-14 05:29:54 +00:00
|
|
|
|
builder.finalize()
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Merge a `wrapped` Response with a `cors` response
|
|
|
|
|
///
|
|
|
|
|
/// If the `wrapped` response has the `Access-Control-Allow-Origin` header already defined,
|
|
|
|
|
/// it will be left untouched. This allows for chaining of several CORS responders.
|
|
|
|
|
///
|
|
|
|
|
/// Otherwise, the merging will be done according to the rules of `rocket::Response::merge`.
|
|
|
|
|
fn merge(
|
|
|
|
|
mut wrapped: response::Response<'r>,
|
|
|
|
|
cors: response::Response<'r>,
|
|
|
|
|
) -> response::Response<'r> {
|
|
|
|
|
|
|
|
|
|
let existing_cors = {
|
|
|
|
|
wrapped.headers().get("Access-Control-Allow-Origin").next() == None
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
if existing_cors {
|
|
|
|
|
wrapped.merge(cors);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
wrapped
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Finalize the Response by merging the CORS header with the wrapped `Responder
|
|
|
|
|
///
|
|
|
|
|
/// If the original response has the `Access-Control-Allow-Origin` header already defined,
|
|
|
|
|
/// it will be left untouched.This allows for chaining of several CORS responders.
|
|
|
|
|
///
|
|
|
|
|
/// Otherwise, the following headers may be set for the final Rocket `Response`, overwriting any
|
|
|
|
|
/// existing headers defined:
|
|
|
|
|
///
|
|
|
|
|
/// - `Access-Control-Allow-Origin`
|
|
|
|
|
/// - `Access-Control-Expose-Headers`
|
|
|
|
|
/// - `Access-Control-Max-Age`
|
|
|
|
|
/// - `Access-Control-Allow-Credentials`
|
|
|
|
|
/// - `Access-Control-Allow-Methods`
|
|
|
|
|
/// - `Access-Control-Allow-Headers`
|
|
|
|
|
/// - `Vary`
|
|
|
|
|
fn finalize(self, request: &Request) -> response::Result<'r> {
|
|
|
|
|
let cors_response = self.build();
|
|
|
|
|
let original_response = self.responder.respond_to(request)?;
|
|
|
|
|
|
|
|
|
|
Ok(Self::merge(original_response, cors_response))
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
impl<'r, R: Responder<'r>> Responder<'r> for Response<R> {
|
|
|
|
|
fn respond_to(self, request: &Request) -> response::Result<'r> {
|
|
|
|
|
self.finalize(request)
|
2017-07-13 07:37:15 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[cfg(test)]
|
|
|
|
|
#[allow(unmounted_route)]
|
|
|
|
|
mod tests {
|
|
|
|
|
use std::str::FromStr;
|
|
|
|
|
|
|
|
|
|
use hyper;
|
|
|
|
|
use rocket;
|
|
|
|
|
use rocket::local::Client;
|
|
|
|
|
use rocket::http::Method;
|
|
|
|
|
use rocket::http::{Header, Status};
|
|
|
|
|
|
|
|
|
|
use super::*;
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn origin_header_conversion() {
|
|
|
|
|
let url = "https://foo.bar.xyz";
|
|
|
|
|
let _ = not_err!(Origin::from_str(url));
|
|
|
|
|
|
|
|
|
|
let url = "https://foo.bar.xyz/path/somewhere"; // this should never really be used
|
|
|
|
|
let _ = not_err!(Origin::from_str(url));
|
|
|
|
|
|
|
|
|
|
let url = "invalid_url";
|
|
|
|
|
let _ = is_err!(Origin::from_str(url));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn request_method_conversion() {
|
|
|
|
|
let method = "POST";
|
|
|
|
|
let parsed_method = not_err!(AccessControlRequestMethod::from_str(method));
|
|
|
|
|
assert_matches!(parsed_method, AccessControlRequestMethod(Method::Post));
|
|
|
|
|
|
|
|
|
|
let method = "options";
|
|
|
|
|
let parsed_method = not_err!(AccessControlRequestMethod::from_str(method));
|
|
|
|
|
assert_matches!(parsed_method, AccessControlRequestMethod(Method::Options));
|
|
|
|
|
|
|
|
|
|
let method = "INVALID";
|
|
|
|
|
let _ = is_err!(AccessControlRequestMethod::from_str(method));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn request_headers_conversion() {
|
|
|
|
|
let headers = ["foo", "bar", "baz"];
|
|
|
|
|
let parsed_headers = not_err!(AccessControlRequestHeaders::from_str(&headers.join(", ")));
|
|
|
|
|
let expected_headers: HeaderFieldNamesSet =
|
|
|
|
|
headers.iter().map(|s| s.to_string().into()).collect();
|
|
|
|
|
let AccessControlRequestHeaders(actual_headers) = parsed_headers;
|
|
|
|
|
assert_eq!(actual_headers, expected_headers);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[get("/request_headers")]
|
|
|
|
|
#[allow(needless_pass_by_value)]
|
|
|
|
|
fn request_headers(
|
|
|
|
|
origin: Origin,
|
|
|
|
|
method: AccessControlRequestMethod,
|
|
|
|
|
headers: AccessControlRequestHeaders,
|
|
|
|
|
) -> String {
|
|
|
|
|
let AccessControlRequestMethod(method) = method;
|
|
|
|
|
let AccessControlRequestHeaders(headers) = headers;
|
|
|
|
|
let mut headers = headers
|
|
|
|
|
.iter()
|
|
|
|
|
.map(|s| s.deref().to_string())
|
|
|
|
|
.collect::<Vec<String>>();
|
|
|
|
|
headers.sort();
|
|
|
|
|
format!("{}\n{}\n{}", origin, method, headers.join(", "))
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Tests that all the headers are parsed correcly in a HTTP request
|
|
|
|
|
#[test]
|
|
|
|
|
fn request_headers_round_trip_smoke_test() {
|
|
|
|
|
let rocket = rocket::ignite().mount("/", routes![request_headers]);
|
|
|
|
|
let client = not_err!(Client::new(rocket));
|
|
|
|
|
|
|
|
|
|
let origin_header = Header::from(not_err!(
|
|
|
|
|
hyper::header::Origin::from_str("https://foo.bar.xyz")
|
|
|
|
|
));
|
|
|
|
|
let method_header = Header::from(hyper::header::AccessControlRequestMethod(
|
|
|
|
|
hyper::method::Method::Get,
|
|
|
|
|
));
|
|
|
|
|
let request_headers = hyper::header::AccessControlRequestHeaders(vec![
|
|
|
|
|
FromStr::from_str("accept-language").unwrap(),
|
|
|
|
|
FromStr::from_str("X-Ping").unwrap(),
|
|
|
|
|
]);
|
|
|
|
|
let request_headers = Header::from(request_headers);
|
|
|
|
|
let req = client
|
|
|
|
|
.get("/request_headers")
|
|
|
|
|
.header(origin_header)
|
|
|
|
|
.header(method_header)
|
|
|
|
|
.header(request_headers);
|
|
|
|
|
let mut response = req.dispatch();
|
|
|
|
|
|
|
|
|
|
assert_eq!(Status::Ok, response.status());
|
|
|
|
|
let body_str = not_none!(response.body().and_then(|body| body.into_string()));
|
|
|
|
|
let expected_body = r#"https://foo.bar.xyz/
|
|
|
|
|
GET
|
|
|
|
|
X-Ping, accept-language"#;
|
|
|
|
|
assert_eq!(expected_body, body_str);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[get("/any")]
|
|
|
|
|
fn any() -> Response<&'static str> {
|
2017-07-14 03:03:45 +00:00
|
|
|
|
Response::new("Hello, world!").any()
|
2017-07-13 07:37:15 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn response_any_origin_smoke_test() {
|
|
|
|
|
let rocket = rocket::ignite().mount("/", routes![any]);
|
|
|
|
|
let client = not_err!(Client::new(rocket));
|
|
|
|
|
|
|
|
|
|
let req = client.get("/any");
|
|
|
|
|
let mut response = req.dispatch();
|
|
|
|
|
|
|
|
|
|
assert_eq!(Status::Ok, response.status());
|
|
|
|
|
let body_str = response.body().and_then(|body| body.into_string());
|
|
|
|
|
let values: Vec<_> = response
|
|
|
|
|
.headers()
|
|
|
|
|
.get("Access-Control-Allow-Origin")
|
|
|
|
|
.collect();
|
|
|
|
|
assert_eq!(values, vec!["*"]);
|
|
|
|
|
assert_eq!(body_str, Some("Hello, world!".to_string()));
|
|
|
|
|
}
|
|
|
|
|
}
|