openssl-x509-parse.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.openssl-x509-parse" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>openssl_x509_parse</refname>
  <refpurpose>Parse an X509 certificate and return the information as an array</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></type><methodname>openssl_x509_parse</methodname>
   <methodparam><type class="union"><type>OpenSSLCertificate</type><type>string</type></type><parameter>certificate</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>short_names</parameter><initializer>&true;</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>openssl_x509_parse</function> returns information about the
   supplied <parameter>certificate</parameter>, including fields such as subject
   name, issuer name, purposes, valid from and valid to dates etc.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>certificate</parameter></term>
     <listitem>
      <para>
        X509 certificate. See <link linkend="openssl.certparams">Key/Certificate parameters</link> for a list of valid values.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>short_names</parameter></term>
     <listitem>
      <para>
       <parameter>short_names</parameter> controls how the data is indexed in the
       array - if <parameter>short_names</parameter> is &true; (the default) then
       fields will be indexed with the short name form, otherwise, the long name
       form will be used - e.g.: CN is the shortname form of commonName.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <emphasis>The structure of the returned data is (deliberately) not
   yet documented, as it is still subject to change.</emphasis>
  </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.4.0</entry>
      <entry>
       Parsing certificate with no seconds in UTCTime is no longer allowed for any OpenSSL version.
       It was already disallowed for OpenSSL version 3.3+.
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>certificate</parameter> accepts an <classname>OpenSSLCertificate</classname> instance now;
       previously, a &resource; of type <literal>OpenSSL X.509</literal> was accepted.
      </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
-->