Skip to content

Commit

Permalink
Make reference/password/ fully synced with EN (updates + new pages)
Browse files Browse the repository at this point in the history
  • Loading branch information
@Sobak
Sobak committed Jun 7, 2024
1 parent 220986b commit dcf39a0
Show file tree
Hide file tree
Showing 6 changed files with 603 additions and 110 deletions.
258 changes: 258 additions & 0 deletions reference/password/constants.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,258 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: c6532951edb85836f2d49a3c81f8f5e1e41d3554 Maintainer: sobak Status: ready -->
<!-- $Revision$ -->

<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>string</type>)
</term>
<listitem>
<para>
<constant>PASSWORD_BCRYPT</constant> jest używana do tworzenia nowych hashy haseł
przy pomocy algorytmu <constant>CRYPT_BLOWFISH</constant>.
</para>
<para>
Hash zawsze będzie używał formatu "$2y$" i zawsze będzie miał szerokość 60 znaków.
</para>
<para>
Obsługiwane opcje:
</para>
<itemizedlist>
<listitem>
<para>
Jeżeli pomięto, losowa sól zostanie wygenerowana przez <function>password_hash</function>
dla każdego hasła. Jest to zalecany sposób postępowania.
</para>
<para>
Jeśli pominięto, <function>password_hash</function> wygeneruje losową sól dla
każdego z hashowanych haseł. Jest to zalecany sposób postępowania
a od PHP 7.0.0 opcja salt jest przestarzała.
</para>
</listitem>
<listitem>
<para>
<literal>cost</literal> (<type>int</type>) - oznacza koszt algorytmu, który powinien zostać użyty.
Przykładowe wartości można znaleźć na stronie funkcji
<function>crypt</function>.
</para>
<para>
Jeżeli pominięto, to zostanie użyta domyślna wartość <literal>10</literal>. Stanowi ona rozsądny
koszt wyjściowy, ale możesz rozważyć jego zwiększenie w zależności od sprzętu, którym dysponujesz.
</para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.password-bcrypt-default-cost">
<term>
<constant>PASSWORD_BCRYPT_DEFAULT_COST</constant>
(<type>int</type>)
</term>
<listitem>
<para>
</para>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.password-argon2i">
<term>
<constant>PASSWORD_ARGON2I</constant>
(<type>string</type>)
</term>
<listitem>
<para>
<constant>PASSWORD_ARGON2I</constant> jest używana do tworzenia nowych hashy haseł
przy pomocy algorytmu Argon2i.
</para>
<para>
Obsługiwane opcje:
</para>
<itemizedlist>
<listitem>
<para>
<literal>memory_cost</literal> (<type>int</type>) - Maksymalna ilość pamięci (w bajtach), która może
być użyta, aby obliczyć hash Argon2. Domyślnie ma wartość <constant>PASSWORD_ARGON2_DEFAULT_MEMORY_COST</constant>.
</para>
</listitem>
<listitem>
<para>
<literal>time_cost</literal> (<type>int</type>) - Maksymalna ilość czasu, która
może być użyta, aby obliczyć hash Argon2. Domyślnie ma wartość <constant>PASSWORD_ARGON2_DEFAULT_TIME_COST</constant>.
</para>
</listitem>
<listitem>
<para>
<literal>threads</literal> (<type>int</type>) - Liczba wątków, których należy użyć dla obliczenia
hasha Argon2. Domyślna wartość to <constant>PASSWORD_ARGON2_DEFAULT_THREADS</constant>.
Dostępne tylko, gdy PHP używa libargon2, nie implementacji libsodium.
</para>
</listitem>
</itemizedlist>
<para>
Dostępna od PHP 7.2.0.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.password-argon2id">
<term>
<constant>PASSWORD_ARGON2ID</constant>
(<type>string</type>)
</term>
<listitem>
<para>
<constant>PASSWORD_ARGON2ID</constant> jest używana do tworzenia nowych hashy haseł
przy pomocy algorytmu Argon2id. Obsługuje takie same opcje jak
<link linkend="constant.password-argon2i"><constant>PASSWORD_ARGON2I</constant></link>.
</para>
<para>
Dostępna od PHP 7.3.0.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.password-argon2-default-memory-cost">
<term>
<constant>PASSWORD_ARGON2_DEFAULT_MEMORY_COST</constant>
(<type>int</type>)
</term>
<listitem>
<para>
Domyślna ilość pamięci w bajtach, która będzie użyta podczas pró”y
obliczenia hasha.
</para>
<para>
Dostępna od PHP 7.2.0.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.password-argon2-default-time-cost">
<term>
<constant>PASSWORD_ARGON2_DEFAULT_TIME_COST</constant>
(<type>int</type>)
</term>
<listitem>
<para>
Domyślna ilość czasu, który zostanie poświęcony na próbę obliczenia hasha.
</para>
<para>
Dostępna od PHP 7.2.0.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.password-argon2-default-threads">
<term>
<constant>PASSWORD_ARGON2_DEFAULT_THREADS</constant>
(<type>int</type>)
</term>
<listitem>
<para>
Domyślna ilość wątków, których użyje Argon2lib.
Niedostępna z implementacją libsodium.
</para>
<para>
Dostępna od PHP 7.2.0.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.password-argon2-provider">
<term>
<constant>PASSWORD_ARGON2_PROVIDER</constant>
(<type>string</type>)
</term>
<listitem>
<para>
</para>
<para>
Dostępna od PHP 7.4.0.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.password-default">
<term>
<constant>PASSWORD_DEFAULT</constant>
(<type>mixed</type>)
</term>
<listitem>
<para>
Domyślny algorytm używany do hashowania, jeśli nie został podany algorytm.
Ta wartość może zmieniać się w kolejnych wydaniach PHP, gdy pojawi się wsparcie
dla nowszych i mocniejszych algorytmów hashujących.
</para>
<para>
Warto zauważyć, że z biegiem czasu wartość tej stałej najprawdopodobniej się
zmieni. W związku z tym należy mieć świadomość, że długość wynikowego
hasha może się zmienić. Tak więc, jeśli używasz <constant>PASSWORD_DEFAULT</constant>,
to hash powinien być zapisany w taki sposób, który może przechowywać więcej niż 60
znaków (255 to zalecana długość).
</para>
<para>
Wartości tej stałej:
</para>
<itemizedlist>
<listitem>
<simpara>
PHP 5.5.0 - <constant>PASSWORD_BCRYPT</constant>
</simpara>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
</variablelist>
</para>

<formalpara>
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>7.4.0</entry>
<entry>
Wartości identyfikatorów algorytmów haseł (<constant>PASSWORD_BCRYPT</constant>, <constant>PASSWORD_ARGON2I</constant>,
<constant>PASSWORD_ARGON2ID</constant> and <constant>PASSWORD_DEFAULT</constant>) są teraz typu &string;.
Wcześniej były to liczby (&integer;).
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</formalpara>

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

80 changes: 80 additions & 0 deletions reference/password/functions/password-algos.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: c9596f7576ae7b476b9592522320f0f53ce1c0c0 Maintainer: sobak Status: ready -->
<!-- $Revision$ -->

<refentry xml:id="function.password-algos" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>password_algos</refname>
<refpurpose>Pobiera identyfikatory dostępnych algorytmów hashujących hasła</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>password_algos</methodname>
<void />
</methodsynopsis>
<para>
Zwraca pełną listę identyfikatorów zarejestrowanych algorytmów hashujących hasła jako tablicę ciągów znaków.
</para>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Zwraca identyfikatory dostępnych algorytmów hashujących hasła.
</para>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<example xml:id="password-algos.example.basic">
<title>Podstawowe użycie <function>password</function></title>
<programlisting role="php">
<![CDATA[
<?php
print_r(password_algos());
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Array
(
[0] => 2y
[1] => argon2i
[2] => argon2id
)
]]>
</screen>
</example>
</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
-->
Loading

0 comments on commit dcf39a0

Please sign in to comment.