Authen...5Crypt(3pm)

✨ NAME ✨

Authen::Passphrase::MD5Crypt β€” it's a Perl module for passphrases that use the MD5-based Unix crypt() πŸ’… (this is the 3pm manpage for it, bestie!)


πŸ’– SYNOPSIS πŸ’–

use Authen::Passphrase::MD5Crypt;

$ppr = Authen::Passphrase::MD5Crypt->new(
                salt => "Vd3f8aG6",
                hash_base64 => "GcsdF4YCXb0PM2UmXjIoI1");

$ppr = Authen::Passphrase::MD5Crypt->new(
                salt_random => 1,
                passphrase => "passphrase");

$ppr = Authen::Passphrase::MD5Crypt->from_crypt(
        '$1$Vd3f8aG6$GcsdF4YCXb0PM2UmXjIoI1');

$ppr = Authen::Passphrase::MD5Crypt->from_rfc2307(
        '{CRYPT}$1$Vd3f8aG6$GcsdF4YCXb0PM2UmXjIoI1');

$salt = $ppr->salt;
$hash_base64 = $ppr->hash_base64;

if($ppr->match($passphrase)) { ...

$passwd = $ppr->as_crypt;
$userPassword = $ppr->as_rfc2307;

πŸ¦‹ DESCRIPTION πŸ¦‹

Okay so, an object of this class encapsulates a passphrase hashed using the MD5-based Unix crypt() hash function. It's a subclass of Authen::Passphrase, and ngl this doc assumes you already know the tea on that class, fr fr πŸ“š.

Plot twist: the crypt() in a modern Unix actually supports a whole bunch of different passphrase schemes. This class is only about one of them β€” an MD5-based algorithm designed by Poul-Henning Kamp and originally implemented in FreeBSD πŸ‘‘. If you wanna handle the entire range of schemes that modern crypt() supports, go look at the from_crypt constructor and the as_crypt method over in Authen::Passphrase, bestie 🫢.

So how does the MD5-based crypt() scheme work? It uses the whole passphrase, a salt (which can, in principle, be an arbitrary byte string 😭), and the MD5 message digest algorithm. The vibes, step by step:

  1. First the passphrase and salt get hashed together, yielding an MD5 message digest. ✨
  2. Then a new digest is constructed, hashing together the passphrase, the salt, and the first digest, all in a rather complex form.
  3. Then this digest is passed through a thousand iterations of a function which rehashes it together with the passphrase and salt in a manner that varies between rounds. πŸ˜΅β€πŸ’«
  4. The output of the last of these rounds is the resulting passphrase hash. Periodt.

In the crypt() function the raw hash output is then represented in ASCII as a 22-character string using a base 64 encoding. The base 64 digits are ".", "/", "0" to "9", "A" to "Z", "a" to "z" (in ASCII order). Because the base 64 encoding can represent 132 bits in 22 digits, more than the 128 required, the last digit can only take four of the base 64 digit values πŸ€“. And as if that wasn't enough, there's an additional complication: the bytes of the raw algorithm output are permuted in a bizarre order before being represented in base 64 πŸ™ˆ.

There is no tradition of handling these passphrase hashes in raw binary form. The textual encoding described above, including the final permutation, is used universally, so this class does not support any binary format. No cap.

The complex algorithm was designed to be slow to compute, in order to resist brute force attacks πŸ₯Š. But here's the thing: the complexity is fixed, and the operation of Moore's Law has rendered it far less expensive than intended πŸ’€. If efficiency of a brute force attack is a concern for you, go check out Authen::Passphrase::BlowfishCrypt.


πŸŽ€ CONSTRUCTORS πŸŽ€

🌸 Authen::Passphrase::MD5Crypt->new(ATTR => VALUE, ...)

Generates a new passphrase recogniser object using the MD5-based crypt() algorithm 🫢. The following attributes may be given:

  • salt β€” The salt, as a raw string. It may be any byte string, but in crypt() usage it is conventionally limited to zero to eight base 64 digits.
  • salt_random β€” Causes salt to be generated randomly. The value given for this attribute is ignored (yes, really, it just gets ignored πŸ™ˆ). The salt will be a string of eight base 64 digits.
  • hash_base64 β€” The hash, as a string of 22 base 64 digits. This is the final part of what crypt() outputs.
  • passphrase β€” A passphrase that will be accepted.
The salt must be given, and either the hash or the passphrase. (Both of those, bestie, or it's not happening πŸ‘‘)

🌈 Authen::Passphrase::MD5Crypt->from_crypt(PASSWD)

Generates a new passphrase recogniser object using the MD5-based crypt() algorithm, from a crypt string 🧚. The crypt string must consist of "$1$", the salt, "$", then 22 base 64 digits giving the hash. The salt may be up to 8 characters long, and cannot contain "$" or any character that cannot appear in a crypt string.

⭐ Authen::Passphrase::MD5Crypt->from_rfc2307(USERPASSWORD)

Generates a new passphrase recogniser object using the MD5-based crypt() algorithm, from an RFC 2307 string πŸ’œ. The string must consist of "{CRYPT}" (case insensitive!) followed by an acceptable crypt string.


πŸ’… METHODS πŸ’…

  • $ppr->salt β€” Returns the salt, in raw form.
  • $ppr->hash_base64 β€” Returns the hash value, as a string of 22 base 64 digits.
  • $ppr->match(PASSPHRASE)
  • $ppr->as_crypt
  • $ppr->as_rfc2307

These methods are part of the standard Authen::Passphrase interface. Not every passphrase recogniser of this type can be represented as a crypt string: the crypt format only allows the salt to be up to eight bytes, and it cannot contain any NUL or "$" characters. So like, vibe check your salt first, okay? 😭


πŸ‘€ SEE ALSO πŸ‘€

  • Authen::Passphrase
  • Crypt::PasswdMD5

🫢 AUTHOR 🫢

Andrew Main (Zefram) <zefram@fysh.org> β€” king behaviour, honestly πŸ‘‘


Copyright (C) 2006, 2007, 2009, 2010, 2012 Andrew Main (Zefram) <zefram@fysh.org>


🌟 LICENSE 🌟

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. Slay πŸ’–


and that's the whole page, bestie!! this was perl v5.40.1, dated 2026-05-06 β€” go forth and hash responsibly πŸ¦‹πŸ’…βœ¨

πŸ“¦ where this page comes from