1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
use std::collections::HashMap;
use std::path::Path;
use std::sync::Arc;
use actix_web::{HttpRequest, web};
use actix_web::http::header::HeaderValue;
use chrono::Utc;
use fernet::Fernet;
use crate::constant;
use crate::squire;
/// Represents user credentials extracted from an authorization header.
///
/// Contains the username, signature, and timestamp obtained by decoding and parsing the authorization header.
struct Credentials {
username: String,
signature: String,
timestamp: String,
}
/// Represents the result of authentication, indicating whether it was successful or not.
///
/// If successful, it includes the username and a generated key for the session.
pub struct AuthToken {
pub ok: bool,
pub detail: String,
pub username: String,
pub time_left: i64
}
/// Extracts credentials from the authorization header in the following steps
///
/// # Arguments
///
/// * `authorization` - An optional `HeaderValue` containing the authorization header.
///
/// # See Also
/// - Decodes the base64 encoded header
/// - Splits it into 3 parts with first one being the username followed by the signature and timestamp
/// - Converts the username from hex into a string.
///
/// # Returns
///
/// Returns a `Result` containing the extracted `Credentials` or an error message if extraction fails.
fn extract_credentials(authorization: &HeaderValue) -> Result<Credentials, &'static str> {
let header = authorization.to_str().unwrap().to_string();
// base64 encoded in JavaScript using inbuilt btoa function
let b64_decode_response = squire::secure::base64_decode(&header);
return match b64_decode_response {
Ok(decoded_auth) => {
if decoded_auth.is_empty() {
log::warn!("Authorization header was received without a value");
return Err("No credentials received");
}
let vector: Vec<&str> = decoded_auth.split(',').collect();
Ok(Credentials {
// Decode hex username into string to retrieve password from config file
username: squire::secure::hex_decode(vector.first().unwrap()),
signature: vector.get(1).unwrap().to_string(),
timestamp: vector.get(2).unwrap().to_string(),
})
}
Err(err) => {
Err(err)
}
};
}
/// Verifies user login based on extracted credentials and configuration settings.
///
/// # Arguments
///
/// * `request` - A reference to the Actix web `HttpRequest` object.
/// * `config` - Configuration data for the application.
/// * `session` - Session struct that holds the `session_mapping` and `session_tracker` to handle sessions.
///
/// # Returns
///
/// Returns a `Result` containing a `HashMap` with session information if authentication is successful,
/// otherwise returns an error message.
pub fn verify_login(
request: &HttpRequest,
config: &web::Data<Arc<squire::settings::Config>>,
session: &web::Data<Arc<constant::Session>>,
) -> Result<HashMap<&'static str, String>, String> {
let err_response;
if let Some(authorization) = request.headers().get("authorization") {
let extracted_credentials = extract_credentials(authorization);
match extracted_credentials {
Ok(credentials) => {
// Check if the username is present in HashMap as key
if let Some(password) = config.authorization.get(&credentials.username) {
let message = format!("{}{}{}",
squire::secure::hex_encode(&credentials.username),
squire::secure::hex_encode(password),
credentials.timestamp);
// Create a new signature with hex encoded username and password stored in config file as plain text
let expected_signature = squire::secure::calculate_hash(message);
if expected_signature == credentials.signature {
let key = squire::secure::keygen();
session.mapping.lock().unwrap().insert(credentials.username.to_string(), key.to_string());
let mut mapped = HashMap::new();
mapped.insert("username", credentials.username.to_string());
mapped.insert("key", key.to_string());
mapped.insert("timestamp", credentials.timestamp.to_string());
return Ok(mapped);
} else {
log::warn!("{} entered bad credentials", credentials.username);
err_response = "Incorrect username or password";
}
} else {
log::warn!("{} is not allowed", credentials.username);
err_response = "Incorrect username or password";
}
}
Err(err) => {
err_response = err;
}
}
} else {
log::warn!("Authorization header was missing");
err_response = "No credentials received";
}
Err(err_response.to_string())
}
/// Verifies a session token extracted from an HTTP request against stored session mappings and configuration.
///
/// # Arguments
///
/// * `request` - A reference to the Actix web `HttpRequest` object.
/// * `config` - Configuration data for the application.
/// * `fernet` - Fernet object to encrypt the auth payload that will be set as `session_token` cookie.
/// * `session` - Session struct that holds the `session_mapping` and `session_tracker` to handle sessions.
///
/// # Returns
///
/// Returns an instance of the `AuthToken` struct indicating the result of the token verification.
pub fn verify_token(
request: &HttpRequest,
config: &squire::settings::Config,
fernet: &Fernet,
session: &constant::Session,
) -> AuthToken {
if session.mapping.lock().unwrap().is_empty() {
log::warn!("No stored sessions, no point in validating further");
return AuthToken {
ok: false,
detail: "Server doesn't recognize your session".to_string(),
username: "NA".to_string(),
time_left: 0
};
}
if let Some(cookie) = request.cookie("session_token") {
if let Ok(decrypted) = fernet.decrypt(cookie.value()) {
let payload: HashMap<String, String> = serde_json::from_str(&String::from_utf8_lossy(&decrypted)).unwrap();
let username = payload.get("username").unwrap().to_string();
let cookie_key = payload.get("key").unwrap().to_string();
let timestamp = payload.get("timestamp").unwrap().parse::<i64>().unwrap();
let stored_key = session.mapping.lock().unwrap().get(&username).unwrap().to_string();
let current_time = Utc::now().timestamp();
// Max time and expiry for session token is set in the Cookie, but this is a fallback mechanism
if stored_key != *cookie_key {
return AuthToken {
ok: false,
detail: "Invalid session token".to_string(),
username,
time_left: 0
};
}
if current_time - timestamp > config.session_duration {
return AuthToken {
ok: false,
detail: "Session Expired".to_string(),
username,
time_left: 0
};
}
let time_left = timestamp + config.session_duration - current_time;
AuthToken {
ok: true,
detail: format!("Session valid for {}s", time_left),
username,
time_left
}
} else {
AuthToken {
ok: false,
detail: "Invalid session token".to_string(),
username: "NA".to_string(),
time_left: 0
}
}
} else {
AuthToken {
ok: false,
detail: "Session information not found".to_string(),
username: "NA".to_string(),
time_left: 0
}
}
}
/// Verifies the secure index of the directory/file that's being accessed.
///
/// # Arguments
/// * `path` - A reference to the `PathBuf` object that's being accessed.
/// * `username` - Username of the session.
///
/// ## See Also
/// **Content delivery endpoints**
/// * `stream` - Servers the content's landing page.
/// * `track` - Servers the content's subtitles track.
/// * `media` - Servers the content as a streaming response.
/// * `home` - Servers the content's listing page.
///
/// **Endpoints that require secure index validation**
/// * `stream` - Handles validation for both the landing page and subdirectories.
/// * `media` - Handles validation for streaming the requested content.
/// * `track` - Handles validation for subtitles track file.
///
/// # Returns
///
/// Returns a boolean value to indicate if the access can be granted.
pub fn verify_secure_index(path: &Path, username: &String) -> bool {
for dir in path.iter() {
let child = dir.to_string_lossy().to_string();
if child.ends_with(constant::SECURE_INDEX) && child != format!("{}_{}", username, constant::SECURE_INDEX) {
let user_dir = child
.strip_suffix(constant::SECURE_INDEX).unwrap()
.strip_suffix('_').unwrap();
log::warn!("'{}' tried to access {:?} that belongs to '{}'", username, path, user_dir);
return false;
}
}
true
}