hash-hmac-file.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 539a9823a805ac29cab7fa4baf3ae3a28116a2f5 Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.hash-hmac-file" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>hash_hmac_file</refname>
  <refpurpose>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>
       選択したアルゴリズムの名前 (例: <literal>"sha256"</literal>)。
       サポートするアルゴリズムの一覧は <function>hash_hmac_algos</function> を参照ください。
       <note>
        <para>
         暗号に適さないハッシュ関数は許可されません。
        </para>
       </note>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>filename</parameter></term>
     <listitem>
      <para>
       ハッシュ対象となるファイルの位置を示す URL。
       fopen ラッパーをサポートしています。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>key</parameter></term>
     <listitem>
      <para>
       HMAC 方式でのメッセージダイジェストを生成するために使用する
       共有の秘密鍵。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>binary</parameter></term>
     <listitem>
      <para>
       &true; を設定すると、生のバイナリデータを出力します。
       &false; の場合は小文字の 16 進数値となります。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <parameter>binary</parameter> が true に設定されていない場合は、
   メッセージダイジェストの計算結果を小文字の 16 進数値形式の文字列で
   返します。もし true に設定されていた場合は、メッセージダイジェストが
   そのままのバイナリ形式で返されます。
   <parameter>filename</parameter> が読めない場合は、&false; が返されます。
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   <parameter>algo</parameter> が不明な場合や、
   暗号に適さないハッシュ関数の場合、
   <classname>ValueError</classname> がスローされます。
  </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>8.0.0</entry>
       <entry>
        <parameter>algo</parameter> が不明な場合や、
        暗号に適さないハッシュ関数の場合、
        <classname>ValueError</classname> がスローされるようになりました。
        これより前のバージョンでは、&false; を返していました。
       </entry>
      </row>
      <row>
       <entry>7.2.0</entry>
       <entry>暗号に適さないハッシュ関数 (adler32, crc32, crc32b, fnv132, fnv1a32, fnv164, fnv1a64, joaat) は使えなくなりました。</entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>hash_hmac_file</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
/* ハッシュ値を計算するファイルを作成します */
file_put_contents('example.txt', 'The quick brown fox jumped over the lazy dog.');

echo hash_hmac_file('sha256', 'example.txt', 'secret');
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
9c5c42422b03f0ee32949920649445e417b2c634050833c5165704b825c2a53b
]]>
    </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
-->