1
0
mirror of https://github.com/php/doc-ja.git synced 2026-03-24 07:02:08 +01:00
Files
archived-doc-ja/reference/phar/Phar/setSignatureAlgorithm.xml
2022-12-13 19:58:20 +09:00

148 lines
4.5 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: f03806fcd8fe03a0501bd40b6e3939ff6589a1d2 Maintainer: takagi Status: ready -->
<refentry xml:id="phar.setsignaturealgorithm" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Phar::setSignatureAlgorithm</refname>
<refpurpose>phar のシグネチャのアルゴリズムを設定して適用する</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="Phar">
<modifier>public</modifier> <type>void</type><methodname>Phar::setSignatureAlgorithm</methodname>
<methodparam><type>int</type><parameter>algo</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>privateKey</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
&phar.write;
<para>
phar のシグネチャのアルゴリズムを設定します。
シグネチャのアルゴリズムは <literal>Phar::MD5</literal>
<literal>Phar::SHA1</literal><literal>Phar::SHA256</literal>
<literal>Phar::SHA512</literal> あるいは <literal>Phar::OPENSSL</literal>
のいずれかでなければなりません。
</para>
<para>
実行可能な phar アーカイブについては、
<literal>SHA1</literal> 形式のシグネチャが
デフォルトで自動的に作成されることに注意しましょう。
データ tar 形式あるいは zip 形式のアーカイブ
(<classname>PharData</classname> クラスで作成したアーカイブ)
の場合は、
<function>Phar::setSignatureAlgorithm</function>
で明示的にシグネチャを作成して設定する必要があります。
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>algo</parameter></term>
<listitem>
<para>
<literal>Phar::MD5</literal>
<literal>Phar::SHA1</literal><literal>Phar::SHA256</literal>
<literal>Phar::SHA512</literal> あるいは <literal>Phar::OPENSSL</literal>
のいずれか。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>privateKey</parameter></term>
<listitem>
<para>
OpenSSL 秘密鍵の中身。証明書あるいは OpenSSL 鍵ファイルから取り出したもの。
<programlisting role="php">
<![CDATA[
<?php
$private = openssl_get_privatekey(file_get_contents('private.pem'));
$pkey = '';
openssl_pkey_export($private, $pkey);
$p->setSignatureAlgorithm(Phar::OPENSSL, $pkey);
?>
]]>
</programlisting>
公開鍵ファイルの名前や置き場所については
<link linkend="phar.using">phar の導入</link> を参照ください。
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
さまざまなエラーが発生した場合に
<classname>UnexpectedValueException</classname> をスローします。
変更内容をディスクに書き込むときにエラーが発生した場合は
<classname>PharException</classname> をスローします。
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>privateKey</parameter> は、nullable になりました。
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>Phar::getSupportedSignatures</function></member>
<member><function>Phar::getSignature</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
-->