From 8703f2f82e36171515ca488fca0163c42f738a3a Mon Sep 17 00:00:00 2001 From: svartalf Date: Sun, 20 May 2018 12:59:41 +0300 Subject: [PATCH] Initial commit --- .gitignore | 3 + .travis.yml | 8 ++ Cargo.toml | 16 ++++ LICENSE-APACHE | 201 +++++++++++++++++++++++++++++++++++++++++++ LICENSE-MIT | 25 ++++++ README.md | 1 + src/errors.rs | 63 ++++++++++++++ src/lib.rs | 8 ++ src/schemes/basic.rs | 120 ++++++++++++++++++++++++++ src/schemes/mod.rs | 3 + 10 files changed, 448 insertions(+) create mode 100644 .gitignore create mode 100644 .travis.yml create mode 100644 Cargo.toml create mode 100644 LICENSE-APACHE create mode 100644 LICENSE-MIT create mode 100644 README.md create mode 100644 src/errors.rs create mode 100644 src/lib.rs create mode 100644 src/schemes/basic.rs create mode 100644 src/schemes/mod.rs diff --git a/.gitignore b/.gitignore new file mode 100644 index 000000000..693699042 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +/target +**/*.rs.bk +Cargo.lock diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 000000000..8c91a7415 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,8 @@ +language: rust +rust: + - stable + - beta + - nightly +matrix: + allow_failures: + - rust: nightly diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 000000000..773d4c264 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,16 @@ +[package] +name = "actix-web-httpauth" +version = "0.0.1" +authors = ["svartalf "] +description = "HTTP authorization schemes for actix-web" +readme = "README.md" +keywords = ["http", "web", "framework"] +homepage = "https://github.com/svartalf/actix-web-httpauth" +repository = "https://github.com/svartlaf/actix-web-httpauth.git" +documentation = "https://docs.rs/actix-web-httpauth/" +categories = ["web-programming::http-server"] +license = "MIT/Apache-2.0" + +[dependencies] +actix-web = "0.6" +base64 = "0.9" diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 000000000..b3844ab27 --- /dev/null +++ b/LICENSE-APACHE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2017-NOW svartalf + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 000000000..a82012880 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,25 @@ +Copyright (c) 2017 svartalf + +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 000000000..cd9f91f30 --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +# actix-web-httpauth diff --git a/src/errors.rs b/src/errors.rs new file mode 100644 index 000000000..f85fd7fd9 --- /dev/null +++ b/src/errors.rs @@ -0,0 +1,63 @@ +use std::fmt; +use std::error; +use std::string; + +use base64; +use actix_web::HttpResponse; +use actix_web::error::ResponseError; +use actix_web::http::{StatusCode, header}; + +#[derive(Debug, PartialEq)] +pub enum Error { + HeaderMissing, // HTTP 401 + // TODO: Ensure that 401 should be returned if not a `Basic` mechanism is received + InvalidMechanism, // HTTP 401 ? + HeaderMalformed, // HTTP 400 +} + +impl fmt::Display for Error { + fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { + let msg = match self { + Error::HeaderMissing => "HTTP 'Authorization' header is missing", + Error::InvalidMechanism => "Wrong mechanizm for a HTTP 'Authorization' header, expected 'Basic'", + Error::HeaderMalformed => "Malformed HTTP 'Authorization' header", + }; + + f.write_str(msg) + } +} + +impl error::Error for Error {} + +impl From for Error { + fn from(_: header::ToStrError) -> Self { + Error::HeaderMalformed + } +} + +impl From for Error { + fn from(_: base64::DecodeError) -> Self { + Error::HeaderMalformed + } +} + +impl From for Error { + fn from(_: string::FromUtf8Error) -> Self { + Error::HeaderMalformed + } +} + +impl ResponseError for Error { + fn error_response(&self) -> HttpResponse { + let status = match self { + Error::HeaderMissing => StatusCode::UNAUTHORIZED, + Error::InvalidMechanism => StatusCode::UNAUTHORIZED, + Error::HeaderMalformed => StatusCode::BAD_REQUEST, + }; + + HttpResponse::build(status) + .header("WWW-Authenticate", "Basic, charset=\"UTF-8\"") + .finish() + } + +} diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 000000000..67bbfb6f1 --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,8 @@ +extern crate actix_web; +extern crate base64; + +mod schemes; +mod errors; + +pub use schemes::*; +pub use errors::Error; diff --git a/src/schemes/basic.rs b/src/schemes/basic.rs new file mode 100644 index 000000000..3000abaec --- /dev/null +++ b/src/schemes/basic.rs @@ -0,0 +1,120 @@ +use base64; +use actix_web::{HttpRequest, HttpMessage, FromRequest}; + +use errors::Error; + +/// Extractor for `Authorization: Basic {payload}` HTTP request header. +/// +/// If header is not present, HTTP 401 will be returned. +/// +/// # Example +/// +/// use actix_web_httpauth::BasicAuth; +/// +/// pub fn handler(auth: BasicAuth) -> String { +/// format!("Hello, {}", auth.username) +/// } +#[derive(Debug, PartialEq)] +pub struct BasicAuth { + pub username: String, + pub password: String, +} + + +impl FromRequest for BasicAuth { + type Config = (); + type Result = Result; + + fn from_request(req: &HttpRequest, _cfg: &>::Config) -> >::Result { + let header = req.headers().get("Authorization") + .ok_or(Error::HeaderMissing)? + .to_str()?; + let mut parts = header.splitn(2, ' '); + + // Authorization mechanism + match parts.next() { + None => return Err(Error::InvalidMechanism), + Some(mechanism) if mechanism != "Basic" => return Err(Error::InvalidMechanism), + _ => () + } + + // Authorization payload + let payload = parts.next().ok_or(Error::HeaderMalformed)?; + let payload = base64::decode(payload)?; + let payload = String::from_utf8(payload)?; + let mut parts = payload.splitn(2, ':'); + let user = parts.next().ok_or(Error::HeaderMalformed)?; + let password = parts.next().ok_or(Error::HeaderMalformed)?; + + Ok(BasicAuth{ + username: user.to_string(), + password: password.to_string(), + }) + } +} + +#[cfg(test)] +mod tests { + use base64; + use actix_web::FromRequest; + use actix_web::test::TestRequest; + + use super::{BasicAuth, Error}; + + #[test] + fn test_valid_auth() { + let value = format!("Basic {}", base64::encode("user:pass")); + let req = TestRequest::with_header("Authorization", value).finish(); + let auth = BasicAuth::extract(&req); + + assert!(auth.is_ok()); + let auth = auth.unwrap(); + assert_eq!(auth.username, "user".to_string()); + assert_eq!(auth.password, "pass".to_string()); + } + + #[test] + fn test_missing_header() { + let req = TestRequest::default().finish(); + let auth = BasicAuth::extract(&req); + + assert!(auth.is_err()); + let err = auth.err().unwrap(); + assert_eq!(err, Error::HeaderMissing); + } + + #[test] + fn test_invalid_mechanism() { + let value = format!("Digest {}", base64::encode("user:pass")); + let req = TestRequest::with_header("Authorization", value).finish(); + let auth = BasicAuth::extract(&req); + + assert!(auth.is_err()); + let err = auth.err().unwrap(); + assert_eq!(err, Error::InvalidMechanism); + } + + #[test] + fn test_invalid_format() { + let value = format!("Basic {}", base64::encode("user")); + let req = TestRequest::with_header("Authorization", value).finish(); + let auth = BasicAuth::extract(&req); + + assert!(auth.is_err()); + let err = auth.err().unwrap(); + assert_eq!(err, Error::HeaderMalformed); + } + + #[test] + fn test_user_without_password() { + let value = format!("Basic {}", base64::encode("user:")); + let req = TestRequest::with_header("Authorization", value).finish(); + let auth = BasicAuth::extract(&req); + + assert!(auth.is_ok()); + assert_eq!(auth.unwrap(), BasicAuth { + username: "user".to_string(), + password: "".to_string(), + }) + } +} diff --git a/src/schemes/mod.rs b/src/schemes/mod.rs new file mode 100644 index 000000000..43d195913 --- /dev/null +++ b/src/schemes/mod.rs @@ -0,0 +1,3 @@ +mod basic; + +pub use self::basic::BasicAuth;