[prev in list] [next in list] [prev in thread] [next in thread]
List: php-doc-cvs
Subject: [DOC-CVS] [doc-en] master: Fix openssl cms constants
From: Alexis MARQUIS via GitHub <noreply () php ! net>
Date: 2022-01-14 14:47:04
Message-ID: SJCvx8qH65yMSVfdVLihWzDQKFeBmdeoqDmgo5mPs () main ! php ! net
[Download RAW message or body]
Author: Alexis MARQUIS (alexismarquis)
Committer: GitHub (web-flow)
Pusher: cmb69
Date: 2022-01-14T15:46:56+01:00
Commit: https://github.com/php/doc-en/commit/96263b14054f0f102fcc653688ff3ed99f9df858
Raw diff: https://github.com/php/doc-en/commit/96263b14054f0f102fcc653688ff3ed99f9df858.diff
Fix openssl cms constants
Co-authored-by: Alexis MARQUIS <amarquis@opendev.fr>
Closes GH-1334.
Changed paths:
M reference/openssl/functions/openssl-cms-decrypt.xml
M reference/openssl/functions/openssl-cms-encrypt.xml
M reference/openssl/functions/openssl-cms-sign.xml
M reference/openssl/functions/openssl-cms-verify.xml
Diff:
diff --git a/reference/openssl/functions/openssl-cms-decrypt.xml \
b/reference/openssl/functions/openssl-cms-decrypt.xml index 1552a8a6ec..f901b1410d \
100644
--- a/reference/openssl/functions/openssl-cms-decrypt.xml
+++ b/reference/openssl/functions/openssl-cms-decrypt.xml
@@ -61,8 +61,8 @@
<term><parameter>encoding</parameter></term>
<listitem>
<para>
- The encoding of the input file. One of <constant>OPENSSL_CMS_SMIME</constant>,
- <constant>OPENSLL_CMS_DER</constant> or <constant>OPENSSL_CMS_PEM</constant>.
+ 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>
diff --git a/reference/openssl/functions/openssl-cms-encrypt.xml \
b/reference/openssl/functions/openssl-cms-encrypt.xml index 8cde077236..fc347594cf \
100644
--- a/reference/openssl/functions/openssl-cms-encrypt.xml
+++ b/reference/openssl/functions/openssl-cms-encrypt.xml
@@ -71,8 +71,8 @@
<term><parameter>encoding</parameter></term>
<listitem>
<para>
- An encoding to output. One of <constant>OPENSSL_CMS_SMIME</constant>,
- <constant>OPENSLL_CMS_DER</constant> or <constant>OPENSSL_CMS_PEM</constant>.
+ An encoding to output. One of <constant>OPENSSL_ENCODING_SMIME</constant>,
+ <constant>OPENSSL_ENCODING_DER</constant> or \
<constant>OPENSSL_ENCODING_PEM</constant>. </para>
</listitem>
</varlistentry>
diff --git a/reference/openssl/functions/openssl-cms-sign.xml \
b/reference/openssl/functions/openssl-cms-sign.xml index 2e2efd673f..0a087850b4 \
100644
--- a/reference/openssl/functions/openssl-cms-sign.xml
+++ b/reference/openssl/functions/openssl-cms-sign.xml
@@ -1,145 +1,145 @@
-<?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><type \
class="union"><type>OpenSSLAsymmetricKey</type><type>OpenSSLCertificate</type><type>ar \
ray</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_CMS_SMIME</constant>,
- <constant>OPENSLL_CMS_DER</constant> or <constant>OPENSSL_CMS_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
--->
+<?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><type \
class="union"><type>OpenSSLAsymmetricKey</type><type>OpenSSLCertificate</type><type>ar \
ray</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
+-->
diff --git a/reference/openssl/functions/openssl-cms-verify.xml \
b/reference/openssl/functions/openssl-cms-verify.xml index 75271cd7e5..c547ff03a1 \
100644
--- a/reference/openssl/functions/openssl-cms-verify.xml
+++ b/reference/openssl/functions/openssl-cms-verify.xml
@@ -1,136 +1,136 @@
-<?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_CMS_SMIME</constant>,
- <constant>OPENSLL_CMS_DER</constant> or <constant>OPENSSL_CMS_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
--->
+<?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
+-->
--
PHP Documentation Commits Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic