APIキーやパスワードの情報漏洩を防ぐsecretlintの使い方

secretlintとは

secretlintはソースコードや設定ファイル内に含まれるAPIキー・アクセストークン・秘密鍵・パスワードなどの機密情報を検出する静的解析ツールです。

主な検知対象には以下のとおりです。

  • クラウド・インフラ系:AWS(Secret Access Keyなど)、GCP、Cloudflareなどの認証情報
  • 開発・外部サービス系:GitHub、npm、OpenAI、Slack Webhook URLなどのトークン・APIキー
  • 鍵・パスワード系:SSH秘密鍵、Basic認証の資格情報、.envファイル

secretlintは問題が見つかるとエラー終了を返すため、ローカルのGitフックやCI(GitHub Actionsなど)と組み合わせることで、機密情報を含んだコードのコミットやマージを自動でブロックできます。

secretlintはコマンド1つで実行可能

プロジェクトのルートディレクトリで以下のコマンドを実行すると、インストールなしでカレントディレクトリ配下のファイルをスキャンできます。

npx secretlint "**/*"

試しに以下のコードでGITHUB_TOKENとSLACK_WEBHOOKが記述されたサンプルファイルを作成したあと、上記のコマンドを実行すると検知されます。

mkdir secretlint-sample
cd secretlint-sample
cat << 'EOF' > sample.env
GITHUB_TOKEN=ghp_0123456789abcdefghijklmnopqrstuvwxyz
SLACK_WEBHOOK=https://hooks.slack.com/services/T00000000/B00000000/SAMPLE
EOF
$ npx secretlint "**/*"

/secretlint-sample/sample.env
  1:13  error  [GITHUB_TOKEN] found GitHub Token(*****************************): ****************************************   @secretlint/secretlint-rule-preset-recommend > @secretlint/secretlint-rule-github
  2:14  error  [IncomingWebhook] found Slack Incoming Webhook: ***********************************************************  @secretlint/secretlint-rule-preset-recommend > @secretlint/secretlint-rule-slack

✖ 2 problems (2 errors, 0 warnings, 0 infos)

プロジェクトへのインストールと基本設定

継続的にチェックを行う場合は、プロジェクトにインストールして設定ファイルを用意します。

npm i -D secretlint

設定ファイルはプロジェクトのルートディレクトリにnpx secretlint --initコマンドで .secretlintrc.json を作成します。

npx secretlint --initコマンドだけだと推奨ルールしか追加されないので、以下のようにほかのルールも必要に応じて追加したほうが良いです。

.secretlintrc.json
{
  "rules": [
    {
      "id": "@secretlint/secretlint-rule-preset-recommend"
    },
    {
      "id": "@secretlint/secretlint-rule-no-dotenv"
    },
    {
      "id": "@secretlint/secretlint-rule-no-homedir"
    },
    {
      "id": "@secretlint/secretlint-rule-pattern",
      "options": {
        "patterns": [
          {
            "name": "IWB_TOKEN (独自トークン)",
            "pattern": "/IWB_TOKEN=/"
          }
        ]
      }
    }
  ]
}

毎回長いコマンドを打たなくて済むよう、package.jsonのscriptsに登録しておくと便利です。

{
  "scripts": {
    "lint:secret": "secretlint \"**/*\""
  }
}

ローカル環境でのみ使用する場合は、手動で実行するのではなく、pre-pushなどにコマンドを記述して自動実行にしてください。

.git/hooks/pre-push
npm run lint:secretlint

特定のファイルを無視する.secretlintignoreを追加する

「"**/*"」だとすべてのファイルを調べて時間がかかってしまいます。

.secretlintignoreファイルを追加して、node_modules, .git, package-lock.jsonなどの調べる必要がないディレクトリおよびファイルを無視する設定をしてください。

.secretlintignore
node_modules/
.git/
package-lock.json

GitHub Actionsを追加する

GitHubを使用している場合はGitHub Actionsでsecretlintを実行する処理も追加します。

.github/workflows/secretlint.yml
name: secretlint

on:
  push:
  pull_request:

permissions:
  contents: read

jobs:
  secretlint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 26
          cache: npm
      - run: npm ci
      - run: npm run lint:secretlint

こちらを追加していれば正しいフローで作業している限り、secretlintを実行せずに本番に反映してしまうミスを防げます。