<!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>Open sealed data</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.openssl-get-publickey.html">openssl_get_publickey</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.openssl-pbkdf2.html">openssl_pbkdf2</a></div>
<div class="up"><a href="ref.openssl.html">OpenSSL Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.openssl-open" class="refentry">
<div class="refnamediv">
<h1 class="refname">openssl_open</h1>
<p class="verinfo">(PHP 4 >= 4.0.4, PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">openssl_open</span> — <span class="dc-title">Open sealed data</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.openssl-open-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>openssl_open</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$sealed_data</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter reference">&$open_data</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$env_key</code></span>
, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$priv_key_id</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$method</code><span class="initializer"> = "RC4"</span></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$iv</code></span>
]] )</div>
<p class="para rdfs-comment">
<span class="function"><strong>openssl_open()</strong></span> opens (decrypts)
<code class="parameter">sealed_data</code> using the private key associated with
the key identifier <code class="parameter">priv_key_id</code> and the envelope key
<code class="parameter">env_key</code>, and fills
<code class="parameter">open_data</code> with the decrypted data.
The envelope key is generated when the
data are sealed and can only be used by one specific private key. See
<span class="function"><a href="function.openssl-seal.html" class="function">openssl_seal()</a></span> for more information.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.openssl-open-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">sealed_data</code></dt>
<dd>
<p class="para">
</p>
</dd>
<dt>
<code class="parameter">open_data</code></dt>
<dd>
<p class="para">
If the call is successful the opened data is returned in this
parameter.
</p>
</dd>
<dt>
<code class="parameter">env_key</code></dt>
<dd>
<p class="para">
</p>
</dd>
<dt>
<code class="parameter">priv_key_id</code></dt>
<dd>
<p class="para">
</p>
</dd>
<dt>
<code class="parameter">method</code></dt>
<dd>
<p class="para">
The cipher method.
</p>
</dd>
<dt>
<code class="parameter">iv</code></dt>
<dd>
<p class="para">
The initialization vector.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.openssl-open-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 changelog" id="refsect1-function.openssl-open-changelog">
<h3 class="title">Changelog</h3>
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>7.0.0</td>
<td>
The <code class="parameter">iv</code> has been added.
</td>
</tr>
<tr>
<td>5.3.0</td>
<td>
The <code class="parameter">method</code> has been added.
</td>
</tr>
</tbody>
</table>
</div>
<div class="refsect1 examples" id="refsect1-function.openssl-open-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-972">
<p><strong>Example #1 <span class="function"><strong>openssl_open()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// $sealed and $env_key are assumed to contain the sealed data<br />// and our envelope key, both given to us by the sealer.<br /><br />// fetch private key from file and ready it<br /></span><span style="color: #0000BB">$fp </span><span style="color: #007700">= </span><span style="color: #0000BB">fopen</span><span style="color: #007700">(</span><span style="color: #DD0000">"/src/openssl-0.9.6/demos/sign/key.pem"</span><span style="color: #007700">, </span><span style="color: #DD0000">"r"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$priv_key </span><span style="color: #007700">= </span><span style="color: #0000BB">fread</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">, </span><span style="color: #0000BB">8192</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">fclose</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$pkeyid </span><span style="color: #007700">= </span><span style="color: #0000BB">openssl_get_privatekey</span><span style="color: #007700">(</span><span style="color: #0000BB">$priv_key</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// decrypt the data and store it in $open<br /></span><span style="color: #007700">if (</span><span style="color: #0000BB">openssl_open</span><span style="color: #007700">(</span><span style="color: #0000BB">$sealed</span><span style="color: #007700">, </span><span style="color: #0000BB">$open</span><span style="color: #007700">, </span><span style="color: #0000BB">$env_key</span><span style="color: #007700">, </span><span style="color: #0000BB">$pkeyid</span><span style="color: #007700">)) {<br /> echo </span><span style="color: #DD0000">"here is the opened data: "</span><span style="color: #007700">, </span><span style="color: #0000BB">$open</span><span style="color: #007700">;<br />} else {<br /> echo </span><span style="color: #DD0000">"failed to open data"</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #FF8000">// free the private key from memory<br /></span><span style="color: #0000BB">openssl_free_key</span><span style="color: #007700">(</span><span style="color: #0000BB">$pkeyid</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.openssl-open-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="function.openssl-seal.html" class="function" rel="rdfs-seeAlso">openssl_seal()</a> - Seal (encrypt) data</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="function.openssl-get-publickey.html">openssl_get_publickey</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.openssl-pbkdf2.html">openssl_pbkdf2</a></div>
<div class="up"><a href="ref.openssl.html">OpenSSL Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
