<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.rnp.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'es',
  ),
  'this' => 
  array (
    0 => 'function.rnp-op-generate-key.php',
    1 => 'rnp_op_generate_key',
    2 => 'Genera una clave',
  ),
  'up' => 
  array (
    0 => 'ref.rnp.php',
    1 => 'Funciones de Rnp',
  ),
  'prev' => 
  array (
    0 => 'function.rnp-op-encrypt.php',
    1 => 'rnp_op_encrypt',
  ),
  'next' => 
  array (
    0 => 'function.rnp-op-sign.php',
    1 => 'rnp_op_sign',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'es',
    'path' => 'reference/rnp/functions/rnp-op-generate-key.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.rnp-op-generate-key" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">rnp_op_generate_key</h1>
  <p class="verinfo">(PECL rnp &gt;= 0.1.1)</p><p class="refpurpose"><span class="refname">rnp_op_generate_key</span> &mdash; <span class="dc-title">Genera una clave</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.rnp-op-generate-key-description">
  <h3 class="title">Descripción</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>rnp_op_generate_key</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="class.rnpffi.php" class="type RnpFFI">RnpFFI</a></span> <code class="parameter">$ffi</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$userid</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$key_alg</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$sub_alg</code><span class="initializer"> = ?</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.array.php" class="type array">array</a></span> <code class="parameter">$options</code><span class="initializer"> = ?</span></span><br>): <span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="simpara">

  </p>

 </div>


 <div class="refsect1 parameters" id="refsect1-function.rnp-op-generate-key-parameters">
  <h3 class="title">Parámetros</h3>
  <dl>
   
    <dt><code class="parameter">ffi</code></dt>
    <dd>
     <span class="simpara">
      El objeto FFI retornado por <span class="function"><a href="function.rnp-ffi-create.php" class="function">rnp_ffi_create()</a></span>.
     </span>
    </dd>
   
   
    <dt><code class="parameter">userid</code></dt>
    <dd>
     <span class="simpara">
      El identificador del usuario PGP - texto que debe representar
      el nombre y la dirección de correo electrónico del titular de la clave.
     </span>
    </dd>
   
   
    <dt><code class="parameter">key_alg</code></dt>
    <dd>
     <span class="simpara">
      La clave del algoritmo (es decir, &#039;RSA&#039;, &#039;DSA&#039;, etc).
     </span>
    </dd>
   
   
    <dt><code class="parameter">sub_alg</code></dt>
    <dd>
     <span class="simpara">
      El algoritmo de subclave. Si no está definido, la subclave no será generada.
     </span>
    </dd>
   
   
    <dt><code class="parameter">options</code></dt>
    <dd>
     <span class="simpara">
      Un array asociativo con opciones.
     </span>
     <table class="doctable informaltable">
      
       <thead>
        <tr>
         <th>Clave</th>
         <th>Tipo de datos</th>
         <th>Descripción</th>
        </tr>

       </thead>

       <tbody class="tbody">
        <tr>
         <td><code class="literal">&quot;bits&quot;</code></td>
         <td>integer</td>
         <td>El tamaño de la clave principal en bits. Aplicable únicamente a las claves RSA, DSA y El-Gamal.</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;hash&quot;</code></td>
         <td>string</td>
         <td>Algoritmo de hash utilizado en la firma de la clave o la firma de ligadura de subclave.</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;dsa_qbits&quot;</code></td>
         <td>integer</td>
         <td>Define el tamaño de un parámetro <code class="literal">q</code> para la clave DSA.
          Nota: se definirá un valor predeterminado adecuado, según el número de bits de la clave. Sin embargo, puede
          ser reemplazado si es necesario.</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;curve&quot;</code></td>
         <td>string</td>
         <td>Define la curva utilizada para la clave ECC. Nota: esto se aplica únicamente a las claves ECDSA, ECDH y SM2.</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;request_password&quot;</code></td>
         <td>boolean</td>
         <td>Activa la solicitud de contraseña a través del proveedor de contraseñas. Esta contraseña
          será utilizada para el cifrado de la clave. La función de retrollamada del proveedor de contraseñas debe ser definida previamente
          llamando a <span class="function"><a href="function.rnp-ffi-set-pass-provider.php" class="function">rnp_ffi_set_pass_provider()</a></span>.
          Nota: este parámetro será ignorado si la contraseña ha sido definida a través de <code class="literal">&quot;password&quot;</code></td>
        </tr>

        <tr>
         <td><code class="literal">&quot;password&quot;</code></td>
         <td>string</td>
         <td>Define la contraseña utilizada para cifrar los datos de la clave secreta.</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;expiration&quot;</code></td>
         <td>integer</td>
         <td>Define el tiempo de expiración de la clave principal y la subclave en segundos.</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;sub_bits&quot;</code></td>
         <td>integer</td>
         <td>El tamaño de la subclave en bits. Aplicable únicamente a las claves RSA, DSA y El-Gamal.</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;sub_hash&quot;</code></td>
         <td>string</td>
         <td>Algoritmo de hash utilizado en la firma de la subclave o la firma de ligadura de subclave.</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;sub_curve&quot;</code></td>
         <td>string</td>
         <td>Define la curva utilizada para la subclave ECC. Nota: esto se aplica únicamente a las claves ECDSA, ECDH y SM2.</td>
        </tr>

       </tbody>
      
     </table>

    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.rnp-op-generate-key-returnvalues">
  <h3 class="title">Valores devueltos</h3>
  <p class="simpara">
   La huella de la clave principal generada o <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> si ocurre un error. Esta huella puede ser utilizada
   más tarde para referenciar la clave en las operaciones de firma y cifrado. Los datos de la clave se almacenan en el contexto de memoria
   FFI y pueden ser guardados utilizando
   <span class="function"><a href="function.rnp-save-keys.php" class="function">rnp_save_keys()</a></span> o <span class="function"><a href="function.rnp-save-keys-to-path.php" class="function">rnp_save_keys_to_path()</a></span>.
  </p>
 </div>


</div><?php manual_footer($setup); ?>