mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-30 15:58:55 +00:00
af4410a7e1
still using this, after discussion on the phpdoc list. From now on, manual.ced will need to be found at ~/.phpdoc/manual.ced. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@288721 c90b9560-bf6c-de11-be94-00142212c4b1
120 lines
3.5 KiB
XML
120 lines
3.5 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<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>set the signature algorithm for a phar and apply it.</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>void</type><methodname>Phar::setSignatureAlgorithm</methodname>
|
|
<methodparam><type>int</type><parameter>sigtype</parameter></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>privatekey</parameter></methodparam>
|
|
</methodsynopsis>
|
|
&phar.write;
|
|
|
|
<para>
|
|
set the signature algorithm for a phar and apply it. The
|
|
signature algorithm must be one of <literal>Phar::MD5</literal>,
|
|
<literal>Phar::SHA1</literal>, <literal>Phar::SHA256</literal>,
|
|
<literal>Phar::SHA512</literal>, or <literal>Phar::OPENSSL</literal>.
|
|
</para>
|
|
<para>
|
|
Note that all executable phar archives have a signature created
|
|
automatically, <literal>SHA1</literal> by default. data tar- or zip-based archives
|
|
(archives created with the <classname>PharData</classname> class) must have
|
|
their signature created and set explicitly via
|
|
<function>Phar::setSignatureAlgorithm</function>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>sigtype</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
One of <literal>Phar::MD5</literal>,
|
|
<literal>Phar::SHA1</literal>, <literal>Phar::SHA256</literal>,
|
|
<literal>Phar::SHA512</literal>, or <literal>Phar::OPENSSL</literal>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>privatekey</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The contents of an OpenSSL private key, as extracted from a certificate or
|
|
OpenSSL key file:
|
|
<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>
|
|
See <link linkend="phar.using">phar introduction</link> for instructions on
|
|
naming and placement of the public key file.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.void;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="errors">
|
|
&reftitle.errors;
|
|
<para>
|
|
Throws <classname>UnexpectedValueException</classname> for many errors,
|
|
and a <classname>PharException</classname>
|
|
if any problems occur flushing changes to disk.
|
|
</para>
|
|
</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
|
|
-->
|