wolfSSH manual: rewrite and extend the API reference

wolfSSH/Makefile

@@ -16,7 +16,10 @@ SOURCES = chapter01.md \
           chapter11.md \
           chapter12.md \
           chapter13.md \
-          chapter14.md 
+          chapter14.md \
+          chapter15.md \
+          chapter16.md \
+          chapter17.md
 
 ifeq ($(DOC_LANG),JA)
     PDF  = wolfSSH-Manual-jp.pdf

wolfSSH/mkdocs-ja.yml

@@ -17,7 +17,10 @@ nav:
     - "11. サポートとコンサルティング": chapter11.md
     - "12. wolfSSHのアップデート": chapter12.md
     - "13. APIリファレンス": chapter13.md
-    - "14. wolfSSL SFTP API リファレンス": chapter14.md
+    - "14. SFTP API リファレンス": chapter14.md
+    - "15. SCP API リファレンス": chapter15.md
+    - "16. その他のAPIリファレンス": chapter16.md
+    - "17. プリプロセッサ ガードマクロ": chapter17.md
 theme:
   name: null
   custom_dir: ../mkdocs-material/material

wolfSSH/mkdocs.yml

@@ -17,7 +17,10 @@ nav:
     - "11. Support and Consulting": chapter11.md
     - "12. wolfSSH Updates": chapter12.md
     - "13. API Reference": chapter13.md
-    - "14. wolfSSL SFTP API Reference": chapter14.md
+    - "14. SFTP API Reference": chapter14.md
+    - "15. SCP API Reference": chapter15.md
+    - "16. Additional API Reference": chapter16.md
+    - "17. Preprocessor Guard Macros": chapter17.md
 theme:
   name: null
   custom_dir: ../mkdocs-material/material

wolfSSH/src-ja/chapter01.md

@@ -1,49 +1,41 @@
 #  イントロダクション
 
+このマニュアルは組み込み用 wolfSSH ライブラリの技術ガイドとして書かれています。wolfSSH のビルド方法と使い始め方を説明し、ビルドオプション、機能、サポートなどの概要を提供します。
 
-このマニュアルは組み込み用wolfSSHライブラリの技術解説書としてお読みいただけるように書かれています。wolfSSHをビルドして起動することから始まり、ビルドオプション、機能、サポートなどの概要を提供します。
-
-wolfSSHはC言語で書かれたSSH（セキュアシェル）サーバー実装で、wolfSSLから利用可能なwolfCryptを使用します。さらに、マルチプラットフォームで使用できるようにゼロから構築されています。また、SSHv2仕様に準拠しています。
+wolfSSH は C 言語で書かれた SSH（セキュアシェル）サーバーの実装で、wolfSSL からも利用可能な wolfCrypt ライブラリを使用します。さらに、wolfSSH はマルチプラットフォームで利用できるようにゼロから構築されています。この実装は SSH v2 仕様に基づいています。
 
 ##  プロトコル概要
 
-SSHは２つの通信端点に多重化されたデータストリームを提供する一連の階層化されたプロトコルです。一般的には、サーバー上のシェルへの接続を保護するために利用されます。ですが、ファイルを安全にコピーしたり、Xディスプレイプロトコルをトンネリングするのにも利用されています。
-
-##  wolfSSHをお勧めする理由
+SSH は、2 つのピア間で多重化されたデータストリームを提供する階層化されたプロトコル群です。一般的には、サーバー上のシェルへの接続を保護するために利用されます。ただし、2 台のマシン間でファイルを安全にコピーしたり、X ディスプレイプロトコルをトンネリングしたりするためにもよく利用されます。
 
-wolfSSHはANSI Cで記述された軽量のSSHv2サーバーライブラリで、サイズが軽量でありスピード、機能セットに富んでいる点から、組み込み機器、リアルタイムOSおよびリソース制約のある環境をターゲットにしています。wolfSSHは業界標準のSSH v2をサポートし、さらに先進的なアルゴリズム（ChaCha20, Poly1305, NTRU とSHA-3)も提供しています。wolfSSHを支えているのはwolfCrypt暗号化ライブラリで、このライブラリはFIPS140-2認証（認証#2425）を受けています。より詳細はwolfCrypt FIPS FAQを参照されるかあるいはfacts@wolfssl.comまでお知らせください。
+##  wolfSSH をお勧めする理由
 
+wolfSSH ライブラリは ANSI C で記述された軽量な SSHv2 サーバーライブラリで、そのサイズの小ささ、速度、機能セットから、主に組み込み機器、RTOS、リソース制約のある環境をターゲットにしています。ロイヤリティフリーの価格設定と優れたクロスプラットフォームサポートにより、標準的な動作環境でも広く利用されています。wolfSSH は業界標準の SSH v2 をサポートしています。wolfSSH は wolfCrypt ライブラリによって支えられています。wolfCrypt 暗号ライブラリのあるバージョンは FIPS 140-3 認証（認証番号 #4718）および FIPS 140-2 認証（認証番号 #3389）を取得しています。追加情報については、wolfCrypt FIPS FAQ を参照するか、fips@wolfssl.com までお問い合わせください。
 
-### 機能（特徴）
+### 機能
 
+- SSH v2.0（サーバーおよびクライアント）
 
-- SSH v2.0 (サーバー機能)
+- 最小フットプリントサイズ 33kB
 
-- 最小フットプリント：33kB
+- 実行時メモリ使用量 1.4KB〜2KB（設定可能な受信バッファは含まず）
 
-- 実行時メモリ消費量：1.4KB ~ 2KB (受信バッファは含まず)
+- 複数のハッシュ関数: SHA-1、SHA-2（SHA-256、SHA-384、SHA-512）
 
-- ハッシュ関数: SHA-1, SHA-2 (SHA-256, SHA-384, SHA-512), BLAKE2b, Poly
+- ブロック暗号および認証付き暗号: AES-CBC、AES-CTR、AES-GCM
 
-- 暗号アルゴリズム：Block, Stream, and Authenticated Ciphers: AES (CBC, CTR, GCM, CCM), Camellia, ChaCha
+- 鍵交換オプション: DHE および ECDHE（曲線 NISTP256、NISTP384、NISTP521）
 
-- 公開鍵オプション: RSA, DH, EDH, NTRU
+- 公開鍵認証オプション: RSA および ECDSA（曲線 NISTP256、NISTP384、NISTP521）
 
-- ECDH と ECDSA で次の楕円曲線をサポート: NISTP256, NISTP384, NISTP, Curve25519, Ed
+- ユーザー認証のサポート（パスワード、keyboard-interactive、公開鍵認証）
 
-- クライアント認証をサポート(RSA key, password)
+- シンプルな API
 
-- シンプルなAPI
+- PEM および DER 形式の X.509 証明書サポート
 
-- PEM and DER certificate support
+- ハードウェア暗号サポート: Intel AES-NI サポート、Intel AVX1/2、RDRAND、RDSEED、Cavium NITROX サポート、STM32F2/F4 ハードウェア暗号サポート、Freescale CAU / mmCAU / SEC、Microchip PIC32MZ
 
-- ハードウエア暗号サポート: 
-    - Intel AES-NI support
-    - Intel AVX1/2
-    - RDRAND
-    - RDSEED
-    - Cavium NITROX
-    - STM32F2/F4 ハードウエア暗号
-    - Freescale CAU / mmCAU / SEC
-    - Microchip PIC32MZ
+- Hybrid ECDH-P256 Kyber-Level1 によるポスト量子ハイブリッド鍵交換
 
+- SFTP、SCP、SSH-AGENT、ローカルおよびリモートポートフォワーディングのサポート