git-secrets の履歴(No.2)

• 履歴一覧
• 差分 を表示
• 現在との差分 を表示
• ソース を表示
• git-secrets へ行く。
  • 1 (2021-05-21 (金) 13:52:54)
  • 2 (2021-05-21 (金) 13:55:28)
  • 3 (2021-06-22 (火) 15:49:44)

Tag: git-secrets

目次†

関連ページ†

参考情報†

• awslabs/git-secrets: Prevents you from committing secrets and credentials into git repositories…公式サイト。

インストール†

• Homebrewの場合

  brew install git-secrets

• MacPortsは存在しない。しかし単なるシェルスクリプトなので以下で良い

  make install

初期設定†

• 特定のgitリポジトリでだけ使用する場合。

  cd /path/to/my/repo
  git secrets --install
  git secrets --register-aws
  

• これによって.git/configの「secrets」のなかに設定が保存される。

Tips†

「--register-aws」の意味†

• aws向けの設定をconfigに追加するとともに、~/.aws/credentialsに含まれるキーがソースコードに含まれないことを保証するためのオールインワンオプション。
• 以下のような情報が追加される。

  [secrets]
      providers = git secrets --aws-provider
      patterns = (A3T[A-Z0-9]|AKIA|AGPA|AIDA|AROA|AIPA|ANPA|ANVA|ASIA)[A-Z0-9]{16}
      patterns = (\"|')?(AWS|aws|Aws)?_?(SECRET|secret|Secret)?_?(ACCESS|access|Access)?_?(KEY|key|Key)(\"|')\
  ?\\s*(:|=>|=)\\s*(\"|')?[A-Za-z0-9/\\+=]{40}(\"|')?
      patterns = (\"|')?(AWS|aws|Aws)?_?(ACCOUNT|account|Account)_?(ID|id|Id)?(\"|')?\\s*(:|=>|=)\\s*(\"|')?[\
  0-9]{4}\\-?[0-9]{4}\\-?[0-9]{4}(\"|')?
      allowed = AKIAIOSFODNN7EXAMPLE
      allowed = wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
  

• この並びに意味はない？最初の「providers = git secrets --aws-provider」が~/.aws/credentialsのチェックに使われ、のこりは一般的なチェックパターン(と許可パターン)ということだと思われる。

「--add-provider」ってどういうオプション？†

• git-secrets 導入 — シガナイエンジニアの雑記が参考になる。

  git secrets --add-provider -- cat SECRET_WORDS.txt

• するとconfigに以下の設定が追加される。

      providers = cat SECRET_WORDS.txt
  

• providersで指定されたコマンドがチェックで実行されるというような意味だと思われる。