Skip to content

Commit 3804c7b

Browse files
committed
Add missing command documentation
1 parent abc254f commit 3804c7b

10 files changed

Lines changed: 242 additions & 0 deletions

File tree

wolfCLU/mkdocs-ja.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ nav:
1414
- "DSAPARAM コマンド": dsaparam.md
1515
- "DGST コマンド": dgst.md
1616
- "DHPARAM コマンド": dhparam.md
17+
- "ECC コマンド": ecc.md
1718
- "ECPARAM コマンド": ecparam.md
19+
- "ED25519 コマンド": ed25519.md
1820
- "ENC コマンド": enc.md
1921
- "GENKEY コマンド": genkey.md
2022
- "HASH コマンド": hash.md
@@ -28,7 +30,9 @@ nav:
2830
- "RSA コマンド": rsa.md
2931
- "SHA コマンド": sha.md
3032
- "S_CLIENT コマンド": s_client.md
33+
- "S_SERVER コマンド": s_server.md
3134
- "VERIFY コマンド": verify.md
35+
- "VERSION コマンド": version.md
3236
- "X509 コマンド": x509.md
3337
- "BASE64 コマンド": base64.md
3438
- "付録":

wolfCLU/mkdocs.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ nav:
1414
- "DSAPARAM Command": dsaparam.md
1515
- "DGST Command": dgst.md
1616
- "DHPARAM Command": dhparam.md
17+
- "ECC Command": ecc.md
1718
- "ECPARAM Command": ecparam.md
19+
- "ED25519 Command": ed25519.md
1820
- "ENC Command": enc.md
1921
- "GENKEY Command": genkey.md
2022
- "HASH Command": hash.md
@@ -28,7 +30,9 @@ nav:
2830
- "RSA Command": rsa.md
2931
- "SHA Command": sha.md
3032
- "S_CLIENT Command": s_client.md
33+
- "S_SERVER Command": s_server.md
3134
- "VERIFY Command": verify.md
35+
- "VERSION Command": version.md
3236
- "X509 Command": x509.md
3337
- "BASE64 Command": base64.md
3438
- "Appendix":

wolfCLU/src-ja/ecc.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
### ECC コマンド
2+
3+
ECC(楕円曲線暗号)鍵を使用してデータの署名・検証を行います。
4+
5+
引数:
6+
7+
- [-sign] 署名操作
8+
- [-verify] 検証操作
9+
- [-inkey] 入力鍵ファイル
10+
- [-in] 署名または検証する入力ファイル
11+
- [-out] 署名の出力ファイル(署名操作時)
12+
- [-sigfile] 署名ファイル(検証操作時)
13+
- [-pubin] 入力鍵が公開鍵であることを指定(検証操作時)
14+
15+
使用例:
16+
17+
ECC秘密鍵でファイルに署名:
18+
19+
```
20+
wolfssl ecc -sign -inkey ecc-priv.pem -in file.txt -out file.sig
21+
```
22+
23+
ECC公開鍵で署名を検証:
24+
25+
```
26+
wolfssl ecc -verify -inkey ecc-pub.pem -sigfile file.sig -in file.txt -pubin
27+
```
28+
29+
ECC秘密鍵で署名を検証:
30+
31+
```
32+
wolfssl ecc -verify -inkey ecc-priv.pem -sigfile file.sig -in file.txt
33+
```

wolfCLU/src-ja/ed25519.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
### ED25519 コマンド
2+
3+
Ed25519鍵を使用してデータの署名・検証を行います。
4+
5+
引数:
6+
7+
- [-sign] 署名操作
8+
- [-verify] 検証操作
9+
- [-inkey] 入力鍵ファイル
10+
- [-in] 署名または検証する入力ファイル
11+
- [-out] 署名の出力ファイル(署名操作時)
12+
- [-sigfile] 署名ファイル(検証操作時)
13+
- [-pubin] 入力鍵が公開鍵であることを指定(検証操作時)
14+
15+
使用例:
16+
17+
Ed25519秘密鍵でファイルに署名:
18+
19+
```
20+
wolfssl ed25519 -sign -inkey ed25519-priv.pem -in file.txt -out file.sig
21+
```
22+
23+
Ed25519公開鍵で署名を検証:
24+
25+
```
26+
wolfssl ed25519 -verify -inkey ed25519-pub.pem -sigfile file.sig -in file.txt -pubin
27+
```
28+
29+
Ed25519秘密鍵で署名を検証:
30+
31+
```
32+
wolfssl ed25519 -verify -inkey ed25519-priv.pem -sigfile file.sig -in file.txt
33+
```

wolfCLU/src-ja/s_server.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
### S_SERVER コマンド
2+
3+
テスト用のシンプルなSSL/TLSサーバーです。指定したポートでリッスンし、SSL/TLS接続を処理します。
4+
5+
引数:
6+
7+
- [-port] リッスンするポート番号
8+
- [-key] 秘密鍵ファイル(PEM形式)
9+
- [-cert] 証明書ファイル(PEM形式)
10+
- [-noVerify] クライアント証明書の検証を無効化
11+
- [-CAfile] クライアント検証用のCA証明書ファイル(PEM形式)
12+
- [-version] SSL/TLSバージョン: 0=SSLv3, 1=TLS1.0, 2=TLS1.1, 3=TLS1.2, 4=TLS1.3
13+
- [-naccept] 受け付ける接続数(デフォルト: 1)
14+
- [-www] HTTPレスポンスをHTML形式で送信
15+
- [-readyFile] 外部モニタリング用のreadyファイルを作成
16+
17+
使用例:
18+
19+
ポート4433でシンプルなTLSサーバーを起動:
20+
21+
```
22+
wolfssl s_server -port 4433 -cert server-cert.pem -key server-key.pem
23+
```
24+
25+
クライアント証明書検証付きでサーバーを起動:
26+
27+
```
28+
wolfssl s_server -port 4433 -cert server-cert.pem -key server-key.pem -CAfile ca-cert.pem
29+
```
30+
31+
複数接続を受け付けHTTPレスポンスを返すサーバーを起動:
32+
33+
```
34+
wolfssl s_server -port 4433 -cert server-cert.pem -key server-key.pem -naccept 10 -www
35+
```

wolfCLU/src-ja/version.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
### VERSION コマンド
2+
3+
wolfCLUとリンクされたwolfSSLライブラリのバージョン情報を表示します。
4+
5+
使用例:
6+
7+
```
8+
wolfssl version
9+
```
10+
11+
出力例:
12+
13+
```
14+
You are using version 0.1.9 of the wolfssl Command Line Utility.
15+
Linked to wolfSSL version 5.8.4
16+
```

wolfCLU/src/ecc.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
### ECC Command
2+
3+
Sign and verify data using ECC (Elliptic Curve Cryptography) keys.
4+
5+
Arguments:
6+
7+
- [-sign] Sign operation
8+
- [-verify] Verify operation
9+
- [-inkey] Input key file
10+
- [-in] Input file to sign or verify
11+
- [-out] Output file for signature (sign operation)
12+
- [-sigfile] Signature file (verify operation)
13+
- [-pubin] Input key is a public key (for verify operation)
14+
15+
Usage Examples:
16+
17+
Sign a file with ECC private key:
18+
19+
```
20+
wolfssl ecc -sign -inkey ecc-priv.pem -in file.txt -out file.sig
21+
```
22+
23+
Verify a signature with ECC public key:
24+
25+
```
26+
wolfssl ecc -verify -inkey ecc-pub.pem -sigfile file.sig -in file.txt -pubin
27+
```
28+
29+
Verify a signature with ECC private key:
30+
31+
```
32+
wolfssl ecc -verify -inkey ecc-priv.pem -sigfile file.sig -in file.txt
33+
```

wolfCLU/src/ed25519.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
### ED25519 Command
2+
3+
Sign and verify data using Ed25519 keys.
4+
5+
Arguments:
6+
7+
- [-sign] Sign operation
8+
- [-verify] Verify operation
9+
- [-inkey] Input key file
10+
- [-in] Input file to sign or verify
11+
- [-out] Output file for signature (sign operation)
12+
- [-sigfile] Signature file (verify operation)
13+
- [-pubin] Input key is a public key (for verify operation)
14+
15+
Usage Examples:
16+
17+
Sign a file with Ed25519 private key:
18+
19+
```
20+
wolfssl ed25519 -sign -inkey ed25519-priv.pem -in file.txt -out file.sig
21+
```
22+
23+
Verify a signature with Ed25519 public key:
24+
25+
```
26+
wolfssl ed25519 -verify -inkey ed25519-pub.pem -sigfile file.sig -in file.txt -pubin
27+
```
28+
29+
Verify a signature with Ed25519 private key:
30+
31+
```
32+
wolfssl ed25519 -verify -inkey ed25519-priv.pem -sigfile file.sig -in file.txt
33+
```

wolfCLU/src/s_server.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
### S_SERVER Command
2+
3+
A simple SSL/TLS server for testing. Listens on a specified port and handles incoming SSL/TLS connections.
4+
5+
Arguments:
6+
7+
- [-port] Port number to listen on
8+
- [-key] Private key file (PEM format)
9+
- [-cert] Certificate file (PEM format)
10+
- [-noVerify] Disable client certificate verification
11+
- [-CAfile] CA certificate file for client verification (PEM format)
12+
- [-version] SSL/TLS version: 0=SSLv3, 1=TLS1.0, 2=TLS1.1, 3=TLS1.2, 4=TLS1.3
13+
- [-naccept] Number of connections to accept (default: 1)
14+
- [-www] Send HTTP response in HTML format
15+
- [-readyFile] Create a ready file for external monitoring
16+
17+
Usage Examples:
18+
19+
Start a simple TLS server on port 4433:
20+
21+
```
22+
wolfssl s_server -port 4433 -cert server-cert.pem -key server-key.pem
23+
```
24+
25+
Start server with client certificate verification:
26+
27+
```
28+
wolfssl s_server -port 4433 -cert server-cert.pem -key server-key.pem -CAfile ca-cert.pem
29+
```
30+
31+
Start server accepting multiple connections with HTTP response:
32+
33+
```
34+
wolfssl s_server -port 4433 -cert server-cert.pem -key server-key.pem -naccept 10 -www
35+
```

wolfCLU/src/version.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
### VERSION Command
2+
3+
Displays version information for wolfCLU and the linked wolfSSL library.
4+
5+
Usage:
6+
7+
```
8+
wolfssl version
9+
```
10+
11+
Example Output:
12+
13+
```
14+
You are using version 0.1.9 of the wolfssl Command Line Utility.
15+
Linked to wolfSSL version 5.8.4
16+
```

0 commit comments

Comments
 (0)