ShieldGate Docs

Advanced

Building plugins

Extend ShieldGate with ShieldGate.PluginSdk contracts.

Goal

Build a custom plugin assembly the PluginHost can load.

Prerequisites

  • .NET 10 class library referencing ShieldGate.PluginSdk only (not Domain/Persistence).
  • Familiarity with Plugins.

Contracts (examples)

  • IShieldGatePlugin
  • IThreatIntelligencePlugin
  • INotificationPlugin
  • IWafRulePlugin / inspector plugins
  • IAuthenticationPlugin / IAuthorizationPlugin
  • Logging / metrics plugins

Steps

  1. Create a class library and implement the relevant interfaces.
  2. Put settings keys in Plugins:Settings as needed.
  3. Copy the DLL into Plugins:Directory for Api/Worker (and Proxy if the plugin type runs there).
  4. Restart hosts to load.
  5. Configure the feature UI to use your plugin id.

Verify

  • Listed under Ops → Plugins.
  • End-to-end behavior matches the sample plugins in src/plugins/.
  • Sample projects under src/plugins/.