RdpGuard プラグイン API

標準で対応していないログの失敗検出には、プラグイン API を利用できます。プラグインがログのエントリを解析し、RdpGuard がファイルの監視、失敗のカウント、設定に応じた IP のブロックを行います。

.NET Framework クラスライブラリを作成し、RdpGuard フォルダーの rdpguard-plugin-api.dll への参照を追加します。API とサンプルの対象は .NET Framework 4.5 です。

引数なしのコンストラクターを持つ public クラスで IExternalLogBasedEngine を実装します。次の例ではコンストラクターを宣言していないため、自動的に生成されます。

プラグインを RdpGuard の Plugins サブフォルダー (例: C:\Program Files\RdpGuard\Plugins) に配置します。

プラグインのインターフェース:

namespace rdpguard_plugin_api {

    public interface IExternalEngine {

        string Name { get; }
        string Protocol { get; }
    }

    public interface IExternalLogBasedEngine : IExternalEngine {

        string Directory { get; }
        string FileMask { get; }

        bool IsFailedLoginAttempt(string _line, out string _ip, out string _username);
    }
}

失敗の場合は true を返し、有効な IP を _ip に設定します。ログにユーザー名がない場合、_username には null を設定します。それ以外のエントリには false を返します。

実装例:

using rdpguard_plugin_api;

namespace rdpguard_test_plugin {

    public class MyEngine : IExternalLogBasedEngine {

        public string Name => "TestEngine";
        public string Protocol => "MyProto";

        public string Directory => @"C:\MyApp\Logs\";
        public string FileMask => "*.log";

        public bool IsFailedLoginAttempt(string _line, out string _ip, out string _username) {

            _ip = _username = null;

            // sample log line:
            // 2020-06-22 10:29:18 AUTH-ERROR admin 66.249.65.238 Invalid+username+or+password

            var parts = _line.Split(' ');

            if (parts.Length > 5 && "AUTH-ERROR" == parts[2]) {
                _username = parts[3];
                _ip = parts[4];
                return true;
            }

            return false;
        }
    }
}

プラグインをビルドし、DLL を C:\Program Files\RdpGuard\Plugins (またはインストール先の Plugins サブフォルダー) にコピーします。必要に応じてフォルダーを作成し、ツール, RdpGuard サービス, 再起動からサービスを再起動します。

再起動前に、ツール, オプション, ログでレベルを詳細に設定し、保存をクリックします。次のメッセージを確認してください。

ExternalLogBasedEngine::TestEngine started (C:\MyApp\Logs\)

このメッセージはプラグインの起動を示します。検出を試すには、アプリで新しい失敗を発生させ、RdpGuard に記録されることを確認します。

プラグインについてサポートが必要な場合は、お問い合わせください。