openssl-pkcs7-sign.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: seros Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.openssl-pkcs7-sign">
 <refnamediv>
  <refname>openssl_pkcs7_sign</refname>
  <refpurpose>Firma un mensaje S/MIME</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>openssl_pkcs7_sign</methodname>
   <methodparam><type>string</type><parameter>infilename</parameter></methodparam>
   <methodparam><type>string</type><parameter>outfilename</parameter></methodparam>
   <methodparam><type>mixed</type><parameter>signcert</parameter></methodparam>
   <methodparam><type>mixed</type><parameter>privkey</parameter></methodparam>
   <methodparam><type>array</type><parameter>headers</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>PKCS7_DETACHED</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>extracerts</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>openssl_pkcs7_sign</function> toma el contenido del archivo
   nombrado por <parameter>infilename</parameter> y lo firma usando el
   certificado y su clave privada coincidente especificados por los
   parámetros <parameter>signcert</parameter> y
   <parameter>privkey</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>infilename</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>outfilename</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>signcert</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>privkey</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>headers</parameter></term>
     <listitem>
      <para>
       <parameter>headers</parameter> es una matriz de cabeceras que
       serán añadidas delante de la información después de que se haya firmado (véase
       <function>openssl_pkcs7_encrypt</function> para más información acerca
       del formato de este parámetro).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       <parameter>flags</parameter> se puede usar para alterar la salida - véase <link
       linkend="openssl.pkcs7.flags">constantes PKCS7</link>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>extracerts</parameter></term>
     <listitem>
      <para>
       <parameter>extracerts</parameter> especifica el nombre de un archivo que contiene
       un grupo de certificados extra, para incluir en la firma, que puede ser usado para,
       por ejemplo, ayudar al destinatario a verificar el certificado que se usó.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ejemplo de <function>openssl_pkcs7_sign</function></title>
    <programlisting role="php">
<![CDATA[
<?php
// el mensaje que quiere firmar, por lo que el destinatario puede estar serguro de fue usted
// el que lo envió
$data = <<<EOD

Tiene mi autorización para emplear $10,000 en gastos de comida.

El Presidente
EOD;
// guardar el mensaje en un archivo
$fp = fopen("mensaje.txt", "w");
fwrite($fp, $data);
fclose($fp);
// encriptarlo
if (openssl_pkcs7_sign("mensaje.txt", "firmado.txt", "micert.pem",
    array("file://micert.pem", "mi_frase_de_contraseña"),
    array("Para" => "joes@example.com", // sintaxis asociativa
          "DE: C.G. <presidente@example.com>", // sintaxis indexada
          "Tema" => "Confidencial")
    )) {
    // mensaje firmado - ¡envíelo!
    exec(ini_get("ruta_correo") . " < firmado.txt");
}
?>
]]>
    </programlisting>
   </example>
  </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
-->