From 926de39360075e4b8653bac0e32f72c7753eb789 Mon Sep 17 00:00:00 2001 From: realaravinth Date: Sat, 2 Jan 2021 12:46:20 +0530 Subject: [PATCH] readme and license --- Cargo.toml | 7 ++ LICENSE-APACHE | 201 +++++++++++++++++++++++++++++++++++++++++++++++ LICENSE-MIT | 25 ++++++ README.md | 21 +++++ src/payload.rs | 207 ------------------------------------------------- 5 files changed, 254 insertions(+), 207 deletions(-) create mode 100644 LICENSE-APACHE create mode 100644 LICENSE-MIT create mode 100644 README.md delete mode 100644 src/payload.rs diff --git a/Cargo.toml b/Cargo.toml index 1a0d597..0ff03a1 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -2,6 +2,13 @@ name = "argon2-creds" version = "0.1.0" authors = ["realaravinth "] +description = "Convenient abstractions for all things credentials" +keywords = ["credentials", "password"] +homepage = "https://github.com/realaravinth/argon2-creds" +repository = "https://github.com/realaravinth/argon2-creds" +documentation = "https://doc.rs/argon2-creds" +license = "MIT OR Apache-2.0" +readme = "README.md" edition = "2018" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..8f5ba39 --- /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 Actix Team + + 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 0000000..95938ef --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,25 @@ +Copyright (c) 2017 Actix Team + +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 0000000..d66293a --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +
+

Argon2-Creds

+

+ Argon2-Creds provides a convenient abstractions for managing + credentials +

+

+ +[![Dependency Status](https://deps.rs/crate/argon2-creds/3.3.2/status.svg)](https://deps.rs/crate/argon2-creds/3.3.2) +
+[![codecov](https://codecov.io/gh/realaravinth/argon2-creds/branch/master/graph/badge.svg)](https://codecov.io/gh/realaravinth/argon2-creds) + +

+ +## Featuers +- [x] PRECIS Framework [UsernameCaseMapped](https://tools.ietf.org/html/rfc8265#page-7) +- [x] Password hashing and validation +- [x] Filters for words that might cause ambiguity. See +[Blacklist](https://github.com/shuttlecraft/The-Big-Username-Blacklist) +- [x] Profanity filter +- [x] Email validation(Regex validation not verification) diff --git a/src/payload.rs b/src/payload.rs deleted file mode 100644 index 64c0f34..0000000 --- a/src/payload.rs +++ /dev/null @@ -1,207 +0,0 @@ -/* -* Copyright (C) 2020 Aravinth Manivannan -* -* This program is free software: you can redistribute it and/or modify -* it under the terms of the GNU Affero General Public License as -* published by the Free Software Foundation, either version 3 of the -* License, or (at your option) any later version. -* -* This program is distributed in the hope that it will be useful, -* but WITHOUT ANY WARRANTY; without even the implied warranty of -* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -* GNU Affero General Public License for more details. -* -* You should have received a copy of the GNU Affero General Public License -* along with this program. If not, see . -*/ - -use ammonia::clean; -use argon2::{self, Config, ThreadMode, Variant, Version}; -use pow_sha256::PoW; -use rand::distributions::Alphanumeric; -use rand::{thread_rng, Rng}; -use serde::{Deserialize, Serialize}; -use unicode_normalization::UnicodeNormalization; -use validator::Validate; -use validator_derive::Validate; - -use super::{beep, filter, forbidden}; -use crate::errors::*; -use crate::SETTINGS; - -#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)] -pub struct UnvalidatedRegisterCreds { - pub username: String, - pub email_id: Option, - pub password: String, - pub pow: PoW>, -} - -#[derive(Debug, Default, Clone, PartialEq, Validate, Deserialize, Serialize)] -pub struct RegisterCreds { - pub username: String, - #[validate(email)] - pub email_id: Option, - pub password: String, -} -//impl AsRef for RegisterCreds { -// fn as_ref(&self) -> &RegisterCreds { -// &self -// } -//} -// -//impl AsMut for RegisterCreds { -// fn as_mut<'a>(&'a mut self) -> &'a mut Self { -// &mut self -// } -//} -impl UnvalidatedRegisterCreds { - pub fn process(&self) -> ServiceResult { - let creds = RegisterCreds::new() - .set_email(&self.email_id)? - .set_username(&self.username) - .validate_fields()? - .set_password(&self.password)? - .build(); - Ok(creds) - } -} - -impl RegisterCreds { - // pub fn create_register_creds<'a>(&'a mut self) -> ServiceResult { - // let creds = RegisterCreds::new() - // .set_email(&u_creds.email_id)? - // .set_username(&u_creds.username) - // .validate_fields()? - // .set_password(&u_creds.password)? - // .build(); - // Ok(creds) - // } - fn new() -> Self { - let registered_creds: RegisterCreds = Default::default(); - registered_creds - } - - fn set_username<'a>(&'a mut self, username: &str) -> &'a mut Self { - self.username = clean(username) - .to_lowercase() - .nfc() - .collect::() - .trim() - .to_owned(); - self - } - - fn set_email<'a>(&'a mut self, email_id: &Option) -> ServiceResult<&'a mut Self> { - if let Some(email) = email_id { - self.email_id = Some(email.trim().to_owned()); - self.validate()?; - } - Ok(self) - } - - fn validate_fields<'a>(&'a mut self) -> ServiceResult<&'a mut Self> { - filter(&self.username)?; - forbidden(&self.username)?; - beep(&self.username)?; - Ok(self) - } - - fn set_password<'a>(&'a mut self, password: &str) -> ServiceResult<&'a mut Self> { - let config = Config { - variant: Variant::Argon2i, - version: Version::Version13, - mem_cost: SETTINGS.password_difficulty.mem_cost, - time_cost: SETTINGS.password_difficulty.time_cost, - lanes: SETTINGS.password_difficulty.lanes, - thread_mode: ThreadMode::Parallel, - secret: &[], - ad: &[], - hash_length: 32, - }; - - let salt: String = thread_rng().sample_iter(&Alphanumeric).take(32).collect(); - self.password = argon2::hash_encoded(password.as_bytes(), salt.as_bytes(), &config)?; - Ok(self) - } - - fn build(&mut self) -> Self { - self.to_owned() - } -} - -#[cfg(test)] -mod tests { - use super::*; - - #[test] - fn utils_register_builer() { - let registered_creds = RegisterCreds::new() - .set_password("password") - .unwrap() - .set_username("realaravinth") - .set_email(&Some("batman@we.net".into())) - .unwrap() - .validate_fields() - .unwrap() - .build(); - - assert_eq!(registered_creds.username, "realaravinth"); - assert_eq!(registered_creds.email_id, Some("batman@we.net".into())); - } - - #[test] - fn utils_register_email_err() { - let mut email_err = RegisterCreds::new() - .set_password("password") - .unwrap() - .set_username("realaravinth") - .build(); - assert_eq!( - email_err.set_email(&Some("sdfasdf".into())), - Err(ServiceError::NotAnEmail) - ); - } - - #[test] - fn utils_create_new_organisation() { - let password = "somepassword"; - let org = RegisterCreds::new() - .set_email(&Some("batman@we.net".into())) - .unwrap() - .set_username("Realaravinth") - .validate_fields() - .unwrap() - .set_password(password) - .unwrap() - .build(); - - assert_eq!(org.username, "realaravinth"); - - assert!( - argon2::verify_encoded(&org.password, password.as_bytes()).unwrap(), - "verify hahsing" - ); - } - - #[test] - fn utils_create_new_profane_organisation() { - let mut profane_org = RegisterCreds::new(); - profane_org.set_username("fuck"); - - assert_eq!( - profane_org.validate_fields(), - Err(ServiceError::UsernameError) - ); - } - - #[test] - fn utils_create_new_forbidden_organisation() { - let mut forbidden_org = RegisterCreds::new().set_username("htaccessasnc").build(); - - assert_eq!( - forbidden_org.validate_fields(), - Err(ServiceError::UsernameError) - ); - } -}