Sophie

Sophie

distrib > Mageia > 7 > armv7hl > by-pkgid > 2b917e0437961edec048f1d15e2d7449 > files > 5460

php-manual-en-7.2.11-1.mga7.noarch.rpm

<!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>Returns the public key of a CSR</title>

 </head>
 <body><div class="manualnavbar" style="text-align: center;">
 <div class="prev" style="text-align: left; float: left;"><a href="function.openssl-csr-export.html">openssl_csr_export</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="function.openssl-csr-get-subject.html">openssl_csr_get_subject</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-csr-get-public-key" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">openssl_csr_get_public_key</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.2.0, PHP 7)</p><p class="refpurpose"><span class="refname">openssl_csr_get_public_key</span> &mdash; <span class="dc-title">Returns the public key of a CSR</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.openssl-csr-get-public-key-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="type">resource</span> <span class="methodname"><strong>openssl_csr_get_public_key</strong></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">$csr</code></span>
   [, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$use_shortnames</code><span class="initializer"> = <strong><code>TRUE</code></strong></span></span>
  ] )</div>

  <p class="para rdfs-comment">
   <span class="function"><strong>openssl_csr_get_public_key()</strong></span> extracts the public key 
   from <code class="parameter">csr</code> and prepares it for use by other functions.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.openssl-csr-get-public-key-parameters">
  <h3 class="title">Parameters</h3>
  <p class="para">
   <dl>

     
 <dt>
<code class="parameter">csr</code></dt>

 <dd>

  <p class="para">
   See <a href="openssl.certparams.html" class="link">CSR parameters</a> for a list of valid values.
  </p>
 </dd>


    
     <dt>
<code class="parameter">use_shortnames</code></dt>

     <dd>

      <div class="warning"><strong class="warning">Warning</strong>
       <p class="para">
        This parameter is ignored
       </p>
      </div>
     </dd>

    
   </dl>

  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.openssl-csr-get-public-key-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="para">
   Returns a positive key resource identifier on success, or FALSE on error. 
  </p>
 </div>

 
 <div class="refsect1 examples" id="refsect1-function.openssl-csr-get-public-key-examples">
  <h3 class="title">Examples</h3>
  <p class="para">
   <div class="example" id="example-958">
    <p><strong>Example #1 openssl_csr_get_public_key() example</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br />$subject&nbsp;</span><span style="color: #007700">=&nbsp;array(<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">"commonName"&nbsp;</span><span style="color: #007700">=&gt;&nbsp;</span><span style="color: #DD0000">"example.com"</span><span style="color: #007700">,<br />);<br /></span><span style="color: #0000BB">$private_key&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">openssl_pkey_new</span><span style="color: #007700">(array(<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">"private_key_bits"&nbsp;</span><span style="color: #007700">=&gt;&nbsp;</span><span style="color: #0000BB">2048</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">"private_key_type"&nbsp;</span><span style="color: #007700">=&gt;&nbsp;</span><span style="color: #0000BB">OPENSSL_KEYTYPE_RSA</span><span style="color: #007700">,<br />));<br /></span><span style="color: #0000BB">$csr&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">openssl_csr_new</span><span style="color: #007700">(</span><span style="color: #0000BB">$subject</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$private_key</span><span style="color: #007700">,&nbsp;array(</span><span style="color: #DD0000">'digest_alg'&nbsp;</span><span style="color: #007700">=&gt;&nbsp;</span><span style="color: #DD0000">'sha256'</span><span style="color: #007700">)&nbsp;);<br /></span><span style="color: #0000BB">$public_key&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">openssl_csr_get_public_key</span><span style="color: #007700">(</span><span style="color: #0000BB">$csr</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$info&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">openssl_pkey_get_details</span><span style="color: #007700">(</span><span style="color: #0000BB">$public_key</span><span style="color: #007700">);<br />echo&nbsp;</span><span style="color: #0000BB">$info</span><span style="color: #007700">[</span><span style="color: #DD0000">'key'</span><span style="color: #007700">];<br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</code></div>
    </div>

   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.openssl-csr-get-public-key-seealso">
  <h3 class="title">See Also</h3>
  <p class="para">
   <ul class="simplelist">
    <li class="member"><span class="function"><a href="function.openssl-csr-get-subject.html" class="function" rel="rdfs-seeAlso">openssl_csr_get_subject()</a> - Returns the subject of a CSR</span></li>
    <li class="member"><span class="function"><a href="function.openssl-csr-new.html" class="function" rel="rdfs-seeAlso">openssl_csr_new()</a> - Generates a CSR</span></li>
    <li class="member"><span class="function"><a href="function.openssl-pkey-get-details.html" class="function" rel="rdfs-seeAlso">openssl_pkey_get_details()</a> - Returns an array with the key details</span></li>
    <li class="member"><span class="function"><a href="function.openssl-pkey-export-to-file.html" class="function" rel="rdfs-seeAlso">openssl_pkey_export_to_file()</a> - Gets an exportable representation of a key into a file</span></li>
    <li class="member"><span class="function"><a href="function.openssl-pkey-export.html" class="function" rel="rdfs-seeAlso">openssl_pkey_export()</a> - Gets an exportable representation of a key into a string</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-csr-export.html">openssl_csr_export</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="function.openssl-csr-get-subject.html">openssl_csr_get_subject</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>