For AI agents: a documentation index is available at /llms.txt. Markdown versions of pages are available by appending .md to any documentation URL.
Skip to main content

Security module

Use SecurityModuleService to register a named security module.

The service exposes:

  • register(name, securityModuleSupplier) to register a security module supplier.
  • getByName(name) to retrieve a registered security module supplier.

Security module plugins are useful when node key operations must be delegated to a custom implementation, such as an HSM-backed implementation.

For example, register a custom security module supplier:

@Override
public void register(final ServiceManager context) {
  this.serviceManager = context;
  serviceManager
      .getService(SecurityModuleService.class)
      .ifPresent(
          securityModules -> securityModules.register("example-hsm", () -> securityModule));
}

The plugin supplies the SecurityModule implementation.