rbnacl 5.0.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0ff080260ca84ccc368c7c8414627267dffa9348
-  data.tar.gz: 2a3275a27b2ca89e36223529316076b67f895cac
+SHA256:
+  metadata.gz: 00e82b69d0f03bb3d5e4dbe1dbcef2b70aabcbe33630a1c68b9d713a64f52c58
+  data.tar.gz: bdeb5770fd8d698b66ff967b0674c5a06b8e4bc77f24507128a0460dda7be97c
 SHA512:
-  metadata.gz: 32bd4e83ea75ce57d93dcc7c1b2f3249d7e0010694c03d7d9a73a20e1a310ec6b9b6f40e0f190fb454f64eda528ea4e7eb35367d49d04f5ea7aafad270d26ff2
-  data.tar.gz: 9408f5ae9713e018e29a943bb9ddbb64010e9ace49d4cff37b2769e886f09025edba7776dcfbe81372363051b8d7b68cd7e04a583b8eeda87b3d48a17f39607b
+  metadata.gz: a4d5e5c9f0d4a0cf0e264b4f0cc49e071131fd5a158bd732a2e5fb8134a480c63d5fa8f384b853b8ad2010cc5ffad99beb108bf553ae8aaa5ab15f06a96a0ee7
+  data.tar.gz: 5b583ce0415a169b899bac5dcf3210c2ef8b2383bf0e7f1c4a533925892fa8c83aa6dd34db10c772706b4bee0ee9576a6ab51d4326d291a5eba9177a061c9085

data/.gitignore

@@ -17,3 +17,4 @@ test/version_tmp
 tmp
 libsodium
 libsodium-*.tar.gz
+.rakeTasks

data/.rubocop.yml

@@ -1,11 +1,8 @@
 AllCops:
+  TargetRubyVersion: 2.2
   DisplayCopNames: true
-  Include:
-    - '**/Rakefile'
   Exclude:
-    - 'spec/**/*'
     - 'vendor/**/*'
-    - 'lib/rbnacl/test_vectors.rb'
 
 #
 # Metrics
@@ -14,23 +11,45 @@ AllCops:
 Metrics/AbcSize:
   Max: 20
 
+Metrics/BlockLength:
+  Max: 128
+  ExcludedMethods: [ 'describe' ]
+
 Metrics/ClassLength:
-  Max: 150
+  Max: 128
+
+Metrics/LineLength:
+  Max: 128
 
 Metrics/MethodLength:
-  Max: 25
+  CountComments: false
+  Max: 50
+
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+Metrics/PerceivedComplexity:
+  Max: 15
 
 #
-# Style
+# Naming
 #
 
-LineLength:
-  Max: 128
+Naming/UncommunicativeMethodParamName:
+  Enabled: false
 
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
+#
+# Performance
+#
 
-Style/SpaceBeforeFirstArg:
+Performance/UnfreezeString:
+  Enabled: false
+
+#
+# Style
+#
+
+Style/AccessModifierDeclarations:
   Enabled: false
 
 Style/GlobalVars:
@@ -38,3 +57,6 @@ Style/GlobalVars:
 
 Style/SafeNavigation:
   Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/.travis.yml

@@ -1,25 +1,25 @@
 language: ruby
-sudo: false
 cache: bundler
-script: bundle exec rake ci
-bundler_args: --without development
 
-branches:
-  only:
-    - master
+before_install:
+  - sudo add-apt-repository -y ppa:chris-lea/libsodium
+  - sudo apt-get update -q
+  - sudo apt-get install libsodium-dev
+  - gem update --system
+  - gem --version
+  - gem install bundler -v 1.17.1
+  - bundle --version
 
 rvm:
-  - jruby-9.1.6.0
-  - 2.2.6
-  - 2.3.3
-  - 2.4.0
-
-env:
-  - LIBSODIUM_VERSION=1.0.0  # Minimum supported
-  - LIBSODIUM_VERSION=1.0.11 # Latest released
+  - jruby-9.1.15.0
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
 
 matrix:
   fast_finish: true
 
-notifications:
-  irc: "irc.freenode.org#cryptosphere"
+branches:
+  only:
+    - master

data/CHANGES.md

@@ -1,52 +1,76 @@
+## [6.0.0] (2018-11-08)
+
+[6.0.0]: https://github.com/crypto-rb/rbnacl/pull/182
+
+* [#180](https://github.com/crypto-rb/rbnacl/pull/180)
+  Deprecate rbnacl-libsodium.
+  ([@tarcieri])
+
+* [#176](https://github.com/crypto-rb/rbnacl/pull/176)
+  Add support for XChaCha20-Poly1305.
+  ([@AnIrishDuck])
+
+* [#174](https://github.com/crypto-rb/rbnacl/pull/174)
+  Fix buffer size type in `randombytes_buf` binding.
+  ([@elijh])
+
+* [#172](https://github.com/crypto-rb/rbnacl/pull/172)
+  Add support for argon2id digest.
+  ([@trofi])
+
+* [#166](https://github.com/crypto-rb/rbnacl/pull/166)
+  Support for non-32-byte HMAC-SHA256/512 keys.
+  ([@nsheremet])
+
 ## 5.0.0 (2017-06-13)
 
-* [#159](https://github.com/cryptosphere/rbnacl/pull/159)
+* [#159](https://github.com/crypto-rb/rbnacl/pull/159)
   Support the BLAKE2b Initialize-Update-Finalize API.
   ([@fudanchii])
 
 ## 4.0.2 (2017-03-12)
 
-* [#157](https://github.com/cryptosphere/rbnacl/pull/157)
+* [#157](https://github.com/crypto-rb/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)
+* [#148](https://github.com/crypto-rb/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)
+* [#141](https://github.com/crypto-rb/rbnacl/pull/141)
   Add wrappers for ChaCha20Poly1305 AEAD ciphers.
   ([@aadavids])
 
-* [#142](https://github.com/cryptosphere/rbnacl/pull/142)
+* [#142](https://github.com/crypto-rb/rbnacl/pull/142)
   Added support for Argon2 password hash.
   ([@elijh])
 
-* [#143](https://github.com/cryptosphere/rbnacl/pull/143)
+* [#143](https://github.com/crypto-rb/rbnacl/pull/143)
   Require Ruby 2.2.6+.
   ([@tarcieri])
 
 ## 3.4.0 (2015-05-07)
 
-* [#135](https://github.com/cryptosphere/rbnacl/pull/135)
+* [#135](https://github.com/crypto-rb/rbnacl/pull/135)
   Expose `RbNaCl::Signatures::Ed25519#keypair_bytes`.
   ([@grempe])
 
-* [#137](https://github.com/cryptosphere/rbnacl/pull/137)
+* [#137](https://github.com/crypto-rb/rbnacl/pull/137)
   Expose HMAC-SHA512 (with 64-byte keys)
   ([@mwpastore])
 
 ## 3.3.0 (2015-12-29)
 
-* [#105](https://github.com/cryptosphere/rbnacl/pull/105)
+* [#105](https://github.com/crypto-rb/rbnacl/pull/105)
   Add salt/personalisation strings for Blake2b.
   ([@namelessjon])
 
-* [#128](https://github.com/cryptosphere/rbnacl/pull/128)
+* [#128](https://github.com/crypto-rb/rbnacl/pull/128)
   Remove use of Thread.exclusive when initializing library.
   ([@tarcieri])
 
@@ -119,3 +143,6 @@
 [@elijh]: https://github.com/elijh
 [@paragonie-scott]: https://github.com/paragonie-scott
 [@fudanchii]: https://github.com/fudanchii
+[@nsheremet]: https://github.com/nsheremet
+[@trofi]: https://github.com/trofi
+[@AnIrishDuck]: https://github.com/AnIrishDuck

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 gemspec
@@ -7,10 +9,9 @@ group :development do
 end
 
 group :test do
-  gem "rspec"
-  gem "rubocop", "0.46.0"
   gem "coveralls", require: false
-  gem "rbnacl-libsodium", ENV["LIBSODIUM_VERSION"]
+  gem "rspec"
+  gem "rubocop", "= 0.60.0"
 end
 
 group :development, :test do

data/Guardfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 

data/LICENSE.txt

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

data/README.md

@@ -1,15 +1,16 @@
-![RbNaCl](https://raw.github.com/cryptosphere/rbnacl/master/images/logo.png)
+![RbNaCl](https://raw.github.com/crypto-rb/rbnacl/master/images/logo.png)
 ======
 [![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)
-[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/cryptosphere/rbnacl/blob/master/LICENSE.txt)
+[![Build Status](https://travis-ci.org/crypto-rb/rbnacl.svg?branch=master)](https://travis-ci.org/crypto-rb/rbnacl)
+[![Code Climate](https://codeclimate.com/github/crypto-rb/rbnacl.svg)](https://codeclimate.com/github/crypto-rb/rbnacl)
+[![Coverage Status](https://coveralls.io/repos/crypto-rb/rbnacl/badge.svg?branch=master)](https://coveralls.io/r/crypto-rb/rbnacl)
+[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/crypto-rb/rbnacl/blob/master/LICENSE.txt)
+[![Gitter Chat](https://badges.gitter.im/badge.svg)](https://gitter.im/crypto-rb/Lobby)
 
 _NOTE: This is the 5.x **stable** branch of RbNaCl. For the 4.x **legacy**
 branch, please see:_
 
-https://github.com/cryptosphere/rbnacl/tree/4-x-stable
+https://github.com/crypto-rb/rbnacl/tree/4-x-stable
 
 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.
@@ -19,7 +20,7 @@ On a completely unrelated topic, RbNaCl is also the empirical formula for
 Rubidium Sodium Chloride.
 
 Need help with RbNaCl? Join the [RbNaCl Google Group][group].
-We're also on IRC at #cryptosphere on irc.freenode.net
+We're also on IRC at #crypto-rb on irc.freenode.net
 
 [nacl]:  http://nacl.cr.yp.to/
 [djb]:   http://cr.yp.to/djb.html
@@ -56,6 +57,17 @@ For more information on NaCl's goals, see Dan Bernstein's presentation
 
 [Yes.](http://news.ycombinator.com/item?id=3067434)
 
+## Help and Discussion
+
+Have questions? Want to suggest a feature or change? Join a discussion group:
+
+* [Crypto.rb Gitter]: web-based chat about Ruby crypto projects including **RbNaCl**.
+* [Crypto.rb Google Group]: join via web or email ([crypto-rb+subscribe@googlegroups.com])
+
+[Crypto.rb Gitter]: https://gitter.im/crypto-rb/Lobby
+[Crypto.rb Google Group]: https://groups.google.com/forum/#!forum/crypto-rb
+[crypto-rb+subscribe@googlegroups.com]: mailto:crypto-rb+subscribe@googlegroups.com?subject=subscribe
+
 ## Supported platforms
 
 You can use RbNaCl on platforms libsodium is supported (see below).
@@ -65,6 +77,7 @@ versions:
 
 * Ruby 2.2.6+
 * Ruby 2.3.0+
+* Ruby 2.4.2+
 * JRuby 9.1.6.0+
 
 If something doesn't work on one of these versions, it's a bug.
@@ -80,17 +93,14 @@ patches in a timely fashion. If critical issues for a particular implementation
 exist at the time of a major release, support for that Ruby version may be
 dropped.
 
-[travis]: http://travis-ci.org/cryptosphere/rbnacl
+[travis]: http://travis-ci.org/crypto-rb/rbnacl
 
 ## Installation
 
-Note: [Windows installation instructions are available](https://github.com/cryptosphere/rbnacl/wiki/Windows-Installation).
+Note: [Windows installation instructions are available](https://github.com/crypto-rb/rbnacl/wiki/Windows-Installation).
 
 ### libsodium
 
-**NOTE: Want to avoid the hassle of installing libsodium? Use the
-[rbnacl-libsodium](https://github.com/cryptosphere/rbnacl-libsodium) gem**
-
 To use RbNaCl, you will need to install libsodium:
 
 https://github.com/jedisct1/libsodium
@@ -153,13 +163,13 @@ information.
 
 [YARD API documentation][yard] is also available.
 
-[wiki]: https://github.com/cryptosphere/rbnacl/wiki
-[simplebox]: https://github.com/cryptosphere/rbnacl/wiki/SimpleBox
-[secretkey]: https://github.com/cryptosphere/rbnacl/wiki/Secret-Key-Encryption
-[publickey]: https://github.com/cryptosphere/rbnacl/wiki/Public-Key-Encryption
-[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
+[wiki]: https://github.com/crypto-rb/rbnacl/wiki
+[simplebox]: https://github.com/crypto-rb/rbnacl/wiki/SimpleBox
+[secretkey]: https://github.com/crypto-rb/rbnacl/wiki/Secret-Key-Encryption
+[publickey]: https://github.com/crypto-rb/rbnacl/wiki/Public-Key-Encryption
+[signatures]: https://github.com/crypto-rb/rbnacl/wiki/Digital-Signatures
+[macs]: https://github.com/crypto-rb/rbnacl/wiki/HMAC
+[hashes]: https://github.com/crypto-rb/rbnacl/wiki/Hash-Functions
 [yard]: http://www.rubydoc.info/gems/rbnacl
 
 ## Learn More
@@ -209,7 +219,7 @@ Sure, here you go:
 
 ## License
 
-Copyright (c) 2012-2017 Tony Arcieri, Jonathan Stott. Distributed under the MIT License.
+Copyright (c) 2012-2018 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
+[LICENSE.txt]: https://github.com/crypto-rb/rbnacl/blob/master/LICENSE.txt

data/Rakefile

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
+
 require "bundler/gem_tasks"
 
-Dir[File.expand_path("../tasks/**/*.rake", __FILE__)].each { |task| load task }
+Dir[File.expand_path("tasks/**/*.rake", __dir__)].each { |task| load task }
 
-task default: %w(spec rubocop)
-task ci:      %w(spec rubocop)
+task default: %w[spec rubocop]
+task ci:      %w[spec rubocop]

data/lib/rbnacl.rb

@@ -1,6 +1,12 @@
 # encoding: binary
 # frozen_string_literal: true
 
+if defined?(RBNACL_LIBSODIUM_GEM_LIB_PATH)
+  raise "rbnacl-libsodium is not supported by rbnacl 6.0+. "\
+        "Please remove it as a dependency and install libsodium using your system package manager. "\
+        "See https://github.com/crypto-rb/rbnacl#installation"
+end
+
 require "rbnacl/version"
 require "rbnacl/sodium"
 require "rbnacl/sodium/version"
@@ -69,9 +75,7 @@ module RbNaCl
   # Password hash functions
   require "rbnacl/password_hash"
   require "rbnacl/password_hash/scrypt"
-  if RbNaCl::Sodium::Version::ARGON2_SUPPORTED
-    require "rbnacl/password_hash/argon2"
-  end
+  require "rbnacl/password_hash/argon2" if RbNaCl::Sodium::Version::ARGON2_SUPPORTED
 
   # HMAC: SHA256/512 and SHA512256
   require "rbnacl/hmac/sha256"
@@ -81,6 +85,7 @@ module RbNaCl
   # AEAD: ChaCha20-Poly1305
   require "rbnacl/aead/chacha20poly1305_legacy"
   require "rbnacl/aead/chacha20poly1305_ietf"
+  require "rbnacl/aead/xchacha20poly1305_ietf"
 
   #
   # Bind aliases used by the public API

data/lib/rbnacl/aead/base.rb

@@ -51,6 +51,7 @@ module RbNaCl
 
         success = do_encrypt(ciphertext, ciphertext_len, nonce, message, additional_data)
         raise CryptoError, "Encryption failed" unless success
+
         ciphertext
       end
 
@@ -72,6 +73,7 @@ module RbNaCl
 
         success = do_decrypt(message, message_len, nonce, ciphertext, additional_data)
         raise CryptoError, "Decryption failed. Ciphertext failed verification." unless success
+
         message
       end
 
@@ -128,6 +130,7 @@ module RbNaCl
 
       def data_len(data)
         return 0 if data.nil?
+
         data.bytesize
       end
 

data/lib/rbnacl/aead/chacha20poly1305_ietf.rb

@@ -17,11 +17,11 @@ module RbNaCl
 
         sodium_function :aead_chacha20poly1305_ietf_encrypt,
                         :crypto_aead_chacha20poly1305_ietf_encrypt,
-                        [:pointer, :pointer, :pointer, :ulong_long, :pointer, :ulong_long, :pointer, :pointer, :pointer]
+                        %i[pointer pointer pointer ulong_long pointer ulong_long pointer pointer pointer]
 
         sodium_function :aead_chacha20poly1305_ietf_decrypt,
                         :crypto_aead_chacha20poly1305_ietf_decrypt,
-                        [:pointer, :pointer, :pointer, :pointer, :ulong_long, :pointer, :ulong_long, :pointer, :pointer]
+                        %i[pointer pointer pointer pointer ulong_long pointer ulong_long pointer pointer]
 
         private