openssl-x509-checkpurpose.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 497c40ac164d5873fd87f622dfdeb5206392b446 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi -->
<refentry xml:id="function.openssl-x509-checkpurpose" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>openssl_x509_checkpurpose</refname>
  <refpurpose>証明書が特定の目的に使用可能かどうか確認する</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>bool</type><type>int</type></type><methodname>openssl_x509_checkpurpose</methodname>
   <methodparam><type class="union"><type>OpenSSLCertificate</type><type>string</type></type><parameter>certificate</parameter></methodparam>
   <methodparam><type>int</type><parameter>purpose</parameter></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>ca_info</parameter><initializer>[]</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>untrusted_certificates_file</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>openssl_x509_checkpurpose</function> は証明書を調べ、
   <parameter>purpose</parameter> で指定した目的に使用可能であるかどうかを確認します。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>certificate</parameter></term>
     <listitem>
      <para>
       調べたい証明書。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>purpose</parameter></term>
     <listitem>
      <para>
       <table>
        <title><function>openssl_x509_checkpurpose</function> の目的</title>
        <tgroup cols="2">
         <thead>
          <row>
           <entry>定数</entry>
           <entry>説明</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry>X509_PURPOSE_SSL_CLIENT</entry>
           <entry>
            この証明書を SSL 接続のクライアント側で使用できるか?
           </entry>
          </row>
          <row>
           <entry>X509_PURPOSE_SSL_SERVER</entry>
           <entry>
            この証明書を SSL 接続のサーバー側で使用できるか?
           </entry>
          </row>
          <row>
           <entry>X509_PURPOSE_NS_SSL_SERVER</entry>
           <entry>この証明書を Netscape SSL サーバーで使用できるか?</entry>
          </row>
          <row>
           <entry>X509_PURPOSE_SMIME_SIGN</entry>
           <entry>この証明書を S/MIME email で使用できるか?</entry>
          </row>
          <row>
           <entry>X509_PURPOSE_SMIME_ENCRYPT</entry>
           <entry>この証明書を S/MIME email の暗号化で使用できるか?</entry>
          </row>
          <row>
           <entry>X509_PURPOSE_CRL_SIGN</entry>
           <entry>
            この証明書を証明書取消リスト(CRL)にサインをする際に使用できるか?
           </entry>
          </row>
          <row>
           <entry>X509_PURPOSE_ANY</entry>
           <entry>この証明書をあらゆる用途に使用できるか?</entry>
          </row>
         </tbody>
        </tgroup>
       </table>
       これらのオプションはビットフィールドではありません。
       指定できるのは一つだけです!
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>ca_info</parameter></term>
     <listitem>
      <para>
       <parameter>ca_info</parameter> は、<link
       linkend="openssl.cert.verification">証明書の認証</link>
       で説明したような信頼できる CA ファイル/ディレクトリの配列です。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>untrusted_certificates_file</parameter></term>
     <listitem>
      <para>
       指定した場合は、これが証明書を含む<acronym>PEM</acronym>エンコードされたファイルの名前になります。
       この証明書は、検証と証明を簡単化するために使用されます。
       そのファイル内にある証明書は、信頼されない(untrusted)証明書とみなされます。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   証明書が意図した目的に使用可能である場合に &true;、使用できない場合に
   &false; 、エラーの場合に -1 を返します。
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>certificate</parameter> は、
       <classname>OpenSSLCertificate</classname> クラスのインスタンスを受け入れるようになりました。
       これより前のバージョンでは、
       <literal>OpenSSL X.509</literal> 型のリソースを受け入れていました。
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>untrusted_certificates_file</parameter> は、nullable になりました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>
</refentry>
<!-- 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
-->