//! This is an example of how you can mix and match the "Truly manual" mode with "Guard". //! //! In this example, you typically have an application wide `Cors` struct except for one specific //! `ping` route that you want to allow all Origins to access. use rocket::http::hyper; use rocket::http::{Header, Method, Status}; use rocket::local::blocking::Client; use rocket::response::Responder; use rocket::{get, options, routes}; use rocket_cors::{AllowedHeaders, AllowedOrigins, CorsOptions, Guard}; static ORIGIN: hyper::HeaderName = hyper::header::ORIGIN; static ACCESS_CONTROL_REQUEST_METHOD: hyper::HeaderName = hyper::header::ACCESS_CONTROL_REQUEST_METHOD; static ACCESS_CONTROL_REQUEST_HEADERS: hyper::HeaderName = hyper::header::ACCESS_CONTROL_REQUEST_HEADERS; /// The "usual" app route #[get("/")] fn app(cors: Guard<'_>) -> rocket_cors::Responder<'_, '_, &str> { cors.responder("Hello CORS!") } /// The special "ping" route #[get("/ping")] fn ping<'r, 'o: 'r>() -> impl Responder<'r, 'o> { let cors = cors_options_all().to_cors()?; cors.respond_owned(|guard| guard.responder("Pong!")) } /// You need to define an OPTIONS route for preflight checks if you want to use `Cors` struct /// that is not in Rocket's managed state. /// These routes can just return the unit type `()` #[options("/ping")] fn ping_options<'r, 'o: 'r>() -> impl Responder<'r, 'o> { let cors = cors_options_all().to_cors()?; cors.respond_owned(|guard| guard.responder(())) } /// Returns the "application wide" Cors struct fn cors_options() -> CorsOptions { let allowed_origins = AllowedOrigins::some_exact(&["https://www.acme.com"]); // You can also deserialize this rocket_cors::CorsOptions { allowed_origins, allowed_methods: vec![Method::Get].into_iter().map(From::from).collect(), allowed_headers: AllowedHeaders::some(&["Authorization", "Accept"]), allow_credentials: true, ..Default::default() } } /// A special struct that allows all origins /// /// Note: In your real application, you might want to use something like `lazy_static` to generate /// a `&'static` reference to this instead of creating a new struct on every request. fn cors_options_all() -> CorsOptions { // You can also deserialize this Default::default() } fn rocket() -> rocket::Rocket { rocket::build() .mount("/", routes![app, ping, ping_options,]) .mount("/", rocket_cors::catch_all_options_routes()) // mount the catch all routes .manage(cors_options().to_cors().expect("Not to fail")) } #[test] fn smoke_test() { let client = Client::tracked(rocket()).unwrap(); // `Options` pre-flight checks let origin_header = Header::new(ORIGIN.as_str(), "https://www.acme.com"); let method_header = Header::new( ACCESS_CONTROL_REQUEST_METHOD.as_str(), hyper::Method::GET.as_str(), ); let request_headers = Header::new(ACCESS_CONTROL_REQUEST_HEADERS.as_str(), "Authorization"); let req = client .options("/") .header(origin_header) .header(method_header) .header(request_headers); let response = req.dispatch(); assert!(response.status().class().is_success()); // "Actual" request let origin_header = Header::new(ORIGIN.as_str(), "https://www.acme.com"); let authorization = Header::new("Authorization", "let me in"); let req = client.get("/").header(origin_header).header(authorization); let response = req.dispatch(); assert!(response.status().class().is_success()); let origin_header = response .headers() .get_one("Access-Control-Allow-Origin") .expect("to exist"); assert_eq!("https://www.acme.com", origin_header); let body_str = response.into_string(); assert_eq!(body_str, Some("Hello CORS!".to_string())); } #[test] fn cors_options_check() { let client = Client::tracked(rocket()).unwrap(); let origin_header = Header::new(ORIGIN.as_str(), "https://www.acme.com"); let method_header = Header::new( ACCESS_CONTROL_REQUEST_METHOD.as_str(), hyper::Method::GET.as_str(), ); let request_headers = Header::new(ACCESS_CONTROL_REQUEST_HEADERS.as_str(), "Authorization"); let req = client .options("/") .header(origin_header) .header(method_header) .header(request_headers); let response = req.dispatch(); assert!(response.status().class().is_success()); let origin_header = response .headers() .get_one("Access-Control-Allow-Origin") .expect("to exist"); assert_eq!("https://www.acme.com", origin_header); } #[test] fn cors_get_check() { let client = Client::tracked(rocket()).unwrap(); let origin_header = Header::new(ORIGIN.as_str(), "https://www.acme.com"); let authorization = Header::new("Authorization", "let me in"); let req = client.get("/").header(origin_header).header(authorization); let response = req.dispatch(); assert!(response.status().class().is_success()); let origin_header = response .headers() .get_one("Access-Control-Allow-Origin") .expect("to exist"); assert_eq!("https://www.acme.com", origin_header); let body_str = response.into_string(); assert_eq!(body_str, Some("Hello CORS!".to_string())); } /// This test is to check that non CORS compliant requests to GET should still work. (i.e. curl) #[test] fn cors_get_no_origin() { let client = Client::tracked(rocket()).unwrap(); let authorization = Header::new("Authorization", "let me in"); let req = client.get("/").header(authorization); let response = req.dispatch(); assert!(response.status().class().is_success()); let body_str = response.into_string(); assert_eq!(body_str, Some("Hello CORS!".to_string())); } #[test] fn cors_options_bad_origin() { let client = Client::tracked(rocket()).unwrap(); let origin_header = Header::new(ORIGIN.as_str(), "https://www.bad-origin.com"); let method_header = Header::new( ACCESS_CONTROL_REQUEST_METHOD.as_str(), hyper::Method::GET.as_str(), ); let request_headers = Header::new(ACCESS_CONTROL_REQUEST_HEADERS.as_str(), "Authorization"); let req = client .options("/") .header(origin_header) .header(method_header) .header(request_headers); let response = req.dispatch(); assert_eq!(response.status(), Status::Forbidden); } #[test] fn cors_options_missing_origin() { let client = Client::tracked(rocket()).unwrap(); let method_header = Header::new( ACCESS_CONTROL_REQUEST_METHOD.as_str(), hyper::Method::GET.as_str(), ); let request_headers = Header::new(ACCESS_CONTROL_REQUEST_HEADERS.as_str(), "Authorization"); let req = client .options("/") .header(method_header) .header(request_headers); let response = req.dispatch(); assert!(response.status().class().is_success()); assert!(response .headers() .get_one("Access-Control-Allow-Origin") .is_none()); } #[test] fn cors_options_bad_request_method() { let client = Client::tracked(rocket()).unwrap(); let origin_header = Header::new(ORIGIN.as_str(), "https://www.acme.com"); let method_header = Header::new( ACCESS_CONTROL_REQUEST_METHOD.as_str(), hyper::Method::POST.as_str(), ); let request_headers = Header::new(ACCESS_CONTROL_REQUEST_HEADERS.as_str(), "Authorization"); let req = client .options("/") .header(origin_header) .header(method_header) .header(request_headers); let response = req.dispatch(); assert_eq!(response.status(), Status::Forbidden); assert!(response .headers() .get_one("Access-Control-Allow-Origin") .is_none()); } #[test] fn cors_options_bad_request_header() { let client = Client::tracked(rocket()).unwrap(); let origin_header = Header::new(ORIGIN.as_str(), "https://www.acme.com"); let method_header = Header::new( ACCESS_CONTROL_REQUEST_METHOD.as_str(), hyper::Method::GET.as_str(), ); let request_headers = Header::new(ACCESS_CONTROL_REQUEST_HEADERS.as_str(), "Foobar"); let req = client .options("/") .header(origin_header) .header(method_header) .header(request_headers); let response = req.dispatch(); assert_eq!(response.status(), Status::Forbidden); assert!(response .headers() .get_one("Access-Control-Allow-Origin") .is_none()); } #[test] fn cors_get_bad_origin() { let client = Client::tracked(rocket()).unwrap(); let origin_header = Header::new(ORIGIN.as_str(), "https://www.bad-origin.com"); let authorization = Header::new("Authorization", "let me in"); let req = client.get("/").header(origin_header).header(authorization); let response = req.dispatch(); assert_eq!(response.status(), Status::Forbidden); assert!(response .headers() .get_one("Access-Control-Allow-Origin") .is_none()); } /// Tests that the `ping` route accepts other Origins #[test] fn cors_options_ping_check() { let client = Client::tracked(rocket()).unwrap(); let origin_header = Header::new(ORIGIN.as_str(), "https://www.example.com"); let method_header = Header::new( ACCESS_CONTROL_REQUEST_METHOD.as_str(), hyper::Method::GET.as_str(), ); let req = client .options("/ping") .header(origin_header) .header(method_header); let response = req.dispatch(); assert!(response.status().class().is_success()); let origin_header = response .headers() .get_one("Access-Control-Allow-Origin") .expect("to exist"); assert_eq!("https://www.example.com", origin_header); } /// Tests that the `ping` route accepts other Origins #[test] fn cors_get_ping_check() { let client = Client::tracked(rocket()).unwrap(); let origin_header = Header::new(ORIGIN.as_str(), "https://www.example.com"); let req = client.get("/ping").header(origin_header); let response = req.dispatch(); assert!(response.status().class().is_success()); let origin_header = response .headers() .get_one("Access-Control-Allow-Origin") .expect("to exist"); assert_eq!("https://www.example.com", origin_header); let body_str = response.into_string(); assert_eq!(body_str, Some("Pong!".to_string())); }