File: constants.xml

package info (click to toggle)
php-doc 20140201-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 74,084 kB
  • ctags: 4,040
  • sloc: xml: 998,137; php: 20,812; cpp: 500; sh: 177; makefile: 63; awk: 28
file content (105 lines) | stat: -rw-r--r-- 3,267 bytes parent folder | download
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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 330612 $ -->

<appendix xml:id="password.constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 &reftitle.constants;
 &extension.constants.core;

 <para>
  <variablelist>
   <varlistentry xml:id="constant.password-bcrypt">
    <term>
     <constant>PASSWORD_BCRYPT</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <para>
      <constant>PASSWORD_BCRYPT</constant> is used to create new password
      hashes using the <constant>CRYPT_BLOWFISH</constant> algorithm.
     </para>
     <para>
      This will always result in a hash using the "$2y$" crypt format, 
      which is always 60 characters wide.
     </para>
     <para>
      Supported Options:
     </para>
     <itemizedlist>
      <listitem>
       <para>
        <literal>salt</literal> - to manually provide a salt to use when hashing the password.
        Note that this will override and prevent a salt from being automatically generated.
       </para>
       <para>
        If omitted, a random salt will be generated by <function>password_hash</function> for
        each password hashed. This is the intended mode of operation.
       </para>
      </listitem>
      <listitem>
       <para>
        <literal>cost</literal> - which denotes the algorithmic cost that should be used. 
        Examples of these values can be found on the <function>crypt</function> page.
       </para>
       <para>
        If ommitted, a default value of <literal>10</literal> will be used. This is a good
        baseline cost, but you may want to consider increasing it depending on your hardware.
       </para>
      </listitem>
     </itemizedlist>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.password-default">
    <term>
     <constant>PASSWORD_DEFAULT</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <para>
      The default algorithm to use for hashing if no algorithm is provided.
      This may change in newer PHP releases when newer, stronger hashing
      algorithms are supported.
     </para>
     <para>
      It is worth noting that over time this constant can (and likely will)
      change. Therefore you should be aware that the length of the resulting
      hash can change. Therefore, if you use <constant>PASSWORD_DEFAULT</constant>
      you should store the resulting hash in a way that can store more than 60
      characters (255 is the recomended width).
     </para>
     <para>
      Values for this constant:
     </para>
     <itemizedlist>
      <listitem>
       <simpara>
        PHP 5.5.0 - <constant>PASSWORD_BCRYPT</constant>
       </simpara>
      </listitem>
     </itemizedlist>
    </listitem>
   </varlistentry>
  </variablelist>
 </para>
</appendix>

<!-- 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
-->