constants.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 5380fa1f30a0beacd62aec0d331939015f395fd6 Maintainer: duanxiaoqiang Status: ready -->
<!-- CREDITS: mowangjuanzi, Luffy -->
<appendix xml:id="openssl.constants" xmlns="http://docbook.org/ns/docbook">
 &reftitle.constants;
 &extension.constants;
  <section xml:id="openssl.purpose-check">
   <title>目的检查 flag</title>
   <variablelist>
    <varlistentry xml:id="constant.x509-purpose-ssl-client">
     <term>
      <constant>X509_PURPOSE_SSL_CLIENT</constant>
      (<type>int</type>)
     </term>
     <listitem>
      <simpara>
     
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="constant.x509-purpose-ssl-server">
     <term>
      <constant>X509_PURPOSE_SSL_SERVER</constant>
      (<type>int</type>)
     </term>
     <listitem>
      <simpara>
     
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="constant.x509-purpose-ns-ssl-server">
     <term>
      <constant>X509_PURPOSE_NS_SSL_SERVER</constant>
      (<type>int</type>)
     </term>
     <listitem>
      <simpara>
     
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="constant.x509-purpose-smime-sign">
     <term>
      <constant>X509_PURPOSE_SMIME_SIGN</constant>
      (<type>int</type>)
     </term>
     <listitem>
      <simpara>
     
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="constant.x509-purpose-smime-encrypt">
     <term>
      <constant>X509_PURPOSE_SMIME_ENCRYPT</constant>
      (<type>int</type>)
     </term>
     <listitem>
      <simpara>
     
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="constant.x509-purpose-crl-sign">
     <term>
      <constant>X509_PURPOSE_CRL_SIGN</constant>
      (<type>int</type>)
     </term>
     <listitem>
      <simpara>
     
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="constant.x509-purpose-any">
     <term>
      <constant>X509_PURPOSE_ANY</constant>
      (<type>int</type>)
     </term>
     <listitem>
      <simpara>
     
      </simpara>
     </listitem>
    </varlistentry>
   </variablelist>
  </section>

  <section xml:id="openssl.padding">
   <title>非对称加密的填充标志</title>
   <variablelist>
  <varlistentry xml:id="constant.openssl-pkcs1-padding">
   <term>
    <constant>OPENSSL_PKCS1_PADDING</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.openssl-sslv23-padding">
   <term>
    <constant>OPENSSL_SSLV23_PADDING</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.openssl-no-padding">
   <term>
    <constant>OPENSSL_NO_PADDING</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.openssl-pkcs1-oaep-padding">
   <term>
    <constant>OPENSSL_PKCS1_OAEP_PADDING</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     
    </simpara>
   </listitem>
  </varlistentry>
 </variablelist>
 </section>

  <section xml:id="openssl.key-types">
   <title>密钥类型</title>
 <variablelist>
  <varlistentry xml:id="constant.openssl-keytype-rsa">
   <term>
    <constant>OPENSSL_KEYTYPE_RSA</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.openssl-keytype-dsa">
   <term>
    <constant>OPENSSL_KEYTYPE_DSA</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.openssl-keytype-dh">
   <term>
    <constant>OPENSSL_KEYTYPE_DH</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.openssl-keytype-ec">
   <term>
    <constant>OPENSSL_KEYTYPE_EC</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     这个常量只有在使用 OpenSSL 0.9.8+ 进行编译时才可用。
    </simpara>
   </listitem>
  </varlistentry>  
 </variablelist>
  </section>  

  <section xml:id="openssl.pkcs7.flags">
   <title><acronym>PKCS7</acronym> flag/常量</title>
   <para>
    S/MIME 函数使用通过一个位阈来表示的标志位，该位阈可包含如下一个或多个值：
    <table>
     <title><acronym>PKCS7</acronym> 常量</title>
      <tgroup cols="2">
       <thead>
        <row>
         <entry>常量名</entry>
         <entry>描述</entry>
        </row>
       </thead>
       <tbody>
        <row xml:id="constant.pkcs7-text">
         <entry>
          <constant>PKCS7_TEXT</constant>
          (<type>int</type>)
         </entry>
         <entry>把纯文本类型的 header 头添加到加密/签名的消息中。如果解密或者验证，将会从输出中剥离这些 header 头 - 如果这些被解密或验证的消息不是 MIME 类型的纯文本文件将会导致一个错误。</entry>
        </row>
        <row xml:id="constant.pkcs7-binary">
         <entry>
          <constant>PKCS7_BINARY</constant>
          (<type>int</type>)
         </entry>
         <entry>通常输入消息将被转成以 <literal>CR</literal> 和 <literal>LF</literal> 作行末的 "canonical" 格式(S/MIME规范中的声明)。当该选项出现时，消息将不会被转化。 当处理非 MIME 格式的二进制数据时，这个选项会很有用。</entry>
        </row>
        <row xml:id="constant.pkcs7-nointern">
         <entry>
          <constant>PKCS7_NOINTERN</constant>
          (<type>int</type>)
         </entry>
         <entry>在验证消息时，在消息中包含的证书(如果有的话)通常会被搜索签名证书。 对于该选项，只有当 <function>openssl_pkcs7_verify</function> 函数的参数 <parameter>untrusted_certificates_filename</parameter> 指定了的证书才会被使用。然而提供的证书仍然被当做不受信任的证书使用。</entry>
        </row>
        <row xml:id="constant.pkcs7-noverify">
         <entry>
          <constant>PKCS7_NOVERIFY</constant>
          (<type>int</type>)
         </entry>
         <entry>不要验证签名消息的签名者证书。</entry>
        </row>
        <row xml:id="constant.pkcs7-nochain">
         <entry>
          <constant>PKCS7_NOCHAIN</constant>
          (<type>int</type>)
         </entry>
         <entry>不要约束验证签名者证书：不要把签名消息中的证书当做不受信任的证书。</entry>
        </row>
        <row xml:id="constant.pkcs7-nocerts">
         <entry>
          <constant>PKCS7_NOCERTS</constant>
          (<type>int</type>)
         </entry>
         <entry>在签署消息时，签名者的证书通常包括在内，但是有了这个选项后，就不需要包括证书了。这将会缩小被签名消息的大小，但是验证人在本地必须有可用的签名者证书副本(比如由 <function>openssl_pkcs7_verify</function> 函数中的 <parameter>untrusted_certificates_filename</parameter> 参数传递) 。
         </entry>
        </row>
        <row xml:id="constant.pkcs7-noattr">
         <entry>
          <constant>PKCS7_NOATTR</constant>
          (<type>int</type>)
         </entry>
         <entry>通常当消息被签名了，一些属性的集合将会包含在内，比如签名时间和支持的对称算法。使用该选项用来设置不包含这些属性。
         </entry>
        </row>
        <row xml:id="constant.pkcs7-detached">
         <entry>
          <constant>PKCS7_DETACHED</constant>
          (<type>int</type>)
         </entry>
         <entry>
          当签名消息时，使用 MIME 类型(<literal>"multipart/signed"</literal>)的明文签名。
          如果你为 <function>openssl_pkcs7_sign</function> 函数没有指定任何 <parameter>flags</parameter>，这个将会是默认的值。
          如果你关闭这个选项，消息将使用不透明的签名来签名, 这将会使消息更能抵抗邮件中继的翻译，但是不支持 S/MIME 的邮件客户端将不能读取该消息。
         </entry>
        </row>
        <row xml:id="constant.pkcs7-nosigs">
         <entry>
          <constant>PKCS7_NOSIGS</constant>
          (<type>int</type>)
         </entry>
         <entry>不要尝试在消息中验证签名</entry>
        </row>
        <row xml:id="constant.pkcs7-nooldmimetype">
         <entry>
          <constant>PKCS7_NOOLDMIMETYPE</constant>
          (<type>int</type>)
         </entry>
         <entry>
          自 PHP 8.3.0 起可用。
          将 content-type 设置为 <literal>application/pkcs7-mime</literal>，而不是 <literal>application/x-pkcs7-mime</literal> 来加密消息。
         </entry>
        </row>
       </tbody>
      </tgroup>
     </table>
   </para>
  </section>

  <section xml:id="openssl.cms.flags">
   <title><acronym>CMS</acronym> Flag/常量</title>
   <para>
    CMS 函数使用 flag，这些 flag 使用位字段指定，位字段可以包含以下一个或多个值：
    <table>
     <title><acronym>CMS</acronym> CONSTANTS</title>
      <tgroup cols="2">
       <thead>
        <row>
         <entry>常量名</entry>
         <entry>说明</entry>
        </row>
       </thead>
       <tbody>
        <row xml:id="constant.openssl-cms-text">
         <entry>
          <constant>OPENSSL_CMS_TEXT</constant>
          (<type>int</type>)
         </entry>
         <entry>
          将 text/plain 内容类型标头添加到加密/签名消息中。如果解密或验证，将从输出中去除这些标头；如果解密或验证的消息不是 MIME 类型 text/plain，则会发生错误。
         </entry>
        </row>
        <row xml:id="constant.openssl-cms-binary">
         <entry>
          <constant>OPENSSL_CMS_BINARY</constant>
          (<type>int</type>)
         </entry>
         <entry>
          通常，输入消息被转换为有效使用 <literal>CR</literal> 和 <literal>LF</literal> 作为行尾的“canonical”格式：按照
          CMS 规范的要求。存在此选项时，不会发生翻译。这在处理可能不是 CMS 格式的二进制数据时很有用。
         </entry>
        </row>
        <row xml:id="constant.openssl-cms-nointern">
         <entry>
          <constant>OPENSSL_CMS_NOINTERN</constant>
          (<type>int</type>)
         </entry>
         <entry>
          验证消息时，通常会搜索消息中包含的证书（如果有）以查找签名证书。使用此选项仅使用在 <function>openssl_cms_verify</function>
          的 <parameter>untrusted_certificates_filename</parameter> 参数中指定的证书。但是，提供的证书仍可用作不受信任的 CA。
         </entry>
        </row>
        <row xml:id="constant.openssl-cms-noverify">
         <entry>
          <constant>OPENSSL_CMS_NOVERIFY</constant>
          (<type>int</type>)
         </entry>
         <entry>
          不验证签名消息的签名者证书。
         </entry>
        </row>
        <row xml:id="constant.openssl-cms-nocerts">
         <entry>
          <constant>OPENSSL_CMS_NOCERTS</constant>
          (<type>int</type>)
         </entry>
         <entry>
          When signing a message the signer's certificate is normally
          included - with this option it is excluded.  This will reduce the
          size of the signed message but the verifier must have a copy of the
          signers certificate available locally (passed using the
          <parameter>untrusted_certificates_filename</parameter> to
          <function>openssl_cms_verify</function> for example).
         </entry>
        </row>
        <row xml:id="constant.openssl-cms-noattr">
         <entry>
          <constant>OPENSSL_CMS_NOATTR</constant>
          (<type>int</type>)
         </entry>
         <entry>
          Normally when a message is signed, a set of attributes are
          included which include the signing time and the supported symmetric
          algorithms.  With this option they are not included.
         </entry>
        </row>
        <row xml:id="constant.openssl-cms-detached">
         <entry>
          <constant>OPENSSL_CMS_DETACHED</constant>
          (<type>int</type>)
         </entry>
         <entry>
          When signing a message, use cleartext signing with the MIME
          type <literal>"multipart/signed"</literal>. This is the default
          if you do not specify any <parameter>flags</parameter> to
          <function>openssl_cms_sign</function>.
          If you turn this option off, the message will be signed using
          opaque signing, which is more resistant to translation by mail relays
          but cannot be read by mail agents that do not support S/MIME.
         </entry>
        </row>
        <row xml:id="constant.openssl-cms-nosigs">
         <entry>
          <constant>OPENSSL_CMS_NOSIGS</constant>
          (<type>int</type>)
         </entry>
         <entry>不要尝试验证消息的签名</entry>
        </row>
        <row xml:id="constant.openssl-cms-oldmimetype">
         <entry>
          <constant>OPENSSL_CMS_OLDMIMETYPE</constant>
          (<type>int</type>)
         </entry>
         <entry>
          自 PHP 8.3.0 起可用。
          将 content-type 设置为 <literal>application/x-pkcs7-mime</literal>，而不是 <literal>application/pkcs7-mime</literal> 来加密消息。
         </entry>
        </row>
       </tbody>
      </tgroup>
     </table>
   </para>
  </section>

  <section xml:id="openssl.signature-algos">
   <title>签名算法</title>
   <variablelist>
    <varlistentry xml:id="constant.openssl-algo-dss1">
     <term>
      <constant>OPENSSL_ALGO_DSS1</constant>
      (<type>int</type>)
     </term>
     <listitem>
      <simpara>

      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="constant.openssl-algo-sha1">
     <term>
      <constant>OPENSSL_ALGO_SHA1</constant>
      (<type>int</type>)
     </term>
     <listitem>
      <simpara>
        <function>openssl_sign</function> 和
       <function>openssl_verify</function> 函数使用的默认算法。
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="constant.openssl-algo-sha224">
     <term>
      <constant>OPENSSL_ALGO_SHA224</constant>
      (<type>int</type>)
     </term>
     <listitem>
      <simpara>

      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="constant.openssl-algo-sha256">
     <term>
      <constant>OPENSSL_ALGO_SHA256</constant>
      (<type>int</type>)
     </term>
     <listitem>
      <simpara>

      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="constant.openssl-algo-sha384">
     <term>
      <constant>OPENSSL_ALGO_SHA384</constant>
      (<type>int</type>)
     </term>
     <listitem>
      <simpara>

      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="constant.openssl-algo-sha512">
     <term>
      <constant>OPENSSL_ALGO_SHA512</constant>
      (<type>int</type>)
     </term>
     <listitem>
      <simpara>

      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="constant.openssl-algo-rmd160">
     <term>
      <constant>OPENSSL_ALGO_RMD160</constant>
      (<type>int</type>)
     </term>
     <listitem>
      <simpara>

      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="constant.openssl-algo-md5">
     <term>
      <constant>OPENSSL_ALGO_MD5</constant>
      (<type>int</type>)
     </term>
     <listitem>
      <simpara>

      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="constant.openssl-algo-md4">
     <term>
      <constant>OPENSSL_ALGO_MD4</constant>
      (<type>int</type>)
     </term>
     <listitem>
      <simpara>

      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="constant.openssl-algo-md2">
     <term>
      <constant>OPENSSL_ALGO_MD2</constant>
      (<type>int</type>)
     </term>
     <listitem>
      <simpara>
       只有在使用 MD2 支持编译 PHP 时，才可以使用这个常量。当在编译 PHP 时需要验证通过
       DHAVE_OPENSSL_MD2_H CFLAGP，当编译 OpenSSL 1.0.0+ 版本时需要启用 enable-md2选项。
      </simpara>
     </listitem>
    </varlistentry>
   </variablelist>

  </section>

  <section xml:id="openssl.ciphers">
   <title>Ciphers</title>
   <variablelist>
  <varlistentry xml:id="constant.openssl-cipher-rc2-40">
   <term>
    <constant>OPENSSL_CIPHER_RC2_40</constant>
     (<type>int</type>)
   </term>
   <listitem>
    <simpara>

    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.openssl-cipher-rc2-128">
   <term>
    <constant>OPENSSL_CIPHER_RC2_128</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>

    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.openssl-cipher-rc2-64">
   <term>
    <constant>OPENSSL_CIPHER_RC2_64</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>

    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.openssl-cipher-des">
   <term>
    <constant>OPENSSL_CIPHER_DES</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>

    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.openssl-cipher-3des">
   <term>
    <constant>OPENSSL_CIPHER_3DES</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>

    </simpara>
   </listitem>
  </varlistentry>
 </variablelist>
   <variablelist>
  <varlistentry xml:id="constant.openssl-cipher-aes-128-cbc">
   <term>
    <constant>OPENSSL_CIPHER_AES_128_CBC</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>

    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.openssl-cipher-aes-192-cbc">
   <term>
    <constant>OPENSSL_CIPHER_AES_192_CBC</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>

    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.openssl-cipher-aes-256-cbc">
   <term>
    <constant>OPENSSL_CIPHER_AES_256_CBC</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>

    </simpara>
   </listitem>
  </varlistentry>
 </variablelist>
  </section> 

 <section xml:id="openssl.constversion">
  <title>版本常量</title>
  <variablelist>
    <varlistentry xml:id="constant.openssl-version-text">
      <term>
       <constant>OPENSSL_VERSION_TEXT</constant>
       (<type>string</type>)
      </term>
      <listitem>
        <simpara>

        </simpara>
      </listitem>
    </varlistentry>
    <varlistentry xml:id="constant.openssl-version-number">
      <term>
       <constant>OPENSSL_VERSION_NUMBER</constant>
       (<type>int</type>)
      </term>
      <listitem>
        <simpara>

        </simpara>
      </listitem>
    </varlistentry>
  </variablelist>
 </section>

 <section xml:id="openssl.constsni">
  <title>Server Name Indication constants</title>
  <variablelist>
    <varlistentry xml:id="constant.openssl-tlsext-server-name">
      <term>
       <constant>OPENSSL_TLSEXT_SERVER_NAME</constant>
       (<type>int</type>)
      </term>
      <listitem>
        <simpara>
         SNI 支持是否可用。
        </simpara>
      </listitem>
    </varlistentry>
  </variablelist>
  <note>
   <para>
    这个常量要求 PHP 是由 OpenSSL 0.9.8j 及以上版本构建的。
   </para>
  </note>
 </section>

 <section xml:id="openssl.constants.other">
  <title>其它常量</title>
  <variablelist>
    <varlistentry xml:id="constant.openssl-raw-data">
      <term>
        <constant>OPENSSL_RAW_DATA</constant>
        (<type>int</type>)
      </term>
      <listitem>
        <simpara>
         If <constant>OPENSSL_RAW_DATA</constant> is set in the
         <function>openssl_encrypt</function> or <function>openssl_decrypt</function>,
         the returned data is returned as-is.
         When it is not specified, Base64 encoded data is returned to the caller.
        </simpara>
      </listitem>
    </varlistentry>
    <varlistentry xml:id="constant.openssl-zero-padding">
      <term>
       <constant>OPENSSL_ZERO_PADDING</constant>
       (<type>int</type>)
      </term>
      <listitem>
        <simpara>
         By default encryption operations are padded using standard block
         padding and the padding is checked and removed when decrypting.
         If <constant>OPENSSL_ZERO_PADDING</constant> is set in the
         <function>openssl_encrypt</function> or <function>openssl_decrypt</function>
         <parameter>options</parameter> then no padding is performed, the total
         amount of data encrypted or decrypted must then be a multiple of the
         block size or an error will occur.
        </simpara>
      </listitem>
    </varlistentry>
    <varlistentry xml:id="constant.openssl-encoding-smime">
      <term>
       <constant>OPENSSL_ENCODING_SMIME</constant>
       (<type>int</type>)
      </term>
      <listitem>
        <simpara>
         表明编码是 S/MIME。
        </simpara>
      </listitem>
    </varlistentry>
    <varlistentry xml:id="constant.openssl-encoding-der">
      <term>
       <constant>OPENSSL_ENCODING_DER</constant>
       (<type>int</type>)
      </term>
      <listitem>
        <simpara>
         表明编码是 <acronym>DER</acronym>。
        </simpara>
      </listitem>
    </varlistentry>
    <varlistentry xml:id="constant.openssl-encoding-pem">
      <term>
       <constant>OPENSSL_ENCODING_PEM</constant>
       (<type>int</type>)
      </term>
      <listitem>
        <simpara>
         表明编码是 <acronym>PEM</acronym>。
        </simpara>
      </listitem>
    </varlistentry>
  </variablelist>
 </section>
</appendix>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->