Joomla! Documentation™

The "API15" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

Description

Formats a password using the current encryption.

Syntax

getCryptedPassword($plaintext, $salt= '', $encryption= 'md5-hex', $show_encrypt=false)

Parameter Name	Default Value	Description
$plaintext		$plaintext The plaintext password to encrypt.
$salt		$salt The salt to use to encrypt the password. [] If not present, a new salt will be generated.
$encryption	'md5-hex'	$encryption The kind of pasword encryption to use. Defaults to md5-hex.
$show_encrypt	false	$show_encrypt Some password systems prepend the kind of encryption to the crypted password ({SHA}, etc). Defaults to false.

Returns

string The encrypted password.

Defined in

libraries/joomla/user/helper.php

Importing

jimport( 'joomla.user.helper' );

Source Body

function getCryptedPassword($plaintext, $salt = '', $encryption = 'md5-hex', $show_encrypt = false)
{
        // Get the salt to use.
        $salt = JUserHelper::getSalt($encryption, $salt, $plaintext);

        // Encrypt the password.
        switch ($encryption)
        {
                case 'plain' :
                        return $plaintext;

                case 'sha' :
                        $encrypted = base64_encode(mhash(MHASH_SHA1, $plaintext));
                        return ($show_encrypt) ? '{SHA}'.$encrypted : $encrypted;

                case 'crypt' :
                case 'crypt-des' :
                case 'crypt-md5' :
                case 'crypt-blowfish' :
                        return ($show_encrypt ? '{crypt}' : '').crypt($plaintext, $salt);

                case 'md5-base64' :
                        $encrypted = base64_encode(mhash(MHASH_MD5, $plaintext));
                        return ($show_encrypt) ? '{MD5}'.$encrypted : $encrypted;

                case 'ssha' :
                        $encrypted = base64_encode(mhash(MHASH_SHA1, $plaintext.$salt).$salt);
                        return ($show_encrypt) ? '{SSHA}'.$encrypted : $encrypted;

                case 'smd5' :
                        $encrypted = base64_encode(mhash(MHASH_MD5, $plaintext.$salt).$salt);
                        return ($show_encrypt) ? '{SMD5}'.$encrypted : $encrypted;

                case 'aprmd5' :
                        $length = strlen($plaintext);
                        $context = $plaintext.'$apr1$'.$salt;
                        $binary = JUserHelper::_bin(md5($plaintext.$salt.$plaintext));

                        for ($i = $length; $i > 0; $i -= 16) {
                                $context .= substr($binary, 0, ($i > 16 ? 16 : $i));
                        }
                        for ($i = $length; $i > 0; $i >>= 1) {
                                $context .= ($i & 1) ? chr(0) : $plaintext[0];
                        }

                        $binary = JUserHelper::_bin(md5($context));

                        for ($i = 0; $i < 1000; $i ++) {
                                $new = ($i & 1) ? $plaintext : substr($binary, 0, 16);
                                if ($i % 3) {
                                        $new .= $salt;
                                }
                                if ($i % 7) {
                                        $new .= $plaintext;
                                }
                                $new .= ($i & 1) ? substr($binary, 0, 16) : $plaintext;
                                $binary = JUserHelper::_bin(md5($new));
                        }

                        $p = array ();
                        for ($i = 0; $i < 5; $i ++) {
                                $k = $i +6;
                                $j = $i +12;
                                if ($j == 16) {
                                        $j = 5;
                                }
                                $p[] = JUserHelper::_toAPRMD5((ord($binary[$i]) << 16) | (ord($binary[$k]) << 8) | (ord($binary[$j])), 5);
                        }

                        return '$apr1$'.$salt.'$'.implode('', $p).JUserHelper::_toAPRMD5(ord($binary[11]), 3);

                case 'md5-hex' :
                default :
                        $encrypted = ($salt) ? md5($plaintext.$salt) : md5($plaintext);
                        return ($show_encrypt) ? '{MD5}'.$encrypted : $encrypted;
        }
}

Examples

<CodeExamplesForm />