oydid 0.4.0 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e715e178b3d9ea7da5fe0a47421740fec4b6e22f8e3355c9fb7e43a704c6b56
-  data.tar.gz: 8ba62acc964c24e22411a4e5e5287df54bdda9b1566f98c91a760d5853a3b826
+  metadata.gz: 56c65853f4983bcb8214a4027986839c0503adcc1133933f817d8401d8881be7
+  data.tar.gz: 2a6048ab2023f8641e83e7b0162a8c15ef6bdb2c0855d70cef8d6c015ca34720
 SHA512:
-  metadata.gz: d656097d2b8ab1d9d9b19788cdf5051e397c13580de470cbce0d9f0c917dc5a2a9a3ec8c7eb7cfaf8b3ef8755f37275f0fee39ad27d7e87fcba16fc2bd9dea59
-  data.tar.gz: cb6ecf4797e57f43c15c401068966688be5fa1f84d8947f2fb5b65b75c96394b7d471cb5c2357f65f6734d0cb6e54f1ea1ded76a4bfa7eb4b2c251e98ba85898
+  metadata.gz: 799e94f77486d60beb09c8b8f5101ac5789eb1d000052a1aa396121acbd13e0a935cb06fe0c1849ef4deb75b407da049d1111bd15f0d49bd2863671419da4480
+  data.tar.gz: d513c74e0b307a74a9c7fced1bd3ce5bdaef1941290a70aef447a183e3e31da5c44582d25969cd401ec25379412fb7850d55e5e547972e87ee39e4297e79866c

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.4.4

data/lib/oydid/basic.rb

@@ -25,6 +25,11 @@ class Oydid
         message.to_json_c14n
     end
 
+    def self.percent_encode(did)
+        # remove "https://" from string as it is default
+        did = did.sub("https://","").sub("@", "%40").sub("http://","http%3A%2F%2F")
+    end
+
     # key management ----------------------------
     def self.generate_private_key(input, method = "ed25519-priv")
         begin
@@ -47,13 +52,21 @@ class Oydid
         return [encode([omc, length, raw_key].pack("SCa#{length}")), ""]
     end
 
-    def self.public_key(private_key)
+    def self.public_key(private_key, method = "ed25519-pub")
         code, length, digest = decode(private_key).unpack('SCa*')
         case Multicodecs[code].name
         when 'ed25519-priv'
-            public_key = Ed25519::SigningKey.new(digest).verify_key
+            case method
+            when 'ed25519-pub'
+                public_key = Ed25519::SigningKey.new(digest).verify_key
+            when 'x25519-pub'
+                public_key = RbNaCl::PrivateKey.new(digest).public_key
+            else
+                return [nil, "unsupported key codec"]
+            end
             length = public_key.to_bytes.bytesize
-            return [encode([Multicodecs['ed25519-pub'].code, length, public_key].pack("CCa#{length}")), ""]
+            return [encode([Multicodecs[method].code, length, public_key].pack("CCa#{length}")), ""]
+
         else
             return [nil, "unsupported key codec"]
         end
@@ -91,6 +104,53 @@ class Oydid
         end
     end
 
+    def self.encrypt(message, public_key)
+        begin
+            code, length, digest = decode(public_key).unpack('CCa*')
+            case Multicodecs[code].name
+            when 'x25519-pub'
+                pubKey = RbNaCl::PublicKey.new(digest)
+                authHash = RbNaCl::Hash.sha256('auth'.dup.force_encoding('ASCII-8BIT'))
+                authKey = RbNaCl::PrivateKey.new(authHash)
+                box = RbNaCl::Box.new(pubKey, authKey)
+                nonce = RbNaCl::Random.random_bytes(box.nonce_bytes)
+                msg = message.force_encoding('ASCII-8BIT')
+                cipher = box.encrypt(nonce, msg)
+                return [
+                    { 
+                        value: cipher.unpack('H*')[0], 
+                        nonce: nonce.unpack('H*')[0]
+                    }, ""
+                ]
+            else
+                return [nil, "unsupported key codec"]
+            end
+        rescue
+            return [nil, "encryption failed"]
+        end
+    end
+
+    def self.decrypt(message, private_key)
+        begin
+            cipher = [JSON.parse(message)["value"]].pack('H*')
+            nonce = [JSON.parse(message)["nonce"]].pack('H*')
+            code, length, digest = decode(private_key).unpack('SCa*')
+            case Multicodecs[code].name
+            when 'ed25519-priv'
+                privKey = RbNaCl::PrivateKey.new(digest)
+                authHash = RbNaCl::Hash.sha256('auth'.dup.force_encoding('ASCII-8BIT'))
+                authKey = RbNaCl::PrivateKey.new(authHash).public_key
+                box = RbNaCl::Box.new(authKey, privKey)
+                retVal = box.decrypt(nonce, cipher)
+                return [retVal, ""]
+            else
+                return [nil, "unsupported key codec"]
+            end
+        rescue
+            return [nil, "decryption failed"]
+        end
+    end
+
     def self.read_private_key(filename)
         begin
             f = File.open(filename)
@@ -157,6 +217,7 @@ class Oydid
 
         case doc_location
         when /^http/
+            doc_location = doc_location.sub("%3A%2F%2F","://")
             retVal = HTTParty.get(doc_location + "/doc/" + doc_hash)
             if retVal.code != 200
                 msg = retVal.parsed_response("error").to_s rescue "invalid response from " + doc_location.to_s + "/doc/" + doc_hash.to_s
@@ -190,6 +251,7 @@ class Oydid
 
         case doc_location
         when /^http/
+            doc_location = doc_location.sub("%3A%2F%2F","://")
             retVal = HTTParty.get(doc_location + "/doc_raw/" + doc_hash)
             if retVal.code != 200
                 msg = retVal.parsed_response("error").to_s rescue "invalid response from " + doc_location.to_s + "/doc/" + doc_hash.to_s

data/lib/oydid/didcomm.rb

@@ -0,0 +1,120 @@
+# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
+
+class Oydid
+
+    # DIDComm Plain Message ---------------------
+    def self.dcpm(payload, options)
+        dcDoc = {}
+        dcDoc["id"] = SecureRandom.random_number(10e14).to_i
+        dcDoc["type"] = options[:didcomm_type]
+        if !options[:didcomm_from_did].nil?
+            dcDoc["from"] = options[:didcomm_from_did]
+        end
+        dcDoc["to"] = [options[:didcomm_to_did]]
+        dcDoc["created_time"] = Time.now.utc.to_i
+        dcDoc["body"] = payload
+        return [dcDoc, ""]
+
+    end
+
+    # DIDComm Signed Message --------------------
+    def self.dcsm(payload, private_key_encoded, options)
+        error = ""
+        code, length, digest = decode(private_key_encoded).unpack('SCa*')
+        case Multicodecs[code].name
+        when 'ed25519-priv'
+            private_key = RbNaCl::Signatures::Ed25519::SigningKey.new(digest)
+            token = JWT.encode payload, private_key, 'ED25519', { typ: 'JWM', kid: options[:sign_did].to_s, alg: 'ED25519' }
+        else
+            token = nil
+            error = "unsupported key codec"
+        end
+        return [token, error]
+    end
+
+    def self.dcsm_verify(token, options)
+        error = ""
+        decoded_payload = JWT.decode token, nil, false
+        pubkey_did = decoded_payload.last["kid"]
+        result, msg = Oydid.read(pubkey_did, options)
+        public_key_encoded = Oydid.w3c(result, options)["authentication"].first["publicKeyMultibase"]
+        begin
+            code, length, digest = Oydid.decode(public_key_encoded).unpack('CCa*')
+            case Multicodecs[code].name
+            when 'ed25519-pub'
+                public_key = RbNaCl::Signatures::Ed25519::VerifyKey.new(digest)
+                payload = JWT.decode token.to_s, public_key, true, { algorithm: 'ED25519' }
+            else
+                payload = nil
+                error = "unsupported key codec"
+            end
+            return [payload, error]
+        rescue
+            return [nil, "verification failed"]
+        end
+    end
+
+    # encryption -----------------------------------
+    def self.msg_encrypt(payload, private_key_encoded, did)
+        error = ""
+        code, length, digest = decode(private_key_encoded).unpack('SCa*')
+        case Multicodecs[code].name
+        when 'ed25519-priv'
+            private_key = RbNaCl::Signatures::Ed25519::SigningKey.new(digest)
+            token = JWT.encode payload, private_key, 'ED25519'
+        else
+            token = nil
+            error = "unsupported key codec"
+        end
+        return [token, error]
+    end
+
+    def self.msg_decrypt(token, public_key_encoded)
+        error = ""
+        code, length, digest = Oydid.decode(public_key_encoded).unpack('CCa*')
+        case Multicodecs[code].name
+        when 'ed25519-pub'
+            public_key = RbNaCl::Signatures::Ed25519::VerifyKey.new(digest)
+            payload = JWT.decode token.to_s, public_key, true, { algorithm: 'ED25519' }
+        else
+            payload = nil
+            error = "unsupported key codec"
+        end
+        return [payload, error]
+    end
+
+    # signing for JWS ---------------------------
+    def self.msg_sign(payload, hmac_secret)
+        token = JWT.encode payload, hmac_secret, 'HS256'
+        return [token, ""]
+    end
+
+    def self.msg_verify_jws(token, hmac_secret)
+        begin
+            decoded_token = JWT.decode token, hmac_secret, true, { algorithm: 'HS256' }
+            return [decoded_token, ""]
+        rescue
+            return [nil, "verification failed"]
+        end
+    end
+
+    # DID Auth for data container with challenge ---
+    def self.token_from_challenge(host, pwd)
+        sid = SecureRandom.hex(20).to_s
+        retVal = HTTParty.post(host + "/oydid/init",
+                    headers: { 'Content-Type' => 'application/json' },
+                    body: { "session_id": sid }.to_json )
+        challenge = retVal.parsed_response["challenge"]
+        signed_challenge = Oydid.sign(challenge, Oydid.generate_private_key(pwd).first).first
+        public_key = Oydid.public_key(Oydid.generate_private_key(pwd).first).first
+        retVal = HTTParty.post(host + "/oydid/token",
+                    headers: { 'Content-Type' => 'application/json' },
+                    body: {
+                        "session_id": sid,
+                        "signed_challenge": signed_challenge,
+                        "public_key": public_key
+                    }.to_json)
+        return retVal.parsed_response["access_token"]
+    end
+end

data/lib/oydid/log.rb

@@ -37,6 +37,7 @@ class Oydid
 
         case log_location
         when /^http/
+            log_location = log_location.sub("%3A%2F%2F","://")
             retVal = HTTParty.get(log_location + "/log/" + did_hash)
             if retVal.code != 200
                 msg = retVal.parsed_response("error").to_s rescue 
@@ -152,20 +153,23 @@ class Oydid
 
     def self.dag_update(currentDID, options)
         i = 0
-        initial_did = currentDID["did"].to_s
+        doc_location = ""
+        initial_did = currentDID["did"].to_s.dup
         initial_did = initial_did.delete_prefix("did:oyd:")
-        initial_did = initial_did.split("@").first
+        if initial_did.include?(LOCATION_PREFIX)
+            tmp = initial_did.split(LOCATION_PREFIX)
+            initial_did = tmp[0] 
+            doc_location = tmp[1]
+        end
         current_public_doc_key = ""
         verification_output = false
         currentDID["log"].each do |el|
             case el["op"]
             when 2,3 # CREATE, UPDATE
                 currentDID["doc_log_id"] = i
-
                 doc_did = el["doc"]
-                doc_location = get_location(doc_did)
                 did_hash = doc_did.delete_prefix("did:oyd:")
-                did_hash = did_hash.split("@").first
+                did_hash = did_hash.split(LOCATION_PREFIX).first
                 did10 = did_hash[0,10]
                 doc = retrieve_document_raw(doc_did, did10 + ".doc", doc_location, {})
                 if doc.first.nil?
@@ -217,9 +221,8 @@ class Oydid
                 currentDID["termination_log_id"] = i
 
                 doc_did = currentDID["did"]
-                doc_location = get_location(doc_did)
                 did_hash = doc_did.delete_prefix("did:oyd:")
-                did_hash = did_hash.split("@").first
+                did_hash = did_hash.split(LOCATION_PREFIX).first
                 did10 = did_hash[0,10]
                 doc = retrieve_document_raw(doc_did, did10 + ".doc", doc_location, {})
                 # since it retrieves a DID that previously existed, this test is not necessary
@@ -230,11 +233,11 @@ class Oydid
                 # end
                 doc = doc.first["doc"]
                 term = doc["log"]
-                log_location = term.split("@")[1] rescue ""
+                log_location = term.split(LOCATION_PREFIX)[1] rescue ""
                 if log_location.to_s == ""
                     log_location = DEFAULT_LOCATION
                 end
-                term = term.split("@").first
+                term = term.split(LOCATION_PREFIX).first
                 if hash(canonical(el)) != term
                     currentDID["error"] = 1
                     currentDID["message"] = "Log reference and record don't match"
@@ -256,7 +259,7 @@ class Oydid
                 # check if there is a revocation entry
                 revocation_record = {}
                 revoc_term = el["doc"]
-                revoc_term = revoc_term.split("@").first
+                revoc_term = revoc_term.split(LOCATION_PREFIX).first
                 revoc_term_found = false
                 log_array, msg = retrieve_log(did_hash, did10 + ".log", log_location, options)
                 log_array.each do |log_el|
@@ -321,9 +324,9 @@ class Oydid
                                         currentDID["verification"] += "of next DID Document (Details: https://ownyourdata.github.io/oydid/#verify_signature)" + "\n"
 
                                         next_doc_did = log_el["doc"].to_s
-                                        next_doc_location = get_location(next_doc_did)
+                                        next_doc_location = doc_location
                                         next_did_hash = next_doc_did.delete_prefix("did:oyd:")
-                                        next_did_hash = next_did_hash.split("@").first
+                                        next_did_hash = next_did_hash.split(LOCATION_PREFIX).first
                                         next_did10 = next_did_hash[0,10]
                                         next_doc = retrieve_document_raw(next_doc_did, next_did10 + ".doc", next_doc_location, {})
                                         if next_doc.first.nil?
@@ -342,9 +345,9 @@ class Oydid
                                     currentDID["message"] = "Signature does not match"
                                     if verification_output
                                         new_doc_did = log_el["doc"].to_s
-                                        new_doc_location = get_location(new_doc_did)
+                                        new_doc_location = doc_location
                                         new_did_hash = new_doc_did.delete_prefix("did:oyd:")
-                                        new_did_hash = new_did_hash.split("@").first
+                                        new_did_hash = new_did_hash.split(LOCATION_PREFIX).first
                                         new_did10 = new_did_hash[0,10]
                                         new_doc = retrieve_document(new_doc_did, new_did10 + ".doc", new_doc_location, {}).first
                                         currentDID["verification"] += "found UPDATE log record:" + "\n"

data/lib/oydid.rb

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 require 'dag'
+require 'jwt'
 require 'rbnacl'
 require 'ed25519'
 require 'httparty'
@@ -11,6 +12,7 @@ require 'multicodecs'
 require 'json/canonicalization'
 require 'oydid/basic'
 require 'oydid/log'
+require 'oydid/didcomm'
 
 class Oydid
 
@@ -137,6 +139,11 @@ class Oydid
         return write(content, did, "update", options)
     end
 
+    def self.simulate_did(content, did, mode, options)
+        user_did, didDocument, revoc_log, l1, l2, r1, privateKey, revocationKey, did_old, log_old, msg = Oydid.generate_base(content, did, mode, options)
+        return [user_did, msg]
+    end
+    
     def self.generate_base(content, did, mode, options)
         # input validation
         did_doc = JSON.parse(content.to_json) rescue nil
@@ -147,7 +154,7 @@ class Oydid
         log_old = nil
         prev_hash = []
         revoc_log = nil
-        doc_location = options[:doc_location]
+        doc_location = options[:location]
         if options[:ts].nil?
             ts = Time.now.to_i
         else
@@ -670,14 +677,13 @@ class Oydid
         wd = {}
         wd["@context"] = "https://www.w3.org/ns/did/v1"
         wd["id"] = did
-        wd["assertionMethod"] = [{
-            "id": did,
+        wd["verificationMethod"] = [{
+            "id": did + "#key-doc",
             "type": "Ed25519VerificationKey2020",
             "controller": did,
             "publicKeyMultibase": pubDocKey
-        }]
-        wd["keyAgreement"] = [{
-            "id": did,
+        },{
+            "id": did + "#key-rev",
             "type": "Ed25519VerificationKey2020",
             "controller": did,
             "publicKeyMultibase": pubRevKey

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oydid
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.4
 platform: ruby
 authors:
 - Christoph Fabianek
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-13 00:00:00.000000000 Z
+date: 2022-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dag
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.9
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.1
 - !ruby/object:Gem::Dependency
   name: rbnacl
   requirement: !ruby/object:Gem::Requirement
@@ -148,6 +162,7 @@ files:
 - VERSION
 - lib/oydid.rb
 - lib/oydid/basic.rb
+- lib/oydid/didcomm.rb
 - lib/oydid/log.rb
 - spec/input/basic/arrays.json
 - spec/input/basic/french.json