Merge pull request #89 from TakayukiMatsuo/clu

Author: cconlon

wolfCLU/Makefile

@@ -7,8 +7,11 @@ SOURCES = Intro.md \
 		  build.md \
 		  command_list.md \
 		  bench.md \
+		  ca.md \
           crl.md \
+		  dsaparam.md \
           dgst.md \
+		  dhparam.md \
           ecparam.md \
           enc.md \
 		  genkey.md \
@@ -19,11 +22,16 @@ SOURCES = Intro.md \
 		  rand.md \
 		  req.md \
 		  rsa.md \
+		  sha.md \
 		  s_client.md \
 		  verify.md \
 		  x509.md
 
-PDF = wolfCLU-Manual.pdf
+ifeq ($(DOC_LANG),JA)
+    PDF  = wolfCLU-Manual-jp.pdf
+else
+    PDF  = wolfCLU-Manual.pdf
+endif
 
 .PHONY: html-prep
 html-prep:

wolfCLU/mkdocs-ja.yml

@@ -0,0 +1,49 @@
+site_name: wolfCLU マニュアル
+site_url: https://wolfssl.com/
+docs_dir: build/html/
+site_dir: html/
+copyright: wolfSSL Inc. 2022
+nav:
+    - "1. イントロダクション": index.md
+    - "2. wolfCLUのビルド": build.md
+    - "3. コマンド":
+      - "コマンドリスト": command_list.md
+      - "BENCH コマンド": bench.md
+      - "CA コマンド": ca.md
+      - "CRL コマンド": crl.md
+      - "DSAPARAM コマンド": dsaparam.md
+      - "DGST コマンド": dgst.md
+      - "DHPARAM コマンド": dhparam.md
+      - "ECPARAM コマンド": ecparam.md
+      - "ENC コマンド": enc.md
+      - "GENKEY コマンド": genkey.md
+      - "HASH コマンド": hash.md
+      - "MD5 コマンド": md5.md
+      - "PKCS12 コマンド": pkcs12.md
+      - "PKEY コマンド": pkey.md
+      - "RAND コマンド": rand.md
+      - "REQ コマンド": req.md
+      - "RSA コマンド": rsa.md
+      - "SHA コマンド": sha.md
+      - "S_CLIENT コマンド": s_client.md
+      - "VERIFY コマンド": verify.md
+      - "X509 コマンド": x509.md
+theme:
+  name: null
+  custom_dir: ../mkdocs-material/material
+  language: en
+  palette:
+    primary: indigo
+    accent: indigo
+  font:
+    text: Roboto
+    code: Roboto Mono
+  icon: "logo.png"
+  logo: logo.png
+  favicon: logo.png
+  feature:
+    tabs: true
+extra_css: [skin.css]
+extra:
+    generator: false
+use_directory_urls: false

wolfCLU/src-ja/Intro.md

@@ -0,0 +1,9 @@
+
+# wolfCLU マニュアル
+
+ wolfSSL コマンドラインユーティリティ (version 0.0.7)    
+2021/Nov/24
+
+
+## 始めに
+wolfCLU は、アプリケーションを最初から作成するよりも簡単/迅速に、いくつかの一般的な暗号化操作を処理するために作成されました。 処理できる操作の例としては、証明書の解析と鍵の生成があります。

wolfCLU/src-ja/bench.md

@@ -0,0 +1,2 @@
+### BENCH コマンド
+ベンチマーク アルゴリズムのコマンドは現在実装途中です。現在使用できるコマンドは、全アルゴリズムを実行する、"wolfSSL bench -all" です。

wolfCLU/src-ja/build.md

@@ -0,0 +1,62 @@
+## wolfCLUのビルド
+
+### *NIX上でのビルド
+
+wolfCLU のビルドに先立ち、最初に --enable-wolfclu フラグを指定して 次のようにwolfSSL をビルドしインストールする必要があります：
+
+```
+cd wolfssl
+./configure --enable-wolfclu
+make
+sudo make install
+```
+    
+RC2を使用してPKCS12ファイルを解析する場合、またはCRLを使用する場合には、wolfSSLのビルドの際にフラグ "--enable-rc2" および "--enable-crl" も使用する必要があることに注意してください。
+
+次に、作成した wolfSSLライブラリをリンクしてwolfCLUをビルドします。
+
+```
+cd wolfclu
+./configure
+make
+sudo make install
+```
+
+あるいは
+
+```
+cd wolfclu
+./configure --with-wolfssl=/path/to/wolfssl/install
+make
+sudo make install
+```
+
+ユニットテストを実行する場合には"make check"を実行してください。
+
+
+### Windows上でのビルド
+
+wolfCLU は、そのVisual Studioソリューションファイルである wolfclu.sln を使用してビルドすることもできます。 このソリューションファイルは、32ビットまたは 64ビットのダイナミックリンクライブラリのデバッグ ビルドとリリース ビルドの両方を提供します。コンフィグレーションオプション指定のためにファイル`user_settings.h`を用意する必要があります。
+
+この`user_settings.h`のテンプレートとして使用できるファイルが`wolfclu\ide\winvs\user_settings.h` に用意してありいます。このファイルを、ディレクトリ `wolfclu\ide\winvs` から `wolfssl\IDE\WIN` にコピーして使用してください。wolfCLU をサポートする wolfSSL をビルドすることができます。
+
+wolfCLU をビルドする前に、wolfSSL で使用されているのと同じアーキテクチャ (Win32 または x64) が選択されていることを確認してください。
+
+このプロジェクトでは、wolfSSH および wolfSSL ソース ディレクトリが各々バージョン番号がない状態でサイドバイサイドで配置されていることを前提としています：
+
+```
+    Projects\
+        wolfclu\
+        wolfssl\
+```
+リリース構成でwolfCLUをビルドすると、`Release\Win32` あるいは `Release\x64`フォルダに`wolfssl.exe`が生成されます。
+ 
+
+#### ユニットテストの実行
+
+シェルスクリプトのユニットテストを実行するには、`shコマンド`または`bashコマンド`のいずれかが必要です。
+どちらのコマンドも、Windows の Git インストールに付属しています (ただし、それらを PATH に追加する必要がある場合があります)。
+
+1. wolfssl.exe を wolfclu のルートディレクトリにコピーします。
+2. `./wolfssl $1` の代わりに `./wolfssl.exe $1` を実行するように、目的のユニットテストの `run` 関数 (存在する場合は `run_fail` も) を変更します。
+3. ターミナルで、ルート ディレクトリから `sh <desired_unit_test>` を実行します。 たとえば、ハッシュ ユニット テストを実行するには、`sh tests\hash\hash-test.sh`を実行します。

wolfCLU/src-ja/ca.md

@@ -0,0 +1,21 @@
+### CA コマンド
+証明書への署名に使用されます。このコマンドはコンフィグレーションファイルを指定し、そのファイルから基本的なコンフィグレーション内容を取得することが可能です。
+
+指定可能な引数:
+
+- [-in] 入力となるCSRファイル
+- [-out] 出力先ファイル
+- [-keyfile] 秘密鍵ファイル
+- [-cert] CA証明書ファイル
+- [-extensions] コンフィグレーションファイル内の解析すべきセクション
+- [-md] ハッシュタイプ（sha, sha256, ...）
+- [-inform] CSRファイル形式（PEM/DER）
+- [-config] コンフィグレーションファイル
+- [-days] 証明書に与える有効期間（日数）
+- [-selfsign] 自己署名する
+
+使用例:
+
+```
+wolfssl ca -config ca.conf -in test.csr -out test.pem -md sha256 -selfsign -keyfile ./key
+```

wolfCLU/src-ja/command_list.md

@@ -0,0 +1,23 @@
+## コマンドリスト:
+- bench
+- ca
+- crl
+- dsaparam
+- dgst
+- ecparam
+- enc
+- genkey
+- hash
+- md5
+- pkcs12
+- pkey
+- rand
+- req
+- rsa
+- s_client
+- verify
+- x509
+- dhparam
+- sha256
+- sha384
+- sha512

wolfCLU/src-ja/crl.md

@@ -0,0 +1,17 @@
+### CRL コマンド
+CA を指定して CRL ファイルを検証するために使用されます。 または、CRL を フォーマット変換 [DER|PEM] することもできます。-out が指定されておらず、-noout が使用されていない場合、このコマンドは CRL を stdout に出力します。 検証が成功すると「OK」を出力します。
+
+引数：
+
+- [-CAfile] CA証明書ファイル
+- [-inform] 入力フォーマット：pem あるいは der 
+- [-in] the CRLファイル
+- [-outform] 出力フォーマット：pem あるいは der
+- [-out] 出力ファイル
+- [-noout] 指定がある場合には出力しません
+
+使用例:
+
+```
+wolfssl crl -CAfile ./certs/ca-cert.pem -in ./certs/crl.der -inform DER -noout
+```

wolfCLU/src-ja/dgst.md

@@ -0,0 +1,34 @@
+### DGST コマンド
+署名を検証することが可能です。最後の引数は署名対象となったデータです。
+
+サポートしているハッシュアルゴリズム:     
+
+- [-sha]
+- [-sha224]
+- [-sha256]
+- [-sha384]
+- [-sha512]
+
+**署名**
+
+引数:     
+
+- [-sign] 署名作成に必要な鍵
+- [-out] 署名出力先のファイル
+
+使用例:
+```
+wolfssl dgst -sign keyPrivate.pem -out test.sig testfile
+```
+
+**検証**
+
+引数:     
+
+- [-verify] 署名を検証する為に使用する鍵
+- [-signature] 署名を含んだファイル
+
+使用例:
+```
+wolfssl dgst -verify keyPublic.pem -signature test.sig testfile
+```

wolfCLU/src-ja/dhparam.md

@@ -0,0 +1,17 @@
+### DHPARAM コマンド
+
+デフィー・ヘルマンパラメータと鍵の生成に使用されます。
+
+引数:    
+
+- [-genkey] 新たなDH鍵を生成します
+- [-in] 鍵生成のためのパラメータを読み取るファイル
+- [-out] 出力ファイル（デフォルトはstdout)
+- [-check] 生成されたパラメータが有効かチェックする
+- [-noout] パラメータをプリントしない
+
+使用例: 
+
+```
+wolfssl dhparam -check -out dh.params 1024
+```