rbnacl 4.0.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b98225b2e645925d76a0189adf330c81c7b34f68
-  data.tar.gz: 8ccf325edde59b1ba96e29ca0c018a3a1cd0abc8
+  metadata.gz: 2ad004cd262c6ed52566b6a3a957d8880e468038
+  data.tar.gz: 807e63c3416eb1329c105f34be304f0ec0fd3d2d
 SHA512:
-  metadata.gz: 2460addc91d22d5f6e846f8a43aa7e4e582a0763482884700f29be44ee48176f5bd3ca492fe78554a2c0c8f3e10be57d9b4b24c32b670b9441440eec6ac5aa86
-  data.tar.gz: 9d0cc147b8897251d7329aafa78049bd7099fa1726af94249c0c1062a3ff67c069b77d2228983b914d7e6a2b2ae95ca326e64ee2848956b72b91ac6a3c5f4376
+  metadata.gz: 576e8ff0844842e967a529c052e89b3c58bfe0b914d890ec69f78f388a6f15162de6605a5cc67bea1ea0a24d58fcc37c03929054b0752d7d0d3fc65cb4c7239e
+  data.tar.gz: e0d8b0ffd5a309dee7dd43c1d279c523afd0c3ab497b077d7e3c4e56f3d33c6e1145164ae2ec4dff7e09c108234a52f179f5eb3d066c09fa063b66322221431a

data/CHANGES.md

@@ -1,5 +1,12 @@
+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.

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

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/version.rb

@@ -4,5 +4,5 @@
 # NaCl/libsodium for Ruby
 module RbNaCl
   # The library's version
-  VERSION = "4.0.0"
+  VERSION = "4.0.1"
 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/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.1
 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: 2016-12-24 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
@@ -155,7 +155,7 @@ 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