GCPのSecret Managerに保管されている値をFlutterアプリから取得するにはどうしたらいいのでしょうか。

Question

実現したいこと

GCPのSecret Managerに保管されている値をFlutterアプリから取得したいです。

詳細

こちらを見ながら、公式ドキュメントSecret Managerに値を登録し、コマンドを叩くと値を取得することはできます。

//値を設定
firebase functions:secrets:set {SECRET_NAME}
//値を取得
firebase functions:secrets:access {SECRET_NAME}

次に、Flutterアプリからcloud functionsを実行し、先ほどSecret Managerに登録した値を取得したいのですが、エラーが出てしまい取得できません。色々試したのですがわからなかったのためこちらで質問させていただきます。

以下のコードは「SECRET_NAME」という名前でSecret Managerに登録されたものを、Flutterアプリ側で取得できるよう「test1」から「test4」までサンプルの関数をデプロイし、それを呼び出したものです。

試したFunction（とりあえず色々試しました）

exports.test1 = functions.https.onCall(
  { secrets: ["SECRET_NAME"] },
  (req, res) => {
   return [process.env.SECRET_NAME]
  }
);

exports.test2 = functions.https.onCall(
  { secrets: ["SECRET_NAME"] },
  (req, res) => {
    res.send(process.env.SECRET_NAME)
  }
);

exports.test3 = functions.https.onCall(
  { secrets: ["SECRET_NAME"] },
  () => {
    return [process.env.SECRET_NAME]
  }
);
  exports.test4 = functions.https.onCall((req, res) => {
    return [process.env.SECRET_NAME]
  });

Flutter側

void test1() async {
  try {
    var callable = FirebaseFunctions.instanceFor(region: 'us-central1')
        .httpsCallable("test1");
    var result = await callable();
    print(result.data);
  } on FirebaseFunctionsException catch (error) {
    print(error.code);
    print(error.details);
    print(error.message);
    print(error.stackTrace);
  }
}

void test2() async {
  try {
    var callable = FirebaseFunctions.instance.httpsCallable("test2");
    var result = await callable();
    print(result.data);
  } on FirebaseFunctionsException catch (error) {
    print(error.code);
    print(error.details);
    print(error.message);
    print(error.stackTrace);
  }
}

void test3() async {
  try {
    var callable = FirebaseFunctions.instance.httpsCallable("test3");
    var result = await callable();
    print(result.data);
  } on FirebaseFunctionsException catch (error) {
    print(error.code);
    print(error.details);
    print(error.message);
    print(error.stackTrace);
  }
}

void test4() async {
  try {
    var callable = FirebaseFunctions.instance.httpsCallable("test4");
    var result = await callable();
    print(result.data);
  } on FirebaseFunctionsException catch (error) {
    print(error.code);
    print(error.details);
    print(error.message);
    print(error.stackTrace);
  }
}

発生している問題・エラーメッセージ

INTERNAL

（「test4」のみエラーは出ていないのですが、中身がnullです）

試したこと

Flutter側のfunctions呼び出し側をfunction名からトリガーURIにしたりしてみましたが、変わらずエラーでした。

    var callable = FirebaseFunctions.instanceFor(region: 'us-central1')
        .httpsCallableFromUri("uri"); // cloud functionsにデプロイした関数のトリガーURI

リージョンを指定したり、Secret Managerに設定した値の権限を色々いじったり、しましたが変わらなかったです。

補足情報（FW/ツールのバージョンなど）

[✓] Flutter (Channel stable, 3.10.2, on macOS 13.3.1 locale ja-JP)
[✓] Android toolchain - develop for Android devices (Android SDK version 33.0.0)
[✓] Xcode - develop for iOS and macOS (Xcode 14.3)
[✓] Android Studio (version 2021.3)

Comments

[68user]

シークレット SECRET_NAME を登録した「後」に、function をデプロイしていますか?

わたしは https.onCall を使った経験がないので js が正しいか判断できないのですが、
return [process.env.SECRET_NAME]
を
return ["TEST"]
などとしてもエラーになりますか。なるなら、原因はシークレットとは関係ないように見えます。

[taaa00]

コメントありがとうございます。
return ["TEST"]
などのシークレットとは関係ない値は問題なくFlutterアプリ側で取得できます。

[taaa00]

ちなみに、「わたしは https.onCall を使った経験がないので」ということは、onCall以外でもcloud functionsを呼び出せるのでしょうか？

[68user]

なるほど、では secret の読み取りが問題なわけですね。

わたしは Cloud Function + secret 連携をしたことはありますが、Firebase function + secret はやったことがないので違いがわかりません。下記を参考にしてみてはどうでしょうか。
https://zenn.dev/nbstsh/scraps/a2135438f0a89c

[68user]

ちなみに Cloud Functions からやる場合はこんな感じです。"INTERNAL" だと原因の調べようがないので、console からテスト実行して、エラーログにてエラー詳細を確認するような流れがよいと思います
https://dev.classmethod.jp/articles/cloud-functions-access-secret-manager-as-file-or-envvar/

[taaa00]

何度もコメントありがとうございます。助かります。
教えていたさいたサイトでの、
```
export const mySecret = functions
.region('asia-northeast1')
.runWith({
secrets: ['MY_SECRET'],
})
.https.onRequest((request, res) => {
res.send({ MY_SECRET: process.env.MY_SECRET });
});
```
を真似みたのですが、「Response is missing data field.」というエラーが出てしまいます。もうちょっと勉強してみます。
ちなみにgcpの方のログにはなんのエラーも出てはいないです。

[68user]

例によって
res.send({ MY_SECRET: "test" });
だとうまくいくんですよね。

[taaa00]

すみません、色々コメントで相談にのっていただいて申し訳ないのですが、自力で解決してしまいました。。申し訳ありません。

Answer 1

cloud functions側

exports.test = functions
.runWith({
  secrets: ['SECRET_NAME'],
}).
https.onCall((request, res) => {
 return {SECRET_VALUE:process.env.SECRET_NAME};
});

Flutter 側

void test() async {
  try {
    var callable = FirebaseFunctions.instance.httpsCallable("test");
    var result = await callable();
    print(result.data);
  } on FirebaseFunctionsException catch (error) {
  }
}