[PHP-DOC] cvs: phpdoc /cs/functions mhash.xml

[Roman Neuhauser]

cynic           Thu Jan 25 18:55:58 2001 EDT

  Added files:                 
    /phpdoc/cs/functions        mhash.xml 
  Log:
  
  
  needs some further work (win-1250)
  

Index: phpdoc/cs/functions/mhash.xml
+++ phpdoc/cs/functions/mhash.xml
 <reference id="ref.mhash">
  <title>Mhash funkce</title>
  <titleabbrev>mhash</titleabbrev>

  <partintro>
   <para>
    Tyto funkce jsou ur�eny pro pr�ci s <ulink url="&url.mhash;">mhash</ulink>.
   </para>
   <para>
    Toto je interface ke knihvn� mhash. mhash podporuje �irokou �k�lu hash
    algoritm� jako nap�. MD5, SHA1, GOST a mnoho jin�ch.
   </para>
   <para>
    Pokud chcete tyto funkce pou��vat, st�hn�te si mhash distribuci z <ulink
    url="&url.mhash;">its web site</ulink> a postupujte podle p�ilo�en�ch
    instrukc� k instalaci. K aktivaci tohoto modulu budete muset zkompilovat PHP
    s volbou <option role="configure">--with-mhash</option>
   </para>
   <para>
    Mhash se d� pou��t k vytv��en� kontroln�ch sou�t�, message digests, message
    authentication codes, and more.
   </para>
   <para>
    <example>
     <title>Compute the MD5 digest and hmac and print it out as hex</title>
     <programlisting role="php">
&lt;?php
$input = "what do ya want for nothing?";
$hash = mhash (MHASH_MD5, $input);
print "The hash is ".bin2hex ($hash)."\n&lt;br>";
$hash = mhash (MHASH_MD5, $input, "Jefe");
print "The hmac is ".bin2hex ($hash)."\n&lt;br>";
?&gt;
     </programlisting>
    </example>
    This will produce:
    <programlisting>
The hash is d03cb659cbf9192dcd066272249f8412
The hmac is 750c783e6ab0b503eaa86e310a5db738
    </programlisting>
    Kompletn� seznam podporovan�ch hash� viz dokumentaci mhash. Obecn�m pravidlem
    je, �e hash algoritmus je dostupn� z PHP pomoc� MHASH_NAZEVHASHE. Nap��klad
    TIGER se v PHP pou��v� pomoc� konstanty MHASH_TIGER.
   </para>
   <para>
    Zde je seznam hash� podporovan�ch mhashem v sou�asn� dob�. Pokud zde nen�
    n�kter� hash jmenov�n, ale v dokumentaci mhashe je uveden jako podporovan�,
    m��ete bezpe�n� p�edpokl�dat, �e je tato dokumentace zastaral�.
    <itemizedlist>
     <listitem>
      <simpara>
       MHASH_MD5
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       MHASH_SHA1
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       MHASH_HAVAL256
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       MHASH_HAVAL192
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       MHASH_HAVAL160
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       MHASH_HAVAL128
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       MHASH_RIPEMD160
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       MHASH_GOST
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       MHASH_TIGER
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       MHASH_CRC32
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       MHASH_CRC32B
      </simpara>
     </listitem>
    </itemizedlist>
   </para>
  </partintro>

  <refentry id="function.mhash-get-hash-name">
   <refnamediv>
    <refname>mhash_get_hash_name</refname>
    <refpurpose>Z�skat n�zev zadan�ho hashe</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Popis</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>string <function>mhash_get_hash_name</function></funcdef>
      <paramdef>int <parameter>hash</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
     <function>mhash_get_hash_name</function> se pou��v� ke zji�t�n� n�zvu
     zadan�ho hashe.
    </para>
    <para>
     <function>mhash_get_hash_name</function> p�ij�m� id hashe jako argument a
     vrac� n�zev tohoto hashe nebo <literal>false</literal>, pokud tento hash
     neexistuje.
    </para>
    <para>
     <example>
      <title>Uk�zka <function>mhash_get_hash_name</function></title>
      <programlisting>
&lt;?php
$hash = MHASH_MD5;

print mhash_get_hash_name ($hash);
?&gt;
      </programlisting>
     </example>
     V��e uveden� uk�zka vytiskne:
     <programlisting>
MD5
     </programlisting>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.mhash-get-block-size">
   <refnamediv>
    <refname>mhash_get_block_size</refname>
    <refpurpose>Z�skat velikost bloku ur�en�ho hashe</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Popis</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>int <function>mhash_get_block_size</function></funcdef>
      <paramdef>int <parameter>hash</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
     <function>mhash_get_block_size</function> se pou��v� ke zji�t�n� velikosti
     bloku argumentu <parameter>hash</parameter>.
    </para>
    <para>
     <function>mhash_get_block_size</function> p�ij�m� jeden argument,
     <parameter>hash</parameter> a vrac� velikost v bytech nebo
     <literal>false</literal>, pokud <parameter>hash</parameter> neexistuje.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.mhash-count">
   <refnamediv>
    <refname>mhash_count</refname>
    <refpurpose>Z�skat nejvy��� dostupn� hash id</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Popis</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>int <function>mhash_count</function></funcdef>
      <paramdef>void </paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
     <function>mhash_count</function> vrac� nejvy��� dostupn� hash id. Hashe jsou
     ��slovan� od 0 po toto hash id.
    </para>
    <para>
     <example>
      <title>Traversing all hashes</title>
      <programlisting role="php">
&lt;?php

$nr = mhash_count();

for ($i = 0; $i &lt;= $nr; $i++) {
    echo sprintf ("The blocksize of %s is %d\n",
        mhash_get_hash_name ($i),
        mhash_get_block_size ($i));
}
?&gt;
      </programlisting>
     </example>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.mhash">
   <refnamediv>
    <refname>mhash</refname>
    <refpurpose>Spo��tat hash</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Popis</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>string <function>mhash</function></funcdef>
      <paramdef>int <parameter>hash</parameter></paramdef>
      <paramdef>string <parameter>data</parameter></paramdef>
      <paramdef>string <parameter>[ key ]</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
     <function>mhash</function> aplikuje hash funkci ur�enou argumentem
     <parameter>hash</parameter> na <parameter>data</parameter> a vrac� v�sledn�
     hash (tak� naz�van� digest). Pokud je p�ed�n <parameter> key</parameter>,
     vrac� v�sledn� HMAC. HMAC is keyed hashing for message authentication,
     or simply a message digest that depends on  the specified key. Not all
     algorithms supported in mhash can be used in  HMAC mode. In case of an error
     returns false.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.mhash-keygen-s2k">
   <refnamediv>
    <refname>mhash_keygen_s2k</refname>
    <refpurpose>Vygenerovat kl��</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Popis</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>string <function>mhash_keygen_s2k</function></funcdef>
      <paramdef>int <parameter>hash</parameter></paramdef>
      <paramdef>string <parameter>password</parameter></paramdef>
      <paramdef>string <parameter>salt</parameter></paramdef>
      <paramdef>int <parameter>bytes</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
     <function>mhash_keygen_s2k</function> generuje kl��, kter� je
     <parameter>bytes</parameter> dlouh�, z p�edan�ho hesla. Toto je Salted S2K
     algoritmus specifikovan� v OpenPGP dokumentu (RFC 2440). Tento algoritmus
     pou�ije k vytvo�en� kl��e <parameter>hash</parameter> algoritmus.
     <parameter>salt</parameter> mus� b�t pro ka�d� generovan� kl�� jin� a
     dostate�n� n�hodn�, aby vytvo�il r�zn� kl��e.
     Salt mus� b�t p�i kontrole kl��� zn�m, tud� je dobr� n�pad ho p�ipojit
     ke kl��i. Salt ma pevnou d�lku 8 byt� a pokud dod�te m�n� byt�, bude
     dopln�n nulami.
     Pamatujte, �e u�ivatelsky ur�en� hesla nejsou vhodn� k pou�it� jako kl��e,
     proto�e u�ivatel� obvykle vol� kl��e, kter� mohou napsat na kl�vesnici.
     Tato hesla vyu��vaj� pouze 6 a� 7 byt� na znak (nebo m�n�). Je velmi vhodn�
     na u�ivateli ur�en� kl��e pou��t n�jakou transformaci (jako je tato funkce).
    </para>
   </refsect1>
  </refentry>
 </reference>

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