v1.2.0

[aidantwoods]

What's Changed

• Update ci.yml by @ilyabrin in Update ci.yml #9
• Validate ed25519 private keys during import by @aidantwoods in Validate ed25519 private keys during import #8
• Add sentinel error types by @aidantwoods in Add sentinel error types #12

New Contributors

• @ilyabrin made their first contribution in Update ci.yml #9

Full Changelog: v1.1.3...v1.2.0

Sentinel Errors

Introduces two specialisations on errors that may be returned: TokenError and RuleError. Note that some errors will still be returned by the library that are in neither of these specialisations, and so you should still fallback to general error handling (not assume one of these will always be returned).

A TokenError will be returned if the token is outright invalid in some way, whether that be due to formatting, a cryptographic issue, or some other issue which renders the token invalid.

A RuleError will be returned if a token fails one of the specified rules, but is otherwise valid (including cryptographically).

Distinguishing between these two error types is not mandatory: it is perfectly safe to just handle a general error without inspecting it. Being able to inspect an error may be useful for some use cases, for example if a different handling action is desired depending on whether the token was invalid or whether a rule failure occurred. Note that if you do look for one of these errors, you should additionally include code to handle general errors as a fallback: you should expect new errors that do not fall into either of these two categories to be returned in the future.

---

This discussion was created from the release v1.2.0.