Summary

Improve invalidation checking to InvalidatableMixin.

Review Request #15189 — Created July 21, 2026 and updated July 29, 2026, 8:39 p.m.

Information

Owner

chipx86

Repository

cryptozoology

Branch

master

Bugs

Depends On

Reviewers

Groups

beanbag-misc

People

Description

Initially, invalidation support was limited to BaseKey, though it
was moved out early in development to InvalidatableMixin. The one
piece remaining in BaseKey was check_valid(), which raised a
KeyInvalidatedError if no longer valid.

This change renames the exception to InvalidatedError and moves
check_valid() out into the mixin, so that any invalidatable object can
perform these validity checks. It's been renamed to assert_valid(), to
make its purpose more clear.

When used as a context manager, invalidatable objects will now start
with a validity assertion, to avoid any surprises and catch problems
early.

Testing Done

Unit tests pass.

Commits

Summary	ID
Improve invalidation checking to InvalidatableMixin. Initially, invalidation support was limited to `BaseKey`, though it was moved out early in development to `InvalidatableMixin`. The one piece remaining in `BaseKey` was `check_valid()`, which raised a `KeyInvalidatedError` if no longer valid. This change renames the exception to `InvalidatedError` and moves `check_valid()` out into the mixin, so that any invalidatable object can perform these validity checks. It's been renamed to `assert_valid()`, to make its purpose more clear. When used as a context manager, invalidatable objects will now start with a validity assertion, to avoid any surprises and catch problems early.	2f02f59a7e0c9e5ffbf0fcd726fa2162335de3d3

Summary

Improve invalidation checking to InvalidatableMixin.

Initially, invalidation support was limited to `BaseKey`, though it was moved out early in development to `InvalidatableMixin`. The one piece remaining in `BaseKey` was `check_valid()`, which raised a `KeyInvalidatedError` if no longer valid. This change renames the exception to `InvalidatedError` and moves `check_valid()` out into the mixin, so that any invalidatable object can perform these validity checks. It's been renamed to `assert_valid()`, to make its purpose more clear. When used as a context manager, invalidatable objects will now start with a validity assertion, to avoid any surprises and catch problems early.

2f02f59a7e0c9e5ffbf0fcd726fa2162335de3d3

Issues

Description	From	Last Updated
Since this is now happening in the mixin and the error is really generic, it's hard to know what's wrong …	david	July 29, 2026, 7:50 p.m.
'cryptozoology.errors.InvalidatedError' imported but unused Column: 1 Error code: F401	reviewbot	July 21, 2026, 11:04 p.m.
In modern python we can use with self.assertRaises(InvalidatedError, msg=message): Same for others below.	david	July 29, 2026, 8:24 p.m.
This was copied over straight from check_valid(). Probably should say "Assert that the object is still valid" now.	david	July 29, 2026, 7:49 p.m.
Same about assertRaises in this file.	david	July 29, 2026, 8:24 p.m.

flake8 failed.

JSHint passed.

flake8

cryptozoology/keys/base.py (Diff revision 1)

The issue has been resolved. Show all issues

'cryptozoology.errors.InvalidatedError' imported but unused

Column: 1
Error code: F401

Change Summary:

Removed an unused import.

Commits:

	Summary	ID
	Improve invalidation checking to InvalidatableMixin. Initially, invalidation support was limited to `BaseKey`, though it was moved out early in development to `InvalidatableMixin`. The one piece remaining in `BaseKey` was `check_valid()`, which raised a `KeyInvalidatedError` if no longer valid. This change renames the exception to `InvalidatedError` and moves `check_valid()` out into the mixin, so that any invalidatable object can perform these validity checks. It's been renamed to `assert_valid()`, to make its purpose more clear. When used as a context manager, invalidatable objects will now start with a validity assertion, to avoid any surprises and catch problems early.	726f1805cff2dda9f452a8518ce3e1da2dec1051
	Improve invalidation checking to InvalidatableMixin. Initially, invalidation support was limited to `BaseKey`, though it was moved out early in development to `InvalidatableMixin`. The one piece remaining in `BaseKey` was `check_valid()`, which raised a `KeyInvalidatedError` if no longer valid. This change renames the exception to `InvalidatedError` and moves `check_valid()` out into the mixin, so that any invalidatable object can perform these validity checks. It's been renamed to `assert_valid()`, to make its purpose more clear. When used as a context manager, invalidatable objects will now start with a validity assertion, to avoid any surprises and catch problems early.	51b16ff5594badd0014a6349d507d4cd5b22acd6

Diff:

Revision 2 (+180 -114)

Show changes

	cryptozoology/errors.py
	cryptozoology/keys/aes.py
	cryptozoology/keys/base.py
	cryptozoology/keys/ec.py
	cryptozoology/keys/tests/test_aes_key.py
	cryptozoology/keys/tests/test_base.py
	cryptozoology/keys/tests/test_ec_private_key.py
	cryptozoology/keys/tests/test_ec_public_key.py
	2 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

The issue has been resolved. Show all issues

Since this is now happening in the mixin and the error is really generic, it's hard to know what's wrong if we get InvalidatedError. A traceback coming from a decryption operation would just tell the caller that something was invalid, but it's hard to know if it was the key or the SensitiveBytes instance. As this library grows that just becomes even less clear.

Can we include type(self).__name__ in the exception's message somehow?

cryptozoology/utils/invalidation.py (Diff revision 2)

The issue has been resolved. Show all issues

This was copied over straight from check_valid(). Probably should say "Assert that the object is still valid" now.

Change Summary:


Added an error message for InvalidatedError and updated tests.
Improved the docstring for assert_valid().

Commits:

	Summary	ID
	Improve invalidation checking to InvalidatableMixin. Initially, invalidation support was limited to `BaseKey`, though it was moved out early in development to `InvalidatableMixin`. The one piece remaining in `BaseKey` was `check_valid()`, which raised a `KeyInvalidatedError` if no longer valid. This change renames the exception to `InvalidatedError` and moves `check_valid()` out into the mixin, so that any invalidatable object can perform these validity checks. It's been renamed to `assert_valid()`, to make its purpose more clear. When used as a context manager, invalidatable objects will now start with a validity assertion, to avoid any surprises and catch problems early.	51b16ff5594badd0014a6349d507d4cd5b22acd6
	Improve invalidation checking to InvalidatableMixin. Initially, invalidation support was limited to `BaseKey`, though it was moved out early in development to `InvalidatableMixin`. The one piece remaining in `BaseKey` was `check_valid()`, which raised a `KeyInvalidatedError` if no longer valid. This change renames the exception to `InvalidatedError` and moves `check_valid()` out into the mixin, so that any invalidatable object can perform these validity checks. It's been renamed to `assert_valid()`, to make its purpose more clear. When used as a context manager, invalidatable objects will now start with a validity assertion, to avoid any surprises and catch problems early.	2f02f59a7e0c9e5ffbf0fcd726fa2162335de3d3

Diff:

Revision 3 (+322 -114)

Show changes

	cryptozoology/errors.py
	cryptozoology/keys/aes.py
	cryptozoology/keys/base.py
	cryptozoology/keys/ec.py
	cryptozoology/keys/tests/test_aes_key.py
	cryptozoology/keys/tests/test_base.py
	cryptozoology/keys/tests/test_ec_private_key.py
	cryptozoology/keys/tests/test_ec_public_key.py
	2 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

cryptozoology/keys/tests/test_aes_key.py (Diff revisions 2 - 3)

The issue has been dropped. Show all issues

In modern python we can use with self.assertRaises(InvalidatedError, msg=message):
Same for others below.

chipx86

July 29, 2026, 8:25 p.m.

No, this provides a custom message if the validation fails. It doesn't check against the message. It's equivalent to assertEqual(..., msg=...).

david

July 29, 2026, 8:39 p.m.
```
Oh, right you are.
```
chipx86

July 29, 2026, 8:39 p.m.
```
I really wish it did do that though :(
```

cryptozoology/utils/tests/test_invalidatable_mixin.py (Diff revisions 2 - 3)
The issue has been dropped. Show all issues
```
Same about assertRaises in this file.
```

Ship it!

```
Ship It!
```