<!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>Seal (encrypt) data</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.openssl-random-pseudo-bytes.html">openssl_random_pseudo_bytes</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.openssl-sign.html">openssl_sign</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-seal" class="refentry">
<div class="refnamediv">
<h1 class="refname">openssl_seal</h1>
<p class="verinfo">(PHP 4 >= 4.0.4, PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">openssl_seal</span> — <span class="dc-title">Seal (encrypt) data</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.openssl-seal-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>openssl_seal</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$data</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter reference">&$sealed_data</code></span>
, <span class="methodparam"><span class="type">array</span> <code class="parameter reference">&$env_keys</code></span>
, <span class="methodparam"><span class="type">array</span> <code class="parameter">$pub_key_ids</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 reference">&$iv</code></span>
]] )</div>
<p class="para rdfs-comment">
<span class="function"><strong>openssl_seal()</strong></span> seals (encrypts)
<code class="parameter">data</code> by using the given <code class="parameter">method</code> with a randomly generated
secret key. The key is encrypted with each of the public keys
associated with the identifiers in <code class="parameter">pub_key_ids</code>
and each encrypted key is returned
in <code class="parameter">env_keys</code>. This means that one can send
sealed data to multiple recipients (provided one has obtained their
public keys). Each recipient must receive both the sealed data and
the envelope key that was encrypted with the recipient's public key.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.openssl-seal-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">data</code></dt>
<dd>
<p class="para">
The data to seal.
</p>
</dd>
<dt>
<code class="parameter">sealed_data</code></dt>
<dd>
<p class="para">
The sealed data.
</p>
</dd>
<dt>
<code class="parameter">env_keys</code></dt>
<dd>
<p class="para">
Array of encrypted keys.
</p>
</dd>
<dt>
<code class="parameter">pub_key_ids</code></dt>
<dd>
<p class="para">
Array of public key resource identifiers.
</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-seal-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the length of the sealed data on success, or <strong><code>FALSE</code></strong> on error.
If successful the sealed data is returned in
<code class="parameter">sealed_data</code>, and the envelope keys in
<code class="parameter">env_keys</code>.
</p>
</div>
<div class="refsect1 changelog" id="refsect1-function.openssl-seal-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-seal-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-979">
<p><strong>Example #1 <span class="function"><strong>openssl_seal()</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">// $data is assumed to contain the data to be sealed<br /><br />// fetch public keys for our recipients, and ready them<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/maurice/cert.pem"</span><span style="color: #007700">, </span><span style="color: #DD0000">"r"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$cert </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">$pk1 </span><span style="color: #007700">= </span><span style="color: #0000BB">openssl_get_publickey</span><span style="color: #007700">(</span><span style="color: #0000BB">$cert</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// Repeat for second recipient<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/cert.pem"</span><span style="color: #007700">, </span><span style="color: #DD0000">"r"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$cert </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">$pk2 </span><span style="color: #007700">= </span><span style="color: #0000BB">openssl_get_publickey</span><span style="color: #007700">(</span><span style="color: #0000BB">$cert</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// seal message, only owners of $pk1 and $pk2 can decrypt $sealed with keys<br />// $ekeys[0] and $ekeys[1] respectively.<br /></span><span style="color: #0000BB">openssl_seal</span><span style="color: #007700">(</span><span style="color: #0000BB">$data</span><span style="color: #007700">, </span><span style="color: #0000BB">$sealed</span><span style="color: #007700">, </span><span style="color: #0000BB">$ekeys</span><span style="color: #007700">, array(</span><span style="color: #0000BB">$pk1</span><span style="color: #007700">, </span><span style="color: #0000BB">$pk2</span><span style="color: #007700">));<br /><br /></span><span style="color: #FF8000">// free the keys from memory<br /></span><span style="color: #0000BB">openssl_free_key</span><span style="color: #007700">(</span><span style="color: #0000BB">$pk1</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">openssl_free_key</span><span style="color: #007700">(</span><span style="color: #0000BB">$pk2</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-seal-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="function.openssl-open.html" class="function" rel="rdfs-seeAlso">openssl_open()</a> - Open sealed 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-random-pseudo-bytes.html">openssl_random_pseudo_bytes</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.openssl-sign.html">openssl_sign</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>
