6.6 VPN Tools コマンドリファレンス - SoftEther VPN プロジェクト

6.6 VPN Tools コマンドリファレンス

    ここでは、vpncmd を「VPN Tools コマンドの使用 (証明書作成や通信速度測定)」モードで使用している場合に呼び出すことができる、すべてのコマンドについて解説します。

    6.6.1 "About": バージョン情報の表示

    コマンド名 About
    コマンドの概要 バージョン情報の表示
    説明 このコマンドライン管理ユーティリティのバージョン情報を表示します。バージョン情報には、vpncmd のバージョン番号、ビルド番号、ビルド情報などが含まれます。
    コマンドライン書式 About
    "About" コマンドで指定することができるパラメータ引数の一覧:
    このコマンドには指定すべきパラメータ引数は 1 つもありません。

     

    6.6.2 "MakeCert": 新しい X.509 証明書と秘密鍵の作成

    コマンド名 MakeCert
    コマンドの概要 新しい X.509 証明書と秘密鍵の作成
    説明 新しい X.509 証明書と秘密鍵を作成し、ファイルとして保存します。
    証明書の公開鍵と秘密鍵の生成アルゴリズムには、RSA 1024 bit が使用されます。
    証明書の種類として、ルート証明書 (自己署名証明書) と他の証明書によって署名された証明書のどちらでも作成することができます。他の証明書によって署名された証明書を作成するためには、署名に使用する証明書 (X.509 形式のファイル) と対応する秘密鍵ファイル (Base 64 エンコード) が必要です。

    作成する証明書には、名前 (CN)、所属機関 (O)、組織単位 (OU)、国 (C)、都道府県 (ST)、ローカル (L)、シリアル番号、有効期限を指定することができます。
    作成された証明書は X.509 形式のファイルとして、秘密鍵ファイルは RSA 1024 bit 形式の Base 64 エンコードされたファイルとしてそれぞれ保存されます。

    MakeCert コマンドは、証明書を作成するための必要最低限の機能を用意したツールです。本格的な証明書を作成したい場合は、OpenSSL などのフリーソフトや、市販の CA (証明機関) ソフトウェアを使用することを推奨します。

    ※注意: このコマンドは SoftEther VPN コマンドライン管理ユーティリティから呼び出すことが可能です。現在 VPN Server や VPN Client に管理モードで接続している場合も実行できますが、実際に RSA 演算を行い、証明書データを生成しファイルに保存するのはこのコマンドを実行しているコンピュータであり、管理モードで接続先のコンピュータとは一切関係ないコンテキストで実行されます。
    コマンドライン書式 MakeCert [/CN:cn] [/O:o] [/OU:ou] [/C:c] [/ST:st] [/L:l] [/SERIAL:serial] [/EXPIRES:expires] [/SIGNCERT:signcert] [/SIGNKEY:signkey] [/SAVECERT:savecert] [/SAVEKEY:savekey]
    "MakeCert" コマンドで指定することができるパラメータ引数の一覧:
    /CN 作成する証明書の名前 (CN) 項目を指定します。none を指定することもできます。
    /O 作成する証明書の所属機関 (O) 項目を指定します。none を指定することもできます。
    /OU 作成する証明書の組織単位 (OU) 項目を指定します。none を指定することもできます。
    /C 作成する証明書の国 (C) 項目を指定します。none を指定することもできます。
    /ST 作成する証明書の都道府県 (ST) 項目を指定します。none を指定することもできます。
    /L 作成する証明書のローカル (L) 項目を指定します。none を指定することもできます。
    /SERIAL 作成する証明書のシリアル番号項目を指定します。16 進数で指定します。none を指定することもできます。
    /EXPIRES 作成する証明書の有効期限を指定します。none または 0 を指定すると、3650 日 (約 10 年) が使用されます。最大 10950 日 (約 30 年) まで指定できます。
    /SIGNCERT 作成する証明書を、既存の証明書によって署名する場合は、署名に使用する X.509 形式の証明書のファイル名を指定します。パラメータを省略した場合は、署名は行わず新しい証明書をルート証明書として作成します。
    /SIGNKEY /SIGNCERT で指定した証明書に対応する秘密鍵 (RSA, Base-64 エンコード) を指定します。
    /SAVECERT 作成した証明書を保存するファイル名を指定します。証明書は RSA 形式の 1024 bit の公開鍵を含んだ X.509 ファイルとして保存されます。
    /SAVEKEY 作成した証明書に対応する秘密鍵を保存するファイル名を指定します。秘密鍵は RSA 形式の 1024 bit の秘密鍵ファイルとして保存されます。

     

    6.6.3 "TrafficClient": 通信スループット測定ツールクライアントの実行

    コマンド名 TrafficClient
    コマンドの概要 通信スループット測定ツールクライアントの実行
    説明 通信スループット測定ツールの、クライアントプログラムを実行します。
    通信スループット測定ツールは TrafficClient と TrafficServer の 2 つのコマンドとして利用し、IP ネットワーク上で接続された 2 台のコンピュータの間で伝送することができる通信スループットを計測することができます。すでに別のコンピュータ上で、TrafficServer コマンドを用いて通信スループット測定ツールサーバーを待機させておき、TrafficClient コマンドで、そのサーバーのホスト名または IP アドレスとポート番号を指定して接続し、通信速度を測定することができます。
    通信速度の測定は、同時に複数本の TCP コネクションを確立し、それぞれのコネクションで最大限にストリームデータを伝送した結果、指定された時間内に実際に伝送することができたデータのビット数を計算し、それを元に通信スループットの平均値 (bps) を算出する方法で行われます。通常、1 本の TCP コネクションを用いた場合は TCP のアルゴリズム上の限界により、実際のネットワークスループットよりも遅い速度でしか通信できない場合が多いため、複数本の TCP コネクションを同時に確立して通信した結果を測定することを推奨します。この測定方法によって計測されたスループットは実際に TCP でストリームとして受信側に届いたデータのビット長から計算されるため、途中で発生したパケットロスやデータ破損したパケットは、実際に届いたパケットには含まれず、純粋なネットワークの最大通信可能帯域幅に近い値を算出することができます。
    測定結果として TCP 内で伝送されたストリームサイズから、実際にネットワーク上を流れたデータ量の近似値を計算し、それを時間で割ってビット毎秒 (bps) を算出します。物理的なネットワークの種類は Ethernet (IEEE802.3) で、MAC フレームのペイロードサイズは 1,500 Bytes (TCP の MSS は 1,460 Bytes) と仮定して計算が行われます。/RAW オプションを指定すると、TCP/IP ヘッダや MAC ヘッダのデータ量を補正する計算は行われません。

    ※注意: このコマンドは SoftEther VPN コマンドライン管理ユーティリティから呼び出すことが可能です。現在 VPN Server や VPN Client に管理モードで接続している場合も実行できますが、実際に通信を行ってスループットを測定するのは、このコマンドを実行しているコンピュータであり、管理モードで接続先のコンピュータとは一切関係ないコンテキストで実行されます。
    コマンドライン書式 TrafficClient [host:port] [/NUMTCP:numtcp] [/TYPE:download|upload|full] [/SPAN:span] [/DOUBLE:yes|no] [/RAW:yes|no]
    "TrafficClient" コマンドで指定することができるパラメータ引数の一覧:
    host:port 通信スループット測定ツールサーバー (TrafficServer) が待機しているホスト名、または IP アドレスとポート番号を指定します。ポート番号を省略した場合は、9821 が使用されます。
    /NUMTCP 同時にクライアントとサーバーとの間で確立されデータが伝送される TCP コネクション数を指定します。省略した場合は 32 が使用されます。
    /TYPE スループット測定を行う際の、データの流れる方向を指定します。"download"、"upload"、"full" のうち 1 つを指定します。download を指定すると、サーバー側からクライアント側にデータが伝送されます。upload を指定すると、クライアント側からサーバー側にデータが伝送されます。full を指定すると、双方向にデータが伝送されます。full を指定する場合は、NUMTCP の値は 2 以上の偶数に指定する必要があります (同時に接続される TCP コネクションのうち半数がダウンロード方向、残りの半数がアップロード方向に使用されます)。このパラメータを省略した場合は full が使用されます。
    /SPAN スループットを測定するためのデータ伝送を行う時間を、秒数単位で指定します。このパラメータを省略した場合は 15 秒が使用されます。
    /DOUBLE "yes" を指定した場合、計測した結果のスループットを 2 倍にして表示します。このオプションは、途中にネットワーク装置などがあり、そのネットワーク装置が入出力した合計のスループット能力を測定する場合に使用します。
    /RAW "yes" を指定すると、TCP/IP ヘッダや MAC ヘッダのデータ量を補正する計算を行いません。

     

    6.6.4 "TrafficServer": 通信スループット測定ツールサーバーの実行

    コマンド名 TrafficServer
    コマンドの概要 通信スループット測定ツールサーバーの実行
    説明 通信スループット測定ツールのサーバープログラムを実行します。
    通信スループット測定ツールは、TrafficClient と TrafficServer の 2 つのコマンドとして利用し、IP ネットワーク上で接続された 2 台のコンピュータの間で伝送することができる通信スループットを計測することができます。
    このコンピュータ上の TCP ポートを待機状態にして、別のコンピュータからの TrafficClient からの接続を待ち受けるには、TrafficServer コマンドにポート番号を指定して起動します。
    通信スループット測定ツールに関する詳細は、TrafficClient /? と入力すると表示されます。

    ※注意: このコマンドは SoftEther VPN コマンドライン管理ユーティリティから呼び出すことが可能です。現在 VPN Server や VPN Client に管理モードで接続している場合も実行できますが、実際に通信を行ってスループットを測定するのは、このコマンドを実行しているコンピュータであり、管理モードで接続先のコンピュータとは一切関係ないコンテキストで実行されます。
    コマンドライン書式 TrafficServer [port]
    "TrafficServer" コマンドで指定することができるパラメータ引数の一覧:
    port 接続を待ち受けるポート番号を整数で指定します。指定されたポートが、すでに別のプログラムによって使用中の場合や、ポートを開くことができない場合はエラーが発生します。

     

    6.6.5 "Check": SoftEther VPN の動作が可能かどうかチェックする

    コマンド名 Check
    コマンドの概要 SoftEther VPN の動作が可能かどうかチェックする
    説明 現在 vpncmd を動作させているコンピュータが、SoftEther VPN Server / Bridge の動作プラットフォームとして適切であるかどうかをチェックします。
    このチェックを通過したシステム上では、SoftEther VPN ソフトウェアが正しく動作する可能性が高いと思われます。
    また、このチェックを通過できないシステム上では、SoftEther VPN ソフトウェアを使用した場合に、何らかの問題が発生する可能性があります。
    コマンドライン書式 Check
    "Check" コマンドで指定することができるパラメータ引数の一覧:
    このコマンドには指定すべきパラメータ引数は 1 つもありません。