@secretlint/secretlint-rule-tailscale

Tailscale rule for secretlint.

Detects Tailscale keys with the documented tskey- prefix:

• tskey-api- — API access tokens
• tskey-auth- — Pre-authentication keys
• tskey-client- — OAuth client keys
• tskey-scim- — SCIM keys
• tskey-webhook- — Webhook keys

Reference: https://tailscale.com/docs/reference/key-prefixes

Install

Install with npm:

npm install @secretlint/secretlint-rule-tailscale

Usage

Add the rule to your .secretlintrc.json:

{
    "rules": [
        {
            "id": "@secretlint/secretlint-rule-tailscale"
        }
    ]
}

MessageIDs

TAILSCALE_API_KEY

found Tailscale API access token: ${props.KEY}

TAILSCALE_AUTH_KEY

found Tailscale pre-authentication key: ${props.KEY}

TAILSCALE_CLIENT_KEY

found Tailscale OAuth client key: ${props.KEY}

TAILSCALE_SCIM_KEY

found Tailscale SCIM key: ${props.KEY}

TAILSCALE_WEBHOOK_KEY

found Tailscale webhook key: ${props.KEY}

TAILSCALE_KEY

found Tailscale key: ${props.KEY}

Fallback message used when the key type does not match a known prefix.

A leaked Tailscale key can grant access to manage devices, ACLs, and network configuration.

Options

• allows: string[]
  • Allows a list of RegExp-like String

Changelog

See Releases page.

Running tests

pnpm test

Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, please create an issue.

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D

License

MIT © azu