php-doc-en/reference/mhash/reference.xml
2003-12-15 16:55:22 +00:00

102 lines
2.5 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<reference id="ref.mhash">
<title>Mhash Functions</title>
<titleabbrev>mhash</titleabbrev>
<partintro>
<section id="mhash.intro">
&reftitle.intro;
<para>
These functions are intended to work with <ulink
url="&url.mhash;">mhash</ulink>. Mhash can be used to create checksums,
message digests, message authentication codes, and more.
</para>
<para>
This is an interface to the mhash library. mhash supports a wide
variety of hash algorithms such as MD5, SHA1, GOST, and many
others. For a complete list of supported hashes, refer to the
documentation of mhash. The general rule is that you can access
the hash algorithm from PHP with MHASH_HASHNAME. For example, to
access TIGER you use the PHP constant MHASH_TIGER.
</para>
</section>
<section id="mhash.requirements">
&reftitle.required;
<para>
To use it, download the mhash distribution from <ulink
url="&url.mhash;">its web site</ulink> and follow the included
installation instructions.
</para>
</section>
&reference.mhash.configure;
<section id="mhash.configuration">
&reftitle.runtime;
&no.config;
</section>
<section id="mhash.resources">
&reftitle.resources;
&no.resource;
</section>
&reference.mhash.constants;
<section id="mhash.examples">
&reftitle.examples;
<para>
<example>
<title>Compute the MD5 digest and hmac and print it out as hex</title>
<programlisting role="php">
<![CDATA[
<?php
$input = "what do ya want for nothing?";
$hash = mhash(MHASH_MD5, $input);
echo "The hash is " . bin2hex($hash) . "<br />\n";
$hash = mhash(MHASH_MD5, $input, "Jefe");
echo "The hmac is " . bin2hex($hash) . "<br />\n";
?>
]]>
</programlisting>
<para>
This will produce:
<screen>
<![CDATA[
The hash is d03cb659cbf9192dcd066272249f8412
The hmac is 750c783e6ab0b503eaa86e310a5db738
]]>
</screen>
</para>
</example>
</para>
</section>
</partintro>
&reference.mhash.functions;
</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
indent-tabs-mode:nil
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
-->