Crate passwordmaker_rs

source ·
Expand description

Library that should allow quick implementation of tools that are compatible with PasswordMaker Pro.

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, 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.

Structs

A cached instance of validated PasswordMaker settings. See new for details.
Settings for the parsing of the user’s input URL. This is used to generate the data parameter for PasswordMaker.

Enums

Error returned if the supplied input did not meet expectations.
The hash algorithm to use, as shown in the GUI of the JavaScript edition of PasswordMaker Pro.
The leet level to use. The higher the value, the more obfuscated the results.
How to handle the URL protocol, or the absence of it, during UrlParsing.
Error returned if creation of a PasswordMaker object failed due to invalid settings.
When the Leet replacement as illustrated in LeetLevel is applied.

Traits

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.
List of hash functions to use. Trait may change in later versions to include constructors for actual hasher objects.
Trait your Md4 hash function needs to implement.
Trait your Md5 hash function needs to implement.
Trait your Ripemd160 hash function needs to implement.
Trait your Sha1 hash function needs to implement.
Trait your Sha256 hash function needs to implement.