<!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>Decrypts an S/MIME encrypted message</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.openssl-pkcs12-read.html">openssl_pkcs12_read</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.openssl-pkcs7-encrypt.html">openssl_pkcs7_encrypt</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-pkcs7-decrypt" class="refentry">
<div class="refnamediv">
<h1 class="refname">openssl_pkcs7_decrypt</h1>
<p class="verinfo">(PHP 4 >= 4.0.6, PHP 5)</p><p class="refpurpose"><span class="refname">openssl_pkcs7_decrypt</span> — <span class="dc-title">Decrypts an S/MIME encrypted message</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.openssl-pkcs7-decrypt-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>openssl_pkcs7_decrypt</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$infilename</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$outfilename</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">$recipcert</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">$recipkey</code></span>
] )</div>
<p class="para rdfs-comment">
Decrypts the S/MIME encrypted message contained in the file specified by
<em><code class="parameter">infilename</code></em> using the certificate and its
associated private key specified by <em><code class="parameter">recipcert</code></em> and
<em><code class="parameter">recipkey</code></em>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.openssl-pkcs7-decrypt-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">infilename</code></em></span>
<dd>
<p class="para">
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">outfilename</code></em></span>
<dd>
<p class="para">
The decrypted message is written to the file specified by
<em><code class="parameter">outfilename</code></em>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">recipcert</code></em></span>
<dd>
<p class="para">
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">recipkey</code></em></span>
<dd>
<p class="para">
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.openssl-pkcs7-decrypt-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 examples" id="refsect1-function.openssl-pkcs7-decrypt-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-865">
<p><strong>Example #1 <span class="function"><strong>openssl_pkcs7_decrypt()</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">// $cert and $key are assumed to contain your personal certificate and private<br />// key pair, and that you are the recipient of an S/MIME message<br /></span><span style="color: #0000BB">$infilename </span><span style="color: #007700">= </span><span style="color: #DD0000">"encrypted.msg"</span><span style="color: #007700">; </span><span style="color: #FF8000">// this file holds your encrypted message<br /></span><span style="color: #0000BB">$outfilename </span><span style="color: #007700">= </span><span style="color: #DD0000">"decrypted.msg"</span><span style="color: #007700">; </span><span style="color: #FF8000">// make sure you can write to this file<br /><br /></span><span style="color: #007700">if (</span><span style="color: #0000BB">openssl_pkcs7_decrypt</span><span style="color: #007700">(</span><span style="color: #0000BB">$infilename</span><span style="color: #007700">, </span><span style="color: #0000BB">$outfilename</span><span style="color: #007700">, </span><span style="color: #0000BB">$cert</span><span style="color: #007700">, </span><span style="color: #0000BB">$key</span><span style="color: #007700">)) {<br /> echo </span><span style="color: #DD0000">"decrypted!"</span><span style="color: #007700">;<br />} else {<br /> echo </span><span style="color: #DD0000">"failed to decrypt!"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.openssl-pkcs12-read.html">openssl_pkcs12_read</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.openssl-pkcs7-encrypt.html">openssl_pkcs7_encrypt</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>
