fix(passkeys): canonicalize backup state credential encoding - #112
Merged
Conversation
pando85
marked this pull request as ready for review
August 2, 2026 00:25
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #111.
This PR makes APS use the same stable credential backup-state representation as soft-fido2 while preserving compatibility with credentials written by existing APS releases.
Canonical format
New writes emit exactly one CBOR text field:
APS no longer emits
backup_eligible.Legacy migration
The decoder continues to accept the historical APS boolean pair:
Valid legacy combinations are converted through a typed three-state codec. The invalid
BE=0, BS=1combination, malformed types, unknown text values, and mixed canonical/legacy representations are rejected.Credentials with no backup fields retain APS's established syncable-credential default (
eligible). Migration is lazy: the next save rewrites a legacy credential using the canonical representation.Compatibility
passkeys/CREDENTIAL_FORMAT.md.Validation
The branch workflow runs:
Regression coverage includes all canonical states, every valid legacy combination, invalid BE/BS, missing fields, malformed values, conflicting representations, metadata parity, and canonical lazy migration.
Related: pando85/soft-fido2#162