From a331c6e476bbb1c81a91c6e461f8d884be2dd845 Mon Sep 17 00:00:00 2001 From: Andrew Hutchings Date: Tue, 17 Nov 2026 16:39:54 +0100 Subject: [PATCH 1/2] wolfSSL manual: fix errors found while syncing the Japanese manual - chapter02: give the full WOLFSSL_CRYPT_HW_MUTEX lock/unlock function names. - chapter02: --enable-aeskeywrap: only the RFC 5649 padding variant is new in 5.9.4, not the whole option. - chapter02: the wolfssl-examples CSR and PKCS7 examples are in the certgen and pkcs7 directories, not cmake. - chapter02, 04, 11: wolfSSL_CTX_set_ephemeral_key() and the DTLS 1.2 method functions are documented on the CertsKeys and Setup group pages. The ssl.h page has no anchor for them in the HTML build. - chapter03: add the missing separator after `break` in the echoserver command list. - chapter04: the SSL/TLS/DTLS comparison is in Appendix D, not Appendix A, and the cipher suites are lists, not a table. - chapter07: "i.e." -> "e.g." for the trust peer certificate type, and name wc_DerToPem() correctly. - chapter11: fix "so that the when". --- wolfSSL/src/chapter02.md | 8 ++++---- wolfSSL/src/chapter03.md | 2 +- wolfSSL/src/chapter04.md | 8 ++++---- wolfSSL/src/chapter07.md | 4 ++-- wolfSSL/src/chapter11.md | 4 ++-- 5 files changed, 13 insertions(+), 13 deletions(-) diff --git a/wolfSSL/src/chapter02.md b/wolfSSL/src/chapter02.md index 4e6dcf8b..68084028 100644 --- a/wolfSSL/src/chapter02.md +++ b/wolfSSL/src/chapter02.md @@ -2216,7 +2216,7 @@ Enables the ability to override maximum signature algorithms. #### WOLFSSL_STATIC_EPHEMERAL -Lets a fixed ("static") ephemeral (EC)DH key be loaded with [`wolfSSL_CTX_set_ephemeral_key()`](ssl_8h.md#function-wolfssl_ctx_set_ephemeral_key) or `wolfSSL_set_ephemeral_key()`, so the sniffer can decrypt traffic that uses ephemeral key exchange. Reusing one ephemeral key across connections gives up forward secrecy; use it only for testing, inspection or debugging. Set automatically by `--enable-sniffer`. +Lets a fixed ("static") ephemeral (EC)DH key be loaded with [`wolfSSL_CTX_set_ephemeral_key()`](group__CertsKeys.md#function-wolfssl_ctx_set_ephemeral_key) or `wolfSSL_set_ephemeral_key()`, so the sniffer can decrypt traffic that uses ephemeral key exchange. Reusing one ephemeral key across connections gives up forward secrecy; use it only for testing, inspection or debugging. Set automatically by `--enable-sniffer`. #### SSL_SNIFFER_EXPORTS @@ -3260,7 +3260,7 @@ Enable per-algorithm hardware mutex locks for AES, hash, public-key, and RNG ope #### WOLFSSL_CRYPT_HW_MUTEX -Master control for hardware crypto mutex initialization. When enabled, provides `wolfSSL_CryptHwMutexInit`, `Lock`, and `UnLock` functions. +Master control for hardware crypto mutex initialization. When enabled, provides `wolfSSL_CryptHwMutexInit`, `wolfSSL_CryptHwMutexLock`, and `wolfSSL_CryptHwMutexUnLock` functions. #### USE_WOLFSSL_MEMORY @@ -5488,7 +5488,7 @@ Enable export and import of sessions ### `--enable-aeskeywrap` -Enable AES key wrap support (RFC 3394). To also build AES Key Wrap with Padding (RFC 5649), pass `--enable-aeskeywrap=padding`; it is provided by `wc_AesKeyWrap_Pad()` and `wc_AesKeyWrap_Pad_ex()` and supports crypto callbacks. New in wolfSSL 5.9.4. +Enable AES key wrap support (RFC 3394). To also build AES Key Wrap with Padding (RFC 5649), pass `--enable-aeskeywrap=padding`; it is provided by `wc_AesKeyWrap_Pad()` and `wc_AesKeyWrap_Pad_ex()` and supports crypto callbacks. The padding variant is new in wolfSSL 5.9.4. ### `--enable-jobserver` @@ -7049,7 +7049,7 @@ Example IDE Setup for use with IMXRT1170 can be found in the directory IDE/MCUEX - (note board files need to be recreated .... this can be done by creating a new project that has the same settings and copying over the generated board/* files) - Build the projects -CSR and PKCS7 examples, and an example of building with CMake, are in the cmake directory of the wolfssl-examples repository (). +CSR examples are in the certgen directory, PKCS7 examples in the pkcs7 directory, and an example of building with CMake in the cmake directory of the wolfssl-examples repository (). #### Expanding RT1170 CAAM Driver diff --git a/wolfSSL/src/chapter03.md b/wolfSSL/src/chapter03.md index c17c55b9..d1c5eef7 100644 --- a/wolfSSL/src/chapter03.md +++ b/wolfSSL/src/chapter03.md @@ -333,7 +333,7 @@ https://github.com/wolfSSL/wolfssl-examples/tree/master/tls The echoserver example sits in an endless loop waiting for an unlimited number of client connections. Whatever the client sends the echoserver echoes back. Client authentication isn't performed so the example client can be used against the echoserver in all 3 modes. Four special commands aren't echoed back and instruct the echoserver to take a different action. 1. `quit` - If the echoserver receives the string "quit" it will shutdown. -2. `break` If the echoserver receives the string "break" it will stop the current session but continue handling requests. This is particularly useful for DTLS testing. +2. `break` - If the echoserver receives the string "break" it will stop the current session but continue handling requests. This is particularly useful for DTLS testing. 3. `printstats` - If the echoserver receives the string "printstats" it will print out statistics for the session cache. This command is only available when wolfSSL is built with `PRINT_SESSION_STATS`. 4. `GET` - If the echoserver receives the string "GET" it will handle it as an http get and send back a simple page with the message "greetings from wolfSSL". This allows testing of various TLS/SSL clients like Safari, IE, Firefox, gnutls, and the like against the echoserver example. diff --git a/wolfSSL/src/chapter04.md b/wolfSSL/src/chapter04.md index c96c0812..6505676f 100644 --- a/wolfSSL/src/chapter04.md +++ b/wolfSSL/src/chapter04.md @@ -23,7 +23,7 @@ wolfSSL supports **SSL 3.0**, **TLS** (**1.0**, **1.1**, **1.2, 1.3**), and **DT ### Server Functions * [`wolfDTLSv1_server_method()`](group__Setup.md#function-wolfdtlsv1_server_method) - DTLS 1.0 -* [`wolfDTLSv1_2_server_method()`](ssl_8h.md#function-wolfdtlsv1_2_server_method) - DTLS 1.2 +* [`wolfDTLSv1_2_server_method()`](group__Setup.md#function-wolfdtlsv1_2_server_method) - DTLS 1.2 * [`wolfDTLSv1_3_server_method()`](group__Setup.md#function-wolfdtlsv1_3_server_method) - DTLS 1.3 * [`wolfDTLS_server_method()`](group__Setup.md#function-wolfdtls_server_method) - Use highest possible DTLS version enabled in the build * [`wolfSSLv3_server_method()`](group__Setup.md#function-wolfsslv3_server_method) - SSL 3.0 @@ -52,11 +52,11 @@ wolfSSL supports robust server downgrade with the [`wolfSSLv23_server_method()`] * [`wolfSSLv23_client_method()`](group__Setup.md#function-wolfsslv23_client_method) - Use the highest possible version, up to TLS 1.3 (downgrading to the lowest version enabled in the build) * `wolfTLS_client_method()` - Same as `wolfSSLv23_client_method()` -Each method also has an `_ex` variant, for example [`wolfDTLSv1_2_client_method_ex()`](ssl_8h.md#function-wolfdtlsv1_2_client_method_ex), that takes a heap hint. The same build conditions apply as for the server functions. +Each method also has an `_ex` variant, for example [`wolfDTLSv1_2_client_method_ex()`](group__Setup.md#function-wolfdtlsv1_2_client_method_ex), that takes a heap hint. The same build conditions apply as for the server functions. wolfSSL supports robust client downgrade with the [`wolfSSLv23_client_method()`](group__Setup.md#function-wolfsslv23_client_method) function. See [Robust Client and Server Downgrade](#robust-client-and-server-downgrade) for details. -For details on how to use these functions, please see the [Getting Started](chapter03.md#getting-started) chapter. For a comparison between SSL, TLS, and DTLS, please see Appendix A. +For details on how to use these functions, please see the [Getting Started](chapter03.md#getting-started) chapter. For a comparison between SSL, TLS, and DTLS, please see Appendix D, [SSL/TLS Overview](appendix04.md). ### Robust Client and Server Downgrade @@ -435,7 +435,7 @@ wolfSSL has support for Elliptic Curve Cryptography (ECC) including but not limi wolfSSL's ECC implementation can be found in the `/wolfssl/wolfcrypt/ecc.h` header file and the `/wolfcrypt/src/ecc.c` source file. -Supported cipher suites are shown in the table above. ECC is enabled by default on all platforms. It can be disabled with [`--disable-ecc`](chapter02.md#--disable-ecc), and is enabled in builds that do not use autoconf with the `HAVE_ECC` define. When using the autoconf system: +Supported cipher suites are listed in the Supported Cipher Suites section above. ECC is enabled by default on all platforms. It can be disabled with [`--disable-ecc`](chapter02.md#--disable-ecc), and is enabled in builds that do not use autoconf with the `HAVE_ECC` define. When using the autoconf system: ```sh ./configure --enable-ecc diff --git a/wolfSSL/src/chapter07.md b/wolfSSL/src/chapter07.md index 0ac4e934..508ce0a2 100644 --- a/wolfSSL/src/chapter07.md +++ b/wolfSSL/src/chapter07.md @@ -222,7 +222,7 @@ int wolfSSL_CTX_trust_peer_cert(WOLFSSL_CTX *ctx, const char *trustCert, int type); ``` -`trustCert` is the certificate file to load, and `type` is the format of the certificate (i.e. `WOLFSSL_FILETYPE_PEM`). Trusted peer certificates require wolfSSL to be built with [`WOLFSSL_TRUST_PEER_CERT`](chapter02.md#wolfssl_trust_peer_cert) defined. There is no dedicated configure option for it, so add it through `CFLAGS` (for example `./configure CFLAGS="-DWOLFSSL_TRUST_PEER_CERT"`). +`trustCert` is the certificate file to load, and `type` is the format of the certificate (e.g. `WOLFSSL_FILETYPE_PEM`). Trusted peer certificates require wolfSSL to be built with [`WOLFSSL_TRUST_PEER_CERT`](chapter02.md#wolfssl_trust_peer_cert) defined. There is no dedicated configure option for it, so add it through `CFLAGS` (for example `./configure CFLAGS="-DWOLFSSL_TRUST_PEER_CERT"`). ### Loading System CA Certificates @@ -336,7 +336,7 @@ if (pemSz < 0) /* pemSz contains error */; ``` -The last argument of _DerToPem()_ takes a type parameter, usually either `PRIVATEKEY_TYPE` or `CERT_TYPE`. Now the buffer `pem` holds the PEM format of the key. Supported types are listed below. Some are only available when the matching feature is compiled in (for example `CERTREQ_TYPE` needs `WOLFSSL_CERT_REQ` and `ED448_TYPE` needs `HAVE_ED448`): +The last argument of `wc_DerToPem()` takes a type parameter, usually either `PRIVATEKEY_TYPE` or `CERT_TYPE`. Now the buffer `pem` holds the PEM format of the key. Supported types are listed below. Some are only available when the matching feature is compiled in (for example `CERTREQ_TYPE` needs `WOLFSSL_CERT_REQ` and `ED448_TYPE` needs `HAVE_ED448`): * `CA_TYPE` * `TRUSTED_PEER_TYPE` diff --git a/wolfSSL/src/chapter11.md b/wolfSSL/src/chapter11.md index 79720a18..cc01bc88 100644 --- a/wolfSSL/src/chapter11.md +++ b/wolfSSL/src/chapter11.md @@ -270,11 +270,11 @@ EchoServer: * [`wolfSSLv23_server_method();`](group__Setup.md#function-wolfsslv23_server_method) - Accept the highest version both sides support (TLS 1.3 or TLS 1.2 in a default build) * `wolfTLS_server_method();` - Same as `wolfSSLv23_server_method()` * [`wolfDTLSv1_server_method();`](group__Setup.md#function-wolfdtlsv1_server_method) - DTLS 1.0 (`--enable-oldtls`) -* [`wolfDTLSv1_2_server_method();`](ssl_8h.md#function-wolfdtlsv1_2_server_method) - DTLS 1.2 +* [`wolfDTLSv1_2_server_method();`](group__Setup.md#function-wolfdtlsv1_2_server_method) - DTLS 1.2 * [`wolfDTLSv1_3_server_method();`](group__Setup.md#function-wolfdtlsv1_3_server_method) - DTLS 1.3 * [`wolfDTLS_server_method();`](group__Setup.md#function-wolfdtls_server_method) - Accept the highest DTLS version both sides support -We need to load our CA (Certificate Authority) certificate into the `WOLFSSL_CTX` so that the when the echoclient connects to the echoserver, it is able to verify the server's identity. To load the CA certificates into the `WOLFSSL_CTX`, use [`wolfSSL_CTX_load_verify_locations()`](group__CertsKeys.md#function-wolfssl_ctx_load_verify_locations). This function requires three arguments: a `WOLFSSL_CTX` pointer, a certificate file, and a path value. The path value points to a directory which should contain CA certificates in PEM format. When looking up certificates, wolfSSL will look at the certificate file value before looking in the path location. In this case, we don't need to specify a certificate path because we will specify one CA file - as such we use NULL for the path argument. The [`wolfSSL_CTX_load_verify_locations`](group__CertsKeys.md#function-wolfssl_ctx_load_verify_locations) function returns `WOLFSSL_SUCCESS` on success, or a negative error code on failure (0 when wolfSSL is built with `WOLFSSL_ERROR_CODE_OPENSSL`): +We need to load our CA (Certificate Authority) certificate into the `WOLFSSL_CTX` so that when the echoclient connects to the echoserver, it is able to verify the server's identity. To load the CA certificates into the `WOLFSSL_CTX`, use [`wolfSSL_CTX_load_verify_locations()`](group__CertsKeys.md#function-wolfssl_ctx_load_verify_locations). This function requires three arguments: a `WOLFSSL_CTX` pointer, a certificate file, and a path value. The path value points to a directory which should contain CA certificates in PEM format. When looking up certificates, wolfSSL will look at the certificate file value before looking in the path location. In this case, we don't need to specify a certificate path because we will specify one CA file - as such we use NULL for the path argument. The [`wolfSSL_CTX_load_verify_locations`](group__CertsKeys.md#function-wolfssl_ctx_load_verify_locations) function returns `WOLFSSL_SUCCESS` on success, or a negative error code on failure (0 when wolfSSL is built with `WOLFSSL_ERROR_CODE_OPENSSL`): ```c wolfSSL_CTX_load_verify_locations(WOLFSSL_CTX* ctx, const char* file, const char* path) From 061ef7a3b3908ae96a05f03b9326ea47c1dcf6e6 Mon Sep 17 00:00:00 2001 From: Andrew Hutchings Date: Tue, 17 Nov 2026 16:39:54 +0100 Subject: [PATCH 2/2] wolfSSL manual (JA): sync the Japanese translation with the English The English manual was revised heavily for wolfSSL 5.9.4, and the Japanese translation had fallen behind, in places by several releases. Bring every Japanese chapter and appendix back in line with the current English: the same headings, code blocks, tables and lists, in the same order. - Keep the existing Japanese wording where it still matches the English, translate new and changed text, and drop text the English removed. - Macro and configure option headings stay in English so their anchors work in both languages. Links to sections with Japanese headings use the existing file link plus section name form. - Links to API functions that the Japanese API reference does not cover yet are plain inline code. - Code blocks match the English. Blocks whose comments were translated before keep Japanese comments on the current code. - Keep Japan-specific content: info@wolfssl.jp, wolfssl.jp pages, the Japanese RFC translation links and the Japanese porting guide link. - Fix mistranslations, broken anchors, full-width ASCII symbols and wolfSSL/wolfssl path casing in the existing text. --- wolfSSL/src-ja/appendix04.md | 74 +- wolfSSL/src-ja/appendix05.md | 81 +- wolfSSL/src-ja/appendix06.md | 267 +- wolfSSL/src-ja/appendix07.md | 487 ++- wolfSSL/src-ja/appendix08.md | 187 +- wolfSSL/src-ja/appendix09.md | 1677 ++++---- wolfSSL/src-ja/appendix10.md | 299 +- wolfSSL/src-ja/appendix11.md | 20 +- wolfSSL/src-ja/chapter01.md | 8 +- wolfSSL/src-ja/chapter02.md | 7365 ++++++++++++++++++++++++++-------- wolfSSL/src-ja/chapter03.md | 426 +- wolfSSL/src-ja/chapter04.md | 1020 +++-- wolfSSL/src-ja/chapter05.md | 126 +- wolfSSL/src-ja/chapter06.md | 301 +- wolfSSL/src-ja/chapter07.md | 445 +- wolfSSL/src-ja/chapter08.md | 64 +- wolfSSL/src-ja/chapter09.md | 48 +- wolfSSL/src-ja/chapter10.md | 737 +++- wolfSSL/src-ja/chapter11.md | 187 +- wolfSSL/src-ja/chapter12.md | 20 +- wolfSSL/src-ja/chapter13.md | 86 +- wolfSSL/src-ja/chapter14.md | 11 +- wolfSSL/src-ja/chapter15.md | 39 +- wolfSSL/src-ja/chapter16.md | 12 +- 24 files changed, 9944 insertions(+), 4043 deletions(-) diff --git a/wolfSSL/src-ja/appendix04.md b/wolfSSL/src-ja/appendix04.md index 8a1f7698..c43e7bff 100644 --- a/wolfSSL/src-ja/appendix04.md +++ b/wolfSSL/src-ja/appendix04.md @@ -2,14 +2,19 @@ ## アーキテクチャ -組み込み向けSSL/TLSライブラリであるwolfSSL(旧称:Cyassl)は、SSL 3.0、TLS 1.0、TLS 1.1、TLS 1.2、TLS 1.3プロトコルを実装しています。 +組み込み向けSSL/TLSライブラリであるwolfSSL(旧称:CyaSSL)は、SSL 3.0、TLS 1.0、TLS 1.1、TLS 1.2、TLS 1.3プロトコルに加えて、DTLS 1.0、DTLS 1.2、DTLS 1.3を実装しています。 TLS 1.3は、標準化されている最も安全な最新バージョンです。 -SSL 2.0は数年間不安定であることから、サポートしていません。 - -wolfSSLのTLSプロトコルは、[RFC 5246](https://tex2e.github.io/rfc-translater/html/rfc5246) で定義されている通りに実装されています。 -TLSには、メッセージ層とハンドシェーク層の2つのレコード層プロトコルが存在します。 +SSL 3.0(RFC 7568)、TLS 1.0およびTLS 1.1(RFC 8996)は非推奨となっているため、wolfSSLはデフォルトではこれらをビルドに含めません。 +これらは`--enable-sslv3`、`--enable-tlsv10`、`--enable-oldtls`で明示的に有効にした場合にのみコンパイルされます。 +SSL 2.0は長年にわたり安全でないとされていることから、サポートしていません。 + +wolfSSLは、TLS 1.2を[RFC 5246](https://tex2e.github.io/rfc-translater/html/rfc5246)、TLS 1.3を[RFC 8446](https://tex2e.github.io/rfc-translater/html/rfc8446)で定義されている通りに実装しています。 +DTLS 1.2は[RFC 6347](https://tools.ietf.org/html/rfc6347)に、DTLS 1.3は[RFC 9147](https://tools.ietf.org/html/rfc9147)に準拠しています。 +TLSは階層化されたプロトコルです。 +下位層はレコードプロトコルで、上位層のプロトコルのデータを断片化し、保護(暗号化と認証)して送信します。 +上位層のプロトコルには、ハンドシェイクプロトコル、アラートプロトコル、ChangeCipherSpecプロトコル(TLS 1.2以前のみ)、およびアプリケーションデータがあります。 ハンドシェイクメッセージは、共通の暗号スイートのネゴシエーション、シークレットの作成、および安全な接続の有効化に使用されます。 -メッセージレイヤーはハンドシェイクレイヤーをカプセル化すると同時に、アラート処理とアプリケーションデータ転送もサポートします。 +アラートメッセージは、エラーや接続の終了を通知します。 SSLプロトコルが既存のプロトコルにどのように適合するかを、**図1**に示します。 SSLは、OSIモデルのトランスポート層とアプリケーション層の間に位置し、多くのプロトコル (TCP/IP、Bluetoothなど) がトランスポートメディアとして機能します。 @@ -24,13 +29,46 @@ SSLハンドシェイクプロセスの簡略を以下の**図2**に示します ![ハンドシェイク](sslhandshake.png) +**図2**は、TLS 1.2以前のバージョンにおけるフルハンドシェイクを示しています。 +実際のメッセージ順序では、証明書を要求されたクライアントは、ClientKeyExchangeメッセージの前にCertificateメッセージを送信し、ClientKeyExchangeメッセージの後にCertificateVerifyメッセージを送信します。 + +### TLS 1.3ハンドシェイク + +TLS 1.3では、これとは異なる、より短いハンドシェイクを使用します。 +鍵交換はHelloメッセージ(`key_share`拡張)の中で行われるため、フルハンドシェイクでは、クライアントがアプリケーションデータを送信できるようになるまでに1往復(1ラウンドトリップ)しか必要としません。 +ServerKeyExchange、ServerHelloDone、ClientKeyExchangeメッセージは存在せず、ChangeCipherSpecはミドルボックス互換モードでダミーメッセージとして送信されるのみです。 +また、サーバーがServerHelloの後に送信するメッセージはすべて暗号化されます。 + +```text +Client Server + +ClientHello (key_share, supported_versions) + --------> + ServerHello (key_share) + {EncryptedExtensions} + {CertificateRequest} * + {Certificate} + {CertificateVerify} + {Finished} + <-------- +{Certificate} * +{CertificateVerify} * +{Finished} + --------> +[Application Data] <-------> [Application Data] + +* sent only when the server requests client authentication +{} encrypted with the handshake traffic keys +[] encrypted with the application traffic keys +``` + ## SSL/TLSにおける、バージョンごとの違い -SSL (Secure Sockets Layer) と TLS (Transport Security Layer) はどちらも、ネットワーク上で安全な通信を提供する暗号化プロトコルです。 +SSL (Secure Sockets Layer) と TLS (Transport Layer Security) はどちらも、ネットワーク上で安全な通信を提供する暗号化プロトコルです。 これら2つのプロトコルは、今日、WebブラウジングからEメール、インスタントメッセージング、VoIPに至るまで、さまざまなアプリケーションで広く使用されています。 SSLとTLS、そしてそれぞれに含まれる各バージョン間にはいくつかの違いがあります。 -以下に、SSL および TLS プロトコルの各バージョンについての解説と主な相違点を示します。 +以下に、SSL および TLS プロトコルの各バージョンについての解説と主な相違点を示します。 各プロトコルの具体的な詳細については、記載されているRFC仕様を参照してください。 ### SSL 3.0 @@ -79,10 +117,10 @@ TLS 1.1 をベースとして、いくつかの改善が行われました。 * クライアントとサーバーが受け入れるハッシュおよび署名アルゴリズムの組み合わせが整理されました。 * 追加のデータモードを使用した、認証された暗号化のためのサポートが追加されました。 * TLS拡張機能の定義とAES暗号スイートがマージされました。 -* EncryptedPremasterSecretバージョン番号が厳しくチェックされるようになりました。 +* EncryptedPreMasterSecretバージョン番号が厳しくチェックされるようになりました。 * 多くの要件が厳しくなりました。 -* `Verify_data`の長さは暗号スイートに依存します -* Bleichenbacher/Dlima 攻撃防御の説明が簡潔になりました。 +* `Verify_data`の長さは暗号スイートに依存します。 +* Bleichenbacher/Klima 攻撃防御の説明が簡潔になりました。 ### TLS 1.3 @@ -90,12 +128,22 @@ TLS 1.1 をベースとして、いくつかの改善が行われました。 主に、セキュリティ性能とスピードが向上しています。 主な違いは次のとおりです。 -* サポートされている対称アルゴリズムのリストは、すべての従来のアルゴリズムから整理されました。残りのアルゴリズムはすべて、認証タグ付き暗号(AEAD) アルゴリズムを使用します。 +* サポートされている対称アルゴリズムのリストから、従来のアルゴリズムがすべて削除されました。残りのアルゴリズムはすべて、認証タグ付き暗号(AEAD) アルゴリズムを使用します。 * ゼロRTT (0-RTT) モードが追加され、一部のセキュリティ属性を犠牲にすることで、一部のアプリケーションデータのための接続時のラウンドトリップが削減されました。 * `ServerHello`の後のすべてのハンドシェイクメッセージが暗号化されるようになりました。 * HMACベースの抽出および拡張鍵導出機能(HKDF)がプリミティブとして使用されているため、鍵導出機能が再設計されました。 * ハンドシェイクステートマシンが再構築され、一貫性が向上し、余分なメッセージが削除されました。 * ECCは基本仕様になり、新しい署名アルゴリズムが含まれるようになりました。各曲線の単一のポイント形式を支持して、ポイント形式のネゴシエーションを削除しました。 -* 圧縮、カスタムDHEグループ、およびDSAが削除されました、RSAパディングはPSSを使用するようになりました。 +* 圧縮、カスタムDHEグループ、およびDSAが削除されました。RSA署名はPSSパディングを使用するようになりました。 +* 静的RSAおよび静的Diffie-Hellmanの暗号スイートが削除され、公開鍵ベースの鍵交換メカニズムはすべて前方秘匿性を提供するようになりました。 * TLS 1.2 バージョンネゴシエーション検証メカニズムは廃止され、拡張機能のバージョンリストが採用されました。 * サーバー側の状態の有無にかかわらず、セッションの再開と、TLSの以前のバージョンのPSKベースの暗号スイートは、単一の新しいPSK交換に置き換えられました。 + +### DTLS + +DTLS(Datagram Transport Layer Security)は、TLSをUDPなどのデータグラムトランスポートに適応させたプロトコルです。 +DTLSでは、明示的なレコードシーケンス番号とエポック、失われたハンドシェイクメッセージの再送信、およびサーバーをサービス拒否攻撃から保護するクッキー交換が追加されています。 +DTLS 1.0(RFC 4347)はTLS 1.1を、DTLS 1.2(RFC 6347)はTLS 1.2を、DTLS 1.3(RFC 9147)はTLS 1.3をベースにしており、DTLS 1.1は存在しません。 +wolfSSLでは、DTLSはデフォルトで無効です。 +DTLS 1.2には`--enable-dtls`を、DTLS 1.3には`--enable-dtls13`を使用してください。 +DTLS 1.0には`--enable-oldtls`も必要です。 diff --git a/wolfSSL/src-ja/appendix05.md b/wolfSSL/src-ja/appendix05.md index 15a23a94..c94ca5ab 100644 --- a/wolfSSL/src-ja/appendix05.md +++ b/wolfSSL/src-ja/appendix05.md @@ -2,47 +2,106 @@ ## プロトコル -* SSL v3.0 - [IETF Draft](https://tools.ietf.org/id/draft-ietf-tls-ssl-version3-00.txt) +* SSL v3.0 - [RFC6101](https://datatracker.ietf.org/doc/html/rfc6101)(ステータスはHistoric。[RFC7568](https://datatracker.ietf.org/doc/html/rfc7568)により非推奨化) * TLS v1.0 - [RFC2246](https://www.ietf.org/rfc/rfc2246.txt) * TLS v1.1 - [RFC4346](https://www.ietf.org/rfc/rfc4346.txt) +* TLS 1.0およびTLS 1.1の非推奨化 - [RFC8996](https://datatracker.ietf.org/doc/html/rfc8996) * TLS v1.2 - [RFC5246](https://www.ietf.org/rfc/rfc5246.txt) -* TLS v1.3 - [RFC8446](https://www.ietf.org/rfc/rfc8446.txt) -* DTLS - [RFC9147](https://datatracker.ietf.org/doc/html/rfc9147) +* TLS v1.3 - [RFC8446](https://www.ietf.org/rfc/rfc8446.txt)、改訂版は[RFC9846](https://datatracker.ietf.org/doc/html/rfc9846) +* DTLS v1.0 - [RFC4347](https://datatracker.ietf.org/doc/html/rfc4347) +* DTLS v1.2 - [RFC6347](https://datatracker.ietf.org/doc/html/rfc6347) +* DTLS v1.3 - [RFC9147](https://datatracker.ietf.org/doc/html/rfc9147) +* TLSを使用したQUICの保護 - [RFC9001](https://datatracker.ietf.org/doc/html/rfc9001) +* TLSおよびDTLSの安全な使用に関する推奨事項(BCP 195) - [RFC9325](https://datatracker.ietf.org/doc/html/rfc9325) * IPv4の概要 - [Wikipedia](https://en.wikipedia.org/wiki/IPv4) * IPv6の概要 - [Wikipedia](https://en.wikipedia.org/wiki/IPv6) +## TLS拡張と暗号スイート + +* TLS拡張機能(SNI、Maximum Fragment Length、Trusted CA Keys、Truncated HMAC、Certificate Status Request) - [RFC6066](https://datatracker.ietf.org/doc/html/rfc6066) +* Multiple Certificate Status Request(`status_request_v2`) - [RFC6961](https://datatracker.ietf.org/doc/html/rfc6961) +* Application-Layer Protocol Negotiation (ALPN) - [RFC7301](https://datatracker.ietf.org/doc/html/rfc7301) +* Renegotiation Indication - [RFC5746](https://datatracker.ietf.org/doc/html/rfc5746) +* セッションチケット - [RFC5077](https://datatracker.ietf.org/doc/html/rfc5077) +* Encrypt-then-MAC - [RFC7366](https://datatracker.ietf.org/doc/html/rfc7366) +* 拡張マスターシークレット(Extended Master Secret) - [RFC7627](https://datatracker.ietf.org/doc/html/rfc7627) +* TLS 1.2以前向けのECC暗号スイート - [RFC8422](https://datatracker.ietf.org/doc/html/rfc8422)([RFC4492](https://datatracker.ietf.org/doc/html/rfc4492)を廃止) +* 有限体Diffie-Hellman Ephemeral(FFDHE)グループ - [RFC7919](https://datatracker.ietf.org/doc/html/rfc7919) +* TLS 1.3向けのBrainpool曲線 - [RFC8734](https://datatracker.ietf.org/doc/html/rfc8734) +* Raw Public Keys - [RFC7250](https://datatracker.ietf.org/doc/html/rfc7250) +* AES-GCM暗号スイート - [RFC5288](https://datatracker.ietf.org/doc/html/rfc5288) +* AES-CCM暗号スイート - [RFC6655](https://datatracker.ietf.org/doc/html/rfc6655) +* ChaCha20-Poly1305暗号スイート - [RFC7905](https://datatracker.ietf.org/doc/html/rfc7905) +* ECDHE-PSK AEAD暗号スイート - [RFC8442](https://datatracker.ietf.org/doc/html/rfc8442) +* TLS 1.3向けの完全性保護のみの暗号スイート - [RFC9150](https://datatracker.ietf.org/doc/html/rfc9150) +* TLS 1.3向けのShangMi(SM)暗号スイート - [RFC8998](https://datatracker.ietf.org/doc/html/rfc8998) +* TLS 1.2およびDTLS 1.2におけるMD5およびSHA-1署名ハッシュの非推奨化 - [RFC9155](https://datatracker.ietf.org/doc/html/rfc9155) +* DTLS Connection ID - [RFC9146](https://datatracker.ietf.org/doc/html/rfc9146) +* DTLS-SRTP - [RFC5764](https://datatracker.ietf.org/doc/html/rfc5764) +* Encrypted Client Hello (ECH) - [RFC9849](https://datatracker.ietf.org/doc/html/rfc9849) +* 外部PSKを用いた証明書認証(`cert_with_extern_psk`) - [RFC9973](https://datatracker.ietf.org/doc/html/rfc9973)([RFC8773](https://datatracker.ietf.org/doc/html/rfc8773)を廃止) +* TLS 1.3向けのML-KEM - [draft-ietf-tls-mlkem](https://datatracker.ietf.org/doc/draft-ietf-tls-mlkem/) +* TLS 1.3向けのハイブリッドECDHE-ML-KEM - [draft-ietf-tls-ecdhe-mlkem](https://datatracker.ietf.org/doc/draft-ietf-tls-ecdhe-mlkem/) + ## ストリーム暗号 * 概要 - [Wikipedia](https://en.wikipedia.org/wiki/Stream_cipher) * RC4 / ARC4 - [IETF Draft](https://tools.ietf.org/id/draft-kaukonen-cipher-arcfour-03.txt) [Wikipedia](https://en.wikipedia.org/wiki/Rc4) +* ChaCha20およびPoly1305 - [RFC8439](https://datatracker.ietf.org/doc/html/rfc8439) ## ブロック暗号 * 概要 - [Wikipedia](https://en.wikipedia.org/wiki/Block_cipher) * AES - [NIST Publication](https://csrc.nist.gov/publications/fips/fips197/fips-197.pdf) [Wikipedia](https://en.wikipedia.org/wiki/Advanced_Encryption_Standard) -* AES-GCM - [NIST Specification](https://csrc.nist.rip/groups/ST/toolkit/BCM/documents/proposedmodes/gcm/gcm-spec.pdf) +* ブロック暗号の利用モード(ECB、CBC、CFB、OFB、CTR) - [NIST SP 800-38A](https://csrc.nist.gov/pubs/sp/800/38/a/final) +* AES-CMAC - [NIST SP 800-38B](https://csrc.nist.gov/pubs/sp/800/38/b/upd1/final) +* AES-CCM - [NIST SP 800-38C](https://csrc.nist.gov/pubs/sp/800/38/c/upd1/final) +* AES-GCM - [NIST SP 800-38D](https://csrc.nist.gov/pubs/sp/800/38/d/final) +* AES-SIV - [RFC5297](https://datatracker.ietf.org/doc/html/rfc5297) +* AES-GCM-SIV - [RFC8452](https://datatracker.ietf.org/doc/html/rfc8452) +* AESキーラップ - [RFC3394](https://datatracker.ietf.org/doc/html/rfc3394)、パディング付き - [RFC5649](https://datatracker.ietf.org/doc/html/rfc5649) * AES-NI - [Intel Software Network](https://software.intel.com/en-us/articles/intel-advanced-encryption-standard-instructions-aes-ni/) * DES/3DES - [NIST Publication](https://csrc.nist.gov/publications/fips/fips46-3/fips46-3.pdf) [Wikipedia](https://en.wikipedia.org/wiki/Data_Encryption_Standard) ## ハッシュ -* SHA - [NIST FIPS180-1 Publication](https://www.itl.nist.gov/fipspubs/fip180-1.htm">https://www.itl.nist.gov/fipspubs/fip180-1.htm) [NIST FIPS180-2 Publication](https://csrc.nist.gov/publications/fips/fips180-2/fips180-2.pdf) [Wikipedia](https://en.wikipedia.org/wiki/SHA_hash_functions) +* SHA-1およびSHA-2 - [NIST FIPS 180-4](https://csrc.nist.gov/pubs/fips/180-4/upd1/final) [Wikipedia](https://en.wikipedia.org/wiki/SHA_hash_functions) +* SHA-3およびSHAKE - [NIST FIPS 202](https://csrc.nist.gov/pubs/fips/202/final) * MD4 - [RFC1320](https://tools.ietf.org/html/rfc1320) * MD5 - [RFC1321](https://tools.ietf.org/html/rfc1321) * RIPEMD-160 - [Specification document](https://homes.esat.kuleuven.be/~bosselae/ripemd160.html) +* HKDF - [RFC5869](https://datatracker.ietf.org/doc/html/rfc5869) ## 公開鍵暗号 * Diffie-Hellman - [Wikipedia](https://en.wikipedia.org/wiki/Diffie-Hellman_key_exchange) * RSA - [MIT Paper](https://people.csail.mit.edu/rivest/Rsapaper.pdf) [Wikipedia](https://en.wikipedia.org/wiki/RSA) -* DSA/DSS - [NIST FIPS186-3](https://csrc.nist.gov/publications/fips/fips186-3/fips_186-3.pdf) -* ECDSA - [Specification Document](https://www.cs.miami.edu/home/burt/learning/Csc609.142/ecdsa-cert.pdf) -* X.509 - [RFC3279](https://www.ietf.org/rfc/rfc3279.txt) +* RSA(PKCS#1 v2.2) - [RFC8017](https://datatracker.ietf.org/doc/html/rfc8017) +* デジタル署名標準(DSA、ECDSA、EdDSA) - [NIST FIPS 186-5](https://csrc.nist.gov/pubs/fips/186-5/final)。FIPS 186-5はFIPS 186-3および186-4に代わるもので、署名生成用としてDSAを承認していません。 +* ECDSA - [NIST FIPS 186-5](https://csrc.nist.gov/pubs/fips/186-5/final) [SEC 1](https://www.secg.org/sec1-v2.pdf)、決定論的ECDSA - [RFC6979](https://datatracker.ietf.org/doc/html/rfc6979) +* EdDSA(Ed25519、Ed448) - [RFC8032](https://datatracker.ietf.org/doc/html/rfc8032) +* X25519およびX448 - [RFC7748](https://datatracker.ietf.org/doc/html/rfc7748) +* X.509 - [RFC5280](https://datatracker.ietf.org/doc/html/rfc5280)、アルゴリズム識別子 - [RFC3279](https://www.ietf.org/rfc/rfc3279.txt) * ASN.1 - [Specification Document](https://luca.ntop.org/Teaching/Appunti/asn1.html) [Wikipedia](https://en.wikipedia.org/wiki/Abstract_Syntax_Notation_One) * PSK - [RFC4279](https://tools.ietf.org/html/rfc4279) +* HPKE - [RFC9180](https://datatracker.ietf.org/doc/html/rfc9180) + +## ポスト量子暗号 + +* ML-KEM - [NIST FIPS 203](https://csrc.nist.gov/pubs/fips/203/final) +* ML-DSA - [NIST FIPS 204](https://csrc.nist.gov/pubs/fips/204/final) +* SLH-DSA - [NIST FIPS 205](https://csrc.nist.gov/pubs/fips/205/final) +* LMS/HSS - [RFC8554](https://datatracker.ietf.org/doc/html/rfc8554) +* XMSS - [RFC8391](https://datatracker.ietf.org/doc/html/rfc8391) +* ステートフルハッシュベース署名(LMS、XMSS) - [NIST SP 800-208](https://csrc.nist.gov/pubs/sp/800/208/final) ## その他 -* PKCS#5, PBKDF1, PBKDF2 - [RFC2898](https://tools.ietf.org/html/rfc2898) -* PKCS#8 - [RFC5208](https://tools.ietf.org/html/rfc5208) -* PKCS#12 - [Wikipedia](https://en.wikipedia.org/wiki/PKCS_12) +* PKCS#5, PBKDF1, PBKDF2 - [RFC8018](https://datatracker.ietf.org/doc/html/rfc8018) +* PKCS#7 / CMS - [RFC5652](https://datatracker.ietf.org/doc/html/rfc5652) +* PKCS#8 - [RFC5958](https://datatracker.ietf.org/doc/html/rfc5958) +* PKCS#12 - [RFC7292](https://datatracker.ietf.org/doc/html/rfc7292) [Wikipedia](https://en.wikipedia.org/wiki/PKCS_12) +* OCSP - [RFC6960](https://datatracker.ietf.org/doc/html/rfc6960) +* タイムスタンププロトコル(TSP) - [RFC3161](https://datatracker.ietf.org/doc/html/rfc3161) +* Argon2 - [RFC9106](https://datatracker.ietf.org/doc/html/rfc9106) +* Hash DRBG - [NIST SP 800-90A Rev. 1](https://csrc.nist.gov/pubs/sp/800/90/a/r1/final) diff --git a/wolfSSL/src-ja/appendix06.md b/wolfSSL/src-ja/appendix06.md index 90529d9f..cd013097 100644 --- a/wolfSSL/src-ja/appendix06.md +++ b/wolfSSL/src-ja/appendix06.md @@ -2,24 +2,42 @@ ## wolfSSL エラーコード -wolfSSLのエラーコードは、`wolfssl/ssl.h`に記載しています。 +wolfSSL(旧称CyaSSL)のエラーコードは、`wolfssl/ssl.h`に記載しています。 +これらは[`wolfSSL_get_error()`](group__Debug.md#function-wolfssl_get_error)が返す値であり、OpenSSLの同名の値と一致します。 以下のエラーの詳細な説明については、OpenSSLのマニュアルページ`SSL_get_error`(`man SSL_get_error`)をご参照ください。 +`SSL_ERROR_*`という名前は、`WOLFSSL_ERROR_*`という名前のエイリアスです(`NO_OLD_SSL_NAMES`が定義されている場合は定義されません)。 -| エラーコード列挙型 | エラーコード | -| --------------- | ---------- | -| `SSL_ERROR_WANT_READ` | 2 | -| `SSL_ERROR_WANT_WRITE` | 3 | -| `SSL_ERROR_WANT_CONNECT` | 7 | -| `SSL_ERROR_WANT_ACCEPT` | 8 | -| `SSL_ERROR_SYSCALL` | 5 | -| `SSL_ERROR_WANT_X509_LOOKUP` | 83 | -| `SSL_ERROR_ZERO_RETURN` | 6 | -| `SSL_ERROR_SSL` | 85 | +| エラーコード列挙型 | エラーコード | エラーの説明 | +| --------------- | ---------- | ----------------- | +| `WOLFSSL_ERROR_NONE` (`SSL_ERROR_NONE`) | 0 | エラーなし | +| `WOLFSSL_ERROR_SSL` (`SSL_ERROR_SSL`) | 1 | OpenSSL互換のために定義、現在wolfSSLからは返されない | +| `WOLFSSL_ERROR_WANT_READ` (`SSL_ERROR_WANT_READ`) | 2 | 操作が完了していない、このAPIを再度呼び出す必要がある | +| `WOLFSSL_ERROR_WANT_WRITE` (`SSL_ERROR_WANT_WRITE`) | 3 | 操作が完了していない、このAPIを再度呼び出す必要がある | +| `WOLFSSL_ERROR_WANT_X509_LOOKUP` (`SSL_ERROR_WANT_X509_LOOKUP`) | 4 | 操作が完了していない、コールバックがこのAPIの再呼び出しを必要としている | +| `WOLFSSL_ERROR_SYSCALL` (`SSL_ERROR_SYSCALL`) | 5 | 何らかのシステムI/Oエラーが発生した | +| `WOLFSSL_ERROR_ZERO_RETURN` (`SSL_ERROR_ZERO_RETURN`) | 6 | クロージャアラートにより接続が閉じられた | +| `WOLFSSL_ERROR_WANT_CONNECT` (`SSL_ERROR_WANT_CONNECT`) | 7 | 下位プロトコルの接続がまだ開始されていない、このAPIを再度呼び出す必要がある | +| `WOLFSSL_ERROR_WANT_ACCEPT` (`SSL_ERROR_WANT_ACCEPT`) | 8 | 下位プロトコルの接続がまだ開始されていない、このAPIを再度呼び出す必要がある | + +`wolfSSL_get_error()`は、内部コード`WANT_READ`、`WANT_WRITE`、`ZERO_RETURN`を、それぞれ`SSL_ERROR_WANT_READ`、`SSL_ERROR_WANT_WRITE`、`SSL_ERROR_ZERO_RETURN`として報告します。 +`OPENSSL_EXTRA`ビルドでは`MATCH_SUITE_ERROR`と`SOCKET_PEER_CLOSED_E`も`SSL_ERROR_SYSCALL`(5)として報告し、`WOLFSSL_ASYNC_CRYPT`が定義されている場合は`MP_WOULDBLOCK`を`WC_PENDING_E`として報告します。 +その他の失敗の場合は、以下に示すwolfSSLまたはwolfCryptの負のエラーコードのいずれかを返します。 +[`wolfSSL_ERR_error_string()`](group__Debug.md#function-wolfssl_err_error_string)は、wolfSSLおよびwolfCryptのあらゆるエラーコードに対応する説明文字列を返します。 wolfSSLの追加のエラーコードは、`wolfssl/error-ssl.h`に記載しています。 +wolfSSL独自のTLSエラーコードは、-301(`WOLFSSL_FIRST_E`)から-525(`WOLFSSL_LAST_E`)までの範囲を使用します。 +このヘッダーでは、`WOLFSSL_FATAL_ERROR`(-1)と、`WOLFSSL_ERROR_*`の各値に対応する負の値(-2から-8)も定義しています。 | エラーコード列挙型 | エラーコード | エラーの説明 | | --------------- | ---------- | ----------------- | +| `WOLFSSL_FATAL_ERROR` | -1 | 汎用的な致命的エラー。ほとんどのAPI(`wolfSSL_connect()`や`wolfSSL_read()`など)は失敗時にこの値を返す。原因は`wolfSSL_get_error()`を呼び出して取得する | +| `WOLFSSL_ERROR_WANT_READ_E` | -2 | `WOLFSSL_ERROR_WANT_READ`に対応する負の値 | +| `WOLFSSL_ERROR_WANT_WRITE_E` | -3 | `WOLFSSL_ERROR_WANT_WRITE`に対応する負の値 | +| `WOLFSSL_ERROR_WANT_X509_LOOKUP_E` | -4 | `WOLFSSL_ERROR_WANT_X509_LOOKUP`に対応する負の値 | +| `WOLFSSL_ERROR_SYSCALL_E` | -5 | `WOLFSSL_ERROR_SYSCALL`に対応する負の値 | +| `WOLFSSL_ERROR_ZERO_RETURN_E` | -6 | `WOLFSSL_ERROR_ZERO_RETURN`に対応する負の値 | +| `WOLFSSL_ERROR_WANT_CONNECT_E` | -7 | `WOLFSSL_ERROR_WANT_CONNECT`に対応する負の値 | +| `WOLFSSL_ERROR_WANT_ACCEPT_E` | -8 | `WOLFSSL_ERROR_WANT_ACCEPT`に対応する負の値 | | `INPUT_CASE_ERROR` | -301 | プロセス入力状態エラー | | `PREFIX_ERROR` | -302 | 鍵ラウンドへの不正なインデックス | | `MEMORY_ERROR` | -303 | メモリ確保失敗 | @@ -44,6 +62,7 @@ wolfSSLの追加のエラーコードは、`wolfssl/error-ssl.h`に記載して | `DOMAIN_NAME_MISMATCH` | -322 | ピアのサブジェクト名の不一致 | | `WANT_READ` | -323 | データ再読み取りが必要 | | `NOT_READY_ERROR` | -324 | ハンドシェイクレイヤーがReadyでない | +| `IPADDR_MISMATCH` | -325 | ピアのIPアドレスの不一致 | | `VERSION_ERROR` | -326 | レコードレイヤーのバージョンエラー | | `WANT_WRITE` | -327 | データの再送が必要 | | `BUFFER_ERROR` | -328 | 不正な形式のバッファ入力 | @@ -52,6 +71,8 @@ wolfSSLの追加のエラーコードは、`wolfssl/error-ssl.h`に記載して | `CLIENT_ID_ERROR` | -331 | PSKクライアントIDエラー | | `SERVER_HINT_ERROR` | -332 | PSKサーバーヒントエラー | | `PSK_KEY_ERROR` | -333 | PSK鍵エラー | +| `DUPE_ENTRY_E` | -334 | 重複エントリーエラー | +| `PSK_MISSING_ERROR` | -335 | PSKが存在しない | | `GETTIME_ERROR` | -337 | gettimeofdayが失敗 | | `GETITIMER_ERROR` | -338 | getitimerが失敗 | | `SIGACT_ERROR` | -339 | sigactionが失敗 | @@ -81,6 +102,7 @@ wolfSSLの追加のエラーコードは、`wolfssl/error-ssl.h`に記載して | `COOKIE_ERROR` | -369 | DTLSクッキーエラー | | `SEQUENCE_ERROR` | -370 | DTLSシーケンスエラー | | `SUITES_ERROR` | -371 | スイートポインタエラー | +| `MAX_CERT_EXTENSIONS_ERR` | -372 | 証明書拡張の最大数を超えた | | `OUT_OF_ORDER_E` | -373 | 順序外のメッセージ | | `BAD_KEA_TYPE_E` | -374 | 不正なKEAタイプが見つかった | | `SANITY_CIPHER_E` | -375 | 暗号のサニティチェックエラー | @@ -88,12 +110,12 @@ wolfSSLの追加のエラーコードは、`wolfssl/error-ssl.h`に記載して | `GEN_COOKIE_E` | -377 | クッキー生成エラー | | `NO_PEER_VERIFY` | -378 | 検証すべきピア証明書が存在しない | | `FWRITE_ERROR` | -379 | fwriteエラー | -| `CACHE_MATCH_ERROR` | -380 | キャッシュHRD不一致 | +| `CACHE_MATCH_ERROR` | -380 | キャッシュヘッダー不一致エラー | | `UNKNOWN_SNI_HOST_NAME_E` | -381 | 認識されないホスト名 | | `UNKNOWN_MAX_FRAG_LEN_E` | -382 | 認識されない最大フラグメント | | `KEYUSE_SIGNATURE_E` | -383 | KeyUse digSignatureエラー | | `KEYUSE_ENCIPHER_E` | -385 | KeyUse KeyEncipherエラー | -| `EXTKEYUSE_AUTH_E` | -386 | ExtKeyUse server・client_auth | +| `EXTKEYUSE_AUTH_E` | -386 | ExtKeyUse server\|client_auth | | `SEND_OOB_READ_E` | -387 | 送信コールバックが境界外読み取り | | `SECURE_RENEGOTIATION_E` | -388 | 無効な再ネゴシエーション情報 | | `SESSION_TICKET_LEN_E` | -389 | セッションチケットが大きすぎる | @@ -102,7 +124,7 @@ wolfSSLの追加のエラーコードは、`wolfssl/error-ssl.h`に記載して | `SESSION_SECRET_CB_E` | -392 | セッション秘密CB関数の失敗 | | `NO_CHANGE_CIPHER_E` | -393 | Cipher変更前に終了 | | `SANITY_MSG_E` | -394 | メッセージ順序のサニティチェックエラー | -| `DUPLICATE_MST_E` | -395 | 重複メッセージエラー | +| `DUPLICATE_MSG_E` | -395 | 重複メッセージエラー | | `SNI_UNSUPPORTED` | -396 | SSL 3.0はSNIをサポートしていない | | `SOCKET_PEER_CLOSED_E` | -397 | トランスポート層がクローズされた | | `BAD_TICKET_KEY_CB_SZ` | -398 | 不正なセッションチケット鍵cbサイズ | @@ -115,13 +137,13 @@ wolfSSLの追加のエラーコードは、`wolfssl/error-ssl.h`に記載して | `UNKNOWN_ALPN_PROTOCOL_NAME_E` | -405 | 認識されないプロトコル名 | | `BAD_CERTIFICATE_STATUS_ERROR` | -406 | 不正な証明書ステータスメッセージ | | `OCSP_INVALID_STATUS` | -407 | 無効なOCSPステータス | -| `OCSP_WANT_READ` | -408 | OCSPコールバックレスポンス | +| `OCSP_WANT_READ` | -408 | OCSP I/Oコールバックが`WOLFSSL_CBIO_ERR_WANT_READ`を返した、再度呼び出す必要がある | | `RSA_KEY_SIZE_E` | -409 | RSA鍵が小さすぎる | | `ECC_KEY_SIZE_E` | -410 | ECC鍵が小さすぎる | | `DTLS_EXPORT_VER_E` | -411 | エクスポートバージョンエラー | | `INPUT_SIZE_E` | -412 | 入力サイズが大きすぎる | | `CTX_INIT_MUTEX_E` | -413 | コンテキストミューテックス初期化エラー | -| `EXT_MASTER_SECRET_NEEDED_E` | -414 | 再開するにはEMSを有効にする必要がある | +| `EXT_MASTER_SECRET_NEEDED_E` | -414 | EMSが必要だがネゴシエートされていない | | `DTLS_POOL_SZ_E` | -415 | DTLSプールサイズを超えた | | `DECODE_E` | -416 | ハンドシェイクメッセージのデコードエラー | | `HTTP_TIMEOUT` | -417 | OCSPまたはCRLリクエストのHTTPタイムアウト | @@ -142,8 +164,40 @@ wolfSSLの追加のエラーコードは、`wolfssl/error-ssl.h`に記載して | `DH_PARAMS_NOT_FFDHE_E` | -432 | サーバーからのDHパラメータがFFDHEでない | | `TCA_INVALID_ID_TYPE` | -433 | TLSX TCA IDタイプが無効 | | `TCA_ABSENT_ERROR` | -434 | TLSX TCA IDレスポンスなし | +| `TSIP_MAC_DIGSZ_E` | -435 | TSIPに対する無効なMACサイズ | +| `CLIENT_CERT_CB_ERROR` | -436 | クライアント証明書コールバックエラー | +| `SSL_SHUTDOWN_ALREADY_DONE_E` | -437 | シャットダウンが重複して呼び出された | +| `TLS13_SECRET_CB_E` | -438 | TLS1.3秘密コールバック関数の失敗 | +| `DTLS_SIZE_ERROR` | -439 | 送信しようとしたデータが大きすぎる | +| `NO_CERT_ERROR` | -440 | TLS1.3で証明書が設定されていないエラー | +| `APP_DATA_READY` | -441 | アプリケーションデータの読み取り準備ができた | +| `TOO_MUCH_EARLY_DATA` | -442 | 早期データが多すぎる。max_early_data_sizeを超える早期データが送信または受信されたか、早期データの送信中にAEAD鍵の使用回数上限に達した | +| `SOCKET_FILTERED_E` | -443 | ネットワークフィルターによりセッションが停止された | +| `HTTP_RECV_ERR` | -444 | HTTP受信エラー | +| `HTTP_HEADER_ERR` | -445 | HTTPヘッダーエラー | +| `HTTP_PROTO_ERR` | -446 | HTTPプロトコルエラー | +| `HTTP_STATUS_ERR` | -447 | HTTPステータスエラー | +| `HTTP_VERSION_ERR` | -448 | HTTPバージョンエラー | +| `HTTP_APPSTR_ERR` | -449 | HTTPアプリケーション文字列エラー | +| `UNSUPPORTED_PROTO_VERSION` | -450 | 不正またはサポートされていないプロトコルバージョン | +| `FALCON_KEY_SIZE_E` | -451 | Falconの鍵サイズが不正 | +| `QUIC_TP_MISSING_E` | -452 | QUICトランスポートパラメータが存在しない | +| `MLDSA_KEY_SIZE_E` | -453 | ML-DSAの鍵サイズが不正(旧エイリアス`DILITHIUM_KEY_SIZE_E`) | +| `DTLS_CID_ERROR` | -454 | CIDが不正または存在しない | +| `DTLS_TOO_MANY_FRAGMENTS_E` | -455 | 受信したフラグメントが多すぎる | +| `DTLS_PARTIAL_RECORD_READ` | -455 | データグラム内の不完全なレコードを受信した(`DTLS_TOO_MANY_FRAGMENTS_E`と同じ値-455を共有) | +| `QUIC_WRONG_ENC_LEVEL` | -456 | 誤った暗号化レベルでQUICデータを受信した | +| `DUPLICATE_TLS_EXT_E` | -457 | メッセージ内でTLS拡張が重複している | +| `WOLFSSL_ALPN_NOT_FOUND` | -458 | TLS拡張が見つからない | +| `WOLFSSL_BAD_CERTTYPE` | -459 | 証明書タイプがサポートされていない | +| `WOLFSSL_BAD_STAT` | -460 | 未使用 | +| `WOLFSSL_BAD_PATH` | -461 | 指定されたパスに証明書が見つからない | +| `WOLFSSL_BAD_FILETYPE` | -462 | データ形式がサポートされていない | +| `WOLFSSL_BAD_FILE` | -463 | ファイルの入出力エラー | +| `WOLFSSL_NOT_IMPLEMENTED` | -464 | 関数が実装されていない | +| `WOLFSSL_UNKNOWN` | -465 | 不明なアルゴリズム(EVP) | -ネゴシエーションパラメータエラー +### ネゴシエーションパラメータエラー | エラーコード列挙型 | エラーコード | エラーの説明 | | --------------- | ---------- | ----------------- | @@ -153,19 +207,73 @@ wolfSSLの追加のエラーコードは、`wolfssl/error-ssl.h`に記載して | `KEY_SHARE_ERROR` | -503 | 鍵共有の不一致 | | `POST_HAND_AUTH_ERROR` | -504 | クライアントがポストハンド認証を行わない | | `HRR_COOKIE_ERROR` | -505 | HRRメッセージクッキーの不一致 | +| `UNSUPPORTED_CERTIFICATE` | -506 | サポートされていない証明書タイプ | + +### PEM、EVP、その他のTLSエラー + +| エラーコード列挙型 | エラーコード | エラーの説明 | +| --------------- | ---------- | ----------------- | +| `WOLFSSL_PEM_R_NO_START_LINE_E` | -507 | 一致するオブジェクトがこれ以上見つからない(PEM) | +| `WOLFSSL_PEM_R_PROBLEMS_GETTING_PASSWORD_E` | -508 | パスワード取得エラー(PEM) | +| `WOLFSSL_PEM_R_BAD_PASSWORD_READ_E` | -509 | 不正なパスワード(PEM) | +| `WOLFSSL_PEM_R_BAD_DECRYPT_E` | -510 | 復号失敗(PEM) | +| `WOLFSSL_ASN1_R_HEADER_TOO_LONG_E` | -511 | ASNヘッダーが長すぎる(互換レイヤー) | +| `WOLFSSL_EVP_R_BAD_DECRYPT_E` | -512 | 復号失敗(EVP) | +| `WOLFSSL_EVP_R_BN_DECODE_ERROR` | -513 | 多倍長整数のデコードエラー(EVP) | +| `WOLFSSL_EVP_R_DECODE_ERROR` | -514 | デコードエラー(EVP) | +| `WOLFSSL_EVP_R_PRIVATE_KEY_DECODE_ERROR` | -515 | 秘密鍵のデコードエラー(EVP) | +| `CRYPTO_POLICY_FORBIDDEN` | -516 | システムの暗号ポリシーにより禁止された操作 | +| `SESSION_TICKET_NONCE_OVERFLOW` | -517 | セッションチケットのナンスのオーバーフロー | +| `EMPTY_RECORD_LIMIT_E` | -518 | 受信した空レコードが多すぎる | +| `ECH_REQUIRED_E` | -519 | ECHを提示したがサーバーに拒否された | +| `SEQUENCE_NUMBER_E` | -520 | レコードシーケンス番号がラップアラウンドする | +| `RPK_UNTRUSTED_E` | -521 | RFC 7250のRaw Public Key(生の公開鍵)が帯域外で信頼されていない | +| `OCSP_NO_URL` | -522 | 証明書がOCSPレスポンダーを示しておらず、上書き用のURLも設定されていない | +| `CHAIN_VERIFY_WANT_E` | -523 | チェーン検証コールバックがまだ判定に至っていない | +| `CHAIN_VERIFY_CB_E` | -524 | チェーン検証コールバックがピアの証明書を拒否した | +| `CHAIN_VERIFY_UNSUPPORTED_E` | -525 | チェーン検証コールバックがDTLS、RPK、またはOCSPステープリングと併用された | + +### I/Oコールバックの戻り値 + +I/Oコールバック(組み込みのソケットコールバック、または`wolfSSL_CTX_SetIORecv()`と`wolfSSL_CTX_SetIOSend()`で登録した独自のコールバック)は、受信または送信したバイト数か、以下のいずれかのコード(`wolfssl/error-ssl.h`の`enum IOerrors`)を返します。 +wolfSSLはこれらを上記のエラーコードに変換します。 +例えば、受信コールバックが返した`WOLFSSL_CBIO_ERR_WANT_READ`は`WANT_READ`になります。 + +| エラーコード列挙型 | エラーコード | エラーの説明 | +| --------------- | ---------- | ----------------- | +| `WOLFSSL_CBIO_ERR_GENERAL` | -1 | 一般的な予期しないエラー | +| `WOLFSSL_CBIO_ERR_WANT_READ` | -2 | readを再度呼び出す必要がある | +| `WOLFSSL_CBIO_ERR_WANT_WRITE` | -2 | writeを再度呼び出す必要がある | +| `WOLFSSL_CBIO_ERR_CONN_RST` | -3 | 接続がリセットされた | +| `WOLFSSL_CBIO_ERR_ISR` | -4 | 割り込み | +| `WOLFSSL_CBIO_ERR_CONN_CLOSE` | -5 | 接続が閉じられた、またはEPIPE | +| `WOLFSSL_CBIO_ERR_TIMEOUT` | -6 | ソケットタイムアウト | ## wolfCryptエラーコード -wolfCryptのエラーコードは、`wolfssl/wolfcrypt/error.h`に記載しています。 +wolfCryptのエラーコードは、`wolfssl/wolfcrypt/error-crypt.h`に記載しています。 +これらは2つの範囲を使用します。 +-97(`WC_SPAN1_FIRST_E`)から-300(`WC_SPAN1_MIN_CODE_E`)までと、-1000(`WC_SPAN2_FIRST_E`)から-1999(`WC_SPAN2_MIN_CODE_E`)までです。 +`MAX_CODE_E`(-96)と`MIN_CODE_E`(-1999)はwolfCryptエラーコード全体の外側の境界を示し、`WC_LAST_E`(-1042)は現在割り当てられている最後のコードです。 +`WC_FAILURE`(-1)は、これらの範囲外にある汎用的な失敗コードです。 +[`wc_GetErrorString()`](group__Error.md#function-wc_geterrorstring)は、wolfCryptエラーコードに対応する説明文字列を返します。 | エラーコード列挙型 | エラーコード | エラーの説明 | | --------------- | ---------- | ----------------- | +| `WC_FAILURE` | -1 | wolfCryptの汎用的な失敗 | +| `MP_MEM` | -97 | MPの動的メモリ確保に失敗 | +| `MP_VAL` | -98 | MPに渡された値が使用できない | +| `MP_WOULDBLOCK` | -99 | MPのノンブロッキング操作が部分的に完了した時点で戻った | +| `MP_NOT_INF` | -100 | MPの点が無限遠点でない | | `OPEN_RAN_E` | -101 | ランダムデバイスを開く際にエラー | | `READ_RAN_E` | -102 | ランダムデバイスの読み取りエラー | | `WINCRYPT_E` | -103 | Windows crypt初期化エラー | -| `CRYPTGEN_E` | -104 | Windows crypt暗号化エラー | +| `CRYPTGEN_E` | -104 | Windows crypt生成エラー | | `RAN_BLOCK_E` | -105 | ランダムデバイスの読み取りがブロックされる | | `BAD_MUTEX_E` | -106 | ミューテックス操作で失敗 | +| `WC_TIMEOUT_E` | -107 | タイムアウトエラー | +| `WC_PENDING_E` | -108 | wolfCrypt操作が保留中(ブロックが発生する状態) | +| `WC_NO_PENDING_E` | -109 | 保留中の非同期操作がない | | `MP_INIT_E` | -110 | mp_initエラー | | `MP_READ_E` | -111 | mp_readエラー | | `MP_EXPTMOD_E` | -112 | mp_exptmodエラー | @@ -178,7 +286,14 @@ wolfCryptのエラーコードは、`wolfssl/wolfcrypt/error.h`に記載して | `MP_INVMOD_E` | -119 | mp_invmodエラー、invmodできない | | `MP_CMP_E` | -120 | mp_cmpエラー | | `MP_ZERO_E` | -121 | 予期しないmp zeroの結果を取得 | +| `AES_EAX_AUTH_E` | -122 | AES-EAX認証チェック失敗 | +| `KEY_EXHAUSTED_E` | -123 | これ以上操作に使用できない | +| `ML_KEM_KAT_FIPS_E` | -124 | ML-KEM KAT失敗 | | `MEMORY_E` | -125 | メモリ不足エラー | +| `VAR_STATE_CHANGE_E` | -126 | 変数の状態が別のスレッドによって変更された | +| `FIPS_DEGRADED_E` | -127 | FIPSモジュールが縮退モード | +| `FIPS_CODE_SZ_E` | -128 | モジュールのCODEが大きすぎる | +| `FIPS_DATA_SZ_E` | -129 | モジュールのDATAが大きすぎる | | `RSA_WRONG_TYPE_E` | -130 | RSA関数に対する不正なブロックタイプ | | `RSA_BUFFER_E` | -131 | RSAバッファエラー、出力が小さすぎるか入力が大きすぎる | | `BUFFER_E` | -132 | 出力バッファが小さすぎるか入力が大きすぎる | @@ -208,7 +323,17 @@ wolfCryptのエラーコードは、`wolfssl/wolfcrypt/error.h`に記載して | `ASN_SIG_HASH_E` | -156 | ASN署名エラー、サポートされていないハッシュタイプ | | `ASN_SIG_KEY_E` | -157 | ASN署名エラー、サポートされていない鍵タイプ | | `ASN_DH_KEY_E` | -158 | ASN鍵初期化エラー、無効な入力 | +| `KDF_SRTP_KAT_FIPS_E` | -159 | SRTP-KDF既知解テスト失敗 | | `ASN_CRIT_EXT_E` | -160 | ASNサポートされていない重要な拡張 | +| `ASN_ALT_NAME_E` | -161 | ASN代替名エラー | +| `ASN_NO_PEM_HEADER` | -162 | ASN PEMヘッダーが見つからない | +| `ED25519_KAT_FIPS_E` | -163 | Ed25519既知解テスト失敗 | +| `ED448_KAT_FIPS_E` | -164 | Ed448既知解テスト失敗 | +| `PBKDF2_KAT_FIPS_E` | -165 | PBKDF2既知解テスト失敗 | +| `WC_KEY_MISMATCH_E` | -166 | 秘密鍵と公開鍵の不一致エラー | +| `ML_DSA_KAT_FIPS_E` | -167 | ML-DSA KAT失敗 | +| `LMS_KAT_FIPS_E` | -168 | LMS KAT失敗 | +| `XMSS_KAT_FIPS_E` | -169 | XMSS KAT失敗 | | `ECC_BAD_ARG_E` | -170 | ECC入力引数の型が間違っている | | `ASN_ECC_KEY_E` | -171 | ASN ECC不正な入力 | | `ECC_CURVE_OID_E` | -172 | サポートされていないECC OID曲線タイプ | @@ -217,19 +342,21 @@ wolfCryptのエラーコードは、`wolfssl/wolfcrypt/error.h`に記載して | `UNICODE_SIZE_E` | -175 | Unicodeパスワードが大きすぎる | | `NO_PASSWORD` | -176 | ユーザーからのパスワード提供なし | | `ALT_NAME_E` | -177 | Alt Nameのサイズ問題、大きすぎる | +| `BAD_OCSP_RESPONDER` | -178 | 無効なOCSPレスポンダー、特定の鍵用途拡張が存在しない | +| `CRL_CERT_DATE_ERR` | -179 | CRL日付エラー | | `AES_GCM_AUTH_E` | -180 | AES-GCM認証チェック失敗 | | `AES_CCM_AUTH_E` | -181 | AES-CCM認証チェック失敗 | -| `CAVIUM_INIT_E` | -182 | Cavium初期化タイプエラー | +| `ASYNC_INIT_E` | -182 | 非同期初期化タイプエラー | | `COMPRESS_INIT_E` | -183 | 圧縮初期化エラー | | `COMPRESS_E` | -184 | 圧縮エラー | | `DECOMPRESS_INIT_E` | -185 | 解凍初期化エラー | | `DECOMPRESS_E` | -186 | 解凍エラー | | `BAD_ALIGN_E` | -187 | 操作の不正なアライメント、割り当てなし | | `ASN_NO_SIGNER_E` | -188 | ASN署名エラー、証明書を検証するCAの署名者なし | -| `ASN_CRL_CONFIRM_E` | -189 | ASN CRL失敗を確認する署名者なし | +| `ASN_CRL_CONFIRM_E` | -189 | ASN CRL署名確認失敗 | | `ASN_CRL_NO_SIGNER_E` | -190 | ASN CRL失敗を確認する署名者なし | | `ASN_OCSP_CONFIRM_E` | -191 | ASN OCSP署名確認失敗 | -| `BAD_ENC_STATE_E` | -192 | 不正なECC暗号化状態操作 | +| `BAD_STATE_E` | -192 | 不正な状態操作 | | `BAD_PADDING_E` | -193 | 不正なパディング、メッセージ長が不正 | | `REQ_ATTRIBUTE_E` | -194 | 証明書リクエスト属性設定エラー | | `PKCS7_OID_E` | -195 | PKCS#7、OIDの不一致エラー | @@ -254,11 +381,12 @@ wolfCryptのエラーコードは、`wolfssl/wolfcrypt/error.h`に記載して | `IS_POINT_E` | -214 | ECC曲線上の点判定失敗 | | `ECC_INF_E` | -215 | ECC点無限大エラー | | `ECC_PRIV_KEY_E` | -216 | ECC秘密鍵が無効エラー | -| `SRP_CALL_ORDER_E` | -217 | SRP関数が間違った順序で呼び出された | -| `SRP_VERIFY_E` | -218 | SRP証明検証失敗 | -| `SRP_BAD_KEY_E` | -219 | SRP不正な一時値 | -| `ASN_NO_SKID` | -220 | ASNサブジェクト鍵識別子なし | -| `ASN_NO_AKID` | -221 | ASN権限鍵識別子なし | +| `ECC_OUT_OF_RANGE_E` | -217 | ECC鍵の要素が範囲外 | +| `SRP_CALL_ORDER_E` | -218 | SRP関数が間違った順序で呼び出された | +| `SRP_VERIFY_E` | -219 | SRP証明検証失敗 | +| `SRP_BAD_KEY_E` | -220 | SRP不正な一時値 | +| `ASN_NO_SKID` | -221 | ASNサブジェクト鍵識別子なし | +| `ASN_NO_AKID` | -222 | ASN権限鍵識別子なし | | `ASN_NO_KEYUSAGE` | -223 | ASN鍵用途なし | | `SKID_E` | -224 | サブジェクト鍵識別子設定エラー | | `AKID_E` | -225 | 権限鍵識別子設定エラー | @@ -266,9 +394,10 @@ wolfCryptのエラーコードは、`wolfssl/wolfcrypt/error.h`に記載して | `CERTPOLICIES_E` | -227 | 証明書ポリシー設定エラー | | `WC_INIT_E` | -228 | wolfCrypt初期化失敗 | | `SIG_VERIFY_E` | -229 | wolfCrypt署名検証エラー | -| `BAD_PKCS7_SIGNEEDS_CHECKCOND_E` | -230 | 不正な条件変数操作 | +| `BAD_COND_E` | -230 | 不正な条件変数操作 | | `SIG_TYPE_E` | -231 | 署名タイプが有効でない/利用不可 | | `HASH_TYPE_E` | -232 | ハッシュタイプが有効でない/利用不可 | +| `FIPS_INVALID_VER_E` | -233 | 無効なFIPSバージョンが定義されている | | `WC_KEY_SIZE_E` | -234 | 鍵サイズエラー、小さすぎるか大きすぎる | | `ASN_COUNTRY_SIZE_E` | -235 | ASN証明書生成、無効な国コードサイズ | | `MISSING_RNG_E` | -236 | RNGが必要だが提供されていない | @@ -308,8 +437,81 @@ wolfCryptのエラーコードは、`wolfssl/wolfcrypt/error.h`に記載して | `WC_PKCS7_WANT_READ_E` | -270 | PKCS7ストリーム操作でより多くの入力が必要 | | `CRYPTOCB_UNAVAILABLE` | -271 | 暗号コールバック利用不可 | | `PKCS7_SIGNEEDS_CHECK` | -272 | 署名は呼び出し元による検証が必要 | +| `PSS_SALTLEN_RECOVER_E` | -273 | PSSのsaltの長さを復元できない | +| `CHACHA_POLY_OVERFLOW` | -274 | ChaCha20Poly1305の上限オーバーフロー | | `ASN_SELF_SIGNED_E` | -275 | ASN自己署名証明書エラー | -| `MIN_CODE_E` | -300 | エラー -101 - -299 | +| `SAKKE_VERIFY_FAIL_E` | -276 | SAKKE導出検証エラー | +| `MISSING_IV` | -277 | IVが設定されていない | +| `MISSING_KEY` | -278 | 鍵が設定されていない | +| `BAD_LENGTH_E` | -279 | 長さパラメータの値が無効 | +| `ECDSA_KAT_FIPS_E` | -280 | ECDSA KAT失敗 | +| `RSA_PAT_FIPS_E` | -281 | RSAペアワイズテスト失敗 | +| `KDF_TLS12_KAT_FIPS_E` | -282 | TLS12 KDF KAT失敗 | +| `KDF_TLS13_KAT_FIPS_E` | -283 | TLS13 KDF KAT失敗 | +| `KDF_SSH_KAT_FIPS_E` | -284 | SSH KDF KAT失敗 | +| `DHE_PCT_E` | -285 | DHEペアワイズ整合性テスト失敗 | +| `ECC_PCT_E` | -286 | ECDHEペアワイズ整合性テスト失敗 | +| `FIPS_PRIVATE_KEY_LOCKED_E` | -287 | 秘密鍵をエクスポートできない | +| `PROTOCOLCB_UNAVAILABLE` | -288 | プロトコルコールバック利用不可 | +| `AES_SIV_AUTH_E` | -289 | AES-SIV認証失敗 | +| `NO_VALID_DEVID` | -290 | 有効なデバイスIDがない | +| `IO_FAILED_E` | -291 | 入出力の失敗 | +| `SYSLIB_FAILED_E` | -292 | システム/ライブラリ呼び出しの失敗 | +| `USE_HW_PSK` | -293 | ハードウェアがPSKを保持していることを示すコールバックの戻り値 | +| `ENTROPY_RT_E` | -294 | エントロピー反復テスト失敗 | +| `ENTROPY_APT_E` | -295 | エントロピー適応比率テスト失敗 | +| `ASN_DEPTH_E` | -296 | 無効なASN.1、深さチェック | +| `ASN_LEN_E` | -297 | ASN.1の長さが無効 | +| `SM4_GCM_AUTH_E` | -298 | SM4-GCM認証チェック失敗 | +| `SM4_CCM_AUTH_E` | -299 | SM4-CCM認証チェック失敗 | + +2番目の範囲(-1000から-1999)のエラーコードは以下のとおりです。 + +| エラーコード列挙型 | エラーコード | エラーの説明 | +| --------------- | ---------- | ----------------- | +| `DEADLOCK_AVERTED_E` | -1000 | デッドロックを回避した、呼び出しを再試行する必要がある | +| `ASCON_AUTH_E` | -1001 | ASCON認証チェック失敗 | +| `WC_ACCEL_INHIBIT_E` | -1002 | 暗号アクセラレーションが現在抑止されている | +| `BAD_INDEX_E` | -1003 | 不正なインデックス | +| `INTERRUPTED_E` | -1004 | 処理が中断された | +| `MLKEM_PUB_HASH_E` | -1005 | カプセル化解除鍵内のエンコードされた公開鍵が、保存されたハッシュと一致しない | +| `BUSY_E` | -1006 | オブジェクトがビジー状態 | +| `ALREADY_E` | -1007 | 操作はすでに実行済み(例えば、同じ暗号コールバックデバイスIDを二重に登録した場合) | +| `SEQ_OVERFLOW_E` | -1008 | シーケンスカウンターがオーバーフローする | +| `PUF_INIT_E` | -1009 | PUF初期化失敗(予約済み) | +| `PUF_READ_E` | -1010 | PUF SRAMの読み出しが起動時のヘルスチェックに失敗した | +| `PUF_ENROLL_E` | -1011 | PUFエンロールメント失敗 | +| `PUF_RECONSTRUCT_E` | -1012 | PUF再構成失敗 | +| `PUF_DERIVE_KEY_E` | -1013 | PUF鍵導出失敗 | +| `PUF_IDENTITY_E` | -1014 | PUF ID取得失敗 | +| `ML_KEM_PCT_E` | -1015 | ML-KEMペアワイズ整合性テスト失敗 | +| `ML_DSA_PCT_E` | -1016 | ML-DSAペアワイズ整合性テスト失敗 | +| `DRBG_SHA512_KAT_FIPS_E` | -1017 | SHA-512 DRBG KAT失敗 | +| `SLH_DSA_KAT_FIPS_E` | -1018 | SLH-DSA CAST KAT失敗 | +| `TSP_VERIFY_E` | -1019 | TSPトークンが無効、またはレスポンスがリクエストと一致しない | +| `SLH_DSA_PCT_E` | -1020 | SLH-DSAペアワイズ整合性テスト失敗 | +| `CMAC_KAT_FIPS_E` | -1021 | AES-CMAC KAT失敗 | +| `SHAKE_KAT_FIPS_E` | -1022 | SHAKE KAT失敗 | +| `DH_PCT_E` | -1023 | DHペアワイズ整合性テスト失敗(FIPS v7以降では廃止) | +| `AES_KW_KAT_FIPS_E` | -1024 | AESキーラップKAT失敗 | +| `FIPS_WRONG_API_E` | -1025 | 要求されたAPIはFIPSモードでは許可されていない | +| `KMAC_MIN_KEYLEN_E` | -1026 | FIPSモードKMAC最小鍵長エラー | +| `FIPS_BAD_VALUE_E` | -1027 | 指定された値はFIPSポリシーで許可されていない | +| `FIPS_UNAPPROVED_E` | -1028 | 操作は実行されたが、パラメータがFIPS承認済みではない | +| `NO_DEFAULT_FOUND_E` | -1029 | 要求タイプに対して登録されたデフォルトオブジェクトがない | +| `NOT_READY_E` | -1030 | リソースがまだ準備できていない(再試行が必要) | +| `OBJECT_NOT_LOCKED_E` | -1031 | オブジェクトに必要なロックが保持されていない | +| `WRONG_TYPE_OBJECT_E` | -1032 | 要求された操作に対してオブジェクトのタイプが誤っている | +| `NEEDS_RECOVERY_E` | -1033 | オブジェクトは使用前に復旧が必要 | +| `UNEXPECTED_STATE_E` | -1034 | オブジェクトが予期しない状態にある | +| `STILL_REFERENCED_E` | -1035 | オブジェクトがまだ参照されている(解放するのは安全でない) | +| `OBJECT_ORPHANED_E` | -1036 | オブジェクトが孤立している(引き取り可能) | +| `HWPUF_INIT_E` | -1037 | HWPUF初期化失敗 | +| `HWPUF_ENROLL_E` | -1038 | HWPUFエンロールメント失敗 | +| `HWPUF_START_E` | -1039 | HWPUF開始失敗 | +| `HWPUF_GENERATE_KEY_E` | -1040 | HWPUF鍵生成失敗 | +| `HWPUF_GET_KEY_E` | -1041 | HWPUF鍵取得失敗 | +| `HWPUF_ZEROIZE_E` | -1042 | HWPUFゼロ化失敗 | ## 一般的なエラーコードとその解決策 @@ -331,8 +533,9 @@ wolfCryptのエラーコードは、`wolfssl/wolfcrypt/error.h`に記載して ### `WANT_READ` (-323) `WANT_READ`エラーは、ノンブロッキングソケットを使用する場合によく発生します。 -ノンブロッキングソケットを使用する場合において、実際にはエラーではありませんが、エラーとして出力されます。 -I/Oコールバックからデータを受信する呼び出しが、現在受信可能なデータがないためブロックされる場合、I/Oコールバックは`WANT_READ`を返します。 -呼び出し元は待機し、後で再度受信を試みてください。 +ノンブロッキングソケットを使用する場合において、実際にはエラーではありませんが、エラーとして呼び出し元に返されます。 +I/Oコールバックからデータを受信する呼び出しが、現在受信可能なデータがないためブロックされる場合、I/Oコールバックは`WOLFSSL_CBIO_ERR_WANT_READ`(-2)を返します。 +wolfSSLはこれを内部的に`WANT_READ`(-323)として記録し、APIの呼び出しは`WOLFSSL_FATAL_ERROR`(-1)を返し、[`wolfSSL_get_error()`](group__Debug.md#function-wolfssl_get_error)は`SSL_ERROR_WANT_READ`(2)を返します。 +アプリケーションは`wolfSSL_get_error()`の戻り値を(-323ではなく)`SSL_ERROR_WANT_READ`と比較し、待機してから後で再度受信を試みてください。 これは通常、[`wolfSSL_read()`](group__IO.md#function-wolfssl_read)、[`wolfSSL_negotiate()`](group__IO.md#function-wolfssl_negotiate)、[`wolfSSL_accept()`](group__IO.md#function-wolfssl_accept)、および[`wolfSSL_connect()`](group__IO.md#function-wolfssl_connect)の呼び出しから見られます。 サンプルクライアントとサーバーは、デバッグ出力が有効である場合に`WANT_READ`を出力します。 diff --git a/wolfSSL/src-ja/appendix07.md b/wolfSSL/src-ja/appendix07.md index 741ecacf..832f636e 100644 --- a/wolfSSL/src-ja/appendix07.md +++ b/wolfSSL/src-ja/appendix07.md @@ -2,10 +2,10 @@ ## A. 暗号スイート -### A-1. TLS 1.3 +### A-1 TLS 1.3 -| IANA名 | Wire ID | デフォルト | configureオプション | -|--------|---------|:----------:|---------------------| +| IANA名 | Wire Value | デフォルト | configureオプション | +|-----------|-----------|:-------:|-----------------| | `TLS_AES_128_GCM_SHA256` | `0x13,0x01` | **有効** | `--enable-tls13` + `--enable-aesgcm` | | `TLS_AES_256_GCM_SHA384` | `0x13,0x02` | **有効** | `--enable-tls13` + `--enable-aesgcm` + `--enable-sha384` | | `TLS_CHACHA20_POLY1305_SHA256` | `0x13,0x03` | **有効** | `--enable-tls13` + `--enable-chacha` + `--enable-poly1305` | @@ -16,21 +16,22 @@ | `TLS_SHA256_SHA256` | `0xC0,0xB4` | 無効 | `--enable-nullcipher` | | `TLS_SHA384_SHA384` | `0xC0,0xB5` | 無効 | `--enable-nullcipher` + `--enable-sha384` | -### A-2. TLS 1.2 ECDHE-ECDSA +### A-2 TLS 1.2 ECDHE-ECDSA -| IANA名 | Wire ID | デフォルト | configureオプション | -|--------|---------|:----------:|---------------------| -| `TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256` | `0xC0,0x2B` | **有効** | — | -| `TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384` | `0xC0,0x2C` | **有効** | — | -| `TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256` | `0xCC,0xA9` | **有効** | — | -| `TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA` | `0xC0,0x09` | **有効** | — | -| `TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA` | `0xC0,0x0A` | **有効** | — | -| `TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256` | `0xC0,0x23` | **有効** | — | +| IANA名 | Wire Value | デフォルト | configureオプション | +|-----------|-----------|:-------:|-----------------| +| `TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256` | `0xC0,0x2B` | **有効** | - | +| `TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384` | `0xC0,0x2C` | **有効** | - | +| `TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256` | `0xCC,0xA9` | **有効** | - | +| `TLS_ECDHE_ECDSA_WITH_CHACHA20_OLD_POLY1305_SHA256` | `0xCC,0x14` | **有効** | -(A-4の注記を参照) | +| `TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA` | `0xC0,0x09` | **有効** | - | +| `TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA` | `0xC0,0x0A` | **有効** | - | +| `TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256` | `0xC0,0x23` | **有効** | - | | `TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384` | `0xC0,0x24` | **有効** | `--enable-sha384` | | `TLS_ECDHE_ECDSA_WITH_AES_128_CCM` | `0xC0,0xAC` | 無効 | `--enable-aesccm` | | `TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8` | `0xC0,0xAE` | 無効 | `--enable-aesccm` | | `TLS_ECDHE_ECDSA_WITH_AES_256_CCM_8` | `0xC0,0xAF` | 無効 | `--enable-aesccm` | -| `TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA` | `0xC0,0x08` | 無効 | `--enable-des3` | +| `TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA` | `0xC0,0x08` | 無効 | `--enable-des3` + `--enable-des3-tls-suites` | | `TLS_ECDHE_ECDSA_WITH_RC4_128_SHA` | `0xC0,0x07` | 無効 | `--enable-arc4` | | `TLS_ECDHE_ECDSA_WITH_NULL_SHA` | `0xC0,0x06` | 無効 | `--enable-nullcipher` | | `TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256` | `0xC0,0x5C` | 無効 | `--enable-aria` | @@ -39,302 +40,383 @@ | `TLS_ECDHE_ECDSA_WITH_SM4_GCM_SM3` | `0xE0,0x51` | 無効 | `--enable-sm4-gcm` + `--enable-sm3` + `--enable-sm2` | | `TLS_ECDHE_ECDSA_WITH_SM4_CCM_SM3` | `0xE0,0x52` | 無効 | `--enable-sm4-ccm` + `--enable-sm3` + `--enable-sm2` | -### A-3. TLS 1.2 ECDHE-RSA +### A-3 TLS 1.2 ECDHE-RSA -| IANA名 | Wire ID | デフォルト | configureオプション | -|--------|---------|:----------:|---------------------| -| `TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256` | `0xC0,0x2F` | **有効** | — | -| `TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384` | `0xC0,0x30` | **有効** | — | -| `TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256` | `0xCC,0xA8` | **有効** | — | -| `TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA` | `0xC0,0x13` | **有効** | — | -| `TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA` | `0xC0,0x14` | **有効** | — | -| `TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256` | `0xC0,0x27` | **有効** | — | +| IANA名 | Wire Value | デフォルト | configureオプション | +|-----------|-----------|:-------:|-----------------| +| `TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256` | `0xC0,0x2F` | **有効** | - | +| `TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384` | `0xC0,0x30` | **有効** | - | +| `TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256` | `0xCC,0xA8` | **有効** | - | +| `TLS_ECDHE_RSA_WITH_CHACHA20_OLD_POLY1305_SHA256` | `0xCC,0x13` | **有効** | -(A-4の注記を参照) | +| `TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA` | `0xC0,0x13` | **有効** | - | +| `TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA` | `0xC0,0x14` | **有効** | - | +| `TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256` | `0xC0,0x27` | **有効** | - | | `TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384` | `0xC0,0x28` | **有効** | `--enable-sha384` | -| `TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA` | `0xC0,0x12` | 無効 | `--enable-des3` | +| `TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA` | `0xC0,0x12` | 無効 | `--enable-des3` + `--enable-des3-tls-suites` | | `TLS_ECDHE_RSA_WITH_RC4_128_SHA` | `0xC0,0x11` | 無効 | `--enable-arc4` | -### A-4. TLS 1.2 DHE-RSA - -| IANA名 | Wire ID | デフォルト | configureオプション | -|--------|---------|:----------:|---------------------| -| `TLS_DHE_RSA_WITH_AES_128_GCM_SHA256` | `0x00,0x9E` | 無効 | `--enable-dh` | -| `TLS_DHE_RSA_WITH_AES_256_GCM_SHA384` | `0x00,0x9F` | 無効 | `--enable-dh` | -| `TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256` | `0xCC,0xAA` | 無効 | `--enable-dh` + `--enable-chacha` | -| `TLS_DHE_RSA_WITH_AES_128_CBC_SHA` | `0x00,0x33` | 無効 | `--enable-dh` | -| `TLS_DHE_RSA_WITH_AES_256_CBC_SHA` | `0x00,0x39` | 無効 | `--enable-dh` | -| `TLS_DHE_RSA_WITH_AES_128_CBC_SHA256` | `0x00,0x67` | 無効 | `--enable-dh` | -| `TLS_DHE_RSA_WITH_AES_256_CBC_SHA256` | `0x00,0x6B` | 無効 | `--enable-dh` | -| `TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA` | `0x00,0x16` | 無効 | `--enable-dh` + `--enable-des3` | -| `TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA` | `0x00,0x45` | 無効 | `--enable-dh` + `--enable-camellia` | -| `TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA` | `0x00,0x88` | 無効 | `--enable-dh` + `--enable-camellia` | -| `TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256` | `0x00,0xBE` | 無効 | `--enable-dh` + `--enable-camellia` | -| `TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256` | `0x00,0xC4` | 無効 | `--enable-dh` + `--enable-camellia` | - -### A-5. TLS 1.2 RSA(静的鍵交換) - -| IANA名 | Wire ID | デフォルト | configureオプション | -|--------|---------|:----------:|---------------------| -| `TLS_RSA_WITH_AES_128_GCM_SHA256` | `0x00,0x9C` | **有効** | — | -| `TLS_RSA_WITH_AES_256_GCM_SHA384` | `0x00,0x9D` | **有効** | — | -| `TLS_RSA_WITH_AES_128_CBC_SHA` | `0x00,0x2F` | **有効** | — | -| `TLS_RSA_WITH_AES_256_CBC_SHA` | `0x00,0x35` | **有効** | — | -| `TLS_RSA_WITH_AES_128_CBC_SHA256` | `0x00,0x3C` | **有効** | — | -| `TLS_RSA_WITH_AES_256_CBC_SHA256` | `0x00,0x3D` | **有効** | — | -| `TLS_RSA_WITH_AES_128_CCM_8` | `0xC0,0xA0` | 無効 | `--enable-aesccm` | -| `TLS_RSA_WITH_AES_256_CCM_8` | `0xC0,0xA1` | 無効 | `--enable-aesccm` | -| `SSL_RSA_WITH_3DES_EDE_CBC_SHA` | `0x00,0x0A` | 無効 | `--enable-des3` | -| `SSL_RSA_WITH_RC4_128_SHA` | `0x00,0x05` | 無効 | `--enable-arc4` | -| `SSL_RSA_WITH_RC4_128_MD5` | `0x00,0x04` | 無効 | `--enable-arc4` | -| `TLS_RSA_WITH_NULL_MD5` | `0x00,0x01` | 無効 | `--enable-nullcipher` | -| `TLS_RSA_WITH_NULL_SHA` | `0x00,0x02` | 無効 | `--enable-nullcipher` | -| `TLS_RSA_WITH_NULL_SHA256` | `0x00,0x3B` | 無効 | `--enable-nullcipher` | -| `TLS_RSA_WITH_CAMELLIA_128_CBC_SHA` | `0x00,0x41` | 無効 | `--enable-camellia` | -| `TLS_RSA_WITH_CAMELLIA_256_CBC_SHA` | `0x00,0x84` | 無効 | `--enable-camellia` | -| `TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256` | `0x00,0xBA` | 無効 | `--enable-camellia` | -| `TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256` | `0x00,0xC0` | 無効 | `--enable-camellia` | - -### A-6. TLS 1.2 静的ECDH - -| IANA名 | Wire ID | デフォルト | configureオプション | -|--------|---------|:----------:|---------------------| -| `TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256` | `0xC0,0x31` | 無効 | `--enable-staticecdh` | -| `TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384` | `0xC0,0x32` | 無効 | `--enable-staticecdh` | -| `TLS_ECDH_RSA_WITH_AES_128_CBC_SHA` | `0xC0,0x0E` | 無効 | `--enable-staticecdh` | -| `TLS_ECDH_RSA_WITH_AES_256_CBC_SHA` | `0xC0,0x0F` | 無効 | `--enable-staticecdh` | -| `TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256` | `0xC0,0x29` | 無効 | `--enable-staticecdh` | -| `TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384` | `0xC0,0x2A` | 無効 | `--enable-staticecdh` | -| `TLS_ECDH_RSA_WITH_RC4_128_SHA` | `0xC0,0x0C` | 無効 | `--enable-staticecdh` + `--enable-arc4` | -| `TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA` | `0xC0,0x0D` | 無効 | `--enable-staticecdh` + `--enable-des3` | -| `TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256` | `0xC0,0x2D` | 無効 | `--enable-staticecdh` | -| `TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384` | `0xC0,0x2E` | 無効 | `--enable-staticecdh` | -| `TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA` | `0xC0,0x04` | 無効 | `--enable-staticecdh` | -| `TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA` | `0xC0,0x05` | 無効 | `--enable-staticecdh` | -| `TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256` | `0xC0,0x25` | 無効 | `--enable-staticecdh` | -| `TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384` | `0xC0,0x26` | 無効 | `--enable-staticecdh` | -| `TLS_ECDH_ECDSA_WITH_RC4_128_SHA` | `0xC0,0x02` | 無効 | `--enable-staticecdh` + `--enable-arc4` | -| `TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA` | `0xC0,0x03` | 無効 | `--enable-staticecdh` + `--enable-des3` | - -### A-7. TLS 1.2 PSK - -| IANA名 | Wire ID | デフォルト | configureオプション | -|--------|---------|:----------:|---------------------| -| `TLS_PSK_WITH_AES_128_GCM_SHA256` | `0x00,0xA8` | 無効 | `--enable-psk` | -| `TLS_PSK_WITH_AES_256_GCM_SHA384` | `0x00,0xA9` | 無効 | `--enable-psk` | -| `TLS_PSK_WITH_AES_128_CBC_SHA256` | `0x00,0xAE` | 無効 | `--enable-psk` | -| `TLS_PSK_WITH_AES_256_CBC_SHA384` | `0x00,0xAF` | 無効 | `--enable-psk` | -| `TLS_PSK_WITH_AES_128_CBC_SHA` | `0x00,0x8C` | 無効 | `--enable-psk` | -| `TLS_PSK_WITH_AES_256_CBC_SHA` | `0x00,0x8D` | 無効 | `--enable-psk` | -| `TLS_PSK_WITH_AES_128_CCM` | `0xC0,0xA4` | 無効 | `--enable-psk` + `--enable-aesccm` | -| `TLS_PSK_WITH_AES_256_CCM` | `0xC0,0xA5` | 無効 | `--enable-psk` + `--enable-aesccm` | -| `TLS_PSK_WITH_AES_128_CCM_8` | `0xC0,0xA8` | 無効 | `--enable-psk` + `--enable-aesccm` | -| `TLS_PSK_WITH_AES_256_CCM_8` | `0xC0,0xA9` | 無効 | `--enable-psk` + `--enable-aesccm` | +### A-4 TLS 1.2 DHE-RSA + +| IANA名 | Wire Value | デフォルト | configureオプション | +|-----------|-----------|:-------:|-----------------| +| `TLS_DHE_RSA_WITH_AES_128_GCM_SHA256` | `0x00,0x9E` | **有効** | - | +| `TLS_DHE_RSA_WITH_AES_256_GCM_SHA384` | `0x00,0x9F` | **有効** | - | +| `TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256` | `0xCC,0xAA` | **有効** | - | +| `TLS_DHE_RSA_WITH_CHACHA20_OLD_POLY1305_SHA256` | `0xCC,0x15` | **有効** | -(下記の注記を参照) | +| `TLS_DHE_RSA_WITH_AES_128_CBC_SHA` | `0x00,0x33` | **有効** | - | +| `TLS_DHE_RSA_WITH_AES_256_CBC_SHA` | `0x00,0x39` | **有効** | - | +| `TLS_DHE_RSA_WITH_AES_128_CBC_SHA256` | `0x00,0x67` | **有効** | - | +| `TLS_DHE_RSA_WITH_AES_256_CBC_SHA256` | `0x00,0x6B` | **有効** | - | +| `TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA` | `0x00,0x16` | 無効 | `--enable-des3` + `--enable-des3-tls-suites` | +| `TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA` | `0x00,0x45` | 無効 | `--enable-camellia` | +| `TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA` | `0x00,0x88` | 無効 | `--enable-camellia` | +| `TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256` | `0x00,0xBE` | 無効 | `--enable-camellia` | +| `TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256` | `0x00,0xC4` | 無効 | `--enable-camellia` | + +DHはデフォルトで有効(`--enable-dh`。ただしFIPS v7以降のビルドを除く)であるため、DHE暗号スイートはデフォルトでビルドに含まれます。 +サーバーがこれらの暗号スイートをネゴシエートするのは、`wolfSSL_CTX_SetTmpDH()`(または関連する関数)で読み込んだDHパラメータがある場合か、クライアントが提示したFFDHEグループからDHパラメータを選択した場合のみです。 + +A-2、A-3、A-4の`_OLD_POLY1305`暗号スイートは、ChaCha20-Poly1305暗号スイートの初期ドラフト版(ノンスとパディングが異なります)で、コードポイント`0xCC,0x13`から`0xCC,0x15`を使用します。 +これらはIANAに登録されたRFC 7905の暗号スイートではありません。 +これらはデフォルトでビルドに含まれ、提示されます。 +削除するには`NO_OLD_POLY1305`を定義してください。 + +### A-5 TLS 1.2 RSA(静的鍵交換) + +静的RSA鍵交換は前方秘匿性を提供しないため、推奨されません。 +これらの暗号スイートは、`--enable-all`を指定した場合でも、デフォルトではビルドに含まれません。 +これらには`WOLFSSL_STATIC_RSA`が必要ですが、対応するconfigureオプションはありません(`CPPFLAGS=-DWOLFSSL_STATIC_RSA`または`user_settings.h`を使用してください)。 +`WOLFSSL_SNIFFER`を定義すると、このマクロも自動的に定義されます。 + +| IANA名 | Wire Value | デフォルト | configureオプション | +|-----------|-----------|:-------:|-----------------| +| `TLS_RSA_WITH_AES_128_GCM_SHA256` | `0x00,0x9C` | 無効 | `-DWOLFSSL_STATIC_RSA` | +| `TLS_RSA_WITH_AES_256_GCM_SHA384` | `0x00,0x9D` | 無効 | `-DWOLFSSL_STATIC_RSA` | +| `TLS_RSA_WITH_AES_128_CBC_SHA` | `0x00,0x2F` | 無効 | `-DWOLFSSL_STATIC_RSA` | +| `TLS_RSA_WITH_AES_256_CBC_SHA` | `0x00,0x35` | 無効 | `-DWOLFSSL_STATIC_RSA` | +| `TLS_RSA_WITH_AES_128_CBC_SHA256` | `0x00,0x3C` | 無効 | `-DWOLFSSL_STATIC_RSA` | +| `TLS_RSA_WITH_AES_256_CBC_SHA256` | `0x00,0x3D` | 無効 | `-DWOLFSSL_STATIC_RSA` | +| `TLS_RSA_WITH_AES_128_CCM_8` | `0xC0,0xA0` | 無効 | `-DWOLFSSL_STATIC_RSA` + `--enable-aesccm` | +| `TLS_RSA_WITH_AES_256_CCM_8` | `0xC0,0xA1` | 無効 | `-DWOLFSSL_STATIC_RSA` + `--enable-aesccm` | +| `SSL_RSA_WITH_3DES_EDE_CBC_SHA` | `0x00,0x0A` | 無効 | `-DWOLFSSL_STATIC_RSA` + `--enable-des3` + `--enable-des3-tls-suites` | +| `SSL_RSA_WITH_RC4_128_SHA` | `0x00,0x05` | 無効 | `-DWOLFSSL_STATIC_RSA` + `--enable-arc4` | +| `SSL_RSA_WITH_RC4_128_MD5` | `0x00,0x04` | 無効 | `-DWOLFSSL_STATIC_RSA` + `--enable-arc4` + `--enable-md5` | +| `TLS_RSA_WITH_NULL_MD5` | `0x00,0x01` | 無効 | `-DWOLFSSL_STATIC_RSA` + `--enable-nullcipher` + `--enable-md5` | +| `TLS_RSA_WITH_NULL_SHA` | `0x00,0x02` | 無効 | `-DWOLFSSL_STATIC_RSA` + `--enable-nullcipher` | +| `TLS_RSA_WITH_NULL_SHA256` | `0x00,0x3B` | 無効 | `-DWOLFSSL_STATIC_RSA` + `--enable-nullcipher` | +| `TLS_RSA_WITH_CAMELLIA_128_CBC_SHA` | `0x00,0x41` | 無効 | `-DWOLFSSL_STATIC_RSA` + `--enable-camellia` | +| `TLS_RSA_WITH_CAMELLIA_256_CBC_SHA` | `0x00,0x84` | 無効 | `-DWOLFSSL_STATIC_RSA` + `--enable-camellia` | +| `TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256` | `0x00,0xBA` | 無効 | `-DWOLFSSL_STATIC_RSA` + `--enable-camellia` | +| `TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256` | `0x00,0xC0` | 無効 | `-DWOLFSSL_STATIC_RSA` + `--enable-camellia` | + +### A-6 TLS 1.2 静的ECDH + +静的ECDH鍵交換は前方秘匿性を提供しないため、推奨されません。 +これらの暗号スイートには`WOLFSSL_STATIC_DH`(およびECC)が必要ですが、対応するconfigureオプションはありません(`CPPFLAGS=-DWOLFSSL_STATIC_DH`または`user_settings.h`を使用してください)。 +`WOLFSSL_SNIFFER`を定義すると、このマクロも自動的に定義されます。 + +| IANA名 | Wire Value | デフォルト | configureオプション | +|-----------|-----------|:-------:|-----------------| +| `TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256` | `0xC0,0x31` | 無効 | `-DWOLFSSL_STATIC_DH` | +| `TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384` | `0xC0,0x32` | 無効 | `-DWOLFSSL_STATIC_DH` | +| `TLS_ECDH_RSA_WITH_AES_128_CBC_SHA` | `0xC0,0x0E` | 無効 | `-DWOLFSSL_STATIC_DH` | +| `TLS_ECDH_RSA_WITH_AES_256_CBC_SHA` | `0xC0,0x0F` | 無効 | `-DWOLFSSL_STATIC_DH` | +| `TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256` | `0xC0,0x29` | 無効 | `-DWOLFSSL_STATIC_DH` | +| `TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384` | `0xC0,0x2A` | 無効 | `-DWOLFSSL_STATIC_DH` | +| `TLS_ECDH_RSA_WITH_RC4_128_SHA` | `0xC0,0x0C` | 無効 | `-DWOLFSSL_STATIC_DH` + `--enable-arc4` | +| `TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA` | `0xC0,0x0D` | 無効 | `-DWOLFSSL_STATIC_DH` + `--enable-des3` + `--enable-des3-tls-suites` | +| `TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256` | `0xC0,0x2D` | 無効 | `-DWOLFSSL_STATIC_DH` | +| `TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384` | `0xC0,0x2E` | 無効 | `-DWOLFSSL_STATIC_DH` | +| `TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA` | `0xC0,0x04` | 無効 | `-DWOLFSSL_STATIC_DH` | +| `TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA` | `0xC0,0x05` | 無効 | `-DWOLFSSL_STATIC_DH` | +| `TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256` | `0xC0,0x25` | 無効 | `-DWOLFSSL_STATIC_DH` | +| `TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384` | `0xC0,0x26` | 無効 | `-DWOLFSSL_STATIC_DH` | +| `TLS_ECDH_ECDSA_WITH_RC4_128_SHA` | `0xC0,0x02` | 無効 | `-DWOLFSSL_STATIC_DH` + `--enable-arc4` | +| `TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA` | `0xC0,0x03` | 無効 | `-DWOLFSSL_STATIC_DH` + `--enable-des3` + `--enable-des3-tls-suites` | + +### A-7 TLS 1.2 PSK + +AESまたはNULL暗号を使用する純粋なPSK暗号スイートには、`WOLFSSL_STATIC_PSK`も必要です。 +このマクロは`--enable-psk`では定義されません(`CPPFLAGS=-DWOLFSSL_STATIC_PSK`または`user_settings.h`を使用してください)。 +`TLS_PSK_WITH_CHACHA20_POLY1305_SHA256`、DHE-PSK暗号スイート、ECDHE-PSK暗号スイートに必要なのは`--enable-psk`のみです。 + +| IANA名 | Wire Value | デフォルト | configureオプション | +|-----------|-----------|:-------:|-----------------| +| `TLS_PSK_WITH_AES_128_GCM_SHA256` | `0x00,0xA8` | 無効 | `--enable-psk` + `-DWOLFSSL_STATIC_PSK` | +| `TLS_PSK_WITH_AES_256_GCM_SHA384` | `0x00,0xA9` | 無効 | `--enable-psk` + `-DWOLFSSL_STATIC_PSK` | +| `TLS_PSK_WITH_AES_128_CBC_SHA256` | `0x00,0xAE` | 無効 | `--enable-psk` + `-DWOLFSSL_STATIC_PSK` | +| `TLS_PSK_WITH_AES_256_CBC_SHA384` | `0x00,0xAF` | 無効 | `--enable-psk` + `-DWOLFSSL_STATIC_PSK` | +| `TLS_PSK_WITH_AES_128_CBC_SHA` | `0x00,0x8C` | 無効 | `--enable-psk` + `-DWOLFSSL_STATIC_PSK` | +| `TLS_PSK_WITH_AES_256_CBC_SHA` | `0x00,0x8D` | 無効 | `--enable-psk` + `-DWOLFSSL_STATIC_PSK` | +| `TLS_PSK_WITH_AES_128_CCM` | `0xC0,0xA4` | 無効 | `--enable-psk` + `-DWOLFSSL_STATIC_PSK` + `--enable-aesccm` | +| `TLS_PSK_WITH_AES_256_CCM` | `0xC0,0xA5` | 無効 | `--enable-psk` + `-DWOLFSSL_STATIC_PSK` + `--enable-aesccm` | +| `TLS_PSK_WITH_AES_128_CCM_8` | `0xC0,0xA8` | 無効 | `--enable-psk` + `-DWOLFSSL_STATIC_PSK` + `--enable-aesccm` | +| `TLS_PSK_WITH_AES_256_CCM_8` | `0xC0,0xA9` | 無効 | `--enable-psk` + `-DWOLFSSL_STATIC_PSK` + `--enable-aesccm` | | `TLS_PSK_WITH_CHACHA20_POLY1305_SHA256` | `0xCC,0xAB` | 無効 | `--enable-psk` + `--enable-chacha` | -| `TLS_PSK_WITH_NULL_SHA256` | `0x00,0xB0` | 無効 | `--enable-psk` + `--enable-nullcipher` | -| `TLS_PSK_WITH_NULL_SHA384` | `0x00,0xB1` | 無効 | `--enable-psk` + `--enable-nullcipher` | -| `TLS_PSK_WITH_NULL_SHA` | `0x00,0x2C` | 無効 | `--enable-psk` + `--enable-nullcipher` | - -### A-8. TLS 1.2 DHE-PSK - -| IANA名 | Wire ID | デフォルト | configureオプション | -|--------|---------|:----------:|---------------------| -| `TLS_DHE_PSK_WITH_AES_128_GCM_SHA256` | `0x00,0xAA` | 無効 | `--enable-psk` + `--enable-dh` | -| `TLS_DHE_PSK_WITH_AES_256_GCM_SHA384` | `0x00,0xAB` | 無効 | `--enable-psk` + `--enable-dh` | -| `TLS_DHE_PSK_WITH_AES_128_CBC_SHA256` | `0x00,0xB2` | 無効 | `--enable-psk` + `--enable-dh` | -| `TLS_DHE_PSK_WITH_AES_256_CBC_SHA384` | `0x00,0xB3` | 無効 | `--enable-psk` + `--enable-dh` | -| `TLS_DHE_PSK_WITH_AES_128_CCM` | `0xC0,0xA6` | 無効 | `--enable-psk` + `--enable-dh` + `--enable-aesccm` | -| `TLS_DHE_PSK_WITH_AES_256_CCM` | `0xC0,0xA7` | 無効 | `--enable-psk` + `--enable-dh` + `--enable-aesccm` | -| `TLS_DHE_PSK_WITH_CHACHA20_POLY1305_SHA256` | `0xCC,0xAD` | 無効 | `--enable-psk` + `--enable-dh` + `--enable-chacha` | -| `TLS_DHE_PSK_WITH_NULL_SHA256` | `0x00,0xB4` | 無効 | `--enable-psk` + `--enable-dh` + `--enable-nullcipher` | -| `TLS_DHE_PSK_WITH_NULL_SHA384` | `0x00,0xB5` | 無効 | `--enable-psk` + `--enable-dh` + `--enable-nullcipher` | - -### A-9. TLS 1.2 ECDHE-PSK - -| IANA名 | Wire ID | デフォルト | configureオプション | -|--------|---------|:----------:|---------------------| +| `TLS_PSK_WITH_NULL_SHA256` | `0x00,0xB0` | 無効 | `--enable-psk` + `-DWOLFSSL_STATIC_PSK` + `--enable-nullcipher` | +| `TLS_PSK_WITH_NULL_SHA384` | `0x00,0xB1` | 無効 | `--enable-psk` + `-DWOLFSSL_STATIC_PSK` + `--enable-nullcipher` | +| `TLS_PSK_WITH_NULL_SHA` | `0x00,0x2C` | 無効 | `--enable-psk` + `-DWOLFSSL_STATIC_PSK` + `--enable-nullcipher` | + +### A-8 TLS 1.2 DHE-PSK + +| IANA名 | Wire Value | デフォルト | configureオプション | +|-----------|-----------|:-------:|-----------------| +| `TLS_DHE_PSK_WITH_AES_128_GCM_SHA256` | `0x00,0xAA` | 無効 | `--enable-psk` | +| `TLS_DHE_PSK_WITH_AES_256_GCM_SHA384` | `0x00,0xAB` | 無効 | `--enable-psk` | +| `TLS_DHE_PSK_WITH_AES_128_CBC_SHA256` | `0x00,0xB2` | 無効 | `--enable-psk` | +| `TLS_DHE_PSK_WITH_AES_256_CBC_SHA384` | `0x00,0xB3` | 無効 | `--enable-psk` | +| `TLS_DHE_PSK_WITH_AES_128_CCM` | `0xC0,0xA6` | 無効 | `--enable-psk` + `--enable-aesccm` | +| `TLS_DHE_PSK_WITH_AES_256_CCM` | `0xC0,0xA7` | 無効 | `--enable-psk` + `--enable-aesccm` | +| `TLS_DHE_PSK_WITH_CHACHA20_POLY1305_SHA256` | `0xCC,0xAD` | 無効 | `--enable-psk` + `--enable-chacha` | +| `TLS_DHE_PSK_WITH_NULL_SHA256` | `0x00,0xB4` | 無効 | `--enable-psk` + `--enable-nullcipher` | +| `TLS_DHE_PSK_WITH_NULL_SHA384` | `0x00,0xB5` | 無効 | `--enable-psk` + `--enable-nullcipher` | + +### A-9 TLS 1.2 ECDHE-PSK + +| IANA名 | Wire Value | デフォルト | configureオプション | +|-----------|-----------|:-------:|-----------------| | `TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256` | `0xC0,0x37` | 無効 | `--enable-psk` + `--enable-supportedcurves` | | `TLS_ECDHE_PSK_WITH_AES_128_GCM_SHA256` | `0xD0,0x01` | 無効 | `--enable-psk` + `--enable-supportedcurves` | | `TLS_ECDHE_PSK_WITH_CHACHA20_POLY1305_SHA256` | `0xCC,0xAC` | 無効 | `--enable-psk` + `--enable-chacha` | | `TLS_ECDHE_PSK_WITH_NULL_SHA256` | `0xC0,0x3A` | 無効 | `--enable-psk` + `--enable-nullcipher` | -### A-10. TLS 1.2 DH_anon +### A-10 TLS 1.2 DH_anon -| IANA名 | Wire ID | デフォルト | configureオプション | -|--------|---------|:----------:|---------------------| +| IANA名 | Wire Value | デフォルト | configureオプション | +|-----------|-----------|:-------:|-----------------| | `TLS_DH_anon_WITH_AES_128_CBC_SHA` | `0x00,0x34` | 無効 | `--enable-anon` | | `TLS_DH_anon_WITH_AES_256_GCM_SHA384` | `0x00,0xA7` | 無効 | `--enable-anon` | +### A-11 シグナリング値とプライベート値 + +| 名前 | Wire Value | デフォルト | configureオプション | +|------|-----------|:-------:|-----------------| +| `TLS_EMPTY_RENEGOTIATION_INFO_SCSV` | `0x00,0xFF` | 無効 | `--enable-renegotiation-indication`(クライアントが送信します。デフォルトの`--enable-secure-renegotiation-info`が有効なサーバーはこれを認識します) | +| `WDM_WITH_NULL_SHA256` | `0x00,0xFE` | 無効 | `--enable-mcast`(wolfSSL DTLSマルチキャスト。DTLSとNULL暗号も有効にします) | + +`--enable-harden-tls`(RFC 9325)はDHEおよびRC4暗号スイートを除外し、`--enable-harden-tls=128`の場合は3DES暗号スイートも除外します。 +このオプションは、NULL、静的RSA、静的DH、匿名の各暗号スイートとは併用できません(ビルドがエラーで停止します)。 + --- ## B. 鍵交換グループ -### B-1. NIST楕円曲線 +### B-1 NIST楕円曲線 | グループ名 | ID | デフォルト | configureオプション | -|------------|:---:|:----------:|---------------------| +|------------|:--:|:-------:|-----------------| | `secp256r1` (P-256) | 23 | **有効** | `--enable-ecc` | | `secp384r1` (P-384) | 24 | **有効** | `--enable-ecc` | | `secp521r1` (P-521) | 25 | **有効** | `--enable-ecc` | -| `secp192r1` (P-192) | 19 | 無効 | `--enable-ecc`(TLS 1.2のみ) | -| `secp224r1` (P-224) | 21 | 無効 | `--enable-ecc`(TLS 1.2のみ) | +| `secp224r1` (P-224) | 21 | **有効** | `--enable-ecc` | +| `secp192r1` (P-192) | 19 | 無効 | `--with-eccminsz=192` | +| `secp160r1` | 16 | 無効 | `--with-eccminsz=160` | +| `secp160r2` | 17 | 無効 | `--enable-ecccustcurves=all` + `--with-eccminsz=160` | + +ECC鍵の最小サイズ(`ECC_MIN_KEY_SZ`、`--with-eccminsz`で設定)はデフォルトで224ビット(FIPSビルドでは192ビット)であるため、P-224より小さい曲線を使用するには最小サイズを下げる必要があります。 +これらの曲線のうち、RFC 8446がTLS 1.3向けに定義しているのは`secp256r1`、`secp384r1`、`secp521r1`のみですが、wolfSSLは他の曲線をプロトコルバージョンによって除外しません。 -### B-2. Koblitz曲線 +### B-2 Koblitz曲線 | グループ名 | ID | デフォルト | configureオプション | -|------------|:---:|:----------:|---------------------| -| `secp160k1` | 15 | 無効 | `--enable-ecccustcurves` | -| `secp192k1` | 18 | 無効 | `--enable-ecccustcurves` | -| `secp224k1` | 20 | 無効 | `--enable-ecccustcurves` | -| `secp256k1` | 22 | 無効 | `--enable-ecccustcurves` | +|------------|:--:|:-------:|-----------------| +| `secp160k1` | 15 | 無効 | `--enable-ecccustcurves=all` + `--with-eccminsz=160` | +| `secp192k1` | 18 | 無効 | `--enable-ecccustcurves=all` + `--with-eccminsz=192` | +| `secp224k1` | 20 | 無効 | `--enable-ecccustcurves=all` | +| `secp256k1` | 22 | 無効 | `--enable-ecccustcurves=all` | -### B-3. Brainpool曲線 +値を指定しない`--enable-ecccustcurves`では`WOLFSSL_CUSTOM_CURVES`のみが定義されます。 +Koblitz曲線(`HAVE_ECC_KOBLITZ`)には`--enable-ecccustcurves=all`(または`--enable-all`)が必要です。 + +### B-3 Brainpool曲線 | グループ名 | ID | TLS版 | デフォルト | configureオプション | -|------------|:---:|:-----:|:----------:|---------------------| -| `brainpoolP256r1` | 26 | 1.2 | 無効 | `--enable-ecccustcurves` + `--enable-brainpool` | -| `brainpoolP384r1` | 27 | 1.2 | 無効 | `--enable-ecccustcurves` + `--enable-brainpool` | -| `brainpoolP512r1` | 28 | 1.2 | 無効 | `--enable-ecccustcurves` + `--enable-brainpool` | -| `brainpoolP256r1tls13` | 31 | 1.3 | 無効 | `--enable-ecccustcurves` + `--enable-brainpool` | -| `brainpoolP384r1tls13` | 32 | 1.3 | 無効 | `--enable-ecccustcurves` + `--enable-brainpool` | -| `brainpoolP512r1tls13` | 33 | 1.3 | 無効 | `--enable-ecccustcurves` + `--enable-brainpool` | +|------------|:--:|:--------:|:-------:|-----------------| +| `brainpoolP256r1` | 26 | 1.2 | 無効 | `--enable-ecccustcurves` | +| `brainpoolP384r1` | 27 | 1.2 | 無効 | `--enable-ecccustcurves` | +| `brainpoolP512r1` | 28 | 1.2 | 無効 | `--enable-ecccustcurves` | +| `brainpoolP256r1tls13` | 31 | 1.3 | 無効 | `--enable-ecccustcurves` | +| `brainpoolP384r1tls13` | 32 | 1.3 | 無効 | `--enable-ecccustcurves` | +| `brainpoolP512r1tls13` | 33 | 1.3 | 無効 | `--enable-ecccustcurves` | -### B-4. X25519 / X448 +### B-4 X25519 / X448 | グループ名 | ID | デフォルト | configureオプション | -|------------|:---:|:----------:|---------------------| +|------------|:--:|:-------:|-----------------| | `x25519` | 29 | 無効 | `--enable-curve25519` | | `x448` | 30 | 無効 | `--enable-curve448` | -### B-5. FFDHE +### B-5 FFDHE | グループ名 | ID | デフォルト | configureオプション | -|------------|:---:|:----------:|---------------------| +|------------|:--:|:-------:|-----------------| | `ffdhe2048` | 256 | 条件付き有効 | `--enable-dh`(TLS 1.3+DH有効時に自動設定) | | `ffdhe3072` | 257 | 無効 | `-DHAVE_FFDHE_3072` | | `ffdhe4096` | 258 | 無効 | `-DHAVE_FFDHE_4096` | | `ffdhe6144` | 259 | 無効 | `-DHAVE_FFDHE_6144` | | `ffdhe8192` | 260 | 無効 | `-DHAVE_FFDHE_8192` | -### B-6. SM2 +### B-6 SM2 | グループ名 | ID | デフォルト | configureオプション | -|------------|:---:|:----------:|---------------------| +|------------|:--:|:-------:|-----------------| | `sm2p256v1` | 41 | 無効 | `--enable-sm2` | -### B-7. ML-KEMスタンドアロン +### B-7 ML-KEMスタンドアロン | グループ名 | ID | デフォルト | configureオプション | -|------------|:---:|:----------:|---------------------| -| `ML-KEM-512` | 512 | 無効 | `--enable-mlkem` + `--enable-tls-mlkem-standalone` | -| `ML-KEM-768` | 513 | 無効 | `--enable-mlkem` + `--enable-tls-mlkem-standalone` | -| `ML-KEM-1024` | 514 | 無効 | `--enable-mlkem` + `--enable-tls-mlkem-standalone` | +|------------|:--:|:-------:|-----------------| +| `ML_KEM_512` (alias `MLKEM512`) | 512 | 無効 | `--enable-mlkem` + `--enable-tls-mlkem-standalone` | +| `ML_KEM_768` (alias `MLKEM768`) | 513 | 無効 | `--enable-mlkem` + `--enable-tls-mlkem-standalone` | +| `ML_KEM_1024` (alias `MLKEM1024`) | 514 | 無効 | `--enable-mlkem` + `--enable-tls-mlkem-standalone` | -### B-8. ML-KEMハイブリッド(標準) +### B-8 ML-KEMハイブリッド(標準) | グループ名 | ID | デフォルト | configureオプション | -|------------|:---:|:----------:|---------------------| +|------------|:--:|:-------:|-----------------| | `SecP256r1MLKEM768` | 4587 | 条件付き有効 | `--enable-mlkem` + `--enable-pqc-hybrids` | | `X25519MLKEM768` | 4588 | 無効 | `--enable-mlkem` + `--enable-pqc-hybrids` + `--enable-curve25519` | | `SecP384r1MLKEM1024` | 4589 | 条件付き有効 | `--enable-mlkem` + `--enable-pqc-hybrids` | -### B-9. ML-KEMハイブリッド(実験的) +### B-9 ML-KEMハイブリッド(実験的) | グループ名 | ID | デフォルト | configureオプション | -|------------|:---:|:----------:|---------------------| +|------------|:--:|:-------:|-----------------| | `SecP256r1MLKEM512` | 12107 | 無効 | `--enable-extra-pqc-hybrids` + `--enable-experimental` | | `SecP384r1MLKEM768` | 12108 | 無効 | `--enable-extra-pqc-hybrids` + `--enable-experimental` | | `SecP521r1MLKEM1024` | 12109 | 無効 | `--enable-extra-pqc-hybrids` + `--enable-experimental` | | `X25519MLKEM512` | 12214 | 無効 | 同上 + `--enable-curve25519` | | `X448MLKEM768` | 12215 | 無効 | 同上 + `--enable-curve448` | +| `P256_ML_KEM_512_OLD` | 12103 | 無効 | 同上 + `-DWOLFSSL_ML_KEM_USE_OLD_IDS` | +| `P384_ML_KEM_768_OLD` | 12104 | 無効 | 同上 + `-DWOLFSSL_ML_KEM_USE_OLD_IDS` | +| `P521_ML_KEM_1024_OLD` | 12105 | 無効 | 同上 + `-DWOLFSSL_ML_KEM_USE_OLD_IDS` | + +`_OLD`のIDは、NIST曲線ハイブリッドの以前のコードポイントです。 +`WOLFSSL_ML_KEM_USE_OLD_IDS`を定義すると、それぞれ対応する新しいID(12107から12109)と一緒に送信されます。 -### B-10. Kyber Round 3 レガシー +### B-10 Kyber Round 3 レガシー | グループ名 | ID | デフォルト | configureオプション | -|------------|:---:|:----------:|---------------------| -| `KYBER_LEVEL1` | 570 | 無効 | `--enable-mlkem=original` | -| `KYBER_LEVEL3` | 572 | 無効 | `--enable-mlkem=original` | -| `KYBER_LEVEL5` | 573 | 無効 | `--enable-mlkem=original` | -| `P256_KYBER_LEVEL1` | 12090 | 無効 | `--enable-mlkem=original` | -| `P384_KYBER_LEVEL3` | 12092 | 無効 | `--enable-mlkem=original` | -| `P521_KYBER_LEVEL5` | 12093 | 無効 | `--enable-mlkem=original` | +|------------|:--:|:-------:|-----------------| +| `KYBER_LEVEL1` | 570 | 無効 | `--enable-mlkem=yes,original` | +| `KYBER_LEVEL3` | 572 | 無効 | `--enable-mlkem=yes,original` | +| `KYBER_LEVEL5` | 573 | 無効 | `--enable-mlkem=yes,original` | +| `P256_KYBER_LEVEL1` | 12090 | 無効 | `--enable-mlkem=yes,original` | +| `P384_KYBER_LEVEL3` | 12092 | 無効 | `--enable-mlkem=yes,original` | +| `P521_KYBER_LEVEL5` | 12093 | 無効 | `--enable-mlkem=yes,original` | | `X25519_KYBER_LEVEL1` | 12089 | 無効 | 同上 + `--enable-curve25519` | | `X25519_KYBER_LEVEL3` | 25497 | 無効 | 同上 + `--enable-curve25519` | | `X448_KYBER_LEVEL3` | 12176 | 無効 | 同上 + `--enable-curve448` | -| `P256_KYBER_LEVEL3` | 25498 | 無効 | `--enable-mlkem=original` | +| `P256_KYBER_LEVEL3` | 25498 | 無効 | `--enable-mlkem=yes,original` | + +`--enable-mlkem=original`のみでは、使用可能なKyberパラメータセットはビルドされません。 +`--enable-mlkem=yes,original`を使用してください。 +`original`を選択すると、`ml-kem`も併せて指定しない限り(`--enable-mlkem=yes,original,ml-kem`)、ML-KEMグループは無効になります。 --- ## C. 署名アルゴリズム -### C-1. ECDSA(NIST曲線) +### C-1 ECDSA(NIST曲線) | IANA名 | Wire Value | デフォルト | configureオプション | -|--------|-----------|:----------:|---------------------| +|-----------|-----------|:-------:|-----------------| | `ecdsa_secp256r1_sha256` | `0x04,0x03` | **有効** | `--enable-ecc` | | `ecdsa_secp384r1_sha384` | `0x05,0x03` | **有効** | `--enable-ecc` + `--enable-sha384` | | `ecdsa_secp521r1_sha512` | `0x06,0x03` | **有効** | `--enable-ecc` + `--enable-sha512` | -| `ecdsa_sha1` | `0x02,0x03` | 条件付き | `!NO_OLD_TLS` または `WOLFSSL_ALLOW_TLS_SHA1` | +| `ecdsa_sha1` | `0x02,0x03` | 無効 | TLS 1.0/1.1のハンドシェイク(`--enable-oldtls`)。TLS 1.2では`-DWOLFSSL_ALLOW_TLS_SHA1`指定時のみ(RFC 9155を参照) | -### C-2. ECDSA(Brainpool, TLS 1.3専用) +### C-2 ECDSA(Brainpool, TLS 1.3専用) | IANA名 | Wire Value | デフォルト | configureオプション | -|--------|-----------|:----------:|---------------------| -| `ecdsa_brainpoolP256r1tls13_sha256` | `0x08,0x1A` | 無効 | `--enable-ecccustcurves` + `--enable-brainpool` | +|-----------|-----------|:-------:|-----------------| +| `ecdsa_brainpoolP256r1tls13_sha256` | `0x08,0x1A` | 無効 | `--enable-ecccustcurves` | | `ecdsa_brainpoolP384r1tls13_sha384` | `0x08,0x1B` | 無効 | 同上 + `--enable-sha384` | | `ecdsa_brainpoolP512r1tls13_sha512` | `0x08,0x1C` | 無効 | 同上 + `--enable-sha512` | -### C-3. EdDSA +### C-3 EdDSA | IANA名 | Wire Value | デフォルト | configureオプション | -|--------|-----------|:----------:|---------------------| +|-----------|-----------|:-------:|-----------------| | `ed25519` | `0x08,0x07` | 無効 | `--enable-ed25519` | | `ed448` | `0x08,0x08` | 無効 | `--enable-ed448` | -### C-4. RSA-PSS RSAE +### C-4 RSA-PSS RSAE | IANA名 | Wire Value | デフォルト | configureオプション | -|--------|-----------|:----------:|---------------------| +|-----------|-----------|:-------:|-----------------| | `rsa_pss_rsae_sha256` | `0x08,0x04` | **有効** | `--enable-rsapss`(TLS 1.3時自動) | | `rsa_pss_rsae_sha384` | `0x08,0x05` | **有効** | `--enable-rsapss` + `--enable-sha384` | | `rsa_pss_rsae_sha512` | `0x08,0x06` | **有効** | `--enable-rsapss` + `--enable-sha512` | -### C-5. RSA-PSS PSS(TLS 1.3専用) +### C-5 RSA-PSS PSS(TLS 1.3専用) | IANA名 | Wire Value | デフォルト | configureオプション | -|--------|-----------|:----------:|---------------------| +|-----------|-----------|:-------:|-----------------| | `rsa_pss_pss_sha256` | `0x08,0x09` | **有効** | `--enable-tls13` + `--enable-rsapss` | | `rsa_pss_pss_sha384` | `0x08,0x0A` | **有効** | 同上 + `--enable-sha384` | | `rsa_pss_pss_sha512` | `0x08,0x0B` | **有効** | 同上 + `--enable-sha512` | -### C-6. RSA PKCS#1 v1.5 +### C-6 RSA PKCS#1 v1.5 | IANA名 | Wire Value | デフォルト | configureオプション | -|--------|-----------|:----------:|---------------------| -| `rsa_pkcs1_sha256` | `0x04,0x01` | **有効** | — | +|-----------|-----------|:-------:|-----------------| +| `rsa_pkcs1_sha256` | `0x04,0x01` | **有効** | - | | `rsa_pkcs1_sha384` | `0x05,0x01` | **有効** | `--enable-sha384` | | `rsa_pkcs1_sha512` | `0x06,0x01` | **有効** | `--enable-sha512` | | `rsa_pkcs1_sha224` | `0x03,0x01` | 条件付き | `--enable-sha224`(x86_64/aarch64でデフォルト有効) | -| `rsa_pkcs1_sha1` | `0x02,0x01` | 条件付き | `!NO_OLD_TLS` または `WOLFSSL_ALLOW_TLS_SHA1` | +| `rsa_pkcs1_sha1` | `0x02,0x01` | 無効 | TLS 1.0/1.1のハンドシェイク(`--enable-oldtls`)。TLS 1.2では`-DWOLFSSL_ALLOW_TLS_SHA1`指定時のみ(RFC 9155を参照) | -### C-7. SM2 +### C-7 SM2 | IANA名 | Wire Value | デフォルト | configureオプション | -|--------|-----------|:----------:|---------------------| +|-----------|-----------|:-------:|-----------------| | `sm2sig_sm3` | `0x07,0x08` | 無効 | `--enable-sm2` + `--enable-sm3` | -### C-8. ML-DSA / Dilithium +### C-8 ML-DSA / Dilithium | IANA名 | Wire Value | デフォルト | configureオプション | -|--------|-----------|:----------:|---------------------| +|-----------|-----------|:-------:|-----------------| | `mldsa44` (ML-DSA-44) | `0x09,0x04` | 無効 | `--enable-mldsa` | | `mldsa65` (ML-DSA-65) | `0x09,0x05` | 無効 | `--enable-mldsa` | | `mldsa87` (ML-DSA-87) | `0x09,0x06` | 無効 | `--enable-mldsa` | +### C-9 SLH-DSA (FIPS 205) + +Wire Valueはdraft-reddy-tls-slhdsaに基づくもので、oqs-providerが使用している値と同じです。 +SLH-DSAはTLS 1.3およびDTLS 1.3のハンドシェイクの署名に使用できます(wolfSSL 5.9.4で新規追加)。 + +| 名前 | Wire Value | デフォルト | configureオプション | +|------|-----------|:-------:|-----------------| +| `slhdsa_sha2_128s` | `0x09,0x11` | 無効 | `--enable-slhdsa=sha2` | +| `slhdsa_sha2_128f` | `0x09,0x12` | 無効 | `--enable-slhdsa=sha2` | +| `slhdsa_sha2_192s` | `0x09,0x13` | 無効 | `--enable-slhdsa=sha2` | +| `slhdsa_sha2_192f` | `0x09,0x14` | 無効 | `--enable-slhdsa=sha2` | +| `slhdsa_sha2_256s` | `0x09,0x15` | 無効 | `--enable-slhdsa=sha2` | +| `slhdsa_sha2_256f` | `0x09,0x16` | 無効 | `--enable-slhdsa=sha2` | +| `slhdsa_shake_128s` | `0x09,0x17` | 無効 | `--enable-slhdsa` | +| `slhdsa_shake_128f` | `0x09,0x18` | 無効 | `--enable-slhdsa` | +| `slhdsa_shake_192s` | `0x09,0x19` | 無効 | `--enable-slhdsa` | +| `slhdsa_shake_192f` | `0x09,0x1A` | 無効 | `--enable-slhdsa` | +| `slhdsa_shake_256s` | `0x09,0x1B` | 無効 | `--enable-slhdsa` | +| `slhdsa_shake_256f` | `0x09,0x1C` | 無効 | `--enable-slhdsa` | + +### C-10 Falcon(実験的) + +Falconは、以前のliboqs統合と共有していたプライベート用途のコードポイントを使用します。 +アルゴリズム自体は現在、wolfCryptにネイティブに実装されています。 + +| 名前 | Wire Value | デフォルト | configureオプション | +|------|-----------|:-------:|-----------------| +| `falcon_level1` (Falcon-512) | `0xFE,0xD7` | 無効 | `--enable-falcon` + `--enable-experimental` | +| `falcon_level5` (Falcon-1024) | `0xFE,0xDA` | 無効 | `--enable-falcon` + `--enable-experimental` | + --- -## D. configureオプション ↔ #define 対応表 +## D. configureオプションと#defineマクロの対応表 | configureオプション | #define マクロ | 備考 | -|---------------------|---------------|------| +|-----------------|--------------|-------| | `--enable-tls13` | `WOLFSSL_TLS13` | デフォルト有効 | | `--enable-ecc` | `HAVE_ECC` | デフォルト有効 | | `--enable-aesgcm` | `HAVE_AESGCM` | デフォルト有効 | @@ -344,24 +426,41 @@ | `--enable-sha512` | `WOLFSSL_SHA512` | デフォルト有効 | | `--enable-supportedcurves` | `HAVE_SUPPORTED_CURVES` + `HAVE_TLS_EXTENSIONS` | デフォルト有効 | | `--enable-aesccm` | `HAVE_AESCCM` | | -| `--enable-dh` | `HAVE_DH` | | +| `--enable-dh` | `HAVE_DH` | デフォルト有効(FIPS v7以降を除く) | | `--enable-psk` | `NO_PSK`を削除 | | | `--enable-rsapss` | `WC_RSA_PSS` | TLS 1.3時自動 | | `--enable-curve25519` | `HAVE_CURVE25519` | | | `--enable-curve448` | `HAVE_CURVE448` | | | `--enable-ed25519` | `HAVE_ED25519` | | | `--enable-ed448` | `HAVE_ED448` | | -| `--enable-ecccustcurves` | `WOLFSSL_CUSTOM_CURVES` | | -| `--enable-brainpool` | `HAVE_ECC_BRAINPOOL` | ecccustcurves必須 | +| `--enable-ecccustcurves` | `WOLFSSL_CUSTOM_CURVES` | `=all`を指定すると`HAVE_ECC_KOBLITZ`、`HAVE_ECC_SECPR2`、`HAVE_ECC_SECPR3`、`HAVE_ECC_BRAINPOOL`も定義 | +| `--enable-brainpool` | `HAVE_ECC_BRAINPOOL` | ecccustcurves必須。ecccustcurves有効時はデフォルト有効 | | `--enable-des3` | `NO_DES3`を除去 | | +| `--enable-des3-tls-suites` | `NO_DES3_TLS_SUITES`を除去 | 3DES暗号スイートに必要。`--enable-des3`必須 | | `--enable-arc4` | `NO_RC4`を除去 | | +| `--enable-md5` | `NO_MD5`を除去 | MD5ベースの暗号スイートに必要 | | `--enable-camellia` | `HAVE_CAMELLIA` | | | `--enable-aria` | `HAVE_ARIA` | | -| `--enable-nullcipher` | `HAVE_NULL_CIPHER` | 非推奨 | -| `--enable-anon` | `HAVE_ANON` | 非推奨 | +| `--enable-nullcipher` | `HAVE_NULL_CIPHER` | 非推奨(RFC 9325) | +| `--enable-anon` | `HAVE_ANON` | 非推奨(RFC 9325) | | `--enable-sm2` | `WOLFSSL_SM2` | | | `--enable-sm3` | `WOLFSSL_SM3` | | +| `--enable-sm4-cbc` | `WOLFSSL_SM4_CBC` | | | `--enable-sm4-gcm` | `WOLFSSL_SM4_GCM` | | -| `--enable-mlkem` | `WOLFSSL_HAVE_MLKEM` + `HAVE_PQC` | | +| `--enable-sm4-ccm` | `WOLFSSL_SM4_CCM` | | +| `--enable-mlkem` | `WOLFSSL_HAVE_MLKEM` | デフォルト有効(非FIPSまたはFIPS v7以降。SHA-3とSHAKEが必要) | | `--enable-pqc-hybrids` | `WOLFSSL_PQC_HYBRIDS` | mlkem有効時デフォルト有効 | -| `--enable-mldsa` | `HAVE_DILITHIUM` | | +| `--enable-mldsa` | `WOLFSSL_HAVE_MLDSA` | `HAVE_DILITHIUM`は旧来のエイリアス | +| `--enable-slhdsa` | `WOLFSSL_HAVE_SLHDSA` | TLS 1.3 / DTLS 1.3の認証に対応、5.9.4で新規追加 | +| `--enable-falcon` | `HAVE_FALCON` | ネイティブ実装、--enable-experimentalが必要 | +| `--enable-tls13-sha512` | `WOLFSSL_TLS13_SHA512` | TLS 1.3のみのビルドでSHA-512トランスクリプトを保持 | +| `--disable-tlsv12` | `WOLFSSL_NO_TLS12` | TLS 1.2をビルドから除外(5.9.4以降) | +| `--with-eccminsz=BITS` | `ECC_MIN_KEY_SZ` | デフォルト224(FIPSでは192) | +| `--enable-mcast` | `WOLFSSL_MULTICAST` | DTLSとNULL暗号も有効化 | +| `--enable-renegotiation-indication` | `HAVE_RENEGOTIATION_INDICATION` | クライアントが`TLS_EMPTY_RENEGOTIATION_INFO_SCSV`を送信 | +| `--enable-harden-tls` | `WOLFSSL_HARDEN_TLS` | RFC 9325の要件。`=112`(`yes`と同じ)または`=128` | +| (CFLAGS) | `WOLFSSL_STATIC_RSA` | 静的RSA暗号スイート、前方秘匿性なし | +| (CFLAGS) | `WOLFSSL_STATIC_DH` | 静的ECDH暗号スイート、前方秘匿性なし | +| (CFLAGS) | `WOLFSSL_STATIC_PSK` | AESまたはNULL暗号を使用する純粋なPSK暗号スイート | +| (CFLAGS) | `NO_OLD_POLY1305` | `_OLD_POLY1305` ChaCha20-Poly1305暗号スイートを除去 | +| (CFLAGS) | `WOLFSSL_ALLOW_TLS_SHA1` | TLS 1.2でSHA-1署名アルゴリズムを提示 | diff --git a/wolfSSL/src-ja/appendix08.md b/wolfSSL/src-ja/appendix08.md index 104867c9..e1c3d41d 100644 --- a/wolfSSL/src-ja/appendix08.md +++ b/wolfSSL/src-ja/appendix08.md @@ -2,40 +2,63 @@ ## A. アーキテクチャ別 ISA/SIMD 最適化 +以下のアセンブリ最適化は、デフォルトの `./configure` ではいずれも有効になりません。 +`--enable-all-asm` は、ビルドホストに該当する最適化を有効にします(x86-64 では `--enable-intelasm` と SP アセンブリ、AArch64 では `--enable-armasm` と SP アセンブリ、PowerPC ホストでは PowerPC アセンブリ)。 +また、ほとんどのホストでは、`--enable-all-crypto`(したがって `--enable-all`)を指定した場合にも `--enable-all-asm` がデフォルトで有効になります。 + | アーキテクチャ | アルゴリズム | user_settings.h マクロ | configure オプション | 備考 | |---|---|---|---|---| | **Intel x86-64** | AES(全モード) | `WOLFSSL_AESNI` | `--enable-aesni` | AES-NI 命令 | -| Intel x86-64 | SHA-256, SHA-512 | `USE_INTEL_SPEEDUP` + `HAVE_INTEL_AVX1` | 自動検出 | AVX1 アセンブリ | -| Intel x86-64 | SHA-512, SHA-3 | `USE_INTEL_SPEEDUP` + `HAVE_INTEL_AVX2` | 自動検出 | AVX2 アセンブリ | -| Intel x86-64 | ChaCha20, Poly1305 | `USE_INTEL_SPEEDUP` | 自動検出 | | -| Intel x86-64 | X25519 (Curve25519), Ed25519 | `USE_INTEL_SPEEDUP` | 自動検出 | fe_x25519_asm.S | -| Intel x86-64 | RSA/ECC/DH (SP) | `WOLFSSL_SP_X86_64_ASM` | 自動検出 | sp_x86_64_asm.S | -| **ARM AArch64** | AES, SHA-256/512, SHA-3, ChaCha20, Poly1305 | `WOLFSSL_ARMASM` | `--enable-armasm` | ARMv8 CE (Crypto Extension) | +| Intel x86-64 | SHA-256, SHA-512 | `USE_INTEL_SPEEDUP` | `--enable-intelasm` | `HAVE_INTEL_AVX1` / `HAVE_INTEL_AVX2` は内部で定義され、AVX1 と AVX2 のどちらのコードを使用するかは実行時に選択されます | +| Intel x86-64 | SHA-3 | `USE_INTEL_SPEEDUP` | `--enable-intelasm` | sha3_asm.S | +| Intel x86-64 | ChaCha20, Poly1305 | `USE_INTEL_SPEEDUP` | `--enable-intelasm` | | +| Intel x86-64 | X25519 (Curve25519), Ed25519 | `USE_INTEL_SPEEDUP` | `--enable-intelasm` | fe_x25519_asm.S | +| Intel x86-64 | ML-KEM, ML-DSA, FrodoKEM | `USE_INTEL_SPEEDUP` | `--enable-intelasm` | wc_mlkem_asm.S, wc_mldsa_asm.S, wc_frodokem_asm.S | +| Intel x86-64 | SM3 | `USE_INTEL_SPEEDUP` | `--enable-intelasm` + `--enable-sm3` | sm3_asm.S(SM アルゴリズムには wolfSM が必要です。付録K をご参照ください) | +| Intel x86-64 | Falcon | - | `--enable-falcon=asm` + `--enable-experimental` | wc_falcon_fpr_x86_64_asm.S | +| Intel x86-64 | RSA/ECC/DH (SP) | `WOLFSSL_SP_X86_64_ASM` | `--enable-sp --enable-sp-asm` | sp_x86_64_asm.S | +| **Intel x86 (32-bit)** | AES, AES-XTS | `WOLFSSL_AESNI` | `--enable-aesni` | aes_asm.S, aes_xts_x86_asm.S(32-bit の AES-GCM は、AES-NI と C 実装の GHASH を組み合わせて使用します) | +| **ARM AArch64** | AES, SHA-1, SHA-256/512, SHA-3, ChaCha20, Poly1305 | `WOLFSSL_ARMASM` | `--enable-armasm` | ARMv8 CE (Crypto Extension) | | ARM AArch64 | X25519 (Curve25519), Ed25519 | `WOLFSSL_ARMASM` | `--enable-armasm` | armv8-curve25519.S | -| ARM AArch64 | RSA/ECC/DH (SP) | `WOLFSSL_SP_ARM64_ASM` | 自動検出 | sp_arm64.c | +| ARM AArch64 | ML-KEM, ML-DSA, FrodoKEM | `WOLFSSL_ARMASM` | `--enable-armasm` | armv8-mlkem-asm.S, armv8-mldsa-asm.S, armv8-frodokem-asm.S | +| ARM AArch64 | RSA/ECC/DH (SP) | `WOLFSSL_SP_ARM64_ASM` | `--enable-sp --enable-sp-asm` | sp_arm64.c | | **ARM 32-bit (ARMv8-32)** | AES, SHA-256/512, SHA-3, ChaCha20, Poly1305 | `WOLFSSL_ARMASM` | `--enable-armasm` | | | ARM 32-bit | X25519 (Curve25519), Ed25519 | `WOLFSSL_ARMASM` | `--enable-armasm` | armv8-32-curve25519.S | -| ARM 32-bit | RSA/ECC/DH (SP) | `WOLFSSL_SP_ARM32_ASM` | 自動検出 | sp_arm32.c | -| **ARM Thumb2** | X25519 (Curve25519), Ed25519 | `WOLFSSL_ARMASM` + `WOLFSSL_ARMASM_THUMB2` | `--enable-armasm` | thumb2-curve25519.S | -| **ARM Thumb** | RSA/ECC/DH (SP) | `WOLFSSL_SP_ARM_THUMB_ASM` | 自動検出 | sp_armthumb.c | -| **ARM Cortex-M** | RSA/ECC/DH (SP) | `WOLFSSL_SP_ARM_CORTEX_M_ASM` | 自動検出 | sp_cortexm.c | -| **RISC-V 64-bit** | AES, SHA-256/512, SHA-3, ChaCha20, Poly1305 | `WOLFSSL_RISCV_ASM` | `--enable-riscv` | riscv/riscv-64-*.c | -| **PowerPC 32-bit** | SHA-256 | `WOLFSSL_PPC32_ASM` | 自動検出 | ppc32/ppc32-sha256-asm.S | +| ARM 32-bit | ML-KEM, ML-DSA, FrodoKEM | `WOLFSSL_ARMASM` | `--enable-armasm` | armv8-32-mlkem-asm.S, armv8-32-mldsa-asm.S, armv8-32-frodokem-asm.S | +| ARM 32-bit | RSA/ECC/DH (SP) | `WOLFSSL_SP_ARM32_ASM` | `--enable-sp --enable-sp-asm` | sp_arm32.c | +| **ARM Thumb2** | AES, SHA-256/512, SHA-3, ChaCha20, Poly1305, X25519 (Curve25519), Ed25519, ML-KEM, FrodoKEM | `WOLFSSL_ARMASM` + `WOLFSSL_ARMASM_THUMB2` | `--enable-armasm` | thumb2-*-asm.S, thumb2-curve25519.S | +| **ARM Thumb** | RSA/ECC/DH (SP) | `WOLFSSL_SP_ARM_THUMB_ASM` | `--enable-sp --enable-sp-asm` | sp_armthumb.c | +| **ARM Cortex-M** | RSA/ECC/DH (SP) | `WOLFSSL_SP_ARM_CORTEX_M_ASM` | `--enable-sp --enable-sp-asm` | sp_cortexm.c | +| **RISC-V 64-bit** | AES, SHA-256/512, SHA-3, ChaCha20, Poly1305 | `WOLFSSL_RISCV_ASM` | `--enable-riscv-asm` | port/riscv64/riscv-64-*-asm.S | +| RISC-V 64-bit | RSA/ECC/DH (SP) | `WOLFSSL_SP_RISCV64_ASM` | `--enable-sp --enable-sp-asm` | sp_riscv64.c | +| **PowerPC 32-bit** | AES, SHA-256, SHA-512, SHA-3 | `WOLFSSL_PPC32_ASM` | `--enable-ppc32-asm` | port/ppc32/ppc32-*-asm.S | +| **PowerPC 64-bit** | AES, SHA-256, SHA-512, SHA-3 | `WOLFSSL_PPC64_ASM` | `--enable-ppc64-asm` | port/ppc64/ppc64-*-asm.S | +| **Qualcomm Hexagon DSP** | ECC P-256 検証 (SP) | `WOLFSSL_DSP` | user_settings.h | sp_dsp32.c、IDE/HEXAGON を参照 | + +SP アセンブリマクロ(`WOLFSSL_SP_*_ASM`)を使用するには、SP 実装(`--enable-sp`、デフォルトで無効)と `--enable-sp-asm` の両方が必要です。 +その場合、configure がホスト CPU に対応するマクロを選択します。 +`--enable-sp-asm` がデフォルトで有効になるのは、x86-64 と AArch64 で制限付きの `--enable-sp-math` を選択した場合のみです。 +デフォルトの数学ライブラリは `sp_int.c`(`WOLFSSL_SP_MATH_ALL`)です。 ## B. SP 数学ライブラリ(公開鍵暗号) | アーキテクチャ | 対応アルゴリズム | user_settings.h マクロ | configure オプション | |---|---|---|---| -| x86-64 アセンブリ | RSA 2048/3072/4096, ECC P-256/P-384/P-521, DH | `WOLFSSL_SP_X86_64_ASM` | 自動検出 | -| ARM AArch64 アセンブリ | RSA, ECC, DH | `WOLFSSL_SP_ARM64_ASM` | 自動検出 | -| ARM 32-bit アセンブリ | RSA, ECC, DH | `WOLFSSL_SP_ARM32_ASM` | 自動検出 | -| ARM Thumb アセンブリ | RSA, ECC, DH | `WOLFSSL_SP_ARM_THUMB_ASM` | 自動検出 | -| Cortex-M アセンブリ | RSA, ECC, DH | `WOLFSSL_SP_ARM_CORTEX_M_ASM` | 自動検出 | -| 汎用 C (32-bit / 64-bit) | RSA, ECC, DH | `WOLFSSL_SP_MATH` | `--enable-sp` | +| x86-64 アセンブリ | RSA 2048/3072/4096, ECC P-256/P-384/P-521, DH | `WOLFSSL_SP_X86_64_ASM` | `--enable-sp --enable-sp-asm` | +| ARM AArch64 アセンブリ | RSA, ECC, DH | `WOLFSSL_SP_ARM64_ASM` | `--enable-sp --enable-sp-asm` | +| ARM 32-bit アセンブリ | RSA, ECC, DH | `WOLFSSL_SP_ARM32_ASM` | `--enable-sp --enable-sp-asm` | +| ARM Thumb アセンブリ | RSA, ECC, DH | `WOLFSSL_SP_ARM_THUMB_ASM` | `--enable-sp --enable-sp-asm` | +| Cortex-M アセンブリ | RSA, ECC, DH | `WOLFSSL_SP_ARM_CORTEX_M_ASM` | `--enable-sp --enable-sp-asm` | +| RISC-V 64-bit アセンブリ | RSA, ECC, DH | `WOLFSSL_SP_RISCV64_ASM` | `--enable-sp --enable-sp-asm` | +| 汎用 C (32-bit / 64-bit) | RSA, ECC, DH | `WOLFSSL_HAVE_SP_RSA`, `WOLFSSL_HAVE_SP_DH`, `WOLFSSL_HAVE_SP_ECC` | `--enable-sp` | + +`--enable-sp` は汎用 C 実装(sp_c32.c / sp_c64.c)をビルドし、`WOLFSSL_HAVE_SP_RSA`、`WOLFSSL_HAVE_SP_DH`、`WOLFSSL_HAVE_SP_ECC` を定義します。 +`WOLFSSL_SP_MATH`(`--enable-sp-math`)は、SP が実装している鍵長と曲線のみをサポートする制限付きモードです。 ### sp_int.c インラインアセンブリ高速化 -`sp_int.c` には、アーキテクチャ専用 SP ファイル(例:`sp_x86_64.c`)が存在しない場合や、RSA/ECC 以外の鍵長に対応するため、多倍長整数の乗算・加算向けの小規模インラインアセンブリが含まれています。以下のマクロで制御されます(自動検出、または `user_settings.h` で明示設定可): +`sp_int.c` には、アーキテクチャ専用 SP ファイル(例:`sp_x86_64.c`)が存在しない場合や、RSA/ECC 以外の鍵長に対応するため、多倍長整数の乗算・加算向けの小規模インラインアセンブリが含まれています。 +以下のマクロで制御されます(自動検出、または `user_settings.h` で明示設定可): | アーキテクチャ | user_settings.h マクロ | |---|---| @@ -43,7 +66,10 @@ | Intel x86 (32-bit) | `WOLFSSL_SP_X86` | | ARM AArch64 | `WOLFSSL_SP_ARM64` | | ARM 32-bit | `WOLFSSL_SP_ARM32` | +| ARM Cortex-M | `WOLFSSL_SP_ARM_CORTEX_M` | | ARM Thumb | `WOLFSSL_SP_ARM_THUMB` | +| PowerPC 64-bit | `WOLFSSL_SP_PPC64` | +| PowerPC 32-bit | `WOLFSSL_SP_PPC` | | RISC-V 64-bit | `WOLFSSL_SP_RISCV64` | | RISC-V 32-bit | `WOLFSSL_SP_RISCV32` | | MIPS 64-bit | `WOLFSSL_SP_MIPS64` | @@ -52,12 +78,26 @@ ### SP 鍵サイズ設定 +SP を有効にすると、RSA-2048、RSA-3072、ECC P-256 はデフォルトで含まれます。 +RSA-4096、P-384、P-521 は追加する必要があります。 +アセンブリマクロは、ターゲットに合ったものを1つだけ選択してください。 + ```c -#define WOLFSSL_SP_MATH -#define WOLFSSL_SP_X86_64_ASM /* x86-64 */ -#define WOLFSSL_SP_ARM64_ASM /* AArch64 */ -#define WOLFSSL_SP_ARM_CORTEX_M_ASM /* Cortex-M */ +/* RSA、DH、ECCでSPを有効化 */ +#define WOLFSSL_HAVE_SP_RSA +#define WOLFSSL_HAVE_SP_DH +#define WOLFSSL_HAVE_SP_ECC + +/* オプション: 制限付きSP数学(以下で有効にしたサイズと曲線のみ) */ +/* #define WOLFSSL_SP_MATH */ + +/* オプション: アセンブリ(いずれか1つを選択) */ +#define WOLFSSL_SP_ASM +#define WOLFSSL_SP_X86_64_ASM /* x86-64 */ +/* #define WOLFSSL_SP_ARM64_ASM */ /* AArch64 */ +/* #define WOLFSSL_SP_ARM_CORTEX_M_ASM */ /* Cortex-M */ +/* 追加の鍵サイズと曲線 */ #define WOLFSSL_SP_4096 /* RSA-4096 */ #define WOLFSSL_SP_384 /* ECC P-384 */ #define WOLFSSL_SP_521 /* ECC P-521 */ @@ -70,41 +110,78 @@ ## C. マイコン/SoC チップ別ハードウェアアクセラレータ +これらのポートは、`user_settings.h` での定義によって選択します(例えば `WOLFSSL_STM32F4` を定義すると、`settings.h` が `STM32_CRYPTO` と `STM32_HASH` を定義します)。 +自動検出はされません。 +configure オプションが存在するものは、そのオプションも記載しています。 + | ベンダー / チップ | 対応アルゴリズム | user_settings.h マクロ | configure オプション | ソース | |---|---|---|---|---| | **STMicroelectronics** | | | | | -| STM32F2/F4/F7/H7 (CRYP) | AES-ECB/CBC/CTR/GCM | `STM32_CRYPTO` | HAL 自動検出 | port/st/stm32.c | -| STM32L4/L5/WB55 | AES, SHA(部分) | `STM32_CRYPTO` | HAL 自動検出 | port/st/stm32.c | -| STM32U5 (DHUK) | 鍵ラップ付き AES | `WOLFSSL_STM32U5_DHUK` | 自動検出 | port/st/stm32.c | -| STM32MP13 (ベアメタル) | AES, SHA, RNG, ECC (PKA) | `WOLFSSL_STM32MP13` (`STM32_CRYPTO`を設定) | user_settings.h | port/st/stm32.c | +| STM32F2/F4/F7/H7 (CRYP) | AES-ECB/CBC/CTR/GCM | `STM32_CRYPTO`(ファミリーの定義により設定。例:`WOLFSSL_STM32F4`) | user_settings.h | port/st/stm32.c | +| STM32L4/L5/WB55 | AES, SHA(部分) | `STM32_CRYPTO`(ファミリーの定義により設定) | user_settings.h | port/st/stm32.c | +| STM32U5 (DHUK) | 鍵ラップ付き AES | `WOLFSSL_STM32U5_DHUK` | user_settings.h | port/st/stm32.c | +| STM32MP13 (ベアメタル) | AES, SHA, RNG, ECC (PKA) | `WOLFSSL_STM32MP13` (`STM32_CRYPTO`を設定) | user_settings.h | port/st/stm32.c、port/st/STM32MP13.md を参照 | +| STM32V8 (Cortex-M85) | AES, SHA, PKA, RNG | `WOLFSSL_STM32V8` | user_settings.h | port/st/stm32.c | +| STM32 ベアメタル(レジスタ直接アクセス、HAL 不使用、約27ファミリー) | HASH, AES, PKA, RNG, DHUK ラップ鍵, CCB 保護 ECDSA | `WOLFSSL_STM32_BARE` | user_settings.h | port/st/stm32.c | +| STM32 CubeMX / CubeMX2 暗号コールバックデバイス | AES(平文鍵), AES-GCM, ECDSA | `WOLFSSL_STM32_CUBEMX` / `WOLFSSL_MX2_CONF_INCLUDE` | user_settings.h | port/st/ | +| STSAFE-A100/A120 | ECDSA, ECDH | `WOLFSSL_STSAFEA100` / `WOLFSSL_STSAFEA120` | `--enable-stsafe=a100` / `--enable-stsafe=a120` | port/st/stsafe.c | | **NXP** | | | | | -| i.MX RT (DCP) | AES-ECB/CBC/CTR/GCM, SHA | `WOLFSSL_IMXRT_DCP` | 自動検出 | port/nxp/dcp_port.c | +| i.MX RT (DCP) | AES-ECB/CBC (128-bit), SHA-1, SHA-256 | `WOLFSSL_IMXRT_DCP` | user_settings.h | port/nxp/dcp_port.c | | i.MX 6/8 (CAAM) | AES, SHA, RSA, ECC, DH, HMAC | `WOLFSSL_IMX6_CAAM` / `WOLFSSL_SECO_CAAM` | `--enable-caam` | port/caam/* | -| SE050 セキュアエレメント | AES, SHA, RSA, ECC, X25519, ECDH | `WOLFSSL_SE050` + `WOLFSSL_SE050_CRYPT` | 自動検出 | port/nxp/se050_port.c | +| SE050 セキュアエレメント | AES, SHA, RSA, ECC, X25519, ECDH | `WOLFSSL_SE050` + `WOLFSSL_SE050_CRYPT` | `--with-se050=PATH` | port/nxp/se050_port.c | +| EdgeLock Secure Enclave (ELE) | RNG(シード) | `WOLFSSL_NXP_ELE` | `--enable-ele` | port/nxp/ele_cryptocb.c, ele_rng.c | +| EdgeLock ELS/PKC(例:RW61x) | AES-ECB/CBC/CTR/GCM, CMAC, SHA-256/384/512, RNG | `WOLFSSL_ELS_PKC` | `--with-els-pkc=PATH` | port/nxp/els_pkc_port.c | +| LPC55S69 HashCrypt | AES-ECB/CBC/CTR/OFB/CFB, SHA-1, SHA-256 | `WOLFSSL_NXP_HASHCRYPT`(`WOLFSSL_NXP_LPC55S6X` により設定) | user_settings.h | port/nxp/hashcrypt_port.c | +| LPC55S69 CASPER | RSA 公開鍵演算, ECC 点乗算 | `WOLFSSL_NXP_CASPER`(`WOLFSSL_NXP_LPC55S6X` により設定) | user_settings.h | port/nxp/casper_port.c | +| LPC55S69 ハードウェア PUF | PUF による鍵の生成と保管 | `WOLFSSL_NXP_HWPUF` | user_settings.h | port/nxp/hwpuf_port.c | +| Kinetis mmCAU / LTC | AES, DES, MD5, SHA-1, SHA-256 (mmCAU); AES-GCM, RSA/ECC 演算 (LTC) | `FREESCALE_USE_MMCAU` / `FREESCALE_USE_LTC` | user_settings.h | aes.c, des3.c, port/nxp/ksdk_port.c | +| QorIQ SEC (T1040, T2080) | AES-CBC/CTR/ECB/GCM, ECDSA, ECDH, RSA, FFDHE, RNG | `WOLFSSL_SEC_QORIQ` | `--enable-sec-qoriq` | port/nxp/sec_qoriq*.c | | **Espressif** | | | | | -| ESP32 / ESP32-S2 / ESP32-S3 | AES, SHA-1/256/384/512, RSA, ECC | `WOLFSSL_ESP32_CRYPT` | `--enable-esp32` | port/Espressif/esp32_*.c | -| ESP32-C3 / C6 / H2 | AES, SHA-256/384/512(部分) | `WOLFSSL_ESP32_CRYPT` | `--enable-esp32` | port/Espressif/esp32_*.c | +| ESP32 / ESP32-S2 / ESP32-S3 | AES, SHA-1/256/384/512, RSA, ECC | `WOLFSSL_ESPIDF` + `WOLFSSL_ESP32`(これにより settings.h が `WOLFSSL_ESP32_CRYPT` を定義) | ESP-IDF コンポーネント | port/Espressif/esp32_*.c | +| ESP32-C3 / C6 / H2 | AES, SHA-256/384/512(部分) | `WOLFSSL_ESPIDF` + `WOLFSSL_ESP32`(これにより settings.h が `WOLFSSL_ESP32_CRYPT` を定義) | ESP-IDF コンポーネント | port/Espressif/esp32_*.c | | **Renesas** | | | | | -| RX64M/RX71M/RX72M | SHA-1, SHA-256 | `WOLFSSL_RENESAS_RX64_HASH` | 自動検出 | port/Renesas/renesas_rx64_*.c | -| RX65N (SCE) | AES, SHA, RSA, ECC, RNG | `WOLFSSL_RENESAS_SCEPROTECT` | 自動検出 | port/Renesas/renesas_*.c | -| RZ/A1/A2 (TSIP) | AES, SHA, RSA, ECC, RNG | `WOLFSSL_RENESAS_TSIP` | 自動検出 | port/Renesas/renesas_tsip_*.c | -| RA4M4/RA6M4 (RSIP) | AES, SHA, RSA, ECC, RNG | `WOLFSSL_RENESAS_RSIP` | 自動検出 | port/Renesas/renesas_rsip*.c | -| RA FSP Secure Manager | AES, SHA, RSA, ECC, HMAC | `WOLFSSL_RENESAS_FSPSM` | 自動検出 | port/Renesas/renesas_fspsm_*.c | +| RX64M/RX71M/RX72M | SHA-1, SHA-256 | `WOLFSSL_RENESAS_RX64_HASH` | user_settings.h | port/Renesas/renesas_rx64_*.c | +| RX65N / RX72N (TSIP) | AES, SHA, RSA, ECC, RNG | `WOLFSSL_RENESAS_TSIP` | user_settings.h | port/Renesas/renesas_tsip_*.c | +| RA6M3 / RA6M4 (SCE Protected Mode) | AES, SHA, RSA, ECC, RNG | `WOLFSSL_RENESAS_SCEPROTECT` | user_settings.h | port/Renesas/renesas_fspsm_*.c | +| RZ/N2L (RSIP) | AES, SHA, RSA, ECC, RNG | `WOLFSSL_RENESAS_RSIP` | user_settings.h | port/Renesas/renesas_fspsm_*.c | +| RA FSP Secure Manager | AES, SHA, RSA, ECC, HMAC | `WOLFSSL_RENESAS_FSPSM` | user_settings.h | port/Renesas/renesas_fspsm_*.c | | **Cypress** | | | | | -| PSoC 6 | AES, SHA, ECC, RNG | `WOLFSSL_PSOC6_CRYPTO` | 自動検出 | port/cypress/psoc6_crypto.c | +| PSoC 6 | AES, SHA, ECC, RNG | `WOLFSSL_PSOC6_CRYPTO` | user_settings.h | port/cypress/psoc6_crypto.c | | **Silicon Labs** | | | | | -| EFR32 / EFM32 (SE) | AES, SHA, ECC, RNG | `WOLFSSL_SILABS_SE_ACCEL` | 自動検出 | port/silabs/silabs_*.c | +| EFR32 / EFM32 (SE) | AES, SHA, ECC, RNG | `WOLFSSL_SILABS_SE_ACCEL` | user_settings.h | port/silabs/silabs_*.c | +| EFR32 Secure Element 暗号コールバックデバイス | AES-ECB/CBC/CTR/GCM/CCM, ChaCha20, CMAC, SHA-1/224/256/384/512, HKDF, PBKDF2, ECDSA, ECDH, RNG | `WOLFSSL_SILABS_CRYPTOCB` | `--enable-silabs-cryptocb` | port/silabs/silabs_cb_*.c | | **Maxim** | | | | | -| MAX3266X | AES-ECB/CBC, RSA | `WOLFSSL_MAX3266X` | 自動検出 | port/maxim/max3266x.c | +| MAX3266X | AES-ECB/CBC, SHA-1/224/256/384/512, TRNG, MAA (RSA/ECC 演算) | `WOLFSSL_MAX3266X` | user_settings.h | port/maxim/max3266x.c | | MAXQ10XX | AES, SHA, RSA, ECC, RNG | `WOLFSSL_MAXQ10XX_CRYPTO` | `--with-maxq10xx=PART` | port/maxim/maxq10xx.c | | **Microchip** | | | | | -| PIC32MZ | AES, SHA, RNG | `WOLFSSL_PIC32MZ_CRYPT` | 自動検出 | port/pic32/ | +| PIC32MZ | AES, SHA, RNG | `WOLFSSL_PIC32MZ_CRYPT` | user_settings.h | port/pic32/ | | ATECC508A / 608A | AES, SHA, ECC (ECDH/ECDSA) | `WOLFSSL_ATECC508A` / `WOLFSSL_ATECC608A` | `--enable-microchip=508` / `--enable-microchip=608` | port/atmel/atmel.c | -| **Xilinx** | | | | | -| Zynq / Zynq-7000 | AES, SHA, RSA, ECC | `WOLFSSL_XILINX_CRYPT` | `--enable-xilinx` | port/xilinx/xil-*.c | -| Versal | AES-GCM, SHA-3, RNG | `WOLFSSL_XILINX_CRYPT_VERSAL` | `--enable-xilinx` | port/xilinx/xil-versal-*.c | -| **ARM CryptoCell** | | | | | -| CC-300/312/700/712/714 | AES, SHA, RSA, ECC, ChaCha, Poly1305 | `WOLFSSL_CRYPTOCELL` | `--enable-cryptocell` | port/arm/cryptocell*.c | +| TA100 | RSA, ECC, AES-GCM | `WOLFSSL_MICROCHIP_TA100` | `--enable-microchip=100` | port/atmel/atmel.c | +| PolarFire SoC Athena F5200 (TeraFire) | AES-256-CTR, SHA-384 | `WOLFSSL_MPFS_ATHENA` | `--with-mpfs-athena=PATH` | port/microchip/mpfs_athena.c | +| **Xilinx / AMD** | | | | | +| Zynq UltraScale+ MPSoC | AES-GCM, SHA3-384, RSA | `WOLFSSL_XILINX_CRYPT` | `--enable-xilinx` | port/xilinx/xil-*.c | +| Versal | AES-GCM, SHA-3, RSA, ECDSA, RNG | `WOLFSSL_XILINX_CRYPT_VERSAL` | user_settings.h(`--enable-xilinx` は `WOLFSSL_XILINX_CRYPT` のみを定義) | port/xilinx/xil-versal-*.c | +| Versal Gen2 (ASU) | TRNG, ハッシュ, HMAC, AES 暗号, CMAC, GMAC, RSA (raw, PSS, OAEP), ECC, ECDH, ECIES, EdDSA, X25519/X448(X25519/X448 には Vitis 2026.1 以降が必要) | `WOLFSSL_VERSAL_GEN2_ASU` | user_settings.h | port/xilinx/versal_gen2_asu/ | +| **Altera** | | | | | +| Agilex 5 SDM (FPGA Crypto Services) | AES, SHA-256/384/512, HMAC, ECDSA 署名, ECDH, RNG | `WOLFSSL_ALTERA_FCS` | `--enable-alterafcs` | port/altera/ | +| **Nuvoton** | | | | | +| M2354 | AES-ECB/CBC/CTR/GCM, SHA-1/224/256/384/512, RSA, ECDSA, ECDH, RNG | `WOLFSSL_NUVOTON_M2354` | user_settings.h | port/nuvoton/ | +| **Texas Instruments** | | | | | +| TM4C (Tiva) | AES (CBC/CTR/GCM/CCM), 3DES, MD5, SHA-1, SHA-224, SHA-256 | `WOLFSSL_TI_CRYPT` / `WOLFSSL_TI_HASH` | user_settings.h | port/ti/ti-aes.c, ti-des3.c, ti-hash.c, ti-ccm.c | +| AM64x (SA2UL, Cortex-R5F) | TRNG, AES-ECB/CBC/GCM, SHA-256/512, HMAC, CMAC | `WOLFSSL_TI_AM64X_R5` | user_settings.h | port/ti/ti-sa2ul_r5_port.c | +| C2000 C28x(AESA 暗号コールバックデバイス) | AES-ECB/CBC/CTR, オシレータのジッタによるエントロピー | `WOLFSSL_C2000_AES` / `WOLFSSL_C2000_ENTROPY`(`WOLFSSL_WIDE_BYTE` と併用) | user_settings.h | port/ti/ti-c2000-*.c | +| **RealTek** | | | | | +| AmebaPro2(RTL8735B HUK 暗号コールバックデバイス) | AES, HMAC-SHA256, ECDSA, TRNG | `WOLFSSL_RTL8735B_HUK` / `WOLFSSL_RTL8735B_AES` | user_settings.h(`--enable-rtl8735b` はホスト上でのコンパイルテストをビルドします) | port/realtek/rtl8735b.c | +| **WISeKey / SealSQ** | | | | | +| VaultIC セキュアエレメント | P-256 署名, 検証, 鍵生成, ECDH | `WOLFSSL_VAULTIC` | `--enable-vaultic` | port/sealsq/vaultic.c | +| **Tropic Square** | | | | | +| TROPIC01 セキュアエレメント | AES-CBC, AES-GCM, ECDSA, RNG | `WOLFSSL_TROPIC01` | `--with-tropic01=PATH` | port/tropicsquare/tropic01.c | +| **Vorago** | | | | | +| VA416x0 | TRNG(Hash-DRBG のシードとして使用) | `WOLFSSL_VA416X0_TRNG` | user_settings.h | wolfcrypt/src/random.c | +| **Raspberry Pi** | | | | | +| RP2040 / RP2350 (Pico) | RNG | `WOLFSSL_RPIPICO` | user_settings.h | port/rpi_pico/pico.c | +| **Nordic** | | | | | +| nRF51 | RNG | `WOLFSSL_NRF51` | user_settings.h | port/nrf51.c | | **IoT-Safe (SIM)** | ECC, SHA, RNG | `WOLFSSL_IOTSAFE` | `--enable-iotsafe` | port/iotsafe/ | ## D. 外部アクセラレータ・コプロセッサ @@ -112,17 +189,27 @@ | 製品 | 対応アルゴリズム | user_settings.h マクロ | configure オプション | |---|---|---|---| | Intel QuickAssist (QAT) | AES, RSA, DH, ECC, SHA | `HAVE_INTEL_QA` | `--with-intelqa=PATH` | -| Intel QAT(同期) | 同上 | `ENABLED_INTEL_QA_SYNC` | `--with-intelqa-sync=PATH` | +| Intel QAT(同期) | 同上 | `HAVE_INTEL_QA_SYNC` | `--with-intelqa-sync=PATH` | | Cavium NITROX | AES, RSA, DH, ECC, SHA | `HAVE_CAVIUM` | `--with-cavium=PATH` | -| Cavium NITROX V | 同上 | `HAVE_CAVIUM_V` | `--with-cavium=PATH` | +| Cavium NITROX V | 同上 | `HAVE_CAVIUM_V` | `--with-cavium-v=PATH` | | Cavium Octeon (MIPS) | AES, RSA, ECC, SHA | `HAVE_CAVIUM_OCTEON_SYNC` | `--with-octeon-sync=PATH` | | NXP CAAM | AES, SHA, RSA, ECC, HMAC, DH | `WOLFSSL_CAAM` | `--enable-caam` | +| NVIDIA CUDA GPU | AES | `HAVE_CUDA` | `--enable-cuda` | +| MagicCrypto ライブラリ | ARIA 暗号、および暗号コールバック経由の ECDSA、ECDH、SHA-256/384 | `HAVE_ARIA` | `--enable-aria` | +| PKCS#11 トークンまたは HSM | トークンに依存 | `HAVE_PKCS11` | `--enable-pkcs11` | ## E. OS カーネル経由ハードウェアオフロード | インターフェース | 対応アルゴリズム | user_settings.h マクロ | configure オプション | |---|---|---|---| -| Linux `/dev/crypto` | AES, SHA-1/256/512, RSA, ECC, DH, HMAC | `WOLFSSL_DEVCRYPTO` | `--enable-devcrypto` | -| Linux Kernel Crypto API | AES, SHA, RSA, ECC, X25519, HMAC | `WOLFSSL_KCAPI` | `--enable-kcapi` | +| Linux `/dev/crypto` | AES, SHA, HMAC, RSA, ECDSA, X25519 | `WOLFSSL_DEVCRYPTO` | `--enable-devcrypto` | +| Linux Kernel Crypto API | AES, SHA, HMAC, RSA, ECC, DH | `WOLFSSL_KCAPI` | `--enable-kcapi` | | Linux AF_ALG | AES, SHA(カーネルバックエンド依存) | `WOLFSSL_AFALG` | `--enable-afalg` | | PSA (Platform Security Architecture) | ベンダー実装依存 | `WOLFSSL_HAVE_PSA` | `--enable-psa` | +| AUTOSAR Csm / CryIf | AES-CBC, RNG, AES-CMAC | `WOLFSSL_AUTOSAR` | `--enable-autosar` | + +## F. 物理複製困難関数 (PUF) + +| 種類 | 機能 | user_settings.h マクロ | configure オプション | +|---|---|---|---| +| SRAM PUF | SRAM の起動時の値を用いたデバイス鍵の導出とデバイス識別 | `WOLFSSL_PUF` + `WOLFSSL_PUF_SRAM` | `--enable-puf` | diff --git a/wolfSSL/src-ja/appendix09.md b/wolfSSL/src-ja/appendix09.md index 91b20868..75ebfb1a 100644 --- a/wolfSSL/src-ja/appendix09.md +++ b/wolfSSL/src-ja/appendix09.md @@ -2,13 +2,17 @@ wolfSSLチームは以前、実験的なポスト量子暗号アルゴリズムをwolfSSLライブラリに統合しました。 これは、Open Quantum Safeチームのliboqsと統合することで実現されました。 -現在、wolfCryptはLMS、XMSS、ML-DSA、ML-KEMを実装しています。 -コードサイズの削減と保守の容易さのため、wolfSSLチームはliboqsとの統合を削除しました。 +現在、wolfCryptはML-KEM、ML-DSA、SLH-DSA、Falcon、FrodoKEM、およびステートフルハッシュベース署名方式(LMS/HSS、XMSS/XMSS^MT)を独自に実装しています。 +そのため、コードベースを小さく保ち、ライブラリの保守を容易にするために、liboqsとの統合、およびhash-sigs(LMS/HSS)ライブラリとxmss-reference(XMSS/XMSS^MT)ライブラリとの以前の統合を削除しました。 +wolfSSL 5.9.4以降、liboqsはどのアルゴリズムにも使用されておらず、`--with-liboqs` configureオプションは非推奨となり、無視されます。 この付録は、(D)TLS 1.3のコンテキストでポスト量子暗号について学び、実験したい人を対象としています。 ポスト量子アルゴリズムが重要である理由、量子の脅威に対応して私たちが行ったこと、これらの新しいアルゴリズムの実験を開始する方法について説明します。 +DTLS 1.3にのみ該当する注意事項は、「DTLSでのポスト量子アルゴリズム」節に記載しています。 -**注意**: 一部のポスト量子アルゴリズムはまだ完全に標準化されていません。一部のOIDとコードポイントは一時的なものであり、将来変更される可能性があります。完全に標準化されるまでは、下位互換性を期待すべきではありません。 +**注意**: 一部のポスト量子アルゴリズムはまだ完全に標準化されていません。 +一部のOIDとコードポイントは一時的なものであり、将来変更される可能性があります。 +完全に標準化されるまでは、下位互換性を期待すべきではありません。 ## ポスト量子暗号をわかりやすく紹介 @@ -22,6 +26,7 @@ wolfSSLチームは以前、実験的なポスト量子暗号アルゴリズム NISTは量子コンピュータに対して脆弱になる公開鍵暗号アルゴリズムを置き換えるために設計された、新しいアルゴリズムの標準化を主導しています。 この文章の執筆時点において、NISTはすでにML-DSA、ML-KEM、SLH-DSAを標準化しました。 +FalconはFN-DSA(FIPS 206)として標準化が進められていますが、まだドラフト段階であるため、wolfSSLではFalconを実験的なものとして扱っています。 ML-KEM (Module Lattice Key Encapsulation Mechanism) は、NISTが標準化した格子ベースの耐量子アルゴリズムです。 Kyberをベースとして標準化されました。 @@ -29,21 +34,24 @@ Kyberをベースとして標準化されました。 これにより、従来型および量子コンピュータを用いた攻撃者の両方から保護できます。 ML-DSA (Module Lattice Digital Signature Algorithm) は、同じくNISTが標準化した格子ベースの耐量子デジタル署名方式です。 -Kyberをベースとして標準化されました。 +Dilithiumをベースとして標準化されました。 これにより、送信者はメッセージの送信元と完全性を証明する検証可能な署名を生成できます。 ML-KEMとML-DSAはどちらも、暗号の復号に特化した量子コンピュータに耐性を持つように設計された公開鍵アルゴリズムです。 これらはNISTの耐量子暗号標準(FIPS 203およびFIPS 204)の一部です。 量子コンピューティング時代に備えるために、ほとんどのケースでハイブリッド形式にてすぐに導入できます。 -現在、各標準化団体はOIDとコードポイントを示すさまざまなドラフト文書を有しています。 -NISTはこれらのアルゴリズムをCMVP規制フレームワークの傘下に置き、実装に対するFIPS-140-3検証を可能にする取り組みを進めています。 +アルゴリズム自体は、現在ではすでにNIST標準となっています。 +ML-KEM、ML-DSA、SLH-DSAはそれぞれFIPS 203、FIPS 204、FIPS 205で、ステートフルハッシュベース署名方式のLMSとXMSSはNIST SP 800-208で標準化されています。 +wolfSSLが今後予定しているポスト量子FIPS認証の申請は、ML-KEM、ML-DSA、LMS、XMSS、SLH-DSAを対象としています。 +まだ確定していないのは、TLSでのこれらのアルゴリズムの使用方法です。 +ML-KEMグループのコードポイントはIETFドラフトのdraft-ietf-tls-mlkem(純粋なML-KEM)およびdraft-ietf-tls-ecdhe-mlkem(ハイブリッド)に、SLH-DSA署名スキームのコードポイントはdraft-reddy-tls-slhdsaに基づいています。 ### 私たちは自分自身をどのように守るのですか? 大まかに言えば、すべての TLS 1.3 接続において、認証・完全性・機密性は各接続を保護する重要な目標です。 認証は、ECDSAなどの署名スキームによって維持されます。 -機密性と完全性は、ECDHEなどのキー確立アルゴリズムによって維持され、確立されたキーとAESなどの対称暗号化アルゴリズムを使用して通信ストリームを暗号化します。 +機密性と完全性は、ECDHEなどの鍵確立アルゴリズムによって維持され、確立された鍵とAESなどの対称暗号化アルゴリズムを使用して通信ストリームを暗号化します。 したがって、TLS 1.3 プロトコルのセキュリティは、次の3種類の暗号化アルゴリズムに分解できます。 * 認証アルゴリズム @@ -51,7 +59,7 @@ NISTはこれらのアルゴリズムをCMVP規制フレームワークの傘下 * 対称暗号アルゴリズム 量子コンピュータが従来の暗号に及ぼす脅威には、2つの形態があります。 -グローバーのアルゴリズムは、最新の対称暗号アルゴリズムのセキュリティを半分に低下させます。 +グローバーのアルゴリズムは、最新の対称暗号アルゴリズムのセキュリティを約半分に低下させます。 ショアのアルゴリズムは、最新の認証および鍵確立アルゴリズムのセキュリティを完全に破壊します。 したがって、暗号処理に特化した量子コンピュータが存在する場合でも、十分に安全と考えられるAES-256対称暗号を使用して通信を保護し続けることができます。 そして、従来の認証および鍵確立アルゴリズムをポスト量子アルゴリズムに置き換えることができます。 @@ -61,7 +69,8 @@ CNSA(商用国家安全保障アルゴリズムスイート)1.0と2.0はと これらは従来のアルゴリズムとは異なる種類の数学を使用します。 量子コンピュータに対する耐性を特に考慮して設計されたものです。 -NISTがネットワークプロトコルでの使用のために標準化した認証アルゴリズムとKEMは、格子ベースのアルゴリズムです。 +NISTがネットワークプロトコルでの使用のために標準化した主要な署名スキームとKEMは、格子ベースのアルゴリズムです。 +署名については、ハッシュベースの代替手段としてSLH-DSA(FIPS 205)もあります。 * ML-DSA(Dilithium)署名スキーム * ML-KEM(KYBER)KEM @@ -72,11 +81,31 @@ NISTがネットワークプロトコルでの使用のために標準化した **注意**: Dilithium署名スキームのAESバリアントはNISTが標準化を検討していないため、非推奨となり削除されました。 -**注意**: liboqs統合が削除された際、FALCONとSPHINCS+署名スキームも削除されました。今後、独自の実装を提供する予定です。 +**注意**: wolfSSLが以前liboqsから取り込んでいたSPHINCS+は、ネイティブのSLH-DSA(FIPS 205)実装に置き換えられました。 +SLH-DSAは[`--enable-slhdsa`](chapter02.md#--enable-slhdsa)で有効にします。 +FalconはwolfSSL 5.9.4まではliboqsを使用していましたが、5.9.4でレベル1と5のネイティブ実装に置き換えられました。 +このネイティブ実装は`--enable-experimental --enable-falcon`で有効にします。 +鍵カプセル化メカニズムであるFrodoKEMも、`--enable-experimental --enable-frodokem`で利用できます。 + +wolfSSLは、ML-KEMとML-DSAに加えて、以下のポスト量子アルゴリズムもサポートしています。 + +* SLH-DSA(FIPS 205)署名スキーム(12個のパラメータセットすべて)。 + `--enable-slhdsa`は6つのSHAKEパラメータセットをビルドし、`--enable-slhdsa=yes,sha2`は6つのSHA2パラメータセットを追加します。 + SLH-DSAは、draft-reddy-tls-slhdsaに従ってTLS 1.3およびDTLS 1.3のハンドシェイクに署名できます。 + コードポイントは[付録G](appendix07.md#c-9-slh-dsa-fips-205)に記載しています。 +* Falcon署名スキーム(レベル1と5、実験的)。 + wolfCryptのネイティブ実装で、暗号コールバックとARM DSP / AArch64 NEONによる高速化に対応しています。 +* FrodoKEM鍵カプセル化メカニズム(wolfCryptのみ、実験的)。 +* ステートフルハッシュベース署名方式のLMS/HSSおよびXMSS/XMSS^MT。 + この付録の後半で説明します。 -格子ベースの暗号化の説明はこの文書の範囲を超えますが、これらのアルゴリズムに関する詳細情報はNIST提出物で確認できます。 +wolfSSL 5.9.4以降では、ポスト量子アルゴリズムのみでTLS 1.3をビルドすることもできます。 +鍵交換にはML-KEMを、認証にはML-DSAまたはSLH-DSAを使用し、RSA、ECC、DHは使用しません。 +[`--enable-all-quantum-crypto`](chapter02.md#--enable-all-quantum-crypto)を指定すると、ML-KEM、ML-DSA、LMS、XMSS、SLH-DSA(SHAKEとSHA2の両方のパラメータセット)を一度に有効にします。 +`--enable-experimental`と組み合わせると、Falcon、FrodoKEM、および追加のPQ/Tハイブリッドグループも有効になります。 +純粋なML-KEMのTLSグループ(`--enable-tls-mlkem-standalone`)は有効になりません。 - +格子ベースの暗号化の説明はこの文書の範囲を超えますが、これらのアルゴリズムに関する詳細情報は、それぞれの標準であるFIPS 203()、FIPS 204()、FIPS 205()で確認できます。 残念ながら、この章を記している時点においてこれらのアルゴリズムが量子コンピューターからの攻撃に耐えられるかどうかは、まだ分かっていません。 従来型コンピューターにおける攻撃耐性も同様です。 @@ -86,833 +115,420 @@ NISTがネットワークプロトコルでの使用のために標準化した ポスト量子アルゴリズムは比較的新しいため、コミュニティからもう少し注目を集める必要があるかもしれません。 解決策の1つは、これらの新しいアルゴリズムを完全には信頼しないことです。 -今のところ、ポスト量子KEMを、信頼している従来のアルゴリズムとハイブリッド化することで、このリスクを回避することができます。 -FIPS準拠を第一に考えると、NIST標準曲線を使用したECCは良い選択肢になります。 -このため、ポスト量子KEMを統合するだけでなく、NISTが承認した曲線上のECDSAとハイブリッド化しました。 +今のところ、ポスト量子アルゴリズムを、信頼している従来のアルゴリズムとハイブリッド化することで、このリスクを回避することができます。 +FIPS 140-3準拠を第一に考えると、NIST標準曲線を使用したECCは引き続き使用する必要があるため、良い選択肢になります。 +このため、ポスト量子KEMを実装するだけでなく、NISTが承認した曲線上のECDHとハイブリッド化しました(SecP256r1MLKEM768およびSecP384r1MLKEM1024)。 +wolfSSLは、X25519とのハイブリッドであるX25519MLKEM768もサポートしています。 +X25519MLKEM768はサーバーに受け入れられる可能性が最も高いハイブリッドであるため、Curve25519が有効な場合はClientHelloのデフォルトの鍵共有として使用されます。 詳しくは以下のハイブリッドグループのリストを参照してください。 -## wolfSSLのでポスト量子暗号を始めましょう +## wolfSSLでポスト量子暗号を始めましょう ここではまっさらなLinux環境をもとに、量子耐性を有する安全なTLS 1.3接続を実行できるようにするまでの手順を示します。 ### ビルド手順 -wolfSSLリポジトリの[INSTALLファイル](https://github.com/wolfSSL/wolfssl/blob/master/INSTALL) をご参照ください。 +ポスト量子アルゴリズムはいずれも外部ライブラリを必要とせず、すべてwolfSSLのソースからビルドされます。 +一般的な構成は次のとおりです。 -項目15には、構成とビルドの方法に関する説明があります。 +```sh +./configure --enable-mlkem --enable-mldsa --enable-slhdsa=yes,sha2 +``` -ポスト量子暗号鍵と署名を使用して X.509 証明書を生成するには、パッチを適用した OQS OpenSSL Providerフォークが必要です。 -手順は にあります。 -事前に生成された証明書もそこで入手できます。 +実験的なアルゴリズムを使用する場合は、`--enable-experimental --enable-falcon`または`--enable-experimental --enable-frodokem`を追加します。 +これら2つのオプションはサブオプションも受け付けます。 +詳しくは[`--enable-falcon`](chapter02.md#--enable-falcon)および[`--enable-frodokem`](chapter02.md#--enable-frodokem)をご参照ください。 + +wolfSSLリポジトリのINSTALLファイル()の項目15にも同様の内容が記載されています。 +ただし、そこでは古いオプション名である`--enable-kyber`と`--enable-dilithium`(それぞれ`--enable-mlkem`と[`--enable-mldsa`](chapter02.md#--enable-mldsa)の別名)が使用されており、また`--enable-experimental --enable-extra-pqc-hybrids`を必要とするSecP521r1MLKEM1024グループが使用されています。 + +#### デフォルトで有効になっているもの + +* ML-KEMは、SHA-3またはSHAKEが無効になっていない限り、デフォルトで有効です。 + `--enable-mlkem`はサブオプションを渡す場合にのみ必要で、[`--disable-mlkem`](chapter02.md#--disable-mlkem)を指定するとML-KEMを無効にします。 +* 標準のPQ/TハイブリッドグループであるSecP256r1MLKEM768、SecP384r1MLKEM1024、X25519MLKEM768は、デフォルトで有効な[`--enable-pqc-hybrids`](chapter02.md#--disable-pqc-hybrids)によって提供されます。 + X25519MLKEM768には[`--enable-curve25519`](chapter02.md#--enable-curve25519)も必要ですが、こちらはデフォルトで無効です。 +* 純粋なML-KEMグループであるML_KEM_512、ML_KEM_768、ML_KEM_1024には[`--enable-tls-mlkem-standalone`](chapter02.md#--enable-tls-mlkem-standalone)が必要です。 + configureスクリプトがこのオプションを自動的に有効にするのは、ハイブリッドを構成するためのECC、Curve25519、Curve448がいずれもビルドに含まれていない場合のみです。 +* 追加のハイブリッドグループであるSecP256r1MLKEM512、SecP384r1MLKEM768、SecP521r1MLKEM1024、X25519MLKEM512、X448MLKEM768には`--enable-experimental --enable-extra-pqc-hybrids`が必要です。 + これらはFIPS v7ビルドでは使用できません。 +* Round 3のKyberグループには、`--enable-mlkem=yes,original`(ML-KEMの代わりにKyber)または`--enable-mlkem=yes,all`(KyberとML-KEMの両方)が必要です。 + リストには`yes`を残してください。 + `yes`がないと、KyberとML-KEMのパラメータセットが1つもビルドされません。 +* アプリケーションがグループを何も設定しない場合、wolfSSLクライアントは、Curve25519が組み込まれていればX25519MLKEM768の鍵共有を、そうでなければSecP256r1MLKEM768の鍵共有を送信します。 +* ML-DSA、SLH-DSA、LMS、XMSSはデフォルトで無効です。 + FalconとFrodoKEMには、さらに`--enable-experimental`も必要です。 + +[付録G](appendix07.md)の「B-7 ML-KEMスタンドアロン」「B-8 ML-KEMハイブリッド(標準)」「B-9 ML-KEMハイブリッド(実験的)」「B-10 Kyber Round 3 レガシー」の各節に、これらすべてのグループとそのコードポイントを記載しています。 + +#### ポスト量子テスト証明書 + +ポスト量子認証を試すのに、追加のツールは必要ありません。 +wolfSSLのソースツリーには、すぐに使えるテスト証明書と鍵が含まれています。 +`certs/mldsa/`にはML-DSA証明書があり、ML-DSA-87のCA(`mldsa87-ca-cert.pem`)とML-DSA-65のリーフ証明書(`mldsa65-leaf87ca-cert.pem`)も含まれています。 +`certs/slhdsa/`には、SLH-DSAのルート証明書と、ML-DSA-44およびSLH-DSAのサーバー証明書とクライアント証明書があります。 +これらは、ML-DSAとSLH-DSAの鍵と証明書をネイティブに作成できるOpenSSL 3.5以降で生成されました。 +OQSプロバイダーで作成された以前のML-DSA証明書チェーンとその作成手順は、wolfSSL OSPリポジトリ にあります。 ### 量子安全なTLS接続を確立する -次のようにして、サーバーとクライアントを別々のターミナルで実行します。 +wolfSSLソースツリーのルートから、次のようにしてサーバーとクライアントを別々のターミナルで実行します。 ```sh examples/server/server -v 4 -l TLS_AES_256_GCM_SHA384 \ - -A ../osp/oqs/mldsa87_root_cert.pem \ - -c ../osp/oqs/mldsa44_entity_cert.pem \ - -k ../osp/oqs/mldsa44_entity_key.pem \ - --pqc SecP521r1MLKEM1024 + -A certs/mldsa/mldsa87-ca-cert.pem \ + -c certs/mldsa/mldsa65-leaf87ca-cert.pem \ + -k certs/mldsa/mldsa65-leaf87ca-key.pem \ + --pqc SecP384r1MLKEM1024 ``` ```sh examples/client/client -v 4 -l TLS_AES_256_GCM_SHA384 \ - -A ../osp/oqs/mldsa44_root_cert.pem \ - -c ../osp/oqs/mldsa87_entity_cert.pem \ - -k ../osp/oqs/mldsa87_entity_key.pem \ - --pqc SecP521r1MLKEM1024 + -A certs/mldsa/mldsa87-ca-cert.pem \ + -c certs/mldsa/mldsa65-leaf87ca-cert.pem \ + -k certs/mldsa/mldsa65-leaf87ca-key.pem \ + --pqc SecP384r1MLKEM1024 ``` +両側で`SSL curve name is SecP384r1MLKEM1024`と表示され、クライアントはサーバーからの応答`I hear you fa shizzle!`を表示します。 これで、対称暗号化にAES-256、認証にML-DSA署名スキーム、鍵確立にECDHEとML-KEMをハイブリッド化した完全な量子安全なTLS 1.3接続を実現しました。 +両ピアは、ML-DSA-87のCAが発行した同一のML-DSA-65証明書で認証します。 + +代わりにSLH-DSAで認証するには、SLH-DSA証明書を使用します。 +SLH-DSA証明書には、SLH-DSA-SHAKE-128sのルートが発行したサーバー証明書とクライアント証明書が別々に用意されています。 + +```sh +examples/server/server -v 4 -l TLS_AES_256_GCM_SHA384 \ + -A certs/slhdsa/root-slhdsa-shake-128s.pem \ + -c certs/slhdsa/server-slhdsa-shake-128s.pem \ + -k certs/slhdsa/server-slhdsa-shake-128s-priv.pem \ + --pqc SecP384r1MLKEM1024 +``` + +```sh +examples/client/client -v 4 -l TLS_AES_256_GCM_SHA384 \ + -A certs/slhdsa/root-slhdsa-shake-128s.pem \ + -c certs/slhdsa/client-slhdsa-shake-128s.pem \ + -k certs/slhdsa/client-slhdsa-shake-128s-priv.pem \ + --pqc SecP384r1MLKEM1024 +``` + +`--pqc`には、「ポスト量子アルゴリズムのバリアント名」節に記載されているグループ名のいずれかを指定します。 +サンプルの`-?`ヘルプにはビルド構成にかかわらずすべてのグループ名が表示されますが、組み込まれていないグループを指定すると`invalid post-quantum KEM specified`で失敗します。 +例えば、X25519MLKEM768には`--enable-curve25519`が、SecP521r1MLKEM1024には`--enable-experimental --enable-extra-pqc-hybrids`が必要です。 +`--pqc`を指定しない場合、サンプルクライアントは従来型の鍵共有(P-256と、組み込まれている場合はFFDHE 2048)のみを送信するため、ライブラリのデフォルトのハイブリッド鍵共有は確認できません(「開発者ノート」節を参照してください)。 その他のポスト量子の例に関する詳細情報は で確認できます。 +### DTLSでのポスト量子アルゴリズム + +同じグループと証明書はDTLS 1.3でも使用できます。 +wolfSSLを[`--enable-dtls13`](chapter02.md#--enable-dtls13)も指定して構成し、上記のサンプルサーバーとクライアントのコマンドに`-u`を追加してください。 +ML-KEMの鍵共有によってClientHelloが1つのデータグラムよりも大きくなることがあるため、ML-KEMとDTLS 1.3の両方が有効な場合、configureはDTLS 1.3のClientHelloフラグメント化(`--enable-dtls-frag-ch`、`WOLFSSL_DTLS_CH_FRAG`)も有効にします。 +最初のClientHelloをフラグメント化する必要がある場合、wolfSSLクライアントはそのClientHelloを空の鍵共有で送信します。 +サーバーはHelloRetryRequestで応答し、クライアントは2回目のClientHelloで鍵共有を送信します。 +この2回目のClientHelloはフラグメント化される場合があります。 +サーバーは`wolfSSL_dtls13_allow_ch_frag()`でフラグメント化されたClientHelloを許可する必要があります。 +ML-KEMを含むビルドでは、これがデフォルトです。 +クッキーを無効にしたDTLS 1.3サーバーもフラグメント化された最初のClientHelloを処理できますが、それは`wolfSSL_dtls13_allow_ch_frag()`が有効な場合に限られます。 + +## ポスト量子アルゴリズムのバリアント名 + +ポスト量子アルゴリズムのバリアント名: + +NISTセキュリティレベル | アルゴリズム | wolfCrypt識別子 | TLSグループ名 +-------------------- | ----------- | -------------------- | --------------- +2 | ML-DSA-44 | `WC_ML_DSA_44` | n/a +3 | ML-DSA-65 | `WC_ML_DSA_65` | n/a +5 | ML-DSA-87 | `WC_ML_DSA_87` | n/a +1 | ML-KEM-512 | `WC_ML_KEM_512` | `ML_KEM_512` +3 | ML-KEM-768 | `WC_ML_KEM_768` | `ML_KEM_768` +5 | ML-KEM-1024 | `WC_ML_KEM_1024` | `ML_KEM_1024` + +wolfCrypt識別子は、例えば`wc_MlDsaKey_SetParams()`や`wc_MlKemKey_Init()`でパラメータセットを選択するために使用します。 +TLSグループ名は、サンプルクライアントとサーバーの`--pqc`、および`wolfSSL_CTX_set1_groups_list()` / `wolfSSL_set1_groups_list()`に渡す名前です。 +これらの関数は`MLKEM512`、`MLKEM768`、`MLKEM1024`も受け付けます。 +純粋なML-KEMグループには`--enable-tls-mlkem-standalone`が必要です。 + +ポスト量子ハイブリッドKEMの名前は次のとおりです。 +各ハイブリッドは、名前が示す曲線上のECDH鍵合意とML-KEM(FIPS 203)を組み合わせたものです。 + +wolfSSLグループ名 | コードポイント | 組み合わせ | configureオプション +-------------------- | ---------- | ------------------------- | ----------------- +`SecP256r1MLKEM768` | 4587 | ECDH P-256 + ML-KEM-768 | デフォルト +`X25519MLKEM768` | 4588 | X25519 + ML-KEM-768 | デフォルト、`--enable-curve25519`が必要 +`SecP384r1MLKEM1024` | 4589 | ECDH P-384 + ML-KEM-1024 | デフォルト +`SecP256r1MLKEM512` | 12107 | ECDH P-256 + ML-KEM-512 | `--enable-experimental --enable-extra-pqc-hybrids` +`SecP384r1MLKEM768` | 12108 | ECDH P-384 + ML-KEM-768 | `--enable-experimental --enable-extra-pqc-hybrids` +`SecP521r1MLKEM1024` | 12109 | ECDH P-521 + ML-KEM-1024 | `--enable-experimental --enable-extra-pqc-hybrids` +`X25519MLKEM512` | 12214 | X25519 + ML-KEM-512 | 上記に加えて`--enable-curve25519` +`X448MLKEM768` | 12215 | X448 + ML-KEM-768 | 上記に加えて`--enable-curve448` + +デフォルトのハイブリッドはdraft-ietf-tls-ecdhe-mlkemのコードポイントを使用し、追加のハイブリッドはOpen Quantum Safeプロバイダーのコードポイントを使用します。 +[付録G](appendix07.md)の「B-8 ML-KEMハイブリッド(標準)」節もご参照ください。 + ## 暗号アーティファクトのサイズ すべてのサイズはバイト単位です。 -### ポスト量子署名スキームのアーティファクトサイズ +ポスト量子署名スキームのアーティファクトサイズ: + +パラメータセット | 公開鍵サイズ | 秘密鍵サイズ | 最大署名サイズ +---------------- | --------------- | ---------------- | ---------------------- +ML-DSA-44 | 1312 | 2560 | 2420 +ML-DSA-65 | 1952 | 4032 | 3309 +ML-DSA-87 | 2592 | 4896 | 4627 +Falcon level 1 | 897 | 1281 | 666 +Falcon level 5 | 1793 | 2305 | 1280 + +SLH-DSAのアーティファクトサイズ(同じパラメータセットのSHA2バリアントとSHAKEバリアントのサイズは同じです): -PQCバリアント名 | 公開鍵サイズ | 秘密鍵サイズ | 最大署名サイズ --------------- | ----------- | ------------ | -------------- -ML_DSA_44 | 1312 | 2560 | 2420 -ML_DSA_65 | 1952 | 4032 | 3309 -ML_DSA_87 | 2592 | 4896 | 4627 +パラメータセット | 公開鍵サイズ | 秘密鍵サイズ | 署名サイズ +---------------- | --------------- | ---------------- | -------------- +SLH-DSA-128s | 32 | 64 | 7856 +SLH-DSA-128f | 32 | 64 | 17088 +SLH-DSA-192s | 48 | 96 | 16224 +SLH-DSA-192f | 48 | 96 | 35664 +SLH-DSA-256s | 64 | 128 | 29792 +SLH-DSA-256f | 64 | 128 | 49856 -### ポスト量子KEMのアーティファクトサイズ +ポスト量子KEMのアーティファクトサイズ: -PQCバリアント名 | 公開鍵サイズ | 秘密鍵サイズ | 暗号文サイズ | 共有秘密サイズ --------------- | ----------- | ------------ | ----------- | -------------- -ML_KEM_512 | 800 | 1632 | 768 | 32 -ML_KEM_768 | 1184 | 2400 | 1088 | 32 -ML_KEM_1024 | 1568 | 3168 | 1568 | 32 +パラメータセット | 公開鍵サイズ | 秘密鍵サイズ | 暗号文サイズ | 共有秘密サイズ +---------------- | --------------- | ---------------- | --------------- | ------------------ +ML-KEM-512 | 800 | 1632 | 768 | 32 +ML-KEM-768 | 1184 | 2400 | 1088 | 32 +ML-KEM-1024 | 1568 | 3168 | 1568 | 32 + +LMS/HSSおよびXMSS/XMSS^MTの鍵と署名のサイズについては、「ポスト量子ステートフルハッシュベース署名」節をご参照ください。 ## 統計データ -以下の統計とベンチマークは、8コアのUbuntu 22.04.5 LTSを実行している第11世代Intel Core i7-1185G7@3-GHzで取得されました。 +以下の統計とベンチマークは、macOS 27.2を実行しているApple M5(高性能コア4個、高効率コア6個)上で、Apple clang 21でビルドしたwolfSSL 5.9.4(masterブランチ、2026年11月時点)を使用して取得しました。 + +wolfSSL: ```text -./configure --enable-kyber \ - --enable-dilithium \ +./configure --enable-mlkem \ + --enable-mldsa \ + --enable-tls-mlkem-standalone \ + --enable-experimental \ + --enable-extra-pqc-hybrids \ + --enable-curve25519 \ --disable-psk \ --disable-shared \ - --enable-intelasm \ - --enable-aesni \ + --enable-armasm \ --enable-sp-math-all \ --enable-sp-asm \ CFLAGS="-Os" ``` -**注**:主に耐量子アルゴリズムをベンチマークしていますが、比較目的のために従来のアルゴリズムも残しています。 +**注意**: 主に耐量子アルゴリズムをベンチマークしていますが、比較目的のために従来のアルゴリズムも残しています。 +純粋なML-KEMグループと追加のハイブリッドも測定できるように有効にしています。 ### 実行時バイナリサイズ -`tls_bench`サンプルアプリケーションのバイナリファイルは、ビルド後にストリップすると2498432バイト(約2.4M)です。 -`--enable-kyber --enable-dilithium`なしでは、ビルド後にストリップすると2290912バイト(約2.2M)です。 -これは207520バイト(約200K)の差です。 +`tls_bench`サンプルアプリケーションのバイナリファイルは、ビルド後にストリップすると2507328バイト(約2.4M)です。 +`--enable-mlkem`の代わりに`--disable-mlkem`を指定し、`--enable-mldsa`、`--enable-tls-mlkem-standalone`、`--enable-experimental`、`--enable-extra-pqc-hybrids`を指定しない場合は、ビルド後にストリップすると2273088バイト(約2.2M)です。 +これは234240バイト(約229K)の差です。 ### TLS 1.3データ送信サイズ -サンプルサーバーとクライアントを実行し、送信されるすべての情報をWiresharkで記録することによって取得した値を以下に示します。 +サンプルサーバーとクライアントを実行し、双方向に送信されたすべてのTCPペイロードのバイト数を数えて取得した値を以下に示します(Wiresharkですべてのパケットの`tcp.len`を合計した値と同じです)。 これには、相互認証による TLS 1.3 ハンドシェイク、"hello wolfssl!"、"I hear you fa shizzle!" メッセージが含まれます。 -すべてのパケットの `tcp.len` を合計しました。 - -暗号スイート | 認証 | 鍵確立 | 合計バイト ----------------------- | -------------------- | --------------------- | ----------- -TLS_AES_256_GCM_SHA384 | RSA 2048ビット | ECC SECP256R1 | 5455 -TLS_AES_256_GCM_SHA384 | RSA 2048ビット | ML_KEM_512 | 6633 -TLS_AES_256_GCM_SHA384 | RSA 2048ビット | ML_KEM_768 | 7337 -TLS_AES_256_GCM_SHA384 | RSA 2048ビット | ML_KEM_1024 | 8201 -TLS_AES_256_GCM_SHA384 | RSA 2048ビット | P256_ML_KEM_512 | 6763 -TLS_AES_256_GCM_SHA384 | RSA 2048ビット | P384_ML_KEM_768 | 7531 -TLS_AES_256_GCM_SHA384 | RSA 2048ビット | P521_ML_KEM_1024 | 8467 -TLS_AES_256_GCM_SHA384 | ML_DSA_44 | ECC SECP256R1 | 7918 -TLS_AES_256_GCM_SHA384 | ML_DSA_65 | ECC SECP256R1 | 10233 -TLS_AES_256_GCM_SHA384 | ML_DSA_87 | ECC SECP256R1 | 13477 - -### ヒープとスタックの使用量 - -**注意**:これは古い情報です。これらはwolfSSLがこれらのアルゴリズムのliboqs実装を使用していた時に取得されたものです。歴史的な目的のために残されています。 - -これらの統計は、次の構成フラグを追加して取得しました。 - -`--enable-trackmemory --enable-stacksize` - -クライアントのサーバー認証なしのサーバー署名とクライアント検証、鍵交換用の TLS13-AES256-GCM-SHA384 暗号スイートおよび ECC SECP256R1 におけるメモリ使用量を以下に示します。 - -```text -Server FALCON_LEVEL1 - -stack used = 48960 -total Allocs = 250 -heap total = 113548 -heap peak = 40990 - -Client FALCON_LEVEL1 - -stack used = 29935 -total Allocs = 768 -heap total = 179427 -heap peak = 41765 - -Server FALCON_LEVEL5 - -stack used = 89088 -total Allocs = 250 -heap total = 125232 -heap peak = 45630 - -Client FALCON_LEVEL5 - -stack used = 29935 -total Allocs = 768 -heap total = 191365 -heap peak = 47469 - -Server DILITHIUM_LEVEL2 - -stack used = 56328 -total Allocs = 243 -total Deallocs = 243 -total Bytes = 128153 -peak Bytes = 50250 - -Client DILITHIUM_LEVEL2 - -stack used = 30856 -total Allocs = 805 -total Deallocs = 805 -total Bytes = 206412 -peak Bytes = 56299 - -Server DILITHIUM_LEVEL3 - -stack used = 86216 -total Allocs = 243 -total Deallocs = 243 -total Bytes = 140128 -peak Bytes = 55161 - -Client DILITHIUM_LEVEL3 - -stack used = 33928 -total Allocs = 805 -total Deallocs = 805 -total Bytes = 220633 -peak Bytes = 61245 - -Server DILITHIUM_LEVEL5 - -stack used = 119944 -total Allocs = 243 -total Deallocs = 243 -total Bytes = 152046 -peak Bytes = 59829 +両ピアは同じ種類の証明書を使用します。 +RSAの行ではサンプルのデフォルト証明書を使用し、ML-DSAの行では両側で自己署名の`certs/mldsa/mldsa-cert.pem`と`certs/mldsa/mldsa-key.pem`を使用しています。 +例えば次のように実行します。 -Client DILITHIUM_LEVEL5 - -stack used = 40328 -total Allocs = 805 -total Deallocs = 805 -total Bytes = 238167 -peak Bytes = 67049 - -Server RSA 2048 - -stack used = 52896 -total Allocs = 253 -heap total = 121784 -heap peak = 39573 - -Client RSA 2048 - -stack used = 54640 -total Allocs = 897 -heap total = 202472 -heap peak = 41760 +```sh +examples/server/server -v 4 -l TLS_AES_256_GCM_SHA384 --pqc ML_KEM_768 +examples/client/client -v 4 -l TLS_AES_256_GCM_SHA384 --pqc ML_KEM_768 ``` -KEM グループのメモリ使用量を示します。 -サーバーのクライアント認証には TLS13-AES256-GCM-SHA384とRSA-2048を使用し、クライアントのサーバー認証は行いません。 - -```text -Server KYBER_LEVEL1 - -stack used = 52896 -total Allocs = 206 -heap total = 66864 -heap peak = 28474 - -Client KYBER_LEVEL1 - -stack used = 54640 -total Allocs = 879 -heap total = 147235 -heap peak = 44538 - -Server KYBER_LEVEL3 - -stack used = 52896 -total Allocs = 206 -heap total = 67888 -heap peak = 28794 - -Client KYBER_LEVEL3 - -stack used = 54640 -total Allocs = 879 -heap total = 149411 -heap peak = 46010 - -Server KYBER_LEVEL5 - -stack used = 52896 -total Allocs = 206 -heap total = 69232 -heap peak = 29274 - -Client KYBER_LEVEL5 - -stack used = 54640 -total Allocs = 879 -heap total = 151907 -heap peak = 47642 - -Server KYBER_90S_LEVEL1 - -stack used = 52896 -total Allocs = 206 -heap total = 66864 -heap peak = 28474 - -Client KYBER_90S_LEVEL1 - -stack used = 54640 -total Allocs = 879 -heap total = 147235 -heap peak = 44538 - -Server KYBER_90S_LEVEL3 - -stack used = 52896 -total Allocs = 206 -heap total = 67888 -heap peak = 28794 - -Client KYBER_90S_LEVEL3 - -stack used = 54640 -total Allocs = 879 -heap total = 149411 -heap peak = 46010 - -Server KYBER_90S_LEVEL5 - -stack used = 52896 -total Allocs = 206 -heap total = 69232 -heap peak = 29274 - -Client KYBER_90S_LEVEL5 - -stack used = 54640 -total Allocs = 879 -heap total = 151907 -heap peak = 47642 - -Server P256_KYBER_LEVEL1 - -stack used = 52896 -total Allocs = 223 -heap total = 118940 -heap peak = 37652 - -Client P256_KYBER_LEVEL1 - -stack used = 54640 -total Allocs = 896 -heap total = 199376 -heap peak = 48932 - -Server P384_KYBER_LEVEL3 - -stack used = 52896 -total Allocs = 223 -heap total = 120108 -heap peak = 38468 - -Client P384_KYBER_LEVEL3 - -stack used = 54640 -total Allocs = 896 -heap total = 201728 -heap peak = 50468 - -Client Server P521_KYBER_LEVEL5 - -stack used = 52896 -total Allocs = 223 -heap total = 121614 -heap peak = 39458 - -Client P521_KYBER_LEVEL5 - -stack used = 54640 -total Allocs = 896 -heap total = 204422 -heap peak = 52172 - -Client Server P256_KYBER_90S_LEVEL1 - -stack used = 52896 -total Allocs = 223 -heap total = 118940 -heap peak = 37652 - -Client P256_KYBER_90S_LEVEL1 - -stack used = 54640 -total Allocs = 896 -heap total = 199376 -heap peak = 48932 +ML-DSAの行では、両方のコマンドに`-A certs/mldsa/mldsa44-cert.pem -c certs/mldsa/mldsa44-cert.pem -k certs/mldsa/mldsa44-key.pem`(または65もしくは87のファイル)を追加しました。 +`--pqc`を指定していない行では、P-256の鍵共有のみを送信するように、クライアントを`-Y`付きで実行しました(デフォルトではFFDHE 2048の鍵共有も送信します)。 +ClientHelloにはビルドがサポートするすべてのグループが列挙されるため、グループの少ないビルドでは送信されるデータ量がわずかに少なくなります。 -Server P384_KYBER_90S_LEVEL3 - -stack used = 52896 -total Allocs = 223 -heap total = 120108 -heap peak = 38468 - -Client P384_KYBER_90S_LEVEL3 - -stack used = 54640 -total Allocs = 896 -heap total = 201728 -heap peak = 50468 - -Server P521_KYBER_90S_LEVEL5 - -stack used = 52896 -total Allocs = 223 -heap total = 121614 -heap peak = 39458 - -Client P521_KYBER_90S_LEVEL5 - -stack used = 54640 -total Allocs = 896 -heap total = 204422 -heap peak = 52172 - -Server ECDSA SECP256R1 - -stack used = 52896 -total Allocs = 253 -heap total = 121784 -heap peak = 39573 +暗号スイート | 認証 | 鍵確立 | 合計バイト +---------------------- | -------------------- | --------------------- | ----------- +TLS_AES_256_GCM_SHA384 | RSA 2048ビット | ECC SECP256R1 | 5230 +TLS_AES_256_GCM_SHA384 | RSA 2048ビット | ML_KEM_512 | 6668 +TLS_AES_256_GCM_SHA384 | RSA 2048ビット | ML_KEM_768 | 7372 +TLS_AES_256_GCM_SHA384 | RSA 2048ビット | ML_KEM_1024 | 8236 +TLS_AES_256_GCM_SHA384 | RSA 2048ビット | SecP256r1MLKEM768 | 7502 +TLS_AES_256_GCM_SHA384 | RSA 2048ビット | X25519MLKEM768 | 7436 +TLS_AES_256_GCM_SHA384 | RSA 2048ビット | SecP384r1MLKEM1024 | 8430 +TLS_AES_256_GCM_SHA384 | RSA 2048ビット | SecP256r1MLKEM512 | 6798 +TLS_AES_256_GCM_SHA384 | RSA 2048ビット | SecP384r1MLKEM768 | 7566 +TLS_AES_256_GCM_SHA384 | RSA 2048ビット | SecP521r1MLKEM1024 | 8502 +TLS_AES_256_GCM_SHA384 | ML-DSA-44 | ECC SECP256R1 | 13918 +TLS_AES_256_GCM_SHA384 | ML-DSA-44 | SecP384r1MLKEM1024 | 17118 +TLS_AES_256_GCM_SHA384 | ML-DSA-65 | ECC SECP256R1 | 18754 +TLS_AES_256_GCM_SHA384 | ML-DSA-65 | SecP384r1MLKEM1024 | 21954 +TLS_AES_256_GCM_SHA384 | ML-DSA-87 | ECC SECP256R1 | 25306 +TLS_AES_256_GCM_SHA384 | ML-DSA-87 | SecP384r1MLKEM1024 | 28506 + +ML_KEM_*の行には`--enable-tls-mlkem-standalone`が、SecP256r1MLKEM512、SecP384r1MLKEM768、SecP521r1MLKEM1024の行には`--enable-experimental --enable-extra-pqc-hybrids`が、X25519MLKEM768の行には`--enable-curve25519`が必要です。 -Client ECDSA SECP256R1 +### ヒープとスタックの使用量 -stack used = 54640 -total Allocs = 897 -heap total = 202472 -heap peak = 41760 -``` +これらの統計は、`--enable-trackmemory --enable-stacksize`構成フラグを追加して取得しました。 +これにより、サンプルサーバーとクライアントはスタック使用量が計測されるスレッド内で実行され、使用したスタックと、wolfSSLの初期化からクリーンアップまでの間のヒープ使用量(割り当て回数、割り当てられた総バイト数、およびある時点で使用中だったバイト数のピーク)を出力します。 +これらの数値には証明書と鍵の読み込みも含まれており、ビルドオプションによって変化します。 + +サーバーによるクライアント認証を行わない場合の、サーバー署名とクライアント検証、TLS_AES_256_GCM_SHA384暗号スイート、および鍵交換にECC SECP256R1を使用した際のメモリ使用量を以下に示します。 +サーバーは`-d`付きで実行し、クライアントは自身の証明書を読み込まないように`-x`付きで、かつP-256の鍵共有のみを送信するように`-Y`付きで実行しました。 +ECDSAの行では`certs/server-ecc.pem`を、ML-DSAの行では自己署名の`certs/mldsa/mldsa-cert.pem`を使用しています。 + +認証 | 側 | スタック使用量 | 割り当て回数 | ヒープ合計 | ヒープピーク +---------------- | ------ | ---------- | ----------- | ---------- | --------- +RSA 2048 | サーバー | 14064 | 53 | 56373 | 22214 +RSA 2048 | クライアント | 16056 | 66 | 59229 | 20745 +ECDSA P-256 | サーバー | 14064 | 47 | 29455 | 16106 +ECDSA P-256 | クライアント | 16056 | 50 | 31522 | 14290 +ML-DSA-44 | サーバー | 14064 | 52 | 170031 | 78217 +ML-DSA-44 | クライアント | 16056 | 52 | 114087 | 53314 +ML-DSA-65 | サーバー | 14064 | 52 | 247775 | 110817 +ML-DSA-65 | クライアント | 16056 | 52 | 160841 | 75579 +ML-DSA-87 | サーバー | 14064 | 52 | 367873 | 158962 +ML-DSA-87 | クライアント | 16056 | 52 | 236231 | 111585 + +KEMグループのメモリ使用量を以下に示します。 +TLS_AES_256_GCM_SHA384暗号スイートを使用し、クライアントによるサーバー認証にはRSA-2048を使用しています。 +サーバーによるクライアント認証は行っていません。 +サーバーは`-d`付きで、クライアントは`-x`付きで実行しました。 +グループは両側で`--pqc `を指定して選択しました(X25519の場合は`-t`、SECP256R1の場合はクライアントで`-Y`を使用)。 + +鍵確立 | 側 | スタック使用量 | 割り当て回数 | ヒープ合計 | ヒープピーク +------------------ | ------ | ---------- | ----------- | ---------- | --------- +ECC SECP256R1 | サーバー | 14064 | 53 | 56373 | 22214 +ECC SECP256R1 | クライアント | 16056 | 66 | 59229 | 20745 +ECC X25519 | サーバー | 13320 | 54 | 48101 | 22181 +ECC X25519 | クライアント | 16056 | 66 | 50881 | 20712 +ML_KEM_512 | サーバー | 13320 | 54 | 62613 | 25854 +ML_KEM_512 | クライアント | 16056 | 70 | 72401 | 23112 +ML_KEM_768 | サーバー | 13320 | 54 | 68117 | 31038 +ML_KEM_768 | クライアント | 16056 | 70 | 82577 | 28765 +ML_KEM_1024 | サーバー | 13320 | 54 | 74965 | 37406 +ML_KEM_1024 | クライアント | 16056 | 70 | 95281 | 36477 +SecP256r1MLKEM768 | サーバー | 14832 | 61 | 78171 | 32546 +SecP256r1MLKEM768 | クライアント | 16056 | 80 | 93975 | 30208 +X25519MLKEM768 | サーバー | 13320 | 61 | 69781 | 32414 +X25519MLKEM768 | クライアント | 16056 | 80 | 85585 | 30109 +SecP384r1MLKEM1024 | サーバー | 18544 | 61 | 85691 | 39522 +SecP384r1MLKEM1024 | クライアント | 19376 | 80 | 107735 | 38496 +SecP256r1MLKEM512 | サーバー | 14832 | 61 | 72347 | 28099 +SecP256r1MLKEM512 | クライアント | 16056 | 80 | 83095 | 24737 +SecP384r1MLKEM768 | サーバー | 18544 | 61 | 78363 | 32674 +SecP384r1MLKEM768 | クライアント | 19376 | 80 | 94167 | 30304 +SecP521r1MLKEM1024 | サーバー | 24032 | 61 | 85907 | 39666 +SecP521r1MLKEM1024 | クライアント | 24864 | 80 | 107951 | 38604 ### ベンチマーク -#### wolfCryptによるベンチマーク - -以下のベンチマークは次の設定フラグを使用して取得されました。 +以下のベンチマークは、「統計データ」節の冒頭に示した構成フラグを使用して取得しました。 -```text -./configure --enable-kyber \ - --enable-dilithium \ - --disable-shared \ - --enable-intelasm \ - --enable-aesni \ - --enable-sp \ - --enable-sp-math \ - --enable-sp-asm \ - CFLAGS="-Os -DECC_USER_CURVES -DHAVE_ECC256 -DHAVE_ECC384" -``` +#### wolfCryptによるベンチマーク **注意**: 1つのコアのみが使用されています。 +`-ecc`はP-256のみを測定します。 +その他の曲線は`-ecc-all`、`-p384`、`-p521`で測定します。 +`-ml-kem-512`、`-ml-dsa-44`などは単一のパラメータセットを選択し、`-slhdsa`、`-falcon_level1`、`-falcon_level5`、`-lms_hss`、`-xmss_xmssmt`は、組み込まれている場合にその他のポスト量子アルゴリズムを測定します。 +AArch64では、「Cycles」の数値はCPUコアのサイクル数ではなく、システムタイマー(その周波数は「Clock frequency」として表示されます)で計測されます。 ```text -CPU: Intel x86_64 - avx1 avx2 rdrand rdseed bmi2 aesni adx movbe bmi1 sha -Math: Multi-Precision: Disabled - Single Precision: ecc 256 384 521 rsa/dh 2048 3072 4096 asm sp_x86_64.c - -ECC SECP256R1 key gen 95600 ops took 1.000 sec, avg 0.010 ms, 95587.830 ops/sec -ECDHE SECP256R1 agree 24800 ops took 1.003 sec, avg 0.040 ms, 24737.512 ops/sec -ECDSA SECP256R1 sign 61400 ops took 1.001 sec, avg 0.016 ms, 61337.775 ops/sec -ECDSA SECP256R1 verify 23000 ops took 1.001 sec, avg 0.044 ms, 22976.012 ops/sec -ML-KEM 512 key gen 284600 ops took 1.000 sec, avg 0.004 ms, 284565.467 ops/sec -ML-KEM 512 encap 270800 ops took 1.000 sec, avg 0.004 ms, 270749.585 ops/sec -ML-KEM 512 decap 172900 ops took 1.000 sec, avg 0.006 ms, 172896.249 ops/sec -ML-KEM 768 key gen 159800 ops took 1.000 sec, avg 0.006 ms, 159776.306 ops/sec -ML-KEM 768 encap 152800 ops took 1.000 sec, avg 0.007 ms, 152765.071 ops/sec -ML-KEM 768 decap 100100 ops took 1.000 sec, avg 0.010 ms, 100091.147 ops/sec -ML-KEM 1024 key gen 108300 ops took 1.000 sec, avg 0.009 ms, 108277.024 ops/sec -ML-KEM 1024 encap 104400 ops took 1.000 sec, avg 0.010 ms, 104388.900 ops/sec -ML-KEM 1024 decap 74100 ops took 1.001 sec, avg 0.014 ms, 74057.147 ops/sec -ML-DSA 44 key gen 20700 ops took 1.004 sec, avg 0.049 ms, 20617.041 ops/sec -ML-DSA 44 sign 5100 ops took 1.019 sec, avg 0.200 ms, 5003.233 ops/sec -ML-DSA 44 verify 18500 ops took 1.005 sec, avg 0.054 ms, 18403.134 ops/sec -ML-DSA 65 key gen 10200 ops took 1.007 sec, avg 0.099 ms, 10133.468 ops/sec -ML-DSA 65 sign 2900 ops took 1.004 sec, avg 0.346 ms, 2887.112 ops/sec -ML-DSA 65 verify 11600 ops took 1.005 sec, avg 0.087 ms, 11544.122 ops/sec -ML-DSA 87 key gen 7700 ops took 1.013 sec, avg 0.132 ms, 7598.278 ops/sec -ML-DSA 87 sign 2600 ops took 1.000 sec, avg 0.385 ms, 2599.634 ops/sec -ML-DSA 87 verify 7200 ops took 1.007 sec, avg 0.140 ms, 7152.274 ops/sec +./wolfcrypt/benchmark/benchmark -ecc -x25519 -ml-kem -ml-dsa +------------------------------------------------------------------------------ + wolfSSL version 5.9.4 +------------------------------------------------------------------------------ +CPU: Aarch64 - aes pmull sha256 sha512 rdm sha3 +Clock frequency: 1000000000 Hz +Math: Multi-Precision: Wolf(SP) no-dyn-stack word-size=64 bits=4096 sp_int.c + Single Precision: ecc 256 384 521 rsa/dh 2048 3072 4096 asm sp_arm64.c + Assembly Speedups: ARMASM ALIGN +wolfCrypt Benchmark (block bytes 1048576, min 1.0 sec each) +ML-KEM 512 128 key gen 416000 ops took 1.000 sec, avg 0.002 ms, 415934.748 ops/sec, 1000151922 cycles 2404.2 Cycles/op +ML-KEM 512 128 encap 364000 ops took 1.000 sec, avg 0.003 ms, 363971.971 ops/sec, 1000072762 cycles 2747.5 Cycles/op +ML-KEM 512 128 decap 244200 ops took 1.000 sec, avg 0.004 ms, 244189.521 ops/sec, 1000038535 cycles 4095.2 Cycles/op +ML-KEM 768 192 key gen 293000 ops took 1.000 sec, avg 0.003 ms, 292985.051 ops/sec, 1000045870 cycles 3413.1 Cycles/op +ML-KEM 768 192 encap 244100 ops took 1.000 sec, avg 0.004 ms, 244013.374 ops/sec, 1000350401 cycles 4098.1 Cycles/op +ML-KEM 768 192 decap 167000 ops took 1.000 sec, avg 0.006 ms, 166981.129 ops/sec, 1000109070 cycles 5988.7 Cycles/op +ML-KEM 1024 256 key gen 171900 ops took 1.000 sec, avg 0.006 ms, 171855.298 ops/sec, 1000255617 cycles 5818.8 Cycles/op +ML-KEM 1024 256 encap 152200 ops took 1.000 sec, avg 0.007 ms, 152125.140 ops/sec, 1000488156 cycles 6573.5 Cycles/op +ML-KEM 1024 256 decap 111200 ops took 1.000 sec, avg 0.009 ms, 111160.087 ops/sec, 1000354818 cycles 8996.0 Cycles/op +ECDHE [ SECP256R1] 256 agree 37200 ops took 1.001 sec, avg 0.027 ms, 37161.574 ops/sec, 1001029139 cycles 26909.4 Cycles/op +ECDSA [ SECP256R1] 256 sign 91900 ops took 1.000 sec, avg 0.011 ms, 91856.375 ops/sec, 1000471181 cycles 10886.5 Cycles/op +ECDSA [ SECP256R1] 256 verify 34900 ops took 1.001 sec, avg 0.029 ms, 34861.343 ops/sec, 1001104424 cycles 28684.9 Cycles/op +CURVE 25519 agree 66500 ops took 1.001 sec, avg 0.015 ms, 66458.866 ops/sec, 1000614019 cycles 15046.8 Cycles/op +ML-DSA 44 key gen 97300 ops took 1.000 sec, avg 0.010 ms, 97285.387 ops/sec, 1000145962 cycles 10279.0 Cycles/op +ML-DSA 44 sign 32300 ops took 1.001 sec, avg 0.031 ms, 32263.539 ops/sec, 1001125275 cycles 30994.6 Cycles/op +ML-DSA 44 verify 94500 ops took 1.001 sec, avg 0.011 ms, 94446.363 ops/sec, 1000563608 cycles 10588.0 Cycles/op +ML-DSA 65 key gen 57300 ops took 1.000 sec, avg 0.017 ms, 57272.567 ops/sec, 1000474781 cycles 17460.3 Cycles/op +ML-DSA 65 sign 22000 ops took 1.002 sec, avg 0.046 ms, 21957.444 ops/sec, 1001934023 cycles 45542.5 Cycles/op +ML-DSA 65 verify 61300 ops took 1.001 sec, avg 0.016 ms, 61249.897 ops/sec, 1000813141 cycles 16326.5 Cycles/op +ML-DSA 87 key gen 37600 ops took 1.001 sec, avg 0.027 ms, 37576.295 ops/sec, 1000626661 cycles 26612.4 Cycles/op +ML-DSA 87 sign 17600 ops took 1.005 sec, avg 0.057 ms, 17512.228 ops/sec, 1005007883 cycles 57102.7 Cycles/op +ML-DSA 87 verify 37800 ops took 1.002 sec, avg 0.027 ms, 37712.765 ops/sec, 1002308693 cycles 26516.1 Cycles/op +Benchmark complete ``` #### wolfSSLによるベンチマーク -以下のベンチマークは次の設定フラグを使用して取得されました。 +`tls_bench`は、ビルドがサポートするすべてのTLS 1.3グループに対してベンチマークを1回ずつ実行する`-g`と、各テストを2秒間実行する`-t 2`を指定して実行しました。 -```text -./configure --enable-kyber \ - --enable-dilithium \ - --disable-shared \ - --enable-intelasm \ - --enable-aesni \ - --enable-sp \ - --enable-sp-math \ - --enable-sp-asm \ - CFLAGS="-Os -DECC_USER_CURVES -DHAVE_ECC256" +```sh +./examples/benchmark/tls_bench -g -l TLS13-AES256-GCM-SHA384 -t 2 ``` **注意**: これらのベンチマークには2つのコアのみが使用されています。 - -```text -wolfSSL Server Benchmark on TLS13-AES128-GCM-SHA256 with group ECC_SECP256R1: - Total : 6029312 bytes - Num Conns : 24 - Rx Total : 965.511 ms - Tx Total : 7.469 ms - Rx : 2.978 MB/s - Tx : 384.903 MB/s - Connect : 48.343 ms - Connect Avg : 2.014 ms -wolfSSL Client Benchmark on TLS13-AES128-GCM-SHA256 with group ECC_SECP256R1: - Total : 6029312 bytes - Num Conns : 24 - Rx Total : 967.748 ms - Tx Total : 6.789 ms - Rx : 2.971 MB/s - Tx : 423.496 MB/s - Connect : 48.574 ms - Connect Avg : 2.024 ms - -wolfSSL Server Benchmark on TLS13-AES128-GCM-SHA256 with group ECC_SECP384R1: - Total : 6029312 bytes - Num Conns : 24 - Rx Total : 960.296 ms - Tx Total : 7.494 ms - Rx : 2.994 MB/s - Tx : 383.617 MB/s - Connect : 56.255 ms - Connect Avg : 2.344 ms -wolfSSL Client Benchmark on TLS13-AES128-GCM-SHA256 with group ECC_SECP384R1: - Total : 6029312 bytes - Num Conns : 24 - Rx Total : 962.002 ms - Tx Total : 7.367 ms - Rx : 2.989 MB/s - Tx : 390.259 MB/s - Connect : 56.220 ms - Connect Avg : 2.343 ms - -wolfSSL Server Benchmark on TLS13-AES128-GCM-SHA256 with group ECC_SECP521R1: - Total : 5767168 bytes - Num Conns : 23 - Rx Total : 938.745 ms - Tx Total : 7.889 ms - Rx : 2.929 MB/s - Tx : 348.596 MB/s - Connect : 61.261 ms - Connect Avg : 2.664 ms -wolfSSL Client Benchmark on TLS13-AES128-GCM-SHA256 with group ECC_SECP521R1: - Total : 5767168 bytes - Num Conns : 23 - Rx Total : 940.382 ms - Tx Total : 7.540 ms - Rx : 2.924 MB/s - Tx : 364.711 MB/s - Connect : 61.433 ms - Connect Avg : 2.671 ms - -wolfSSL Server Benchmark on TLS13-AES128-GCM-SHA256 with group ML_KEM_512: - Total : 6029312 bytes - Num Conns : 24 - Rx Total : 952.389 ms - Tx Total : 5.561 ms - Rx : 3.019 MB/s - Tx : 517.005 MB/s - Connect : 50.177 ms - Connect Avg : 2.091 ms -wolfSSL Client Benchmark on TLS13-AES128-GCM-SHA256 with group ML_KEM_512: - Total : 6029312 bytes - Num Conns : 24 - Rx Total : 954.202 ms - Tx Total : 4.751 ms - Rx : 3.013 MB/s - Tx : 605.110 MB/s - Connect : 48.602 ms - Connect Avg : 2.025 ms - -wolfSSL Server Benchmark on TLS13-AES128-GCM-SHA256 with group ML_KEM_768: - Total : 6029312 bytes - Num Conns : 24 - Rx Total : 955.030 ms - Tx Total : 5.882 ms - Rx : 3.010 MB/s - Tx : 488.757 MB/s - Connect : 51.283 ms - Connect Avg : 2.137 ms -wolfSSL Client Benchmark on TLS13-AES128-GCM-SHA256 with group ML_KEM_768: - Total : 6029312 bytes - Num Conns : 24 - Rx Total : 955.658 ms - Tx Total : 6.200 ms - Rx : 3.008 MB/s - Tx : 463.686 MB/s - Connect : 49.717 ms - Connect Avg : 2.072 ms - -wolfSSL Server Benchmark on TLS13-AES128-GCM-SHA256 with group ML_KEM_1024: - Total : 6029312 bytes - Num Conns : 24 - Rx Total : 973.042 ms - Tx Total : 7.294 ms - Rx : 2.955 MB/s - Tx : 394.150 MB/s - Connect : 51.750 ms - Connect Avg : 2.156 ms -wolfSSL Client Benchmark on TLS13-AES128-GCM-SHA256 with group ML_KEM_1024: - Total : 6029312 bytes - Num Conns : 24 - Rx Total : 973.655 ms - Tx Total : 7.996 ms - Rx : 2.953 MB/s - Tx : 359.573 MB/s - Connect : 50.328 ms - Connect Avg : 2.097 ms - -wolfSSL Server Benchmark on TLS13-AES128-GCM-SHA256 with group P256_ML_KEM_512: - Total : 6029312 bytes - Num Conns : 24 - Rx Total : 961.483 ms - Tx Total : 7.430 ms - Rx : 2.990 MB/s - Tx : 386.966 MB/s - Connect : 55.885 ms - Connect Avg : 2.329 ms -wolfSSL Client Benchmark on TLS13-AES128-GCM-SHA256 with group P256_ML_KEM_512: - Total : 6029312 bytes - Num Conns : 24 - Rx Total : 963.042 ms - Tx Total : 7.088 ms - Rx : 2.985 MB/s - Tx : 405.605 MB/s - Connect : 53.236 ms - Connect Avg : 2.218 ms - -wolfSSL Server Benchmark on TLS13-AES128-GCM-SHA256 with group P384_ML_KEM_768: - Total : 5767168 bytes - Num Conns : 23 - Rx Total : 927.519 ms - Tx Total : 7.338 ms - Rx : 2.965 MB/s - Tx : 374.747 MB/s - Connect : 64.464 ms - Connect Avg : 2.803 ms -wolfSSL Client Benchmark on TLS13-AES128-GCM-SHA256 with group P384_ML_KEM_768: - Total : 5767168 bytes - Num Conns : 23 - Rx Total : 929.281 ms - Tx Total : 6.923 ms - Rx : 2.959 MB/s - Tx : 397.229 MB/s - Connect : 60.200 ms - Connect Avg : 2.617 ms - -wolfSSL Server Benchmark on TLS13-AES128-GCM-SHA256 with group P521_ML_KEM_1024: - Total : 5767168 bytes - Num Conns : 23 - Rx Total : 918.122 ms - Tx Total : 7.598 ms - Rx : 2.995 MB/s - Tx : 361.941 MB/s - Connect : 79.426 ms - Connect Avg : 3.453 ms -wolfSSL Client Benchmark on TLS13-AES128-GCM-SHA256 with group P521_ML_KEM_1024: - Total : 5767168 bytes - Num Conns : 23 - Rx Total : 919.900 ms - Tx Total : 7.563 ms - Rx : 2.989 MB/s - Tx : 363.618 MB/s - Connect : 71.686 ms - Connect Avg : 3.117 ms - -wolfSSL Server Benchmark on TLS13-AES256-GCM-SHA384 with group ECC_SECP256R1: - Total : 6029312 bytes - Num Conns : 24 - Rx Total : 962.723 ms - Tx Total : 6.394 ms - Rx : 2.986 MB/s - Tx : 449.663 MB/s - Connect : 52.042 ms - Connect Avg : 2.168 ms -wolfSSL Client Benchmark on TLS13-AES256-GCM-SHA384 with group ECC_SECP256R1: - Total : 6029312 bytes - Num Conns : 24 - Rx Total : 963.166 ms - Tx Total : 7.537 ms - Rx : 2.985 MB/s - Tx : 381.433 MB/s - Connect : 52.348 ms - Connect Avg : 2.181 ms - - -wolfSSL Server Benchmark on TLS13-AES256-GCM-SHA384 with group ECC_SECP384R1: - Total : 6029312 bytes - Num Conns : 24 - Rx Total : 966.071 ms - Tx Total : 8.458 ms - Rx : 2.976 MB/s - Tx : 339.929 MB/s - Connect : 56.135 ms - Connect Avg : 2.339 ms -wolfSSL Client Benchmark on TLS13-AES256-GCM-SHA384 with group ECC_SECP384R1: - Total : 6029312 bytes - Num Conns : 24 - Rx Total : 968.053 ms - Tx Total : 7.895 ms - Rx : 2.970 MB/s - Tx : 364.155 MB/s - Connect : 56.188 ms - Connect Avg : 2.341 ms - -wolfSSL Server Benchmark on TLS13-AES256-GCM-SHA384 with group ECC_SECP521R1: - Total : 5767168 bytes - Num Conns : 23 - Rx Total : 930.195 ms - Tx Total : 7.849 ms - Rx : 2.956 MB/s - Tx : 350.364 MB/s - Connect : 62.644 ms - Connect Avg : 2.724 ms -wolfSSL Client Benchmark on TLS13-AES256-GCM-SHA384 with group ECC_SECP521R1: - Total : 5767168 bytes - Num Conns : 23 - Rx Total : 932.128 ms - Tx Total : 7.440 ms - Rx : 2.950 MB/s - Tx : 369.619 MB/s - Connect : 62.538 ms - Connect Avg : 2.719 ms - -wolfSSL Server Benchmark on TLS13-AES256-GCM-SHA384 with group ML_KEM_512: - Total : 6029312 bytes - Num Conns : 24 - Rx Total : 973.208 ms - Tx Total : 8.190 ms - Rx : 2.954 MB/s - Tx : 351.021 MB/s - Connect : 49.608 ms - Connect Avg : 2.067 ms -wolfSSL Client Benchmark on TLS13-AES256-GCM-SHA384 with group ML_KEM_512: - Total : 6029312 bytes - Num Conns : 24 - Rx Total : 975.874 ms - Tx Total : 7.051 ms - Rx : 2.946 MB/s - Tx : 407.772 MB/s - Connect : 48.708 ms - Connect Avg : 2.030 ms - -wolfSSL Server Benchmark on TLS13-AES256-GCM-SHA384 with group ML_KEM_768: - Total : 6029312 bytes - Num Conns : 24 - Rx Total : 965.259 ms - Tx Total : 8.098 ms - Rx : 2.978 MB/s - Tx : 355.041 MB/s - Connect : 51.284 ms - Connect Avg : 2.137 ms -wolfSSL Client Benchmark on TLS13-AES256-GCM-SHA384 with group ML_KEM_768: - Total : 6029312 bytes - Num Conns : 24 - Rx Total : 967.507 ms - Tx Total : 7.774 ms - Rx : 2.972 MB/s - Tx : 369.828 MB/s - Connect : 49.899 ms - Connect Avg : 2.079 ms - -wolfSSL Server Benchmark on TLS13-AES256-GCM-SHA384 with group ML_KEM_1024: - Total : 6029312 bytes - Num Conns : 24 - Rx Total : 972.588 ms - Tx Total : 7.835 ms - Rx : 2.956 MB/s - Tx : 366.959 MB/s - Connect : 52.259 ms - Connect Avg : 2.177 ms -wolfSSL Client Benchmark on TLS13-AES256-GCM-SHA384 with group ML_KEM_1024: - Total : 6029312 bytes - Num Conns : 24 - Rx Total : 974.238 ms - Tx Total : 7.838 ms - Rx : 2.951 MB/s - Tx : 366.813 MB/s - Connect : 50.758 ms - Connect Avg : 2.115 ms - -wolfSSL Server Benchmark on TLS13-AES256-GCM-SHA384 with group P256_ML_KEM_512: - Total : 6029312 bytes - Num Conns : 24 - Rx Total : 971.832 ms - Tx Total : 7.544 ms - Rx : 2.958 MB/s - Tx : 381.096 MB/s - Connect : 54.727 ms - Connect Avg : 2.280 ms -wolfSSL Client Benchmark on TLS13-AES256-GCM-SHA384 with group P256_ML_KEM_512: - Total : 6029312 bytes - Num Conns : 24 - Rx Total : 972.623 ms - Tx Total : 8.807 ms - Rx : 2.956 MB/s - Tx : 326.456 MB/s - Connect : 52.613 ms - Connect Avg : 2.192 ms - -wolfSSL Server Benchmark on TLS13-AES256-GCM-SHA384 with group P384_ML_KEM_768: - Total : 5767168 bytes - Num Conns : 23 - Rx Total : 921.217 ms - Tx Total : 7.740 ms - Rx : 2.985 MB/s - Tx : 355.285 MB/s - Connect : 69.367 ms - Connect Avg : 3.016 ms -wolfSSL Client Benchmark on TLS13-AES256-GCM-SHA384 with group P384_ML_KEM_768: - Total : 5767168 bytes - Num Conns : 23 - Rx Total : 923.622 ms - Tx Total : 6.928 ms - Rx : 2.977 MB/s - Tx : 396.956 MB/s - Connect : 63.739 ms - Connect Avg : 2.771 ms - -wolfSSL Server Benchmark on TLS13-AES256-GCM-SHA384 with group P521_ML_KEM_1024: - Total : 5767168 bytes - Num Conns : 23 - Rx Total : 920.447 ms - Tx Total : 7.735 ms - Rx : 2.988 MB/s - Tx : 355.548 MB/s - Connect : 78.446 ms - Connect Avg : 3.411 ms -wolfSSL Client Benchmark on TLS13-AES256-GCM-SHA384 with group P521_ML_KEM_1024: - Total : 5767168 bytes - Num Conns : 23 - Rx Total : 921.889 ms - Tx Total : 7.585 ms - Rx : 2.983 MB/s - Tx : 362.578 MB/s - Connect : 71.310 ms - Connect Avg : 3.100 ms -``` +`tls_bench`は、1つのサーバースレッドと1つのクライアントスレッドを実行します。 +サーバーはRSA 2048ビットの証明書で認証し、クライアントは認証されません。 + +以下の表は、各側が報告したハンドシェイク完了までの平均時間(「Connect Avg」)を示しています。 +`tls_bench`は、最初に実行するグループ(ここではECC_SECP256R1)を「N/A」と表示します。 + +グループ | サーバーConnect Avg (ms) | クライアントConnect Avg (ms) +------------------- | ----------------------- | ----------------------- +ECC_SECP256R1 | 0.508 | 0.489 +ECC_SECP384R1 | 0.590 | 0.571 +ECC_SECP521R1 | 0.667 | 0.651 +ECC_X25519 | 0.502 | 0.481 +FFDHE_2048 | 0.785 | 0.766 +ML_KEM_512 | 0.500 | 0.475 +ML_KEM_768 | 0.502 | 0.476 +ML_KEM_1024 | 0.513 | 0.484 +SecP256r1MLKEM768 | 0.523 | 0.495 +SecP384r1MLKEM1024 | 0.619 | 0.574 +X25519MLKEM768 | 0.530 | 0.500 +SecP256r1MLKEM512 | 0.546 | 0.513 +SecP384r1MLKEM768 | 0.655 | 0.602 +SecP521r1MLKEM1024 | 0.778 | 0.703 +X25519MLKEM512 | 0.531 | 0.501 ## ドキュメンテーション -技術文書や既知の回答テストなどのその他のリソースは、NIST PQC Webサイトにあります。 - - +各標準はNISTのWebサイトで入手できます。 -アルゴリズム固有のベンチマーク情報については、OQSプロジェクトのWebサイトに掲載されています。 +- ML-KEM、FIPS 203: +- ML-DSA、FIPS 204: +- SLH-DSA、FIPS 205: +- LMSおよびXMSS、NIST SP 800-208: - +お使いのハードウェアでアルゴリズムを測定するには、「ベンチマーク」節に示したwolfCryptベンチマークを使用してください。 ## ポスト量子ステートフルハッシュベース署名 -このセクションでは、最近wolfSSLがサポートを開始したLMS/HSSなどのポスト量子ステートフルハッシュベース署名(HBS)スキームについて記します。 +このセクションでは、ポスト量子ステートフルハッシュベース署名(HBS)スキームであるLMS/HSSおよびXMSS/XMSS^MTについて記します。 +wolfCryptは、両方のネイティブ実装を備えています。 +wolfSSL 5.9.2以降では、これらをX.509証明書(RFC 9802)でも使用できます。 +wolfSSLはHSS/LMSまたはXMSS/XMSS^MTで署名された証明書を検証でき、そのような証明書や証明書署名要求を生成することもできます。 +TLSハンドシェイクの署名アルゴリズムとしては使用できません。 ### 動機づけ ステートフルHBSスキームは、いくつかの理由から注目を集めています。 - -ステートフルHBSスキームの主な目的は、量子セキュリティの強化です。 -前述したように、ショアのアルゴリズムにより、量子コンピューターは大きな整数を効率的に因数分解し、離散対数を計算することができます。 +ステートフルHBSスキームの主な目的は、ポスト量子セキュリティの確保です。 +本付録で前述したように、ショアのアルゴリズムにより、量子コンピューターは大きな整数を効率的に因数分解し、離散対数を計算することができます。 これによって、RSAやECCなどの公開鍵暗号スキームを完全に破ることができます。 対照的に、ステートフルHBSスキームは、その基礎となるハッシュ関数とマークルツリー(通常SHA256で実装)のセキュリティに基づいており、暗号に関連する量子コンピューターの登場によって破られることは予想されていません。 @@ -923,24 +539,24 @@ wolfSSL Client Benchmark on TLS13-AES256-GCM-SHA384 with group P521_ML_KEM_1024: - さらにCNSA 2.0のタイムラインでは、2030年までにポスト量子ステートフルHBSスキームのみを使用する必要があり、採用は 「直ちに」 開始する必要があると規定されています。 -LMS の採用は、CNSA 2.0スイートのタイムラインで最も早い要件です。 +実際、LMS の採用は、CNSA 2.0スイートのタイムラインで最も早い要件です。 ただし、ステートフルHBSスキームの性質上、その使用と状態の追跡には細心の注意を払う必要があります。 -ステートフルHBSシステムでは、秘密鍵は実際にはワンタイム署名(OTS)キーの有限セットであり、再利用されることはありません。 +ステートフルHBSシステムでは、秘密鍵は実際にはワンタイム署名(OTS)キーの有限セットであり、決して再利用してはなりません。 同じOTSキーを使用して2つの異なるメッセージを署名すると、攻撃者が署名を偽造できる可能性があり、スキーム全体のセキュリティが崩壊します。 したがって、ステートフルHBSスキームは、パブリックインターネットなどの一般的な使用には適していません。 -LMS/HSSなどのステートフルHBSスキームは、特に長い運用寿命が期待され、暗号に関連する量子コンピューターに対して耐性が求められる組み込みシステムや制約付きシステムでのオフラインファームウェア認証と署名検証に特に役立ちます。 +その代わりに、こうした独自の長所と特性、およびNISTとNSAによる支持から、LMS/HSSなどのステートフルHBSスキームは、特に長い運用寿命が期待され、暗号に関連する量子コンピューターに対して耐性が求められる組み込みシステムや制約付きシステムでのオフラインファームウェア認証と署名検証に特に役立ちます。 ### LMS/HSS署名 -wolfSSLは、wolfCrypt組み込み暗号エンジンにLMS/HSSハッシュベースの署名スキームのサポートを追加しています。 -これは、以前のliboqs統合と同様に、hash-sigsLMS/HSSライブラリ()との実験的な統合によって実現されます。 +wolfCryptは、LMS/HSSハッシュベース署名スキーム(RFC 8554、NIST SP 800-208)のネイティブ実装を備えています。 +外部ライブラリは必要ありません。 Leighton-Micali Signatures(LMS)とそのマルチツリーのバリアントであるHierarchical Signature System(HSS)は、ポスト量子、ステートフルハッシュベース署名スキームです。 公開鍵と秘密鍵が小さく、署名と検証が速いことで知られています。 署名のサイズは大きくなりますが、Winternitzパラメーターを介して調整できます。 -詳細については、RFC8554の次の2つのリンクを参照してください: +詳細については、RFC8554の次の2つのリンクを参照してください。 - LMS: - HSS: @@ -957,21 +573,30 @@ LMS/HSS署名は3つのパラメータによって定義されます。 - Winternitz: ウィンターニッツチェーンで使用されるハッシュのビット数。 署名サイズの時空間トレードオフとして使用されます。 -wolfSSLは、[RFC 8554](https://tex2e.github.io/rfc-translater/html/rfc8554.html)で定義されているすべてのLMS/HSSパラメータをサポートしています。 +wolfSSLは、次のLMS/HSSパラメータ値をサポートしています。 -- levels = {1..8} +- levels = {1..4} - height = {5, 10, 15, 20, 25} - Winternitz = {1, 2, 4, 8} +[RFC 8554](https://tex2e.github.io/rfc-translater/html/rfc8554.html)では最大8レベルまで認められていますが、wolfSSLがサポートするのは最大4レベルまでです(`WOLFSSL_LMS_MAX_LEVELS`、デフォルトは4)。 +`WOLFSSL_LMS_MAX_HEIGHT`(デフォルトは25)を使用すると、ツリーの高さの最大値を下げてメモリを節約できます。 +デフォルトでは、パラメータセットは32バイト(SHA-256/256)のハッシュでSHA-256を使用します。 +NIST SP 800-208のSHA-256/192およびSHAKE256(256ビットおよび192ビット出力)のパラメータセットは、ビルド時に追加できます。 +「LMS/HSSビルド方法」節をご参照ください。 + 利用可能な署名の数は次の通りです。 - N = 2 ** (levels * height) -便宜上、一部のパラメータセットはenum `wc_LmsParm` で事前定義されています。 -その値を以下の表に示します。 +パラメータセットはenum `wc_LmsParm` で事前定義されており、鍵を`wc_LmsKey_SetLmsParm()`と`wc_LmsKey_SetParameters()`のどちらで設定する場合でも、そこに列挙されている組み合わせのみを使用できます。 +SHA-256/256パラメータセットの一部を以下の表に示します。 +完全な一覧については、`wolfssl/wolfcrypt/wc_lms.h`の`enum wc_LmsParm`をご参照ください。 +そこには`WC_LMS_PARM_SHA256_192_*`、`WC_LMS_PARM_SHAKE_*`、`WC_LMS_PARM_SHAKE192_*`のセットも含まれています。 +`WC_LMS_PARM_NONE`はパラメータセットではありません。 +`wc_LmsKey_SetLmsParm()`はこれを拒否するため、必ずパラメータセットを選択する必要があります。 パラメータセット | 説明 -------------------- | --------------------------- -WC_LMS_PARM_NONE | 設定されていません。デフォルトを使用します (WC_LMS_PARM_L1_H15_W2) WC_LMS_PARM_L1_H15_W2 | level:1, height:15, Winternitz:2 WC_LMS_PARM_L1_H15_W4 | level:1, height:15, Winternitz:4 WC_LMS_PARM_L2_H10_W2 | level:2, height:10, Winternitz:2 @@ -1001,118 +626,250 @@ WC_LMS_PARM_L4_H5_W8 | 5340 | 1048576 表から分かるように、署名のサイズは主にレベルとWinternitz値、および比較的影響は小さいですが高さによって決まります。 - レベル値を大きくすると、署名サイズは大幅に増加します。 -- 高さの値を大きくすると、署名のサイズは増加します。 +- 高さの値を大きくすると、署名のサイズは緩やかに増加します。 - Winternitz値を大きくすると、署名のサイズは小さくなりますが、鍵の生成と署名/検証にかかる時間が長くなります。 鍵の生成時間は、第1レベルのツリーの高さによって大きく決まります。 -使用可能な署名の数が同じであっても、レベル3、高さ5のツリーは、初期鍵生成時にレベル1、高さ15のツリーよりもはるかに高速です +使用可能な署名の数が同じであっても、レベル3、高さ5のツリーは、初期鍵生成時にレベル1、高さ15のツリーよりもはるかに高速です。 + +公開鍵のサイズは、SHA-256/256およびSHAKE256/256パラメータセットでは60バイト、192ビットのパラメータセットでは52バイトです。 +保存しておく必要がある秘密鍵のサイズは、256ビットのパラメータセットでは64バイトです。 +`wc_LmsKey_GetPrivLen()`は、どのパラメータセットについてもこのサイズを返します。 #### LMS/HSSビルド方法 -wolfSSLリポジトリの[INSTALLファイル](https://github.com/wolfSSL/wolfssl/blob/master/INSTALL) をご参照ください。 -項目17には、wolfSSLとhash-sigs LMS/HSSライブラリを設定および構築する方法についての手順が記載されています。 +[`--enable-lms`](chapter02.md#--enable-lms)を指定してwolfSSLをビルドしてください。 +外部ライブラリは必要ありません。 +`--enable-all-quantum-crypto`でもLMS/HSSが有効になります。 +`--enable-lms`には、サブオプションをカンマ区切りのリストで指定できます。 -#### ベンチマークデータ +- `verify-only`: 署名検証のみをコンパイルします(`WOLFSSL_LMS_VERIFY_ONLY`)。 +- `small`: メモリが限られている場合向けに、署名が遅くなる代わりにコードを小さくします(`WOLFSSL_WC_LMS_SMALL`)。 +- `sha256-192`: SHA-256/192パラメータセットを追加します(`WOLFSSL_LMS_SHA256_192`)。 +- `shake256`: SHAKE256/256およびSHAKE256/192パラメータセットを追加します(`WOLFSSL_LMS_SHAKE256`)。 +- `no-sha256-256`: SHA-256/256パラメータセットを除外します(`WOLFSSL_NO_LMS_SHA256_256`)。 + `sha256-192`または`shake256`と組み合わせる必要があります。 -次のベンチマークデータは、8コアIntel i7-8700 CPU@3.20GHz、Fedora 38(`6.2.9-300.fc38.x86_64`)で取得されました。 -マルチスレッドの例では4スレッドと4コアが使用されましたが、シングルスレッドの例では1コアのみが使用されました。 +例えば、次のように指定します。 -INSTALLファイルの項目17で説明されているように、hash-sigsライブラリは2つの静的ライブラリを提供します。 +```sh +./configure --enable-lms=sha256-192,shake256 +``` -- `hss_lib.a`: シングルスレッド -- `hss_lib_thread.a`: マルチスレッド +smallビルド以外では、`WOLFSSL_LMS_ROOT_LEVELS`と`WOLFSSL_LMS_CACHE_BITS`(どちらもデフォルトは5、`WOLFSSL_LMS_LARGE_CACHES`を定義した場合は7)によって、`LmsKey`オブジェクトのサイズと引き換えに署名を高速化できます。 +これらについては`wolfssl/wolfcrypt/wc_lms.h`で説明しています。 -マルチスレッドバージョンではワーカースレッドが生成され、鍵生成などのCPUを集中的に使用するタスクが高速化されます。 -これにより、主にすべてのパラメータ値に対する鍵の生成と署名が高速化され、より大きなレベル値の検証も多少高速化されます。 +#### LMS/HSS鍵の使用 -なお、以下のベンチマークは次の構成オプションを有効化して取得しました。 +署名鍵は、次の手順で使用します。 -```text - ./configure \ - --enable-static \ - --disable-shared \ - --enable-lms=yes \ - --with-liblms= -``` +1. [`wc_LmsKey_Init()`](group__LMS.md#function-wc_lmskey_init)を呼び出し、[`wc_LmsKey_SetLmsParm()`](group__LMS.md#function-wc_lmskey_setlmsparm)または[`wc_LmsKey_SetParameters()`](group__LMS.md#function-wc_lmskey_setparameters)でパラメータセットを選択します。 +2. [`wc_LmsKey_SetWriteCb()`](group__LMS.md#function-wc_lmskey_setwritecb)、[`wc_LmsKey_SetReadCb()`](group__LMS.md#function-wc_lmskey_setreadcb)、[`wc_LmsKey_SetContext()`](group__LMS.md#function-wc_lmskey_setcontext)で、秘密鍵のコールバックを設定します。 + コンテキストポインタ(例えばファイル名)はコールバックに渡されます。 +3. [`wc_LmsKey_MakeKey()`](group__LMS.md#function-wc_lmskey_makekey)は鍵ペアを生成し、書き込みコールバックで秘密鍵を保存します。 + 公開鍵は[`wc_LmsKey_ExportPubRaw()`](group__LMS.md#function-wc_lmskey_exportpubraw)でエクスポートします。 +4. [`wc_LmsKey_Sign()`](group__LMS.md#function-wc_lmskey_sign)は、呼び出すたびにワンタイム鍵を1つ消費し、署名を返す前に、更新された秘密鍵を書き込みコールバックで保存します。 + [`wc_LmsKey_SigsLeft()`](group__LMS.md#function-wc_lmskey_sigsleft)は、その鍵でまだ署名できる間は0以外の値を返します。 +5. 後で(例えば再起動後に)署名を続けるには、同じパラメータセットとコールバックで新しい`LmsKey`を設定し、[`wc_LmsKey_Reload()`](group__LMS.md#function-wc_lmskey_reload)を呼び出します。 + この関数は読み込みコールバックで秘密鍵を読み込み、キャッシュされたツリーの状態を再構築します。 + これには鍵生成とほぼ同じ時間がかかります。 + 再読み込みした鍵で署名はできますが、公開鍵は保持していないため、鍵生成後にエクスポートした公開鍵を保管しておいてください。 -**マルチスレッドベンチマーク** +コールバックの型は次の通りです。 -以下は、集中的なタスクを並列化するために4スレッドを使用し、4コアを使用したマルチスレッド `hss_lib_thread.a` と共にビルドして取得したベンチマークデータです。 +```c +typedef int (*wc_lms_write_private_key_cb)(const byte* priv, word32 privSz, + void* context); +typedef int (*wc_lms_read_private_key_cb)(byte* priv, word32 privSz, + void* context); +``` -```text -./wolfcrypt/benchmark/benchmark -lms_hss ------------------------------------------------------------------------------- - wolfSSL version 5.6.3 ------------------------------------------------------------------------------- -Math: Multi-Precision: Wolf(SP) word-size=64 bits=4096 sp_int.c -wolfCrypt Benchmark (block bytes 1048576, min 1.0 sec each) -LMS/HSS L2_H10_W2 9300 sign 1500 ops took 1.075 sec, avg 0.717 ms, 1394.969 ops/sec -LMS/HSS L2_H10_W2 9300 verify 5200 ops took 1.002 sec, avg 0.193 ms, 5189.238 ops/sec -LMS/HSS L2_H10_W4 5076 sign 800 ops took 1.012 sec, avg 1.265 ms, 790.776 ops/sec -LMS/HSS L2_H10_W4 5076 verify 2500 ops took 1.003 sec, avg 0.401 ms, 2493.584 ops/sec -LMS/HSS L3_H5_W4 7160 sign 1500 ops took 1.051 sec, avg 0.701 ms, 1427.485 ops/sec -LMS/HSS L3_H5_W4 7160 verify 2700 ops took 1.024 sec, avg 0.379 ms, 2636.899 ops/sec -LMS/HSS L3_H5_W8 3992 sign 300 ops took 1.363 sec, avg 4.545 ms, 220.030 ops/sec -LMS/HSS L3_H5_W8 3992 verify 400 ops took 1.066 sec, avg 2.664 ms, 375.335 ops/sec -LMS/HSS L3_H10_W4 7640 sign 900 ops took 1.090 sec, avg 1.211 ms, 825.985 ops/sec -LMS/HSS L3_H10_W4 7640 verify 2400 ops took 1.037 sec, avg 0.432 ms, 2314.464 ops/sec -LMS/HSS L4_H5_W8 5340 sign 300 ops took 1.310 sec, avg 4.367 ms, 228.965 ops/sec -LMS/HSS L4_H5_W8 5340 verify 400 ops took 1.221 sec, avg 3.053 ms, 327.599 ops/sec -Benchmark complete +書き込みコールバックは、秘密鍵が不揮発性ストレージに格納されて初めて`WC_LMS_RC_SAVED_TO_NV_MEMORY`を返すようにしてください。 +読み込みコールバックは、`priv`にデータを格納した時点で`WC_LMS_RC_READ_TO_MEMORY`を返します。 +それ以外の値を返すと、呼び出しは`IO_FAILED_E`で失敗します。 +署名中に更新された秘密鍵の保存に失敗した場合、`wc_LmsKey_Sign()`は署名を消去し、その鍵ではそれ以上署名できなくなります。 +同じ秘密鍵の2つのコピーで署名したり、保存されている秘密鍵を古いコピーに戻したりしないでください。 +どちらもワンタイム鍵の再利用につながります。 + +検証するには、[`wc_LmsKey_ImportPubRaw()`](group__LMS.md#function-wc_lmskey_importpubraw)で公開鍵を専用の鍵オブジェクトにインポートし、[`wc_LmsKey_Verify()`](group__LMS.md#function-wc_lmskey_verify)を呼び出します。 +`wc_LmsKey_ImportPubRaw()`は、パラメータセットが設定されていない場合、公開鍵からパラメータセットを取得します。 + +次の例では、小さなパラメータセット`WC_LMS_PARM_L1_H5_W8`(32署名)で鍵を生成し、秘密鍵をファイルに保存して、署名と検証を行い、鍵を再読み込みして再び署名します。 + +```c +#include +#include +#include +#include +#include +#include +#include + +/* The private key must be stored before wc_LmsKey_MakeKey() or + * wc_LmsKey_Sign() returns. Only return WC_LMS_RC_SAVED_TO_NV_MEMORY once the + * data is durable (a real application should write a new file, sync it and + * rename it over the old one). */ +static int lms_write_key(const byte* priv, word32 privSz, void* context) +{ + FILE* f = fopen((const char*)context, "wb"); + int ok; + + if (f == NULL) + return WC_LMS_RC_WRITE_FAIL; + ok = (fwrite(priv, 1, privSz, f) == privSz); + if (fclose(f) != 0) + ok = 0; + return ok ? WC_LMS_RC_SAVED_TO_NV_MEMORY : WC_LMS_RC_WRITE_FAIL; +} + +/* Called by wc_LmsKey_Reload() to load the stored private key. */ +static int lms_read_key(byte* priv, word32 privSz, void* context) +{ + FILE* f = fopen((const char*)context, "rb"); + size_t n; + + if (f == NULL) + return WC_LMS_RC_READ_FAIL; + n = fread(priv, 1, privSz, f); + fclose(f); + return (n == privSz) ? WC_LMS_RC_READ_TO_MEMORY : WC_LMS_RC_READ_FAIL; +} + +/* Set the parameters and callbacks: needed before MakeKey and Reload. */ +static int lms_setup(LmsKey* key, const char* file) +{ + int ret = wc_LmsKey_Init(key, NULL, INVALID_DEVID); + if (ret == 0) + ret = wc_LmsKey_SetLmsParm(key, WC_LMS_PARM_L1_H5_W8); + if (ret == 0) + ret = wc_LmsKey_SetWriteCb(key, lms_write_key); + if (ret == 0) + ret = wc_LmsKey_SetReadCb(key, lms_read_key); + if (ret == 0) + ret = wc_LmsKey_SetContext(key, (void*)file); + return ret; +} + +int main(void) +{ + const char* file = "lms_priv.key"; + const byte msg[] = "firmware image"; + byte pub[HSS_MAX_PUBLIC_KEY_LEN]; + word32 pubSz = sizeof(pub); + byte* sig = NULL; + word32 sigSz = 0; + LmsKey key; + LmsKey verifyKey; + WC_RNG rng; + int ret; + + ret = wc_InitRng(&rng); + if (ret != 0) + return 1; + + /* Generate a new key pair. The private key is written with the write + * callback. */ + ret = lms_setup(&key, file); + if (ret == 0) + ret = wc_LmsKey_MakeKey(&key, &rng); + if (ret == 0) + ret = wc_LmsKey_ExportPubRaw(&key, pub, &pubSz); + if (ret == 0) + ret = wc_LmsKey_GetSigLen(&key, &sigSz); + if (ret == 0) { + sig = (byte*)malloc(sigSz); + if (sig == NULL) + ret = MEMORY_E; + } + /* Each signature uses up one one-time key. The updated private key is + * written before the signature is returned. */ + if (ret == 0) + ret = wc_LmsKey_Sign(&key, sig, &sigSz, msg, (int)sizeof(msg)); + wc_LmsKey_Free(&key); + + /* Verify with a public-key-only object. The parameter set is taken from + * the public key. */ + if (ret == 0) + ret = wc_LmsKey_Init(&verifyKey, NULL, INVALID_DEVID); + if (ret == 0) { + ret = wc_LmsKey_ImportPubRaw(&verifyKey, pub, pubSz); + if (ret == 0) + ret = wc_LmsKey_Verify(&verifyKey, sig, sigSz, msg, + (int)sizeof(msg)); + wc_LmsKey_Free(&verifyKey); + } + + /* Later, for example after a restart: reload the stored private key and + * carry on signing where it left off. */ + if (ret == 0) + ret = lms_setup(&key, file); + if (ret == 0) + ret = wc_LmsKey_Reload(&key); + if ((ret == 0) && (wc_LmsKey_SigsLeft(&key) == 0)) + ret = KEY_EXHAUSTED_E; + if (ret == 0) + ret = wc_LmsKey_Sign(&key, sig, &sigSz, msg, (int)sizeof(msg)); + wc_LmsKey_Free(&key); + + printf("LMS example %s (%d)\n", (ret == 0) ? "passed" : "failed", ret); + free(sig); + wc_FreeRng(&rng); + return (ret == 0) ? 0 : 1; +} ``` -**シングルスレッドベンチマーク** +#### ベンチマークデータ -以下は、シングルスレッドの`hss_lib.a`と共にビルドして取得したベンチマークデータです -これは単一のコアのみを使用します。 +次のベンチマークデータは、「統計データ」節で説明しているApple M5システム上で、`./configure --enable-lms --enable-xmss --enable-armasm`および`./configure --enable-lms --enable-xmss`で構成したwolfSSL 5.9.4を使用し、次のコマンドを実行して取得しました。 -```text -$ ./wolfcrypt/benchmark/benchmark -lms_hss ------------------------------------------------------------------------------- - wolfSSL version 5.6.3 ------------------------------------------------------------------------------- -Math: Multi-Precision: Wolf(SP) word-size=64 bits=4096 sp_int.c -wolfCrypt Benchmark (block bytes 1048576, min 1.0 sec each) -LMS/HSS L2_H10_W2 9300 sign 800 ops took 1.115 sec, avg 1.394 ms, 717.589 ops/sec -LMS/HSS L2_H10_W2 9300 verify 4500 ops took 1.001 sec, avg 0.223 ms, 4493.623 ops/sec -LMS/HSS L2_H10_W4 5076 sign 500 ops took 1.239 sec, avg 2.478 ms, 403.519 ops/sec -LMS/HSS L2_H10_W4 5076 verify 2100 ops took 1.006 sec, avg 0.479 ms, 2087.944 ops/sec -LMS/HSS L3_H5_W4 7160 sign 800 ops took 1.079 sec, avg 1.349 ms, 741.523 ops/sec -LMS/HSS L3_H5_W4 7160 verify 1600 ops took 1.012 sec, avg 0.632 ms, 1581.686 ops/sec -LMS/HSS L3_H5_W8 3992 sign 100 ops took 1.042 sec, avg 10.420 ms, 95.971 ops/sec -LMS/HSS L3_H5_W8 3992 verify 200 ops took 1.220 sec, avg 6.102 ms, 163.894 ops/sec -LMS/HSS L3_H10_W4 7640 sign 400 ops took 1.010 sec, avg 2.526 ms, 395.864 ops/sec -LMS/HSS L3_H10_W4 7640 verify 1500 ops took 1.052 sec, avg 0.701 ms, 1426.284 ops/sec -LMS/HSS L4_H5_W8 5340 sign 100 ops took 1.066 sec, avg 10.665 ms, 93.768 ops/sec -LMS/HSS L4_H5_W8 5340 verify 200 ops took 1.478 sec, avg 7.388 ms, 135.358 ops/sec -Benchmark complete +```sh +./wolfcrypt/benchmark/benchmark -lms_hss ``` -### XMSS/XMSS^MT 署名 - -wolfSSLは、XMSS/XMSS^MTステートフルハッシュベース署名のサポートを追加しています。 -LMSと同様に、これは[RFC 8391](https://tex2e.github.io/rfc-translater/html/rfc8391.html) のxmss-reference リポジトリ (https://github.com/XMSS/xmss-reference.git) との実験的な統合によって実現されています。 +各時間はミリ秒単位の平均値で、`--enable-armasm`ありの値を先に、なしの値を後に示しています。 +`--enable-armasm`はARMv8のSHA-256命令を使用するため、LMS/HSSのすべての操作が高速化されます。 +再読み込みは`wc_LmsKey_Reload()`の時間です。 +シングルコアのみを使用しています。 + +パラメータセット | 署名サイズ | 鍵生成 (ms) | 再読み込み (ms) | 署名 (ms) | 検証 (ms) +------------- | -------------- | ---------------- | ---------------- | ------------- | ------------- +L1_H5_W4 | 2352 | 1.066 / 5.535 | 1.071 / 5.381 | 0.017 / 0.089 | 0.016 / 0.085 +L1_H5_W8 | 1296 | 8.562 / 42.308 | 10.534 / 42.950 | 0.382 / 0.645 | 0.206 / 0.753 +L2_H10_W2 | 9300 | 37.449 / 188.105 | 34.651 / 188.645 | 0.052 / 0.281 | 0.016 / 0.088 +L2_H10_W4 | 5076 | 68.022 / 343.029 | 67.543 / 344.260 | 0.099 / 0.507 | 0.034 / 0.178 +L3_H5_W4 | 7160 | 3.312 / 17.186 | 3.391 / 17.427 | 0.053 / 0.268 | 0.048 / 0.268 +L3_H5_W8 | 3992 | 26.232 / 144.790 | 26.499 / 140.189 | 0.411 / 2.185 | 0.408 / 2.240 +L3_H10_W4 | 7640 | 103.184 / 548.525 | 102.161 / 563.973 | 0.099 / 0.546 | 0.050 / 0.258 +L4_H5_W8 | 5340 | 35.179 / 188.079 | 35.460 / 187.302 | 0.417 / 2.174 | 0.573 / 3.758 -xmss-referenceは、`xmss_core_fast` および `xmss_core` 実装をサポートしています。 -`xmss_core_fast` 実装は、トレードオフとしてより大きな秘密鍵サイズでパフォーマンスを優先するように設計されています。 +### XMSS/XMSS^MT 署名 -当社の統合では `xmss_core_fast` を使用していますが、パッチが適用されているため、代わりに wolfCrypt SHA256実装を使用できます。 +wolfCryptは、[RFC 8391](https://tex2e.github.io/rfc-translater/html/rfc8391.html)およびNIST SP 800-208のXMSSおよびXMSS^MTステートフルハッシュベース署名スキームのネイティブ実装を備えています。 +[`--enable-xmss`](chapter02.md#--enable-xmss)を指定してwolfSSLをビルドしてください。 +外部ライブラリは必要ありません。 +`--enable-all-quantum-crypto`でもXMSS/XMSS^MTが有効になります。 +`--enable-xmss`には、次のサブオプションがあります。 -パッチは、[wolfssl-examplesリポジトリ](https://github.com/wolfSSL/wolfssl-examples)の -``` -pq/stateful_hash_sig/0001-Patch-to-support-wolfSSL-xmss-reference-integration.patch -``` -にて公開しています。 +- `verify-only`: 署名検証のみをコンパイルします(`WOLFSSL_XMSS_VERIFY_ONLY`)。 +- `small`: コードを小さくし、秘密鍵も大幅に小さくします(`WOLFSSL_WC_XMSS_SMALL`)。 + この場合、秘密鍵はツリー走査の状態を保持しないため、署名は大幅に遅くなります。 全体的に、XMSS/XMSS^MTはLMS/HSSに似ています。 より詳細な比較については、[「LMS vs XMSS: 2 つのハッシュベース署名標準の比較」](https://eprint.iacr.org/2017/349.pdf) をご参照ください。 XMSS^MTはXMSSのマルチツリー一般化であり、HSS with LMSに似ていますが、XMSS/XMSS^MTではWinternitz値が `w=16` に固定されている点が異なります。 -公開鍵はXMSS/XMSS\^MTでは若干大きくなり(XMSS/XMSS\^MTでは68 バイト、LMS/HSSでは60バイト)、署名は若干小さくなります。 +公開鍵はXMSS/XMSS^MT では若干大きくなり(XMSS/XMSS^MT では68バイト、LMS/HSSでは60バイト)、署名は若干小さくなります。 #### サポートしているパラメータ -wolfSSLは、[NIST SP 800-208](https://csrc.nist.gov/pubs/sp/800/208/final) の表10および11のSHA256 XMSS/XMSS^MTパラメータセットをサポートしています。 +wolfSSLは、組み込まれている各ハッシュアルゴリズムについて、RFC 8391およびNIST SP 800-208のXMSS/XMSS^MTパラメータセットをサポートしています。 +対象は、n = 32およびn = 24のSHA2-256、SHA2-512(n = 64)、SHAKE128(n = 32)、およびn = 64、32、24のSHAKE256です。 +FIPSビルドがサポートするのは、n = 32およびn = 24のSHA2-256とSHAKE256のセットのみです。 +以下の表は、[NIST SP 800-208](https://csrc.nist.gov/pubs/sp/800/208/final)の表10および11から、n = 32のSHA2-256パラメータセットを示したものです。 +その他のセットの名前も同じパターンに従います。 +例えば、"XMSS-SHA2_10_192"、"XMSS-SHA2_10_512"、"XMSS-SHAKE_10_256"、"XMSS-SHAKE256_10_256"、"XMSSMT-SHAKE256_60/12_192"などです。 +完全な一覧は`wolfcrypt/src/wc_xmss.c`にあります。 +`WOLFSSL_XMSS_MIN_HEIGHT`と`WOLFSSL_XMSS_MAX_HEIGHT`(デフォルトはそれぞれ10と60)によって、コンパイルに含めるツリーの合計の高さを制限できます。 parameter set name | Oid | n | w | h | d | h/d | Sig len ----------------------- | ----------- | --- | --- | --- | --- | --- | -- @@ -1130,142 +887,124 @@ XMSS^MT | | | | | | | "XMSSMT-SHA2_60/6_256" | 0x00000007 | 32 | 16 | 60 | 6 | 10 | 14824 "XMSSMT-SHA2_60/12_256" | 0x00000008 | 32 | 16 | 60 | 12 | 5 | 27688 -上記の表で、`n` は HASH 関数のバイト数、`w` はWinternitz値、`h` はツリーシステムの合計高さ、`d` はツリーのレベルを示します。 +上記の表で、`n` は HASH 関数のバイト数、`w` はWinternitz値、`h` はツリーシステムの合計高さ、`d` はツリーのレベル数を示します。 鍵生成時間は第1レベルのツリーの高さ(または`h/d`) によって大きく左右されますが、署名の長さは主に`d` (ハイパーツリーレベルの数)とともに増加します。 LMS/HSSと同様に、使用可能な署名の数は `2**h` に比例して増加します。 -ここで `h` はツリー システムの合計高さです。 - - -#### ベンチマークデータ - -以下では、Intel x86_64およびaarch64のいくつかのXMSS/XMSS^MTパラメータセットのベンチマーク データを示します。 -これらのシステムでのSHA256パフォーマンスも参考として記載されています。 -必要なハッシュチェーンの数が多いため、XMSS/XMSS^MTのCPU 作業の大部分が計算されるためです。 -さらに、xmss-referenceへのパッチはwolfCryptのSHA256実装を置き換えるため、同じASMの高速化のメリットが得られます。 - -前述のように、XMSS統合ではxmss-referenceの`xmss_core_fast`実装を使用しています。 -この実装は、秘密鍵のサイズが大きいというトレードオフで、より高速なパフォーマンスを実現します。 - -**x86_64** - -以下のx86_64ベンチマークデータは、Fedora 38 (`6.2.9-300.fc38.x86_64`) が動作するIntel i7-8700 CPU @ 3.20GHz(8コア)で取得しました。 -このCPUには`avx avx2`フラグがあり、`--enable-intelasm` を有効化することでハッシュ操作を高速化できます。 - -`--enable-intelasm` を使用する場合 - -```text -$./wolfcrypt/benchmark/benchmark -xmss_xmssmt -sha256 ------------------------------------------------------------------------------- - wolfSSL version 5.6.3 ------------------------------------------------------------------------------- -Math: Multi-Precision: Wolf(SP) word-size=64 bits=4096 sp_int.c -wolfCrypt Benchmark (block bytes 1048576, min 1.0 sec each) -SHA-256 500 MiB took 1.009 seconds, 495.569 MiB/s Cycles per byte = 6.14 -XMSS-SHA2_10_256 2500 sign 200 ops took 1.010 sec, avg 5.052 ms, 197.925 ops/sec -XMSS-SHA2_10_256 2500 verify 1600 ops took 1.011 sec, avg 0.632 ms, 1582.844 ops/sec -XMSSMT-SHA2_20/2_256 4963 sign 200 ops took 1.286 sec, avg 6.431 ms, 155.504 ops/sec -XMSSMT-SHA2_20/2_256 4963 verify 700 ops took 1.009 sec, avg 1.441 ms, 693.905 ops/sec -XMSSMT-SHA2_20/4_256 9251 sign 300 ops took 1.223 sec, avg 4.076 ms, 245.335 ops/sec -XMSSMT-SHA2_20/4_256 9251 verify 400 ops took 1.027 sec, avg 2.569 ms, 389.329 ops/sec -XMSSMT-SHA2_40/4_256 9893 sign 200 ops took 1.466 sec, avg 7.332 ms, 136.394 ops/sec -XMSSMT-SHA2_40/4_256 9893 verify 400 ops took 1.024 sec, avg 2.560 ms, 390.627 ops/sec -XMSSMT-SHA2_40/8_256 18469 sign 300 ops took 1.202 sec, avg 4.006 ms, 249.637 ops/sec -XMSSMT-SHA2_40/8_256 18469 verify 200 ops took 1.089 sec, avg 5.446 ms, 183.635 ops/sec -XMSSMT-SHA2_60/6_256 14824 sign 200 ops took 1.724 sec, avg 8.618 ms, 116.033 ops/sec -XMSSMT-SHA2_60/6_256 14824 verify 300 ops took 1.136 sec, avg 3.788 ms, 263.995 ops/sec -XMSSMT-SHA2_60/12_256 27688 sign 300 ops took 1.210 sec, avg 4.034 ms, 247.889 ops/sec -XMSSMT-SHA2_60/12_256 27688 verify 200 ops took 1.575 sec, avg 7.877 ms, 126.946 ops/sec -Benchmark complete -``` - -`--enable-intelasm` を使用しない場合 - -```text -$./wolfcrypt/benchmark/benchmark -xmss_xmssmt -sha256 ------------------------------------------------------------------------------- - wolfSSL version 5.6.3 ------------------------------------------------------------------------------- -Math: Multi-Precision: Wolf(SP) word-size=64 bits=4096 sp_int.c -wolfCrypt Benchmark (block bytes 1048576, min 1.0 sec each) -SHA-256 275 MiB took 1.005 seconds, 273.549 MiB/s Cycles per byte = 11.13 -XMSS-SHA2_10_256 2500 sign 200 ops took 1.356 sec, avg 6.781 ms, 147.480 ops/sec -XMSS-SHA2_10_256 2500 verify 1200 ops took 1.025 sec, avg 0.854 ms, 1170.547 ops/sec -XMSSMT-SHA2_20/2_256 4963 sign 200 ops took 1.687 sec, avg 8.436 ms, 118.546 ops/sec -XMSSMT-SHA2_20/2_256 4963 verify 600 ops took 1.187 sec, avg 1.978 ms, 505.663 ops/sec -XMSSMT-SHA2_20/4_256 9251 sign 200 ops took 1.119 sec, avg 5.593 ms, 178.785 ops/sec -XMSSMT-SHA2_20/4_256 9251 verify 300 ops took 1.086 sec, avg 3.622 ms, 276.122 ops/sec -XMSSMT-SHA2_40/4_256 9893 sign 200 ops took 1.991 sec, avg 9.954 ms, 100.460 ops/sec -XMSSMT-SHA2_40/4_256 9893 verify 300 ops took 1.043 sec, avg 3.478 ms, 287.545 ops/sec -XMSSMT-SHA2_40/8_256 18469 sign 200 ops took 1.114 sec, avg 5.572 ms, 179.454 ops/sec -XMSSMT-SHA2_40/8_256 18469 verify 200 ops took 1.495 sec, avg 7.476 ms, 133.770 ops/sec -XMSSMT-SHA2_60/6_256 14824 sign 100 ops took 1.111 sec, avg 11.114 ms, 89.975 ops/sec -XMSSMT-SHA2_60/6_256 14824 verify 200 ops took 1.070 sec, avg 5.349 ms, 186.963 ops/sec -XMSSMT-SHA2_60/12_256 27688 sign 200 ops took 1.148 sec, avg 5.739 ms, 174.247 ops/sec -XMSSMT-SHA2_60/12_256 27688 verify 100 ops took 1.080 sec, avg 10.797 ms, 92.618 ops/sec -Benchmark complete +ここで `h` はツリーシステムの合計高さです。 + +#### XMSS/XMSS^MT 鍵の使用 + +XMSS/XMSS^MT 鍵は、`wc_XmssKey_`関数を使用して、LMS/HSS鍵と同じ方法で使用します。 +保存される秘密鍵についても同じ規則が適用されます。 +相違点は次の通りです。 + +- パラメータセットは、[`wc_XmssKey_SetParamStr()`](group__XMSS.md#function-wc_xmsskey_setparamstr)で名前によって選択します。 + 例えば、"XMSS-SHA2_10_256"や"XMSSMT-SHA2_20/4_256"のように指定します。 +- コールバックは`enum wc_XmssRc`を返します。 + 書き込みコールバックは`WC_XMSS_RC_SAVED_TO_NV_MEMORY`を、読み込みコールバックは`WC_XMSS_RC_READ_TO_MEMORY`を返します。 +- wolfCryptは、署名と署名の間に秘密鍵をメモリ上に保持しません。 + [`wc_XmssKey_Sign()`](group__XMSS.md#function-wc_xmsskey_sign)は、読み込みコールバックで秘密鍵を読み込んで署名し、更新された秘密鍵を書き込みコールバックで保存してから、自身のコピーを消去します。 + そのため、署名の前に両方のコールバックを設定しておく必要があります。 + [`wc_XmssKey_SigsLeft()`](group__XMSS.md#function-wc_xmsskey_sigsleft)も保存されている秘密鍵を読み込みます。 + [`wc_XmssKey_Reload()`](group__XMSS.md#function-wc_xmsskey_reload)は、秘密鍵を読み込めることを確認するだけです。 +- 検証専用の鍵では、[`wc_XmssKey_ImportPubRaw()`](group__XMSS.md#function-wc_xmsskey_importpubraw)の前に`wc_XmssKey_SetParamStr()`でパラメータ文字列を設定する必要があります。 +- 秘密鍵の形式はwolfSSL固有であり、そのサイズはパラメータセットと`small`オプションによって異なります("XMSS-SHA2_10_256"の場合、デフォルトでは1343バイト、`small`では136バイトです)。 + XMSS/XMSS^MTの秘密鍵が他の実装で使用できるとは想定しないでください。 + +例えば、コールバックと鍵生成は次のようになります。 + +```c +static enum wc_XmssRc xmss_write_key(const byte* priv, word32 privSz, + void* context) +{ + FILE* f = fopen((const char*)context, "wb"); + int ok; + + if (f == NULL) + return WC_XMSS_RC_WRITE_FAIL; + ok = (fwrite(priv, 1, privSz, f) == privSz); + if (fclose(f) != 0) + ok = 0; + return ok ? WC_XMSS_RC_SAVED_TO_NV_MEMORY : WC_XMSS_RC_WRITE_FAIL; +} + +static enum wc_XmssRc xmss_read_key(byte* priv, word32 privSz, void* context) +{ + FILE* f = fopen((const char*)context, "rb"); + size_t n; + + if (f == NULL) + return WC_XMSS_RC_READ_FAIL; + n = fread(priv, 1, privSz, f); + fclose(f); + return (n == privSz) ? WC_XMSS_RC_READ_TO_MEMORY : WC_XMSS_RC_READ_FAIL; +} + + /* In a function with XmssKey key, an initialized WC_RNG rng, + * byte pub[XMSS_SHA256_PUBLEN] and word32 pubSz = sizeof(pub): */ + ret = wc_XmssKey_Init(&key, NULL, INVALID_DEVID); + if (ret == 0) + ret = wc_XmssKey_SetParamStr(&key, "XMSS-SHA2_10_256"); + if (ret == 0) + ret = wc_XmssKey_SetWriteCb(&key, xmss_write_key); + if (ret == 0) + ret = wc_XmssKey_SetReadCb(&key, xmss_read_key); + if (ret == 0) + ret = wc_XmssKey_SetContext(&key, (void*)"xmss_priv.key"); + if (ret == 0) + ret = wc_XmssKey_MakeKey(&key, &rng); + if (ret == 0) + ret = wc_XmssKey_ExportPubRaw(&key, pub, &pubSz); ``` -**aarch64** +#### ベンチマークデータ -以下のaarch64データは、CPUフラグ`sha1 sha2 sha3 sha512`を使用してApple M1上で実行されているUbuntu(`5.15.0-71-generic`) で取得されました。 -`--enable-armasm` を使用してビルドすると、特に SHA ハッシュ操作が大幅に高速化されます。 +以下では、SHA2-256 XMSS/XMSS^MTパラメータセットのベンチマークデータを示します。 +必要となる多数のハッシュチェーンの計算がXMSS/XMSS^MTのCPU処理の大部分を占めるため、SHA256のパフォーマンスも参考として記載しています。 +wolfCryptのXMSS/XMSS^MT実装はwolfCryptのSHA-256コードを使用しているため、同じASMによる高速化の恩恵を受けます。 -`--enable-armasm`を使用する場合 +データは、「統計データ」節で説明しているApple M5システム上で、LMS/HSSのデータと同じ2つのビルド(`--enable-armasm`ありとなし)を使用し、次のコマンドを実行して取得しました。 -```text -$ ./wolfcrypt/benchmark/benchmark -xmss_xmssmt -sha256 ------------------------------------------------------------------------------- - wolfSSL version 5.6.3 ------------------------------------------------------------------------------- -Math: Multi-Precision: Wolf(SP) word-size=64 bits=4096 sp_int.c -wolfCrypt Benchmark (block bytes 1048576, min 1.0 sec each) -SHA-256 2305 MiB took 1.001 seconds, 2303.346 MiB/s -XMSS-SHA2_10_256 2500 sign 800 ops took 1.079 sec, avg 1.349 ms, 741.447 ops/sec -XMSS-SHA2_10_256 2500 verify 6500 ops took 1.007 sec, avg 0.155 ms, 6455.445 ops/sec -XMSSMT-SHA2_20/2_256 4963 sign 700 ops took 1.155 sec, avg 1.650 ms, 606.154 ops/sec -XMSSMT-SHA2_20/2_256 4963 verify 3100 ops took 1.021 sec, avg 0.329 ms, 3037.051 ops/sec -XMSSMT-SHA2_20/4_256 9251 sign 1100 ops took 1.006 sec, avg 0.915 ms, 1093.191 ops/sec -XMSSMT-SHA2_20/4_256 9251 verify 1700 ops took 1.013 sec, avg 0.596 ms, 1677.399 ops/sec -XMSSMT-SHA2_40/4_256 9893 sign 600 ops took 1.096 sec, avg 1.827 ms, 547.226 ops/sec -XMSSMT-SHA2_40/4_256 9893 verify 1600 ops took 1.062 sec, avg 0.664 ms, 1506.946 ops/sec -XMSSMT-SHA2_40/8_256 18469 sign 1100 ops took 1.007 sec, avg 0.916 ms, 1092.214 ops/sec -XMSSMT-SHA2_40/8_256 18469 verify 900 ops took 1.088 sec, avg 1.209 ms, 827.090 ops/sec -XMSSMT-SHA2_60/6_256 14824 sign 600 ops took 1.179 sec, avg 1.966 ms, 508.728 ops/sec -XMSSMT-SHA2_60/6_256 14824 verify 1100 ops took 1.038 sec, avg 0.944 ms, 1059.590 ops/sec -XMSSMT-SHA2_60/12_256 27688 sign 1100 ops took 1.015 sec, avg 0.923 ms, 1083.767 ops/sec -XMSSMT-SHA2_60/12_256 27688 verify 600 ops took 1.149 sec, avg 1.914 ms, 522.367 ops/sec -Benchmark complete +```sh +./wolfcrypt/benchmark/benchmark -xmss_xmssmt -sha256 ``` -`--enable-armasm`を使用しない場合 - -```text -$ ./wolfcrypt/benchmark/benchmark -xmss_xmssmt -sha256 ------------------------------------------------------------------------------- - wolfSSL version 5.6.3 ------------------------------------------------------------------------------- -Math: Multi-Precision: Wolf(SP) word-size=64 bits=4096 sp_int.c -wolfCrypt Benchmark (block bytes 1048576, min 1.0 sec each) -SHA-256 190 MiB took 1.020 seconds, 186.277 MiB/s -XMSS-SHA2_10_256 2500 sign 200 ops took 1.908 sec, avg 9.538 ms, 104.845 ops/sec -XMSS-SHA2_10_256 2500 verify 800 ops took 1.002 sec, avg 1.253 ms, 798.338 ops/sec -XMSSMT-SHA2_20/2_256 4963 sign 100 ops took 1.084 sec, avg 10.843 ms, 92.222 ops/sec -XMSSMT-SHA2_20/2_256 4963 verify 500 ops took 1.240 sec, avg 2.479 ms, 403.334 ops/sec -XMSSMT-SHA2_20/4_256 9251 sign 200 ops took 1.615 sec, avg 8.074 ms, 123.855 ops/sec -XMSSMT-SHA2_20/4_256 9251 verify 200 ops took 1.071 sec, avg 5.355 ms, 186.726 ops/sec -XMSSMT-SHA2_40/4_256 9893 sign 100 ops took 1.354 sec, avg 13.543 ms, 73.840 ops/sec -XMSSMT-SHA2_40/4_256 9893 verify 300 ops took 1.483 sec, avg 4.945 ms, 202.237 ops/sec -XMSSMT-SHA2_40/8_256 18469 sign 200 ops took 1.588 sec, avg 7.941 ms, 125.922 ops/sec -XMSSMT-SHA2_40/8_256 18469 verify 100 ops took 1.042 sec, avg 10.415 ms, 96.014 ops/sec -XMSSMT-SHA2_60/6_256 14824 sign 100 ops took 1.571 sec, avg 15.710 ms, 63.654 ops/sec -XMSSMT-SHA2_60/6_256 14824 verify 200 ops took 1.526 sec, avg 7.632 ms, 131.033 ops/sec -XMSSMT-SHA2_60/12_256 27688 sign 200 ops took 1.607 sec, avg 8.036 ms, 124.434 ops/sec -XMSSMT-SHA2_60/12_256 27688 verify 100 ops took 1.501 sec, avg 15.011 ms, 66.616 ops/sec -Benchmark complete -``` +`-xmss_xmssmt`はSHA2-256パラメータセット(n = 32およびn = 24)を実行します。 +`-xmss_xmssmt_sha512`、`-xmss_xmssmt_shake128`、`-xmss_xmssmt_shake256`は、その他のハッシュファミリーを実行します。 +SHA-256の速度は、`--enable-armasm`ありで2971.128 MiB/s、なしで451.523 MiB/sでした。 +x86_64では、`--enable-intelasm`によってアセンブリ版のSHA-256コードが有効になります。 + +各時間はミリ秒単位の平均値で、`--enable-armasm`ありの値を先に、なしの値を後に示しています。 +シングルコアのみを使用しています。 + +パラメータセット | 署名サイズ | 鍵生成 (ms) | 署名 (ms) | 検証 (ms) +---------------------- | -------------- | ------------------- | ------------- | ------------- +XMSS-SHA2_10_256 | 2500 | 147.243 / 706.314 | 0.659 / 3.129 | 0.081 / 0.364 +XMSS-SHA2_10_192 | 1492 | 152.998 / 669.786 | 0.680 / 2.939 | 0.086 / 0.386 +XMSSMT-SHA2_20/2_256 | 4963 | 298.039 / 1435.763 | 0.809 / 3.463 | 0.177 / 0.732 +XMSSMT-SHA2_20/4_256 | 9251 | 18.635 / 87.609 | 0.473 / 2.214 | 0.335 / 1.472 +XMSSMT-SHA2_40/4_256 | 9893 | 609.783 / 2879.408 | 0.862 / 3.975 | 0.339 / 1.590 +XMSSMT-SHA2_40/8_256 | 18469 | 39.661 / 189.600 | 0.481 / 2.349 | 0.647 / 3.061 +XMSSMT-SHA2_60/6_256 | 14824 | 916.980 / 4452.551 | 0.889 / 4.362 | 0.501 / 2.389 +XMSSMT-SHA2_60/12_256 | 27688 | 59.256 / 298.819 | 0.471 / 2.376 | 1.007 / 4.663 +XMSSMT-SHA2_20/2_192 | 2955 | 317.927 / 1407.238 | 0.826 / 3.531 | 0.166 / 0.818 +XMSSMT-SHA2_20/4_192 | 5403 | 20.774 / 93.409 | 0.477 / 2.312 | 0.341 / 1.535 +XMSSMT-SHA2_40/4_192 | 5885 | 641.373 / 3006.338 | 0.894 / 4.040 | 0.351 / 1.647 +XMSSMT-SHA2_40/8_192 | 10781 | 38.492 / 181.952 | 0.486 / 2.262 | 0.669 / 3.202 +XMSSMT-SHA2_60/6_192 | 8816 | 935.416 / 4241.281 | 0.862 / 4.085 | 0.508 / 2.212 +XMSSMT-SHA2_60/12_192 | 16160 | 55.882 / 263.694 | 0.446 / 2.222 | 0.959 / 4.503 ### 開発者ノート -* 「今収穫し、後で復号する」脅威モデルを阻止しようとしていて、相互運用性の一部を犠牲にしても構わない場合は、Supported Groups拡張機能で従来のアルゴリズムのサポートを広告したくないことと思います。選択したアルゴリズムで`wolfSSL_UseKeyShare()`と`wolfSSL_set_groups()`を必ず呼び出してください。`wolfSSL_UseKeyShare()`だけを呼び出すだけでは不十分です。なぜなら、それは量子的に脆弱なアルゴリズムのサポートを広告することになるからです。ピアがポスト量子アルゴリズムをサポートしていない場合、`HelloRetryRequest`を送信し、その結果として、従来のアルゴリズムとの接続が確立されます。 +* 「今収穫し、後で復号する」脅威モデルを阻止しようとしていて、相互運用性の一部を犠牲にしても構わない場合は、Supported Groups拡張機能で従来のアルゴリズムのサポートを広告したくないことと思います。 + wolfSSLクライアントはデフォルトで既にPQ/Tハイブリッドの鍵共有を送信し(Curve25519が組み込まれている場合はX25519MLKEM768、それ以外の場合はSecP256r1MLKEM768です。別のグループを選択するには`WOLFSSL_KEY_SHARE_DEFAULT_GROUP`を定義します)、Supported Groups拡張機能では標準のハイブリッドを先頭に列挙しますが、その後に従来のグループが続きます。 + ピアがポスト量子アルゴリズムをサポートしていない場合、ピアは`HelloRetryRequest`を送信し、その結果として、従来のアルゴリズムによる接続が確立されます。 + これを防ぐには、[`wolfSSL_CTX_set_groups()`](group__Setup.md#function-wolfssl_ctx_set_groups)または[`wolfSSL_set_groups()`](group__Setup.md#function-wolfssl_set_groups)で、あるいは名前を指定する[`wolfSSL_CTX_set1_groups_list()`](group__Setup.md#function-wolfssl_ctx_set1_groups_list)または[`wolfSSL_set1_groups_list()`](group__Setup.md#function-wolfssl_set1_groups_list)で、選択したグループのみを設定してください。 + 名前を指定する2つの関数には、OpenSSL互換レイヤー(例えば`--enable-opensslextra`)が必要です。 + 例えば、`"SecP384r1MLKEM1024:X25519MLKEM768"`のように指定します。 + 名前の大文字と小文字は区別されません。 + 鍵共有は、リスト内のグループのうち、ビルドがサポートしている最初のグループに対して作成されます。 + [`wolfSSL_UseKeyShare()`](group__Setup.md#function-wolfssl_usekeyshare)を呼び出すだけでは不十分です。 + それでは量子的に脆弱なアルゴリズムのサポートを広告することになるからです。 diff --git a/wolfSSL/src-ja/appendix10.md b/wolfSSL/src-ja/appendix10.md index 326b6f56..e1fc1889 100644 --- a/wolfSSL/src-ja/appendix10.md +++ b/wolfSSL/src-ja/appendix10.md @@ -2,7 +2,11 @@ ## 目的 -このガイドは、軽量 SSL/TLS ライブラリwolfSSLを新しい組み込みプラットフォーム、オペレーティングシステム、トランスポートメディア(TCP/IP、Bluetoothなど)に移植するエンジニア向けのリファレンスを提供します。wolfSSLを移植する際に通常変更が必要となるwolfSSLコードベースの領域を説明しています。本稿はあくまで「ガイド」で、技術の進化に伴い変更が必要になることもあります。不足していると感じる箇所があれば、気兼ねなくお知らせください。 +このガイドは、軽量 SSL/TLS ライブラリwolfSSLを新しい組み込みプラットフォーム、オペレーティングシステム、トランスポートメディア(TCP/IP、Bluetoothなど)に移植するエンジニア向けのリファレンスを提供します。 +wolfSSLを移植する際に通常変更が必要となるwolfSSLコードベースの領域を説明しています。 +本稿はあくまで「ガイド」で、技術の進化に伴い変更が必要になることもあります。 +不足していると感じる箇所があれば、気兼ねなくお知らせください。 +説明や補足を喜んで本ドキュメントに追加いたします。 ## 対象読者 @@ -12,17 +16,27 @@ ## 序章 -組み込みプラットフォームでwolfSSLを実行するには、いくつかの手順を繰り返す必要があります。これらの手順の一部は、[2.4章](chapter02.md#building-in-a-non-standard-environment) で概説しています。 +組み込みプラットフォームでwolfSSLを実行するには、いくつかの手順を繰り返す必要があります。 +これらの手順の一部は、[第2章 wolfSSLのビルド](chapter02.md)の「非標準環境でのビルド」節で概説しています。 -wolfSSLドキュメント第2章に示した手順に加えて、特定のプラットフォームに対応するために移植または変更が必要なコード領域があります。wolfSSLはこれらの領域の多くを抽象化して、新しいプラットフォームへできるだけ簡単に移植できるようにしています。 +wolfSSLドキュメント第2章に示した手順に加えて、特定のプラットフォームに対応するために移植または変更が必要なコード領域があります。 +wolfSSLはこれらの領域の多くを抽象化して、新しいプラットフォームへできるだけ簡単に移植できるようにしています。 -`./wolfssl/wolfcrypt/settings.h` ファイルには、さまざまなオペレーティングシステム、TCP/IPスタック、およびチップセット (例: MBED、FREESCALE_MQX、MICROCHIP_PIC32、MICRIUM、EBSNET など) に固有の定義がいくつかあります。wolfSSLをコンパイルして新しいプラットフォームに移植するときに、`#defines` を配置する主な場所は2つあります。 +`./wolfssl/wolfcrypt/settings.h` ファイルには、さまざまなオペレーティングシステム、TCP/IPスタック、およびチップセット (例: MBED、FREESCALE_MQX、MICROCHIP_PIC32、MICRIUM、EBSNET など) に固有の定義がいくつかあります。 +wolfSSLをコンパイルして新しいプラットフォームに移植するときに、`#defines` を配置する主な場所は2つあります。 -1. オペレーティングシステムまたはTCP/IPスタックに対応するための新たなマクロ定義は、通常、wolfSSLのポーティングが完了すると、`settings.h` ファイルに追加しています。これにより、機能のオン/オフを簡単に切り替えたり、そのビルドの「デフォルト」となるビルド設定をカスタマイズしたりできます。wolfSSLを新しいプラットフォームに移植する際にも、このファイルに新しいカスタム定義を追加することでお使いいただけます。新しいプラットフォームへの移植が完了した際、もし差し支えなければ、wolfSSLの [Gitリポジトリ](https://www.github.com/wolfssl/wolfssl) にPull Requestを送信していただけると嬉しく思います。これにより、より多くの環境でwolfSSLを使用しやすくなります。 +1. オペレーティングシステムまたはTCP/IPスタックに対応するための新たなマクロ定義は、通常、wolfSSLのポーティングが完了すると、`settings.h` ファイルに追加しています。 + これにより、機能のオン/オフを簡単に切り替えたり、そのビルドの「デフォルト」となるビルド設定をカスタマイズしたりできます。 + wolfSSLを新しいプラットフォームに移植する際にも、このファイルに新しいカスタム定義を追加することでお使いいただけます。 + 新しいプラットフォームへの移植が完了した際、もし差し支えなければ、wolfSSLの [Gitリポジトリ](https://www.github.com/wolfssl/wolfssl) にPull Requestを送信していただけると嬉しく思います。 + これにより、wolfSSLを最新の状態に保つことができ、wolfSSLプロジェクトの改善と進展に合わせてさまざまな移植版も更新され続けます。 -2. wolfSSL自体に変更を加えたくない場合、または追加のプリプロセッサ定義を使用して wolfSSLビルドをカスタマイズしたい場合、wolfSSLはカスタムヘッダーファイル`user_settings.h`の使用を推奨します。 wolfSSLソースファイルをコンパイルするときに `WOLFSSL_USER_SETTINGS` が定義されている場合、wolfSSLはカスタムヘッダーファイル `user_settings.h` を自動的にインクルードします。このヘッダーはユーザーが作成し、インクルードパスに配置する必要があります。これにより、ユーザーはwolfSSLビルド用に1つのファイルのみを管理すればよく、wolfSSLの新しいバージョンへの更新がはるかに簡単になります。 +2. wolfSSL自体に変更を加えたくない場合、または追加のプリプロセッサ定義を使用して wolfSSLビルドをカスタマイズしたい場合、wolfSSLはカスタムヘッダーファイル`user_settings.h`の使用を推奨します。 + wolfSSLソースファイルをコンパイルするときに `WOLFSSL_USER_SETTINGS` が定義されている場合、wolfSSLはカスタムヘッダーファイル `user_settings.h` を自動的にインクルードします。 + このヘッダーはユーザーが作成し、インクルードパスに配置する必要があります。 + これにより、ユーザーはwolfSSLビルド用に1つのファイルのみを管理すればよく、wolfSSLの新しいバージョンへの更新がはるかに簡単になります。 -wolfSSLでは、直接のメール ([info@wolfssl.jp](mailto:infopwolfssl.jp)) または [GitHub Pull Request](https://github.com/wolfssl/wolfssl) を通じてパッチとコード変更をご送信いただくことを推奨しています。 +wolfSSLでは、直接のメール ([info@wolfssl.jp](mailto:info@wolfssl.jp)) または [GitHub Pull Request](https://github.com/wolfssl/wolfssl) を通じてパッチとコード変更をご送信いただくことを推奨しています。 ## wolfSSLの移植 @@ -34,39 +48,53 @@ wolfSSLでは、直接のメール ([info@wolfssl.jp](mailto:infopwolfssl.jp)) A: プラットフォームに適したデータ型のサイズを設定することは常に重要です。 -wolfSSL は、64ビット型を利用できることで速度面でメリットを得ています。プラットフォームの `sizeof(long)` と `sizeof(long long)` の結果と一致するように `SIZEOF_LONG` と `SIZEOF_LONG_LONG` を定義します。これは、`settings.h` または `user_settings.h` のカスタム定義に追加できます。たとえば、`MY_NEW_PLATFORM` のサンプル定義の下の `settings.h` では次のように示します。 +wolfSSL は、64ビット型を利用できることで速度面でメリットを得ています。 +プラットフォームの `sizeof(long)` と `sizeof(long long)` の結果と一致するように `SIZEOF_LONG` と `SIZEOF_LONG_LONG` を定義します。 +これは、`settings.h` または `user_settings.h` のカスタム定義に追加できます。 +たとえば、`MY_NEW_PLATFORM` のサンプル定義の下の `settings.h` では次のように示します。 + ```c #ifdef MY_NEW_PLATFORM - #define SIZEOF_LONG 4 - #define SIZEOF_LONG_LONG 8 -... + #define SIZEOF_LONG 4 + #define SIZEOF_LONG_LONG 8 + ... #endif ``` -wolfSSLとwolfCryptでは、`word32` と `word16` という2つの追加データ型を使用します。これらのデフォルトの型マッピングは次のとおりです。 +wolfSSLとwolfCryptでは、`word32` と `word16` という2つの追加データ型を使用します。 +これらのデフォルトの型マッピングは次のとおりです。 ```c #ifndef WOLFSSL_TYPES #ifndef byte - typedef unsigned char byte + typedef unsigned char byte; #endif - typedef unsigned short word16; - typedef unsigned int word32; - typedef byte word24[3]; + typedef unsigned short word16; + typedef unsigned int word32; + typedef byte word24[3]; #endif ``` -`word32` はコンパイラの32ビット型にマッピングされ、`word16` はコンパイラの16ビット型にマッピングされます。これらのデフォルトのマッピングがプラットフォームに適していない場合は、`settings.h` または `user_settings.h` で `WOLFSSL_TYPES` を定義し、word32およびword16に独自のカスタムtypedefを割り当てる必要があります。 +`word32` はコンパイラの32ビット型にマッピングし、`word16` はコンパイラの16ビット型にマッピングする必要があります。 +これらのデフォルトのマッピングがプラットフォームに適していない場合は、`settings.h` または `user_settings.h` で `WOLFSSL_TYPES` を定義し、word32およびword16に独自のカスタムtypedefを割り当てる必要があります。 -wolfSSLのfastmathライブラリは、`fp_digit` および `fp_word` 型を使用します。デフォルトでは、これらはビルド構成に応じて `` にマッピングされます。 +デフォルトの数学ライブラリであるSP数学ライブラリ(`./wolfcrypt/src/sp_int.c`、`WOLFSSL_SP_MATH_ALL`)は、`sp_int_digit` 型と `sp_int_word` 型を使用します。 +これらのサイズは `SP_WORD_SIZE` によって選択されます。 +`SP_WORD_SIZE` はターゲットに応じて決定されますが、必要に応じて `user_settings.h` で32または64に設定することもできます。 -`fp_word` は `fp_digit` の2倍のサイズである必要があります。デフォルトのケースがプラットフォームに当てはまらない場合は、`settings.h` または `user_settings.h` で `WOLFSSL_BIGINT_TYPES` を定義し、`fp_word` および `fp_digit` に独自のカスタムtypedefを割り当てる必要があります。 +レガシーのfastmathバックエンド(`USE_FAST_MATH`)を使用する場合は、`` でマッピングされている `fp_digit` 型と `fp_word` 型が使用されます。 +レガシーのヒープ数学バックエンド(`USE_INTEGER_HEAP_MATH`)は、`` の `mp_digit` 型と `mp_word` 型を使用します。 +word型はdigit型の2倍のサイズである必要があります。 +デフォルトのケースがプラットフォームに当てはまらない場合は、`settings.h` または `user_settings.h` で `WOLFSSL_BIGINT_TYPES` を定義し、これらの型に独自のカスタムtypedefを割り当てる必要があります。 -wolfSSLは、一部の操作において使用可能な場合は64ビット型を使用します。ビルド時には、`SIZEOF_LONG` および `SIZEOF_LONG_LONG` の設定に基づいて、`word64` の正しいデータ型を検出して設定しようとします。 真の64ビット型を持たない一部のプラットフォームでは、2つの32ビット型を合わせて使用するため、パフォーマンスが低下する可能性があります。コンパイル時に`NO_64BIT`を定義することで、64ビット型を使用しないこともできます。 +wolfSSLは、一部の操作において使用可能な場合は64ビット型を使用します。 +ビルド時には、`SIZEOF_LONG` および `SIZEOF_LONG_LONG` の設定に基づいて、`word64` の正しいデータ型を検出して設定しようとします。 +真の64ビット型を持たない一部のプラットフォームでは、2つの32ビット型を合わせて使用するため、パフォーマンスが低下する可能性があります。 +コンパイル時に`NO_64BIT`を定義することで、64ビット型を使用しないこともできます。 ### エンディアン @@ -75,13 +103,17 @@ wolfSSLは、一部の操作において使用可能な場合は64ビット型 A: あなたのプラットフォームがビッグエンディアンの場合です。 -お使いのプラットフォームはビッグエンディアンとリトルエンディアン、どちらでしょうか。wolfSSLはデフォルトでリトルエンディアンを使用しています。システムがビッグエンディアンの場合は、wolfSSL をビルドする際に `BIG_ENDIAN_ORDER` を定義します。例えば、`settings.h` で次のように設定できます。 +お使いのプラットフォームはビッグエンディアンとリトルエンディアン、どちらでしょうか。 +wolfSSLはデフォルトでリトルエンディアンを使用しています。 +システムがビッグエンディアンの場合は、wolfSSL をビルドする際に `BIG_ENDIAN_ORDER` を定義します。 +例えば、`settings.h` で次のように設定できます。 + ```c #ifdef MY_NEW_PLATFORM - ... - #define BIG_ENDIAN_ORDER - ... + ... + #define BIG_ENDIAN_ORDER + ... #endif ``` @@ -89,12 +121,12 @@ A: あなたのプラットフォームがビッグエンディアンの場合 ### writev - **Q: どんな場合にこの章の内容が役立ちますか?** A: `` を利用できない場合です。 -デフォルトでは、wolfSSL APIは、`writev()` セマンティクスをシミュレートする `wolfSSL_writev()` をアプリケーションに提供します。 `` ヘッダーが利用できないシステムでは、`NO_WRITEV` を定義してこの機能を除外します。 +デフォルトでは、wolfSSL APIは、`writev()` セマンティクスをシミュレートする `wolfSSL_writev()` をアプリケーションに提供します。 +`` ヘッダーが利用できないシステムでは、`NO_WRITEV` を定義してこの機能を除外します。 ### ネットワークI/O @@ -103,17 +135,26 @@ A: `` を利用できない場合です。 A: BSD スタイルのソケットAPIを利用できない、あるいはカスタムトランスポート層またはTCP/IPスタックを使用している、または静的バッファーのみを使用したい場合です。 -wolfSSLはデフォルトでBSDスタイルのソケットインターフェイスを使用します。トランスポート層がBSDソケットインターフェイスを提供する場合、カスタムヘッダーが必要でない限り、wolfSSLはそのまま統合する必要があります。 +wolfSSLはデフォルトでBSDスタイルのソケットインターフェイスを使用します。 +トランスポート層がBSDソケットインターフェイスを提供する場合、カスタムヘッダーが必要でない限り、wolfSSLはそのまま組み込めるはずです。 -wolfSSLはカスタムI/O抽象化レイヤーを提供し、ユーザーはwolfSSLのI/O機能をシステムに合わせて調整できます。詳細については、[5.1.2節](chapter05.md#custom-inputoutput-abstraction-layer) をご参照ください。 +wolfSSLはカスタムI/O抽象化レイヤーを提供し、ユーザーはwolfSSLのI/O機能をシステムに合わせて調整できます。 +詳細については、[第5章 移植性](chapter05.md)の「カスタム入出力抽象化レイヤー」節をご参照ください。 -具体的には `WOLFSSL_USER_IO` を定義し、wolfSSLデフォルトの `EmbedSend()` と `EmbedReceive()` をテンプレートとして使用し、独自のI/Oコールバック関数を記述します。これら2つの関数は `./src/io.c` にあります。 +具体的には `WOLFSSL_USER_IO` を定義し、wolfSSLデフォルトの `EmbedSend()` と `EmbedReceive()` をテンプレートとして使用し、独自のI/Oコールバック関数を記述します。 +これら2つの関数は `./src/wolfio.c`(ヘッダーは `wolfssl/wolfio.h`)にあります。 +作成したコールバックは、`wolfSSL_CTX_SetIORecv()` と `wolfSSL_CTX_SetIOSend()` で登録します。 +BSDスタイルのソケット層がまったく存在しない場合は、`WOLFSSL_NO_SOCK` を定義すると組み込みのソケットコードが除外されます。 -wolfSSLは、入力と出力に動的バッファを使用します。このバッファのデフォルトは0バイトです。バッファよりも大きいサイズの入力レコードを受信した場合、動的バッファが一時的にリクエストの処理に使用され、その後解放されます。 +wolfSSLは、入力と出力に小さな静的バッファを使用します。 +このバッファは、デフォルトではレコードヘッダー(`STATIC_BUFFER_LEN`、5バイト)のみを保持できるサイズです。 +バッファよりも大きいサイズの入力レコードを受信した場合、動的バッファが一時的にリクエストの処理に使用され、その後解放されます。 動的メモリを必要としない16kBの大きな静的バッファを使用する場合は、`LARGE_STATIC_BUFFERS` を定義することでこのオプションを使用できます。 -動的バッファが使用され、ユーザーがバッファサイズよりも大きい `wolfSSL_write()` を要求した場合、最大 `MAX_RECORD_SIZE` までの動的ブロックを使用してデータを送信します。`RECORD_SIZE` で定義されている現在のバッファサイズの最大のチャンクでのみデータを送信したいユーザーは、`STATIC_CHUNKS_ONLY` を定義することでこれを実現できます。この定義を使用する場合、`RECORD_SIZE` はデフォルトで 128 バイトになります。 +動的バッファが使用され、ユーザーがバッファサイズよりも大きい `wolfSSL_write()` を要求した場合、最大 `MAX_RECORD_SIZE` までの動的ブロックを使用してデータを送信します。 +`RECORD_SIZE` で定義されている現在のバッファサイズの最大のチャンクでのみデータを送信したいユーザーは、`STATIC_CHUNKS_ONLY` を定義することでこれを実現できます。 +`RECORD_SIZE` のデフォルトは128バイト(DTLSビルドでは `MAX_MTU`)で、128から16384までの値に設定できます。 ### ファイルシステム @@ -122,23 +163,32 @@ wolfSSLは、入力と出力に動的バッファを使用します。このバ A: ファイルシステムを利用できない、あるいは標準のファイルシステム機能を利用できない、または独自のファイルシステムを使用している場合です。 -wolfSSLは、TLSセッションまたはコンテキストに鍵と証明書をロードするためにファイルシステムを使用します。wolfSSLでは、これらをメモリバッファからロードすることもできます。メモリバッファのみを使用する場合、ファイルシステムは必要ありません。 +wolfSSLは、TLSセッションまたはコンテキストに鍵と証明書をロードするためにファイルシステムを使用します。 +wolfSSLでは、これらをメモリバッファからロードすることもできます。 +メモリバッファのみを使用する場合、ファイルシステムは必要ありません。 -ライブラリをビルドするときに `NO_FILESYSTEM` を定義することで、wolfSSLによるファイルシステムの使用を無効にできます。つまり、証明書と鍵はファイルではなくメモリバッファからロードする必要があります。`settings.h` で、以下のように設定できます。 +ライブラリをビルドするときに `NO_FILESYSTEM` を定義することで、wolfSSLによるファイルシステムの使用を無効にできます。 +つまり、証明書と鍵はファイルではなくメモリバッファからロードする必要があります。 +`settings.h` で、以下のように設定できます。 ```c #ifdef MY_NEW_PLATFORM - ... - #define NO_FILESYSTEM - ... + ... + #define NO_FILESYSTEM + ... #endif ``` -テスト用の鍵と証明書バッファーは、`./wolfssl/certs_test.h` ヘッダーファイルにあります。これらは、`./certs` ディレクトリにある対応する証明書や鍵と一致します。 +テスト用の鍵と証明書バッファーは、`./wolfssl/certs_test.h` ヘッダーファイルにあります。 +これらは、`./certs` ディレクトリにある対応する証明書や鍵と一致します。 -`certs_test.h` ヘッダーファイルは、必要に応じて `./gencertbuf.pl` スクリプトを使用して更新できます。`gencertbuf.pl` 内には、`fileList_1024` と `fileList_2048` の2つの配列があります。鍵サイズに応じて、追加の証明書またはキーをそれぞれの配列に追加できます。なお、DER形式である必要があります。上記の配列は、証明書・鍵ファイルの場所を目的のバッファー名にマップします。`gencertbuf.pl` を変更した後、wolfSSLルートディレクトリから実行すると、`./wolfssl/certs_test.h` の証明書・鍵のバッファーが更新されます。 +`certs_test.h` ヘッダーファイルは、必要に応じて `./gencertbuf.pl` スクリプトを使用して更新できます。 +`gencertbuf.pl` 内には、鍵の種類とサイズごとにまとめられた複数の配列(`fileList_ecc`、`fileList_ed`、`fileList_x`、`fileList_1024`、`fileList_2048`、`fileList_3072`、`fileList_4096`、`fileList_sm2`、`fileList_sm2_der`、`fileList_falcon`、`fileList_cn_ip`)があります。 +追加の証明書または鍵をそれぞれの配列に追加できますが、DER形式である必要があります(`fileList_sm2` にはPEMファイルを指定します)。 +これらの配列は、証明書・鍵ファイルの場所を目的のバッファー名にマップします。 +`gencertbuf.pl` を変更した後、wolfSSLルートディレクトリから実行すると、`./wolfssl/certs_test.h` の証明書・鍵のバッファー(およびSMのバッファーについては `./wolfssl/certs_test_sm.h`)が更新されます。 ```sh @@ -146,31 +196,46 @@ wolfSSLは、TLSセッションまたはコンテキストに鍵と証明書を ``` -デフォルト以外のファイルシステムを使用する場合、ファイルシステム抽象化レイヤーは `./wolfssl/wolfcrypt/wc_port.h` にあります。ここには、EBSNET、FREESCALE_MQX、MICRIUM などのさまざまなプラットフォームのファイルシステムポートがあります。必要に応じて、プラットフォームのカスタム定義を追加できます。これにより、`XFILE`、`XFOPEN`、`XFSEEK` などを使用してファイルシステム関数を定義できます。たとえば、Micrium の µC/OS (MICRIUM) の `wc_port.h` のファイルシステムレイヤーは次のとおりです。 +デフォルト以外のファイルシステムを使用する場合、ファイルシステム抽象化レイヤーは `./wolfssl/wolfcrypt/wc_port.h` にあります。 +ここには、EBSNET、FREESCALE_MQX、MICRIUM などのさまざまなプラットフォームのファイルシステムポートがあります。 +必要に応じて、プラットフォームのカスタム定義を追加できます。 +これにより、`XFILE`、`XFOPEN`、`XFSEEK` などを使用してファイルシステム関数を定義できます。 +たとえば、Micrium の uC/OS (MICRIUM) の `wc_port.h` のファイルシステムレイヤーは次のとおりです。 + ```c #elif defined(MICRIUM) -#include -#define XFILE FS_FILE* -#define XFOPEN fs_fopen -#define XFSEEK fs_fseek -#define XFTELL fs_ftell -#define XREWIND fs_rewind -#define XFREAD fs_fread -#define XFCLOSE fs_fclose -#define XSEEK_END FS_SEEK_END -#define XBADFILE NULL + #include + #define XFILE FS_FILE* + #define XFOPEN fs_fopen + #define XFSEEK fs_fseek + #define XFTELL fs_ftell + #define XFREAD fs_fread + #define XFWRITE fs_fwrite + #define XFCLOSE fs_fclose + #define XSEEK_SET FS_SEEK_SET + #define XSEEK_END FS_SEEK_END + #define XBADFILE NULL + #define XFGETS(b,s,f) -2 /* Not ported yet */ ``` +`wc_port.h` を編集する代わりに、`WOLFSSL_USER_FILESYSTEM` を定義し、すべての `X*` ファイルシステムマクロを `user_settings.h` で定義することもできます。 + ### スレッド化 **Q: どんな場合にこの章の内容が役立ちますか?** A: マルチスレッド環境でwolfSSLを使用したい、またはシングルスレッドモードでコンパイルしたい場合です。 -wolfSSLをシングルスレッド環境でのみ使用する場合、wolfSSLをコンパイルするときに `SINGLE_THREADED` を定義することでwolfSSLミューテックスレイヤーを無効にできます。これにより、wolfSSLミューテックスレイヤーを移植する必要がなくなります。 +wolfSSLをシングルスレッド環境でのみ使用する場合、wolfSSLをコンパイルするときに `SINGLE_THREADED` を定義することでwolfSSLミューテックスレイヤーを無効にできます。 +これにより、wolfSSLミューテックスレイヤーを移植する必要がなくなります。 -wolfSSLをマルチスレッド環境で使用する場合、wolfSSLミューテックスレイヤーを新しい環境に移植する必要があります。ミューテックスレイヤーは `./wolfssl/wolfcrypt/wc_port.h` および `./wolfcrypt/src/wc_port.c` にあります。新しいシステムでは、`wc_port.h` に `wolfSSL_Mutex` を定義し、`wc_port.c` にミューテックス関数 (`wc_InitMutex`、`wc_FreeMutex`、`wc_LockMutex`、`wc_UnLockMutex`) を定義する必要があります。`wc_port.h` と `wc_port.c` を検索すると、既存のプラットフォームポートレイヤー (EBSNET、FREESCALE_MQX など) の例を参照できます。 +wolfSSLをマルチスレッド環境で使用する場合、wolfSSLミューテックスレイヤーを新しい環境に移植する必要があります。 +ミューテックスレイヤーは `./wolfssl/wolfcrypt/wc_port.h` および `./wolfcrypt/src/wc_port.c` にあります。 +新しいシステムでは、`wc_port.h` に `wolfSSL_Mutex` を定義し、`wc_port.c` にミューテックス関数 (`wc_InitMutex`、`wc_FreeMutex`、`wc_LockMutex`、`wc_UnLockMutex`) を定義する必要があります。 +`wc_port.h` と `wc_port.c` を検索すると、既存のプラットフォームポートレイヤー (EBSNET、FREESCALE_MQX など) の例を参照できます。 +あるいは、`WOLFSSL_USER_MUTEX` を定義し、(例えば `user_settings.h` で)`wolfSSL_Mutex` のtypedefを用意して、ミューテックス関数を独自のコードで実装することもできます。 +この場合、`wc_port.h` や `wc_port.c` を変更する必要はありません。 ### ランダムシード @@ -179,9 +244,19 @@ wolfSSLをマルチスレッド環境で使用する場合、wolfSSLミューテ A: `/dev/random` や `/dev/urandom` を利用できない、あるいはハードウェアRNGに統合する必要がある場合です。 -デフォルトでは、wolfSSLは `/dev/urandom` または `/dev/random` を使用して RNG シードを生成します。wolfSSLをビルドするときに `NO_DEV_RANDOM` 定義を使用して、デフォルトの `GenerateSeed()` 関数を無効にすることができます。これが定義されている場合は、ターゲットプラットフォームに固有の `./wolfcrypt/src/random.c` にカスタム `GenerateSeed()` 関数を記述する必要があります。これにより、ハードウェアベースのランダムエントロピーソースが利用可能な場合は、wolfSSLのPRNGにシードを設定できます。 +デフォルトでは、wolfSSLは `/dev/urandom` または `/dev/random` を使用して RNG シードを生成します(Linuxでは、`WOLFSSL_GETRANDOM` または `HAVE_GETRANDOM` が定義されている場合、代わりに `getrandom()` システムコールを使用します)。 +wolfSSLをビルドするときに `NO_DEV_RANDOM` 定義を使用して、デフォルトの `wc_GenerateSeed()` 関数を無効にすることができます。 +これが定義されている場合は、ターゲットプラットフォームに固有のシードソースを用意する必要があります。 +これにより、ハードウェアベースのランダムエントロピーソースが利用可能な場合は、それを使用してwolfSSLのPRNGにシードを設定できます。 +`./wolfcrypt/src/random.c` を変更する代わりに、`user_settings.h` で以下のいずれかを定義することもできます。 + +* `CUSTOM_RAND_GENERATE_SEED` - 独自のシード関数の名前です。 + この関数は `(byte* output, word32 sz)` を引数に取り、成功時に0を返します。 +* `CUSTOM_RAND_GENERATE_SEED_OS` - 上記と同じですが、追加の第1引数として `OS_Seed*` を取ります。 +* `CUSTOM_RAND_GENERATE_BLOCK` - 同じ `(byte* output, word32 sz)` 引数を取る関数の名前です。 + この関数は、wolfCrypt DRBGの出力を完全に置き換えます(例えばハードウェアRNGを使用する場合)。 -`GenerateSeed()` の記述方法の例については、`./wolfcrypt/src/random.c` にある wolfSSL の既存の `GenerateSeed()` 実装を参照してください。 +`wc_GenerateSeed()` の記述方法の例については、`./wolfcrypt/src/random.c` にある wolfSSL の既存の `wc_GenerateSeed()` 実装を参照してください。 ### メモリー @@ -190,24 +265,31 @@ A: `/dev/random` や `/dev/urandom` を利用できない、あるいはハー A: 標準のメモリ関数が利用できない、あるいはオプションの数学ライブラリ間のメモリ使用量の違いに関心がある場合です。 -wolfSSL本体はデフォルトで `malloc()` と `free()` の両方を使用します。旧来使用されてきた第1世代の整数演算ライブラリ(Normal Math)を使用する場合、wolfCryptは `realloc()` も使用します。 +wolfSSL本体はデフォルトで `malloc()` と `free()` の両方を使用します。 +レガシーのヒープ数学ライブラリ(`USE_INTEGER_HEAP_MATH`)を使用する場合、wolfCryptは `realloc()` も使用します。 -現在、整数演算ライブラリとして最初期に開発された第1世代のNormal Mathライブラリ、パブリックドメインのTFM(Tom's Fast Math)をベースに開発した第2世代のFast Mathライブラリ、SP(Single Precision)最適化を適用した第3世代のSP Mathライブラリが存在します。 -このうち、第2世代以降のFast Math, SP Mathライブラリでは、暗号操作において動的メモリを使用しません。 +wolfSSL/wolfCryptは、デフォルトでSP数学ライブラリ(`./wolfcrypt/src/sp_int.c`、`WOLFSSL_SP_MATH_ALL`)を使用します。 +このライブラリは定数時間で動作し、デフォルトでは多倍長整数をスタック上に保持します。 +スタックの少ないターゲットでは、`WOLFSSL_SMALL_STACK` を定義すると大きな変数をスタックからヒープに移動できます。 +また、`WOLFSSL_SP_SMALL` を定義するとコードサイズを小さくできます。 +`WOLFSSL_SP_MATH` は、SP数学ライブラリをSPコードが実装している鍵長と曲線に制限します(付録Hを参照)。 +レガシーのfastmathライブラリ(`USE_FAST_MATH`、`./wolfcrypt/src/tfm.c`、`--enable-fastmath`)とヒープ数学ライブラリ(`USE_INTEGER_HEAP_MATH`、`./wolfcrypt/src/integer.c`、`--enable-heapmath`)も引き続き使用できます。 +fastmathを使用する場合は、`TFM_TIMING_RESISTANT` も定義してください。 +wolfSSLのTLSレイヤーは依然としていくらかの動的メモリを使用するため、`malloc()` と `free()` は依然として必要です。 + +数学ライブラリ間のリソース使用量(スタック/ヒープ)の比較については、弊社までお問い合わせいただければ、Resource Use ドキュメントをご覧いただけます。 -メモリ使用量とスピードの観点から、私たちはSP Mathライブラリの使用を推奨しています。 -wolfSSL 5.4.0以降ではデフォルトで採用しており、第1世代のNormal Mathライブラリは廃止予定です。 -詳細は以下のページをご覧ください。 +数学ライブラリについては、以下のページもご覧ください。 - [wolfSSLの新たな Multi-Precision 演算ライブラリ](https://wolfssl.jp/wolfblog/2021/02/03/multi-precision-math-library/) - [wolfSSL Math Library Comparison Matrix](https://www.wolfssl.com/wolfssl-math-library-comparison-matrix/) - [レガシー数学ライブラリを廃止します](https://wolfssl.jp/wolfblog/2023/03/13/deprecation-of-wolfssl-normal-math-library/) -wolfSSLのTLSレイヤーは依然としていくらかの動的メモリを使用するため、`malloc()` と `free()` は依然として必要です。 +通常の `malloc()`、`free()`、および場合によっては `realloc()` 関数が使用できない場合は、`XMALLOC_USER` を定義し、`./wolfssl/wolfcrypt/types.h` にターゲット環境に固有のカスタムメモリ関数フックを用意します。 +あるいは、`XMALLOC_OVERRIDE` を定義して独自の `XMALLOC`、`XFREE`、`XREALLOC` マクロを用意するか、`wolfSSL_SetAllocators()` を使用して実行時にメモリ確保関数を登録することもできます。 +ヒープのないシステムでは、`WOLFSSL_STATIC_MEMORY`(`--enable-staticmemory`)を使用すると、アプリケーションが `wc_LoadStaticMemory()` で提供するバッファからwolfSSLがメモリを確保できるようになります。 -通常の `malloc()`、`free()`、および場合によっては `realloc()` 関数が使用できない場合は、`XMALLOC_USER` を定義し、ターゲット環境に固有の `./wolfssl/wolfcrypt/types.h` でカスタムメモリ関数フックを提供します。 - -`XMALLOC_USER` の使用の詳細については、[5.1.1.1節](chapter05.md#memory-use) をご参照ください。 +`XMALLOC_USER` の使用の詳細については、[第5章 移植性](chapter05.md)の「メモリ使用」節をご参照ください。 ### 時間 @@ -216,11 +298,19 @@ wolfSSLのTLSレイヤーは依然としていくらかの動的メモリを使 A: 標準の時間関数 (`time()`、`gmtime()`) を利用できない、あるいはカスタムのクロックティック関数を指定する必要がある場合です。 -デフォルトでは、wolfSSLは `./wolfcrypt/src/asn.c` で指定されているように、`time()`、`gmtime()`、および `ValidateDate()` を使用します。これらは、`XTIME`、`XGMTIME`、および `XVALIDATE_DATE` に抽象化されています。標準の時間関数と `time.h` を利用できない場合は、ユーザーは `USER_TIME` を定義できます。`USER_TIME` を定義した後、ユーザーは独自の `XTIME`、`XGMTIME`、および `XVALIDATE_DATE` 関数を定義できます。 +デフォルトでは、wolfSSLは `time()`、`gmtime()`、および `wc_ValidateDate()` を使用します。 +これらは、`./wolfssl/wolfcrypt/wc_port.h` で `XTIME`、`XGMTIME`、および `XVALIDATE_DATE` に抽象化されています。 +標準の時間関数と `time.h` を利用できない場合は、ユーザーは `USER_TIME` を定義できます。 +`USER_TIME` を定義した後、ユーザーは独自の `XTIME`、`XGMTIME`、および `XVALIDATE_DATE` 関数を定義できます。 +あるいは、`TIME_OVERRIDES` を使用することもできます。 +この場合、標準の時間型はそのまま使用されますが、ユーザーは `XTIME` と `XGMTIME` の両方を用意する必要があります。 -wolfSSLは、クロックティック関数にデフォルトで `time(0)` を使用します。これは、`LowResTimer()` 関数内の `./src/internal.c` にあります。 +wolfSSLは、クロックティック関数にデフォルトで `time(0)` を使用します。 +これは、`./src/internal.c` の `LowResTimer()` 関数内にあります。 -`USER_TICKS` を定義すると、`time(0)` が必要ない場合にユーザーが独自のクロックティック関数を定義できるようになります。カスタム関数には秒単位の精度が必要ですが、エポックと相関させる必要はありません。参考として、`./src/internal.c` の `LowResTimer()` 関数を参照してください。 +`USER_TICKS` を定義すると、`time(0)` が必要ない場合にユーザーが独自のクロックティック関数を定義できるようになります。 +カスタム関数には秒単位の精度が必要ですが、エポックと相関させる必要はありません。 +参考として、`./src/internal.c` の `LowResTimer()` 関数を参照してください。 ### C標準ライブラリ @@ -229,21 +319,28 @@ wolfSSLは、クロックティック関数にデフォルトで `time(0)` を A: C標準ライブラリを使用できない、あるいは独自のライブラリがある場合です。 -wolfSSLは、開発者に高いレベルの移植性と柔軟性を提供するために、C標準ライブラリなしで構築できるようにしています。その場合、ユーザーはC標準の関数の代わりに使用したい関数をマップする必要があります。 +wolfSSLは、開発者に高いレベルの移植性と柔軟性を提供するために、C標準ライブラリなしで構築できるようにしています。 +その場合、ユーザーはC標準の関数の代わりに使用したい関数をマップする必要があります。 -第7章では、メモリ関数について説明しました。メモリ関数の抽象化に加えて、wolfSSLは文字列関数と数学関数も抽象化します。特定の関数は通常、`X` 形式の定義に抽象化されます。`` は抽象化される関数の名前です。 +メモリ関数については、上記の「メモリー」節で説明しました。 +メモリ関数の抽象化に加えて、wolfSSLは文字列関数と数学関数も抽象化します。 +特定の関数は通常、`X` 形式の定義に抽象化されます。 +`` は抽象化される関数の名前です。 詳細については、[5.1章](chapter05.md) をご覧ください。 + ### ロギング **Q: どんな場合にこの章の内容が役立ちますか?** A: デバッグメッセージを有効にしたいが、stderr を使用できない場合です。 -デフォルトでは、wolfSSLはstderrを介してデバッグ出力を提供します。デバッグメッセージを有効にするには、wolfSSLを `DEBUG_WOLFSSL` を定義してコンパイルし、アプリケーションコードから `wolfSSL_Debugging_ON()` を呼び出す必要があります。同様に、アプリケーションから`wolfSSL_Debugging_OFF()` を呼び出すことで、wolfSSLデバッグメッセージをオフにすることもできます。 +デフォルトでは、wolfSSLはstderrを介してデバッグ出力を提供します。 +デバッグメッセージを有効にするには、wolfSSLを `DEBUG_WOLFSSL` を定義してコンパイルし、アプリケーションコードから `wolfSSL_Debugging_ON()` を呼び出す必要があります。 +同様に、アプリケーションから`wolfSSL_Debugging_OFF()` を呼び出すことで、wolfSSLデバッグメッセージをオフにすることもできます。 -stderrを使用できない、あるいは別の出力ストリームや別の形式でデバッグメッセージを出力したい環境には、独自のコールバック関数を使用できるようにしています。 +stderrを使用できない、あるいは別の出力ストリームや別の形式でデバッグメッセージを出力したい環境には、独自のロギングコールバック関数を登録できるようにしています。 詳細については、[8.1章](chapter08.md) をご覧ください。 @@ -254,18 +351,18 @@ stderrを使用できない、あるいは別の出力ストリームや別の A: wolfSSLで独自の公開鍵実装を使用したい場合です。 -wolfSSLでは、SSL/TLSレイヤーが公開鍵操作を行う必要があるときに呼び出される、独自の公開鍵コールバックをユーザーが作成できます。 ユーザーはオプションで6つの機能を定義できます。 +wolfSSLでは、SSL/TLSレイヤーが公開鍵操作を行う必要があるときに呼び出される、独自の公開鍵コールバックをユーザーが作成できます。 +ユーザーはオプションで複数のコールバックを定義できます。 +例えば、次のようなコールバックがあります。 +1. ECC 鍵生成、署名、検証、共有秘密コールバック +2. RSA 署名、検証、暗号化、復号コールバック(RSA-PSS 署名と検証を含む) +3. DH 鍵共有コールバック +4. Ed25519 および Ed448 署名、検証コールバック +5. X25519 および X448 鍵生成、共有秘密コールバック +6. TLS 鍵導出コールバック(例えばマスターシークレット、セッション鍵、Finished、HKDF) - -1. ECC 署名 コールバック -2. ECC 検証 コールバック -3. RSA 署名 コールバック -4. RSA 検証 コールバック -5. RSA 暗号化コールバック -6. RSA 復号 コールバック - -詳細については、[6.4章](chapter06.md#public-key-callbacks) をご覧ください。 +詳細については、[第6章 コールバック](chapter06.md)の「公開鍵コールバック」節をご覧ください。 ### アトミックレコードレイヤーの処理 @@ -274,14 +371,18 @@ wolfSSLでは、SSL/TLSレイヤーが公開鍵操作を行う必要があると A: レコードレイヤーの処理、特にMAC/暗号化および復号/検証操作を独自に実行したい場合です。 -デフォルトでは、wolfSSLは暗号ライブラリwolfCryptを使用し、ユーザーに代わってレコードレイヤーの処理を行います。wolfSSLは、SSL/TLS接続中に MAC/暗号化および復号/検証機能をより細かく制御したいユーザーのために、アトミックレコード処理コールバックを提供します。 +デフォルトでは、wolfSSLは暗号ライブラリwolfCryptを使用し、ユーザーに代わってレコードレイヤーの処理を行います。 +wolfSSLは、SSL/TLS接続中に MAC/暗号化および復号/検証機能をより細かく制御したいユーザーのために、アトミックレコード処理コールバックを提供します。 -ユーザーは2つの関数を定義できます。 +ユーザーは2つの関数を定義する必要があります。 1. MAC/暗号化コールバック関数 2. 復号/検証コールバック関数 -詳細については、[6.3章](chapter06.md#user-atomic-record-layer-processing) をご覧ください。 +Encrypt-Then-MAC がネゴシエートされた場合は、さらに2つのコールバック、暗号化/MAC コールバック(`wolfSSL_CTX_SetEncryptMacCb()`)と検証/復号コールバック(`wolfSSL_CTX_SetVerifyDecryptCb()`)が使用されます。 + +詳細については、[第6章 コールバック](chapter06.md)の「ユーザーアトミックレコードレイヤー処理」節をご覧ください。 + ### 機能 @@ -290,7 +391,18 @@ A: レコードレイヤーの処理、特にMAC/暗号化および復号/検証 A: 特定の機能を無効にしたい場合です。 wolfSSLをビルドする際、マクロ定義を使用して特定の機能を無効化できます。 -使用可能なマクロ定義については、[2章](chapter02.md) をご覧ください。 +使用可能なマクロ定義については、[第2章](chapter02.md) をご覧ください。 + + +### 暗号コールバック + +**Q: どんな場合にこの章の内容が役立ちますか?** + +A: wolfCryptの処理をハードウェアアクセラレータ、セキュアエレメント、その他のデバイスにオフロードしたい場合です。 + +暗号コールバック(`WOLF_CRYPTO_CB`、`--enable-cryptocb`)を使用すると、`wc_CryptoCb_RegisterDevice()` でデバイスを登録し、wolfCryptのソースを変更することなく、暗号化、ハッシュ、公開鍵、乱数生成の各処理をそのデバイスで行えます。 +付録Hに記載しているハードウェアポートの多くは、この仕組みを使用しています。 +詳細については、[第6章 コールバック](chapter06.md)の「暗号コールバック(cryptocb)」節をご覧ください。 ## 次のステップ @@ -298,31 +410,34 @@ wolfSSLをビルドする際、マクロ定義を使用して特定の機能を ### wolfCryptテストアプリケーション -wolfSSLをターゲットプラットフォームで適切にビルドできるようになったら、次のステップとして wolfCryptテストアプリケーションを移植するのがよいでしょう。このアプリケーションをターゲットシステムで実行すると、NISTテストベクトルを使用して、すべての暗号アルゴリズムが正しく動作しているかどうか検証されます。 +wolfSSLをターゲットプラットフォームで適切にビルドできるようになったら、次のステップとして wolfCryptテストアプリケーションを移植するのがよいでしょう。 +このアプリケーションをターゲットシステムで実行すると、NISTテストベクトルを使用して、すべての暗号アルゴリズムが正しく動作しているかどうか検証されます。 このステップを省略してSSL/TLS接続に進むと、基盤となる暗号操作の失敗によって発生する問題のデバッグが難しくなる可能性があります。 -wolfCryptテストアプリケーションは `./wolfcrypt/test/test.c` にあります。組み込みアプリケーションに独自の `main()` 関数がある場合は、`./wolfcrypt/test/test.c` をコンパイルするときに `NO_MAIN_DRIVER` を定義する必要があります。これにより、アプリケーションの `main()` が各暗号/アルゴリズム テストを個別に呼び出すことができます。 +wolfCryptテストアプリケーションは `./wolfcrypt/test/test.c` にあります。 +組み込みアプリケーションに独自の `main()` 関数がある場合は、`./wolfcrypt/test/test.c` をコンパイルするときに `NO_MAIN_DRIVER` を定義する必要があります。 +これにより、アプリケーションの `main()` が各暗号/アルゴリズム テストを個別に呼び出すことができます。 -組み込みデバイスにwolfCryptテストアプリケーション全体を実行するのに十分なリソースがない場合は、個々のテストを `test.c` から切り離して個別にコンパイルできます。 `test.c` から分離された暗号テストを抽出するときは、特定のテストケースに必要な正しいヘッダーファイルがビルドに含まれていることを確認してください。 +組み込みデバイスにwolfCryptテストアプリケーション全体を実行するのに十分なリソースがない場合は、個々のテストを `test.c` から切り離して個別にコンパイルできます。 +`test.c` から分離された暗号テストを抽出するときは、特定のテストケースに必要な正しいヘッダーファイルがビルドに含まれていることを確認してください。 ## サポート 一般的なサポートの質問は、メール、サポートフォーラム(英語)、またはwolfSSLのZendeskチケットトラッキングシステムを介してwolfSSLに直接送信できます。 -Webサイト: [https://www.wolfssl.com](https://www.wolfssl.com) +Webサイト: [https://www.wolfssl.com](https://www.wolfssl.com) サポート用メールアドレス: [support@wolfssl.com](mailto:support@wolfssl.com) -Zendesk: [https://wolfssl.zendesk.com](https://wolfssl.zendesk.com) +Zendesk: [https://wolfssl.zendesk.com](https://wolfssl.zendesk.com) -フォーラム: [https://www.wolfssl.com/forums](https://www.wolfssl.com/forums) +フォーラム: [https://www.wolfssl.com/forums](https://www.wolfssl.com/forums) wolfSSLは、ユーザーと顧客がwolfSSLを新しい環境に移植するのを支援するために、いくつかのサポートパッケージとコンサルティングサービスを提供しています。 -サポートパッケージ: [https://wolfssl.jp/license/support-packages/](https://wolfssl.jp/license/support-packages/) +サポートパッケージ: [https://wolfssl.jp/license/support-packages/](https://wolfssl.jp/license/support-packages/) お問い合わせ: [info@wolfssl.jp](mailto:info@wolfssl.jp) - diff --git a/wolfSSL/src-ja/appendix11.md b/wolfSSL/src-ja/appendix11.md index f6ef00d6..2904d3c7 100644 --- a/wolfSSL/src-ja/appendix11.md +++ b/wolfSSL/src-ja/appendix11.md @@ -1,6 +1,6 @@ # wolfSM (ShangMi) -この章では、wolfSSLにおける中国国家標準の暗号化アルゴリズムであるShangMi(SM)に関する情報を提供します。 +この付録では、wolfSSLにおける中国国家標準の暗号化アルゴリズムであるShangMi(SM)に関する情報を提供します。 wolfSMは以下の要素をサポートしています。 @@ -9,6 +9,7 @@ wolfSMは以下の要素をサポートしています。 * SM2 - ECDH鍵共有と指定された256ビット楕円曲線を使用した署名スキーム 使用するためには、コードをwolfSSLにインストールする必要があります。 + ただし、テストとビルド設定コードはすでにwolfSSLに含まれています。 ## wolfSMの取得とインストール @@ -26,15 +27,15 @@ git clone https://github.com/wolfssl/wolfsm.git SMアルゴリズム実装をビルドしてテストするにはwolfSSLが必要です。 wolfSMの隣にGitHubからwolfSSLリポジトリをチェックアウトします。 -```sh +```text # ディレクトリ構造は次のようになります。 # -# ├── wolfsm -# └── wolfssl +# |-- wolfsm +# `-- wolfssl ``` ```sh -cd .. # wolfsm を含むディレクトリに移動 +# wolfsmを含むディレクトリであるから実行 git clone https://github.com/wolfssl/wolfssl.git ``` @@ -64,6 +65,7 @@ configure時に必要なアルゴリズムをご選択ください。 例えばSM3、SM4-GCM、SM2を含める場合、次のようにします。 ```sh +cd ../wolfssl ./autogen.sh ./configure --enable-sm3 --enable-sm4-gcm --enable-sm2 make @@ -74,8 +76,8 @@ sudo make install SM2の最適化された実装を使用するには、Cのみのコードを使用するか、より高速なアセンブリコードを備えたCコードを使用できます。 -- Cコードのみの場合: `--enable-sp` -- Cとアセンブリコードの場合: `--enable-sp --enable-sp-asm` +* Cコードのみの場合: `--enable-sp` +* Cとアセンブリコードの場合: `--enable-sp --enable-sp-asm` 最適化されたCコードは、32ビットおよび64ビットCPUで利用可能です。 @@ -86,6 +88,7 @@ SM2の最適化された実装を使用するには、Cのみのコードを使 * ARM 32-bit * ARM Thumb2 * ARM Thumb +* RISC-V 64-bit ## wolfSMのテスト @@ -114,7 +117,8 @@ make test SM暗号はTLS 1.2およびTLS 1.3で使用できます。 -**注意**: SM暗号スイートを動作させるには、SM2、SM3、および少なくとも1つのSM4暗号をビルドする必要があります。すべてのアルゴリズムはSMである必要があります。 +**注意**: SM暗号スイートを動作させるには、SM2、SM3、および少なくとも1つのSM4暗号をビルドする必要があります。 +すべてのアルゴリズムはSMである必要があります。 追加される暗号スイートは以下の通りです。 diff --git a/wolfSSL/src-ja/chapter01.md b/wolfSSL/src-ja/chapter01.md index 3c8a3bf8..da449d63 100644 --- a/wolfSSL/src-ja/chapter01.md +++ b/wolfSSL/src-ja/chapter01.md @@ -1,12 +1,12 @@ # 序章 -このマニュアルは、wolfSSL組み込みSSL/TLSライブラリの技術ガイドとして書かれており、wolfsslのビルド、実行方法、ビルドオプションの概要、提供機能、移植性の向上の方法、サポートなどに関する情報を提供します。 +このマニュアルは、wolfSSL組み込みSSL/TLSライブラリの技術ガイドとして書かれており、wolfSSLのビルド、実行方法、ビルドオプションの概要、提供機能、移植性の向上の方法、サポートなどに関する情報を提供します。 このドキュメントのPDFバージョンは[こちら](https://www.wolfssl.com/documentation/manuals/jp/wolfssl/wolfSSL-Manual-jp.pdf)を参照下さい。 ## なぜwolfSSLを選ぶのですか? 組み込み機器向けのSSLソリューションとしてwolfSSLを選択する理由はたくさんあります。 -最大の理由としてはそのサイズ(典型的なフットプリントサイズが20~100 KBの範囲)と、サポートであるといえるでしょう。 -加えて、最新の標準(SSL 3.0、TLS 1.0、TLS 1.1、TLS 1.2、TLS 1.3、DTLS 1.0、DTLS 1.2およびDTLS1.3)に準拠している点、先進的な暗号アルゴリズムのサポート(ストリーム暗号を含む)、マルチプラットフォーム、ロイヤリティフリー、およびOpenSSLパッケージを使用した既存のアプリケーションの移植を容易にするためのOpenSSL互換性APIの提供などが理由として挙げられます。 -[第4章](chapter04.md)にて、より詳しくご紹介しています。 +最大の理由としては、そのサイズ(典型的なフットプリントサイズが20-100 kBの範囲)が挙げられます。 +加えて、最新の標準(TLS 1.2、TLS 1.3、DTLS 1.2およびDTLS 1.3。レガシーなSSL 3.0、TLS 1.0、TLS 1.1およびDTLS 1.0はビルドオプションとして利用可能)をサポートしている点、最新かつ先進的な暗号アルゴリズムのサポート(ストリーム暗号や、デフォルトで有効になっているML-KEMなどのポスト量子アルゴリズムを含む)、マルチプラットフォーム、ロイヤリティフリー、およびOpenSSLパッケージを使用していた既存のアプリケーションの移植を容易にするためのOpenSSL互換性APIの提供などが理由として挙げられます。 +機能の一覧については、[第4章 機能](chapter04.md)の「機能概要」節をご参照ください。 diff --git a/wolfSSL/src-ja/chapter02.md b/wolfSSL/src-ja/chapter02.md index 870b3a25..913d2783 100644 --- a/wolfSSL/src-ja/chapter02.md +++ b/wolfSSL/src-ja/chapter02.md @@ -6,7 +6,8 @@ wolfSSLをビルドするのが難しい場合は、サポートフォーラム( この章では、UnixとWindowsでwolfSSLをビルドする方法を説明し、非標準環境でwolfSSLをビルドする場合のガイダンスも提供します。 [第3章](chapter03.md)に入門ガイド、[第11章](chapter11.md)にSSLチュートリアルをご用意しています。 -autoconf/automakeシステムを使用してwolfSSLをビルドする場合、単一のMakeFileを使用してwolfSSLライブラリの全てのパーツとサンプルプログラムを一度にビルドします。 +autoconf/automakeシステムを使用してwolfSSLをビルドする場合、単一のMakefileを使用してwolfSSLライブラリの全てのパーツとサンプルプログラムを一度にビルドします。 +これは、Makefileを再帰的に使用するよりもシンプルかつ高速です。 ## wolfSSLソースコードの取得 @@ -16,21 +17,31 @@ autoconf/automakeシステムを使用してwolfSSLをビルドする場合、 zipファイルをダウンロードしたら、`unzip`コマンドを使用してファイルを解凍します。 ネイティブの行末文字を使用するには、unzipを使用する際に`-a`オプションを有効にします。 -[unzip man page]で、`-a`オプションが説明されています。 +unzipのmanページでは、`-a`オプションの機能が次のように説明されています。 -> [...] -aオプションでは、zipによってテキストファイル(ZipInfoリストで「b」ではなく「t」ラベルがついているファイル)と識別されると行末文字、ファイル終端文字を変換します。必要に応じて指定してください。[...] +> [...] -aオプションを指定すると、zipによってテキストファイル(zipinfoのリストで「b」ではなく「t」ラベルがついているファイル)と識別されたファイルは、テキストとして自動的に展開され、必要に応じて行末文字、ファイル終端文字、および文字セットそのものが変換されます。[...] -**注**:wolfSSL 2.0.0RC3のリリースから、wolfSSLのディレクトリ構造と標準のインストールフォルダーが変更されました。 -これらの変更は、オープンソースプロジェクトがwolfSSLを統合しやすくするために行われました。 -ヘッダーと構造の変更の詳細については、[第9章](chapter09.md)の「ライブラリヘッダー」および「構造の使用」節を参照してください。 +ソースコードはGitHubからも入手できます。 -## \*nix上でビルド +```sh +git clone https://github.com/wolfSSL/wolfssl.git +``` + +gitでチェックアウトしたソースには`configure`スクリプトが含まれていません。 +以下の手順に進む前に、wolfSSLのルートディレクトリで`./autogen.sh`を実行して生成してください。 +これにはautoconf(2.69以降)、automake(1.13.4以降)、およびlibtool(2.4.2以降)が必要です。 +リリース版のZIPファイルには、すでに`configure`が含まれています。 + +**注**:wolfSSLヘッダーファイルの場所については、[第9章](chapter09.md)の「ライブラリヘッダー」節を参照してください。 +wolfSSLネイティブの構造体の名前については、[第9章](chapter09.md)の「構造体の使用」節を参照してください。 + +## Unix系システムでのビルド Linux、\*BSD、OS X、Solaris、またはその他の\*nixのようなシステムにwolfSSLをビルドする場合、autoconfシステムを使用します。 -wolfSSLをビルドするには、wolfSSLルートディレクトリから2つのコマンド`./configure`および`make`を実行するだけです。 +wolfSSLをビルドするには、wolfSSLルートディレクトリから2つのコマンド`./configure`および`make`を実行するだけです(gitでチェックアウトしたソースからビルドする場合は、先に`./autogen.sh`を実行してください)。 `./configure`スクリプトはビルド環境をセットアップし、任意の数のビルドオプションを`./configure`に追加します。 -利用可能なビルドオプションのリストについては、この章のビルドオプション節を参照するか、次のコマンドラインを実行して、`./configure`に渡すことができるオプションのリストを表示させてください。 +利用可能なビルドオプションのリストについては、この章の「ビルドオプション」節を参照するか、次のコマンドラインを実行して、`./configure`に渡すことができるオプションのリストを表示させてください。 ```sh ./configure --help @@ -55,6 +66,9 @@ make install sudo make install ``` +`./configure`は、ビルド設定を記録したヘッダー`wolfssl/options.h`を生成します。 +アプリケーションをライブラリと同じ設定でコンパイルするために、アプリケーションでは他のどのwolfSSLヘッダーよりも前に`#include `を記述する必要があります(または、wolfSSLのヘッダーに`options.h`を自動的にインクルードさせる`WOLFSSL_USE_OPTIONS_H`を定義します)。 + ビルドをテストするには、wolfSSLのルートディレクトリからtestsuiteプログラムを実行します。 ```sh @@ -67,65 +81,129 @@ sudo make install make test ``` -testsuiteプログラムの予想される出力に関する詳細は、[第3章](chapter03.md)のテストスイート節にあります。 +testsuiteプログラムの予想される出力に関する詳細は、[第3章](chapter03.md)の「テストスイート」節にあります。 +もし、wolfSSLライブラリのみのビルドが必要で、そのほかのコンポーネント(サンプルプログラム、テストスイート、ベンチマークアプリケーション等)はビルドしたくない場合には、wolfSSLのルートディレクトリで下記コマンドを実行してください。 + +```sh +make src/libwolfssl.la +``` + +### DebianおよびRPMパッケージのビルド + +必要なオプションを指定して`./configure`を実行した後、`make deb`を実行するとその構成でDebianパッケージ(Debian、Ubuntu、Linux Mintおよびその派生ディストリビューション向け)を、`make rpm`を実行するとRPMパッケージ(RHEL、Fedora、CentOS、SUSE、openSUSE向け)をビルドできます。 +`make deb-docker`および`make rpm-docker`は、同じパッケージをDockerコンテナ内でビルドします。 + +## CMakeによるビルド -もし、wolfSSLライブラリのみのビルドが必要で、そのほかのコンポーネント(サンプルプログラム、テストスイート、ベンチマークアプリケーション等)はビルドしたくない場合には、wolfSSLのルートディレクトリで下記コマンドを実行してください、 +wolfSSLは、CMake 3.16以降(3.22以降を推奨)を使用して構成およびビルドすることもできます。 +autoconfによるビルドが主要なビルドシステムです。 +CMakeによるビルドは一般的に使用されるオプションをサポートしていますが、`./configure`の全てのオプションをサポートしているわけではありません。 + +CMakeではソースディレクトリ内でのビルドが許可されていないため、別のビルドディレクトリを作成します。 +wolfSSLのルートディレクトリから次のように実行します。 ```sh -make src/libwolfSSL.la +mkdir build +cd build +cmake .. +cmake --build . ``` -## Windowsの上でのビルド +`cmake --build .`は、基盤となるビルドツール(Unix系システムではデフォルトで`make`)を実行します。 +このビルドツールを直接実行することもできます。 + +ビルドオプションは、`cmake`コマンドラインで`-D