openssl-pkey-new.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.openssl-pkey-new">
 <refnamediv>
  <refname>openssl_pkey_new</refname>
  <refpurpose>Generates a new private key </refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>openssl_pkey_new</methodname>
   <methodparam choice="opt"><type>array</type><parameter>configargs</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>openssl_pkey_new</function> generates a new private and public
   key pair.  The public component of the key can be obtained using
   <function>openssl_pkey_get_public</function>.
  </para>
  &note.openssl.cnf;
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>configargs</parameter></term>
     <listitem>
      <para>
       You can finetune the key generation (such as specifying the number of
       bits) using <parameter>configargs</parameter>.  See
       <function>openssl_csr_new</function> for more information about
       <parameter>configargs</parameter>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns a resource identifier for the pkey on success, or &false; on
   error.
  </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:"~/.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
-->