aes_key_wrap 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9c0f645c56b2c0ae94cabd1077535d2a46674367
-  data.tar.gz: f9db99d515349bd73276c3dab991965df415ea4d
+SHA256:
+  metadata.gz: 975893714de4407b4e7810177589efcc6602e32a3586b94b525ba6efc5d61c8e
+  data.tar.gz: 8f10761ae857d59739e0b88c875348374018ec9537da21be113dea8eab97a97f
 SHA512:
-  metadata.gz: e1bc33d21b3971adca4cfe8ebb810ff278e810507dd22462df83a99cd614a95b8bac81ee6bfbe86cb5be386aa97404e8d04ca8f735431091a228fa88ec75159a
-  data.tar.gz: d26e72d021f09467fc09c8cd31bd068fb41001ae0d5619e91d6944746c9adff0f35bd78384bab260148f03b3b4e76d843a24d007c7b753aacc72a2c35bc23665
+  metadata.gz: eac3ed6586dd4aff0b76bab567359969809c6e326aa68210c058f5509d94cecb7c7d35f059f8c8932524dd302e29a2221f0943a1a445111875becf0af2c8c394
+  data.tar.gz: db11cf15a329f48fe0ba8d451c98a63c8bc47bf1dcbd3dd0f4de7227e039a4f4b1c673b8060a945de2d5a3b642dfa19032aa7b9fa3ca5786d83005a55d76abd8

data/.ruby-version

@@ -1 +1 @@
-2.2.0
+2.7

data/.travis.yml

@@ -1 +1,22 @@
+script: bundle exec ruby test/aes_key_wrap.rb
 language: ruby
+
+# test on old rubies
+rvm:
+  - 2.3.8
+  - 2.4.10
+  - 2.5.8
+  - 2.6.6
+
+# run latest ruby differently (run codeclimate)
+matrix:
+  include:
+  - rvm: 2.7.1
+    # code climate config
+    env: CC_TEST_REPORTER_ID=112d90dacd3bbf36bbf39282309a52581175ae544be2cf8ef3b8c0c0221515f5
+    before_script:
+      - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+      - chmod +x ./cc-test-reporter
+      - ./cc-test-reporter before-build
+    after_script:
+      - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.1.0] - 2020-07-12
+### Added
+- IV arguments can be either `String`s or `Integer`s. Previously, they could
+  only be `Integer`s. This is a backwards-compatible addition as long as you
+  aren't doing something freaky with IVs, like using negative numbers (they are
+  supposed to be unsigned).
+
+## [1.0.1] - 2015-04-24
+### Fixed
+- Didn't work unless you had `require 'openssl'` somewhere first. The gem now
+  `require`s its own dependencies, surprising no one.
+
+## [1.0.0] - 2015-04-24
+### Added
+- Everything (Initial release)

data/README.md

@@ -1,4 +1,5 @@
 [![Build Status](https://travis-ci.org/tomdalling/aes_key_wrap.svg?branch=master)](https://travis-ci.org/tomdalling/aes_key_wrap)
+[![Test Coverage](https://codeclimate.com/github/tomdalling/aes_key_wrap/badges/coverage.svg)](https://codeclimate.com/github/tomdalling/aes_key_wrap)
 
 # AESKeyWrap 
 
@@ -14,20 +15,22 @@ To wrap a key, call `AESKeyWrap.wrap` with:
 
 ```ruby
 require 'aes_key_wrap'
+
 plaintext_key = ['00112233445566778899AABBCCDDEEFF'].pack('H*') #binary string
 kek =  ['000102030405060708090A0B0C0D0E0F'].pack('H*') # binary string
-iv = 0xDEADBEEFC0FFEEEE
-wrapped_key = AESKeyWrap.wrap(plaintext_key, kek, iv)
+iv = ['DEADBEEFC0FFEEEE'].pack("H*") # binary string (always 8 bytes)
+
+wrapped_key = AESKeyWrap.wrap(plaintext_key, kek, iv)  # iv is optional
 ```
 
 To unwrap a key, call `AESKeyWrap.unwrap`:
 
 ```ruby
-unwrapped = AESKeyWrap.unwrap(wrapped_key, kek, iv)
+unwrapped = AESKeyWrap.unwrap(wrapped_key, kek, iv)  # iv is optional
 ```
 
-There also `unwrap!`, which throws an exception if unwrapping
-fails, instead of returning nil.
+There also `unwrap!`, which throws an exception if unwrapping fails, instead of
+returning nil.
 
 ## Contributing
 

data/aes_key_wrap.gemspec

@@ -16,7 +16,11 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.2.0'
+  spec.add_development_dependency 'test_bench', '~> 1.0'
+  spec.add_development_dependency 'gem-release'
+
+  # code climate doesn't support v0.18+
+  # see: https://github.com/codeclimate/test-reporter/issues/413
+  spec.add_development_dependency 'simplecov', '< 0.18'
 end
 

data/lib/aes_key_wrap.rb

@@ -5,6 +5,8 @@ require 'openssl'
 #
 module AESKeyWrap
   DEFAULT_IV = 0xA6A6A6A6A6A6A6A6
+  IV_SIZE = 8 # bytes
+
   UnwrapFailedError = Class.new(StandardError)
 
   class << self
@@ -18,7 +20,9 @@ module AESKeyWrap
     #
     # @param unwrapped_key [String] The plaintext key to be wrapped, as a binary string
     # @param kek [String] The key-encrypting key, as a binary_string
-    # @param iv [Integer] The "initial value", as unsigned 64bit integer
+    # @param iv [Integer, String] The "initial value", as either an unsigned
+    #   64-bit integer (e.g. `0xDEADBEEFC0FFEEEE`) or an 8-byte string (e.g.
+    #   `"\xDE\xAD\xBE\xEF\xC0\xFF\xEE\xEE"`).
     # @return [String] The wrapped key, as a binary string
     #
     def wrap(unwrapped_key, kek, iv=DEFAULT_IV)
@@ -31,7 +35,7 @@ module AESKeyWrap
       #    n: block_count
       #    AES: aes(:encrypt, _, _)
       #    IV: iv
-      buffer = [iv] + unwrapped_key.unpack('Q>*')
+      buffer = [coerce_uint64(iv)] + unwrapped_key.unpack('Q>*')
       block_count = buffer.size - 1
 
       # 2) Calculate intermediate values.
@@ -61,10 +65,12 @@ module AESKeyWrap
     #
     # @param wrapped_key [String] The wrapped key (cyphertext), as a binary string
     # @param kek [String] The key-encrypting key, as a binary string
-    # @param expected_iv [Integer] The IV used to wrap the key, as an unsigned 64bit integer
+    # @param expected_iv [Integer, String] The IV used to wrap the key, as either
+    #   an unsigned 64-bit integer (e.g. `0xDEADBEEFC0FFEEEE`) or an 8-byte
+    #   string (e.g. `"\xDE\xAD\xBE\xEF\xC0\xFF\xEE\xEE"`).
     # @return [String] The unwrapped (plaintext) key as a binary string, or
-    #                  `nil` if unwrapping failed due to `expected_iv` not matching the
-    #                  decrypted IV
+    #   `nil` if unwrapping failed due to `expected_iv` not matching the
+    #   decrypted IV
     #
     # @see #unwrap!
     #
@@ -95,7 +101,7 @@ module AESKeyWrap
       end
 
       # 3) Output the results.
-      if buffer[0] == expected_iv
+      if buffer[0] == coerce_uint64(expected_iv)
         buffer.drop(1).pack('Q>*')
       else
         nil
@@ -113,6 +119,8 @@ module AESKeyWrap
 
     private
 
+      MAX_UINT64 = 0xFFFFFFFFFFFFFFFF
+
       def aes(encrypt_or_decrypt, key, data)
         decipher = OpenSSL::Cipher::AES.new(key.bytesize * 8, :ECB)
         decipher.send(encrypt_or_decrypt)
@@ -121,6 +129,27 @@ module AESKeyWrap
 
         decipher.update(data) + decipher.final
       end
+
+      def coerce_uint64(value)
+        case value
+        when Integer
+          if value > MAX_UINT64
+            raise ArgumentError, "IV is too large to fit in a 64-bit unsigned integer"
+          elsif value < 0
+            raise ArgumentError, "IV is not an unsigned integer (it's negative)"
+          else
+            value
+          end
+        when String
+          if value.bytesize == IV_SIZE
+            value.unpack("Q>").first
+          else
+            raise ArgumentError, "IV is not #{IV_SIZE} bytes long"
+          end
+        else
+          raise ArgumentError, "IV is not valid: #{value.inspect}"
+        end
+      end
   end
 end
 

data/lib/aes_key_wrap/version.rb

@@ -1,3 +1,3 @@
 module AESKeyWrap
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,43 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: aes_key_wrap
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Tom Dalling
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-24 00:00:00.000000000 Z
+date: 2020-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: test_bench
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: gem-release
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '0.18'
 description: 
 email:
 - tom@tomdalling.com
@@ -46,13 +60,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".rspec"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - aes_key_wrap.gemspec
 - bin/console
 - bin/setup
@@ -77,10 +90,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A Ruby implementation of AES Key Wrap, a.k.a RFC 3394, a.k.a NIST Key Wrap.
 test_files: []
-has_rdoc: 

data/.rspec

@@ -1,2 +0,0 @@
---format documentation
---color

data/Rakefile

@@ -1,9 +0,0 @@
-require "bundler/gem_tasks"
-
-begin
-  require 'rspec/core/rake_task'
-  RSpec::Core::RakeTask.new(:spec)
-rescue LoadError
-end
-
-task :default => :spec