mcf 0.0.0

Pure Rust implementation of the Modular Crypt Format (MCF) which is used to store password hashes in the form `${id}$...`
Documentation 
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

# [RustCrypto]: Modular Crypt Format

[![crate][crate-image]][crate-link]
[![Docs][docs-image]][docs-link]
[![Build Status][build-image]][build-link]
![Apache2/MIT licensed][license-image]
![Rust Version][rustc-image]
[![Project Chat][chat-image]][chat-link]

Pure Rust implementation of the Modular Crypt Format (MCF), which is used to store password hashes.

## About

Modular Crypt Format is the name for a bespoke set of formats that take the form `${id}$...`, where
`{id}` is a short numeric or lower case alphanumeric algorithm identifier optionally containing a
hyphen character (`-`), followed  by `$` as a delimiter, further followed by an algorithm-specific
serialization of a password hash, typically  using a variant (often an algorithm-specific variant)
of Base64.

This algorithm-specific  serialization contains one or more fields `${first}[${second}]...`, where
each field only uses characters in the regexp range `[A-Za-z0-9./+=,\-]`.

Note that MCF has no official specification describing it, and no central registry of identifiers
exists, nor are there more specific rules for the format than outlined above. MCF is more of an
ad hoc idea of how to serialize password hashes rather than a standard.

This crate provides types for working with Modular Crypt Format in as generic a manner as possible.

For more information and history on MCF, see the [PassLib documentation].

### Example (SHA-crypt w\ SHA-512):

```text
$6$rounds=100000$exn6tVc2j/MZD8uG$BI1Xh8qQSK9J4m14uwy7abn.ctj/TIAzlaVCto0MQrOFIeTXsc1iwzH16XEWo/a7c7Y9eVJvufVzYAs4EsPOy0
```

## Minimum Supported Rust Version

This crate requires **Rust 1.85** at a minimum.

We may change the MSRV in the future, but it will be accompanied by a minor
version bump.

## License

Licensed under either of:

 * [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)
 * [MIT license](http://opensource.org/licenses/MIT)

at your option.

### Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.

[//]: # (badges)

[crate-image]: https://img.shields.io/crates/v/mcf
[crate-link]: https://crates.io/crates/mcf
[docs-image]: https://docs.rs/mcf/badge.svg
[docs-link]: https://docs.rs/mcf/
[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
[rustc-image]: https://img.shields.io/badge/rustc-1.85+-blue.svg
[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg
[chat-link]: https://rustcrypto.zulipchat.com/#narrow/stream/300570-formats
[build-image]: https://github.com/RustCrypto/formats/actions/workflows/mcf.yml/badge.svg
[build-link]: https://github.com/RustCrypto/formats/actions/workflows/mcf.yml

[//]: # (links)

[RustCrypto]: https://github.com/rustcrypto
[PassLib documentation]: https://passlib.readthedocs.io/en/stable/modular_crypt_format.html