crypt-gensalt.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.crypt-gensalt" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>crypt_gensalt</refname>
  <refpurpose>Compile a string for use as the salt argument to crypt</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>null</type></type><methodname>crypt_gensalt</methodname>
   <methodparam choice="opt"><type>string</type><parameter>prefix</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>count</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <simpara>
   Compile a string for use as the salt argument to <function>crypt</function>.
  </simpara>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>prefix</parameter></term>
    <listitem>
     <simpara>
      Hashing method.
      One of the <constant>CRYPT_PREFIX_<replaceable>*</replaceable></constant> constant.
      If &null;, the best available hashing method will be selected.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>count</parameter></term>
    <listitem>
     <simpara>
      Controls the processing cost of the hash;
      the valid range and exact meaning of count depend on the hashing method,
      but larger numbers correspond to more costly hashes in
      terms of CPU time and possibly memory usage.
      If count is <literal>0</literal>, a low default cost will be selected.
     </simpara>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <simpara>
   Returns a string with the setting, or &null; in case of an error.
  </simpara>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>A <function>crypt_gensalt</function> example</title>
   <programlisting role="php">
<![CDATA[
<?php
// Generate the salt
$salt = crypt_gensalt(CRYPT_PREFIX_BLOWFISH);
// Hash the password
$hash = crypt("secret", $salt);
// Check the hash
$test = hash_equals(crypt("secret", $hash), $hash);
var_dump($salt, $hash, $test);
?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
string(29) "$2y$05$GcPykP.Am8C1.dGamdpwW."
string(60) "$2y$05$GcPykP.Am8C1.dGamdpwW.1RR.7uicWvJPZfJfCEizZHqVWwuaJLm"
bool(true)
]]>
   </screen>
  </example>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><function>crypt_preferred_method</function></member>
   <member><function>crypt</function></member>
   <member><function>hash_equals</function></member>
  </simplelist>
 </refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->