openssl-cms-verify.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="function.openssl-cms-verify" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>openssl_cms_verify</refname>
  <refpurpose>Verify a CMS signature</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>openssl_cms_verify</methodname>
   <methodparam><type>string</type><parameter>input_filename</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>certificates</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>ca_info</parameter><initializer>[]</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>untrusted_certificates_filename</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>content</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>pk7</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>sigfile</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>encoding</parameter><initializer><constant>OPENSSL_ENCODING_SMIME</constant></initializer></methodparam>
  </methodsynopsis>
  <para>
   This function verifies a CMS signature, either attached or detached, with the specified encoding.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>input_filename</parameter></term>
    <listitem>
     <para>
      The input file.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>flags</parameter></term>
    <listitem>
     <para>
      Flags to pass to <function>cms_verify</function>.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>certificates</parameter></term>
    <listitem>
     <para>
      A file with the signer certificate and optionally intermediate certificates.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>ca_info</parameter></term>
    <listitem>
     <para>
      An array containing self-signed certificate authority certificates.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>untrusted_certificates_filename</parameter></term>
    <listitem>
     <para>
      A file containing additional intermediate certificates.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>content</parameter></term>
    <listitem>
     <para>
      A file pointing to the content when signatures are detached.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>pk7</parameter></term>
    <listitem>
     <para>

     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>sigfile</parameter></term>
    <listitem>
     <para>
      A file to save the signature to.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>encoding</parameter></term>
    <listitem>
     <para>
      The encoding of the input file. One of <constant>OPENSSL_ENCODING_SMIME</constant>,
      <constant>OPENSSL_ENCODING_DER</constant> or <constant>OPENSSL_ENCODING_PEM</constant>.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </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
-->