noise-ruby 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5b0a36466f2dfcc8a03a1e3d70d3010d150e76dcca4c2669d70ab1d849d3cb5
-  data.tar.gz: 4e3cea23eb34312dbc98b0b4562d045e272047d29a842027242eb28c47b0a615
+  metadata.gz: 876220b34ef23fb45d18cb2dd0dfd7627b5bb202e51f57af9c0cd5a62c211626
+  data.tar.gz: 662c47506e70adf05928da7b8c5e3fb48503e0043242f4127459297e29dba476
 SHA512:
-  metadata.gz: ebcd5a9d334e4b7697fec40d1936d2918d71bc143aca44e5711584ce1c3b2c19fa6b64048d57c8d1b4780eced81e5f982279aeb562ba82bd4809fa6b2f38b238
-  data.tar.gz: 69fcabcd507ad92edab302bc5576e128df0777ce890095c7765f2dc461ef512084cdcb595b4ac451f77baf2a115575787e41d39692a51f8fb8dcad7555eb9b63
+  metadata.gz: 8db525a248cd3a66f1597736745d70470ef109a3e7c7acd9758fda79c5c45aa78350d833c38a4d6d3d2ae9f8a06dd3b6b7f89a6c4928c12ea3dfe899efca4906
+  data.tar.gz: 420bd4dbeff8a66570f9d71ec219375aafeb9e5a45d76b1f23f6d9dfe47776b73da860b918f585214983224fea488370dc423f27dbd7c8905c95f33d8a4dce13

data/.dockerignore

@@ -0,0 +1,8 @@
+# Gemfile.lock is deliberately not listed: the Dockerfile copies it so the image installs the same
+# versions the mounted working tree will ask for.
+.git/
+.rspec_status
+.ruby-lsp/
+coverage/
+pkg/
+tmp/

data/.github/workflows/ruby.yml

@@ -0,0 +1,56 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+          - '3.3'
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Lint code for consistent style
+        run: bundle exec rubocop -f github
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+          - '3.0'
+          - '3.1'
+          - '3.2'
+          - '3.3'
+          - '3.4'
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rspec spec
+

data/.gitignore

@@ -10,3 +10,6 @@
 
 # rspec failure tracking
 .rspec_status
+
+AGENTS.md
+CLAUDE.md

data/.rubocop.yml

@@ -1,12 +1,11 @@
-Metrics/BlockLength:
+require:
+  - rubocop-rspec
+Metrics:
   Enabled: false
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 120
 
-Metrics/MethodLength:
-  Max: 30
-
 Style/Documentation:
   Enabled: false
 
@@ -20,7 +19,30 @@ Style/WordArray:
   MinSize: 100
 
 AllCops:
-  TargetRubyVersion: 2.4.1
+  TargetRubyVersion: 3.0
+  SuggestExtensions: false
 
-Naming/UncommunicativeMethodParamName:
+Naming/MethodParameterName:
     MinNameLength: 1
+
+RSpec:
+  Exclude:
+    - "spec/factories/*"
+RSpec/AnyInstance:
+  Enabled: false
+RSpec/ContextWording:
+  Enabled: false
+RSpec/ExampleLength:
+  Enabled: false
+RSpec/MultipleExpectations:
+  Enabled: false
+RSpec/NamedSubject:
+  Enabled: false
+RSpec/NestedGroups:
+  Enabled: false
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+RSpec/SpecFilePathFormat:
+  Enabled: false
+RSpec/IndexedLet:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.5.1
+3.3.5

data/Dockerfile

@@ -0,0 +1,29 @@
+# check=skip=FromPlatformFlagConstDisallowed
+# The test suite loads the x86_64 libsecp256k1 / libgoldilocks bundled in spec/lib, and
+# spec/spec_helper.rb points at them unconditionally, so this image has to be linux/amd64
+# even on an arm64 host. It mirrors the CI runner (ubuntu x86_64).
+FROM --platform=linux/amd64 ruby:3.3
+
+# libsodium: dlopen'd by rbnacl, which lib/noise.rb requires unconditionally.
+# cargo: the blake3 gem is a Rust extension and is built at install time.
+# git: noise.gemspec calls `git ls-files` while the gemspec is evaluated.
+RUN apt-get update -qq \
+ && apt-get install -y --no-install-recommends build-essential git libsodium23 cargo \
+ && rm -rf /var/lib/apt/lists/*
+
+WORKDIR /work
+
+# Install the gems from the dependency definitions alone so the layer stays cached when only
+# the source changes. Gems live in BUNDLE_PATH (/usr/local/bundle), outside /work, so mounting
+# the working tree over /work at run time does not hide them.
+#
+# Gemfile.lock is gitignored, hence the glob: it is copied when the host has one so the image
+# installs the exact versions the mounted lock will ask for at run time, and skipped otherwise.
+COPY Gemfile* noise.gemspec ./
+COPY lib/noise/version.rb lib/noise/version.rb
+RUN bundle install
+
+# Run with the working tree mounted:
+#   docker run --rm -v "$PWD":/work noise-dev
+#   docker run --rm -v "$PWD":/work noise-dev bundle exec rubocop
+CMD ["bundle", "exec", "rspec"]

data/Gemfile

@@ -4,11 +4,6 @@ source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
-# Specify your gem's dependencies in noise.gemspec
+# Specify your gem's dependencies in noise.gemspec. The optional ed448, secp256k1-ruby and blake3
+# backends are development dependencies there, so the test suite covers all of them.
 gemspec
-
-# Use secp256k1 as ecdh function
-# gem 'secp256k1-ruby'
-
-# Use blake3 as hash function
-# gem 'blake3'

data/README.md

@@ -59,6 +59,12 @@ After installing, define an environment variable as follows:
 
          $ export LIBGOLDILOCKS=/usr/local/lib/libgoldilocks.so
 
+and, add this line to your Gemfile:
+
+```
+gem 'ed448'
+```
+
 If you use Secp256k1, you must install [libsecp256k1](https://github.com/bitcoin-core/secp256k1).
 
     $ git clone https://github.com/bitcoin-core/secp256k1

data/lib/noise/connection/base.rb

@@ -3,10 +3,12 @@
 module Noise
   module Connection
     class Base
-      attr_reader :protocol, :handshake_started, :handshake_finished, :handshake_hash, :handshake_state
-      attr_reader :cipher_state_encrypt, :cipher_state_decrypt, :cipher_state_handshake
+      # The Noise spec caps a handshake or transport message at 65535 bytes.
+      MAX_MESSAGE_LENGTH = 65_535
+
+      attr_reader :protocol, :handshake_started, :handshake_finished, :handshake_hash, :handshake_state,
+                  :cipher_state_encrypt, :cipher_state_decrypt, :cipher_state_handshake, :s, :rs
       attr_accessor :psks, :prologue
-      attr_reader :s, :rs
 
       def initialize(name, keypairs: { s: nil, e: nil, rs: nil, re: nil })
         @protocol = Protocol.create(name)
@@ -27,11 +29,15 @@ module Noise
         @handshake_started = true
       end
 
+      # Restarts the handshake with a fallback pattern, carrying over the keys of the aborted one.
+      #
+      # The roles swap here: the party that wrote the aborted message now reads, and the one that
+      # failed to read it now writes. Both sides are already in that state, so @next_message is
+      # deliberately left as it is rather than reset through initialize_next_message.
       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
@@ -40,7 +46,6 @@ module Noise
       def initialise_handshake_state
         @handshake_state = Noise::State::HandshakeState.new(
           self,
-          protocol,
           initiator?,
           @prologue,
           @local_keypairs,
@@ -56,10 +61,13 @@ module Noise
         raise Noise::Exceptions::NoiseHandshakeError if @next_message != :write
         raise Noise::Exceptions::NoiseHandshakeError if @handshake_finished
 
+        if @handshake_state.expected_message_length(payload.bytesize) > MAX_MESSAGE_LENGTH
+          raise Noise::Exceptions::NoiseHandshakeError, 'Message exceeds the maximum length.'
+        end
+
         @next_message = :read
         buffer = +''
-        result = @handshake_state.write_message(payload, buffer)
-        @handshake_finished = true if result
+        @handshake_finished = @handshake_state.write_message(payload, buffer)
         buffer
       end
 
@@ -68,11 +76,12 @@ module Noise
         raise Noise::Exceptions::NoiseHandshakeError unless @handshake_started
         raise Noise::Exceptions::NoiseHandshakeError if @next_message != :read
         raise Noise::Exceptions::NoiseHandshakeError if @handshake_finished
+        raise Noise::Exceptions::NoiseHandshakeError, 'Message exceeds the maximum length.' if
+          data.bytesize > MAX_MESSAGE_LENGTH
 
         @next_message = :write
         buffer = +''
-        result = @handshake_state.read_message(data, buffer)
-        @handshake_finished = true if result
+        @handshake_finished = @handshake_state.read_message(data, buffer)
         buffer
       end
 
@@ -94,23 +103,19 @@ module Noise
         raise Noise::Exceptions::NoisePSKError if @protocol.pattern.psk_count != @psks.count
       end
 
-      def valid_keypairs?
+      def missing_keypairs?
         keypairs = @local_keypairs.merge(@remote_keys)
         @protocol.pattern.required_keypairs(initiator?).any? { |keypair| !keypairs[keypair] }
       end
 
       def validate
-        validate_psk! if psk_handshake?
+        validate_psk! if @protocol.psk?
 
-        raise Noise::Exceptions::NoiseValidationError if valid_keypairs?
+        raise Noise::Exceptions::NoiseValidationError if missing_keypairs?
 
         true
       end
 
-      def psk_handshake?
-        @protocol.is_psk_handshake
-      end
-
       def handshake_done(_c1, _c2)
         @handshake_hash = @symmetric_state.handshake_hash
         @s = @handshake_state.s

data/lib/noise/exceptions/decrypt_error.rb

@@ -4,6 +4,7 @@ module Noise
   module Exceptions
     class DecryptError < StandardError
       def initialize(cause)
+        super
         @cause = cause
       end
     end

data/lib/noise/exceptions/encrypt_error.rb

@@ -4,6 +4,7 @@ module Noise
   module Exceptions
     class EncryptError < StandardError
       def initialize(cause)
+        super
         @cause = cause
       end
     end

data/lib/noise/exceptions/invalid_public_key_error.rb

@@ -3,7 +3,10 @@
 module Noise
   module Exceptions
     class InvalidPublicKeyError < StandardError
+      attr_reader :public_key
+
       def initialize(public_key)
+        super("Invalid public key: #{public_key.unpack1('H*')}")
         @public_key = public_key
       end
     end

data/lib/noise/exceptions/missing_dependency_error.rb

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

data/lib/noise/exceptions.rb

@@ -6,6 +6,7 @@ module Noise
     autoload :EncryptError, 'noise/exceptions/encrypt_error'
     autoload :InvalidPublicKeyError, 'noise/exceptions/invalid_public_key_error'
     autoload :MaxNonceError, 'noise/exceptions/max_nonce_error'
+    autoload :MissingDependencyError, 'noise/exceptions/missing_dependency_error'
     autoload :ProtocolNameError, 'noise/exceptions/protocol_name_error'
     autoload :NoiseHandshakeError, 'noise/exceptions/noise_handshake_error'
     autoload :NoiseValidationError, 'noise/exceptions/noise_validation_error'

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

@@ -7,28 +7,29 @@ module Noise
         MAX_NONCE = 2**64 - 1
 
         def encrypt(k, n, ad, plaintext)
-          cipher = OpenSSL::Cipher::AES.new(256, :GCM).encrypt
+          cipher = OpenSSL::Cipher.new('aes-256-gcm').encrypt
           cipher.key = k
           cipher.iv = nonce_to_bytes(n)
           cipher.auth_data = ad
-          cipher.update(plaintext) + cipher.final + cipher.auth_tag
+          update(cipher, plaintext) + cipher.final + cipher.auth_tag
         rescue OpenSSL::Cipher::CipherError => e
-          raise Noise::Exceptions::EncryptError.new(e)
+          raise Noise::Exceptions::EncryptError, "Encrypt failed. #{e.message}", e.backtrace
         end
 
         def decrypt(k, n, ad, ciphertext)
-          cipher = OpenSSL::Cipher::AES.new(256, :GCM).decrypt
+          cipher = OpenSSL::Cipher.new('aes-256-gcm').decrypt
           cipher.key = k
           cipher.iv = nonce_to_bytes(n)
           cipher.auth_data = ad
-          cipher.auth_tag = ciphertext[-16..-1]
-          cipher.update(ciphertext[0...-16]) + cipher.final
+          cipher.auth_tag = ciphertext[-16..]
+          update(cipher, ciphertext[0...-16]) + cipher.final
         rescue OpenSSL::Cipher::CipherError => e
-          raise Noise::Exceptions::DecryptError.new(e)
+          raise Noise::Exceptions::DecryptError, "Decrpyt failed. #{e.message}", e.backtrace
         end
 
+        # 4 zero bytes followed by n as a big-endian 64 bit integer.
         def nonce_to_bytes(n)
-          "\x00" * 4 + format('%16x', n).htb
+          "\x00" * 4 + [n].pack('Q>')
         end
 
         # Returns a new 32-byte cipher key as a pseudorandom function of k.
@@ -40,6 +41,16 @@ module Noise
         def rekey(k)
           encrypt(k, MAX_NONCE, '', "\x00" * 32)[0...32]
         end
+
+        private
+
+        # A zero-length payload is normal in a Noise message, but the openssl gem shipped with
+        # Ruby 3.0 raises ArgumentError('data must not be empty') instead of returning ''.
+        def update(cipher, data)
+          return String.new if data.empty?
+
+          cipher.update(data)
+        end
       end
     end
   end

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

@@ -10,18 +10,19 @@ module Noise
           cipher = RbNaCl::AEAD::ChaCha20Poly1305IETF.new(String.new(k).force_encoding('ASCII-8BIT'))
           cipher.encrypt(nonce_to_bytes(n), plaintext, ad)
         rescue ::RbNaCl::CryptoError => e
-          raise Noise::Exceptions::EncryptError.new(e)
+          raise Noise::Exceptions::EncryptError, "Encrypt failed. #{e.message}", e.backtrace
         end
 
         def decrypt(k, n, ad, ciphertext)
           cipher = RbNaCl::AEAD::ChaCha20Poly1305IETF.new(String.new(k).force_encoding('ASCII-8BIT'))
           cipher.decrypt(nonce_to_bytes(n), ciphertext, ad)
         rescue ::RbNaCl::CryptoError => e
-          raise Noise::Exceptions::DecryptError.new(e)
+          raise Noise::Exceptions::DecryptError, "Decrpyt failed. #{e.message}", e.backtrace
         end
 
+        # 4 zero bytes followed by n as a little-endian 64 bit integer.
         def nonce_to_bytes(n)
-          "\x00" * 4 + format('%16x', n).htb.reverse
+          "\x00" * 4 + [n].pack('Q<')
         end
 
         # Returns a new 32-byte cipher key as a pseudorandom function of k.
@@ -31,7 +32,7 @@ module Noise
         # zerolen is a zero-length byte sequence, and zeros is a sequence of
         # 32 bytes filled with zeros.
         def rekey(k)
-          encrypt(k, MAX_NONCE, '', "\x00" * 32)[0..32]
+          encrypt(k, MAX_NONCE, '', "\x00" * 32)[0...32]
         end
       end
     end

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

@@ -1,16 +1,17 @@
 # frozen_string_literal: true
 
-begin
-  require 'ed448'
-  Ed448.init
-rescue LoadError
-end
+Noise.require_optional('ed448') { Ed448.init }
 
 module Noise
   module Functions
     module DH
       class ED448
-        DHLEN = Ed448::X448::X448_PRIVATE_BYTES
+        # Ed448::X448::X448_PRIVATE_BYTES, spelled out so this file loads without the gem.
+        DHLEN = 56
+
+        def initialize
+          Noise.optional_dependency!('ed448')
+        end
 
         def generate_keypair
           private_key = SecureRandom.random_bytes(DHLEN)

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

@@ -1,14 +1,15 @@
 # frozen_string_literal: true
 
-begin
-  require 'secp256k1'
-rescue LoadError
-end
+Noise.require_optional 'secp256k1'
 
 module Noise
   module Functions
     module DH
       class Secp256k1
+        def initialize
+          Noise.optional_dependency!('secp256k1')
+        end
+
         def generate_keypair
           group = ECDSA::Group::Secp256k1
           private_key = 1 + SecureRandom.random_number(group.order - 1)
@@ -22,7 +23,7 @@ module Noise
         def dh(private_key, public_key)
           key = ::Secp256k1::PublicKey.new(pubkey: public_key, raw: true)
           key.ecdh(private_key)
-        rescue ::Secp256k1::AssertError => _
+        rescue ::Secp256k1::AssertError
           raise Noise::Exceptions::InvalidPublicKeyError, public_key
         end
 

data/lib/noise/functions/hash/blake2s.rb

@@ -60,6 +60,7 @@ module Noise
         # @return context
         def init(out_len, key)
           raise ArgumentError if out_len.zero? || out_len > 32
+
           h = IV.dup
           h[0] ^= 0x01010000 ^ (key.size << 8) ^ out_len
           t = 0
@@ -168,6 +169,7 @@ module Noise
 
         class Context
           attr_accessor :b, :h, :t, :c, :out_len
+
           def initialize(b, h, t, c, out_len)
             @b = b
             @h = h

data/lib/noise/functions/hash/blake3.rb

@@ -1,16 +1,18 @@
 # frozen_string_literal: true
 
-begin
-  require 'blake3'
-rescue LoadError
-end
+Noise.require_optional 'blake3'
 
 module Noise
   module Functions
     module Hash
       class Blake3
-        HASHLEN = 64
-        BLOCKLEN = 128
+        HASHLEN = 32
+        BLOCKLEN = 64
+
+        def initialize
+          Noise.optional_dependency!('blake3')
+        end
+
         def hash(data)
           ::Blake3.digest(data)
         end

data/lib/noise/functions/hash.rb

@@ -10,14 +10,17 @@ module Noise
       autoload :Blake3, 'noise/functions/hash/blake3'
 
       def self.hmac_hash(key, data, digest)
-        if digest.include?('SHA')
+        case digest
+        when /SHA/
           OpenSSL::HMAC.digest(OpenSSL::Digest.new(digest), key, data)
-        elsif digest.include?('BLAKE2b')
+        when /BLAKE2b/
           Noise::Functions::Hash::Blake2bHMAC.new(key).update(data).digest
-        elsif digest.include?('BLAKE2s')
+        when /BLAKE2s/
           Noise::Functions::Hash::Blake2sHMAC.new(key).update(data).digest
-        elsif digest.include?('BLAKE3')
+        when /BLAKE3/
           Noise::Functions::Hash::Blake3HMAC.new(key).update(data).digest
+        else
+          raise Noise::Exceptions::ProtocolNameError, "Unsupported hash function: #{digest}"
         end
       end
 
@@ -30,9 +33,10 @@ module Noise
       def self.hkdf(chaining_key, input_key_material, num_outputs, digest)
         temp_key = hmac_hash(chaining_key, input_key_material, digest)
         output1 = hmac_hash(temp_key, "\x01", digest)
-        output2 = hmac_hash(temp_key, output1 + "\x02", digest)
+        output2 = hmac_hash(temp_key, "#{output1}\u0002", digest)
         return [output1, output2] if num_outputs == 2
-        output3 = hmac_hash(temp_key, output2 + "\x03", digest)
+
+        output3 = hmac_hash(temp_key, "#{output2}\u0003", digest)
         [output1, output2, output3]
       end
     end