aes_key_wrap 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 259a4c54a9c1e9d7c04b0c5af1853702ab9762a0
+  data.tar.gz: c576c30659e2f1ade052b41e988ab9045fd99afd
+SHA512:
+  metadata.gz: 491f321a2568db3fdc4e605c19eb1226163dd3f321598eb0973b295c2fa4ce5b674a7eb4f484a87eac197d425ce7a36164b3ddbcb6b46f3d4c7336b1442cba3d
+  data.tar.gz: 04be2bf30c6aee910095d4438a1f60be36f6f72abe1dfd4ce2788df06268dc72cc7a9ad56f50aacc2cdf59ff084392209805da82731e31009e514dcc6b5e749d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in aes_key_wrap.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Tom Dalling
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,33 @@
+# AESKeyWrap
+
+A Ruby implementation of AES Key Wrap, a.k.a RFC 3394, a.k.a NIST Key Wrap.
+
+## Usage
+
+To wrap a key, call `AESKeyWrap.wrap` with:
+
+ - The plain text key
+ - A key-encrypting key (KEK) 
+ - An "initial value" (optional)
+
+```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)
+```
+
+To unwrap a key, call `AESKeyWrap.unwrap`:
+
+```ruby
+unwrapped = AESKeyWrap.unwrap(wrapped_key, kek, iv)
+```
+
+There also `unwrap!`, which throws an exception if unwrapping
+fails, instead of returning nil:
+
+## Contributing
+
+Make sure it's got tests, then do the usual fork and pull request hooha.
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/aes_key_wrap.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'aes_key_wrap/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'aes_key_wrap'
+  spec.version       = AESKeyWrap::VERSION
+  spec.authors       = ['Tom Dalling']
+  spec.email         = ['tom' + '@tom' + 'dalling.com']
+
+  spec.summary       = %q{A Ruby implementation of AES Key Wrap, a.k.a RFC 3394, a.k.a NIST Key Wrap.}
+  spec.homepage      = 'https://github.com/tomdalling/aes_key_wrap'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.8'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.2.0'
+end
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "aes_key_wrap"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/aes_key_wrap.rb

@@ -0,0 +1,124 @@
+##
+# A Ruby implementation of AES Key Wrap, a.k.a RFC 3394, a.k.a NIST Key Wrapping
+#
+module AESKeyWrap
+  DEFAULT_IV = 0xA6A6A6A6A6A6A6A6
+  UnwrapFailedError = Class.new(StandardError)
+
+  class << self
+
+    ##
+    # Wraps a key using a key-encrypting key (KEK)
+    #
+    # This is an implementation of the "index based" algorithm
+    # specified in section 2.2.1 of RFC 3394:
+    # http://www.ietf.org/rfc/rfc3394.txt
+    #
+    # @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
+    # @return [String] The wrapped key, as a binary string
+    #
+    def wrap(unwrapped_key, kek, iv=DEFAULT_IV)
+      # 1) Initialize variables.
+      #
+      #    P: buffer (from unwrapped_key)
+      #    A: buffer[0]
+      #    R: buffer
+      #    K: kek
+      #    n: block_count
+      #    AES: aes(:encrypt, _, _)
+      #    IV: iv
+      buffer = [iv] + unwrapped_key.unpack('Q>*')
+      block_count = buffer.size - 1
+
+      # 2) Calculate intermediate values.
+      # t: round
+      0.upto(5) do |j|
+        1.upto(block_count) do |i|
+          round = block_count*j + i
+          # In
+          data = [buffer[0], buffer[i]].pack('Q>2')
+          buffer[0], buffer[i] = aes(:encrypt, kek, data).unpack('Q>2')
+          # Enc
+          buffer[0] = buffer[0] ^ round
+          # XorT
+        end
+      end
+
+      # 3) Output the results.
+      buffer.pack('Q>*')
+    end
+
+    ##
+    # Unwraps an encrypted key using a key-encrypting key (KEK)
+    #
+    # This is an implementation of the "index based" algorithm
+    # specified in section 2.2.2 of RFC 3394:
+    # http://www.ietf.org/rfc/rfc3394.txt
+    #
+    # @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
+    # @return [String] The unwrapped (plaintext) key as a binary string, or
+    #                  `nil` if unwrapping failed due to `expected_iv` not matching the
+    #                  decrypted IV
+    #
+    # @see #unwrap!
+    #
+    def unwrap(wrapped_key, kek, expected_iv=DEFAULT_IV)
+      # 1) Initialize variables.
+      #
+      #    C: buffer (from wrapped_key)
+      #    A: buffer[0]
+      #    R: buffer
+      #    n: block_count
+      #    K: kek
+      #    AES-1: aes(:decrypt, _, _)
+      buffer = wrapped_key.unpack('Q>*')
+      block_count = buffer.size - 1
+
+      # 2) Calculate intermediate values.
+      # t: round
+      5.downto(0) do |j|
+        block_count.downto(1) do |i|
+          round = block_count*j + i
+          # In
+          buffer[0] = buffer[0] ^ round
+          # XorT
+          data = [buffer[0], buffer[i]].pack('Q>2')
+          buffer[0], buffer[i] = aes(:decrypt, kek, data).unpack('Q>2')
+          # Dec
+        end
+      end
+
+      # 3) Output the results.
+      if buffer[0] == expected_iv
+        buffer.drop(1).pack('Q>*')
+      else
+        nil
+      end
+    end
+
+    ##
+    # Exception-throwing version of #unwrap
+    #
+    # @see #unwrap
+    #
+    def unwrap!(*args)
+      unwrap(*args) || raise(UnwrapFailedError, 'Unwrapped IV does not match')
+    end
+
+    private
+
+      def aes(encrypt_or_decrypt, key, data)
+        decipher = OpenSSL::Cipher::AES.new(key.bytesize * 8, :ECB)
+        decipher.send(encrypt_or_decrypt)
+        decipher.key = key
+        decipher.padding = 0
+
+        decipher.update(data) + decipher.final
+      end
+  end
+end
+

data/lib/aes_key_wrap/version.rb

@@ -0,0 +1,3 @@
+module AESKeyWrap
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: aes_key_wrap
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tom Dalling
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: 
+email:
+- tom@tomdalling.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- aes_key_wrap.gemspec
+- bin/console
+- bin/setup
+- lib/aes_key_wrap.rb
+- lib/aes_key_wrap/version.rb
+homepage: https://github.com/tomdalling/aes_key_wrap
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+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: []