mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-23 04:18:56 +00:00
449a10dc3a
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@159719 c90b9560-bf6c-de11-be94-00142212c4b1
98 lines
3.3 KiB
XML
98 lines
3.3 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.13 $ -->
|
|
<!-- splitted from ./en/functions/openssl.xml, last change in rev 1.4 -->
|
|
<refentry id="function.openssl-pkcs7-sign">
|
|
<refnamediv>
|
|
<refname>openssl_pkcs7_sign</refname>
|
|
<refpurpose>sign an S/MIME message</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<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></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>extracerts</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>openssl_pkcs7_sign</function> takes the contents of the file
|
|
named <parameter>infilename</parameter> and signs them using the
|
|
certificate and its matching private key specified by
|
|
<parameter>signcert</parameter> and <parameter>privkey</parameter>
|
|
parameters.
|
|
</para>
|
|
<para><parameter>headers</parameter> is an array of headers that
|
|
will be prepended to the data after it has been signed (see
|
|
<function>openssl_pkcs7_encrypt</function> for more information about
|
|
the format of this parameter.
|
|
</para>
|
|
<para>
|
|
<parameter>flags</parameter> can be used to alter the output - see <link
|
|
linkend="openssl.pkcs7.flags">PKCS7 constants</link> - if not specified,
|
|
it defaults to PKCS7_DETACHED.
|
|
</para>
|
|
<para>
|
|
<parameter>extracerts</parameter> specifies the name of a file containing
|
|
a bunch of extra certificates to include in the signature which can for
|
|
example be used to help the recipient to verify the certificate that you used.
|
|
</para>
|
|
<para>
|
|
<example>
|
|
<title><function>openssl_pkcs7_sign</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
// the message you want to sign so that recipient can be sure it was you that
|
|
// sent it
|
|
$data = <<<EOD
|
|
|
|
You have my authorization to spend $10,000 on dinner expenses.
|
|
|
|
The CEO
|
|
EOD;
|
|
// save message to file
|
|
$fp = fopen("msg.txt", "w");
|
|
fwrite($fp, $data);
|
|
fclose($fp);
|
|
// encrypt it
|
|
if (openssl_pkcs7_sign("msg.txt", "signed.txt", "mycert.pem",
|
|
array("file://mycert.pem", "mypassphrase"),
|
|
array("To" => "joes@example.com", // keyed syntax
|
|
"From: HQ <ceo@example.com>", // indexed syntax
|
|
"Subject" => "Eyes only")
|
|
)) {
|
|
// message signed - send it!
|
|
exec(ini_get("sendmail_path") . " < signed.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:"../../../../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
|
|
-->
|