8000 feat: enforce strict did peer0 invariants by oleksiipiliugin · Pull Request #283 · affinidi/affinidi-ssi-dart · GitHub
[go: up one dir, main page]

Skip to content

feat: enforce strict did peer0 invariants - #283

Closed
oleksiipiliugin wants to merge 3 commits into
feat/did-manager-multi-key-support-did-web-did-peerfrom
feat/did-peer-strict-peer0
Closed

oleksiipiliugin wants to merge 3 commits into
feat/did-manager-multi-key-support-did-web-did-peerfrom
feat/did-peer-strict-peer0

Conversation

@oleksiipiliugin
Copy link
Copy Markdown
Contributor

This pull request introduces several improvements and fixes to the DID and credential management logic, with a focus on standards compliance, deterministic ID generation, and proper handling of DID method variants. The most significant changes are the addition of strict support for did:peer:0 in DidPeerManager, improved JWK thumbprint-based verification method IDs for did:web, and various fixes to ensure correct key usage and relationships.

DID Peer Manager: did:peer:0 strict mode and resolution improvements

  • Added a preferredNumalgo option to DidPeerManager, enabling strict enforcement of did:peer:0 rules (single wallet key, no services) and fast-path resolution for peer0 DIDs. [1] [2]
  • Updated the DID peer resolution logic to properly handle did:peer:0 and pass the preferred numalgo through to DID construction.

DID Web Manager: Deterministic JWK thumbprint-based VM IDs and key handling

  • Changed buildVerificationMethodId in DidWebManager to use the JWK thumbprint (RFC 7638) of the public key for deterministic, standards-compliant verification method IDs.
  • Refactored verification method creation to ensure correct handling of Ed25519/X25519 key derivation and consistent DID document generation. [1] [2] [3]

Credential and proof generation: Consistent use of didKeyId

  • Updated all credential and proof generation logic to use signer.didKeyId instead of signer.keyId for JWT headers, proof verification methods, and related fields, ensuring correct DID-based key references. [1] [2] [3] [4] [5] [6] [7] [8] [9]

DID Peer and Web: Standards compliance and bugfixes

  • Fixed the construction of verification method IDs in did:peer:2 resolution to use the full DID URL, not just a fragment.
  • Updated the did:peer:0 resolver to recognize additional key types for key agreement, improving compatibility.

Other improvements

  • Improved issuer field handling in JWT credential payloads to ensure the correct issuer value is always set, even when the issuer is a map.
  • Added missing imports and documentation for clarity and maintainability. [1] [2] [3]

These changes collectively improve standards compliance, deterministic behavior, and robustness in the handling of DIDs and credentials.

oleksiipiliugin a 8000 dded 3 commits April 24, 2026 16:06
Extends `_resolveDidPeer0._buildSimpleDoc`'s `forKeyAgreement` predicate so
P256, P384 and P521 peer:0 DIDs include a keyAgreement relationship that
points to the same VM as the signing relationships, mirroring how `did:key`
already resolves these key types via `_buildOtherDoc`.

The previous behavior only enabled keyAgreement for x25519 (`6LS`); P256
(`zDn`), P384 (`z82`) and P521 (`z2J9`) peer:0 DIDs ended up without a
keyAgreement entry even though the underlying ECDH curves are valid for
key agreement.

Adds tests in test/did/did_peer_test.dart covering each prefix:
- x25519 (6LS): keyAgreement-only, signing slots empty (the originally
  uncovered branch).
- p256 (Dn): signing + keyAgreement on the single VM.
- p384 (82): signing + keyAgreement on the single VM.
- p521 (2J9): signing + keyAgreement on the single VM.
- secp256k1 (Q3s): signing only — guards against accidentally enabling
  keyAgreement for secp256k1.
When DidPeerManager is constructed with `preferredNumalgo: DidPeerType.peer0`
the manager now enforces the same single-key, no-services constraints that
DidKeyManager enforces, instead of silently falling back to `did:peer:2`
when those constraints are violated.

This treats `did:peer:0` as the `did:key`-equivalent encoding it is per
spec: one multibase-encoded key, no services. The peer:2 default behavior
is unchanged.

Changes (all in lib/src/did/did_manager/did_peer_manager.dart):
- Override `addVerificationMethod`: when `preferredNumalgo == peer0`,
  scan existing VMs in the store, look up their wallet keys, and reject
  with `tooManyVerificationMethods` if a *different* wallet key is
  already present. Same-key re-entry is allowed so multi-relationship
  adds and the ed25519→x25519 keyAgreement derivation continue to work.
- Override `addServiceEndpoint`: when `preferredNumalgo == peer0`,
  throw `UnsupportedError` (mirror DidKeyManager.addServiceEndpoint).
- Modify `getDidDocument`: when `preferredNumalgo == peer0` and there
  are no services, collapse multiple stored VMs that share a single
  wallet key (e.g. ed25519 + derived x25519) down to the single primary
  key before calling `DidPeer.getDid`. The `_buildEDDoc` resolver
  derives the keyAgreement entry the same way `did:key` does.

`internalAddVerificationMethod` is unchanged — peer:2 remains identical
to v3.6.2/v3.8.0, preserving alignment with the Affinidi Rust mediator.
The `isDid0` gate in `DidPeer.getDid` is also unchanged so the static
public API stays safe for direct callers.

Adds 6 new tests in test/did/did_manager/did_peer_manager_test.dart
(group: "Strict did:peer:0 semantics"):
- rejects a second wallet key with tooManyVerificationMethods
- allows re-entry for the SAME wallet key (multi-relationship adds)
- rejects addServiceEndpoint with UnsupportedError
- single ed25519 + keyAgreement still produces did:peer:0 (mirrors did:key)
- single p256 + multiple relationships produces did:peer:0
- default (peer2) manager still allows multiple keys and services
…hapes

Adds three regression tests in the existing
DidPeerManager > "DID generation" group to lock in that the default
peer:2 manager never auto-collapses single-key/no-service shapes down to
did:peer:0. Pre-PR, the static `DidPeer.getDid` would have done so for
the same inputs (b12ef59 / upstream-without-`preferredNumalgo`), so this
guards the intent of the new `preferredNumalgo: DidPeerType.peer2`
default at the manager level.

Cases covered:
- 1 key (p256) + 1 relationship (authentication) + 0 services
  -> did:peer:2 with a `.Vz` key entry (not did:peer:0).
- 1 ed25519 key + auth+keyAgreement + 0 services
  -> did:peer:2 with `.Vz` and `.Ez` entries and 2 VMs (not collapsed
  to a did:key-style ed25519+derived-x25519 did:peer:0 doc).
- 1 key + empty relationship set -> manager throws SsiException with
  code `invalidDidDocument`, asserting the manager neither silently
  produces a relationships-less did:peer:0 nor a relationships-less
  did:peer:2.
@oleksiipiliugin
oleksiipiliugin requested a review from a team as a code owner April 24, 2026 13:30
@oleksiipiliugin
oleksiipiliugin changed the base branch from main to feat/did-manager-multi-key-support-did-web-did-peer April 24, 2026 13:31
@github-actions
Copy link
Copy Markdown

Coverage after merging feat/did-peer-strict-peer0 into main will be

79.32%

Coverage Report
FileStmtsBranchesFuncsLinesUncovered Lines
lib/src
   types.dart70.83%100%100%70.83%122, 159–160, 172, 174, 189, 244
   digest_utils.dart100%100%100%100%
   utility.dart100%100%100%100%
lib/src/credentials/jwt
   jwt_data_model_v1.dart97.73%100%100%97.73%52
   jwt_dm_v1_suite.dart86.27%100%100%86.27%100, 102, 39, 41, 59, 74, 76
lib/src/credentials/linked_data
   ld_base_suite.dart93.44%100%100%93.44%120, 122, 168, 171
   ld_dm_v1_suite.dart100%100%100%100%
   ld_dm_v2_suite.dart100%100%100%100%
lib/src/credentials/models
   sdjwt_signer_adapter.dart100%100%100%100%
lib/src/credentials/models/field_types
   issuer.dart100%100%100%100%
   context.dart85.96%100%100%85.96%171, 173, 206–211
   credential_schema.dart100%100%100%100%
   credential_subject.dart72.97%100%100%72.97%38, 55, 57–58, 61, 64–65, 70–71, 94
   evidence.dart76.47%100%100%76.47%50–52, 54
   holder.dart100%100%100%100%
   terms_of_use.dart75%100%100%75%46–48, 50
lib/src/credentials/models/field_types/credential_status
   revocation_list_2020.dart20.90%100%100%20.90%101–104, 107, 110–112, 114–116, 118–120, 122–124, 14, 171, 173, 175–182, 22–27, 65, 68–75, 81, 84–85, 87–88, 90–91, 93–94, 99
   v1.dart72.73%100%100%72.73%60–61, 71, 73–76, 78, 82–83, 88–89
   v2.dart72.73%100%100%72.73%59–60, 70, 72–75, 77, 81–82, 87–88
lib/src/credentials/models/field_types/refresh_service
   v1.dart76.47%100%100%76.47%46–48, 50
   v2.dart18.18%100%100%18.18%35–36, 38, 55–56, 61, 66–67, 69
lib/src/credentials/models/v1
   mutable_vc_data_model_v1.dart88.14%100%100%88.14%154, 202–203, 209–210, 216, 222
   vc_data_model_v1.dart91.27%100%100%91.27%160, 162–163, 187–189, 212–215, 218
lib/src/credentials/models/v2
   mutable_vc_data_model_v2.dart84.75%100%100%84.75%179, 185–186, 196–197, 204–205, 211, 217
   vc_data_model_v2.dart90.76%100%100%90.76%165–167, 190–193, 196, 316, 322, 326
lib/src/credentials/parsers
   jwt_parser.dart88.89%100%100%88.89%51, 53
   ld_parser.dart85.71%100%100%85.71%26
   sdjwt_parser.dart70%100%100%70%40, 56, 58
lib/src/credentials/presentations/linked_data
   ld_vp_dm_v1_suite.dart100%100%100%100%
   ld_vp_dm_v2_suite.dart100%100%100%100%
lib/src/credentials/presentations/models
   vc_parse_present.dart57.14%100%100%57.14%101, 104, 109–110, 35–37, 62–64, 88–89, 92–97
lib/src/credentials/presentations/models/v1
   mutable_vp_data_model_v1.dart48.15%100%100%48.15%102, 75, 81–82, 84–86, 88, 90, 92, 94–95, 98–99
   vp_data_model_v1.dart88.52%100%100%88.52%111, 113, 138, 143, 84, 86–87
lib/src/credentials/presentations/models/v2
   vp_data_model_v2.dart88.06%100%100%88.06%116, 118, 142, 147, 205, 89, 91–92
   mutable_vp_data_model_v2.dart46.88%100%100%46.88%101–102, 105–106, 109, 111–112, 115, 81, 87–88, 90, 92–93, 95, 97, 99
lib/src/credentials/presentations/suites
   universal_presentation_parser.dart42.86%100%100%42.86%21–22, 24–25
   universal_presentation_verifier.dart90.63%100%100%90.63%106–108
   vp_suites.dart61.54%100%100%61.54%31, 33, 53–55
lib/src/credentials/presentations/verification
   delegation_vc_verifier.dart100%100%100%100%
   holder_binding_verifier.dart94.87%100%100%94.87%64–65
   vp_expiry_verifier.dart100%100%100%100%
   vp_integrity_verifier.dart100%100%100%100%
   vp_domain_challenge_verifier.dart75%100%100%75%36, 53–54, 62–63
lib/src/credentials/proof
   data_integrity_ecdsa_suite.dart77.98%100%100%77.98%143, 152, 155, 158, 161, 164, 171, 174, 181, 268, 272, 274–275, 350, 355, 384, 386, 404, 408, 410–411, 52, 54–55
   data_integrity_eddsa_suite.dart80%100%100%80%137, 146, 149, 152, 155, 158, 165, 168, 175, 181, 49, 51–52
   ecdsa_secp256k1_signature2019_suite.dart75%100%100%75%125, 130–131, 133, 135–136, 138, 140–141, 143, 145–146, 148, 152–153, 155, 158, 76, 78, 81
   embedded_proof_suite.dart100%100%100%100%
   jcs_utils.dart49.06%100%100%49.06%17, 193, 196, 199–202, 221, 225, 229, 240–241, 249, 252, 42, 44–45, 53, 55, 61, 64, 72–73, 75, 79, 81, 84
   embedded_proof.dart75%100%100%75%107–108, 110, 117, 158–159, 165–167, 169, 183, 191, 197, 199, 91, 96–97
   base_data_integrity_verifier.dart63.50%100%100%63.50%101–102, 116–119, 123–127, 154–159, 183–184, 211, 213, 215–216, 219, 222–223, 227–228, 302, 304–305, 339, 344–345, 347, 349–350, 352, 354–355, 357, 359–360, 362, 365–366, 368, 371, 87–88
   proof_validation_utils.dart100%100%100%100%
   base_jcs_generator.dart100%100%100%100%
   data_integrity_context_util.dart60%100%100%60%14, 23, 25, 31, 35, 37
   base_jcs_verifier.dart72.73%100%100%72.73%101, 103–104, 115, 117–118, 153–154, 184–187,

@oleksiipiliugin
Copy link
Copy Markdown
Contributor Author

Rearranged commits in the PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

0