-
Notifications
You must be signed in to change notification settings - Fork 146
/
openssl-pkcs7-sign.xml
203 lines (195 loc) · 6.7 KB
/
openssl-pkcs7-sign.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 5bc68add3da3cd18c40f851e944b15095d3a26aa Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.openssl-pkcs7-sign" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>openssl_pkcs7_sign</refname>
<refpurpose>Signe un message S/MIME</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openssl_pkcs7_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><constant>PKCS7_DETACHED</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>
<function>openssl_pkcs7_sign</function> prend le contenu du fichier
<parameter>input_filename</parameter> et le signe en utilisant le
certificat et la clé privée contenus dans les arguments
<parameter>certificate</parameter> et <parameter>private_key</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>input_filename</parameter></term>
<listitem>
<para>
Le fichier d'entrée que vous avez l'intention de signer numériquement.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>output_filename</parameter></term>
<listitem>
<para>
Le fichier où la signature numérique sera écrite.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>certificate</parameter></term>
<listitem>
<para>
Le certificat X.509 utilisé pour signer numériquement <parameter>input_filename</parameter>.
Voir <link linkend="openssl.certparams">paramètres Clé/Certificat</link>
pour une liste de valeur valide.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>private_key</parameter></term>
<listitem>
<para>
<parameter>private_key</parameter> est la clé privée correspondant à <parameter>certificate</parameter>.
Voir <link linkend="openssl.certparams">paramètres Clé Publique/Privée</link>
pour une liste de valeur valide.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>headers</parameter></term>
<listitem>
<para>
<parameter>headers</parameter> est un tableau d'en-têtes qui
seront ajoutés aux données chiffrées (voir la fonction
<function>openssl_pkcs7_encrypt</function> pour plus de détails sur
le format du paramètre).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
<parameter>flags</parameter> peut être utilisé pour modifier la sortie.
Voir les <link linkend="openssl.pkcs7.flags">constantes PKCS7</link>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>untrusted_certificates_filename</parameter></term>
<listitem>
<para>
<parameter>untrusted_certificates_filename</parameter> spécifie le nom du fichier contenant
un ensemble de certificats supplémentaires à inclure dans la
signature, qui pourront aider le destinataire à vérifier les
données que vous utilisez.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>certificate</parameter> accepte désormais une instance de
<classname>OpenSSLCertificate</classname> ;
auparavant, une &resource; de type <literal>OpenSSL X.509 CSR</literal> était acceptée.
</entry>
</row>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>private_key</parameter> accepte désormais une instance de
<classname>OpenSSLAsymmetricKey</classname> ou <classname>OpenSSLCertificate</classname> ;
auparavant, une &resource; de type <literal>OpenSSL key</literal> ou <literal>OpenSSL X.509</literal>
était acceptée.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemple avec <function>openssl_pkcs7_sign</function></title>
<programlisting role="php">
<![CDATA[
<?php
// le message que vous voulez signer, afin que le destinataire soit sûr qu'il
// vient bien de vous
$data = <<<EOD
Vous êtes autorisé à dépenser 10 000€ en note de frais.
Le PDG
EOD;
// sauvez le message dans un fichier
$fp = fopen("msg.txt", "w");
fwrite($fp, $data);
fclose($fp);
// encrypt it
if (openssl_pkcs7_sign("msg.txt", "signed.txt", "file://mycert.pem",
array("file://mycert.pem", "mypassphrase"),
array("To" => "joes@example.com", // syntaxe à clé
"From: HQ <ceo@example.com>", // syntaxe indexée
"Subject" => "Eyes only")
)) {
// message signée - envoyez-le !
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:"~/.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
-->