noise-ruby 0.9.4 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb6e8b4da6da1ab86d95f9712cc5af2fde45c8fb2c6b53f8f76cd4e585c8b509
-  data.tar.gz: 7bbec8a8af754911c1b9ce7026ee21ac98b6af601a40c503e4d4fd03a4679e5a
+  metadata.gz: a5b0a36466f2dfcc8a03a1e3d70d3010d150e76dcca4c2669d70ab1d849d3cb5
+  data.tar.gz: 4e3cea23eb34312dbc98b0b4562d045e272047d29a842027242eb28c47b0a615
 SHA512:
-  metadata.gz: 38130604059543fb695227160b59655cc617a29a70abb4d6cac67636fee53b9c7ae78264b6123928842ce1a67ad10a634b7b438d4ec54cf23e48a4e3398aab37
-  data.tar.gz: 0124a47916e35d8267b39336327fc3f496a25068090f6886f92c4a4edf7e4479bb968cd2d78401003821703143bf936aadabd38580146819ab945df981cd0ce1
+  metadata.gz: ebcd5a9d334e4b7697fec40d1936d2918d71bc143aca44e5711584ce1c3b2c19fa6b64048d57c8d1b4780eced81e5f982279aeb562ba82bd4809fa6b2f38b238
+  data.tar.gz: 69fcabcd507ad92edab302bc5576e128df0777ce890095c7765f2dc461ef512084cdcb595b4ac451f77baf2a115575787e41d39692a51f8fb8dcad7555eb9b63

data/Gemfile

@@ -7,5 +7,8 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 # Specify your gem's dependencies in noise.gemspec
 gemspec
 
-# Use secp256k1 as hash function
+# Use secp256k1 as ecdh function
 # gem 'secp256k1-ruby'
+
+# Use blake3 as hash function
+# gem 'blake3'

data/README.md

@@ -2,17 +2,36 @@
 
 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 https://github.com/lightningnetwork/lightning-rfc/blob/master/08-transport.md
+Supported Features:
+
+* DH Functions
+    * ED25519
+    * ED448
+    * Secp256k1
+        * Secp256k1 is required for Lightning Network, layer-2 protocol for bitcoin. see [BOLT #8: Encrypted and Authenticated Transport](https://github.com/lightningnetwork/lightning-rfc/blob/master/08-transport.md)
+* Cipher Algorithm
+    * ChaCha20-Poly1305
+    * AES-GCM
+* Hash Functions
+    * SHA256
+    * SHA512
+    * BLAKE2s
+    * BLAKE2b
+    * BLAKE3
+* Pattens
+    * One-way Patterns(3)
+        * N, K, X
+    * Fundamental Interactive Patterns(12)
+        * NN, KN, NK, KK, NX, KX, XN, IN, XK, IK, XX, IX
+    * Defferred Interactive Patterns(23)
+        * NK1, NX1, X1N, X1K, XK1, X1K1, X1X, XX1, X1X1, K1N, K1K, KK1, K1K1,K1X, KX1, K1X1, I1N, I1K, IK1, I1K1, I1X, IX1, I1X1
+* Fallback
+* PSK
 
 ## Installation
 
-This gem needs libsodium and libgoldilocks library.
-To install these library, see https://github.com/jedisct1/libsodium and https://github.com/otrv4/libgoldilocks
+This gem needs libsodium library.
+To install libsodium, see https://github.com/jedisct1/libsodium
 
 Add this line to your application's Gemfile:
 
@@ -28,6 +47,18 @@ Or install it yourself as:
 
     $ gem install noise-ruby
 
+If you use Ed448 as DH function, you must install [libgoldilocks](https://github.com/otrv4/libgoldilocks).
+
+After installing, define an environment variable as follows:
+
+   * on macOS
+
+         $ export LIBGOLDILOCKS=/usr/local/lib/libgoldilocks.dylib
+
+   * on Linux(Ubuntu)
+
+         $ export LIBGOLDILOCKS=/usr/local/lib/libgoldilocks.so
+
 If you use Secp256k1, you must install [libsecp256k1](https://github.com/bitcoin-core/secp256k1).
 
     $ git clone https://github.com/bitcoin-core/secp256k1
@@ -43,6 +74,13 @@ and, add this line to your Gemfile:
 gem 'secp256k1-ruby'
 ```
 
+If you use BLAKE3, you must install [Rust and Cargo](https://www.rust-lang.org/tools/install).
+And add this line to your Gemfile:
+
+```
+gem 'blake3'
+```
+
 ## Usage
 
 Followings shows handshake protocol with "Noise_NN_25519_ChaChaPoly_BLAKE2b"
@@ -58,12 +96,12 @@ initiator.start_handshake # => true
 cipher = initiator.write_message("") # => "\xB6\xF7gmxi\xAB\xBCY|t\xF0\x9D\x01A\ad\x92\xBBvp\x80ZNU\f=\x83\x81^\xFD\x15"
 ```
 
-then initiator sends `cipher` to responder.
+then initiator sends `cipher` to the responder.
 
 #### responder
 
-Responder receive `cipher` from initiator.
-Responder respond messages to initiator.
+The responder receives `cipher` from the initiator.
+The responder responds messages to the initiator.
 
 ```
 responder = Noise::Connection::Responder.new("Noise_NN_25519_ChaChaPoly_BLAKE2b")
@@ -74,25 +112,26 @@ cipher = responder.write_message("") # => "\v\xD9\x97'\xC0\xB1\xC9\xFFD\x8C\x7F\
 ```
 
 
-### initiator
+#### initiator
 
 ```
 plain = initiator.read_message(cipher) # => ""
 ```
 
-### Send transport message (after handshake finished)
+### Transport (after handshake finished)
+
+#### Send transport message
 
 ```
 cipher = initiator.encrypt("Hello, World!") # => "\xDA\xC7\xD7as\v\xFA\xCC,\xB3\xC7\xD0/xL\xE8I,\xD9\n\xEExh\x8F\xFA\xD6\x01\x99W"
 ```
 
-### Receive transport message
+#### Receive transport message
 
 ```
 plain = responder.decrypt(cipher) # => "Hello, World!"
 ```
 
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -101,8 +140,8 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/noise. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/Yamaguchi/noise. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## Code of Conduct
 
-Everyone interacting in the Noise project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/noise/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Noise project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Yamaguchi/noise/blob/master/CODE_OF_CONDUCT.md).

data/lib/noise/functions/hash.rb

@@ -7,6 +7,7 @@ module Noise
       autoload :Blake2s, 'noise/functions/hash/blake2s'
       autoload :Sha256, 'noise/functions/hash/sha256'
       autoload :Sha512, 'noise/functions/hash/sha512'
+      autoload :Blake3, 'noise/functions/hash/blake3'
 
       def self.hmac_hash(key, data, digest)
         if digest.include?('SHA')
@@ -15,6 +16,8 @@ module Noise
           Noise::Functions::Hash::Blake2bHMAC.new(key).update(data).digest
         elsif digest.include?('BLAKE2s')
           Noise::Functions::Hash::Blake2sHMAC.new(key).update(data).digest
+        elsif digest.include?('BLAKE3')
+          Noise::Functions::Hash::Blake3HMAC.new(key).update(data).digest
         end
       end
 

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+begin
+  require 'blake3'
+rescue LoadError
+end
+
+module Noise
+  module Functions
+    module Hash
+      class Blake3
+        HASHLEN = 64
+        BLOCKLEN = 128
+        def hash(data)
+          ::Blake3.digest(data)
+        end
+
+        def hashlen
+          HASHLEN
+        end
+
+        def blocklen
+          BLOCKLEN
+        end
+      end
+
+      class Blake3HMAC < HMAC::Base
+        def initialize(key = nil)
+          super(::Blake3::Hasher, Blake3::BLOCKLEN, Blake3::HASHLEN, key)
+        end
+        public_class_method :new, :digest, :hexdigest
+      end
+    end
+  end
+end

data/lib/noise/protocol.rb

@@ -21,7 +21,8 @@ module Noise
       'BLAKE2b': Noise::Functions::Hash::Blake2b,
       'BLAKE2s': Noise::Functions::Hash::Blake2s,
       'SHA256': Noise::Functions::Hash::Sha256,
-      'SHA512': Noise::Functions::Hash::Sha512
+      'SHA512': Noise::Functions::Hash::Sha512,
+      'BLAKE3': Noise::Functions::Hash::Blake3,
     }.stringify_keys.freeze
 
     def self.create(name)

data/lib/noise/version.rb

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

data/noise.gemspec

@@ -21,13 +21,14 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_development_dependency 'blake3'
   spec.add_development_dependency 'bundler', '~> 1.15'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'secp256k1-ruby'
 
   spec.add_runtime_dependency 'ecdsa'
+  spec.add_runtime_dependency 'ed448'
   spec.add_runtime_dependency 'rbnacl'
   spec.add_runtime_dependency 'ruby-hmac'
-  spec.add_runtime_dependency 'ed448'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: noise-ruby
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.10.0
 platform: ruby
 authors:
 - Hajime Yamaguchi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-08 00:00:00.000000000 Z
+date: 2020-01-18 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: blake3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -81,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rbnacl
+  name: ed448
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ruby-hmac
+  name: rbnacl
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ed448
+  name: ruby-hmac
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -167,6 +181,7 @@ files:
 - lib/noise/functions/hash.rb
 - lib/noise/functions/hash/blake2b.rb
 - lib/noise/functions/hash/blake2s.rb
+- lib/noise/functions/hash/blake3.rb
 - lib/noise/functions/hash/sha256.rb
 - lib/noise/functions/hash/sha512.rb
 - lib/noise/key.rb