rbnacl 4.0.0 → 4.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b98225b2e645925d76a0189adf330c81c7b34f68
-  data.tar.gz: 8ccf325edde59b1ba96e29ca0c018a3a1cd0abc8
+  metadata.gz: 06b62936ca905b101e22418710c37dfc78cd5d11
+  data.tar.gz: 0b8b8ba5efb7e6673bb8811e19695a7fbb714fbd
 SHA512:
-  metadata.gz: 2460addc91d22d5f6e846f8a43aa7e4e582a0763482884700f29be44ee48176f5bd3ca492fe78554a2c0c8f3e10be57d9b4b24c32b670b9441440eec6ac5aa86
-  data.tar.gz: 9d0cc147b8897251d7329aafa78049bd7099fa1726af94249c0c1062a3ff67c069b77d2228983b914d7e6a2b2ae95ca326e64ee2848956b72b91ac6a3c5f4376
+  metadata.gz: 69a6b4e5aaeee71020409df122943399ba64c1b46a76c4a75b4abaf113fb6d3d93c553f128f8b42e2a52d57a7e8081e45749b6c585b6aca434cbda1eea972fb7
+  data.tar.gz: 20d228a8f6a56e5c710288fb6e73b16ad39d0185f369bd29b519f8742c1da1b5523388ea6bdfea8e1d21df892019761cc99e6e920f44bfdae8e671fa2cb00fe3

data/.ruby-version

@@ -1 +1 @@
-2.3.3
+2.4.0

data/.travis.yml

@@ -12,6 +12,7 @@ rvm:
   - jruby-9.1.6.0
   - 2.2.6
   - 2.3.3
+  - 2.4.0
 
 env:
   - LIBSODIUM_VERSION=1.0.0  # Minimum supported

data/CHANGES.md

@@ -1,5 +1,16 @@
-4.0.0 (2016-12-04)
-----------------------
+## 4.0.2 (2016-03-12)
+
+* [#157](https://github.com/cryptosphere/rbnacl/pull/157)
+  Raise error on degenerate keys (fixes #152).
+  ([@paragonie-scott], [@tarcieri])
+
+## 4.0.1 (2016-12-04)
+
+* [#148](https://github.com/cryptosphere/rbnacl/pull/148)
+  Last minute changes to the ChaCha20Poly1305 API.
+  ([@tarcieri])
+
+## 4.0.0 (2016-12-04)
 
 * [#141](https://github.com/cryptosphere/rbnacl/pull/141)
   Add wrappers for ChaCha20Poly1305 AEAD ciphers.
@@ -13,18 +24,18 @@
   Require Ruby 2.2.6+.
   ([@tarcieri])
 
-3.4.0 (2015-05-07)
-------------------
+## 3.4.0 (2015-05-07)
+
 * [#135](https://github.com/cryptosphere/rbnacl/pull/135)
-  Expose RbNaCl::Signatures::Ed25519#keypair_bytes.
+  Expose `RbNaCl::Signatures::Ed25519#keypair_bytes`.
   ([@grempe])
 
 * [#137](https://github.com/cryptosphere/rbnacl/pull/137)
   Expose HMAC-SHA512 (with 64-byte keys)
   ([@mwpastore])
 
-3.3.0 (2015-12-29)
-------------------
+## 3.3.0 (2015-12-29)
+
 * [#105](https://github.com/cryptosphere/rbnacl/pull/105)
   Add salt/personalisation strings for Blake2b.
   ([@namelessjon])
@@ -33,39 +44,39 @@
   Remove use of Thread.exclusive when initializing library.
   ([@tarcieri])
 
-3.2.0 (2015-05-31)
-------------------
+## 3.2.0 (2015-05-31)
+
 * Fix method signature for blake2b
 * RuboCop-friendly codebase
 
-3.1.2 (2014-08-30)
-------------------
+## 3.1.2 (2014-08-30)
+
 * Fix scrypt support with libsodium 0.7.0 (scryptsalsa208sha256)
 
-3.1.1 (2014-06-14)
-------------------
+## 3.1.1 (2014-06-14)
+
 * Fix undefined variable warning
 * RSpec 3 fixups
 * RuboCop
 
-3.1.0 (2014-05-22)
-------------------
-* The scrypt password hashing function: RbNaCl::PasswordHash.scrypt
+## 3.1.0 (2014-05-22)
+
+* The scrypt password hashing function: `RbNaCl::PasswordHash.scrypt`
+
+## 3.0.1 (2014-05-12)
 
-3.0.1 (2014-05-12)
-------------------
-* Load gem from RBNACL_LIBSODIUM_GEM_LIB_PATH if set. Used by rbnacl-libsodium
+* Load gem from `RBNACL_LIBSODIUM_GEM_LIB_PATH` if set. Used by rbnacl-libsodium
   gem to use libsodium compiled from a gem.
 
-3.0.0 (2014-04-22)
-------------------
+## 3.0.0 (2014-04-22)
+
 * Rename RandomNonceBox to SimpleBox (backwards compatibility preserved)
 * Reverse documented order of SimpleBox/RandomNonceBox initialize parameters.
   Technically backwards compatible, but confusing.
 * Ensure all strings are ASCII-8BIT/BINARY encoding prior to use
 
-2.0.0 (2013-11-07)
-------------------
+## 2.0.0 (2013-11-07)
+
 * Add encrypt/decrypt aliases for Crypto::RandomNonceBox
 * Rename Crypto module to RbNaCl module
 * RbNaCl::VerifyKey#verify operand order was reversed. New operand order is
@@ -84,15 +95,14 @@
 * Changes in the low level binding for libsodium and removal of the NaCl module
 * Add a mutex around calls to randombytes in libsodium
 
-1.1.0 (2013-04-19)
-------------------
+## 1.1.0 (2013-04-19)
 
 * Provide API for querying primitives and details about them, such as key
   lengths, nonce lengths, etc.
 * Fixed bug on passing null bytes to sha256, sha512 functions.
 
-1.0.0 (2013-03-08)
-------------------
+## 1.0.0 (2013-03-08)
+
 * Initial release
 
 [@namelessjon]: https://github.com/namelessjon
@@ -101,3 +111,4 @@
 [@grempe]: https://github.com/grempe
 [@mwpastore]: https://github.com/mwpastore
 [@elijh]: https://github.com/elijh
+[@paragonie-scott]: https://github.com/paragonie-scott

data/LICENSE.txt

@@ -1,5 +1,4 @@
-Copyright (c) 2012 Tony Arcieri
-Copyright (c) 2013 Jonathan Stott
+Copyright (c) 2012-2017 Tony Arcieri, Jonathan Stott
 
 MIT License
 

data/README.md

@@ -6,7 +6,7 @@
 [![Coverage Status](https://coveralls.io/repos/cryptosphere/rbnacl/badge.svg?branch=master)](https://coveralls.io/r/cryptosphere/rbnacl)
 [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/cryptosphere/rbnacl/blob/master/LICENSE.txt)
 
-_NOTE: This is the 4.x **development** branch of RbNaCl. For the 3.x **stable**
+_NOTE: This is the 4.x **stable** branch of RbNaCl. For the 3.x **legacy**
 branch, please see:_
 
 https://github.com/cryptosphere/rbnacl/tree/3-x-stable
@@ -151,7 +151,7 @@ are supported:
 Additional power-user features are available. Please see the Wiki for further
 information.
 
-[RDoc documentation][rdoc] is also available.
+[YARD API documentation][yard] is also available.
 
 [wiki]: https://github.com/cryptosphere/rbnacl/wiki
 [simplebox]: https://github.com/cryptosphere/rbnacl/wiki/SimpleBox
@@ -160,7 +160,7 @@ information.
 [signatures]: https://github.com/cryptosphere/rbnacl/wiki/Digital-Signatures
 [macs]: https://github.com/cryptosphere/rbnacl/wiki/Authenticators
 [hashes]: https://github.com/cryptosphere/rbnacl/wiki/Hash-Functions
-[rdoc]: http://rubydoc.info/github/cryptosphere/rbnacl/master/frames
+[yard]: http://www.rubydoc.info/gems/rbnacl
 
 ## Learn More
 
@@ -209,5 +209,7 @@ Sure, here you go:
 
 ## License
 
-Copyright (c) 2012-2016 Jonathan Stott, Tony Arcieri. Distributed under the MIT License.
-See LICENSE.txt for further details.
+Copyright (c) 2012-2017 Tony Arcieri, Jonathan Stott. Distributed under the MIT License.
+See [LICENSE.txt] for further details.
+
+[LICENSE.txt]: https://github.com/cryptosphere/rbnacl/blob/master/LICENSE.txt

data/lib/rbnacl.rb

@@ -12,7 +12,7 @@ require "rbnacl/random"
 require "rbnacl/simple_box"
 require "rbnacl/test_vectors"
 require "rbnacl/init"
-require "rbnacl/aead/aead"
+require "rbnacl/aead/base"
 
 # NaCl/libsodium for Ruby
 module RbNaCl
@@ -79,7 +79,7 @@ module RbNaCl
   require "rbnacl/hmac/sha512"
 
   # AEAD: ChaCha20-Poly1305
-  require "rbnacl/aead/chacha20poly1305"
+  require "rbnacl/aead/chacha20poly1305_legacy"
   require "rbnacl/aead/chacha20poly1305_ietf"
 
   #

data/lib/rbnacl/aead/{aead.rb → base.rb}

@@ -3,14 +3,14 @@
 
 module RbNaCl
   module AEAD
-    # Authenticated Encryption with Additional Data
+    # Abstract base class for Authenticated Encryption with Additional Data
     #
     # This construction encrypts a message, and computes an authentication
     # tag for the encrypted message and some optional additional data
     #
     # RbNaCl provides wrappers for both ChaCha20-Poly1305 AEAD implementations
     # in libsodium: the original, and the IETF version.
-    class GenericAEAD
+    class Base
       # Number of bytes in a valid key
       KEYBYTES = 0
 

data/lib/rbnacl/aead/chacha20poly1305_ietf.rb

@@ -5,7 +5,7 @@ module RbNaCl
   module AEAD
     # This class contains wrappers for the IETF implementation of
     # Authenticated Encryption with Additional Data using ChaCha20-Poly1305
-    class Chacha20Poly1305IETF < GenericAEAD
+    class ChaCha20Poly1305IETF < RbNaCl::AEAD::Base
       extend Sodium
       if Sodium::Version.supported_version?("1.0.9")
         sodium_type :aead

data/lib/rbnacl/aead/{chacha20poly1305.rb → chacha20poly1305_legacy.rb}

@@ -5,7 +5,7 @@ module RbNaCl
   module AEAD
     # This class contains wrappers for the original libsodium implementation of
     # Authenticated Encryption with Additional Data using ChaCha20-Poly1305
-    class Chacha20Poly1305 < GenericAEAD
+    class ChaCha20Poly1305Legacy < RbNaCl::AEAD::Base
       extend Sodium
 
       sodium_type :aead

data/lib/rbnacl/group_elements/curve25519.rb

@@ -18,6 +18,9 @@ module RbNaCl
       # Order of the standard group
       STANDARD_GROUP_ORDER = 2**252 + 27_742_317_777_372_353_535_851_937_790_883_648_493
 
+      # Degenerate key (all-zeroes, results in an all-zero shared secret)
+      DEGENERATE_KEY = ("\0" * 32).freeze
+
       include KeyComparator
       include Serializable
 
@@ -44,6 +47,8 @@ module RbNaCl
       def initialize(point)
         @point = point.to_str
 
+        raise CryptoError, "degenerate key detected" if @point == DEGENERATE_KEY
+
         # FIXME: really should have a separate constant here for group element size
         # Group elements and scalars are both 32-bits, but that's for convenience
         Util.check_length(@point, SCALARBYTES, "group element")
@@ -61,8 +66,8 @@ module RbNaCl
         Util.check_length(integer, SCALARBYTES, "integer")
 
         result = Util.zeros(SCALARBYTES)
-        self.class.scalarmult_curve25519(result, integer, @point)
 
+        raise CryptoError, "degenerate key detected" unless self.class.scalarmult_curve25519(result, integer, @point)
         self.class.new(result)
       end
 
@@ -79,6 +84,7 @@ module RbNaCl
       #
       # @return [RbNaCl::Point] standard base point (a.k.a. standard group element)
       def self.base
+        # TODO: better support fixed-based scalar multiplication (this glosses over native support)
         @base_point
       end
       class << self

data/lib/rbnacl/version.rb

@@ -4,5 +4,5 @@
 # NaCl/libsodium for Ruby
 module RbNaCl
   # The library's version
-  VERSION = "4.0.0"
+  VERSION = "4.0.2"
 end

data/spec/rbnacl/aead/chacha20poly1305_ietf_spec.rb

@@ -1,16 +1,14 @@
 # encoding: binary
 # frozen_string_literal: true
 
-RSpec.describe RbNaCl::AEAD::Chacha20Poly1305IETF do
+RSpec.describe RbNaCl::AEAD::ChaCha20Poly1305IETF do
   if RbNaCl::Sodium::Version.supported_version?("1.0.9")
     include_examples "aead" do
-      let(:key) {vector :aead_chacha20poly1305_ietf_key}
-      let(:message) {vector :aead_chacha20poly1305_ietf_message}
-      let(:nonce) {vector :aead_chacha20poly1305_ietf_nonce}
-      let(:ad) {vector :aead_chacha20poly1305_ietf_ad}
-      let(:ciphertext) {vector :aead_chacha20poly1305_ietf_ciphertext}
-
-      let(:aead) { RbNaCl::AEAD::Chacha20Poly1305IETF.new(key) }
+      let(:key)        { vector :aead_chacha20poly1305_ietf_key }
+      let(:message)    { vector :aead_chacha20poly1305_ietf_message }
+      let(:nonce)      { vector :aead_chacha20poly1305_ietf_nonce }
+      let(:ad)         { vector :aead_chacha20poly1305_ietf_ad }
+      let(:ciphertext) { vector :aead_chacha20poly1305_ietf_ciphertext }
     end
   end
 end

data/spec/rbnacl/aead/chacha20poly1305_legacy_spec.rb

@@ -0,0 +1,12 @@
+# encoding: binary
+# frozen_string_literal: true
+
+RSpec.describe RbNaCl::AEAD::ChaCha20Poly1305Legacy do
+  include_examples "aead" do
+    let(:key)        { vector :aead_chacha20poly1305_orig_key }
+    let(:message)    { vector :aead_chacha20poly1305_orig_message }
+    let(:nonce)      { vector :aead_chacha20poly1305_orig_nonce }
+    let(:ad)         { vector :aead_chacha20poly1305_orig_ad }
+    let(:ciphertext) { vector :aead_chacha20poly1305_orig_ciphertext }
+  end
+end

data/spec/rbnacl/group_element_spec.rb

@@ -9,6 +9,8 @@ RSpec.describe RbNaCl::GroupElement do
 
   let(:alice_mult_bob) { vector :alice_mult_bob }
 
+  let(:degenerate_key) { RbNaCl::GroupElements::Curve25519::DEGENERATE_KEY }
+
   subject { described_class.new(bob_public) }
 
   it "multiplies integers with the base point" do
@@ -23,5 +25,9 @@ RSpec.describe RbNaCl::GroupElement do
     expect(subject.to_bytes).to eq bob_public
   end
 
+  it "detects degenerate keys" do
+    expect { described_class.new(degenerate_key).mult(alice_private) }.to raise_error RbNaCl::CryptoError
+  end
+
   include_examples "serializable"
 end

data/spec/shared/aead.rb

@@ -2,13 +2,15 @@
 # frozen_string_literal: true
 
 RSpec.shared_examples "aead" do
-  let(:corrupt_ciphertext) { ciphertext.succ}
-  let(:trunc_ciphertext) { ciphertext[0, 20]}
-  let(:invalid_nonce) { nonce[0, nonce.bytesize/2] } # too short!
+  let(:corrupt_ciphertext) { ciphertext.succ }
+  let(:trunc_ciphertext)   { ciphertext[0, 20] }
+  let(:invalid_nonce)      { nonce[0, nonce.bytesize/2] } # too short!
   let(:invalid_nonce_long) { nonce + nonce } # too long!
-  let(:nonce_error_regex) { /Nonce.*(Expected #{aead.nonce_bytes})/ }
-  let(:corrupt_ad) {ad.succ}
-  let(:trunc_ad) {ad[0, ad.bytesize/2]}
+  let(:nonce_error_regex)  { %r{Nonce.*(Expected #{aead.nonce_bytes})} }
+  let(:corrupt_ad)         { ad.succ }
+  let(:trunc_ad)           { ad[0, ad.bytesize/2] }
+
+  let(:aead) { described_class.new(key) }
 
   context "new" do
     it "accepts strings" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rbnacl
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.2
 platform: ruby
 authors:
 - Tony Arcieri
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-23 00:00:00.000000000 Z
+date: 2017-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -66,9 +66,9 @@ files:
 - images/hash.png
 - images/logo.png
 - lib/rbnacl.rb
-- lib/rbnacl/aead/aead.rb
-- lib/rbnacl/aead/chacha20poly1305.rb
+- lib/rbnacl/aead/base.rb
 - lib/rbnacl/aead/chacha20poly1305_ietf.rb
+- lib/rbnacl/aead/chacha20poly1305_legacy.rb
 - lib/rbnacl/auth.rb
 - lib/rbnacl/boxes/curve25519xsalsa20poly1305.rb
 - lib/rbnacl/boxes/curve25519xsalsa20poly1305/private_key.rb
@@ -102,7 +102,7 @@ files:
 - lib/rbnacl/version.rb
 - rbnacl.gemspec
 - spec/rbnacl/aead/chacha20poly1305_ietf_spec.rb
-- spec/rbnacl/aead/chacha20poly1305_orig_spec.rb
+- spec/rbnacl/aead/chacha20poly1305_legacy_spec.rb
 - spec/rbnacl/authenticators/poly1305_spec.rb
 - spec/rbnacl/boxes/curve25519xsalsa20poly1305/private_key_spec.rb
 - spec/rbnacl/boxes/curve25519xsalsa20poly1305/public_key_spec.rb
@@ -149,13 +149,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Ruby binding to the Networking and Cryptography (NaCl) library
 test_files:
 - spec/rbnacl/aead/chacha20poly1305_ietf_spec.rb
-- spec/rbnacl/aead/chacha20poly1305_orig_spec.rb
+- spec/rbnacl/aead/chacha20poly1305_legacy_spec.rb
 - spec/rbnacl/authenticators/poly1305_spec.rb
 - spec/rbnacl/boxes/curve25519xsalsa20poly1305/private_key_spec.rb
 - spec/rbnacl/boxes/curve25519xsalsa20poly1305/public_key_spec.rb

data/spec/rbnacl/aead/chacha20poly1305_orig_spec.rb

@@ -1,14 +0,0 @@
-# encoding: binary
-# frozen_string_literal: true
-
-RSpec.describe RbNaCl::AEAD::Chacha20Poly1305 do
-  include_examples "aead" do
-    let(:key) {vector :aead_chacha20poly1305_orig_key}
-    let(:message) {vector :aead_chacha20poly1305_orig_message}
-    let(:nonce) {vector :aead_chacha20poly1305_orig_nonce}
-    let(:ad) {vector :aead_chacha20poly1305_orig_ad}
-    let(:ciphertext) {vector :aead_chacha20poly1305_orig_ciphertext}
-
-    let(:aead) { RbNaCl::AEAD::Chacha20Poly1305.new(key) }
-  end
-end