0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

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

0
Posted at

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

確認環境:Python 3.13.5 / pydantic 2.14.3 / pydantic-settings 2.16.3(Linux)。キーは sk-test-FAKE0123456789abcdefFAKE(32文字の偽物)を環境変数 API_KEY に入れています。

結論

出し方 str 型 SecretStr 型 SecretStr + hide_input_in_errors=True
print(settings) / repr / f-string 出る 出ない(SecretStr('**********')) 出ない
検証失敗時の print(e) 出る 出る 出ない
検証失敗時の e.json() / e.errors() 出る 出る 出る
e.json(include_input=False) / e.errors(include_input=False) 出ない 出ない 出ない
logging.exception() のトレースバック 出る 出る 出ない

「出る/出ない」は、出力の文字列にキーが含まれるかで判定しました。

1. str 型だと print だけで出る

import os
from pydantic_settings import BaseSettings

os.environ["API_KEY"] = "sk-test-FAKE0123456789abcdefFAKE"

class S1(BaseSettings):
    api_key: str
    timeout: int = 10

s = S1()
print(s)
print(repr(s))
print(s.model_dump())
api_key='sk-test-FAKE0123456789abcdefFAKE' timeout=10
S1(api_key='sk-test-FAKE0123456789abcdefFAKE', timeout=10)
{'api_key': 'sk-test-FAKE0123456789abcdefFAKE', 'timeout': 10}

起動時に「設定を読み込みました」と logging.info("loaded %s", settings) のように書くと、これがそのままログに入ります。

2. SecretStr にすると print では隠れる

from pydantic import SecretStr

class S2(BaseSettings):
    api_key: SecretStr
    timeout: int = 10

s2 = S2()
print(s2)
print(s2.model_dump())
print(s2.model_dump_json())
api_key=SecretStr('**********') timeout=10
{'api_key': SecretStr('**********'), 'timeout': 10}
{"api_key":"**********","timeout":10}

値が必要なところでは s2.api_key.get_secret_value() で取り出します。ここまでは期待どおりでした。

3. SecretStr でも、検証に失敗するとキーが出る

キーの形が明らかにおかしいときに起動を止めたくて、長さの制約を付けたとします(40文字は説明用の値です)。

from pydantic import Field, SecretStr, ValidationError

class Settings(BaseSettings):
    api_key: SecretStr = Field(min_length=40)

try:
    Settings()
except ValidationError as e:
    print(e)
1 validation error for Settings
api_key
  Value should have at least 40 items after validation, not 32 [type=too_short, input_value='sk-test-FAKE0123456789abcdefFAKE', input_type=str]
    For further information visit https://errors.pydantic.dev/2.14/v/too_short

input_value= に、隠したはずのキーがそのまま入りました。SecretStr になる前の入力(環境変数の文字列)がエラーに残るためだと考えています(推測)。str 型で min_length を付けた場合も、api_key を誤って int 型にした場合も同じく input_value= にキーが出ました。

捕まえずに落ちた場合や、logging.exception() で記録した場合も同じです。

ERROR 設定の読み込みに失敗
Traceback (most recent call last):
  ...
pydantic_core._pydantic_core.ValidationError: 1 validation error for Settings
api_key
  Value should have at least 40 items after validation, not 32 [type=too_short, input_value='sk-test-FAKE0123456789abcdefFAKE', input_type=str]

なお、別のフィールド(例:TIMEOUT=abc)の検証に失敗したときは、そのフィールドの入力('abc')だけが出て、api_key は出ませんでした。

4. hide_input_in_errors=True は print だけ隠す

pydantic の設定 hide_input_in_errors を使うと、エラー表示から入力値が消えます。公式ドキュメントの説明は「Whether to hide inputs when printing errors.」です。

from pydantic_settings import SettingsConfigDict

class Hidden(BaseSettings):
    model_config = SettingsConfigDict(hide_input_in_errors=True)
    api_key: SecretStr = Field(min_length=40)

try:
    Hidden()
except ValidationError as e:
    print(e)
    print(e.json())
    print(e.json(include_input=False))
1 validation error for Hidden
api_key
  Value should have at least 40 items after validation, not 32 [type=too_short]
    For further information visit https://errors.pydantic.dev/2.14/v/too_short
[{"type":"too_short","loc":["api_key"],"msg":"Value should have at least 40 items after validation, not 32","input":"sk-test-FAKE0123456789abcdefFAKE","ctx":{"field_type":"Value","min_length":40,"actual_length":32},"url":"https://errors.pydantic.dev/2.14/v/too_short"}]
[{"type":"too_short","loc":["api_key"],"msg":"Value should have at least 40 items after validation, not 32","ctx":{"field_type":"Value","min_length":40,"actual_length":32},"url":"https://errors.pydantic.dev/2.14/v/too_short"}]

print(e) とトレースバックからは消えましたが、e.json() と e.errors() には "input" としてキーが残りました。エラーを JSON にしてエラー監視サービスや API レスポンスに渡すコードがあると、そちらに出ます。消えたのは include_input=False を付けたときだけでした。

対策

  1. 秘密の値は SecretStr にする(print / repr / model_dump_json で隠れる)
  2. 設定クラスに hide_input_in_errors=True を付ける(print(e) とトレースバックで隠れる)
  3. ValidationError を JSON や辞書にして外へ出すところでは、e.json(include_input=False) / e.errors(include_input=False) を使う
  4. 起動時に設定オブジェクトを丸ごとログに出さない
class Settings(BaseSettings):
    model_config = SettingsConfigDict(hide_input_in_errors=True)
    api_key: SecretStr

try:
    settings = Settings()
except ValidationError as e:
    log.error("設定エラー: %s", e.json(include_input=False))
    raise SystemExit(1)

まとめ

  • SecretStr は print では隠れるが、検証に失敗したときの ValidationError には入力のキーがそのまま出た
  • hide_input_in_errors=True で print(e) とトレースバックからは消えたが、e.json() / e.errors() には残った
  • エラーを外に渡すときは include_input=False まで付ける

参考

0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?