noise-ruby 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b311addeddc717377b96beaecbe50300759ea5d6
-  data.tar.gz: 2979832b1b009280a5998de859bead7cae613b00
+  metadata.gz: 61342d193c1bb42324605f5be2643542fac0bc2b
+  data.tar.gz: 44dec9620e075573cf4af4b44367506c45e71b8b
 SHA512:
-  metadata.gz: 176002bdc3b0763255c0c2679485e38aa9d9795477dd7d789f40cebaa2154ae877fcec6593ab0409f095447cfd49f565aac8216053742bc3dce3572fc9a67253
-  data.tar.gz: ac57838f8ab1e3a0f8910dae97cb8d28a8b9a83bec9b6e433316c062c1f2c09465c149ace734db23d0da6360bb5c1f12545f3ad858f72a87cca045ae89554ad9
+  metadata.gz: 4e613f8379f2309a540b1e5a9a9b2f884220fcb39387720a1b5ee978fbb0e698f013ba09435e6a2834c45c5534d413b8d8fd76159bc90a748b219417d49b3fa7
+  data.tar.gz: 72b2c24e768d729b67d6a54d26efb71b0acbed829a66725113ce0a953092a6e6543801bf0f936c3ac80dfa11dd3870d02b74ba556d11eff6c7efe4bfb8cca579

data/.rubocop.yml

@@ -4,6 +4,9 @@ Metrics/BlockLength:
 Metrics/LineLength:
   Max: 120
 
+Metrics/MethodLength:
+  Max: 30
+
 Style/Documentation:
   Enabled: false
 
@@ -18,4 +21,3 @@ Style/WordArray:
 
 AllCops:
   TargetRubyVersion: 2.4.1
-

data/Gemfile

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in noise.gemspec
 gemspec

data/README.md

@@ -6,7 +6,8 @@ A Ruby implementation of the Noise Protocol framework(http://noiseprotocol.org/)
 
 Secp256k1 cipher function is supported.
 This is required for Lightning Network, layer-2 protocol for bitcoin.
-see 
+
+see https://github.com/lightningnetwork/lightning-rfc/blob/master/08-transport.md
 
 ## Future Works
 
@@ -19,6 +20,15 @@ The followings are not supported yet.
 
 ## Installation
 
+This library requires [libsecp256k1](https://github.com/bitcoin-core/secp256k1).
+
+    $ git clone https://github.com/bitcoin-core/secp256k1
+    $ cd secp256k1
+    $ ./autogen.sh
+    $ ./configure --enable-experimental --enable-module-ecdh --enable-module-recovery --enable-benchmark=false
+    $ make
+    $ sudo make install
+
 Add this line to your application's Gemfile:
 
 ```

data/Rakefile

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/lib/noise/connection.rb

@@ -1,12 +1,6 @@
 # frozen_string_literal: true
 
 module Noise
-  module KeyPair
-    STATIC = 's'
-    EPHEMERAL = 'e'
-    REMOTE_STATIC = 'rs'
-    REMOTE_EPHEMERAL = 're'
-  end
   class Connection
     module Status
       STATIC = 1
@@ -22,8 +16,8 @@ module Noise
       @handshake_started = false
       @handshake_finished = false
       @fn = nil
-      @write_message_proc = lambda {|payload| write_message(payload)}
-      @read_message_proc = lambda {|payload| read_message(payload)}
+      @write_message_proc = ->(payload) { write_message(payload) }
+      @read_message_proc = ->(payload) { read_message(payload) }
     end
 
     def psks=(psks)

data/lib/noise/functions/cipher/cha_cha_poly.rb

@@ -15,7 +15,7 @@ module Noise
         end
 
         def nonce_to_bytes(n)
-          "\00" * 4 + sprintf('%16x', n).htb.reverse
+          "\00" * 4 + format('%16x', n).htb.reverse
         end
       end
     end

data/lib/noise/functions/dh/secp256k1.rb

@@ -15,15 +15,12 @@ module Noise
         end
 
         def dh(private_key, public_key)
-          group = ECDSA::Group::Secp256k1
-          point = ECDSA::Format::PointOctetString.decode(public_key, group)
-          scalar = ECDSA::Format::IntegerOctetString.decode(private_key)
-          point = point.multiply_by_scalar(scalar)
-          ECDSA::Format::PointOctetString.encode(point, compression: true)
+          key = ::Secp256k1::PublicKey.new(pubkey: public_key, raw: true)
+          key.ecdh(private_key)
         end
 
         def dhlen
-          64
+          33
         end
 
         def self.from_private(private_key)

data/lib/noise/key_pair.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Noise
+  module KeyPair
+    STATIC = 's'
+    EPHEMERAL = 'e'
+    REMOTE_STATIC = 'rs'
+    REMOTE_EPHEMERAL = 're'
+  end
+end

data/lib/noise/pattern.rb

@@ -12,7 +12,7 @@ module Noise
   end
 
   class Pattern
-    attr_reader :one_way, :tokens, :modifiers
+    attr_reader :one_way, :tokens, :modifiers, :psk_count
 
     def self.create(name)
       pattern_set = name.scan(/([A-Z]+)([^A-Z]*)/)&.first
@@ -35,15 +35,9 @@ module Noise
     def apply_pattern_modifiers
       @modifiers.each do |modifier|
         if modifier.start_with?('psk')
-          begin
-            index = modifier.gsub(/psk/, '').to_i
-          rescue
-            raise Noise::Exceptions::PSKValueError
-          end
-          # if index * 2 > @tokens.size
-          #   raise PSKValueError
-          # end
-          if index == 0
+          index = modifier.gsub(/psk/, '').to_i
+          raise Noise::Exceptions::PSKValueError if index / 2 > @tokens.size
+          if index.zero?
             @tokens[0].insert(0, Token::PSK)
           else
             @tokens[index - 1] << Token::PSK

data/lib/noise/protocol.rb

@@ -17,7 +17,8 @@ module Noise
 
     DH = {
       '25519': Noise::Functions::DH::ED25519,
-      '448': Noise::Functions::DH::ED448
+      '448': Noise::Functions::DH::ED448,
+      'secp256k1': Noise::Functions::DH::Secp256k1
     }.stringify_keys.freeze
 
     HASH = {
@@ -36,16 +37,20 @@ module Noise
     def initialize(name, pattern_name, cipher_name, hash_name, dh_name)
       @name = name
       @pattern = Noise::Pattern.create(pattern_name)
-      @keypairs = { s: nil, e: nil, rs: nil, re: nil }
-      @cipher_fn = CIPHER[cipher_name]&.new
-      @hash_fn = HASH[hash_name]&.new
-      @dh_fn = DH[dh_name]&.new
+      @keypairs = { s: [], e: [], rs: [], re: [] }
       @hkdf_fn = Noise::Functions::Hash.create_hkdf_fn(hash_name)
-      @psks = nil
+      @psks = []
       @is_psk_handshake = @pattern.modifiers.any? { |m| m.start_with?('psk') }
 
       @pattern.apply_pattern_modifiers
 
+      initialize_fn!(cipher_name, hash_name, dh_name)
+    end
+
+    def initialize_fn!(cipher_name, hash_name, dh_name)
+      @cipher_fn = CIPHER[cipher_name]&.new
+      @hash_fn = HASH[hash_name]&.new
+      @dh_fn = DH[dh_name]&.new
       raise Noise::Exceptions::ProtocolNameError unless @cipher_fn && @hash_fn && @dh_fn
     end
 
@@ -66,38 +71,36 @@ module Noise
       @dh_fn = nil
       @hash_fn = nil
       @keypair_fn = nil
+    end
+
+    def validate_psk!
+      # Invalid psk length! Has to be 32 bytes long
+      raise Noise::Exceptions::NoisePSKError if @psks.any? { |psk| psk.bytesize != 32 }
+      # Bad number of PSKs provided to this protocol! {} are required,
+      # given {}'.format(self.pattern.psk_count, len(self.psks)))
+      raise Noise::Exceptions::NoisePSKError if @pattern.psk_count != @psks.count
+    end
 
+    def valid_keypairs?
+      @pattern.required_keypairs(@initiator).any? { |keypair| !@keypairs[keypair] }
     end
 
     def validate
-      if psk_handshake?
-        if @psks.any? {|psk| psk.bytesize != 32}
-          raise NoisePSKError # Invalid psk length! Has to be 32 bytes long
-        end
-        if @pattern.psk_count != @psks.count
-          # Bad number of PSKs provided to this protocol! {} are required,
-          # given {}'.format(self.pattern.psk_count, len(self.psks)))
-          raise NoisePSKError
-        end
-      end
+      validate_psk! if psk_handshake?
 
       # You need to set role with NoiseConnection.set_as_initiator
       # or NoiseConnection.set_as_responder
       raise Noise::Exceptions::NoiseValidationError if @initiator.nil?
 
       # 'Keypair {} has to be set for chosen handshake pattern'.format(keypair)
-      # require 'pp'
-      # pp @pattern
-      # pp @initiator
-      # pp @pattern.required_keypairs(@initiator)
-      # pp @keypairs
-      raise Noise::Exceptions::NoiseValidationError if @pattern.required_keypairs(@initiator).any? { |keypair| !@keypairs[keypair] }
+      raise Noise::Exceptions::NoiseValidationError if valid_keypairs?
 
       if @keypairs[:e] || @keypairs[:re]
         # warnings
         # One of ephemeral keypairs is already set.
         # This is OK for testing, but should NEVER happen in production!
       end
+      true
     end
 
     def initialise_handshake_state
@@ -105,10 +108,7 @@ module Noise
         self,
         @initiator,
         @prologue,
-        @keypairs[:s],
-        @keypairs[:e],
-        @keypairs[:rs],
-        @keypairs[:re]
+        @keypairs
       )
       @symmetric_state = @handshake_state.symmetric_state
     end

data/lib/noise/state/handshake_state.rb

@@ -14,17 +14,17 @@ module Noise
 
       attr_reader :message_patterns, :symmetric_state
 
-      def initialize(protocol, initiator, prologue, s, e, rs, re)
+      def initialize(protocol, initiator, prologue, keypairs)
         # @protocol = handshake_pattern.to_protocol
         @protocol = protocol
         @symmetric_state = SymmetricState.new
         @symmetric_state.initialize_symmetric(@protocol)
         @symmetric_state.mix_hash(prologue)
         @initiator = initiator
-        @s = [s].flatten
-        @e = [e].flatten
-        @rs = [rs].flatten
-        @re = [re].flatten
+        @s = keypairs[:s]
+        @e = keypairs[:e]
+        @rs = keypairs[:rs]
+        @re = keypairs[:re]
 
         # TODO : Calls MixHash() once for each public key listed in the pre-messages from  handshake_pattern, with the
         # specified public key as input (see Section 7 for an explanation of pre-messages). If both initiator and
@@ -60,7 +60,7 @@ module Noise
         pattern.each do |token|
           case token
           when 'e'
-            @e = dh_fn.generate_keypair if @e.compact.empty?
+            @e = dh_fn.generate_keypair if @e.empty?
             message_buffer << @e[1]
             @symmetric_state.mix_hash(@e[1])
             @symmetric_state.mix_key(@e[1]) if @protocol.psk_handshake?
@@ -104,7 +104,7 @@ module Noise
         pattern.each do |token|
           case token
           when 'e'
-            @re = @protocol.dh_fn.class.from_public(message[0...len]) if @re.compact.empty?
+            @re = @protocol.dh_fn.class.from_public(message[0...len]) if @re.empty?
             message = message[len..-1]
             @symmetric_state.mix_hash(@re[1])
             @symmetric_state.mix_key(@re[1]) if @protocol.psk_handshake?

data/lib/noise/state/symmetric_state.rb

@@ -11,14 +11,17 @@ module Noise
       attr_reader :h, :ck
       attr_reader :cipher_state
 
+      def initialize_h(protocol)
+        if protocol.name.length <= protocol.hash_fn.hashlen
+          protocol.name.ljust(protocol.hash_fn.hashlen, "\x00")
+        else
+          protocol.hash_fn.hash(protocol.name)
+        end
+      end
+
       def initialize_symmetric(protocol)
         @protocol = protocol
-        @ck = @h =
-                if @protocol.name.length <= @protocol.hash_fn.hashlen
-                  @protocol.name.ljust(@protocol.hash_fn.hashlen, "\x00")
-                else
-                  @protocol.hash_fn.hash(@protocol.name)
-                end
+        @ck = @h = initialize_h(protocol)
 
         @cipher_state = CipherState.new(cipher: @protocol.cipher_fn)
         @cipher_state.initialize_key(nil)
@@ -59,22 +62,25 @@ module Noise
         plaintext
       end
 
+      def create_cipher_state(k)
+        k = truncate(k)
+        c = CipherState.new(cipher: @protocol.cipher_fn)
+        c.initialize_key(k)
+        c
+      end
+
       def split
         temp_k1, temp_k2 = @protocol.hkdf_fn.call(@ck, '', 2)
-        temp_k1 = truncate(temp_k1)
-        temp_k2 = truncate(temp_k2)
-        c1 = CipherState.new(cipher: @protocol.cipher_fn)
-        c2 = CipherState.new(cipher: @protocol.cipher_fn)
-        c1.initialize_key(temp_k1)
-        c2.initialize_key(temp_k2)
+        c1 = create_cipher_state(temp_k1)
+        c2 = create_cipher_state(temp_k2)
         @protocol.cipher_state_encrypt = @protocol.initiator ? c1 : c2
         @protocol.cipher_state_decrypt = @protocol.initiator ? c2 : c1
         @protocol.handshake_done
         [c1, c2]
       end
 
-      def truncate(temp_k)
-        @protocol.hash_fn.hashlen == 64 ? temp_k[0, 32] : temp_k
+      def truncate(k)
+        @protocol.hash_fn.hashlen == 64 ? k[0, 32] : k
       end
     end
   end

data/lib/noise/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Noise
-  VERSION = '0.3.0'
+  VERSION = '0.5.0'
 end

data/lib/noise.rb

@@ -5,6 +5,7 @@ require 'noise/version'
 require 'ecdsa'
 require 'rbnacl'
 require 'ruby_hmac'
+require 'secp256k1'
 require 'securerandom'
 
 require 'noise/utils/hash'
@@ -12,6 +13,7 @@ require 'noise/utils/string'
 
 module Noise
   autoload :Connection, 'noise/connection'
+  autoload :KeyPair, 'noise/key_pair'
   autoload :Protocol, 'noise/protocol'
   autoload :Pattern, 'noise/pattern'
   autoload :Exceptions, 'noise/exceptions'

data/noise.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.0'
 
   spec.add_runtime_dependency 'aead'
+  spec.add_runtime_dependency 'bitcoin-secp256k1'
   spec.add_runtime_dependency 'ecdsa'
   spec.add_runtime_dependency 'rbnacl'
   spec.add_runtime_dependency 'ruby-hmac'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: noise-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Hajime Yamaguchi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-08 00:00:00.000000000 Z
+date: 2017-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: bitcoin-secp256k1
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ecdsa
   requirement: !ruby/object:Gem::Requirement
@@ -148,6 +162,7 @@ files:
 - lib/noise/functions/hash/blake2s.rb
 - lib/noise/functions/hash/sha256.rb
 - lib/noise/functions/hash/sha512.rb
+- lib/noise/key_pair.rb
 - lib/noise/pattern.rb
 - lib/noise/protocol.rb
 - lib/noise/state.rb