cvs: peardoc /peardoc2 manual.xml.in /peardoc2/en/package text.xml /peardoc2/en/package/text text-password.xml
/peardoc2/en/package/text/text-password intro.xml types.xml
| From: | Martin Jansen | Date: | Mon, 13 Jan 2003 18:11:12 +0000 |
| Subject: | cvs: peardoc /peardoc2 manual.xml.in /peardoc2/en/package text.xml /peardoc2/en/package/text text-password.xml /peardoc2/en/package/text/text-password intro.xml types.xml |
||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-256@lists.php.net to get a copy of this message | ||
mj Mon Jan 13 13:11:12 2003 EDT
Added files:
/peardoc/peardoc2/en/package text.xml
/peardoc/peardoc2/en/package/text text-password.xml
/peardoc/peardoc2/en/package/text/text-password intro.xml types.xml
Modified files:
/peardoc/peardoc2 manual.xml.in
Log:
* Add first documentation for Text_Password.
Index: peardoc/peardoc2/manual.xml.in diff -u peardoc/peardoc2/manual.xml.in:1.7 peardoc/peardoc2/manual.xml.in:1.8 --- peardoc/peardoc2/manual.xml.in:1.7 Sat Jan 11 04:50:46 2003 +++ peardoc/peardoc2/manual.xml.in Mon Jan 13 13:11:11 2003 @@ -76,6 +76,7 @@ &package.payment; &package.php; &package.science; + &package.text; &package.xml; </part> Index: peardoc/peardoc2/en/package/text.xml +++ peardoc/peardoc2/en/package/text.xml <chapter id="package.text"> <title>Text</title> <titleabbrev>Text</titleabbrev> <para> Provides Packages text manipulation and analysis. </para> &package.text.text-password; </chapter> <!-- 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 sgml-parent-document:nil sgml-default-dtd-file:"../../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 --> Index: peardoc/peardoc2/en/package/text/text-password.xml +++ peardoc/peardoc2/en/package/text/text-password.xml <!-- $Revision: 1.1 $ --> <sect1 id="package.text.text-password"> <title>Text_Password</title> <para> Creating passwords with PHP. </para> &package.text.text-password.intro; &package.text.text-password.types; </sect1> <!-- 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 sgml-parent-document:nil sgml-default-dtd-file:"../../../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 --> Index: peardoc/peardoc2/en/package/text/text-password/intro.xml +++ peardoc/peardoc2/en/package/text/text-password/intro.xml <!-- $Revision: 1.1 $ --> <refentry id="package.text.text-password.intro"> <refnamediv> <refname>Introduction</refname> <refpurpose>Introduction to Text_Password</refpurpose> </refnamediv> <refsect1> <title>Introduction</title> <para> Creating passwords is a very common task when creating web applications. This package provides an easy-to-use and intuitive API to create <itemizedlist> <listitem> <para>pronounceable passwords</para> </listitem> <listitem> <para>unpronounceable passwords</para> </listitem> <listitem> <para>passwords based on usernames (<quote>logins</quote>)</para> </listitem> </itemizedlist> For the last point, multiple, simple <quote>obfuscation</quote> algorithms are supported. </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 sgml-parent-document:nil sgml-default-dtd-file:"../../../../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 --> Index: peardoc/peardoc2/en/package/text/text-password/types.xml +++ peardoc/peardoc2/en/package/text/text-password/types.xml <!-- $Revision: 1.1 $ --> <refentry id="package.text.text-password.types"> <refnamediv> <refname>Supported types of passwords</refname> <refpurpose> This part of the documentation introduces the different supported types of passwords. </refpurpose> </refnamediv> <refsect1> <title>Pronouncable passwords</title> <para> One feature of Text_Password is the ability to create passwords that are pronouncable. </para> <example> <title>Creating a pronouncable password:</title> <programlisting role="php"> <![CDATA[ require_once "Text/Password.php"; echo "Creating pronounceable password of 10 chars....: "; echo Text_Password::create() . "\n\n"; echo "Creating 3 different pronounceable passwords...: "; print_r(Text_Password::createMultiple(3)); ]]> </programlisting> </example> </refsect1> <refsect1> <title>Unpronouncable passwords</title> <para> In addition to unpronounceable passwords <classname>Text_Password</classname> can also handle passwords that are not pronounceable. </para> <example> <title>Creating a unpronouncable password:</title> <programlisting role="php"> <![CDATA[ require_once "Text/Password.php"; echo "\nCreating unpronounceable password of 8 chars with a,b,c as possible chars....:\t"; echo Text_Password::create(8, 'unpronounceable', 'a,b,c') . "\n\n"; echo "\nCreating 4 different unpronounceable passwords...:\n"; print_r(Text_Password::createMultiple(4, 10, 'unpronounceable')); echo "\nCreating unpronounceable password of 8 chars with numeric chars:\t"; echo Text_Password::create(8, 'unpronounceable', 'numeric') . "\n\n"; echo "\nCreating unpronounceable password of 8 chars with alphanumeric chars:\t"; echo Text_Password::create(8, 'unpronounceable', 'alphanumeric') . "\n\n"; ]]> </programlisting> </example> </refsect1> <refsect1> <title>Passwords based on usernames</title> <para> <classname>Text_Password</classname> provides the ability to create passwords that are based on a username (usually refered to as <quote>login</quote>). </para> <example> <title>Creating passwords based on logins:</title> <programlisting role="php"> <![CDATA[ require_once "Text/Password.php"; echo "\nCreating password from login 'olivier', type is 'reverse':\t"; echo Text_Password::createFromLogin('olivier', 'reverse') . "\n\n"; echo "\nCreating password from login 'olivier', type is 'rot13':\t"; echo Text_Password::createFromLogin('olivier', 'rot13') . "\n\n"; echo "\nCreating password from login 'olivier', type is 'rotx':\t"; echo Text_Password::createFromLogin('olivier', 'rotx', 13) . "\n\n"; echo "\nCreating password from login 'olivier', type is 'rotx++':\t"; echo Text_Password::createFromLogin('olivier', 'rotx++', 13) . "\n\n"; echo "\nCreating password from login 'olivier', type is 'rotx--':\t"; echo Text_Password::createFromLogin('olivier', 'rotx--', 13) . "\n\n"; echo "\nCreating password from login 'olivier', type is 'xor':\t"; echo Text_Password::createFromLogin('olivier', 'xor', 5) . "\n\n"; echo "\nCreating password from login 'olivier', type is 'ascii_rotx':\t"; echo Text_Password::createFromLogin('olivier', 'ascii_rotx', 5) . "\n\n"; echo "\nCreating password from login 'olivier', type is 'ascii_rotx++':\t"; echo Text_Password::createFromLogin('olivier', 'ascii_rotx++', 5) . "\n\n"; echo "\nCreating password from login 'olivier', type is 'ascii_rotx--':\t"; echo Text_Password::createFromLogin('olivier', 'ascii_rotx--', 5) . "\n\n"; echo "\nCreating password from login 'olivier', type is 'shuffle':\t"; echo Text_Password::createFromLogin('olivier', 'shuffle', 1) . "\n\n"; echo "\nCreating password from an array of login 'olivier', 'martin', 'vanhoucke', 'jansen', type is 'reverse':\n"; $logins = array('olivier', 'martin', 'vanhoucke', 'jansen'); print_r(Text_Password::createMultipleFromLogin($logins, 'reverse')); ]]> </programlisting> </example> <para> Currently the following obfuscation algorithms are supported: <itemizedlist> <listitem> <simpara>xor</simpara> </listitem> <listitem> <simpara>rotx</simpara> </listitem> <listitem> <simpara>rotx++</simpara> </listitem> <listitem> <simpara>rotx--</simpara> </listitem> <listitem> <simpara>ascii_rotx</simpara> </listitem> <listitem> <simpara>ascii_rotx++</simpara> </listitem> <listitem> <simpara>ascii_rotx--</simpara> </listitem> <listitem> <simpara>shuffle</simpara> </listitem> <listitem> <simpara>reverse</simpara> </listitem> </itemizedlist> </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 sgml-parent-document:nil sgml-default-dtd-file:"../../../../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 -->
Index: peardoc/peardoc2/manual.xml.in diff -u peardoc/peardoc2/manual.xml.in:1.7 peardoc/peardoc2/manual.xml.in:1.8 --- peardoc/peardoc2/manual.xml.in:1.7 Sat Jan 11 04:50:46 2003 +++ peardoc/peardoc2/manual.xml.in Mon Jan 13 13:11:11 2003 @@ -76,6 +76,7 @@ &package.payment; &package.php; &package.science; + &package.text; &package.xml; </part> Index: peardoc/peardoc2/en/package/text.xml +++ peardoc/peardoc2/en/package/text.xml <chapter id="package.text"> <title>Text</title> <titleabbrev>Text</titleabbrev> <para> Provides Packages text manipulation and analysis. </para> &package.text.text-password; </chapter> <!-- 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 sgml-parent-document:nil sgml-default-dtd-file:"../../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 --> Index: peardoc/peardoc2/en/package/text/text-password.xml +++ peardoc/peardoc2/en/package/text/text-password.xml <!-- $Revision: 1.1 $ --> <sect1 id="package.text.text-password"> <title>Text_Password</title> <para> Creating passwords with PHP. </para> &package.text.text-password.intro; &package.text.text-password.types; </sect1> <!-- 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 sgml-parent-document:nil sgml-default-dtd-file:"../../../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 --> Index: peardoc/peardoc2/en/package/text/text-password/intro.xml +++ peardoc/peardoc2/en/package/text/text-password/intro.xml <!-- $Revision: 1.1 $ --> <refentry id="package.text.text-password.intro"> <refnamediv> <refname>Introduction</refname> <refpurpose>Introduction to Text_Password</refpurpose> </refnamediv> <refsect1> <title>Introduction</title> <para> Creating passwords is a very common task when creating web applications. This package provides an easy-to-use and intuitive API to create <itemizedlist> <listitem> <para>pronounceable passwords</para> </listitem> <listitem> <para>unpronounceable passwords</para> </listitem> <listitem> <para>passwords based on usernames (<quote>logins</quote>)</para> </listitem> </itemizedlist> For the last point, multiple, simple <quote>obfuscation</quote> algorithms are supported. </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 sgml-parent-document:nil sgml-default-dtd-file:"../../../../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 --> Index: peardoc/peardoc2/en/package/text/text-password/types.xml +++ peardoc/peardoc2/en/package/text/text-password/types.xml <!-- $Revision: 1.1 $ --> <refentry id="package.text.text-password.types"> <refnamediv> <refname>Supported types of passwords</refname> <refpurpose> This part of the documentation introduces the different supported types of passwords. </refpurpose> </refnamediv> <refsect1> <title>Pronouncable passwords</title> <para> One feature of Text_Password is the ability to create passwords that are pronouncable. </para> <example> <title>Creating a pronouncable password:</title> <programlisting role="php"> <![CDATA[ require_once "Text/Password.php"; echo "Creating pronounceable password of 10 chars....: "; echo Text_Password::create() . "\n\n"; echo "Creating 3 different pronounceable passwords...: "; print_r(Text_Password::createMultiple(3)); ]]> </programlisting> </example> </refsect1> <refsect1> <title>Unpronouncable passwords</title> <para> In addition to unpronounceable passwords <classname>Text_Password</classname> can also handle passwords that are not pronounceable. </para> <example> <title>Creating a unpronouncable password:</title> <programlisting role="php"> <![CDATA[ require_once "Text/Password.php"; echo "\nCreating unpronounceable password of 8 chars with a,b,c as possible chars....:\t"; echo Text_Password::create(8, 'unpronounceable', 'a,b,c') . "\n\n"; echo "\nCreating 4 different unpronounceable passwords...:\n"; print_r(Text_Password::createMultiple(4, 10, 'unpronounceable')); echo "\nCreating unpronounceable password of 8 chars with numeric chars:\t"; echo Text_Password::create(8, 'unpronounceable', 'numeric') . "\n\n"; echo "\nCreating unpronounceable password of 8 chars with alphanumeric chars:\t"; echo Text_Password::create(8, 'unpronounceable', 'alphanumeric') . "\n\n"; ]]> </programlisting> </example> </refsect1> <refsect1> <title>Passwords based on usernames</title> <para> <classname>Text_Password</classname> provides the ability to create passwords that are based on a username (usually refered to as <quote>login</quote>). </para> <example> <title>Creating passwords based on logins:</title> <programlisting role="php"> <![CDATA[ require_once "Text/Password.php"; echo "\nCreating password from login 'olivier', type is 'reverse':\t"; echo Text_Password::createFromLogin('olivier', 'reverse') . "\n\n"; echo "\nCreating password from login 'olivier', type is 'rot13':\t"; echo Text_Password::createFromLogin('olivier', 'rot13') . "\n\n"; echo "\nCreating password from login 'olivier', type is 'rotx':\t"; echo Text_Password::createFromLogin('olivier', 'rotx', 13) . "\n\n"; echo "\nCreating password from login 'olivier', type is 'rotx++':\t"; echo Text_Password::createFromLogin('olivier', 'rotx++', 13) . "\n\n"; echo "\nCreating password from login 'olivier', type is 'rotx--':\t"; echo Text_Password::createFromLogin('olivier', 'rotx--', 13) . "\n\n"; echo "\nCreating password from login 'olivier', type is 'xor':\t"; echo Text_Password::createFromLogin('olivier', 'xor', 5) . "\n\n"; echo "\nCreating password from login 'olivier', type is 'ascii_rotx':\t"; echo Text_Password::createFromLogin('olivier', 'ascii_rotx', 5) . "\n\n"; echo "\nCreating password from login 'olivier', type is 'ascii_rotx++':\t"; echo Text_Password::createFromLogin('olivier', 'ascii_rotx++', 5) . "\n\n"; echo "\nCreating password from login 'olivier', type is 'ascii_rotx--':\t"; echo Text_Password::createFromLogin('olivier', 'ascii_rotx--', 5) . "\n\n"; echo "\nCreating password from login 'olivier', type is 'shuffle':\t"; echo Text_Password::createFromLogin('olivier', 'shuffle', 1) . "\n\n"; echo "\nCreating password from an array of login 'olivier', 'martin', 'vanhoucke', 'jansen', type is 'reverse':\n"; $logins = array('olivier', 'martin', 'vanhoucke', 'jansen'); print_r(Text_Password::createMultipleFromLogin($logins, 'reverse')); ]]> </programlisting> </example> <para> Currently the following obfuscation algorithms are supported: <itemizedlist> <listitem> <simpara>xor</simpara> </listitem> <listitem> <simpara>rotx</simpara> </listitem> <listitem> <simpara>rotx++</simpara> </listitem> <listitem> <simpara>rotx--</simpara> </listitem> <listitem> <simpara>ascii_rotx</simpara> </listitem> <listitem> <simpara>ascii_rotx++</simpara> </listitem> <listitem> <simpara>ascii_rotx--</simpara> </listitem> <listitem> <simpara>shuffle</simpara> </listitem> <listitem> <simpara>reverse</simpara> </listitem> </itemizedlist> </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 sgml-parent-document:nil sgml-default-dtd-file:"../../../../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 -->