<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.openssl.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'zh',
  ),
  'this' => 
  array (
    0 => 'function.openssl-decrypt.php',
    1 => 'openssl_decrypt',
    2 => '解密数据',
  ),
  'up' => 
  array (
    0 => 'ref.openssl.php',
    1 => 'OpenSSL 函数',
  ),
  'prev' => 
  array (
    0 => 'function.openssl-csr-sign.php',
    1 => 'openssl_csr_sign',
  ),
  'next' => 
  array (
    0 => 'function.openssl-dh-compute-key.php',
    1 => 'openssl_dh_compute_key',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'zh',
    'path' => 'reference/openssl/functions/openssl-decrypt.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.openssl-decrypt" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">openssl_decrypt</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.3.0, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">openssl_decrypt</span> &mdash; <span class="dc-title">解密数据</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.openssl-decrypt-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>openssl_decrypt</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$data</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$cipher_algo</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="attribute"><a href="class.sensitiveparameter.php">#[\SensitiveParameter]</a> </span><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$passphrase</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$options</code><span class="initializer"> = 0</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$iv</code><span class="initializer"> = &quot;&quot;</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$tag</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$aad</code><span class="initializer"> = &quot;&quot;</span></span><br>): <span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="para rdfs-comment">
   采用原始或base64编码的字符串，并使用给定的方法和密码短语对其进行解密。
  </p>

 </div>


 <div class="refsect1 parameters" id="refsect1-function.openssl-decrypt-parameters">
  <h3 class="title">参数</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">data</code></dt>
     <dd>
      <p class="para">
       将被解密的密文。
      </p>
     </dd>
    
    
     <dt><code class="parameter">cipher_algo</code></dt>
     <dd>
      <p class="para">
       加密算法，使用<span class="function"><a href="function.openssl-get-cipher-methods.php" class="function">openssl_get_cipher_methods()</a></span>函数获取可用的加密算法列表。
      </p>
     </dd>
    
    
     <dt><code class="parameter">passphrase</code></dt>
     <dd>
      <p class="para">
       密码短语。若提供的密码短语比期望短，系统会自动用 <code class="literal">NUL</code> 字符静默填充；若密码短语比期望长，则会静默截断。
      </p>
      <div class="caution"><strong class="caution">警告</strong>
       <p class="simpara">
        正如其名称所示，passphrase 没有用于密钥导出函数。唯一的操作是用 <code class="literal">NUL</code> 字符填充，或者如果长度与预期不同则截断。
       </p>
      </div>
     </dd>
    
    
      <dt><code class="parameter">options</code></dt>
      <dd>
       <p class="para">
        <code class="parameter">options</code> 可以是以下常量之一：
        <strong><code><a href="openssl.constants.other.php#constant.openssl-raw-data">OPENSSL_RAW_DATA</a></code></strong>、
        <strong><code><a href="openssl.constants.other.php#constant.openssl-zero-padding">OPENSSL_ZERO_PADDING</a></code></strong>
        或 <strong><code><a href="openssl.constants.other.php#constant.openssl-dont-zero-pad-key">OPENSSL_DONT_ZERO_PAD_KEY</a></code></strong>。
       </p>
      </dd>
    
    
     <dt><code class="parameter">iv</code></dt>
     <dd>
      <p class="para">
       非 <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong> 的初始化向量。如果 IV 比预期短，则用 <code class="literal">NUL</code> 字符填充并发出警告；如果密码短语比预期长，则将其截断并发出警告。
      </p>
     </dd>
    
    
     <dt><code class="parameter">tag</code></dt>
     <dd>
      <p class="para">
       AEAD密码模式中的身份验证标签。 如果是错误的，验证失败，函数返回<strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>.
      </p>
      <div class="caution"><strong class="caution">警告</strong>
       <p class="simpara">
        函数不检查 <code class="parameter">tag</code> 的长度。调用者有责任确保 tag 的长度与调用 <span class="function"><a href="function.openssl-encrypt.php" class="function">openssl_encrypt()</a></span>
        时检索到的 tag 的长度相匹配。否则，如果给定的 tag 仅匹配正确 tag 的开头，解密可能会成功。
       </p>
      </div>
     </dd>
    
    
     <dt><code class="parameter">aad</code></dt>
     <dd>
      <p class="para">
       额外的认证数据。
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.openssl-decrypt-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="para">
   成功时已解密的字符串 或者在失败时返回 <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>。
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-function.openssl-decrypt-errors">
  <h3 class="title">错误／异常</h3>
  <p class="para">
   如果通过 <code class="parameter">cipher_algo</code> 参数传递的是未知的加密算法，将会抛出 <strong><code><a href="errorfunc.constants.php#constant.e-warning">E_WARNING</a></code></strong> 等级的错误。
  </p>
  <p class="para">
   如果通过<code class="parameter">iv</code>参数传递的是一个空值，将会抛出一个 <strong><code><a href="errorfunc.constants.php#constant.e-warning">E_WARNING</a></code></strong> 等级的错误。
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.openssl-decrypt-changelog">
  <h3 class="title">更新日志</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>版本</th>
      <th>说明</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td>8.1.0</td>
      <td><code class="parameter">tag</code> 现在可为 null。</td>
     </tr>

     <tr>
      <td>7.1.0</td>
      <td>添加了 <code class="parameter">tag</code> 和 <code class="parameter">aad</code> 参数。</td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 seealso" id="refsect1-function.openssl-decrypt-seealso">
  <h3 class="title">参见</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.openssl-encrypt.php" class="function" rel="rdfs-seeAlso">openssl_encrypt()</a> - 加密数据</span></li>
   </ul>
  </p>
 </div>


</div><?php manual_footer($setup); ?>