oydid 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e119ee021cb7e09dd4c7ee6273a4ee778bae850e31b6360a31044c11e674df4c
-  data.tar.gz: 9be71c4690f1e6476c6a339a49172575eac79c11406c6a1ac8a49e66c804ee6e
+  metadata.gz: 853f05f30010c3713c64d00caee53feccd969429af27ee4cbd0370c1de7d9891
+  data.tar.gz: f601867e31baedc4bba925d99039a184dabca9ac64de311b5171c30d84f5b100
 SHA512:
-  metadata.gz: fa57e8c74580e2afa7e6adae48528fd8d43fd306176eb9039a1531c9db46c0090702eef2d036ddaee3aef09e568ef8ad2714c990e6745b2dff4ed080d5e18874
-  data.tar.gz: 4608b92f08da163850832144c89a9495c182a065155727a8d10bacb83ee00fd47951b442420e9ee24582a5804938349e55649b57fe0e699082aa3311fbc57729
+  metadata.gz: 78ce89d1e9fe4546852d6cb9ade32a8afbe0756ddf0af9253db328ade1d7d70fa60f1a1dc3ead15093713264954feae54bfb07f6d73ab41791e18758943b99d7
+  data.tar.gz: 01f895768ab0fcbc4f38c5e93e2ca0ab1bd82a5f25fe8092cf63ec32d4552e2f4a7a91292f55294bc9c3e40388b57809f92073199318142eb923c76703757289

data/VERSION

@@ -1 +1 @@
-0.8.0
+0.8.1

data/lib/oydid.rb

@@ -1367,6 +1367,44 @@ class Oydid
         end
     end
 
+    # Verification relationships in the payload either name a key by fragment
+    # ("#key-doc") or embed a whole verification method. Both need the DID
+    # prefixed onto the identifier; an embedded method additionally needs a
+    # controller, which the client cannot supply - the DID is the hash of the
+    # document that would have to contain it, so it is not known while the
+    # document is being written.
+    def self.expand_verification_methods(payload, wd, did)
+        return wd if !payload.is_a?(Hash)
+
+        [ "authentication",
+          "assertionMethod",
+          "keyAgreement",
+          "capabilityInvocation",
+          "capabilityDelegation" ].each do |vm|
+            next if payload[vm].to_s == ""
+            entries = payload[vm]
+            entries = [entries] if entries.is_a?(Hash) || entries.is_a?(String)
+
+            new_entries = []
+            entries.each do |el|
+                if el.is_a?(String)
+                    new_entries << percent_encode(did) + el
+                else
+                    new_el = el.transform_keys(&:to_s)
+                    new_el["id"] = percent_encode(did) + new_el["id"].to_s
+                    if new_el["controller"].to_s == ""
+                        new_el["controller"] = percent_encode(did)
+                    end
+                    new_entries << new_el
+                end
+            end
+
+            wd[vm] = new_entries.length > 0 ? new_entries : payload[vm]
+            payload.delete(vm)
+        end
+        wd
+    end
+
     def self.w3c(did_info, options)
         # check if doc is already W3C DID
         is_already_w3c_did = (did_info.transform_keys(&:to_s)["doc"]["doc"].has_key?("@context") &&
@@ -1527,6 +1565,10 @@ class Oydid
             if location.nil?
                 location = get_location(did_info["did"].to_s)
             end
+            # a payload carrying a service used to skip the handling below
+            # entirely and get merged verbatim, which left fragment identifiers
+            # unresolved and embedded methods without a controller
+            wd = expand_verification_methods(didDoc["doc"], wd, did)
             wd = wd.merge(didDoc["doc"])
             if wd["service"] != []
                 if wd["service"].is_a?(Array)
@@ -1547,33 +1589,7 @@ class Oydid
             if didDoc["doc"].is_a?(Hash)
                 if didDoc["doc"] != {}
                     didDoc = didDoc["doc"]
-                    # special handling for Verification Methods
-                    vms = [ "authentication", 
-                            "assertionMethod", 
-                            "keyAgreement", 
-                            "capabilityInvocation",
-                            "capabilityDelegation" ]
-
-                    vms.each do |vm|
-                        if didDoc[vm].to_s != ""
-                            new_entries = []
-                            didDoc[vm].each do |el|
-                                if el.is_a?(String)
-                                    new_entries << percent_encode(did) + el
-                                else
-                                    new_el = el.transform_keys(&:to_s)
-                                    new_el["id"] = percent_encode(did) + new_el["id"]
-                                    new_entries << new_el
-                                end
-                            end unless didDoc[vm].nil?
-                            if new_entries.length > 0
-                                wd[vm] = new_entries
-                            else
-                                wd[vm] = didDoc[vm]
-                            end
-                            didDoc.delete(vm)
-                        end
-                    end
+                    wd = expand_verification_methods(didDoc, wd, did)
                     if didDoc["alsoKnownAs"].to_s != ""
                         if didDoc["alsoKnownAs"].is_a?(Array)
                             dda = didDoc["alsoKnownAs"]

data/spec/oydid_spec.rb

@@ -528,4 +528,60 @@ describe "OYDID handling" do
     end
   end
 
+  # W3C conversion of verification relationships carried in the payload
+  describe "verification relationships in the payload" do
+    let(:did) { "did:oyd:zQmaBZTghndXTgxNwfbdpVLWdFf6faYE4oeuN2zzXdQt1kh" }
+    let(:keys) do
+      "z6MktULudTtAsAhRegYPiZ6631RV3viv12qd4GQF8z1xB22S:" \
+      "z6MkqGC3nWZhYieEVTVDKW5v588CiGfsDSmRVG9ZwwWTvLSK"
+    end
+    let(:attestation) do
+      { "id" => "#key-attest",
+        "type" => "Ed25519VerificationKey2020",
+        "publicKeyMultibase" => "z6Mkg49NtQR2LyYRDCQFK4w1VVHqhypZSSRo7HsyuN7SV7v5" }
+    end
+
+    def convert(payload)
+      Oydid.w3c({ "did" => did, "doc" => { "doc" => payload, "key" => keys } }, {})
+    end
+
+    it "prefixes the DID onto a key named by fragment" do
+      wd = convert({ "authentication" => ["#key-doc"] })
+      expect(wd["authentication"]).to eq ["#{did}#key-doc"]
+    end
+
+    it "prefixes the DID onto an embedded verification method" do
+      wd = convert({ "assertionMethod" => [attestation] })
+      expect(wd["assertionMethod"].first["id"]).to eq "#{did}#key-attest"
+    end
+
+    # a client cannot supply the controller: the DID is the hash of the
+    # document that would contain it
+    it "fills in the controller of an embedded verification method" do
+      wd = convert({ "assertionMethod" => [attestation] })
+      expect(wd["assertionMethod"].first["controller"]).to eq did
+    end
+
+    it "keeps a controller the payload already carries" do
+      own = attestation.merge("controller" => "did:oyd:zSomeoneElse")
+      wd = convert({ "assertionMethod" => [own] })
+      expect(wd["assertionMethod"].first["controller"]).to eq "did:oyd:zSomeoneElse"
+    end
+
+    # regression: a payload carrying a service took a different branch and was
+    # merged verbatim, leaving fragments unresolved
+    it "handles relationships next to a service entry" do
+      wd = convert({ "assertionMethod" => [attestation],
+                     "service" => [{ "id" => "#payload", "type" => "Custom" }] })
+      expect(wd["assertionMethod"].first["id"]).to eq "#{did}#key-attest"
+      expect(wd["assertionMethod"].first["controller"]).to eq did
+      expect(wd["service"]).to be_an(Array)
+    end
+
+    it "accepts a single embedded method that is not wrapped in an array" do
+      wd = convert({ "assertionMethod" => attestation })
+      expect(wd["assertionMethod"].first["id"]).to eq "#{did}#key-attest"
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oydid
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Christoph Fabianek