Skip to content

guard-core-jvm

Kotlin/JVM port of the guard-core engine: the framework-free detection engine, the facade artifact that adapters integrate, and the conformance harness that proves behavior parity against the guard-core spec 4.1.0 corpus.

The family

Repo Artifact Role
guard-core-jvm com.guard-core:guard-core-engine, com.guard-core:guard-core Engine + facade + conformance + benchmarks (this repo)
spring-boot-guard com.guard-core:spring-boot-guard Spring Boot 3.x adapter (servlet filter, @Guard* annotations)
ktor-guard com.guard-core:ktor-guard Ktor 3.x adapter (suspend-native server plugin)
guard-agent-jvm com.guard-core:guard-agent-jvm Telemetry agent behind the facade's sink seam

Documentation map

  • Installation - supported runtimes, coordinates, Redis requirement
  • Configuration - all 129 SecurityConfig fields with type, default, and effect
  • API - public surface and the Dokka reference
  • Architecture - module layout and how it maps to the spec sections
  • Detection - coverage taxonomy (verbatim category names) and the bounded-read detection limits
  • Adapters - how the adapters consume the facade
  • Migration - versioning and mixed-version interop constraints
  • Release notes - the CHANGELOG

The KDoc API reference generates with Dokka (see API).