noise-ruby 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c16d9319142dc02bcf5e1524c141aaa99a923942
-  data.tar.gz: b926ad7e994d5387fe48fab254b8f5c0ccb124fe
+  metadata.gz: b311addeddc717377b96beaecbe50300759ea5d6
+  data.tar.gz: 2979832b1b009280a5998de859bead7cae613b00
 SHA512:
-  metadata.gz: d1cafc8d1343cba342d73451a6817001faf4e3298fbc239e6e4efb8d1454087f0826602a73c3c503c9d498eafcfe0aca79fd91bfe3eb2ba401bec13d1b12e9fd
-  data.tar.gz: 40dfacc90d63bb5807dc8ce7b13d01beac299f2a62ef405f98971bf5381e6ff6bf9a2c637eedab26a9d451c95c1715c19991c8ed5014aee0ce28cc426944c3f0
+  metadata.gz: 176002bdc3b0763255c0c2679485e38aa9d9795477dd7d789f40cebaa2154ae877fcec6593ab0409f095447cfd49f565aac8216053742bc3dce3572fc9a67253
+  data.tar.gz: ac57838f8ab1e3a0f8910dae97cb8d28a8b9a83bec9b6e433316c062c1f2c09465c149ace734db23d0da6360bb5c1f12545f3ad858f72a87cca045ae89554ad9

data/README.md

@@ -2,6 +2,12 @@
 
 A Ruby implementation of the Noise Protocol framework(http://noiseprotocol.org/).
 
+## Secp256k1
+
+Secp256k1 cipher function is supported.
+This is required for Lightning Network, layer-2 protocol for bitcoin.
+see 
+
 ## Future Works
 
 The followings are not supported yet.
@@ -10,7 +16,6 @@ The followings are not supported yet.
   - Curve448
 - Hash Functions
   - Blake2s
-- PSK Mode
 
 ## Installation
 

data/lib/noise/connection.rb

@@ -22,8 +22,12 @@ module Noise
       @handshake_started = false
       @handshake_finished = false
       @fn = nil
-      @write_message_proc = ->(payload) { write_message(payload) }
-      @read_message_proc = ->(payload) { read_message(payload) }
+      @write_message_proc = lambda {|payload| write_message(payload)}
+      @read_message_proc = lambda {|payload| read_message(payload)}
+    end
+
+    def psks=(psks)
+      @protocol.psks = psks
     end
 
     def prologue=(prologue)

data/lib/noise/exceptions.rb

@@ -6,5 +6,7 @@ module Noise
     autoload :ProtocolNameError, 'noise/exceptions/protocol_name_error'
     autoload :NoiseHandshakeError, 'noise/exceptions/noise_handshake_error'
     autoload :NoiseValidationError, 'noise/exceptions/noise_validation_error'
+    autoload :NoisePSKError, 'noise/exceptions/noise_psk_error'
+    autoload :PSKValueError, 'noise/exceptions/psk_value_error'
   end
 end

data/lib/noise/exceptions/noise_psk_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Noise
+  module Exceptions
+    class NoisePSKError < RuntimeError
+    end
+  end
+end

data/lib/noise/exceptions/psk_value_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Noise
+  module Exceptions
+    class PSKValueError < RuntimeError
+    end
+  end
+end

data/lib/noise/functions/dh.rb

@@ -3,8 +3,8 @@
 module Noise
   module Functions
     module DH
-      autoload :DH448, 'noise/functions/dh/dh448'
-      autoload :DH25519, 'noise/functions/dh/dh25519'
+      autoload :ED448, 'noise/functions/dh/ed448'
+      autoload :ED25519, 'noise/functions/dh/ed25519'
       autoload :Secp256k1, 'noise/functions/dh/secp256k1'
     end
   end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Noise
+  module Functions
+    module DH
+      class ED25519
+        DHLEN = 32
+        def generate_keypair
+          private_key = 1 + SecureRandom.random_number(RbNaCl::GroupElement::STANDARD_GROUP_ORDER - 1)
+          scalar_as_string = ECDSA::Format::IntegerOctetString.encode(private_key, 32)
+          public_key = RbNaCl::GroupElements::Curve25519.base.mult(scalar_as_string)
+          [ECDSA::Format::IntegerOctetString.encode(private_key, 32), public_key.to_bytes]
+        end
+
+        def dh(private_key, public_key)
+          RbNaCl::GroupElement.new(public_key).mult(private_key).to_bytes
+        end
+
+        def dhlen
+          DHLEN
+        end
+
+        def self.from_private(private_key)
+          public_key = RbNaCl::GroupElements::Curve25519.base.mult(private_key)
+          [private_key, public_key.to_bytes]
+        end
+
+        def self.from_public(public_key)
+          [nil, public_key]
+        end
+      end
+    end
+  end
+end

data/lib/noise/functions/dh/{dh448.rb → ed448.rb}

@@ -1,7 +1,7 @@
 module Noise
   module Functions
     module DH
-      class DH448
+      class ED448
         DHLEN = 56
         def generate_keypair
           throw NotImplementedError

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

@@ -8,19 +8,33 @@ module Noise
           group = ECDSA::Group::Secp256k1
           private_key = 1 + SecureRandom.random_number(group.order - 1)
           public_key = group.generator.multiply_by_scalar(private_key)
-          [private_key, public_key]
+          [
+            ECDSA::Format::IntegerOctetString.encode(private_key, 32),
+            ECDSA::Format::PointOctetString.encode(public_key, compression: true)
+          ]
         end
 
         def dh(private_key, public_key)
-          public_key.multiply_by_scalar(private_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)
         end
 
         def dhlen
           64
         end
+
         def self.from_private(private_key)
+          group = ECDSA::Group::Secp256k1
+          scalar = ECDSA::Format::IntegerOctetString.decode(private_key)
+          point = group.generator.multiply_by_scalar(scalar)
+          [private_key, ECDSA::Format::PointOctetString.encode(point, compression: true)]
         end
-        def self.from_public(private_key)
+
+        def self.from_public(public_key)
+          [nil, public_key]
         end
       end
     end

data/lib/noise/pattern.rb

@@ -12,20 +12,49 @@ module Noise
   end
 
   class Pattern
-    attr_reader :one_way, :tokens
+    attr_reader :one_way, :tokens, :modifiers
 
     def self.create(name)
-      class_name = "Noise::Pattern#{name}"
+      pattern_set = name.scan(/([A-Z]+)([^A-Z]*)/)&.first
+      pattern = pattern_set&.first
+      modifiers = pattern_set[1].split('+')
+      class_name = "Noise::Pattern#{pattern}"
       klass = Object.const_get(class_name)
-      klass.new
+      klass.new(modifiers)
     end
 
-    def initialize
+    def initialize(modifiers)
       @pre_messages = [[], []]
       @tokens = []
       @name = ''
       @one_way = false
       @psk_count = 0
+      @modifiers = modifiers
+    end
+
+    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
+            @tokens[0].insert(0, Token::PSK)
+          else
+            @tokens[index - 1] << Token::PSK
+          end
+          @psk_count += 1
+        elsif modifier == 'fallback'
+          raise NotImplementedError
+        else
+          raise Noise::Exceptions::PSKValueError
+        end
+      end
     end
 
     # initiator [Boolean]
@@ -57,15 +86,15 @@ module Noise
   end
 
   class OneWayPattern < Pattern
-    def initialize
-      super
+    def initialize(modifiers)
+      super(modifiers)
       @one_way = true
     end
   end
 
   class PatternN < OneWayPattern
-    def initialize
-      super
+    def initialize(modifiers)
+      super(modifiers)
       @name = 'N'
       @pre_messages = [[], [Token::S]]
       @tokens = [[Token::E, Token::ES]]
@@ -73,8 +102,8 @@ module Noise
   end
 
   class PatternK < OneWayPattern
-    def initialize
-      super
+    def initialize(modifiers)
+      super(modifiers)
       @name = 'K'
       @pre_messages = [[Token::S], [Token::S]]
       @tokens = [[Token::E, Token::ES, Token::SS]]
@@ -82,8 +111,8 @@ module Noise
   end
 
   class PatternX < OneWayPattern
-    def initialize
-      super
+    def initialize(modifiers)
+      super(modifiers)
       @name = 'X'
       @pre_messages = [[], [Token::S]]
       @tokens = [[Token::E, Token::ES, Token::S, Token::SS]]
@@ -91,8 +120,8 @@ module Noise
   end
 
   class PatternNN < Pattern
-    def initialize
-      super
+    def initialize(modifiers)
+      super(modifiers)
       @name = 'NN'
       @pre_messages = []
       @tokens = [[Token::E], [Token::E, Token::EE]]
@@ -100,8 +129,8 @@ module Noise
   end
 
   class PatternKN < Pattern
-    def initialize
-      super
+    def initialize(modifiers)
+      super(modifiers)
       @name = 'KN'
       @pre_messages = [[Token::S], []]
       @tokens = [[Token::E], [Token::E, Token::EE, Token::SE]]
@@ -109,8 +138,8 @@ module Noise
   end
 
   class PatternNK < Pattern
-    def initialize
-      super
+    def initialize(modifiers)
+      super(modifiers)
       @name = 'NK'
       @pre_messages = [[], [Token::S]]
       @tokens = [[Token::E, Token::ES], [Token::E, Token::EE]]
@@ -118,8 +147,8 @@ module Noise
   end
 
   class PatternKK < Pattern
-    def initialize
-      super
+    def initialize(modifiers)
+      super(modifiers)
       @name = 'KK'
       @pre_messages = [[Token::S], [Token::S]]
       @tokens = [[Token::E, Token::ES, Token::SS], [Token::E, Token::EE, Token::SE]]
@@ -127,16 +156,16 @@ module Noise
   end
 
   class PatternNX < Pattern
-    def initialize
-      super
+    def initialize(modifiers)
+      super(modifiers)
       @name = 'NX'
       @tokens = [[Token::E], [Token::E, Token::EE, Token::S, Token::ES]]
     end
   end
 
   class PatternKX < Pattern
-    def initialize
-      super
+    def initialize(modifiers)
+      super(modifiers)
       @name = 'KX'
       @pre_messages = [[Token::S], []]
       @tokens = [[Token::E], [Token::E, Token::EE, Token::SE, Token::S, Token::ES]]
@@ -144,24 +173,24 @@ module Noise
   end
 
   class PatternXN < Pattern
-    def initialize
-      super
+    def initialize(modifiers)
+      super(modifiers)
       @name = 'XN'
       @tokens = [[Token::E], [Token::E, Token::EE], [Token::S, Token::SE]]
     end
   end
 
   class PatternIN < Pattern
-    def initialize
-      super
+    def initialize(modifiers)
+      super(modifiers)
       @name = 'IN'
       @tokens = [[Token::E, Token::S], [Token::E, Token::EE, Token::SE]]
     end
   end
 
   class PatternXK < Pattern
-    def initialize
-      super
+    def initialize(modifiers)
+      super(modifiers)
       @name = 'XK'
       @pre_messages = [[], [Token::S]]
       @tokens = [[Token::E, Token::ES], [Token::E, Token::EE], [Token::S, Token::SE]]
@@ -169,8 +198,8 @@ module Noise
   end
 
   class PatternIK < Pattern
-    def initialize
-      super
+    def initialize(modifiers)
+      super(modifiers)
       @name = 'IK'
       @pre_messages = [[], [Token::S]]
       @tokens = [[Token::E, Token::ES, Token::S, Token::SS], [Token::E, Token::EE, Token::SE]]
@@ -178,16 +207,16 @@ module Noise
   end
 
   class PatternXX < Pattern
-    def initialize
-      super
+    def initialize(modifiers)
+      super(modifiers)
       @name = 'XX'
       @tokens = [[Token::E], [Token::E, Token::EE, Token::S, Token::ES], [Token::S, Token::SE]]
     end
   end
 
   class PatternIX < Pattern
-    def initialize
-      super
+    def initialize(modifiers)
+      super(modifiers)
       @name = 'IX'
       @tokens = [[Token::E, Token::S], [Token::E, Token::EE, Token::SE, Token::S, Token::ES]]
     end

data/lib/noise/protocol.rb

@@ -2,11 +2,13 @@
 
 module Noise
   class Protocol
-    attr_accessor :prologue, :initiator, :cipher_state_encrypt, :cipher_state_decrypt
+    attr_accessor :prologue, :initiator
+    attr_accessor :cipher_state_encrypt, :cipher_state_decrypt
+    attr_accessor :cipher_state_handshake
+    attr_accessor :psks
     attr_reader :name, :cipher_fn, :hash_fn, :dh_fn, :hkdf_fn, :pattern
     attr_reader :handshake_state, :keypairs, :keypair_fn
     attr_reader :handshake_hash
-    attr_accessor :cipher_state_handshake
 
     CIPHER = {
       'AESGCM': Noise::Functions::Cipher::AesGcm,
@@ -14,8 +16,8 @@ module Noise
     }.stringify_keys.freeze
 
     DH = {
-      '25519': Noise::Functions::DH::DH25519,
-      '448': Noise::Functions::DH::DH448
+      '25519': Noise::Functions::DH::ED25519,
+      '448': Noise::Functions::DH::ED448
     }.stringify_keys.freeze
 
     HASH = {
@@ -33,12 +35,17 @@ module Noise
 
     def initialize(name, pattern_name, cipher_name, hash_name, dh_name)
       @name = name
-      @pattern = Noise::Pattern.create(pattern_name[0..1])
+      @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
       @hkdf_fn = Noise::Functions::Hash.create_hkdf_fn(hash_name)
+      @psks = nil
+      @is_psk_handshake = @pattern.modifiers.any? { |m| m.start_with?('psk') }
+
+      @pattern.apply_pattern_modifiers
+
       raise Noise::Exceptions::ProtocolNameError unless @cipher_fn && @hash_fn && @dh_fn
     end
 
@@ -63,14 +70,16 @@ module Noise
     end
 
     def validate
-      # TODO : support PSK
-      # if @psk_handshake
-      #   if @psks.inclueds? {|psk| psk.size != 32}
-      #     raise NoisePSKError
-      #   else
-      #     raise NoisePSKError
-      #   end
-      # end
+      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
 
       # You need to set role with NoiseConnection.set_as_initiator
       # or NoiseConnection.set_as_responder
@@ -103,5 +112,9 @@ module Noise
       )
       @symmetric_state = @handshake_state.symmetric_state
     end
+
+    def psk_handshake?
+      @is_psk_handshake
+    end
   end
 end

data/lib/noise/state/handshake_state.rb

@@ -63,6 +63,7 @@ module Noise
             @e = dh_fn.generate_keypair if @e.compact.empty?
             message_buffer << @e[1]
             @symmetric_state.mix_hash(@e[1])
+            @symmetric_state.mix_key(@e[1]) if @protocol.psk_handshake?
             next
           when 's'
             message_buffer << @symmetric_state.encrypt_and_hash(@s[1])
@@ -87,6 +88,9 @@ module Noise
           when 'ss'
             @symmetric_state.mix_key(dh_fn.dh(@s[0], @rs[1]))
             next
+          when 'psk'
+            @symmetric_state.mix_key_and_hash(@protocol.psks.shift)
+            next
           end
         end
         message_buffer << @symmetric_state.encrypt_and_hash(payload)
@@ -103,6 +107,7 @@ module Noise
             @re = @protocol.dh_fn.class.from_public(message[0...len]) if @re.compact.empty?
             message = message[len..-1]
             @symmetric_state.mix_hash(@re[1])
+            @symmetric_state.mix_key(@re[1]) if @protocol.psk_handshake?
             next
           when 's'
             offset = @protocol.cipher_state_handshake.key? ? 16 : 0
@@ -130,6 +135,9 @@ module Noise
           when 'ss'
             @symmetric_state.mix_key(dh_fn.dh(@s[0], @rs[1]))
             next
+          when 'psk'
+            @symmetric_state.mix_key_and_hash(@protocol.psks.shift)
+            next
           end
         end
         payload_buffer << @symmetric_state.decrypt_and_hash(message)

data/lib/noise/version.rb

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

data/noise.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'noise/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: noise-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Hajime Yamaguchi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-06 00:00:00.000000000 Z
+date: 2017-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -131,15 +131,17 @@ files:
 - lib/noise/exceptions.rb
 - lib/noise/exceptions/max_nonce_error.rb
 - lib/noise/exceptions/noise_handshake_error.rb
+- lib/noise/exceptions/noise_psk_error.rb
 - lib/noise/exceptions/noise_validation_error.rb
 - lib/noise/exceptions/protocol_name_error.rb
+- lib/noise/exceptions/psk_value_error.rb
 - lib/noise/functions.rb
 - lib/noise/functions/cipher.rb
 - lib/noise/functions/cipher/aes_gcm.rb
 - lib/noise/functions/cipher/cha_cha_poly.rb
 - lib/noise/functions/dh.rb
-- lib/noise/functions/dh/dh25519.rb
-- lib/noise/functions/dh/dh448.rb
+- lib/noise/functions/dh/ed25519.rb
+- lib/noise/functions/dh/ed448.rb
 - lib/noise/functions/dh/secp256k1.rb
 - lib/noise/functions/hash.rb
 - lib/noise/functions/hash/blake2b.rb

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

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module Noise
-  module Functions
-    module DH
-      class DH25519
-        DHLEN = 32
-        def generate_keypair
-          private_key = RbNaCl::Signatures::Ed25519::SigningKey.generate
-          public_key = private_key.verify_key
-          [private_key.to_bytes, public_key.to_bytes]
-        end
-
-        def dh(private_key, public_key)
-          point = RbNaCl::GroupElement.new(public_key).mult(private_key)
-          point.to_bytes
-        end
-
-        def dhlen
-          DHLEN
-        end
-
-        def self.from_private(private_key)
-          private_key = RbNaCl::GroupElements::Curve25519.new(private_key)
-          public_key = RbNaCl::GroupElements::Curve25519.base.mult(private_key)
-          [private_key.to_bytes, public_key.to_bytes]
-        end
-
-        def self.from_public(public_key)
-          public_key = RbNaCl::Signatures::Ed25519::VerifyKey.new(public_key)
-          [nil, public_key.to_bytes]
-        end
-      end
-    end
-  end
-end