<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>set the signature algorithm for a phar and apply it.</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="phar.setmetadata.html">Phar::setMetadata</a></div>
<div class="next" style="text-align: right; float: right;"><a href="phar.setstub.html">Phar::setStub</a></div>
<div class="up"><a href="class.phar.html">Phar</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="phar.setsignaturealgorithm" class="refentry">
<div class="refnamediv">
<h1 class="refname">Phar::setSignatureAlgorithm</h1>
<p class="verinfo">(PHP >= 5.3.0, PECL phar >= 1.1.0)</p><p class="refpurpose"><span class="refname">Phar::setSignatureAlgorithm</span> — <span class="dc-title">set the signature algorithm for a phar and apply it.</span></p>
</div>
<div class="refsect1 description" id="refsect1-phar.setsignaturealgorithm-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><span class="type void">void</span></span> <span class="methodname"><a href="phardata.setsignaturealgorithm.html" class="methodname">Phar::setSignatureAlgorithm</a></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$sigtype</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$privatekey</code></span>
] )</div>
<blockquote class="note"><p><strong class="note">Note</strong>: <p class="para">This
method requires the <var class="filename">php.ini</var> setting <em>phar.readonly</em> to be
set to <em>0</em> in order to work for <a href="class.phar.html" class="classname">Phar</a>
objects. Otherwise, a <a href="class.pharexception.html" class="classname">PharException</a> will be thrown.</p></p></blockquote>
<p class="para">
set the signature algorithm for a phar and apply it. The
signature algorithm must be one of <em>Phar::MD5</em>,
<em>Phar::SHA1</em>, <em>Phar::SHA256</em>,
<em>Phar::SHA512</em>, or <em>Phar::OPENSSL</em>.
</p>
<p class="para">
Note that all executable phar archives have a signature created
automatically, <em>SHA1</em> by default. data tar- or zip-based archives
(archives created with the <a href="class.phardata.html" class="classname">PharData</a> class) must have
their signature created and set explicitly via
<span class="function"><a href="phardata.setsignaturealgorithm.html" class="function">Phar::setSignatureAlgorithm()</a></span>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-phar.setsignaturealgorithm-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">sigtype</code></em></span>
<dd>
<p class="para">
One of <em>Phar::MD5</em>,
<em>Phar::SHA1</em>, <em>Phar::SHA256</em>,
<em>Phar::SHA512</em>, or <em>Phar::OPENSSL</em>
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">privatekey</code></em></span>
<dd>
<p class="para">
The contents of an OpenSSL private key, as extracted from a certificate or
OpenSSL key file:
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$private </span><span style="color: #007700">= </span><span style="color: #0000BB">openssl_get_privatekey</span><span style="color: #007700">(</span><span style="color: #0000BB">file_get_contents</span><span style="color: #007700">(</span><span style="color: #DD0000">'private.pem'</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">$pkey </span><span style="color: #007700">= </span><span style="color: #DD0000">''</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">openssl_pkey_export</span><span style="color: #007700">(</span><span style="color: #0000BB">$private</span><span style="color: #007700">, </span><span style="color: #0000BB">$pkey</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$p</span><span style="color: #007700">-></span><span style="color: #0000BB">setSignatureAlgorithm</span><span style="color: #007700">(</span><span style="color: #0000BB">Phar</span><span style="color: #007700">::</span><span style="color: #0000BB">OPENSSL</span><span style="color: #007700">, </span><span style="color: #0000BB">$pkey</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
See <a href="phar.using.html" class="link">phar introduction</a> for instructions on
naming and placement of the public key file.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-phar.setsignaturealgorithm-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
No value is returned.
</p>
</div>
<div class="refsect1 errors" id="refsect1-phar.setsignaturealgorithm-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Throws <a href="class.unexpectedvalueexception.html" class="classname">UnexpectedValueException</a> for many errors,
and a <a href="class.pharexception.html" class="classname">PharException</a>
if any problems occur flushing changes to disk.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-phar.setsignaturealgorithm-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="phar.getsupportedsignatures.html" class="function" rel="rdfs-seeAlso">Phar::getSupportedSignatures()</a> - Return array of supported signature types</span></li>
<li class="member"> <span class="function"><a href="phar.getsignature.html" class="function" rel="rdfs-seeAlso">Phar::getSignature()</a> - Return MD5/SHA1/SHA256/SHA512/OpenSSL signature of a Phar archive</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="phar.setmetadata.html">Phar::setMetadata</a></div>
<div class="next" style="text-align: right; float: right;"><a href="phar.setstub.html">Phar::setStub</a></div>
<div class="up"><a href="class.phar.html">Phar</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
