Windows CLI

🚀 Windowsコマンドラインインターフェイスサーバーの設定

このプロジェクトは、Windowsコマンドラインインターフェイスサーバーの設定を提供します。サーバーの基本設定、shell設定、SSH設定などを構成でき、安全なコマンド実行環境を提供します。

🚀 クイックスタート

このセクションでは、Windowsコマンドラインインターフェイスサーバーの設定について説明します。

✨ 主な機能

• サーバーの基本設定、shell設定、SSH設定を提供します。
• コマンドの実行を制限し、危険な命令をブロックします。
• SSH接続をサポートし、安全な通信を提供します。
• セキュリティ機能を備え、敏感な情報を自動的に隠します。

📦 インストール

このサーバーの設定は、コードのダウンロードやインストールが必要ないため、このセクションは省略します。

💻 使用例

基本的な使用法

{
  "port": 3000,              // サービスがバインドするポート、デフォルトは3000
  "host": "localhost",       // バインドするアドレス、IPまたはドメイン名に設定、デフォルトはlocalhost
  "restrictWorkingDirectory": true, // コマンドの実行ディレクトリを制限するかどうか、デフォルトはtrue
  "allowedPaths": [          // 許可されるフォルダのパス、デフォルトでは現在の作業ディレクトリとユーザーのホームディレクトリが含まれます
    "%current%",
    "%home%"
  ],
  "commandLengthLimit": 2000, // コマンドの最大長制限、長いコマンドの注入を防ぐ、デフォルトは2000文字
  "logCommands": true,        // 実行されたコマンドを記録するかどうか、デフォルトはtrue
  "timeout": 30000            // コマンドの最大実行時間（ミリ秒）、デフォルトは30秒
}

高度な使用法

# すべての利用可能なリソースを取得する
curl http://localhost:3000/_resources

# 現在のディレクトリ情報を取得する
curl http://localhost:3000/cli://currentdir

# システムコマンドを実行する
curl -X POST --data "command=dir" http://localhost:3000/

📚 ドキュメント

設定

基本設定

{
  "port": 3000,              // サービスがバインドするポート、デフォルトは3000
  "host": "localhost",       // バインドするアドレス、IPまたはドメイン名に設定、デフォルトはlocalhost
  "restrictWorkingDirectory": true, // コマンドの実行ディレクトリを制限するかどうか、デフォルトはtrue
  "allowedPaths": [          // 許可されるフォルダのパス、デフォルトでは現在の作業ディレクトリとユーザーのホームディレクトリが含まれます
    "%current%",
    "%home%"
  ],
  "commandLengthLimit": 2000, // コマンドの最大長制限、長いコマンドの注入を防ぐ、デフォルトは2000文字
  "logCommands": true,        // 実行されたコマンドを記録するかどうか、デフォルトはtrue
  "timeout": 30000            // コマンドの最大実行時間（ミリ秒）、デフォルトは30秒
}

shell設定

{
  "shells": [                // サポートされるshellのリスト、デフォルトではcmdとbashが含まれます
    "cmd.exe",
    "/bin/bash"
  ],
  "blockedCommands": [       // ブロックされる危険なコマンド、デフォルトではrm、delなどが含まれます
    "rm",
    "del",
    "format",
    "erase",
    " Cipher ",
    "vssadmin",
    "wbadmin",
    "regsvr32",
    "msbuild"
  ],
  "blockedArguments": [      // ブロックされる危険な引数、デフォルトでは/c、/fなどが含まれます
    "/c",
    "/f",
    "/q",
    "/s",
    "-rf",
    "--force",
    "--recursive"
  ],
  "enableInjectionProtection": true, // コマンド注入防止を有効にするかどうか、デフォルトはtrue
  "caseInsensitiveBlocking": true     // コマンドのブロックを大文字小文字を区別せずに行うかどうか、デフォルトはtrue
}

SSH設定

{
  "ssh": {
    "enabled": true,          // SSH機能を有効にするかどうか、デフォルトはtrue
    "maxConcurrentSessions": 5,// 許可される最大の同時SSHセッション数、デフォルトは5
    "defaultTimeout": 30000   // デフォルトのコマンドタイムアウト時間（ミリ秒）、デフォルトは30秒
  }
}

リソース

SSH接続

• URI形式: ssh://{connectionId}
• 説明: 各SSH接続は1つのリソースに対応し、接続設定情報を表示し、機密情報を自動的に隠します。
• 例: ssh://raspberry - pi は、"raspberry - pi"という名前の接続設定を表示します。

SSHグローバル設定

• URI: ssh://config
• 説明: すべてのSSHサーバーの設定パラメータを表示し、デフォルトのタイムアウト、最大同時接続数などを含み、パスワード情報を自動的に隠します。

現在のディレクトリ

• URI: cli://currentdir
• 説明: 現在のコマンドラインインターフェイスサーバーの作業ディレクトリを表示し、デフォルトはサービス起動時のディレクトリです。

CLIグローバル設定

• URI: cli://config
• 説明: CLIサーバーのすべての設定情報を表示し、セキュリティ設定、shellパラメータ、SSH設定などを含みます。

🔧 技術詳細

組み込みのセキュリティ機能（無効化不可）

1. コマンドブロックの大文字小文字非依存: すべてのコマンドブロックは大文字小文字を区別せずに行われます。たとえば、"DEL.EXE"や"del.cmd"は、"del"がblockedCommandsに含まれている場合、ブロックされます。
2. スマートパス解析: サーバーは完全なコマンドパスを解析し、詐欺攻撃を防止します。たとえば、"%SystemRoot%\system32\cmd.exe"は、cmd.exeとして正しく認識されます。
3. 自動機密情報隠蔽: 設定やログを表示する際、パスワードやキーなどの機密情報は自動的にプレースホルダーに置き換えられます。
4. セッション期限切れメカニズム: アイドル状態のSSHセッションやコマンド履歴にはタイムアウト制限があり、不正アクセスを防止します。

オプションのセキュリティ機能

1. 双方向認証: クライアント証明書検証またはotpワンタイムパスワードログイン方式をサポートし、SSH接続のセキュリティを向上させます。
2. ログ記録と監査: すべてのユーザー操作は詳細に記録され、コマンド内容、実行時間などの情報が含まれ、後の監査分析に便利です。

重要なセキュリティ警告

• デフォルト設定のリスク: デフォルトのポート3000とデフォルトのパスを使用すると、不正アクセスのリスクが高まる可能性があります。実際のニーズに応じて関連設定を変更してください。
• SSHの弱いパスワードポリシー: デフォルトでは、弱いパスワードプロトコル（DSAなど）の使用が禁止されています。本番環境では、RSAまたはECDSA暗号化を強制的に有効にすることをお勧めします。
• 定期的な更新チェック: ゼロ日脆弱性のリスクがあるため、CLIサーバーを定期的に最新バージョンに更新することをお勧めします。

📄 ライセンス

このプロジェクトはMITライセンスに従い、ユーザーはコードを自由に使用、修正、配布することができますが、著作権表示を保持する必要があります。詳細なライセンス内容はMIT Licenseを参照してください。