cvs: phpdoc /en/reference/openssl/functions openssl-pkcs12-export-to-file.xml openssl-pkcs12-export.xml openssl-pkcs12-read.xml

nathan Fri Oct 26 03:35:11 2007 UTC Added files: /phpdoc/en/reference/openssl/functions openssl-pkcs12-export-to-file.xml openssl-pkcs12-export.xml openssl-pkcs12-read.xml Log: adding PKCS12 placeholder documentation, at least defines the basic I/O for each function could do with some elaboration in some areas though

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/openssl/functions/openssl-pkcs12-export-to-file.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/openssl/functions/openssl-pkcs12-export-to-file.xml +++ phpdoc/en/reference/openssl/functions/openssl-pkcs12-export-to-file.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.openssl-pkcs12-export-to-file"> <refnamediv> <refname>openssl_pkcs12_export_to_file</refname> <refpurpose>Exports a PKCS#12 Compatible Certificate Store File</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>openssl_pkcs12_export_to_file</methodname> <methodparam><type>mixed</type><parameter>x509</parameter></methodparam> <methodparam><type>string</type><parameter>filename</parameter></methodparam> <methodparam><type>mixed</type><parameter>priv_key</parameter></methodparam> <methodparam><type>string</type><parameter>pass</parameter></methodparam> <methodparam choice="opt"><type>array</type><parameter>args</parameter></methodparam> </methodsynopsis> <para> <function>openssl_pkcs12_export_to_file</function> stores <parameter>x509</parameter> into a file named by <parameter>filename</parameter> in a PKCS#12 file format. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>x509</parameter></term> <listitem> <para> </para> </listitem> </varlistentry> <varlistentry> <term><parameter>filename</parameter></term> <listitem> <para> Path to the output file. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>priv_key</parameter></term> <listitem> <para> Private key component of PKCS#12 file. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>pass</parameter></term> <listitem> <para> Encryption password for unlocking the PKCS#12 file. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>args</parameter></term> <listitem> <para> </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.success; </para> </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:"../../../../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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/openssl/functions/openssl-pkcs12-export.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/openssl/functions/openssl-pkcs12-export.xml +++ phpdoc/en/reference/openssl/functions/openssl-pkcs12-export.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.openssl-pkcs12-export"> <refnamediv> <refname>openssl_pkcs12_export</refname> <refpurpose>Exports a PKCS#12 Compatible Certificate Store File to variable.</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>openssl_pkcs12_export</methodname> <methodparam><type>mixed</type><parameter>x509</parameter></methodparam> <methodparam><type>string</type><parameter role="reference">out</parameter></methodparam> <methodparam><type>mixed</type><parameter>priv_key</parameter></methodparam> <methodparam><type>string</type><parameter>pass</parameter></methodparam> <methodparam choice="opt"><type>array</type><parameter>args</parameter></methodparam> </methodsynopsis> <para> <function>openssl_pkcs12_export</function> stores <parameter>x509</parameter> into a string named by <parameter>out</parameter> in a PKCS#12 file format. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>x509</parameter></term> <listitem> <para> </para> </listitem> </varlistentry> <varlistentry> <term><parameter>out</parameter></term> <listitem> <para> On success, this will hold the PKCS#12. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>priv_key</parameter></term> <listitem> <para> Private key component of PKCS#12 file. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>pass</parameter></term> <listitem> <para> Encryption password for unlocking the PKCS#12 file. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>args</parameter></term> <listitem> <para> </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.success; </para> </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:"../../../../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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/openssl/functions/openssl-pkcs12-read.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/openssl/functions/openssl-pkcs12-read.xml +++ phpdoc/en/reference/openssl/functions/openssl-pkcs12-read.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.openssl-pkcs12-read"> <refnamediv> <refname>openssl_pkcs12_read</refname> <refpurpose>Parse a PKCS#12 Certificate Store into an array</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>openssl_pkcs12_read</methodname> <methodparam><type>mixed</type><parameter>PKCS12</parameter></methodparam> <methodparam><type>array</type><parameter role="reference">certs</parameter></methodparam> <methodparam><type>string</type><parameter>pass</parameter></methodparam> </methodsynopsis> <para> <function>openssl_pkcs12_read</function> parses the PKCS#12 certificate store supplied by <parameter>PKCS12</parameter> into a array named <parameter>certs</parameter>. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>PKCS12</parameter></term> <listitem> <para> </para> </listitem> </varlistentry> <varlistentry> <term><parameter>certs</parameter></term> <listitem> <para> On success, this will hold the Certificate Store Data. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>pass</parameter></term> <listitem> <para> Encryption password for unlocking the PKCS#12 file. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.success; </para> </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:"../../../../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 -->