hash-hmac-file.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 539a9823a805ac29cab7fa4baf3ae3a28116a2f5 Maintainer: raphaelm Status: ready -->
<!-- Reviewed: yes -->
<!-- Rev-Revision: 1adf24615e8be8049f68db37513e37dc631d49d1 Reviewer: samesch -->
<refentry xml:id="function.hash-hmac-file" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>hash_hmac_file</refname>
  <refpurpose>Berechnet einen Hash einer Datei mit Schlüssel unter Verwendung von HMAC</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>hash_hmac_file</methodname>
   <methodparam><type>string</type><parameter>algo</parameter></methodparam>
   <methodparam><type>string</type><parameter>filename</parameter></methodparam>
   <methodparam><modifier role="attribute">#[\SensitiveParameter]</modifier><type>string</type><parameter>key</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>binary</parameter><initializer>&false;</initializer></methodparam>
  </methodsynopsis>

 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>algo</parameter></term>
     <listitem>
      <para>
       Der Name des gewählten Hash-Algorithmus (&zb;
       <literal>"sha256"</literal>). Für eine Liste der unterstützten
       Algorithmen, siehe <function>hash_hmac_algos</function>.
       <note>
        <para>
         Nicht-kryptografische Hash-Funktionen sind nicht erlaubt.
        </para>
       </note>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>filename</parameter></term>
     <listitem>
      <para>
       Die URL der Datei, die gehasht werden soll; fopen-Wrapper werden
       unterstützt.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>key</parameter></term>
     <listitem>
      <para>
       Ein geheimer Schlüssel für die Berechnung der HMAC-Variante des Hashes.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>binary</parameter></term>
     <listitem>
      <para>
       Ist dieser Parameter auf &true; gesetzt, werden direkt Binärdaten
       zurückgegeben, andernfalls werden kleingeschriebene Hexadezimalziffern
       zurückgegeben.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Gibt den berechneten Hash als Hexadezimalzahl zurück, außer
   <parameter>binary</parameter> ist auf &true; gesetzt. In diesem Fall wird
   die binäre Darstellung des Hashes zurückgegeben. Gibt &false; zurück, wenn
   die Datei <parameter>filename</parameter> nicht gelesen werden kann.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Löst eine <classname>ValueError</classname>-Exception aus, wenn
   <parameter>algo</parameter> nicht bekannt ist oder eine
   nicht-kryptographische Hash-Funktion ist.
  </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>7.2.0</entry>
       <entry>
        Die Verwendung von nicht-kryptografischen Hashfunktionen (adler32,
        crc32, crc32b, fnv132, fnv1a32, fnv164, fnv1a64, joaat) ist nicht mehr
        möglich.
       </entry>
      </row>
      <row>
       <entry>7.2.0</entry>
       <entry>
        Die Verwendung von nicht-kryptographischen Hashfunktionen (adler32,
        crc32, crc32b, fnv132, fnv1a32, fnv164, fnv1a64, joaat) wurde
        deaktiviert.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>hash_hmac_file</function>-Beispiel</title>
    <programlisting role="php">
<![CDATA[
<?php
/* Erstelle die Datei, deren Inhalt gehasht werden soll */
file_put_contents('example.txt', 'Franz jagt im komplett verwahrlosten Taxi quer durch Bayern.');

echo hash_hmac_file('sha256', 'example.txt', 'geheimnis');
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
b34775b66659af83b5e51064aa61e6f09df258b78842b4347e46b5028da8b021
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>hash_hmac</function></member>
    <member><function>hash_hmac_algos</function></member>
    <member><function>hash_init</function></member>
    <member><function>hash_equals</function></member>
   </simplelist>
  </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
-->