agentleFS
Sign inStart free
opendatahub-ioopendatahub-io/docs-skills/skills/docs-review-security/SKILL.md

docs-review-security

Skill4 starsChanged 4 months agoApache-2.0View on GitHub

Scan documentation for sensitive data before publication — real IP addresses, credentials, internal hostnames, email addresses, and MAC addresses. Use this skill when asked to check for PII, security issues, customer-sensitive data, or before publishing documentation. Runs a deterministic regex scanner first, then applies agent judgment for patterns regex cannot catch.

The file

We split this skill into the rules it gives an agent

2 rules. About 0 are common, 2 are distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Run the PII scanner against the target files:

    line 25
  2. Distinctive:

    After the scanner runs, review the content for patterns that regex cannot reliably detect:

    line 42

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Security and PII review skill

Scan documentation for sensitive data that must not appear in published content: real IP addresses, credentials, internal hostnames, customer-identifying information, and other PII.

This skill has two layers:

  1. Deterministic scan — run pii_scanner.py for regex-based detection
  2. Agent analysis — review for patterns regex cannot catch

Layer 1: Run the scanner

Run the PII scanner against the target files:

python3 ${CLAUDE_SKILL_DIR}/scripts/pii_scanner.py scan <file1> <file2> ...

Or for a docs directory:

python3 ${CLAUDE_SKILL_DIR}/scripts/pii_scanner.py scan --docs-dir <path> [--scan-dirs modules,topics] [--file-types .adoc,.md,.dita]

Parse the JSON output. If findings exist, include them in the report grouped by severity (critical first, then warning).

Layer 2: Agent analysis checklist

After the scanner runs, review the content for patterns that regex cannot reliably detect:

Customer-sensitive data in YAML/JSON examples

  • CR metadata.name fields use generic names (example-<kind>) not customer-specific names
  • CR metadata.namespace fields use generic namespaces, not customer project names
  • resourceName, hostname, and similar fields do not contain real customer identifiers
  • No customer application names appear — use "the custom application" or a generic name

Internal references

  • No internal Jira project keys or ticket numbers that expose internal tooling
  • No internal wiki, Confluence, or Google Doc URLs
  • No internal Slack channel names or references
  • No references to internal build systems, CI/CD pipelines, or staging environments

Sensitive patterns in prose

  • No real person names associated with accounts, cases, or examples
  • No real organization or company names in examples (use "Example Corp" or similar)
  • No internal Red Hat team names or org chart references in customer-facing content
  • No case numbers, account numbers, or subscription IDs from real customers

LUN WWIDs (if applicable)

  • World Wide IDs use the generic pattern: 3600000000000000000aaaaaaaaaaaaaa
  • If differentiation is needed, vary the end characters: ...bbbbbbbbbbbbbb

How to report

For each finding, report:

  • File and line number
  • Category (ip, email, credential, url, mac, internal_hostname, or agent-detected)
  • Severity: critical (credentials, private keys) or warning (IPs, emails, URLs)
  • Suggestion: the safe replacement (RFC 5737 IP, @example.com email, etc.)

Example invocations

  • "Scan this file for PII and sensitive data"
  • "Run a security review on the installation guide"
  • "Check these docs for credentials and internal hostnames before we publish"

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free