<?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-encrypt.php',
    1 => 'rnp_op_encrypt',
    2 => 'Cifra un mensaje',
  ),
  'up' => 
  array (
    0 => 'ref.rnp.php',
    1 => 'Funciones de Rnp',
  ),
  'prev' => 
  array (
    0 => 'function.rnp-locate-key.php',
    1 => 'rnp_locate_key',
  ),
  'next' => 
  array (
    0 => 'function.rnp-op-generate-key.php',
    1 => 'rnp_op_generate_key',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'es',
    'path' => 'reference/rnp/functions/rnp-op-encrypt.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.rnp-op-encrypt" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">rnp_op_encrypt</h1>
  <p class="verinfo">(PECL rnp &gt;= 0.1.1)</p><p class="refpurpose"><span class="refname">rnp_op_encrypt</span> &mdash; <span class="dc-title">Cifra un mensaje</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.rnp-op-encrypt-description">
  <h3 class="title">Descripción</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>rnp_op_encrypt</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">$message</code></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">$recipient_keys_fp</code></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-encrypt-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">message</code></dt>
    <dd>
     <span class="simpara">
      El mensaje a cifrar.
     </span>
    </dd>
   
   
    <dt><code class="parameter">recipient_keys_fp</code></dt>
    <dd>
     <span class="simpara">
      Un array con las huellas de las claves del destinatario. Al menos una clave debe estar presente.
     </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>Key</th>
         <th>Tipo de dato</th>
         <th>Descripción</th>
        </tr>

       </thead>

       <tbody class="tbody">
        <tr>
         <td><code class="literal">&quot;compression_alg&quot;</code></td>
         <td>string</td>
         <td>Algoritmo de compresión. Las opciones
          <code class="literal">&quot;compression_alg&quot;</code> y <code class="literal">&quot;compression_level&quot;</code> deben estar ambas definidas
          para activar la compresión de los datos.
	       </td>
        </tr>

        <tr>
         <td><code class="literal">&quot;compression_level&quot;</code></td>
         <td>integer</td>
         <td>El nivel de compresión, de 0 a 9. 0 desactiva la compresión.</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;armor&quot;</code></td>
         <td>boolean</td>
         <td>Activa la salida ASCII armada. Desactivada por omisión.</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;add_signature&quot;</code></td>
         <td>boolean</td>
         <td>El mensaje cifrado será también firmado.</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;hash&quot;</code></td>
         <td>string</td>
         <td>Define el algoritmo de hash utilizado en el cálculo de la firma. La opción &quot;add_signature&quot; debe estar definida a <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong>.</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;creation_time&quot;</code></td>
         <td>integer</td>
         <td>Define la hora de creación de la firma en segundos desde el 1 de enero de 1970 UTC. Por omisión, se utiliza la hora actual.</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;expiration_time&quot;</code></td>
         <td>integer</td>
         <td>Define el tiempo de expiración de la firma en segundos desde la hora de creación. El valor 0 se utiliza para marcar
          la firma como no expirante (valor por omisión).</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;password&quot;</code></td>
         <td>string</td>
         <td>Añade una contraseña utilizada para cifrar los datos.</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;cipher&quot;</code></td>
         <td>string</td>
         <td>
          Define el algoritmo de cifrado simétrico. Los valores posibles son &quot;IDEA&quot;, &quot;TRIPLEDES&quot;,
	      &quot;CAST5&quot;, &quot;BLOWFISH&quot;, &quot;AES128&quot;, &quot;AES192&quot;, &quot;AES256&quot;, &quot;TWOFISH&quot;, &quot;CAMELLIA128&quot;,
          &quot;CAMELLIA192&quot;, &quot;CAMELLIA256&quot;, &quot;SM4&quot;.
	 </td>
        </tr>

        <tr>
         <td><code class="literal">&quot;aead&quot;</code></td>
         <td>string</td>
         <td>
          Define el algoritmo de modo AEAD. Los valores posibles son &quot;None&quot; para desactivar AEAD, &quot;EAX&quot;, &quot;OCB&quot;.
	 </td>
        </tr>

        <tr>
         <td><code class="literal">&quot;aead_bits&quot;</code></td>
         <td>integer</td>
         <td>Define la longitud del chunk para el modo AEAD en número de bits de tamaño de chunk. Debe estar comprendido entre 0 y 56.</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;flags&quot;</code></td>
         <td>integer</td>
         <td>
          Define indicadores de cifrado adicionales. Los indicadores soportados son: RNP_ENCRYPT_NOWRAP - no envolver
          los datos en un paquete de datos literales. Esto permitiría cifrar datos ya firmados.
         </td>
        </tr>

        <tr>
         <td><code class="literal">&quot;file_name&quot;</code></td>
         <td>string</td>
         <td>Define el nombre de fichero almacenado internamente para los datos cifrados. El valor especial _CONSOLE puede ser utilizado para marcar
          el mensaje como &quot;para sus ojos solamente&quot;, es decir, que no debe ser almacenado en ningún lugar sino solo mostrado
          al destinatario. Por omisión, es una cadena vacía.</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;file_mtime&quot;</code></td>
         <td>integer</td>
         <td>Define la fecha de modificación del fichero de entrada en segundos desde el 1 de enero de 1970 UTC.</td>
        </tr>

       </tbody>
      
     </table>

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


 <div class="refsect1 returnvalues" id="refsect1-function.rnp-op-encrypt-returnvalues">
  <h3 class="title">Valores devueltos</h3>
  <p class="simpara">
   Los datos cifrados en caso de éxito o <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> si ocurre un error.
  </p>
 </div>


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