<!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>Parse a PKCS#12 Certificate Store into an array</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.openssl-pkcs12-export.html">openssl_pkcs12_export</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.openssl-pkcs7-decrypt.html">openssl_pkcs7_decrypt</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-pkcs12-read" class="refentry">
<div class="refnamediv">
<h1 class="refname">openssl_pkcs12_read</h1>
<p class="verinfo">(PHP 5 >= 5.2.2, PHP 7)</p><p class="refpurpose"><span class="refname">openssl_pkcs12_read</span> — <span class="dc-title">Parse a PKCS#12 Certificate Store into an array</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.openssl-pkcs12-read-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>openssl_pkcs12_read</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$pkcs12</code></span>
, <span class="methodparam"><span class="type">array</span> <code class="parameter reference">&$certs</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$pass</code></span>
)</div>
<p class="para rdfs-comment">
<span class="function"><strong>openssl_pkcs12_read()</strong></span> parses the PKCS#12 certificate store supplied by
<code class="parameter">pkcs12</code> into a array named
<code class="parameter">certs</code>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.openssl-pkcs12-read-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">pkcs12</code></dt>
<dd>
<p class="para">
The certificate store contents, not its file name.
</p>
</dd>
<dt>
<code class="parameter">certs</code></dt>
<dd>
<p class="para">
On success, this will hold the Certificate Store Data.
</p>
</dd>
<dt>
<code class="parameter">pass</code></dt>
<dd>
<p class="para">
Encryption password for unlocking the PKCS#12 file.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.openssl-pkcs12-read-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-pkcs12-read-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-974">
<p><strong>Example #1 <span class="function"><strong>openssl_pkcs12_read()</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: #007700">if (!</span><span style="color: #0000BB">$cert_store </span><span style="color: #007700">= </span><span style="color: #0000BB">file_get_contents</span><span style="color: #007700">(</span><span style="color: #DD0000">"/certs/file.p12"</span><span style="color: #007700">)) {<br /> echo </span><span style="color: #DD0000">"Error: Unable to read the cert file\n"</span><span style="color: #007700">;<br /> exit;<br />}<br /><br />if (</span><span style="color: #0000BB">openssl_pkcs12_read</span><span style="color: #007700">(</span><span style="color: #0000BB">$cert_store</span><span style="color: #007700">, </span><span style="color: #0000BB">$cert_info</span><span style="color: #007700">, </span><span style="color: #DD0000">"my_secret_pass"</span><span style="color: #007700">)) {<br /> echo </span><span style="color: #DD0000">"Certificate Information\n"</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$cert_info</span><span style="color: #007700">);<br />} else {<br /> echo </span><span style="color: #DD0000">"Error: Unable to read the cert store.\n"</span><span style="color: #007700">;<br /> exit;<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.openssl-pkcs12-export.html">openssl_pkcs12_export</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.openssl-pkcs7-decrypt.html">openssl_pkcs7_decrypt</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>
