Skip to content

    Type a page, a command such as keryn scan, or a rule id.

    Output formats

    Describes Keryn 0.5.2 and keryn-rules 0.8.0. Changelog

    View as Markdown

    The samples on this page are a real scan of a three-file example repository, generated by the current release: bom.cdx.json, result.sarif, result.json, summary.md.

    Flag Format Notes
    --aibom CycloneDX 1.6 AI components with file/line evidence, coverage and caveat properties (keryn:*)
    --sarif SARIF 2.1.0 one run: every rule with its help text, paths relative to SRCROOT, an automationDetails id so GitHub groups runs, a partialFingerprints entry per result, the proof level in properties
    --json Keryn result (keryn.dev/result/v1) everything: findings, components, policy decisions, coverage, versions
    --markdown Markdown a pull or merge request summary
    --junit JUnit XML policy rules as test cases
    --gitlab-sast GitLab SAST report Security tab and merge request widget
    --codequality Code Climate JSON GitLab Code Quality widget
    --annotations log commands github, azure, gitlab, teamcity

    Workflow findings carry a logical location for each node involved, and binary findings list the files they cite with their SHA-256. The Keryn Web also exports a Problems file for VS Code: path:line:col lines with a problemMatcher on top.

    - as the file name writes to standard output. One run can write any number of outputs. The same input, version, rules and policy give byte-identical output.

    bom.cdx.json
    {
    "bomFormat": "CycloneDX",
    "specVersion": "1.6",
    "serialNumber": "urn:uuid:ad628851-cdd5-49af-8e9f-05752e709274",
    "version": 1,
    "metadata": {
    "timestamp": "2026-01-01T00:00:00Z",
    "tools": {
    "components": [
    {
    "type": "application",
    "name": "keryn",
    "version": "0.5.2",
    "description": "keryn-engine/0.1.1 (tree-sitter-wasm, semgrep-compatible subset)"
    }
    ]
    },
    "component": {
    "type": "application",
    "name": "example-repo",
    "bom-ref": "keryn:subject",
    "version": "0000000"
    },
    "properties": [
    {
    "name": "keryn:coverage.rules",
    "value": "1598/1598 executed"
    },
    {
    "name": "keryn:coverage.files",
    "value": "3 scanned, 0 skipped"
    },
    {
    "name": "keryn:caveat",
    "value": "Inventory reflects static references only. Absence is not evidence of absence; presence does not prove runtime use."
    },
    {
    "name": "keryn:surface",
    "value": "0 routes, 1 tools"
    },
    {
    "name": "keryn:ci:policySha256",
    "value": "none"
    },
    {
    "name": "keryn:ci:ruleBundleSha256",
    "value": "sha256:ff505642b502caefa5c56c481db622fd900dcc90a40e3e22f7b3ac3fa0fffab8"
    }
    ]
    },
    "components": [
    {
    "type": "library",
    "name": "openai",
    "bom-ref": "keryn:library:openai",
    "publisher": "openai",
    "evidence": {
    "occurrences": [
    {
    "location": "agent.py",
    "line": 1
    },
    {
    "location": "ai_route.ts",
    "line": 2
    }
    ]
    },
    "properties": [
    {
    "name": "keryn:assetProvenance",
    "value": "{\"identity\":\"unknown\",\"version\":\"unknown\",\"artifactDigest\":\"unknown\",\"resolutions\":[],\"reachability\":{\"status\":\"unknown\",\"reason\":\"Static references do not establish runtime reachability or non-reachability.\",\"paths\":[]},\"advisory\":{\"status\":\"unknown\",\"source\":\"unknown\",\"asOf\":\"unknown\"},\"malware\":{\"status\":\"unknown\",\"source\":\"unknown\",\"asOf\":\"unknown\"},\"inspection\":\"unassessed\"}"
    },
    {
    "name": "keryn:category",
    "value": "llm-sdk"
    },
    {
    "name": "keryn:basis",
    "value": "observed-in-source"
    },
    {
    "name": "keryn:scope",
    "value": "direct"
    },
    {
    "name": "keryn:rules",
    "value": "keryn.inv.lib.openai"
    },
    {
    "name": "keryn:provider",
    "value": "openai"
    }
    ]
    },
    {
    "type": "library",
    "name": "vercel-ai-sdk",
    "bom-ref": "keryn:library:vercel-ai-sdk",
    "evidence": {
    "occurrences": [
    {
    "location": "ai_route.ts",
    "line": 1
    }
    ]
    },
    "properties": [
    {
    "name": "keryn:assetProvenance",
    "value": "{\"identity\":\"unknown\",\"version\":\"unknown\",\"artifactDigest\":\"unknown\",\"resolutions\":[],\"reachability\":{\"status\":\"unknown\",\"reason\":\"Static references do not establish runtime reachability or non-reachability.\",\"paths\":[]},\"advisory\":{\"status\":\"unknown\",\"source\":\"unknown\",\"asOf\":\"unknown\"},\"malware\":{\"status\":\"unknown\",\"source\":\"unknown\",\"asOf\":\"unknown\"},\"inspection\":\"unassessed\"}"
    },
    {
    "name": "keryn:category",
    "value": "llm-sdk"
    },
    {
    "name": "keryn:basis",
    "value": "observed-in-source"
    },
    {
    "name": "keryn:scope",
    "value": "direct"
    },
    {
    "name": "keryn:rules",
    "value": "keryn.inv.lib.vercel-ai"
    }
    ]
    }
    ],
    "services": [
    {
    "bom-ref": "keryn:tool:ai_route.ts:toolDef",
    "name": "toolDef",
    "description": "send email",
    "properties": [
    {
    "name": "keryn:assetProvenance",
    "value": "{\"identity\":\"source-definition:ai_route.ts:toolDef\",\"version\":\"unknown\",\"artifactDigest\":\"unknown\",\"resolutions\":[],\"reachability\":{\"status\":\"unknown\",\"reason\":\"Static references do not establish runtime reachability or non-reachability.\",\"paths\":[]},\"advisory\":{\"status\":\"unknown\",\"source\":\"unknown\",\"asOf\":\"unknown\"},\"malware\":{\"status\":\"unknown\",\"source\":\"unknown\",\"asOf\":\"unknown\"},\"inspection\":\"unassessed\"}"
    },
    {
    "name": "keryn:category",
    "value": "agent-tool"
    },
    {
    "name": "keryn:basis",
    "value": "observed-in-source"
    },
    {
    "name": "keryn:scope",
    "value": "direct"
    },
    {
    "name": "keryn:occurrences",
    "value": "ai_route.ts:29"
    },
    {
    "name": "keryn:tool.framework",
    "value": "vercel-ai"
    },
    {
    "name": "keryn:tool.capability",
    "value": "send"
    },
    {
    "name": "keryn:tool.capabilityBasis",
    "value": "authority:send,authority:external,authority:irreversible"
    },
    {
    "name": "keryn:tool.authority",
    "value": "send,external,irreversible"
    }
    ]
    }
    ]
    }
    summary.md
    <!-- keryn-summary:v1 -->
    ## Keryn AI-BOM
    **Keryn — Checks passed &#40;Go&#41;**
    Analysis: complete · Policy: checks passed · Approval: not recorded
    base not recorded → analyzed 0000000
    Cases: 7 current = 0 new + 0 existing + 7 unclassified. Unknown cleared from previous assessment. Newly blocking: unknown.
    ### Cases (7 of 7 shown; limit 20)
    | Case | Effect | Location | Evidence | Contributing rules |
    |---|---|---|---|---|
    | Model Output Streamed or Rendered as Unsanitized HTML (sha256&#58;61dedc32607fae20a29bad35697c505ba7119b6cd124de61de2c63c8f1e01843) | review | ai&#95;route.ts:7 | pattern | 1 |
    | Agent file write path traversal. (sha256&#58;dc9c0f2dd746743cfa27fe54474754ff1b22d4aa5298163cb64f7263345bd190) | review | ai&#95;route.ts:13 | pattern | 1 |
    | Agent file write path traversal. (sha256&#58;91da11f4316f3023693b361fa2e473fe0f36452ab04c08d15e48c32f9022009b) | review | ai&#95;route.ts:15 | pattern | 1 |
    | CWE-79 &#40;insecure-output-handling&#41;&#58; Renders raw HTML in React; if it carries LLM/markdown/user output, sanitize &#40;DOMPurify&#41;. (sha256&#58;fda094fae25a9c9150d9e993ce89bd34d70f35cc6f73a63ca3ace11908e79eac) | review | ui.tsx:6 | path-in-file | 6 |
    | Assignment to innerHTML or outerHTML may render model, retrieved, or tool output as executable HTML. Confirm sanitizer use and source trust. (sha256&#58;f1c13928590c3148d0894548d457817226c49e42510b9efdaf77ddd9f6811a08) | review | ui.tsx:14 | path-in-file | 2 |
    | Markdown rendering appears to allow raw HTML. If model or retrieved content reaches this renderer, this can become XSS. (sha256&#58;ff5a126e19946add5d2f52e4b33ab881325fafb7e7342ad075850a19dfc26092) | review | ui.tsx:16 | pattern | 1 |
    | Assignment to innerHTML or outerHTML may render model, retrieved, or tool output as executable HTML. Confirm sanitizer use and source trust. (sha256&#58;f427b43820db7ba61aeafb03a9295b0d70e406061d9b69e298f05acd664ad793) | review | ui.tsx:18 | path-in-file | 2 |
    0 cases omitted by display limit. 32 recorded rule hits; 25 non-case observations; 0 suppressed rule hits; 0 failed checks.
    Exceptions&#58; 0 expired suppression entries; changes since the base unknown &#40;no base run with its exceptions&#41;
    2 AI component(s) in `example-repo`.
    ### Raw rule details and AI-component constraints
    | Level | Rule | Location | Message |
    |---|---|---|---|
    | error | seceng/unfiltered&#95;llm&#95;stream&#95;to&#95;client | ai&#95;route.ts&#58;7 | Model Output Streamed or Rendered as Unsanitized HTML · proof 1 &#40;pattern&#41; |
    | warning | seceng/agent&#95;file&#95;write&#95;path&#95;traversal | ai&#95;route.ts&#58;13 | Agent file write path traversal. · proof 1 &#40;pattern&#41; |
    | warning | seceng/agent&#95;file&#95;write&#95;path&#95;traversal | ai&#95;route.ts&#58;15 | Agent file write path traversal. · proof 1 &#40;pattern&#41; |
    | error | vulnfix-ai-ai&#95;js&#95;dangerous&#95;html | ui.tsx&#58;6 | CWE-79 &#40;insecure-output-handling&#41;&#58; Renders raw HTML in React; if it carries LLM/markdown/user output, sanitize &#40;DOMPurify&#41;. · proof 2 &#40;path-in-file, confirmed by Deep&#41; |
    | warning | seceng.llm05.inner-html-assignment | ui.tsx&#58;14 | Assignment to innerHTML or outerHTML may render model, retrieved, or tool output as executable HTML. Confirm sanitizer use and source trust. · proof 2 &#40;path-in-file, confirmed by Deep&#41; |
    | warning | seceng.llm05.marked-html-enabled | ui.tsx&#58;16 | Markdown rendering appears to allow raw HTML. If model or retrieved content reaches this renderer, this can become XSS. · proof 1 &#40;pattern, needs review&#58; Deep found no data flow to it&#41; |
    | warning | seceng.llm05.inner-html-assignment | ui.tsx&#58;18 | Assignment to innerHTML or outerHTML may render model, retrieved, or tool output as executable HTML. Confirm sanitizer use and source trust. · proof 2 &#40;path-in-file, confirmed by Deep&#41; |
    **Coverage:** 1598/1598 rules executed &#40;0 unsupported, 0 partial, 0 timed out&#41;; 3 files scanned, 0 skipped; 15 absence findings collapsed into 13 repo-level findings.
    _Inventory reflects static references only. Absence is not evidence of absence; presence does not prove runtime use._