日本
The Morning Dev

知っておくべきことだけを、毎朝

‹
 

研究

pydantic の SecretStr でも、検証に失敗すると API キーが ValidationError に出る:hide_input_in_errors は print だけ隠し e.json() には残った(pydantic 2.14で確認)

Qiita · 執筆:supportapp3 ·

要点

  • pydantic 2.14でSecretStrを使っても、検証失敗時のValidationErrorにAPIキーの値が含まれることが確認された。
  • hide_input_in_errorsを有効にするとprint時の表示は隠れるが、e.json()の出力には値が残った。
  • 検証はダミーのキーを使って手元で行われたものである。

なぜ重要か

SecretStrで隠したつもりのAPIキーが、エラーの内容をログや外部サービスに送る処理を通じて漏えいする可能性がある。pydantic-settingsでキーを読み込む開発者は、ValidationErrorの出力経路を確認する必要がある。

影響を受ける人

  • pydantic 2系でAPIキーをSecretStrとして読み込む開発者
  • pydantic-settingsで設定値を管理するPythonプロジェクト

取るべき対応

  1. ValidationErrorをe.json()などで出力し、ログや外部送信に残していないか確認する
  2. hide_input_in_errorsの設定が出力経路に対して十分か見直す

pydantic-settings で API キーを読むとき、SecretStr にしておけば print(settings) で ********** になります。では、キーが検証に失敗したときの ValidationError はどうなるのか。ダミーのキーで手元で確か...

この記事をどう思いますか?

コメント0件

    pydantic の SecretStr でも、検証に失敗すると API キーが ValidationError に出る:hide_input_in_errors は print だけ隠し e.json() には残った(pydantic 2.14で確認) – The Morning Dev