Skip to content

Correct stale and removed wolfSSL macro names in the manual #298

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
philljj merged 1 commit into from
Nov 13, 2026
Merged

Correct stale and removed wolfSSL macro names in the manual #298

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion wolfSSL/src-ja/appendix06.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ wolfCryptのエラーコードは、`wolfssl/wolfcrypt/error.h`に記載して
| `AES_GCM_OVERFLOW_E` | -260 | AES-GCM呼び出しカウンターオーバーフロー |
| `AES_CCM_OVERFLOW_E` | -261 | AES-CCM呼び出しカウンターオーバーフロー |
| `RSA_KEY_PAIR_E` | -262 | RSA鍵ペアーワイズ整合性チェック失敗 |
| `DH_CHECK_PRIVE_E` | -263 | DH秘密鍵チェックエラー |
| `DH_CHECK_PRIV_E` | -263 | DH秘密鍵チェックエラー |
| `WC_AFALG_SOCK_E` | -264 | AF_ALGソケットエラー |
| `WC_DEVCRYPTO_E` | -265 | /dev/cryptoエラー |
| `ZLIB_INIT_ERROR` | -266 | Zlib初期化エラー |
Expand Down
3 changes: 1 addition & 2 deletions wolfSSL/src-ja/appendix07.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -345,7 +345,7 @@
| `--enable-supportedcurves` | `HAVE_SUPPORTED_CURVES` + `HAVE_TLS_EXTENSIONS` | デフォルト有効 |
| `--enable-aesccm` | `HAVE_AESCCM` | |
| `--enable-dh` | `HAVE_DH` | |
| `--enable-psk` | `HAVE_PSK` | |
| `--enable-psk` | `NO_PSK`を削除 | |
| `--enable-rsapss` | `WC_RSA_PSS` | TLS 1.3時自動 |
| `--enable-curve25519` | `HAVE_CURVE25519` | |
| `--enable-curve448` | `HAVE_CURVE448` | |
Expand All @@ -365,4 +365,3 @@
| `--enable-mlkem` | `WOLFSSL_HAVE_MLKEM` + `HAVE_PQC` | |
| `--enable-pqc-hybrids` | `WOLFSSL_PQC_HYBRIDS` | mlkem有効時デフォルト有効 |
| `--enable-mldsa` | `HAVE_DILITHIUM` | |
| `--enable-staticecdh` | `WOLFSSL_STATIC_ECDH` | PFS無し, 非推奨 |
14 changes: 8 additions & 6 deletions wolfSSL/src-ja/appendix08.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,12 +58,14 @@
#define WOLFSSL_SP_ARM64_ASM /* AArch64 */
#define WOLFSSL_SP_ARM_CORTEX_M_ASM /* Cortex-M */

#define WOLFSSL_SP_2048 /* RSA-2048 */
#define WOLFSSL_SP_3072 /* RSA-3072 */
#define WOLFSSL_SP_4096 /* RSA-4096 */
#define WOLFSSL_SP_256 /* ECC P-256 */
#define WOLFSSL_SP_384 /* ECC P-384 */
#define WOLFSSL_SP_521 /* ECC P-521 */

/* 不要なデフォルトサイズを除外 */
/* #define WOLFSSL_SP_NO_2048 */ /* RSA-2048 */
/* #define WOLFSSL_SP_NO_3072 */ /* RSA-3072 */
/* #define WOLFSSL_SP_NO_256 */ /* ECC P-256 */
```

## C. マイコン/SoC チップ別ハードウェアアクセラレータ
Expand All @@ -74,7 +76,7 @@
| 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 |
| STM32MP1/MP13/MP25 | AES, SHA, RSA, ECC | `WOLFSSL_STM32_CRYPT` | 自動検出 | port/st/stm32.c |
| STM32MP13 (ベアメタル) | AES, SHA, RNG, ECC (PKA) | `WOLFSSL_STM32MP13` (`STM32_CRYPTO`を設定) | user_settings.h | port/st/stm32.c |
| **NXP** | | | | |
| i.MX RT (DCP) | AES-ECB/CBC/CTR/GCM, SHA | `WOLFSSL_IMXRT_DCP` | 自動検出 | 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/* |
Expand All @@ -97,7 +99,7 @@
| 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/ |
| ATECC508A / 608A | AES, SHA, ECC (ECDH/ECDSA) | `WOLFSSL_ATECC` | 自動検出 | port/atmel/atmel.c |
| 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 |
Expand All @@ -113,7 +115,7 @@
| Intel QAT（同期） | 同上 | `ENABLED_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 Octeon (MIPS) | AES, RSA, ECC, SHA | `HAVE_CAVIUM_OCTEON` | `--with-octeon-sync=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` |

## E. OS カーネル経由ハードウェアオフロード
Expand Down
17 changes: 3 additions & 14 deletions wolfSSL/src-ja/chapter02.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -588,11 +588,6 @@ TSIP TLSリンク共通鍵暗号化方式のみを無効します。

**注意**：これはルネサスRX TSIP固有の定義です。

#### NO_WOLFSSL_SHA256

これはTLS 1.3にのみ適用されます。
SHA2-256をwolfCryptから有効にして使用できるようにしますが、TLS 1.3からは除外します。

#### WOLFSSL_BLIND_PRIVATE_KEY

秘密鍵をブラインドするためのマスクとして使用されます。
Expand Down Expand Up @@ -1185,7 +1180,7 @@ SHA3使用のビルドをオンにします。
詳細は`wolfSSL_CTX_load_system_CA_certs()`を参照してください。
このプリプロセッサマクロは、`--enable-sys-ca-certs`構成オプションによって自動的に設定されます。

#### WOLFSSL_APPLE_NATIVE_CERT_VERIFICATION
#### WOLFSSL_APPLE_NATIVE_CERT_VALIDATION

TLSピア証明書を認証する際にAppleのネイティブトラストAPIの使用を有効にします。
[WOLFSSL_SYS_CA_CERTS](#WOLFSSL_SYS_CA_CERTS)が定義されている必要があります。
Expand Down Expand Up @@ -1456,8 +1451,7 @@ NULL暗号のサポートをオンにします。

#### HAVE_LIBOQS

OpenQuantumSafeチームのLiboQS統合のサポートをオンにします。
詳細は[付録G ポスト量子暗号の実験](appendix07.md)を参照してください。
wolfSSL 5.9.4で削除されました。ポスト量子アルゴリズムはすべてwolfCryptにネイティブ実装されており、このマクロを定義しても効果はありません。

#### WOLFSSL_SP_4096

Expand Down Expand Up @@ -1781,11 +1775,6 @@ ECDHEサーバーサイズはデフォルトで256ビットであり、これは
認証に実装される暗号化番号として使用されます。
これは擬似乱数であり、整合性のみの暗号スイートです。

#### WOLFSSL_USE_POPEN_HOST

wolfio.cソケットオープンコードでホストとポストでソケットを作成するためにpopenを使用します。
CRLとOCSPで使用されます。

#### CloseSocket

ソケットを閉じるために使用される関数をオーバーライドする方法です。
Expand Down Expand Up @@ -4567,7 +4556,7 @@ SECOで使用する場合 (NXP HSMライブラリを使用)、`ecc_key`構造体
`ecc_key`構造体の初期化後の関数呼び出しの例は次のようになります。

```lang-c
wc_ecc_make_key(&rng, ECC_P256_KEYSIZE, key);
wc_ecc_make_key(&rng, 32, key); /* 32バイトの鍵サイズ: P-256 */
wc_ecc_sign_hash(hash, hashSz, sigOut, sigOutSz, &rng, key);
wc_ecc_verify_hash(sig, sigSz, hash, hashSz, &result, key);
```
Expand Down
4 changes: 2 additions & 2 deletions wolfSSL/src/chapter02.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -864,7 +864,7 @@ Enables time-based non-blocking RSA operations. Allows RSA operations to yield a

#### WOLFSSL_MP_INVMOD_CONSTANT_TIME

Declares that the math library's `mp_invmod()` is constant time, so wolfCrypt calls it directly instead of using a side-channel-safe workaround: in RSA key generation `u = q^-1 mod p` is computed with `mp_invmod()` instead of as `q^(p-2) mod p`, and DSA signing skips the extra blinding of the inverse. Only define it when the `mp_invmod()` of the math backend really is constant time.
Removed after wolfSSL 5.9.4. RSA key generation always computes `u = q^-1 mod p` as `q^(p-2) mod p` and DSA signing always blinds the inverse, so defining this macro has no effect.

#### FP_MAX_BITS

Expand Down Expand Up @@ -1994,7 +1994,7 @@ Enables debug logging for the OpenSSL compatibility layer functions. Helps trace

#### WOLFSSL_VERBOSE_LOGGING

Lets the highest-volume trace messages (`WOLFSSL_MSG_VERBOSE()`, `WOLFSSL_ENTER_VERBOSE()`, `WOLFSSL_LEAVE_VERBOSE()`) into a `DEBUG_WOLFSSL` build. Traces on this tier can be emitted thousands of times by a single API call, so they are compiled out of a normal debug build, which keeps the debug output volume down by roughly 62%. Defined alone it does nothing; `DEBUG_WOLFSSL` is still required. See [Verbose Logging](chapter08.md#verbose-logging).
Lets the highest-volume trace messages (`WOLFSSL_MSG_VERBOSE()` and `WOLFSSL_ENTER_VERBOSE()`) into a `DEBUG_WOLFSSL` build. Traces on this tier can be emitted thousands of times by a single API call, so they are compiled out of a normal debug build, which keeps the debug output volume down by roughly 62%. Defined alone it does nothing; `DEBUG_WOLFSSL` is still required. See [Verbose Logging](chapter08.md#verbose-logging).

#### HAVE_BLAKE2B

Expand Down
2 changes: 1 addition & 1 deletion wolfSSL/src/chapter08.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Two configure options add more detail to the debug output:

### Verbose Logging

wolfSSL 5.9.4 moved the highest-volume trace messages into a separate tier: `WOLFSSL_MSG_VERBOSE()`, `WOLFSSL_ENTER_VERBOSE()` and `WOLFSSL_LEAVE_VERBOSE()`. These are the container helpers, name entry handling and similar code that a single API call can hit thousands of times. They are compiled out of a normal `DEBUG_WOLFSSL` build, which cuts the volume of debug output considerably (about 62% for the unit test suite). To see them, define `WOLFSSL_VERBOSE_LOGGING` in addition to `DEBUG_WOLFSSL`:
wolfSSL 5.9.4 moved the highest-volume trace messages into a separate tier: `WOLFSSL_MSG_VERBOSE()` and `WOLFSSL_ENTER_VERBOSE()`. These are the container helpers, name entry handling and similar code that a single API call can hit thousands of times. They are compiled out of a normal `DEBUG_WOLFSSL` build, which cuts the volume of debug output considerably (about 62% for the unit test suite). To see them, define `WOLFSSL_VERBOSE_LOGGING` in addition to `DEBUG_WOLFSSL`:

```sh
./configure --enable-debug CPPFLAGS=-DWOLFSSL_VERBOSE_LOGGING
Expand Down
Loading