Merge pull request #246 from kojo1/update-wolfclu-docs

Update wolfCLU documentation to match v0.1.8

Author: JacobBarthelmeh

wolfCLU/mkdocs-ja.yml

@@ -31,6 +31,8 @@ nav:
       - "VERIFY コマンド": verify.md
       - "X509 コマンド": x509.md
       - "BASE64 コマンド": base64.md
+    - "付録":
+      - "設定ファイル": config.md
 theme:
   name: null
   custom_dir: ../mkdocs-material/material

wolfCLU/mkdocs.yml

@@ -7,9 +7,13 @@ nav:
     - "1. Introduction": index.md
     - "2. Building wolfCLU": build.md
     - "3. Commands":
+      - "Command List": command_list.md
       - "BENCH Command": bench.md
+      - "CA Command": ca.md
       - "CRL Command": crl.md
+      - "DSAPARAM Command": dsaparam.md
       - "DGST Command": dgst.md
+      - "DHPARAM Command": dhparam.md
       - "ECPARAM Command": ecparam.md
       - "ENC Command": enc.md
       - "GENKEY Command": genkey.md
@@ -22,10 +26,13 @@ nav:
       - "RAND Command": rand.md
       - "REQ Command": req.md
       - "RSA Command": rsa.md
+      - "SHA Command": sha.md
       - "S_CLIENT Command": s_client.md
       - "VERIFY Command": verify.md
       - "X509 Command": x509.md
       - "BASE64 Command": base64.md
+    - "Appendix":
+      - "Configuration File Format": config.md
 theme:
   name: null
   custom_dir: ../mkdocs-material/material

wolfCLU/src-ja/Intro.md

@@ -1,8 +1,8 @@
 
 # wolfCLU マニュアル
 
- wolfSSL コマンドラインユーティリティ (version 0.0.7)    
-2021/Nov/24
+wolfSSL コマンドラインユーティリティ (version 0.1.8)
+2025/April/4
 
 
 ## 始めに

wolfCLU/src-ja/bench.md

@@ -1,2 +1,31 @@
 ### BENCH コマンド
-ベンチマーク アルゴリズムのコマンドは現在実装途中です。現在使用できるコマンドは、全アルゴリズムを実行する、"wolfSSL bench -all" です。
+アルゴリズムのベンチマークに使用されます。すべてのアルゴリズムをベンチマークするには `wolfssl bench -a` を実行します。
+
+利用可能なアルゴリズム（設定に依存）：
+
+- aes-cbc
+- aes-ctr
+- 3des
+- camellia
+- md5
+- sha
+- sha256
+- sha384
+- sha512
+- blake2b
+
+引数：
+
+- [algorithm] ベンチマークするアルゴリズム
+- [-time] 実行時間（秒、1-10）
+- [-a] または [-all] すべての利用可能なアルゴリズムをテスト
+- [-in] 入力ファイル
+- [-out] 出力ファイル
+
+使用例：
+
+```
+wolfssl bench aes-cbc -time 10
+
+wolfssl bench -a -time 5
+```

wolfCLU/src-ja/ca.md

@@ -1,21 +1,82 @@
 ### CA コマンド
-証明書への署名に使用されます。このコマンドはコンフィグレーションファイルを指定し、そのファイルから基本的なコンフィグレーション内容を取得することが可能です。
+証明書への署名に使用されます。設定ファイルの基本的な解析を処理できます。
 
-指定可能な引数:
+設定ファイルのディレクティブの詳細は[設定ファイル](config.md)を参照してください。
 
-- [-in] 入力となるCSRファイル
+引数:
+
+- [-in] 入力CSRファイル
 - [-out] 出力先ファイル
 - [-keyfile] 秘密鍵ファイル
 - [-cert] CA証明書ファイル
-- [-extensions] コンフィグレーションファイル内の解析すべきセクション
-- [-md] ハッシュタイプ（sha, sha256, ...）
+- [-extensions] 設定ファイル内の拡張セクション
+- [-md] ハッシュタイプ（sha、sha256 など）
 - [-inform] CSRファイル形式（PEM/DER）
-- [-config] コンフィグレーションファイル
-- [-days] 証明書に与える有効期間（日数）
-- [-selfsign] 自己署名する
+- [-config] 設定ファイル
+- [-days] 証明書の有効期間（日数）
+- [-selfsign] 入力証明書に関連付けられた鍵で署名
 
 使用例:
 
 ```
 wolfssl ca -config ca.conf -in test.csr -out test.pem -md sha256 -selfsign -keyfile ./key
 ```
+
+### 典型的なワークフロー：CAでCSRに署名
+
+**ステップ1: CA鍵と証明書を作成**（[GENKEY コマンド](genkey.md)と[REQ コマンド](req.md)を参照）
+
+```
+wolfssl genkey rsa -size 2048 -out ca -outform pem -output KEYPAIR
+wolfssl req -new -x509 -key ca.priv -out ca.pem -days 3650 -subj "/C=JP/ST=Tokyo/L=Shinjuku/O=Example/CN=Example CA"
+```
+
+**ステップ2: サーバー鍵とCSRを作成**
+
+```
+wolfssl genkey rsa -size 2048 -out server -outform pem -output KEYPAIR
+wolfssl req -new -key server.priv -out server.csr -subj "/C=JP/ST=Tokyo/L=Shinjuku/O=Example/CN=example.com"
+```
+
+**ステップ3: サーバーCSRをCAで署名**
+
+```
+wolfssl ca -in server.csr -out server-signed.pem -keyfile ca.priv -cert ca.pem -days 365 -md sha256
+```
+
+**ステップ4: 署名済み証明書を検証**（[VERIFY コマンド](verify.md)を参照）
+
+```
+wolfssl verify -CAfile ca.pem server-signed.pem
+```
+
+### CAでの設定ファイルの使用
+
+`-config` オプションを使用すると、署名時に追加する証明書拡張を指定できます。
+
+CA設定ファイルの例（`ca.conf`）：
+
+```ini
+[ca]
+x509_extensions = v3_ca
+
+[v3_ca]
+basicConstraints = critical, CA:FALSE
+keyUsage = digitalSignature, keyEncipherment
+subjectKeyIdentifier = hash
+subjectAltName = @alt_names
+
+[alt_names]
+DNS.1 = example.com
+DNS.2 = www.example.com
+```
+
+設定ファイルの拡張を使用してCSRに署名：
+
+```
+wolfssl ca -config ca.conf -extensions v3_ca -in server.csr -out server-signed.pem -keyfile ca.priv -cert ca.pem -days 365 -md sha256
+```
+
+### 制限事項
+
+設定ファイルを使用しない場合、wolfCLUは署名された各証明書にランダムなシリアル番号を生成します。設定ファイルベースのシリアル番号管理とその現在の制限事項については、[設定ファイル - 制限事項](config.md#制限事項)を参照してください。

wolfCLU/src-ja/command_list.md

@@ -1,26 +1,31 @@
-## コマンドリスト:
+## コマンド一覧
+
 - base64
 - bench
 - ca
 - crl
-- dsaparam
 - dgst
+- dhparam
+- dsaparam
+- ecc
 - ecparam
-- enc
+- ed25519
+- enc / encrypt / decrypt
 - genkey
 - hash
 - md5
-- pkcs12
 - pkcs7
 - pkcs8
+- pkcs12
 - pkey
 - rand
 - req
 - rsa
 - s_client
-- verify
-- x509
-- dhparam
+- s_server
 - sha256
 - sha384
 - sha512
+- verify
+- version
+- x509