20240725

さようなら dotenv, こんにちは Encrypted credentials

The Complete Guide to Ruby on Rails Encrypted Credentials を読んで認証情報の保存場所を .env から config/credentials/development.yml.enc に切り替えた。 Rails における認証情報の取り扱いの新標準だと思う。

この変更により rails アプリから認証情報を参照する方法も変わることになる。

同時にマスターキーも config/credentials/development.key になる。これにより既存の config/credentials.yml.enc と config/master.key は不要になるので削除してしまってよい。環境ごとの認証情報と鍵は以下のコマンドで生成できる。

➜ EDITOR="vi" rails credentials:edit --environment=development

これで dotenv とさよならできるかと思ったが、AWS SDK にホームディレクトリ配下 .aws/{config,credentials} の認証情報を読みにいかせないための AWS_SDK_CONFIG_OPT_OUT だけは必要になる。これだけなら認証情報でもなんでもない。いままでは .gitignore でコミットしないとはいえ .env に平文で書かれていた認証情報が気になったが今後はそういうこともなくなるので精神衛生上もよい。

➜ cat .env
AWS_SDK_CONFIG_OPT_OUT=true

新旧を比較すると以下のようになる。development.yml.enc と development.key は環境ごとに staging や production と読み替えることが可能。

	いままで	これから
提供元	rubygem: dotenv	rails 標準機能
認証情報の格納ファイル	.env	config/credentials/development.yml.enc
復号に使用する鍵	config/master.key	config/credentials/development.key
rails アプリから認証情報を参照する方法	ENV[‘AWS_ACCESS_KEY’]	Rails.application.credentials.dig(:aws, :access_key_id)
レポジトリへコミットするファイル	なし	config/credentials/development.yml.enc
レポジトリへコミットせずチームで共有するファイル(パスワード管理ツールなど)	config/master.key	config/development.key

2024-07-25 21:09:01 +0900 +0900

anime ³

api ¹

aws ³

cloudflrare ¹

cognito ¹

development ¹

development process ¹

development standard ¹

game ¹

howto ²

hugo ¹

idea ²

impressed ¹

leaning toothpick syndrome ¹

life ⁶

log ²

maxim ²

mdx ¹

postgresql ²

rails ⁷

rubocop ¹

ruby ¹

rust ¹

solution ²

stripe ¹

tech ¹⁷

ui ¹

warp ¹

anthropogenic.pages.dev

20240725

さようなら dotenv, こんにちは Encrypted credentials

screenshot of diff