com doc/ja: Actually document openssl_cms_*() functio ns: reference/openssl/functions/openssl-cms-decrypt.xml reference/openssl/functions/openssl-cms-encrypt.xml refe rence/openssl/functions/openssl-cms-read.xml reference/open ssl/functions/openssl-cms-sign.xml reference/openssl/functi ons/openssl-cms-verify.xml
[email protected] (Yoshinari Takaoka) Tue, 05 Jan 2021 06:26:07 +0000
| Newsgroups | php.doc.ja |
|---|---|
| Message-ID | <[email protected]> |
Commit: 296fa970e82b5213643ee697484fbc4c03e336c4 Author: Yoshinari Takaoka <[email protected]> Tue, 5 Jan 2021 15:26:07 +0900 Parents: 01f9f4dd5978fe41c635ebcfefa0e11033a82aed Branches: master Link: http://git.php.net/?p=doc/ja.git;a=commitdiff;h=296fa970e82b5213643ee697484fbc4c03e336c4 Log: Actually document openssl_cms_*() functions Changed paths: A reference/openssl/functions/openssl-cms-decrypt.xml A reference/openssl/functions/openssl-cms-encrypt.xml A reference/openssl/functions/openssl-cms-read.xml A reference/openssl/functions/openssl-cms-sign.xml A reference/openssl/functions/openssl-cms-verify.xml
diff_296fa970e82b5213643ee697484fbc4c03e336c4.txt
(text/plain, 19.7 KB)
diff --git a/reference/openssl/functions/openssl-cms-decrypt.xml b/reference/openssl/functions/openssl-cms-decrypt.xml new file mode 100644 index 0000000000..00f9a54bcc --- /dev/null +++ b/reference/openssl/functions/openssl-cms-decrypt.xml @@ -0,0 +1,103 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision$ --> +<!-- EN-Revision: ad0175ba440b2cb9f22eefc2ca756b885ed79d35 Maintainer: mumumu Status: ready --> + +<refentry xml:id="function.openssl-cms-decrypt" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv> + <refname>openssl_cms_decrypt</refname> + <refpurpose>CMS メッセージを復号化する</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>bool</type><methodname>openssl_cms_decrypt</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 choice="opt"><type class="union"><type>OpenSSLAsymmetricKey</type><type>OpenSSLCertificate</type><type>array</type><type>string</type><type>null</type></type><parameter>private_key</parameter><initializer>&null;</initializer></methodparam> + <methodparam choice="opt"><type>int</type><parameter>encoding</parameter><initializer><constant>OPENSSL_ENCODING_SMIME</constant></initializer></methodparam> + </methodsynopsis> + <para> + CMS メッセージを復号化します。 + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <variablelist> + <varlistentry> + <term><parameter>input_filename</parameter></term> + <listitem> + <para> + 暗号化された内容を含むファイル名。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>output_filename</parameter></term> + <listitem> + <para> + 復号化した内容を書き込むファイル名。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>certificate</parameter></term> + <listitem> + <para> + メッセージの受け手の証明書のファイル名。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>private_key</parameter></term> + <listitem> + <para> + PKCS#8 形式の鍵を含むファイル名。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + <para> + 入力ファイルのエンコーディング。 + <constant>OPENSSL_CMS_SMIME</constant>, + <constant>OPENSLL_CMS_DER</constant>, + <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 +--> diff --git a/reference/openssl/functions/openssl-cms-encrypt.xml b/reference/openssl/functions/openssl-cms-encrypt.xml new file mode 100644 index 0000000000..6d2f538dbe --- /dev/null +++ b/reference/openssl/functions/openssl-cms-encrypt.xml @@ -0,0 +1,122 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision$ --> +<!-- EN-Revision: ad0175ba440b2cb9f22eefc2ca756b885ed79d35 Maintainer: mumumu Status: ready --> + +<refentry xml:id="function.openssl-cms-encrypt" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv> + <refname>openssl_cms_encrypt</refname> + <refpurpose>CMS メッセージを暗号化する</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>bool</type><methodname>openssl_cms_encrypt</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>array</type><type>string</type></type><parameter>certificate</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>int</type><parameter>cipher_algo</parameter><initializer><constant>OPENSSL_CIPHER_RC2_40</constant></initializer></methodparam> + </methodsynopsis> + <para> + この関数は、一人以上のメッセージの受け手に向けて、 + それぞれの受け手の証明書を使ってメッセージを暗号化します。 + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <variablelist> + <varlistentry> + <term><parameter>input_filename</parameter></term> + <listitem> + <para> + 暗号化するファイル。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>output_filename</parameter></term> + <listitem> + <para> + ファイルの出力先。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>certificate</parameter></term> + <listitem> + <para> + 暗号化されたメッセージの受け手の証明書。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>headers</parameter></term> + <listitem> + <para> + S/MIME を使う時に含めるヘッダ。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>flags</parameter></term> + <listitem> + <para> + CMS_sign に渡すフラグ。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + <para> + 出力のエンコーディング。 + <constant>OPENSSL_CMS_SMIME</constant>, + <constant>OPENSLL_CMS_DER</constant>, + <constant>OPENSSL_CMS_PEM</constant> のいずれかです。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>cipher_algo</parameter></term> + <listitem> + <para> + 使用する暗号化アルゴリズム。 + </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 +--> diff --git a/reference/openssl/functions/openssl-cms-read.xml b/reference/openssl/functions/openssl-cms-read.xml new file mode 100644 index 0000000000..ea13af39c6 --- /dev/null +++ b/reference/openssl/functions/openssl-cms-read.xml @@ -0,0 +1,77 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision$ --> +<!-- EN-Revision: ad0175ba440b2cb9f22eefc2ca756b885ed79d35 Maintainer: mumumu Status: ready --> + +<refentry xml:id="function.openssl-cms-read" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv> + <refname>openssl_cms_read</refname> + <refpurpose>CMS ファイルを、PEM証明書の配列にエクスポートする</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>bool</type><methodname>openssl_cms_read</methodname> + <methodparam><type>string</type><parameter>input_filename</parameter></methodparam> + <methodparam><type>array</type><parameter role="reference">certificates</parameter></methodparam> + </methodsynopsis> + <para> + <function>openssl_pkcs7_read</function> と似た処理を行います。 + </para> + + &warn.undocumented.func; + + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <variablelist> + <varlistentry> + <term><parameter>input_filename</parameter></term> + <listitem> + <para> + + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>certificates</parameter></term> + <listitem> + <para> + + </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 +--> diff --git a/reference/openssl/functions/openssl-cms-sign.xml b/reference/openssl/functions/openssl-cms-sign.xml new file mode 100644 index 0000000000..fc2fb67d76 --- /dev/null +++ b/reference/openssl/functions/openssl-cms-sign.xml @@ -0,0 +1,131 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision$ --> +<!-- EN-Revision: ad0175ba440b2cb9f22eefc2ca756b885ed79d35 Maintainer: mumumu Status: ready --> + +<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>ファイルに署名する</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>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> + この関数は、X.509 証明書 と秘密鍵を使ってファイルに署名します。 + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <variablelist> + <varlistentry> + <term><parameter>input_filename</parameter></term> + <listitem> + <para> + 署名するファイル名。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>output_filename</parameter></term> + <listitem> + <para> + 処理結果を出力するファイル名。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>certificate</parameter></term> + <listitem> + <para> + 署名に使う証明書を含むファイル名。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>private_key</parameter></term> + <listitem> + <para> + <parameter>certificate</parameter> + に関連付けられた秘密鍵を含むファイル名。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>headers</parameter></term> + <listitem> + <para> + S/MIME 形式の出力に含められるヘッダの配列。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>flags</parameter></term> + <listitem> + <para> + <function>cms_sign</function> に渡すフラグ。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + <para> + 出力ファイルのエンコーディング。 + <constant>OPENSSL_CMS_SMIME</constant>, + <constant>OPENSLL_CMS_DER</constant>, + <constant>OPENSSL_CMS_PEM</constant> のいずれかです。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>untrusted_certificates_filename</parameter></term> + <listitem> + <para> + 署名に含まれる中間証明書。 + </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 +--> diff --git a/reference/openssl/functions/openssl-cms-verify.xml b/reference/openssl/functions/openssl-cms-verify.xml new file mode 100644 index 0000000000..58e275450c --- /dev/null +++ b/reference/openssl/functions/openssl-cms-verify.xml @@ -0,0 +1,141 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision$ --> +<!-- EN-Revision: ad0175ba440b2cb9f22eefc2ca756b885ed79d35 Maintainer: mumumu Status: ready --> + +<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>CMS の署名を検証する</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> + この関数は、指定されたエンコーディングで CMS の署名を検証します。 + 署名には、Detached (外包)署名または Attached(内包)署名 のふたつがあります。 + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <variablelist> + <varlistentry> + <term><parameter>input_filename</parameter></term> + <listitem> + <para> + 入力ファイル。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>flags</parameter></term> + <listitem> + <para> + <function>cms_verify</function> に渡すフラグ。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>certificates</parameter></term> + <listitem> + <para> + 署名者の証明書のファイル。 + オプションで、中間証明書も含めることができます。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>ca_info</parameter></term> + <listitem> + <para> + 自己署名の認証局の証明書を含む配列。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>untrusted_certificates_filename</parameter></term> + <listitem> + <para> + 追加の中間証明書を含むファイル名。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>content</parameter></term> + <listitem> + <para> + 署名が外包である場合に、その内容を含むファイル。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>pk7</parameter></term> + <listitem> + <para> + + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>sigfile</parameter></term> + <listitem> + <para> + 署名を保存するファイル名。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + <para> + 入力ファイルのエンコーディング。 + <constant>OPENSSL_CMS_SMIME</constant>, + <constant>OPENSLL_CMS_DER</constant>, + <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 +-->