pplcdid 1.2.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4078f962120d21b5e55d2a62fdb62ee7278375672b31eac6b4d55b343dc381d7
+  data.tar.gz: a38212b89e4fe7ba44c0db3c720da018988879d374bddca123a43120c4fbf280
+SHA512:
+  metadata.gz: 891cc95218461f8f0d9c554579a1ca496fbc98d13e9725602595ba3e73d80ca1d3849eda4d5da2523c748a4cff491169c5e7e196a28003dd3f5eb64558d162d7
+  data.tar.gz: 87bab16182bc655081b600b6c4173c0bc465c274a1d8577c11adeea1a4763cc7a9cf3fdd33a0b6a2d15214a4455e77607f81f88c36928383e73f81fcaf1eb393

data/AUTHORS

@@ -0,0 +1 @@
+* jerry zhang <jerry.zhang.bill@gmail.com>

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [2022] [Peopledata.org]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,2 @@
+# PPLCDID Gem
+PeopleCarbon DID Gem packages.

data/VERSION

@@ -0,0 +1 @@
+1.2.3

data/lib/ppldid/basic.rb

@@ -0,0 +1,278 @@
+# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
+
+class Pplcdid
+
+    # basic functions ---------------------------
+    def self.encode(message, method = "base58btc")
+        Multibases.pack(method, message).to_s
+    end
+
+    def self.decode(message)
+        Multibases.unpack(message).decode.to_s('ASCII-8BIT')
+    end
+
+    def self.hash(message)
+        encode(Multihashes.encode(RbNaCl::Hash.sha256(message), "sha2-256").unpack('C*'))
+    end
+
+    def self.canonical(message)
+        if message.is_a? String
+            message = JSON.parse(message) rescue message
+        else
+            message = JSON.parse(message.to_json) rescue message
+        end
+        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
+            omc = Multicodecs[method].code
+        rescue
+            return [nil, "unknown key codec"]
+        end
+        
+        case Multicodecs[method].name 
+        when 'ed25519-priv'
+            if input != ""
+                raw_key = Ed25519::SigningKey.new(RbNaCl::Hash.sha256(input)).to_bytes
+            else
+                raw_key = Ed25519::SigningKey.generate.to_bytes
+            end
+        else
+            return [nil, "unsupported key codec"]
+        end
+        length = raw_key.bytesize
+        return [encode([omc, length, raw_key].pack("SCa#{length}")), ""]
+    end
+
+    def self.public_key(private_key, method = "ed25519-pub")
+        code, length, digest = decode(private_key).unpack('SCa*')
+        case Multicodecs[code].name
+        when 'ed25519-priv'
+            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[method].code, length, public_key].pack("CCa#{length}")), ""]
+
+        else
+            return [nil, "unsupported key codec"]
+        end
+    end
+
+    def self.sign(message, private_key)
+        code, length, digest = decode(private_key).unpack('SCa*')
+        case Multicodecs[code].name
+        when 'ed25519-priv'
+            return [encode(Ed25519::SigningKey.new(digest).sign(message)), ""]
+        else
+            return [nil, "unsupported key codec"]
+        end
+    end
+
+    def self.verify(message, signature, public_key)
+        begin
+            code, length, digest = decode(public_key).unpack('CCa*')
+            case Multicodecs[code].name
+            when 'ed25519-pub'
+                verify_key = Ed25519::VerifyKey.new(digest)
+                signature_verification = false
+                begin
+                    verify_key.verify(decode(signature), message)
+                    signature_verification = true
+                rescue Ed25519::VerifyError
+                    signature_verification = false
+                end
+                return [signature_verification, ""]
+            else
+                return [nil, "unsupported key codec"]
+            end
+        rescue
+            return [nil, "unknown key codec"]
+        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)
+            key_encoded = f.read
+            f.close
+        rescue
+            return [nil, "cannot read file"]
+        end
+        decode_private_key(key_encoded)
+    end
+
+    def self.decode_private_key(key_encoded)
+        begin
+            code, length, digest = decode(key_encoded).unpack('SCa*')
+            case Multicodecs[code].name
+            when 'ed25519-priv'
+                private_key = Ed25519::SigningKey.new(digest).to_bytes
+            else
+                return [nil, "unsupported key codec"]
+            end
+            length = private_key.bytesize
+            return [pplcdid.encode([code, length, private_key].pack("SCa#{length}")), ""]
+        rescue
+            return [nil, "invalid key"]
+        end
+    end
+
+    # storage functions -----------------------------
+    def self.write_private_storage(payload, filename)
+        File.open(filename, 'w') {|f| f.write(payload)}
+    end
+
+    def self.read_private_storage(filename)
+        begin
+            File.open(filename, 'r') { |f| f.read }
+        rescue
+            nil
+        end
+    end
+
+    def self.get_location(id)
+        if id.include?(LOCATION_PREFIX)
+            id_split = id.split(LOCATION_PREFIX)
+            return id_split[1]
+        else
+            if id.include?(CGI.escape(LOCATION_PREFIX))
+                id_split = id.split(CGI.escape(LOCATION_PREFIX))
+                return id_split[1]
+            else
+                return DEFAULT_LOCATION
+            end
+        end
+    end
+
+    def self.retrieve_document(doc_hash, doc_file, doc_location, options)
+        if doc_location == ""
+            doc_location = DEFAULT_LOCATION
+        end
+        if !(doc_location == "" || doc_location == "local")
+            if !doc_location.start_with?("http")
+                doc_location = "https://" + doc_location
+            end
+        end
+
+        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
+                return [nil, msg]
+            end
+            if options.transform_keys(&:to_s)["trace"]
+                if options[:silent].nil? || !options[:silent]
+                    puts "GET " + doc_hash + " from " + doc_location
+                end
+            end
+            return [retVal.parsed_response, ""]
+        when "", "local"
+            doc = JSON.parse(read_private_storage(doc_file)) rescue {}
+            if doc == {}
+                return [nil, "cannot read file"]
+            else
+                return [doc, ""]
+            end
+        end
+    end
+
+    def self.retrieve_document_raw(doc_hash, doc_file, doc_location, options)
+        if doc_location == ""
+            doc_location = DEFAULT_LOCATION
+        end
+        if !(doc_location == "" || doc_location == "local")
+            if !doc_location.start_with?("http")
+                doc_location = "https://" + doc_location
+            end
+        end
+
+        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
+                return [nil, msg]
+            end
+            if options.transform_keys(&:to_s)["trace"]
+                if options[:silent].nil? || !options[:silent]
+                    puts "GET " + doc_hash + " from " + doc_location
+                end
+            end
+            return [retVal.parsed_response, ""]
+        when "", "local"
+            doc = JSON.parse(read_private_storage(doc_file)) rescue {}
+            log = JSON.parse(read_private_storage(doc_file.sub(".doc", ".log"))) rescue {}
+            if doc == {}
+                return [nil, "cannot read file"]
+            else
+                obj = {"doc" => doc, "log" => log}
+                return [obj, ""]
+            end
+        end
+    end
+
+end

data/lib/ppldid/didcomm.rb

@@ -0,0 +1,120 @@
+# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
+
+class Pplcdid
+
+    # 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 = pplcdid.read(pubkey_did, options)
+        public_key_encoded = pplcdid.w3c(result, options)["authentication"].first["publicKeyMultibase"]
+        begin
+            code, length, digest = pplcdid.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 = pplcdid.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 + "/pplcdid/init",
+                    headers: { 'Content-Type' => 'application/json' },
+                    body: { "session_id": sid }.to_json )
+        challenge = retVal.parsed_response["challenge"]
+        signed_challenge = pplcdid.sign(challenge, pplcdid.generate_private_key(pwd).first).first
+        public_key = pplcdid.public_key(pplcdid.generate_private_key(pwd).first).first
+        retVal = HTTParty.post(host + "/pplcdid/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