feat(console-wallet): adds basic grpc authentication

applications/tari_app_grpc/Cargo.toml

@@ -8,18 +8,25 @@ version = "0.36.0"
 edition = "2018"
 
 [dependencies]
-tari_common_types = { version = "^0.36", path = "../../base_layer/common_types"}
-tari_comms = { path = "../../comms/core"}
-tari_core = {  path = "../../base_layer/core"}
+tari_common_types = { version = "^0.36", path = "../../base_layer/common_types" }
+tari_comms = { path = "../../comms/core" }
+tari_core = { path = "../../base_layer/core" }
 tari_crypto = { git = "https://github.com/tari-project/tari-crypto.git", tag = "v0.15.4" }
 tari_script = { path = "../../infrastructure/tari_script" }
 tari_utilities = { git = "https://github.com/tari-project/tari_utilities.git", tag = "v0.4.5" }
 
+argon2 = { version = "0.4.1", features = ["std"] }
+base64 = "0.13.0"
 chrono = { version = "0.4.19", default-features = false }
+digest = "0.9"
+log = "0.4"
+num-traits = "0.2.15"
 prost = "0.9"
 prost-types = "0.9"
-num-traits = "0.2.15"
+rand = "0.8"
+thiserror = "1"
 tonic = "0.6.2"
+zeroize = "1.5"
 
 [build-dependencies]
 tonic-build = "0.6.2"

applications/tari_app_grpc/src/authentication/basic_auth.rs

@@ -0,0 +1,180 @@
+//  Copyright 2022. The Tari Project
+//
+//  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
+//  following conditions are met:
+//
+//  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
+//  disclaimer.
+//
+//  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
+//  following disclaimer in the documentation and/or other materials provided with the distribution.
+//
+//  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote
+//  products derived from this software without specific prior written permission.
+//
+//  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+//  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+//  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+//  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+//  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+//  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
+//  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+use std::{borrow::Cow, string::FromUtf8Error};
+
+use argon2::{password_hash::Encoding, Argon2, PasswordHash, PasswordVerifier};
+use tari_utilities::SafePassword;
+use zeroize::{Zeroize, Zeroizing};
+
+/// Implements [RFC 2617](https://www.ietf.org/rfc/rfc2617.txt#:~:text=The%20%22basic%22%20authentication%20scheme%20is,other%20realms%20on%20that%20server.)
+/// Represents the username and password contained within a Authenticate header.
+#[derive(Debug)]
+pub struct BasicAuthCredentials {
+    pub user_name: String,
+    pub password: SafePassword,
+}
+
+impl BasicAuthCredentials {
+    pub fn new(user_name: String, password: SafePassword) -> Self {
+        Self { user_name, password }
+    }
+
+    /// Creates a `Credentials` instance from a base64 `String`
+    /// which must encode user credentials as `username:password`
+    pub fn decode(auth_header_value: &str) -> Result<Self, BasicAuthError> {
+        let decoded = base64::decode(auth_header_value)?;
+        let as_utf8 = Zeroizing::new(String::from_utf8(decoded)?);
+
+        if let Some((user_name, password)) = as_utf8.split_once(':') {
+            let credentials = Self::new(user_name.into(), password.to_string().into());
+            return Ok(credentials);
+        }
+
+        Err(BasicAuthError::InvalidAuthorizationHeader)
+    }
+
+    /// Creates a `Credentials` instance from an HTTP Authorization header
+    /// which schema is a valid `Basic` HTTP Authorization Schema.
+    pub fn from_header(auth_header: &str) -> Result<BasicAuthCredentials, BasicAuthError> {
+        // check if its a valid basic auth header
+        let (auth_type, encoded_credentials) = auth_header
+            .split_once(' ')
+            .ok_or(BasicAuthError::InvalidAuthorizationHeader)?;
+
+        if encoded_credentials.contains(' ') {
+            // Invalid authorization token received
+            return Err(BasicAuthError::InvalidAuthorizationHeader);
+        }
+
+        // Check the provided authorization header
+        // to be a "Basic" authorization header
+        if auth_type.to_lowercase() != "basic" {
+            return Err(BasicAuthError::InvalidScheme(auth_type.to_string()));
+        }
+
+        let credentials = BasicAuthCredentials::decode(encoded_credentials)?;
+        Ok(credentials)
+    }
+
+    pub fn validate(&self, username: &str, password: &[u8]) -> Result<(), BasicAuthError> {
+        if self.user_name.as_bytes() != username.as_bytes() {
+            return Err(BasicAuthError::InvalidUsername);
+        }
+        // These bytes can leak if the password is not utf-8, but since argon encoding is utf-8 the given
+        // password must be incorrect if conversion to utf-8 fails.
+        let bytes = self.password.reveal().to_vec();
+        let str_password = Zeroizing::new(String::from_utf8(bytes)?);
+        let header_password = PasswordHash::parse(&str_password, Encoding::B64)?;
+        Argon2::default().verify_password(password, &header_password)?;
+        Ok(())
+    }
+
+    pub fn generate_header(username: &str, password: &[u8]) -> Result<String, BasicAuthError> {
+        let password_str = String::from_utf8_lossy(password);
+        let token_str = Zeroizing::new(format!("{}:{}", username, password_str));
+        let mut token = base64::encode(token_str);
+        let header = format!("Basic {}", token);
+        token.zeroize();
+        match password_str {
+            Cow::Borrowed(_) => {},
+            Cow::Owned(mut owned) => owned.zeroize(),
+        }
+        Ok(header)
+    }
+}
+
+/// Authorization Header Error
+#[derive(Debug, thiserror::Error, PartialEq, Eq)]
+pub enum BasicAuthError {
+    #[error("Invalid username")]
+    InvalidUsername,
+    #[error("The HTTP Authorization header value is invalid")]
+    InvalidAuthorizationHeader,
+    #[error("The HTTP Authorization header contains an invalid scheme {0} but only `Basic` is supported")]
+    InvalidScheme(String),
+    #[error("The value expected as a base64 encoded `String` is not encoded correctly: {0}")]
+    InvalidBase64Value(#[from] base64::DecodeError),
+    #[error("The provided binary is not a valid UTF-8 character: {0}")]
+    InvalidUtf8Value(#[from] FromUtf8Error),
+    #[error("Invalid password: {0}")]
+    InvalidPassword(#[from] argon2::password_hash::Error),
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    mod from_header {
+        use super::*;
+
+        #[test]
+        fn it_decodes_from_well_formed_header() {
+            let credentials = BasicAuthCredentials::from_header("Basic YWRtaW46c2VjcmV0").unwrap();
+            assert_eq!(credentials.user_name, "admin");
+            assert_eq!(credentials.password.reveal(), b"secret");
+        }
+
+        #[test]
+        fn it_rejects_header_without_basic_scheme() {
+            let err = BasicAuthCredentials::from_header(" YWRtaW46c2VjcmV0").unwrap_err();
+            assert_eq!(err, BasicAuthError::InvalidScheme("".to_string()));
+            let err = BasicAuthCredentials::from_header("Cookie YWRtaW46c2VjcmV0").unwrap_err();
+            assert_eq!(err, BasicAuthError::InvalidScheme("Cookie".to_string()));
+        }
+    }
+
+    mod validate {
+        use super::*;
+        use crate::authentication::salted_password::create_salted_hashed_password;
+
+        #[test]
+        fn it_validates_for_matching_credentials() {
+            let hashed = create_salted_hashed_password(b"secret").unwrap();
+            let credentials = BasicAuthCredentials::new("admin".to_string(), hashed.to_string().into());
+            credentials.validate("admin", b"secret").unwrap();
+        }
+
+        #[test]
+        fn it_rejects_for_mismatching_credentials() {
+            let credentials = BasicAuthCredentials::new("admin".to_string(), "bruteforce".to_string().into());
+            let err = credentials.validate("admin", b"secret").unwrap_err();
+            assert!(matches!(err, BasicAuthError::InvalidPassword(_)));
+
+            let credentials = BasicAuthCredentials::new("bruteforce".to_string(), "secret".to_string().into());
+            let err = credentials.validate("admin", b"secret").unwrap_err();
+            assert_eq!(err, BasicAuthError::InvalidUsername);
+        }
+    }
+
+    mod generate_header {
+        use super::*;
+
+        #[test]
+        fn it_generates_a_valid_header() {
+            let header = BasicAuthCredentials::generate_header("admin", b"secret").unwrap();
+            let cred = BasicAuthCredentials::from_header(&header).unwrap();
+            assert_eq!(cred.user_name, "admin");
+            assert_eq!(cred.password.reveal(), &b"secret"[..]);
+        }
+    }
+}

applications/tari_app_grpc/src/authentication/client_interceptor.rs

@@ -0,0 +1,65 @@
+//  Copyright 2022. The Tari Project
+//
+//  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
+//  following conditions are met:
+//
+//  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
+//  disclaimer.
+//
+//  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
+//  following disclaimer in the documentation and/or other materials provided with the distribution.
+//
+//  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote
+//  products derived from this software without specific prior written permission.
+//
+//  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+//  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+//  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+//  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+//  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+//  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
+//  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+use tari_common_types::grpc_authentication::GrpcAuthentication;
+use tonic::{
+    codegen::http::header::AUTHORIZATION,
+    metadata::{Ascii, MetadataValue},
+    service::Interceptor,
+    Request,
+    Status,
+};
+
+use crate::authentication::{BasicAuthCredentials, BasicAuthError};
+
+#[derive(Debug, Clone)]
+pub struct ClientAuthenticationInterceptor {
+    authorization_header: Option<MetadataValue<Ascii>>,
+}
+
+impl ClientAuthenticationInterceptor {
+    pub fn create(auth: &GrpcAuthentication) -> Result<Self, BasicAuthError> {
+        let authorization_header = match auth {
+            GrpcAuthentication::None => None,
+            GrpcAuthentication::Basic { username, password } => Some(
+                BasicAuthCredentials::generate_header(username, password.reveal())?
+                    .parse()
+                    .unwrap(),
+            ),
+        };
+        Ok(Self { authorization_header })
+    }
+}
+
+impl Interceptor for ClientAuthenticationInterceptor {
+    fn call(&mut self, mut request: Request<()>) -> Result<Request<()>, Status> {
+        match self.authorization_header.clone() {
+            Some(authorization_header) => {
+                request
+                    .metadata_mut()
+                    .insert(AUTHORIZATION.as_str(), authorization_header);
+                Ok(request)
+            },
+            None => Ok(request),
+        }
+    }
+}