diff options
| author | Eli Collins <elic@assurancetechnologies.com> | 2016-10-04 12:32:24 -0400 |
|---|---|---|
| committer | Eli Collins <elic@assurancetechnologies.com> | 2016-10-04 12:32:24 -0400 |
| commit | 4a8c04e2f2a232dbd021e094ef718066f5d63268 (patch) | |
| tree | 7662a47501d0124dbbc8834b8830787ab0dccd0c /docs/modular_crypt_format.rst | |
| parent | 1f09d22394fdd2c82e77529f78cbb5f920d096f8 (diff) | |
| download | passlib-4a8c04e2f2a232dbd021e094ef718066f5d63268.tar.gz | |
docs: marked MCF as "deprecated" in favor of PHC format, notes scrypt & argon2 PHC compatibility.
Diffstat (limited to 'docs/modular_crypt_format.rst')
| -rw-r--r-- | docs/modular_crypt_format.rst | 20 |
1 files changed, 14 insertions, 6 deletions
diff --git a/docs/modular_crypt_format.rst b/docs/modular_crypt_format.rst index 3c5480d..c70933b 100644 --- a/docs/modular_crypt_format.rst +++ b/docs/modular_crypt_format.rst @@ -1,5 +1,6 @@ .. index:: modular crypt format +.. _phc-format: .. _modular-crypt-format: .. rst-class:: html-toggle @@ -12,6 +13,19 @@ Modular Crypt Format A explanation about a standard that isn't +.. rst-class:: without-title + +.. seealso:: + **Deprecated (as of 2016) in favor of the PHC String Format** + + In the opinion of the main Passlib author, the modular crypt format (described below) + should be considered deprecated when creating new hashes. + The `PHC String Format <https://github.com/P-H-C/phc-string-format/blob/master/phc-sf-spec.md>`_ + is an attempt to specify a common hash string format + that's a restricted & well defined subset of the Modular Crypt Format. + New hashes are strongly encouraged to adhere to the PHC specification, + rather than the much looser Modular Crypt Format. + Overview ======== A number of the hashes in Passlib are described as adhering to the "Modular Crypt Format". @@ -32,12 +46,6 @@ The modular crypt format is more of an ad-hoc idea rather than a true standard. The rest of this page is an attempt to describe what is known, at least as far as the hashes supported by Passlib. -.. seealso:: - - The `PHC string format <https://github.com/P-H-C/phc-string-format/blob/master/phc-sf-spec.md>` - is a recent attempt to specify a common hash string format, - that's a restricted (& more well defined) subset of the modular crypt format. - History ======= Historically, most unix systems supported only :class:`~passlib.hash.des_crypt`. |