🤖

functions:secrets:setが追加され、Functionsのconfigを使った環境変数が非推奨になった話

2022/04/11に公開約3,400字

Firebaseのセキュリティチェックリストを見ていると、

CloudFunctionの環境変数に機密情報を入れないでください
多くの場合、自己ホスト型のNode.jsアプリでは、環境変数を使用して秘密鍵などの機密情報を含めます。 CloudFunctionsではこれを行わないでください。 Cloud Functionsは関数の呼び出し間で環境を再利用するため、機密情報を環境に保存しないでください。

とありました。(2022/04/11)
以前は、ランタイム環境構成でfunctions:config:set で秘匿情報を登録し、 functions.config().some.keyで取り出すという方法が一般的だったのですが、環境変数に関しては、`.env'で管理し、秘匿情報はシークレットを使うことが推奨となりました。「呼び出し間で環境を再利用」とあるので、コンテナを共有あるいは使い回しをし、他のプロジェクトで使われていた古い設定が残るようです。以前からこの問題があり、セキュリティ上の理由で推奨をためたのか、それともコンテナの効率化で変更になったのか理由はわかりませんが、新しい方法が用意されたようです。

Firebaseのドキュメントの環境を構成するを見てみると、npmの firebase-functions v3.18.0と、CLIのfirebase-tools v 10.2.0の組み合わせで、秘匿情報は functions:secrets:setを使って管理するようになったようです。その他にも、このバージョンから.envを使った環境変数の設定をサポートをするようになったようです。秘匿ではない情報はこちらで管理すると楽ですね。まずは、これらのパッケージをupdateしましょう。

functions:secrets:setでの登録の方法はconfigとほぼ同じで

firebase functions:secrets:set SECRET_NAME

で、秘匿情報をセットし、

exports.processPayment = functions
  // Make the secret available to this function
  .runWith({ secrets: ["SECRET_NAME"] })
  .onCall((data, context) => {
    const myBillingService = initializeBillingService(
      // reference the secret value
      process.env.SECRET_NAME
    );
    // Process the payment
  });

と、runWithに、必要な秘匿情報の名前を渡すと process.env.SECRET_NAME のように環境変数としてアクセスできるようです。

基本的には、firebase functions:config:set と似たような方法で使うことができます。

firebase-functionsのChangeLogをみると、

Add new runtime option for setting secrets.

とありますね。

Functions secretsは、実際にはGoogle Cloud Secret Managerで情報を管理しているので、若干のコストがかかります。 6 個のシークレット、1シークレットあたり毎月 10,000 回のアクセス オペレーションまでは無料で、それ以外が、アクセス オペレーション 10,000 回あたり $0.03かかります。
詳しくはSecret Manager の料金を参照してください。

実際に登録を試してみると、

$ firebase functions:secrets:set TEST

Error: HTTP Error: 403, Secret Manager API has not been used in project xxxxxxxxxx before or it is disabled. Enable it by visiting https://console.developers.google.com/apis/api/secretmanager.googleapis.com/overview?project=xxxxxxxxxx then retry. If you enabled this API recently, wait a few minutes for the action to propagate to our systems and retry.

と、まずはSecret Manager APIを有効にする必要があります。

エラーメッセージにあるurlを開き、enable APIで有効にします。有効にした後、再度登録を試してみます。

$ firebase functions:secrets:set TEST
? Enter a value for TEST [hidden]
✔  Created a new secret version projects/998434940151/secrets/TEST/versions/1

登録できました。

他、使い方は

$ firebase functions:secrets:access TEST
xxx

先程登録した値。setではhiddenでしたがここでは生データが確認できます

$ firebase functions:secrets:get TEST
┌─────────┬─────────┐
│ Version │ State   │
├─────────┼─────────┤
│ 1       │ ENABLED │
└─────────┴─────────┘

バージョン管理

$ firebase functions:secrets:prune TEST

Destroys unused secrets

$ firebase functions:secrets:destroy TEST

Destroy a secret. Defaults to destroying the latest version.

$ firebase functions:secrets:destroy TEST
? Are you sure you want to destroy TEST@1 Yes
i  Destroyed secret version TEST@1
i  No active secret versions left. Destroying secret TEST

削除

firebase functions:secrets:get TEST
Error: HTTP Error: 404, Secret [projects/998434940151/secrets/TEST] not found.

削除したのでない。

functions:configで管理していた情報は、やはめにfunctions:secrets:setに移行したほうが良さそうです
使わなくなった config内の変数はfirebase functions:config:unset paramnameで削除する必要があるのでお忘れなく。

Discussion

ログインするとコメントできます