Skip to main content
Menu
Advisories

Validation bypass of aliased fields in TypedDict and dataclasses allowing extra data

GHSA-3R8G-CQWR-JR29Published Updated GitHub

Description

When extra data is allowed, providing both the alias and the name of an aliased TypedDict or dataclass field makes the unvalidated value (provided under the name) overwrite the validated one (provided under the alias), resulting in validated data not matching the declared type.

Details

Extra items are stored in the same dictionary as the fields (the returned dictionary for TypedDict, the instance __dict__ for dataclasses). As only the alias is marked as used, the field name is treated as an extra item, and its unvalidated value overrides the validated one (pydantic-core/src/validators/typed_dict.rs):

// First pass, for each field:
used_keys.insert(lookup_path.first_key()); // only the alias `b` is marked as used
// ...
output_dict.set_item(&field.name, value)?; // the validated value is stored under `a`

// Second pass, for each input key:
if self.used_keys.contains(cow.as_ref()) {
    continue; // `a` isn't marked as used
}
// ...
ExtraBehavior::Allow => {
    // the extra value is stored under `a`, overwriting the validated value:
    self.output_dict.set_item(py_key, value.to_object(self.py)?)?;
}

Dataclasses have the same logic, in pydantic-core/src/validators/dataclass.rs.

The issue was fixed in commit github.com/pydantic/pydantic/commit/34491f5328f168f14e3769cd5f0f83c0af0f4778.

Impact

Validation bypass: data returned by validation doesn't match the declared type. Affected are applications validating untrusted data into TypedDict or dataclass types with aliased fields and extra data allowed (with extra='allow', or with the extra_items argument for TypedDict), using Pydantic V2 (up to and including 2.14.1).

Pydantic models (BaseModel) are not affected, as extra data is stored separately from fields.

Affected versions

References

GitHub · pydantic/pydantic