rbnacl 3.1.2 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe8acfa46de2179b61050402d960a9d1e9a07422
-  data.tar.gz: 5c2a37dd6ab6ff202331f467fc38ae94c879b256
+  metadata.gz: d579b906e40df02d066ed657b294a03258e973c1
+  data.tar.gz: efa52b89d6fa69c64e353bba805b54da1e4cd75e
 SHA512:
-  metadata.gz: 00495b472d456ba7ddcccfab9350397ddb54b273747c3fe497e29f0fd6e17a676b6abd07cb095ff1a48154bd48c71e7fdb6025aa4cf82873ec65d3c9f6a18af7
-  data.tar.gz: 17f5ce6876d8fd7331982df0135a489ecbee45d66382020b13d80139ea0ba642420ebf2eadc2e7cf9f6706e603e7a768215c3a921daa9775a28ff73c2f0b37f2
+  metadata.gz: bc23cabab38ee76841891e5f8ea39c864e2d3053ba70b2b27bce1a4f4699a9260ae20dba5134ecc5eb0264b4d177aae56938aaba8cf94ce20831cf99b3147f81
+  data.tar.gz: c5a70483933ff229e6ef2732d94032a95762c82e37c4fab8d02e551e2b4fc55db1e8706f67ee964d21ccd3f9a40bdc7454473891a1d982bd6479fef24b85e47f

data/.rubocop.yml

@@ -0,0 +1,27 @@
+#
+# Style
+#
+
+# TODO: turn this down
+LineLength:
+  Max: 150
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/SingleSpaceBeforeFirstArg:
+  Enabled: false
+
+Style/GlobalVars:
+  Enabled: false
+
+#
+# Metrics
+#
+
+Metrics/MethodLength:
+  CountComments: false
+  Max: 25
+
+Metrics/AbcSize:
+  Max: 20

data/.travis.yml

@@ -1,15 +1,16 @@
-script: "LD_LIBRARY_PATH=lib bundle exec rake ci"
+script: bundle exec rake ci
 
 rvm:
-  - 1.9.3
   - 2.0.0
-  - 2.1.2
+  - 2.1.4
+  - 2.2.2
   - ruby-head
   - jruby
   - jruby-head
   - rbx-2
 
 matrix:
+  fast_finish: true
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head

data/CHANGES.md

@@ -1,3 +1,8 @@
+3.2.0 (2015-05-31)
+------------------
+* Fix method signature for blake2b
+* RuboCop-friendly codebase
+
 3.1.2 (2014-08-30)
 ------------------
 * Fix scrypt support with libsodium 0.7.0 (scryptsalsa208sha256)

data/Gemfile

@@ -1,12 +1,17 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in rbnacl.gemspec
 gemspec
 
 group :development do
-  gem 'guard-rspec'
+  gem "guard-rspec"
 end
 
 group :test do
-  gem 'coveralls', :require => false
+  gem "coveralls", require: false
+  gem "rbnacl-libsodium"
+end
+
+group :development, :test do
+  gem "rubocop"
 end

data/Guardfile

@@ -4,5 +4,5 @@
 guard :rspec do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
+  watch("spec/spec_helper.rb")  { "spec" }
 end

data/README.md

@@ -1,9 +1,9 @@
 ![RbNaCl](https://raw.github.com/cryptosphere/rbnacl/master/images/logo.png)
 ======
-[![Gem Version](https://badge.fury.io/rb/rbnacl.png)](http://badge.fury.io/rb/rbnacl)
-[![Build Status](https://travis-ci.org/cryptosphere/rbnacl.png?branch=master)](https://travis-ci.org/cryptosphere/rbnacl)
-[![Code Climate](https://codeclimate.com/github/cryptosphere/rbnacl.png)](https://codeclimate.com/github/cryptosphere/rbnacl)
-[![Coverage Status](https://coveralls.io/repos/cryptosphere/rbnacl/badge.png?branch=master)](https://coveralls.io/r/cryptosphere/rbnacl)
+[![Gem Version](https://badge.fury.io/rb/rbnacl.svg)](http://badge.fury.io/rb/rbnacl)
+[![Build Status](https://travis-ci.org/cryptosphere/rbnacl.svg?branch=master)](https://travis-ci.org/cryptosphere/rbnacl)
+[![Code Climate](https://codeclimate.com/github/cryptosphere/rbnacl.svg)](https://codeclimate.com/github/cryptosphere/rbnacl)
+[![Coverage Status](https://coveralls.io/repos/cryptosphere/rbnacl/badge.svg?branch=master)](https://coveralls.io/r/cryptosphere/rbnacl)
 
 A Ruby binding to the state-of-the-art [Networking and Cryptography][nacl]
 library by [Daniel J. Bernstein][djb]. This is **NOT** Google Native Client.
@@ -55,8 +55,7 @@ For more information on NaCl's goals, see Dan Bernstein's presentation
 You can use RbNaCl anywhere you can get libsodium installed (see below).
 RbNaCl is continuously integration tested on the following Ruby VMs:
 
-* MRI 2.0, 2.1
-* MRI 1.9 (YARV)
+* MRI 2.0, 2.1, 2.2
 * JRuby 1.7 (in both 1.8/1.9 mode)
 * Rubinius HEAD (in both 1.8/1.9 mode)
 

data/Rakefile

@@ -1,5 +1,6 @@
 require "bundler/gem_tasks"
+
 Dir[File.expand_path("../tasks/**/*.rake", __FILE__)].each { |task| load task }
-require File.expand_path("../lib/rbnacl/rake_tasks", __FILE__)
 
-task :default => %w(spec rubocop)
+task default: %w(spec rubocop)
+task ci:      %w(spec rubocop)

data/lib/rbnacl.rb

@@ -11,6 +11,7 @@ require "rbnacl/simple_box"
 require "rbnacl/test_vectors"
 require "rbnacl/init"
 
+# NaCl/libsodium for Ruby
 module RbNaCl
   # Oh no, something went wrong!
   #
@@ -37,7 +38,6 @@ module RbNaCl
   # The authenticator was forged or otherwise corrupt
   class BadAuthenticatorError < CryptoError; end
 
-
   # Public Key Encryption (Box): Curve25519XSalsa20Poly1305
   require "rbnacl/boxes/curve25519xsalsa20poly1305"
   require "rbnacl/boxes/curve25519xsalsa20poly1305/private_key"

data/lib/rbnacl/auth.rb

@@ -1,6 +1,5 @@
 # encoding: binary
 module RbNaCl
-
   # Secret Key Authenticators
   #
   # These provide a means of verifying the integrity of a message, but only
@@ -71,7 +70,7 @@ module RbNaCl
     def verify(authenticator, message)
       auth = authenticator.to_s
       Util.check_length(auth, tag_bytes, "Provided authenticator")
-      verify_message(auth, message) || raise(BadAuthenticatorError, "Invalid authenticator provided, message is corrupt")
+      verify_message(auth, message) || fail(BadAuthenticatorError, "Invalid authenticator provided, message is corrupt")
     end
 
     # The crypto primitive for this authenticator instance
@@ -84,25 +83,39 @@ module RbNaCl
     # The number of key bytes for this Auth class
     #
     # @return [Integer] number of key bytes
-    def self.key_bytes; self::KEYBYTES; end
+    def self.key_bytes
+      self::KEYBYTES
+    end
 
     # The number of key bytes for this Auth instance
     #
     # @return [Integer] number of key bytes
-    def key_bytes; self.class.key_bytes; end
+    def key_bytes
+      self.class.key_bytes
+    end
 
     # The number bytes in the tag or authenticator from this Auth class
     #
     # @return [Integer] number of tag bytes
-    def self.tag_bytes; self::BYTES; end
+    def self.tag_bytes
+      self::BYTES
+    end
 
     # The number of bytes in the tag or authenticator for this Auth instance
     #
     # @return [Integer] number of tag bytes
-    def tag_bytes; self.class.tag_bytes; end
+    def tag_bytes
+      self.class.tag_bytes
+    end
 
     private
-    def compute_authenticator(authenticator, message); raise NotImplementedError; end
-    def verify_message(authenticator, message);        raise NotImplementedError; end
+
+    def compute_authenticator(_authenticator, _message)
+      fail NotImplementedError
+    end
+
+    def verify_message(_authenticator, _message)
+      fail NotImplementedError
+    end
   end
 end

data/lib/rbnacl/boxes/curve25519xsalsa20poly1305.rb

@@ -80,7 +80,7 @@ module RbNaCl
       sodium_function :box_curve25519xsalsa20poly1305_open_afternm,
                       :crypto_box_curve25519xsalsa20poly1305_open_afternm,
                       [:pointer, :pointer, :ulong_long, :pointer, :pointer]
-      
+
       sodium_function :box_curve25519xsalsa20poly1305_afternm,
                       :crypto_box_curve25519xsalsa20poly1305_afternm,
                       [:pointer, :pointer, :ulong_long, :pointer, :pointer]
@@ -97,9 +97,9 @@ module RbNaCl
       #
       # @return [RbNaCl::Box] The new Box, ready to use
       def initialize(public_key, private_key)
-        @public_key   = PublicKey  === public_key  ? public_key  : PublicKey.new(public_key)
-        @private_key  = PrivateKey === private_key ? private_key : PrivateKey.new(private_key)
-        raise IncorrectPrimitiveError unless @public_key.primitive == primitive && @private_key.primitive == primitive
+        @public_key   = public_key.is_a?(PublicKey) ? public_key : PublicKey.new(public_key)
+        @private_key  = private_key.is_a?(PrivateKey) ? private_key : PrivateKey.new(private_key)
+        fail IncorrectPrimitiveError unless @public_key.primitive == primitive && @private_key.primitive == primitive
       end
 
       # Encrypts a message
@@ -121,10 +121,10 @@ module RbNaCl
         msg = Util.prepend_zeros(ZEROBYTES, message)
         ct  = Util.zeros(msg.bytesize)
 
-        self.class.box_curve25519xsalsa20poly1305_afternm(ct, msg, msg.bytesize, nonce, beforenm) || raise(CryptoError, "Encryption failed")
+        self.class.box_curve25519xsalsa20poly1305_afternm(ct, msg, msg.bytesize, nonce, beforenm) || fail(CryptoError, "Encryption failed")
         Util.remove_zeros(BOXZEROBYTES, ct)
       end
-      alias encrypt box
+      alias_method :encrypt, :box
 
       # Decrypts a ciphertext
       #
@@ -145,10 +145,12 @@ module RbNaCl
         ct = Util.prepend_zeros(BOXZEROBYTES, ciphertext)
         message  = Util.zeros(ct.bytesize)
 
-        self.class.box_curve25519xsalsa20poly1305_open_afternm(message, ct, ct.bytesize, nonce, beforenm) || raise(CryptoError, "Decryption failed. Ciphertext failed verification.")
+        success = self.class.box_curve25519xsalsa20poly1305_open_afternm(message, ct, ct.bytesize, nonce, beforenm)
+        fail CryptoError, "Decryption failed. Ciphertext failed verification." unless success
+
         Util.remove_zeros(ZEROBYTES, message)
       end
-      alias decrypt open
+      alias_method :decrypt, :open
 
       # The crypto primitive for the box class
       #
@@ -172,12 +174,14 @@ module RbNaCl
       end
 
       private
+
       def beforenm
-        @k ||= begin
-                 k = Util.zeros(BEFORENMBYTES)
-                 self.class.box_curve25519xsalsa20poly1305_beforenm(k, @public_key.to_s, @private_key.to_s) || raise(CryptoError, "Failed to derive shared key")
-                 k
-               end
+        @_key ||= begin
+          key = Util.zeros(BEFORENMBYTES)
+          success = self.class.box_curve25519xsalsa20poly1305_beforenm(key, @public_key.to_s, @private_key.to_s)
+          fail CryptoError, "Failed to derive shared key" unless success
+          key
+        end
       end
     end
   end

data/lib/rbnacl/boxes/curve25519xsalsa20poly1305/private_key.rb

@@ -1,79 +1,82 @@
 # encoding: binary
 
 module RbNaCl
-  # RbNaCl::Box private key. Keep it safe
-  #
-  # This class generates and stores NaCL private keys, as well as providing a
-  # reference to the public key associated with this private key, if that's
-  # provided.
-  #
-  # Note that the documentation for NaCl refers to this as a secret key, but in
-  # this library its a private key, to avoid confusing the issue with the
-  # SecretBox, which does symmetric encryption.
-  class Boxes::Curve25519XSalsa20Poly1305::PrivateKey
+  module Boxes
+    class Curve25519XSalsa20Poly1305
+      # RbNaCl::Box private key. Keep it safe
+      #
+      # This class generates and stores NaCL private keys, as well as providing a
+      # reference to the public key associated with this private key, if that's
+      # provided.
+      #
+      # Note that the documentation for NaCl refers to this as a secret key, but in
+      # this library its a private key, to avoid confusing the issue with the
+      # SecretBox, which does symmetric encryption.
+      class PrivateKey
+        include KeyComparator
+        include Serializable
 
-    include KeyComparator
-    include Serializable
-      
-    extend Sodium
+        extend Sodium
 
-    sodium_type      :box
-    sodium_primitive :curve25519xsalsa20poly1305
+        sodium_type      :box
+        sodium_primitive :curve25519xsalsa20poly1305
 
-    sodium_function :box_curve25519xsalsa20poly1305_keypair,
-                    :crypto_box_curve25519xsalsa20poly1305_keypair,
-                    [:pointer, :pointer]
+        sodium_function  :box_curve25519xsalsa20poly1305_keypair,
+                         :crypto_box_curve25519xsalsa20poly1305_keypair,
+                         [:pointer, :pointer]
 
-    # The size of the key, in bytes
-    BYTES = Boxes::Curve25519XSalsa20Poly1305::PRIVATEKEYBYTES
+        # The size of the key, in bytes
+        BYTES = Boxes::Curve25519XSalsa20Poly1305::PRIVATEKEYBYTES
 
-    # Initializes a new PrivateKey for key operations.
-    #
-    # Takes the (optionally encoded) private key bytes.  This class can then be
-    # used for various key operations, including deriving the corresponding
-    # PublicKey
-    #
-    # @param private_key [String] The private key
-    #
-    # @raise [TypeError] If the key is nil
-    # @raise [RbNaCl::LengthError] If the key is not valid after decoding.
-    #
-    # @return A new PrivateKey
-    def initialize(private_key)
-      @private_key = Util.check_string(private_key, BYTES, "Private key")
-    end
+        # Initializes a new PrivateKey for key operations.
+        #
+        # Takes the (optionally encoded) private key bytes.  This class can then be
+        # used for various key operations, including deriving the corresponding
+        # PublicKey
+        #
+        # @param private_key [String] The private key
+        #
+        # @raise [TypeError] If the key is nil
+        # @raise [RbNaCl::LengthError] If the key is not valid after decoding.
+        #
+        # @return A new PrivateKey
+        def initialize(private_key)
+          @private_key = Util.check_string(private_key, BYTES, "Private key")
+        end
 
-    # Generates a new keypair
-    #
-    # @raise [RbNaCl::CryptoError] if key generation fails, due to insufficient randomness.
-    #
-    # @return [RbNaCl::PrivateKey] A new private key, with the associated public key also set.
-    def self.generate
-      pk = Util.zeros(Boxes::Curve25519XSalsa20Poly1305::PUBLICKEYBYTES)
-      sk = Util.zeros(Boxes::Curve25519XSalsa20Poly1305::PRIVATEKEYBYTES)
-      self.box_curve25519xsalsa20poly1305_keypair(pk, sk) || raise(CryptoError, "Failed to generate a key pair")
-      new(sk)
-    end
+        # Generates a new keypair
+        #
+        # @raise [RbNaCl::CryptoError] if key generation fails, due to insufficient randomness.
+        #
+        # @return [RbNaCl::PrivateKey] A new private key, with the associated public key also set.
+        def self.generate
+          pk = Util.zeros(Boxes::Curve25519XSalsa20Poly1305::PUBLICKEYBYTES)
+          sk = Util.zeros(Boxes::Curve25519XSalsa20Poly1305::PRIVATEKEYBYTES)
+          box_curve25519xsalsa20poly1305_keypair(pk, sk) || fail(CryptoError, "Failed to generate a key pair")
+          new(sk)
+        end
 
-    # The raw bytes of the key
-    #
-    # @return [String] the raw bytes.
-    def to_bytes
-      @private_key
-    end
+        # The raw bytes of the key
+        #
+        # @return [String] the raw bytes.
+        def to_bytes
+          @private_key
+        end
 
-    # the public key associated with this private key
-    #
-    # @return [PublicKey] the key
-    def public_key
-      @public_key ||= PublicKey.new GroupElements::Curve25519.base.mult(to_bytes)
-    end
-    
-    # The crypto primitive this PrivateKey is to be used for.
-    #
-    # @return [Symbol] The primitive
-    def primitive
-      self.class.primitive
+        # the public key associated with this private key
+        #
+        # @return [PublicKey] the key
+        def public_key
+          @public_key ||= PublicKey.new GroupElements::Curve25519.base.mult(to_bytes)
+        end
+
+        # The crypto primitive this PrivateKey is to be used for.
+        #
+        # @return [Symbol] The primitive
+        def primitive
+          self.class.primitive
+        end
+      end
     end
   end
 end

data/lib/rbnacl/boxes/curve25519xsalsa20poly1305/public_key.rb

@@ -1,53 +1,55 @@
 # encoding: binary
 
 module RbNaCl
-  # RbNaCl::Box public key. Send it (securely!) to your friends.
-  #
-  # This class stores the NaCL public key, and provides some convenience
-  # functions for working with it.
-  class Boxes::Curve25519XSalsa20Poly1305::PublicKey
-
-    include KeyComparator
-    include Serializable
-
-    # The size of the key, in bytes
-    BYTES = Boxes::Curve25519XSalsa20Poly1305::PUBLICKEYBYTES
-
-    # Initializes a new PublicKey for key operations.
-    #
-    # Takes the (optionally encoded) public key bytes.  This can be shared with
-    # many people and used to establish key pairs with their private key, for
-    # the exchanging of messages using a RbNaCl::Box
-    #
-    # @param public_key [String] The public key
-    #
-    # @raise [RbNaCl::LengthError] If the key is not valid after decoding.
-    #
-    # @return A new PublicKey
-    def initialize(public_key)
-      @public_key = Util.check_string(public_key, BYTES, "Public key")
-    end
-
-    # The raw bytes of the key
-    #
-    # @return [String] the raw bytes.
-    def to_bytes
-      @public_key
-    end
-
-    # The crypto primitive the PublicKey class is to be used for
-    #
-    # @return [Symbol] The primitive
-    def self.primitive
-      :curve25519xsalsa20poly1305
-    end
-
-    # The crypto primitive this PublicKey is to be used for.
-    #
-    # @return [Symbol] The primitive
-    def primitive
-      self.class.primitive
+  module Boxes
+    class Curve25519XSalsa20Poly1305
+      # RbNaCl::Box public key. Send it (securely!) to your friends.
+      #
+      # This class stores the NaCL public key, and provides some convenience
+      # functions for working with it.
+      class PublicKey
+        include KeyComparator
+        include Serializable
+
+        # The size of the key, in bytes
+        BYTES = Boxes::Curve25519XSalsa20Poly1305::PUBLICKEYBYTES
+
+        # Initializes a new PublicKey for key operations.
+        #
+        # Takes the (optionally encoded) public key bytes.  This can be shared with
+        # many people and used to establish key pairs with their private key, for
+        # the exchanging of messages using a RbNaCl::Box
+        #
+        # @param public_key [String] The public key
+        #
+        # @raise [RbNaCl::LengthError] If the key is not valid after decoding.
+        #
+        # @return A new PublicKey
+        def initialize(public_key)
+          @public_key = Util.check_string(public_key, BYTES, "Public key")
+        end
+
+        # The raw bytes of the key
+        #
+        # @return [String] the raw bytes.
+        def to_bytes
+          @public_key
+        end
+
+        # The crypto primitive the PublicKey class is to be used for
+        #
+        # @return [Symbol] The primitive
+        def self.primitive
+          :curve25519xsalsa20poly1305
+        end
+
+        # The crypto primitive this PublicKey is to be used for.
+        #
+        # @return [Symbol] The primitive
+        def primitive
+          self.class.primitive
+        end
+      end
     end
   end
-
 end