Skip to content

Commit 23c5963

Browse files
authored
fix(serializer): mask pydantic secret values (#1886)
1 parent bedc76f commit 23c5963

2 files changed

Lines changed: 36 additions & 2 deletions

File tree

‎langfuse/_utils/serializer.py‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
from typing import Any
1414
from uuid import UUID
1515

16-
from pydantic import BaseModel
16+
from pydantic import BaseModel, SecretBytes, SecretStr
1717

1818
from langfuse.media import LangfuseMedia, LangfuseMediaReference
1919

@@ -52,6 +52,9 @@ def default(self, obj: Any) -> Any:
5252

5353
def _default_inner(self, obj: Any) -> Any:
5454
try:
55+
if isinstance(obj, (SecretStr, SecretBytes)):
56+
return "<secret>"
57+
5558
if isinstance(obj, (datetime)):
5659
# Timezone-awareness check
5760
return serialize_datetime(obj)

‎tests/unit/test_serializer.py‎

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
from uuid import UUID
88

99
import pytest
10-
from pydantic import BaseModel
10+
from pydantic import BaseModel, SecretBytes, SecretStr
1111

1212
from langfuse._utils.serializer import (
1313
EventSerializer,
@@ -29,6 +29,11 @@ class TestBaseModel(BaseModel):
2929
field: str
3030

3131

32+
class SecretBaseModel(BaseModel):
33+
api_key: SecretStr
34+
token: SecretBytes
35+
36+
3237
def test_datetime():
3338
dt = datetime(2023, 1, 1, 12, 0, 0, tzinfo=timezone.utc)
3439
serializer = EventSerializer()
@@ -71,6 +76,32 @@ def test_pydantic_model():
7176
assert json.loads(serializer.encode(model)) == {"field": "test"}
7277

7378

79+
@pytest.mark.parametrize(
80+
"secret",
81+
[
82+
SecretStr("not-a-real-api-key"),
83+
SecretBytes(b"not-a-real-token"),
84+
],
85+
)
86+
def test_pydantic_secret(secret):
87+
serializer = EventSerializer()
88+
89+
assert serializer.encode(secret) == '"<secret>"'
90+
91+
92+
def test_pydantic_model_with_secrets():
93+
model = SecretBaseModel(
94+
api_key=SecretStr("not-a-real-api-key"),
95+
token=SecretBytes(b"not-a-real-token"),
96+
)
97+
serializer = EventSerializer()
98+
99+
assert json.loads(serializer.encode(model)) == {
100+
"api_key": "<secret>",
101+
"token": "<secret>",
102+
}
103+
104+
74105
def test_langfuse_media_reference_serializes_to_reference_string():
75106
# Resolved references must round-trip back to their original reference string
76107
# rather than falling through to asdict() and emitting an opaque dict.

0 commit comments

Comments
 (0)