realworld

Documentation

Overview

Package realworld validates Keyway against documented, real-world JWT/JWKS incidents (CVEs, GitHub issues, postmortems). Each case reproduces the exact vulnerable behavior from a cited source and asserts that Keyway flags it — so the suite answers "would Keyway have caught this real risk?" rather than only testing synthetic scenarios.

Index

• func MarkdownReport() (md string, detected, total int)
• type Case
  • func Cases() []Case
• type Result

Functions

func MarkdownReport

func MarkdownReport() (md string, detected, total int)

MarkdownReport runs every case and renders a cited, GitHub-friendly report of whether Keyway detects each documented real-world risk.

Types

type Case

type Case struct {
	ID        string // e.g. "RW-01"
	Title     string
	Category  string
	Reference string // CVE id or "org/repo#issue"
	Source    string // canonical URL
	Mechanism string // which Keyway capability catches it
	Severity  string
	Run       func() Result
}

Case is a documented, cited real-world JWT/JWKS risk plus a reproduction that checks whether Keyway detects it.

func Cases

func Cases() []Case

Cases returns the validation suite. Each Run reproduces the exact failure mode from its cited source and asks Keyway to flag it.

type Result

type Result struct {
	Detected bool
	Verdict  string // human-readable statement of what Keyway concluded
}

Result is the outcome of validating one real-world case against Keyway.