noise-ruby 0.7.4 → 0.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecfac7577c0e2c49956249076aa5351f4c002fc135341f4bb21b9279cf54ba56
-  data.tar.gz: d65b64e5ce9df56c2ad0599a75fabb4070b9739ff7313961ec0e6b3ab11b68cd
+  metadata.gz: 9016d0344507e501e7a92acab0142a15b1d472303e6dfd92ff5bd0a89e135d34
+  data.tar.gz: 68cc424b0c8e91006df86737fca0d0f7d5ea723a02ac8335a65ad0e7e746ffd9
 SHA512:
-  metadata.gz: be99c89230f89d0f286a4dc1da6aadb10ce06ba64206325381cca8032ae71abec0406d1a957fafe0946791f72f346ef23cce019c74868605280e5fa357287e18
-  data.tar.gz: b11a5a496096daf4f4abe9dbfb6f2bba693ec4b5be2c680be6b42b450d7be89a7f119535f20e46bba7429c1f5024ebd62896922c7a944c24a76d951e2df8df4c
+  metadata.gz: 2c6c80f4b7c4bbafe3ff40788639c8b03bac62bcc75646ce13de59960abafd1fbc0beb68903eb8ca0120853afc46c972cac1428572b52bbb8c9b5019a75af2e9
+  data.tar.gz: 92b6ad660ee6e22acb87dbcd85925fed0bee616e87b8175d1408dfa26bcb0c8fc146a876fa21237bb74b14cc51759a0ed6da320a758d00f1f51991cc899b7bfa

data/lib/noise/connection/base.rb

@@ -11,14 +11,14 @@ module Noise
       def initialize(name, keypairs: { s: nil, e: nil, rs: nil, re: nil })
         @protocol = Protocol.create(name)
 
-        @keypairs = keypairs
         # parameter keypairs[:e] and keypairs[:s] are strings, so should convert Noise::Key object.
-        @keypairs[:e] = @protocol.dh_fn.class.from_private(@keypairs[:e]) if @keypairs[:e]
-        @keypairs[:s] = @protocol.dh_fn.class.from_private(@keypairs[:s]) if @keypairs[:s]
-
+        @local_keypairs = {}
+        @local_keypairs[:e] = @protocol.dh_fn.class.from_private(keypairs[:e]) if keypairs[:e]
+        @local_keypairs[:s] = @protocol.dh_fn.class.from_private(keypairs[:s]) if keypairs[:s]
+        @remote_keys = { rs: keypairs[:rs], re: keypairs[:re] }
         @handshake_started = false
         @handshake_finished = false
-        @next_message = nil
+        initialize_next_message
       end
 
       def start_handshake
@@ -27,13 +27,24 @@ module Noise
         @handshake_started = true
       end
 
+      def fallback(fallback_name)
+        @protocol = Protocol.create(fallback_name)
+        @handshake_started = false
+        @handshake_finished = false
+        # initialize_next_message
+        @local_keypairs = { e: @handshake_state.e, s: @handshake_state.s }
+        @remote_keys = { re: @handshake_state.re, rs: @handshake_state.rs }
+        start_handshake
+      end
+
       def initialise_handshake_state
         @handshake_state = Noise::State::HandshakeState.new(
           self,
           protocol,
           initiator?,
           @prologue,
-          @keypairs
+          @local_keypairs,
+          @remote_keys
         )
         @symmetric_state = @handshake_state.symmetric_state
         @cipher_state_handshake = @symmetric_state.cipher_state
@@ -43,7 +54,6 @@ module Noise
         # Call NoiseConnection.start_handshake first
         raise Noise::Exceptions::NoiseHandshakeError unless @handshake_started
         raise Noise::Exceptions::NoiseHandshakeError if @next_message != :write
-        # Handshake finished. NoiseConnection.encrypt should be used now
         raise Noise::Exceptions::NoiseHandshakeError if @handshake_finished
         @next_message = :read
         buffer = +''
@@ -56,7 +66,6 @@ module Noise
         # Call NoiseConnection.start_handshake first
         raise Noise::Exceptions::NoiseHandshakeError unless @handshake_started
         raise Noise::Exceptions::NoiseHandshakeError if @next_message != :read
-        # Handshake finished. NoiseConnection.encrypt should be used now
         raise Noise::Exceptions::NoiseHandshakeError if @handshake_finished
 
         @next_message = :write
@@ -68,32 +77,28 @@ module Noise
 
       def encrypt(data)
         raise Noise::Exceptions::NoiseHandshakeError unless @handshake_finished
-        # raise Noise::Exceptions::NoiseInvalidMessage
         @cipher_state_encrypt.encrypt_with_ad('', data)
       end
 
       def decrypt(data)
         raise Noise::Exceptions::NoiseHandshakeError unless @handshake_finished
-        # raise Noise::Exceptions::NoiseInvalidMessage
         @cipher_state_decrypt.decrypt_with_ad('', data)
       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 @protocol.pattern.psk_count != @psks.count
       end
 
       def valid_keypairs?
-        @protocol.pattern.required_keypairs(initiator?).any? { |keypair| !@keypairs[keypair] }
+        keypairs = @local_keypairs.merge(@remote_keys)
+        @protocol.pattern.required_keypairs(initiator?).any? { |keypair| !keypairs[keypair] }
       end
 
       def validate
         validate_psk! if psk_handshake?
 
-        # 'Keypair {} has to be set for chosen handshake pattern'.format(keypair)
         raise Noise::Exceptions::NoiseValidationError if valid_keypairs?
         true
       end

data/lib/noise/connection/initiator.rb

@@ -3,8 +3,7 @@
 module Noise
   module Connection
     class Initiator < Base
-      def initialize(name, keypairs: { s: nil, e: nil, rs: nil, re: nil })
-        super
+      def initialize_next_message
         @next_message = :write
       end
 
@@ -15,7 +14,7 @@ module Noise
       def handshake_done(c1, c2)
         super
         @cipher_state_encrypt = c1
-        @cipher_state_decrypt = @protocol.pattern.one_way ? nil : c2
+        @cipher_state_decrypt = @protocol.pattern.one_way? ? nil : c2
       end
     end
   end

data/lib/noise/connection/responder.rb

@@ -3,8 +3,7 @@
 module Noise
   module Connection
     class Responder < Base
-      def initialize(name, keypairs: { s: nil, e: nil, rs: nil, re: nil })
-        super
+      def initialize_next_message
         @next_message = :read
       end
 
@@ -15,7 +14,7 @@ module Noise
       def handshake_done(c1, c2)
         super
         @cipher_state_decrypt = c1
-        @cipher_state_encrypt = @protocol.pattern.one_way ? nil : c2
+        @cipher_state_encrypt = @protocol.pattern.one_way? ? nil : c2
       end
     end
   end

data/lib/noise/exceptions.rb

@@ -11,5 +11,6 @@ module Noise
     autoload :NoiseValidationError, 'noise/exceptions/noise_validation_error'
     autoload :NoisePSKError, 'noise/exceptions/noise_psk_error'
     autoload :PSKValueError, 'noise/exceptions/psk_value_error'
+    autoload :UnsupportedModifierError, 'noise/exceptions/unsupported_modifier_error'
   end
 end

data/lib/noise/exceptions/unsupported_modifier_error.rb

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

data/lib/noise/pattern.rb

@@ -12,10 +12,10 @@ module Noise
   end
 
   class Pattern
-    attr_reader :one_way, :tokens, :modifiers, :psk_count
+    attr_reader :tokens, :modifiers, :psk_count, :fallback
 
     def self.create(name)
-      pattern_set = name.scan(/([A-Z]+)([^A-Z]*)/)&.first
+      pattern_set = name.scan(/([A-Z1]+)([^A-Z]*)/)&.first
       pattern = pattern_set&.first
       modifiers = pattern_set[1].split('+')
       class_name = "Noise::Pattern#{pattern}"
@@ -27,7 +27,6 @@ module Noise
       @pre_messages = [[], []]
       @tokens = []
       @name = ''
-      @one_way = false
       @psk_count = 0
       @modifiers = modifiers
     end
@@ -37,6 +36,7 @@ module Noise
         if modifier.start_with?('psk')
           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
@@ -44,9 +44,9 @@ module Noise
           end
           @psk_count += 1
         elsif modifier == 'fallback'
-          raise NotImplementedError
+          @fallback = true
         else
-          raise Noise::Exceptions::PSKValueError
+          raise Noise::Exceptions::UnsupportedModifierError
         end
       end
     end
@@ -59,14 +59,14 @@ module Noise
     def required_keypairs_of_initiator
       required = []
       required << :s if %w[K X I].include?(@name[0])
-      required << :rs if @one_way || @name[1] == 'K'
+      required << :rs if one_way? || @name[1] == 'K'
       required
     end
 
     def required_keypairs_of_responder
       required = []
       required << :rs if @name[0] == 'K'
-      required << :s if @one_way || %w[K X].include?(@name[1])
+      required << :s if one_way? || %w[K X].include?(@name[1])
       required
     end
 
@@ -77,12 +77,19 @@ module Noise
     def responder_pre_messages
       @pre_messages[1].dup
     end
+
+    def one_way?
+      false
+    end
   end
 
   class OneWayPattern < Pattern
     def initialize(modifiers)
       super(modifiers)
-      @one_way = true
+    end
+
+    def one_way?
+      true
     end
   end
 
@@ -215,4 +222,205 @@ module Noise
       @tokens = [[Token::E, Token::S], [Token::E, Token::EE, Token::SE, Token::S, Token::ES]]
     end
   end
+
+  class DeferredPattern < Pattern
+  end
+
+  class PatternNK1 < DeferredPattern
+    def initialize(modifiers)
+      super(modifiers)
+      @name = 'NK1'
+      @pre_messages = [[], [Token::S]]
+      @tokens = [[Token::E], [Token::E, Token::EE, Token::ES]]
+    end
+  end
+
+  class PatternNX1 < DeferredPattern
+    def initialize(modifiers)
+      super(modifiers)
+      @name = 'NX1'
+      @tokens = [[Token::E], [Token::E, Token::EE, Token::S], [Token::ES]]
+    end
+  end
+
+  class PatternX1N < DeferredPattern
+    def initialize(modifiers)
+      super(modifiers)
+      @name = 'X1N'
+      @tokens = [[Token::E], [Token::E, Token::EE], [Token::S], [Token::SE]]
+    end
+  end
+
+  class PatternX1K < DeferredPattern
+    def initialize(modifiers)
+      super(modifiers)
+      @name = 'X1K'
+      @pre_messages = [[], [Token::S]]
+      @tokens = [[Token::E, Token::ES], [Token::E, Token::EE], [Token::S], [Token::SE]]
+    end
+  end
+
+  class PatternXK1 < DeferredPattern
+    def initialize(modifiers)
+      super(modifiers)
+      @name = 'XK1'
+      @pre_messages = [[], [Token::S]]
+      @tokens = [[Token::E], [Token::E, Token::EE, Token::ES], [Token::S, Token::SE]]
+    end
+  end
+
+  class PatternX1K1 < DeferredPattern
+    def initialize(modifiers)
+      super(modifiers)
+      @name = 'X1K1'
+      @pre_messages = [[], [Token::S]]
+      @tokens = [[Token::E], [Token::E, Token::EE, Token::ES], [Token::S], [Token::SE]]
+    end
+  end
+
+  class PatternX1X < DeferredPattern
+    def initialize(modifiers)
+      super(modifiers)
+      @name = 'X1X'
+      @tokens = [[Token::E], [Token::E, Token::EE, Token::S, Token::ES], [Token::S], [Token::SE]]
+    end
+  end
+
+  class PatternXX1 < DeferredPattern
+    def initialize(modifiers)
+      super(modifiers)
+      @name = 'XX1'
+      @tokens = [[Token::E], [Token::E, Token::EE, Token::S], [Token::ES, Token::S, Token::SE]]
+    end
+  end
+
+  class PatternX1X1 < DeferredPattern
+    def initialize(modifiers)
+      super(modifiers)
+      @name = 'X1X1'
+      @tokens = [[Token::E], [Token::E, Token::EE, Token::S], [Token::ES, Token::S], [Token::SE]]
+    end
+  end
+
+  class PatternK1N < DeferredPattern
+    def initialize(modifiers)
+      super(modifiers)
+      @name = 'K1N'
+      @pre_messages = [[Token::S], []]
+      @tokens = [[Token::E], [Token::E, Token::EE], [Token::SE]]
+    end
+  end
+
+  class PatternK1K < DeferredPattern
+    def initialize(modifiers)
+      super(modifiers)
+      @name = 'K1K'
+      @pre_messages = [[Token::S], [Token::S]]
+      @tokens = [[Token::E, Token::ES], [Token::E, Token::EE], [Token::SE]]
+    end
+  end
+
+  class PatternKK1 < DeferredPattern
+    def initialize(modifiers)
+      super(modifiers)
+      @name = 'KK1'
+      @pre_messages = [[Token::S], [Token::S]]
+      @tokens = [[Token::E], [Token::E, Token::EE, Token::SE, Token::ES]]
+    end
+  end
+
+  class PatternK1K1 < DeferredPattern
+    def initialize(modifiers)
+      super(modifiers)
+      @name = 'K1K1'
+      @pre_messages = [[Token::S], [Token::S]]
+      @tokens = [[Token::E], [Token::E, Token::EE, Token::ES], [Token::SE]]
+    end
+  end
+
+  class PatternK1X < DeferredPattern
+    def initialize(modifiers)
+      super(modifiers)
+      @name = 'K1X'
+      @pre_messages = [[Token::S], []]
+      @tokens = [[Token::E], [Token::E, Token::EE, Token::S, Token::ES], [Token::SE]]
+    end
+  end
+
+  class PatternKX1 < DeferredPattern
+    def initialize(modifiers)
+      super(modifiers)
+      @name = 'KX1'
+      @pre_messages = [[Token::S], []]
+      @tokens = [[Token::E], [Token::E, Token::EE, Token::SE, Token::S], [Token::ES]]
+    end
+  end
+
+  class PatternK1X1 < DeferredPattern
+    def initialize(modifiers)
+      super(modifiers)
+      @name = 'K1X1'
+      @pre_messages = [[Token::S], []]
+      @tokens = [[Token::E], [Token::E, Token::EE, Token::S], [Token::SE, Token::ES]]
+    end
+  end
+
+  class PatternI1N < DeferredPattern
+    def initialize(modifiers)
+      super(modifiers)
+      @name = 'I1N'
+      @tokens = [[Token::E, Token::S], [Token::E, Token::EE], [Token::SE]]
+    end
+  end
+
+  class PatternI1K < DeferredPattern
+    def initialize(modifiers)
+      super(modifiers)
+      @name = 'I1K'
+      @pre_messages = [[], [Token::S]]
+      @tokens = [[Token::E, Token::ES, Token::S], [Token::E, Token::EE], [Token::SE]]
+    end
+  end
+
+  class PatternIK1 < DeferredPattern
+    def initialize(modifiers)
+      super(modifiers)
+      @name = 'IK1'
+      @pre_messages = [[], [Token::S]]
+      @tokens = [[Token::E, Token::S], [Token::E, Token::EE, Token::SE, Token::ES]]
+    end
+  end
+
+  class PatternI1K1 < DeferredPattern
+    def initialize(modifiers)
+      super(modifiers)
+      @name = 'I1K1'
+      @pre_messages = [[], [Token::S]]
+      @tokens = [[Token::E, Token::S], [Token::E, Token::EE, Token::ES], [Token::SE]]
+    end
+  end
+
+  class PatternI1X < DeferredPattern
+    def initialize(modifiers)
+      super(modifiers)
+      @name = 'I1X'
+      @tokens = [[Token::E, Token::S], [Token::E, Token::EE, Token::S, Token::ES], [Token::SE]]
+    end
+  end
+
+  class PatternIX1 < DeferredPattern
+    def initialize(modifiers)
+      super(modifiers)
+      @name = 'IX1'
+      @tokens = [[Token::E, Token::S], [Token::E, Token::EE, Token::SE, Token::S], [Token::ES]]
+    end
+  end
+
+  class PatternI1X1 < DeferredPattern
+    def initialize(modifiers)
+      super(modifiers)
+      @name = 'I1X1'
+      @tokens = [[Token::E, Token::S], [Token::E, Token::EE, Token::S], [Token::SE, Token::ES]]
+    end
+  end
 end

data/lib/noise/state/handshake_state.rb

@@ -18,23 +18,20 @@ module Noise
     #     Each message pattern is a sequence of tokens from the set ("e", "s", "ee", "es", "se", "ss").
     class HandshakeState
       attr_reader :message_patterns, :symmetric_state
-      attr_reader :s, :rs
+      attr_reader :s, :rs, :e, :re
 
-      def initialize(connection, protocol, initiator, prologue, keypairs)
+      def initialize(connection, protocol, initiator, prologue, local_keypairs, remote_keys)
         @connection = connection
         @protocol = protocol
         @symmetric_state = SymmetricState.new
         @symmetric_state.initialize_symmetric(@protocol, connection)
         @symmetric_state.mix_hash(prologue)
         @initiator = initiator
-        @s = keypairs[:s]
-        @e = keypairs[:e]
-        @rs = keypairs[:rs]
-        @re = keypairs[:re]
+        @s = local_keypairs[:s]
+        @e = local_keypairs[:e]
+        @rs = remote_keys[:rs]
+        @re = remote_keys[: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
-        # responder have pre-messages, the initiator's public keys are hashed first.
         get_local_keypair = ->(token) { instance_variable_get('@' + token).public_key }
         get_remote_keypair = ->(token) { instance_variable_get('@r' + token) }
 
@@ -46,17 +43,45 @@ module Noise
           responder_keypair_getter = get_local_keypair
         end
 
+        # Sets message_patterns to the message patterns from handshake_pattern
+        @message_patterns = @protocol.pattern.tokens.dup
+
         @protocol.pattern.initiator_pre_messages&.map do |message|
           keypair = initiator_keypair_getter.call(message)
           @symmetric_state.mix_hash(keypair)
         end
 
+        if @protocol.pattern.fallback
+          message = @message_patterns.delete_at(0).first
+          public_key = initiator_keypair_getter.call(message)
+          @symmetric_state.mix_hash(public_key)
+        end
+
         @protocol.pattern.responder_pre_messages&.map do |message|
           keypair = responder_keypair_getter.call(message)
           @symmetric_state.mix_hash(keypair)
         end
-        # Sets message_patterns to the message patterns from handshake_pattern
-        @message_patterns = @protocol.pattern.tokens.dup
+      end
+
+      def expected_message_length(payload_size)
+        has_key = @symmetric_state.cipher_state.key?
+        pattern = @message_patterns.first
+        len = pattern.inject(0) do |len, token|
+          case token
+          when 'e'
+            len += @protocol.dh_fn.dhlen
+            has_key = true if @protocol.psk_handshake?
+          when 's'
+            len += @protocol.dh_fn.dhlen
+            len += 16 if has_key
+          when 'ee', 'es', 'se', 'ss', 'psk'
+            has_key = true
+          end
+          len
+        end
+        len += payload_size
+        len += 16 if has_key
+        len
       end
 
       # Takes a payload byte sequence which may be zero-length, and a message_buffer to write the output into

data/lib/noise/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: noise-ruby
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 0.8.4
 platform: ruby
 authors:
 - Hajime Yamaguchi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-30 00:00:00.000000000 Z
+date: 2019-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -141,6 +141,7 @@ files:
 - lib/noise/exceptions/noise_validation_error.rb
 - lib/noise/exceptions/protocol_name_error.rb
 - lib/noise/exceptions/psk_value_error.rb
+- lib/noise/exceptions/unsupported_modifier_error.rb
 - lib/noise/functions.rb
 - lib/noise/functions/cipher.rb
 - lib/noise/functions/cipher/aes_gcm.rb