php-doc-en/reference/crack/functions/crack-check.xml
Christoph Michael Becker 7cddcd7156 documented alternative signature (fixes #69562)
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@336946 c90b9560-bf6c-de11-be94-00142212c4b1
2015-06-14 14:35:52 +00:00

124 lines
3.5 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- splitted from ./en/functions/crack.xml, last change in rev 1.1 -->
<refentry xml:id="function.crack-check" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>crack_check</refname>
<refpurpose>Performs an obscure check with the given password</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>crack_check</methodname>
<methodparam><type>resource</type><parameter>dictionary</parameter></methodparam>
<methodparam><type>string</type><parameter>password</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>bool</type><methodname>crack_check</methodname>
<methodparam><type>string</type><parameter>password</parameter></methodparam>
<methodparam><type>string</type><parameter>username</parameter><initializer>""</initializer></methodparam>
<methodparam><type>string</type><parameter>gecos</parameter><initializer>""</initializer></methodparam>
<methodparam><type>resource</type><parameter>dictionary</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Performs an obscure check with the given password on the specified
dictionary. The alternative signature also takes into account the username
and the GECOS information.
</para>
&warn.experimental.func;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>dictionary</parameter></term>
<listitem>
<para>
The crack lib dictionary. If not specified, the last opened dictionary
is used.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
<para>
The password to be checked.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>username</parameter></term>
<listitem>
<para>
The username of the account with the password.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>gecos</parameter></term>
<listitem>
<para>
The GECOS information associated with the user account.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if <parameter>password</parameter> is strong, or &false; otherwise.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>0.3</entry>
<entry>
The <parameter>username</parameter>, <parameter>gecos</parameter> and
<parameter>dictionary</parameter> parameters were added to the
alternative signature.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</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
-->