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 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351
#![warn(clippy::pedantic)]
#![warn(missing_docs)]
//#![allow(clippy::doc_markdown)]
//! Library that should allow quick implementation of tools that are compatible with [PasswordMaker Pro](https://passwordmaker.org).
//!
//! It forms the core of an upcoming PasswordMaker Pro compatible Sailfish OS App (as of yet unnamed).
//! This library intentionally does not depend on any specific implementation of the cryptographic hashes
//! it relies on. To see an example of how to integrate with the [Rust Crypto Hashes](https://github.com/RustCrypto/hashes),
//! see the integration tests.
//!
//! # Description
//! There are two types in this library, you'll likely want to use: [`UrlParsing`] and [`PasswordMaker`].
//!
//! [`UrlParsing`] takes a user-supplied string, and generates another string from it, according to the passed in settings.
//! The idea is to strip unwanted parts of an URI when generating passwords. For instance, you usually want the same result
//! for all sub-pages of a given website.
//!
//! [`PasswordMaker`] is the main part of this crate. You give it settings similar to those of a PasswordMaker Pro profile,
//! and it gives you a password that's hopfully the same you'd get from PasswordMaker Pro for the same input.
//!
//! # Features
//! The library comes with a set of precomputed powers to (slightly) speed up computation in common use cases. By default, constants
//! for the lengths of the pre-defined character sets of PasswordMaker Pro are included (10, 16, 32, 52, 62, 94), amounting to a total
//! of 360 bytes on a 32bit machine, and 408 bytes on a 64bit machine (and some instructions to read them). For all other character
//! set lengths the values are computed at runtime when needed. Those values are in the (default-enabled)
//! `precomputed_common_max_powers` feature.
//!
//! If you prefer simpler code and want to save a couple of bytes in the binary, you can disable `default-features` to use runtime
//! computation for all values, at the cost of a slight performance impact.
//!
//! On the other hand, if binary size is not of concern, you might want to enable the `precomputed_max_powers` feature.
//! This feature enables precomputed powers for all bases in the range 2..130. It therefore needs 7680 bytes on a 32bit machine, and
//! 8704 bytes on a 64bit machine (plus some extra instructions).
//!
//! # Warning
//! This library has NOT been tested on 16bit machines. It might work, but probably does not.
mod passwordmaker;
mod url_parsing;
use passwordmaker::{PasswordPartParameters, PasswordAssemblyParameters};
use passwordmaker::leet::LeetReplacementTable;
use std::error::Error;
use std::fmt::Display;
use std::marker::PhantomData;
/// Trait you need to implement for the various hash functions you need to provide.
/// Currently only a single function, that computes the hash of a string slice, is needed. This may change in a later version.
///
/// Beware: There is currently no way to put constraints on associated constants in Rust, so Block Size is not exposed.
/// It's anyhow the same (currently hardcoded) value for all supported algorithms.
pub trait Hasher {
/// The output type of the respective hash function. Typically some form of byte array.
type Output;
/// Function that takes a byte array as input, and generates the cryptographic hash of it as output.
fn hash(input : &[u8]) -> Self::Output;
}
/// Trait your Md4 hash function needs to implement.
pub trait Md4 : Hasher<Output = [u8;16]> {}
/// Trait your Md5 hash function needs to implement.
pub trait Md5 : Hasher<Output = [u8;16]> {}
/// Trait your Sha1 hash function needs to implement.
pub trait Sha1 : Hasher<Output = [u8;20]> {}
/// Trait your Sha256 hash function needs to implement.
pub trait Sha256 : Hasher<Output = [u8;32]> {}
/// Trait your Ripemd160 hash function needs to implement.
pub trait Ripemd160 : Hasher<Output = [u8;20]> {}
/// List of hash functions to use. Trait may change in later versions to include constructors for actual hasher objects.
pub trait HasherList {
/// The type that offers MD4 hashing. See the [`Md4`] trait.
type MD4 : Md4;
/// The type that offers MD5 hashing. See the [`Md5`] trait.
type MD5 : Md5;
/// The type that offers SHA1 hashing. See the [`Sha1`] trait.
type SHA1 : Sha1;
/// The type that offers SHA256 hashing. See the [`Sha256`] trait.
type SHA256 : Sha256;
/// The type that offers Ripemd160 hashing. See the [`Ripemd160`] trait.
type RIPEMD160 : Ripemd160;
}
/// A cached instance of validated `PasswordMaker` settings. See [`new`][PasswordMaker::new] for details.
pub struct PasswordMaker<'a, T : HasherList>{
username : &'a str,
modifier : &'a str,
password_part_parameters : PasswordPartParameters<'a>, //contains pre_leet, as this is different for different algorithms
post_leet : Option<LeetReplacementTable>, //same for all algorithms. applied before before password assembly.
assembly_settings : PasswordAssemblyParameters<'a>,
_hashers : PhantomData<T>,
}
impl<'a, T : HasherList> PasswordMaker<'a, T>{
/// Validates user input and returns a `PasswordMaker` object if the input is valid.
///
/// `hash_algorithm` is a PasswordMaker Pro algorithm selection.
/// `use_leet` details when to use leet, if at all.
/// `characters` is the list of output password characters. Actually this is not true. It's the list of grapheme clusters.
/// `username` is the "username" field of PasswordMaker Pro.
/// `modifier` is the "modifier" field of PasswordMaker Pro.
/// `password_length` is the desired password length to generate.
/// `prefix` is the prefix to which the password gets appended. Counts towards `password_length`.
/// `suffix` is the suffix appended to the password. Counts towards `password_length`.
///
/// # Errors
/// Fails if characters does not contain at least 2 grapheme clusters. Mapping to output happens by number system conversion,
/// and a number system base 1 or base 0 does not make any sense.
#[allow(clippy::too_many_arguments)]
pub fn new(
hash_algorithm : HashAlgorithm,
use_leet : UseLeetWhenGenerating,
characters : &'a str,
username : &'a str,
modifier: &'a str,
password_length : usize,
prefix : &'a str,
suffix : &'a str,
) -> Result<Self, SettingsError> {
if Self::is_suitable_as_output_characters(characters) {
let post_leet = match &use_leet {
UseLeetWhenGenerating::NotAtAll
| UseLeetWhenGenerating::Before { .. }
=> None,
UseLeetWhenGenerating::After { level }
| UseLeetWhenGenerating::BeforeAndAfter { level }
=> Some(LeetReplacementTable::get(*level)),
};
Ok(PasswordMaker {
username,
modifier,
password_part_parameters: PasswordPartParameters::from_public_parameters(hash_algorithm, use_leet, characters),
post_leet,
assembly_settings: PasswordAssemblyParameters::from_public_parameters(prefix, suffix, password_length),
_hashers: PhantomData,
})
} else {
Err(SettingsError::InsufficientCharset)
}
}
/// Generates a password for the given `data` and `key`.
/// `data` is the "text-to-use", typically the output of [`UrlParsing`].
/// `key` is the key, also known as "master password".
///
/// # Errors
/// Fails if either of the parameters has zero-length.
pub fn generate(&self, data: String, key: String) -> Result<String, GenerationError> {
if data.is_empty() {
Err(GenerationError::MissingTextToUse)
} else if key.is_empty(){
Err(GenerationError::MissingMasterPassword)
} else {
Ok(self.generate_password_verified_input(data, key))
}
}
}
/// The leet level to use. The higher the value, the more obfuscated the results.
#[cfg_attr(test, derive(strum_macros::EnumIter))]
#[derive(Debug,Clone, Copy)]
pub enum LeetLevel {
/// First Leet level:\
/// `["4", "b", "c", "d", "3", "f", "g", "h", "i", "j", "k", "1", "m", "n", "0", "p", "9", "r", "s", "7", "u", "v", "w", "x", "y", "z"]`
One,
/// Second Leet level:\
/// `["4", "b", "c", "d", "3", "f", "g", "h", "1", "j", "k", "1", "m", "n", "0", "p", "9", "r", "5", "7", "u", "v", "w", "x", "y", "2"]`
Two,
/// Third Leet level:\
/// `["4", "8", "c", "d", "3", "f", "6", "h", "'", "j", "k", "1", "m", "n", "0", "p", "9", "r", "5", "7", "u", "v", "w", "x", "'/", "2"]`
Three,
/// Fourth Leet level:\
/// `["@", "8", "c", "d", "3", "f", "6", "h", "'", "j", "k", "1", "m", "n", "0", "p", "9", "r", "5", "7", "u", "v", "w", "x", "'/", "2"]`
Four,
/// Fifth Leet level:\
/// `["@", "|3", "c", "d", "3", "f", "6", "#", "!", "7", "|<", "1", "m", "n", "0", "|>", "9", "|2", "$", "7", "u", "\\/", "w", "x", "'/", "2"]`
Five,
/// Sixth Leet level:\
/// `["@", "|3", "c", "|)", "&", "|=", "6", "#", "!", ",|", "|<", "1", "m", "n", "0", "|>", "9", "|2", "$", "7", "u", "\\/", "w", "x", "'/", "2"]`
Six,
/// Seventh Leet level:\
/// `["@", "|3", "[", "|)", "&", "|=", "6", "#", "!", ",|", "|<", "1", "^^", "^/", "0", "|*", "9", "|2", "5", "7", "(_)", "\\/", "\\/\\/", "><", "'/", "2"]`
Seven,
/// Eigth Leet level:\
/// `["@", "8", "(", "|)", "&", "|=", "6", "|-|", "!", "_|", "|(", "1", "|\\/|", "|\\|", "()", "|>", "(,)", "|2", "$", "|", "|_|", "\\/", "\\^/", ")(", "'/", "\"/_"]`
Eight,
/// Ninth Leet level:\
/// `["@", "8", "(", "|)", "&", "|=", "6", "|-|", "!", "_|", "|{", "|_", "/\\/\\", "|\\|", "()", "|>", "(,)", "|2", "$", "|", "|_|", "\\/", "\\^/", ")(", "'/", "\"/_"]`
Nine,
}
/// The hash algorithm to use, as shown in the GUI of the JavaScript edition of PasswordMaker Pro.
///
/// # Description
///
/// Most algorithms work by computing the hash of the input values and doing a number system base conversion to indices into
/// the supplied character array.
/// Notable exceptions are the HMAC algorithms, which not only compute the HMAC for the input, but also, before that, encode the
/// input as UTF-16 and discard all upper bytes.
/// The `Md5Version06` variant is for compatibility with ancient versions of PasswordMaker Pro. Not only does it also do the conversion
/// to UTF-16 and the discarding of the upper bytes, in addition it disregards the user-supplied character set completely, and instead
/// just outputs the hash encoded as hexadecimal numbers.
/// The `HmacMd5Version06` is similarly ignoring the supplied characters and using hexadecimal numbers as output.
#[derive(Debug,Clone, Copy)]
pub enum HashAlgorithm {
/// Regular Md4 PasswordMaker Pro setting.
Md4,
/// HAMC Md4 PasswordMaker Pro setting. Encodes input as UTF-16 and discards upper byte (just as PasswordMaker Pro does for HMAC).
HmacMd4,
/// Regular Md5 PasswordMaker Pro setting.
Md5,
/// Md5 as computed by PasswordMaker Pro version 0.6. Encodes input as UTF-16 and discards upper byte and outputs MD5 as hex number.
Md5Version06,
/// HMAC Md5 PasswordMaker Pro setting. Encodes input as UTF-16 and discards upper byte (just as PasswordMaker Pro does for HMAC).
HmacMd5,
/// HMAC Md5 as computed by PasswordMaker Pro version 0.6. Encodes input as UTF-16 and discards upper byte and outputs MD5 as hex number.
HmacMd5Version06,
/// Regular Sha1 PasswordMaker Pro setting.
Sha1,
/// HAMC Sha1 PasswordMaker Pro setting. Encodes input as UTF-16 and discards upper byte (just as PasswordMaker Pro does for HMAC).
HmacSha1,
/// Regular Sha256 PasswordMaker Pro setting.
Sha256,
/// HAMC Sha256 PasswordMaker Pro setting. Encodes input as UTF-16 and discards upper byte (just as PasswordMaker Pro does for HMAC).
HmacSha256,
/// Regular Ripemd160 PasswordMaker Pro setting.
Ripemd160,
/// HAMC Ripemd160 PasswordMaker Pro setting. Encodes input as UTF-16 and discards upper byte (just as PasswordMaker Pro does for HMAC).
HmacRipemd160,
}
/// When the Leet replacement as illustrated in [`LeetLevel`] is applied.
///
/// # Description
/// If Leet is enabled, the input will be converted to lower case.
/// It is always applied to each password part when the required password length
/// is longer than the length obtained by computing a single hash. This is important if the input data or output charset contains certain
/// characters where the lower case representation depends on context (e.g. 'Σ').
#[derive(Debug,Clone, Copy)]
pub enum UseLeetWhenGenerating {
/// Do not apply Leet on input or output.
NotAtAll,
/// Apply Leet on the input before computing a password part.
Before {
/// The Leet level to apply to the input.
level : LeetLevel,
},
/// Apply Leet on the generated password-part. Beware that this will force the password to lower-case characters.
After {
/// The Leet level to apply to the generated password parts.
level : LeetLevel,
},
/// Apply Leet both, to the input for the hasher, and the generated password parts. Beware that this will force the password to lower-case characters.
BeforeAndAfter {
/// The Leet level to apply to both, input and generated password parts.
level : LeetLevel,
},
}
/// Settings for the parsing of the user's input URL.
/// This is used to generate the `data` parameter for [`PasswordMaker`].
#[allow(clippy::struct_excessive_bools)]
#[derive(Debug, Clone)]
pub struct UrlParsing {
use_protocol : ProtocolUsageMode,
use_userinfo : bool,
use_subdomains : bool,
use_domain : bool,
use_port_path : bool,
}
#[allow(clippy::fn_params_excessive_bools)]
impl UrlParsing {
/// Creates a new `UrlParsing` instance with the given settings.
#[must_use]
pub fn new(
use_protocol : ProtocolUsageMode,
use_userinfo : bool,
use_subdomains : bool,
use_domain : bool,
use_port_path : bool,
) -> Self{
UrlParsing{ use_protocol, use_userinfo, use_subdomains, use_domain, use_port_path, }
}
/// Parses an input string, applying the settings in `self`, and generates a string suitable for
/// the `data` parameter of [`PasswordMaker`]
#[must_use]
pub fn parse(&self, input : &str) -> String{
self.make_used_text_from_url(input)
}
}
/// How to handle the URL protocol, or the absence of it, during [`UrlParsing`].
///
/// # Description
/// The "Use Protocol" checkbox in PasswordMaker Pro Javascript Edition has some weird behaviour, that's probably a bug.
/// This enum lets you select how to hande the case that the user wants to use the Protocol, but the input string doesn't contain one.
#[derive(Debug, Clone, Copy)]
pub enum ProtocolUsageMode{
/// The protocol part of the URI is not used in the output.
Ignored,
/// The protocol part of the URI is used in the output, if it's non-empty in the input. Otherwise it isn't.
Used,
/// The protocol part of the URI is used in the output, if it's non-empty in the input. Otherwise the string "undefined" is used in the output.
/// This mirrors behaviour of the PasswordMaker Pro Javascript Edition.
UsedWithUndefinedIfEmpty,
}
/// Error returned if the supplied input did not meet expectations.
#[derive(Debug, Clone, Copy)]
pub enum GenerationError {
/// Password generation failed, because the user did not supply a master password.
MissingMasterPassword,
/// Password generation failed, because the user did not supply a text-to-use.
MissingTextToUse,
}
impl Display for GenerationError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
GenerationError::MissingMasterPassword => write!(f, "No master password given."),
GenerationError::MissingTextToUse => write!(f, "No text to use. Would just hash the master password."),
}
}
}
impl Error for GenerationError{}
/// Error returned if creation of a `PasswordMaker` object failed due to invalid settings.
///
/// # Description
/// `InsufficientCharset` means that the output character set does not contain at least two grapheme clusters.
/// Since the output string is computed by doing a base system conversion from binary to number-of-grapheme-clusters,
/// any number of grapheme clusters lower than 2 forms a nonsensical input. There simply is no base-1 or base-0 number system.
#[derive(Debug, Clone, Copy)]
pub enum SettingsError {
/// Password generation failed, because the character set supplied by the user did not contain at least 2 grapheme clusters.
InsufficientCharset,
}
impl Display for SettingsError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
SettingsError::InsufficientCharset => write!(f, "Charset needs to have at least 2 characters."),
}
}
}
impl Error for SettingsError{}