fabric-gateway 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26b462c9b71e8dc9e2926e0c24b7b626cb40e13358fb36418d3ce121692aa579
-  data.tar.gz: aff70180d2bdb947f0107cb3627fb7b95a4bde69068a8dc91acabb742dc78604
+  metadata.gz: 4ebf0356b3eb18ce6a114639e36b2a2c444a3aa527b63e5678eea7fd86322f33
+  data.tar.gz: 3578f40c92ee6828b7f82361bc2cd2480f385c956b03e936aec1ab85d004e1f1
 SHA512:
-  metadata.gz: fb8ad49f7dd5e04c6b4c125fdb19e7b61927c0f622770c85added66ccd4cbcbea36df5a7922de0a0f8fbb1c73b31ebae31ed160e500a8fd601a085c2f2444168
-  data.tar.gz: 9cf3a1b4f2ce340052a31fcfc00f622326f885f833b0b158c5f4d2fc64a85557848c6573f47ce7690369d74d6ef8cc6521992ebe4f47b46bdfb2c8184d94d8ac
+  metadata.gz: c213fa67cf1838f4aaf0d64b82e73f1c3c267dff9d61a622e877e3458072a46e455a4c90302130a35dab0f528eea6e398afa166aad1c7d6435681ef1fac36609
+  data.tar.gz: 99b60025222f359a922a449df21310c4ebc575d4d2453825c376754c24303a8f9fbda2dc9c265c549fd6ee77bf42dff89aa433a1b91948c6a9b2005fc2a51d52

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fabric-gateway (0.0.1)
+    fabric-gateway (0.0.2)
       google-protobuf (>= 3.19.1)
       grpc (~> 1.42)
 
@@ -15,6 +15,7 @@ GEM
     grpc (1.42.0)
       google-protobuf (~> 3.18)
       googleapis-common-protos-types (~> 1.0)
+    grpc-tools (1.42.0)
     rake (12.3.2)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -35,6 +36,7 @@ PLATFORMS
 
 DEPENDENCIES
   fabric-gateway!
+  grpc-tools (~> 1.42)
   rake (~> 12.0)
   rspec (~> 3.0)
 

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 TODO: Write your name
+Copyright (c) 2021 The Ethical Identity Company
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -18,20 +18,56 @@ Or install it yourself as:
 
     $ gem install fabric-gateway
 
-## Usage
+### ISSUES
+
+Note, there is an issue with the grpc library for MacOS (https://github.com/grpc/grpc/issues/28271). It results in a segfault in ruby when trying to make a connection. 
 
-This is a pre-alpha library. None of the code has been tested or confirmed working yet.
+Workaround: Either run on linux or use a docker container as a workaround.
 
+Will update to new version of grpc when fix is released.
 
-non-working notes...
+## Usage
+
+This is a alpha stage library. This library is barely working.
 
 ```
 $ bin/console
 
-# how in the world do we grab a certificate and connect to the peer properly?
-stub=Gateway::Gateway::Stub.new('localhost:7051', :this_channel_is_insecure)
-stub.submit(Gateway::SubmitRequest.new(transaction_id: "123", channel_id: "2", prepared_transaction: Common::Envelope.new()))
 
+def load_certs
+  data_dir ='/your/certs/directory' # aka test-network/organizations
+  files = [
+      'peerOrganizations/org1.example.com/ca/ca.org1.example.com-cert.pem',
+      'peerOrganizations/org1.example.com/users/Admin\@org1.example.com/msp/keystore/9f7c67dd4dd6562d258593c0d5011a3bff9121e65e67ff7fd3212919ae400a88_sk',
+      'peerOrganizations/org1.example.com/users/Admin\@org1.example.com/msp/signcerts/cert.pem'
+    ]
+  files.map { |f| File.open(File.join(data_dir, f)).read }
+end
+
+# needed if you are connecting via a different dns name or IP address
+client_opts = {
+  channel_args: {
+    GRPC::Core::Channel::SSL_TARGET => 'peer0.org1.example.com'
+  }
+}
+
+user_identity = Fabric::Gateway::Identity.new(
+  {
+    username: "admin",
+    affiliation: "org1.department1",
+    mspid: 'Org1MSP',
+    private_key: Fabric::Gateway.crypto_suite.key_from_pem(load_certs[1]),
+    pem_certificate: load_certs[2],
+  }
+)
+
+creds = GRPC::Core::ChannelCredentials.new(load_certs[0])
+client=Gateway::Gateway::Stub.new('localhost:7051', creds, **client_opts)
+proposal = Fabric::Gateway::Proposal.new(user_identity, {channel_id: 'your_channel', chaincode_id: 'basic', args: [ 'GetAllAssets' ]})
+
+response = client.evaluate(Gateway::EvaluateRequest.new(channel_id: "your_channel", proposed_transaction: proposal.signed_proposal))
+
+pp response
 ```
 
 ## Development
@@ -56,8 +92,9 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/ethica
 
 - [x] Add license
 - [x] Add ChangeLog
-- [ ] Create Gem
+- [x] Create Gem
 - [ ] Add usage instructions
+- [ ] Abstract connection and calls such that the protos aren't being interacted directly
 - [ ] Add testing?
 
 
@@ -65,6 +102,8 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/ethica
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
+Portions of the code was utilized from https://github.com/kirshin/hyperledger-fabric-sdk.
+
 ## Code of Conduct
 
 Everyone interacting in the Fabric::Gateway project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ethicalidentity/fabric-gateway/blob/master/CODE_OF_CONDUCT.md).

data/bin/regenerate

@@ -16,3 +16,4 @@ grpc_tools_ruby_protoc -I ./fabric-protos --ruby_out=./lib --grpc_out=./lib ./fa
 grpc_tools_ruby_protoc -I ./fabric-protos --ruby_out=./lib --grpc_out=./lib ./fabric-protos/orderer/ab.proto
 grpc_tools_ruby_protoc -I ./fabric-protos --ruby_out=./lib --grpc_out=./lib ./fabric-protos/gossip/message.proto
 grpc_tools_ruby_protoc -I ./fabric-protos --ruby_out=./lib --grpc_out=./lib ./fabric-protos/msp/msp_principal.proto
+grpc_tools_ruby_protoc -I ./fabric-protos --ruby_out=./lib --grpc_out=./lib ./fabric-protos/msp/identities.proto

data/fabric-gateway.gemspec

@@ -28,4 +28,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.add_dependency('google-protobuf', '>= 3.19.1')
   spec.add_dependency('grpc', '~> 1.42')
+  spec.add_development_dependency('grpc-tools','~> 1.42')
 end

data/lib/fabric/gateway/client.rb

@@ -0,0 +1,13 @@
+module Fabric
+  module Gateway
+    class Client
+      attr_accessor :identity
+      attr_accessor :connection
+
+      def initialize(connection, identity) 
+        self.identity = identity
+        self.connection = connection
+      end
+    end
+  end
+end

data/lib/fabric/gateway/constants.rb

@@ -0,0 +1,20 @@
+module Fabric
+  module Gateway
+    module Constants
+      ## System Chaincodes
+      LSCC = 'lscc'.freeze
+      QSCC = 'qscc'.freeze
+      CSCC = 'cscc'.freeze
+
+      ## System Channels
+      SYSTEM_CHANNEL_NAME = 'testchainid'.freeze
+
+      ## System Functions
+      FUNC_GET_CHANNELS = 'GetChannels'.freeze
+      FUNC_GET_CONFIG_BLOCK = 'GetConfigBlock'.freeze
+
+      ## Variables
+      CHANNEL_HEADER_VERSION = 1
+    end
+  end
+end

data/lib/fabric/gateway/ec_crypto_suite.rb

@@ -0,0 +1,172 @@
+require 'openssl'
+
+module Fabric
+  module Gateway
+    # Elliptic-curve Crypto Suite using OpenSSL
+    class ECCryptoSuite
+      DEFAULT_KEY_SIZE = 256
+      DEFAULT_DIGEST_ALGORITHM = 'SHA256'.freeze
+      DEFAULT_AES_KEY_SIZE = 128
+    
+      EC_CURVES = { 256 => 'prime256v1', 384 => 'secp384r1' }.freeze
+    
+      CIPHER = 'aes-256-cbc'.freeze
+    
+      attr_reader :key_size, :digest_algorithm, :digest, :curve, :cipher
+    
+      def initialize(opts = {})
+        @key_size = opts[:key_size] || DEFAULT_KEY_SIZE
+        @digest_algorithm = opts[:digest_algorithm] || DEFAULT_DIGEST_ALGORITHM
+        @digest = OpenSSL::Digest.new digest_algorithm
+        @curve = EC_CURVES[key_size]
+        @cipher = opts[:cipher] || CIPHER
+      end
+    
+      def sign(private_key, message)
+        digest = digest message
+        key = pkey_from_private_key private_key
+        signature = key.dsa_sign_asn1 digest
+        sequence = OpenSSL::ASN1.decode signature
+        sequence = prevent_malleability sequence, key.group.order
+    
+        sequence.to_der
+      end
+    
+      def generate_private_key
+        key = OpenSSL::PKey::EC.new curve
+        key.generate_key!
+        
+        key.private_key.to_s(16).downcase
+      end
+    
+      def generate_csr(private_key, attrs = [])
+        key = pkey_from_private_key private_key
+    
+        req = OpenSSL::X509::Request.new
+        req.public_key = key
+        req.subject = OpenSSL::X509::Name.new attrs
+        req.sign key, @digest
+    
+        req
+      end
+    
+      def generate_nonce(length = 24)
+        OpenSSL::Random.random_bytes length
+      end
+    
+      def hexdigest(message)
+        @digest.hexdigest message
+      end
+    
+      def digest(message)
+        @digest.digest message
+      end
+    
+      def encode_hex(bytes)
+        bytes.unpack('H*').first
+      end
+    
+      def decode_hex(string)
+        [string].pack('H*')
+      end
+    
+      def keccak256(bytes)
+        OpenSSL::Digest.new('SHA3-256').digest bytes
+      end
+
+    
+      def restore_public_key(private_key)
+        private_bn = OpenSSL::BN.new private_key, 16
+        group = OpenSSL::PKey::EC::Group.new curve
+        public_bn = group.generator.mul(private_bn).to_bn
+        public_bn = OpenSSL::PKey::EC::Point.new(group, public_bn).to_bn
+    
+        public_bn.to_s(16).downcase
+      end
+    
+      def address_from_public_key(public_key)
+        bytes = decode_hex public_key
+        address_bytes = keccak256(bytes[1..-1])[-20..-1]
+    
+        encode_hex address_bytes
+      end
+    
+      def build_shared_key(private_key, public_key)
+        pkey = pkey_from_private_key private_key
+        public_bn = OpenSSL::BN.new public_key, 16
+        group = OpenSSL::PKey::EC::Group.new curve
+        public_point = OpenSSL::PKey::EC::Point.new group, public_bn
+    
+        encode_hex pkey.dh_compute_key(public_point)
+      end
+    
+      def encrypt(secret, data)
+        aes = OpenSSL::Cipher.new cipher
+        aes.encrypt
+        aes.key = decode_hex(secret)
+        iv = aes.random_iv
+        aes.iv = iv
+    
+        Base64.strict_encode64(iv + aes.update(data) + aes.final)
+      end
+    
+      def decrypt(secret, data)
+        return unless data
+    
+        encrypted_data = Base64.strict_decode64 data
+        aes = OpenSSL::Cipher.new cipher
+        aes.decrypt
+        aes.key = decode_hex(secret)
+        aes.iv = encrypted_data[0..15]
+        encrypted_data = encrypted_data[16..-1]
+    
+        aes.update(encrypted_data) + aes.final
+      end
+
+      def pkey_pem_from_private_key(private_key)
+        public_key = restore_public_key private_key
+        key = OpenSSL::PKey::EC.new curve
+        key.private_key = OpenSSL::BN.new private_key, 16
+        key.public_key = OpenSSL::PKey::EC::Point.new key.group,
+                                                      OpenSSL::BN.new(public_key, 16)
+
+        pkey = OpenSSL::PKey::EC.new(key.public_key.group)
+        pkey.public_key = key.public_key
+
+        pkey.to_pem
+      end
+
+      def key_from_pem(pem)
+        key = OpenSSL::PKey::EC.new(pem)
+        key.private_key.to_s(16)
+      end
+
+      def pkey_from_x509_certificate(certificate)
+        cert = OpenSSL::X509::Certificate.new(certificate)
+        cert.public_key.public_key.to_bn.to_s(16)
+      end
+    
+      private
+    
+      def pkey_from_private_key(private_key)
+        public_key = restore_public_key private_key
+        key = OpenSSL::PKey::EC.new curve
+        key.private_key = OpenSSL::BN.new private_key, 16
+        key.public_key = OpenSSL::PKey::EC::Point.new key.group,
+                                                      OpenSSL::BN.new(public_key, 16)
+    
+        key
+      end
+    
+      def prevent_malleability(sequence, order)
+        half_order = order >> 1
+    
+        if (half_key = sequence.value[1].value) > half_order
+          sequence.value[1].value = order - half_key
+        end
+    
+        sequence
+      end
+    end
+  end
+  end

data/lib/fabric/gateway/identity.rb

@@ -0,0 +1,47 @@
+require 'msp/identities_pb'
+require 'base64'
+
+module Fabric
+  module Gateway
+    class Identity
+      attr_reader :private_key,
+                  :public_key,
+                  :address,
+                  :crypto_suite
+
+      attr_accessor :pem_certificate, :certificate, :mspid
+
+      def initialize(opts = {})
+        @crypto_suite = opts[:crypto_suite] || Fabric::Gateway.crypto_suite
+
+        @private_key = opts[:private_key] || @crypto_suite.generate_private_key
+        @public_key = opts[:public_key] || @crypto_suite.restore_public_key(private_key)
+        @certificate = opts[:certificate]
+        @pem_certificate = opts[:pem_certificate]
+        @mspid = opts[:mspid]
+
+        @address = @crypto_suite.address_from_public_key public_key
+      end
+
+      def generate_csr(attrs = [])
+        @crypto_suite.generate_csr private_key, attrs
+      end
+
+      def sign(message)
+        @crypto_suite.sign(private_key, message)
+      end
+
+      def shared_secret_by(public_key)
+        @crypto_suite.build_shared_key private_key, public_key
+      end
+
+      def decoded_certificate
+        Base64.strict_decode64 certificate
+      end
+
+      def serialize
+        Msp::SerializedIdentity.new(mspid: mspid, id_bytes: pem_certificate).to_proto
+      end
+    end
+  end
+end

data/lib/fabric/gateway/proposal.rb

@@ -0,0 +1,105 @@
+module Fabric
+  module Gateway
+    class Proposal
+      attr_reader :identity, :request
+
+      def initialize(identity, request = {})
+        @identity = identity
+        @request = request
+
+        assign_tx request[:transaction_info] if request[:transaction_info]
+      end
+
+      def crypto_suite
+        identity.crypto_suite
+      end
+
+      def nonce
+        @nonce ||= crypto_suite.generate_nonce
+      end
+
+      def channel_id
+        request[:channel_id]
+      end
+
+      def chaincode_id
+        request[:chaincode_id]
+      end
+
+      def args
+        request[:args].compact.map &:to_s
+      end
+
+      def transient
+        request[:transient] || {}
+      end
+
+      def transaction_id
+        request[:transaction_id]
+      end
+
+      def tx_id
+        @tx_id ||= crypto_suite.hexdigest(nonce + identity.serialize)
+      end
+
+      def proposal
+        @proposal ||= Protos::Proposal.new header: header.to_proto,
+                                          payload: chaincode_proposal.to_proto
+      end
+
+      def signed_proposal
+        proposal_bytes = proposal.to_proto
+        signature = identity.sign proposal_bytes
+
+        Protos::SignedProposal.new proposal_bytes: proposal_bytes, signature: signature
+      end
+
+      def header
+        Common::Header.new channel_header: channel_header.to_proto,
+                          signature_header: signature_header.to_proto
+      end
+
+      def channel_header
+        Common::ChannelHeader.new type: Common::HeaderType::ENDORSER_TRANSACTION,
+                                  channel_id: channel_id, tx_id: tx_id,
+                                  extension: channel_header_extension.to_proto,
+                                  timestamp: tx_timestamp,
+                                  version: Constants::CHANNEL_HEADER_VERSION
+      end
+
+      def channel_header_extension
+        id = Protos::ChaincodeID.new name: chaincode_id
+
+        Protos::ChaincodeHeaderExtension.new chaincode_id: id
+      end
+
+      def tx_timestamp
+        now = Time.now
+
+        @tx_timestamp ||= Google::Protobuf::Timestamp.new seconds: now.to_i, nanos: now.nsec
+      end
+
+      def signature_header
+        Common::SignatureHeader.new creator: identity.serialize, nonce: nonce
+      end
+
+      def chaincode_proposal
+        id = Protos::ChaincodeID.new name: chaincode_id
+        chaincode_input = Protos::ChaincodeInput.new args: args
+        chaincode_spec = Protos::ChaincodeSpec.new type: Protos::ChaincodeSpec::Type::NODE,
+                                                  chaincode_id: id,
+                                                  input: chaincode_input
+        input = Protos::ChaincodeInvocationSpec.new chaincode_spec: chaincode_spec
+
+        Protos::ChaincodeProposalPayload.new input: input.to_proto, TransientMap: transient
+      end
+
+      private
+
+      def assign_tx(transaction_info)
+        @tx_id = transaction_info[:tx_id]
+        @nonce = crypto_suite.decode_hex transaction_info[:nonce_hex]
+      end
+    end
+  end
+end

data/lib/fabric/gateway/version.rb

@@ -1,5 +1,5 @@
 module Fabric
   module Gateway
-    VERSION = "0.0.2"
+    VERSION = "0.1.0"
   end
 end

data/lib/fabric/gateway.rb

@@ -1,10 +1,21 @@
+require "fabric/gateway/client"
+require "fabric/gateway/constants"
+require 'fabric/gateway/ec_crypto_suite'
+require 'fabric/gateway/identity'
+require "fabric/gateway/proposal"
 require "fabric/gateway/version"
+
+
 require "gateway/gateway_pb"
 require "gateway/gateway_services_pb"
 
 module Fabric
   module Gateway
     class Error < StandardError; end
-    # Your code goes here...
+
+
+    def self.crypto_suite(opts = {})
+      @crypto_suite ||= Fabric::Gateway::ECCryptoSuite.new opts
+    end
   end
 end

data/lib/msp/identities_pb.rb

@@ -0,0 +1,25 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: msp/identities.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("msp/identities.proto", :syntax => :proto3) do
+    add_message "msp.SerializedIdentity" do
+      optional :mspid, :string, 1
+      optional :id_bytes, :bytes, 2
+    end
+    add_message "msp.SerializedIdemixIdentity" do
+      optional :nym_x, :bytes, 1
+      optional :nym_y, :bytes, 2
+      optional :ou, :bytes, 3
+      optional :role, :bytes, 4
+      optional :proof, :bytes, 5
+    end
+  end
+end
+
+module Msp
+  SerializedIdentity = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("msp.SerializedIdentity").msgclass
+  SerializedIdemixIdentity = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("msp.SerializedIdemixIdentity").msgclass
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fabric-gateway
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Jonathan Chan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-15 00:00:00.000000000 Z
+date: 2021-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.42'
+- !ruby/object:Gem::Dependency
+  name: grpc-tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.42'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.42'
 description: 'Hyperledger Fabric Gateway gRPC SDK generated directly from protos found
   at: https://github.com/hyperledger/fabric-protos.'
 email:
@@ -67,11 +81,17 @@ files:
 - lib/common/policies_pb.rb
 - lib/fabric/.DS_Store
 - lib/fabric/gateway.rb
+- lib/fabric/gateway/client.rb
+- lib/fabric/gateway/constants.rb
+- lib/fabric/gateway/ec_crypto_suite.rb
+- lib/fabric/gateway/identity.rb
+- lib/fabric/gateway/proposal.rb
 - lib/fabric/gateway/version.rb
 - lib/gateway/gateway_pb.rb
 - lib/gateway/gateway_services_pb.rb
 - lib/gossip/message_pb.rb
 - lib/gossip/message_services_pb.rb
+- lib/msp/identities_pb.rb
 - lib/msp/msp_principal_pb.rb
 - lib/orderer/ab_pb.rb
 - lib/orderer/ab_services_pb.rb
@@ -103,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Hyperledger Fabric Gateway gRPC SDK