openssl-cms-sign.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.openssl-cms-sign" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>openssl_cms_sign</refname>
  <refpurpose>Sign a file</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>openssl_cms_sign</methodname>
   <methodparam><type>string</type><parameter>input_filename</parameter></methodparam>
   <methodparam><type>string</type><parameter>output_filename</parameter></methodparam>
   <methodparam><type class="union"><type>OpenSSLCertificate</type><type>string</type></type><parameter>certificate</parameter></methodparam>
   <methodparam><modifier role="attribute">#[\SensitiveParameter]</modifier><type class="union"><type>OpenSSLAsymmetricKey</type><type>OpenSSLCertificate</type><type>array</type><type>string</type></type><parameter>private_key</parameter></methodparam>
   <methodparam><type class="union"><type>array</type><type>null</type></type><parameter>headers</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>encoding</parameter><initializer><constant>OPENSSL_ENCODING_SMIME</constant></initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>untrusted_certificates_filename</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   This function signs a file with an X.509 certificate and key.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>input_filename</parameter></term>
    <listitem>
     <para>
      The name of the file to be signed.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>output_filename</parameter></term>
    <listitem>
     <para>
      The name of the file to deposit the results.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>certificate</parameter></term>
    <listitem>
     <para>
      The signing certificate.
      See <link linkend="openssl.certparams">Key/Certificate parameters</link> for a list of valid values.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>private_key</parameter></term>
    <listitem>
     <para>
      The key associated with <parameter>certificate</parameter>.
      See <link linkend="openssl.certparams">Key/Certificate parameters</link> for a list of valid values.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>headers</parameter></term>
    <listitem>
     <para>
      An array of headers to be included in S/MIME output.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>flags</parameter></term>
    <listitem>
     <para>
      Flags to be passed to <function>cms_sign</function>.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>encoding</parameter></term>
    <listitem>
     <para>
      The encoding of the output file. One of <constant>OPENSSL_ENCODING_SMIME</constant>,
      <constant>OPENSSL_ENCODING_DER</constant> or <constant>OPENSSL_ENCODING_PEM</constant>.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>untrusted_certificates_filename</parameter></term>
    <listitem>
     <para>
      Intermediate certificates to be included in the signature.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

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

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>openssl_cms_sign</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php

openssl_cms_sign('input.txt', 'output.txt', 'file://cert.pem', 'file://privkey.pem', null, OPENSSL_CMS_BINARY, OPENSSL_ENCODING_DER, 'chain.pem');
?>
]]>
    </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
-->