jwa 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f154fe25018f76d01fdefa5241f8fef1c97441fc
+  data.tar.gz: 03bf77eb30a19f599a3bcca86fb596191d2fdc41
+SHA512:
+  metadata.gz: b4e2acc04af0e0e5f4cf6a95b59d08cc5507023525a17669a42900d21af96ff2470a8bcbafb19df63194cdcc5beb2f48e61657da4a9a0a04218d4018849e7618
+  data.tar.gz: 9438c78e5962c00f466fb2899b1b4140d18b699a10375858df84efec25a40f4204722634987a513dbb22f281b85017a5e8a2e73b6714b89fa04a69df8985b06c

data/.codeclimate.yml

@@ -0,0 +1,15 @@
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+  rubocop:
+    enabled: true
+
+ratings:
+  paths:
+    - lib/**
+
+exclude_paths:
+  - spec/**/*

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.ruby-gemset
+/.ruby-version
+Gemfile.lock
+/coverage
+.byebug_history
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,16 @@
+Metrics/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+Style/Documentation:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Lint/RescueException:
+  Exclude:
+    - spec/**/*

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+dist: trusty
+rvm:
+  - jruby-9.1.9.0
+  - 2.0.0-p648
+  - 2.1.10
+  - 2.2.8
+  - 2.3.5
+  - 2.4.2
+
+after_script:
+  - bundle exec codeclimate-test-reporter
+
+env:
+  CODECLIMATE_REPO_TOKEN: 085192d9e3537c39bd01d2f110619ba42dfc7899f5aaa883b612cf0cabdd65d4 

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,23 @@
+The MIT License (MIT)
+=====================
+
+* Copyright © 2017 Francesco Boffa
+
+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,26 @@
+# JWA
+
+[![Build Status](https://travis-ci.org/jwt/ruby-jwa.svg)](https://travis-ci.org/jwt/ruby-jwa)
+[![Code Climate](https://codeclimate.com/github/jwt/ruby-jwa/badges/gpa.svg)](https://codeclimate.com/github/jwt/ruby-jwa)
+[![Test Coverage](https://codeclimate.com/github/jwt/ruby-jwa/badges/coverage.svg)](https://codeclimate.com/github/jwt/ruby-jwa/coverage)
+
+A ruby implementation of the RFC 7518 JSON Web Algorithms (JWA) standard.
+
+## Installation
+
+    $ gem install jwa
+
+## Usage
+
+TODO: Write usage instructions here
+
+## License
+
+The MIT License
+
+Copyright © 2017 Francesco Boffa
+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/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'jwa'
+
+# 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(__FILE__)

data/bin/setup

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

data/jwa.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jwa/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jwa'
+  spec.version       = JWA::VERSION
+  spec.authors       = ['Francesco Boffa']
+  spec.email         = ['fra.boffa@gmail.com']
+
+  spec.summary       = 'JSON Web Algorithms implementation in Ruby'
+  spec.description   = 'A Ruby implementation of the RFC 7518 JSON Web Algorithms (JWA) standard'
+  spec.homepage      = 'https://github.com/jwt/ruby-jwa'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files`.split("\n")
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'jwk'
+
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+end

data/lib/jwa.rb

@@ -0,0 +1,16 @@
+require 'base64'
+require 'json'
+require 'jwk'
+require 'openssl'
+require 'securerandom'
+
+require 'jwa/algorithms'
+require 'jwa/cipher'
+require 'jwa/version'
+
+require 'jwa/support/concat_kdf'
+require 'jwa/support/pbkdf2'
+
+module JWA
+  class BadDecrypt < StandardError; end
+end

data/lib/jwa/algorithms.rb

@@ -0,0 +1,2 @@
+require 'jwa/algorithms/content_encryption'
+require 'jwa/algorithms/key_management'

data/lib/jwa/algorithms/content_encryption.rb

@@ -0,0 +1,29 @@
+require 'jwa/algorithms/content_encryption/a128_cbc_hs256'
+require 'jwa/algorithms/content_encryption/a192_cbc_hs384'
+require 'jwa/algorithms/content_encryption/a256_cbc_hs512'
+
+require 'jwa/algorithms/content_encryption/a128_gcm'
+require 'jwa/algorithms/content_encryption/a192_gcm'
+require 'jwa/algorithms/content_encryption/a256_gcm'
+
+module JWA
+  module Algorithms
+    module ContentEncryption
+      KNOWN_ENCS = {
+        'A128CBC-HS256' => A128CbcHs256,
+        'A192CBC-HS384' => A192CbcHs384,
+        'A256CBC-HS512' => A256CbcHs512,
+
+        'A128GCM' => A128Gcm,
+        'A192GCM' => A192Gcm,
+        'A256GCM' => A256Gcm
+      }.freeze
+
+      class << self
+        def for(name)
+          KNOWN_ENCS[name]
+        end
+      end
+    end
+  end
+end

data/lib/jwa/algorithms/content_encryption/a128_cbc_hs256.rb

@@ -0,0 +1,29 @@
+require 'jwa/algorithms/content_encryption/aes_cbc_hs'
+
+module JWA
+  module Algorithms
+    module ContentEncryption
+      class A128CbcHs256
+        include AesCbcHs
+
+        class << self
+          def enc_name
+            'A128CBC-HS256'
+          end
+
+          def key_length
+            32
+          end
+
+          def cipher_name
+            'AES-128-CBC'
+          end
+
+          def hash
+            OpenSSL::Digest::SHA256.new
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jwa/algorithms/content_encryption/a128_gcm.rb

@@ -0,0 +1,25 @@
+require 'jwa/algorithms/content_encryption/aes_gcm'
+
+module JWA
+  module Algorithms
+    module ContentEncryption
+      class A128Gcm
+        include AesGcm
+
+        class << self
+          def enc_name
+            'A128GCM'
+          end
+
+          def key_length
+            16
+          end
+
+          def cipher_name
+            'aes-128-gcm'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jwa/algorithms/content_encryption/a192_cbc_hs384.rb

@@ -0,0 +1,29 @@
+require 'jwa/algorithms/content_encryption/aes_cbc_hs'
+
+module JWA
+  module Algorithms
+    module ContentEncryption
+      class A192CbcHs384
+        include AesCbcHs
+
+        class << self
+          def enc_name
+            'A192CBC-HS384'
+          end
+
+          def key_length
+            48
+          end
+
+          def cipher_name
+            'AES-192-CBC'
+          end
+
+          def hash
+            OpenSSL::Digest::SHA384.new
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jwa/algorithms/content_encryption/a192_gcm.rb

@@ -0,0 +1,25 @@
+require 'jwa/algorithms/content_encryption/aes_gcm'
+
+module JWA
+  module Algorithms
+    module ContentEncryption
+      class A192Gcm
+        include AesGcm
+
+        class << self
+          def enc_name
+            'A192GCM'
+          end
+
+          def key_length
+            24
+          end
+
+          def cipher_name
+            'aes-192-gcm'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jwa/algorithms/content_encryption/a256_cbc_hs512.rb

@@ -0,0 +1,29 @@
+require 'jwa/algorithms/content_encryption/aes_cbc_hs'
+
+module JWA
+  module Algorithms
+    module ContentEncryption
+      class A256CbcHs512
+        include AesCbcHs
+
+        class << self
+          def enc_name
+            'A256CBC-HS512'
+          end
+
+          def key_length
+            64
+          end
+
+          def cipher_name
+            'AES-256-CBC'
+          end
+
+          def hash
+            OpenSSL::Digest::SHA512.new
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jwa/algorithms/content_encryption/a256_gcm.rb

@@ -0,0 +1,25 @@
+require 'jwa/algorithms/content_encryption/aes_gcm'
+
+module JWA
+  module Algorithms
+    module ContentEncryption
+      class A256Gcm
+        include AesGcm
+
+        class << self
+          def enc_name
+            'A256GCM'
+          end
+
+          def key_length
+            32
+          end
+
+          def cipher_name
+            'aes-256-gcm'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jwa/algorithms/content_encryption/aes_cbc_hs.rb

@@ -0,0 +1,85 @@
+require 'jwa/cipher'
+
+module JWA
+  module Algorithms
+    module ContentEncryption
+      # Abstract AES in CBC mode, with SHA2 signature for different key sizes.
+      module AesCbcHs
+        attr_reader :key, :iv
+
+        def initialize(key, iv = nil)
+          @key = key
+          @iv = iv || SecureRandom.random_bytes(16)
+
+          if @key.length != self.class.key_length
+            raise ArgumentError, "Invalid Key. Expected length: #{self.class.key_length}. Actual: #{@key.length}."
+          end
+
+          if @iv.length != 16
+            raise ArgumentError, "Invalid IV. Expected length: 16. Actual: #{@iv.length}."
+          end
+        end
+
+        def encrypt(plaintext, authenticated_data)
+          ciphertext = cipher_round(:encrypt, plaintext)
+          signature = generate_tag(authenticated_data, ciphertext)
+
+          [ciphertext, signature]
+        end
+
+        def decrypt(ciphertext, authenticated_data, tag)
+          signature = generate_tag(authenticated_data, ciphertext)
+          if signature != tag
+            raise JWA::BadDecrypt, 'Signature check failed. The AAD may have been tampered.'
+          end
+
+          cipher_round(:decrypt, ciphertext)
+        rescue OpenSSL::Cipher::CipherError
+          raise JWA::BadDecrypt, 'Invalid ciphertext or authentication tag.'
+        end
+
+        def cipher_round(direction, data)
+          cipher.send(direction)
+          cipher.key = enc_key
+          cipher.iv = @iv
+
+          cipher.update(data) + cipher.final
+        end
+
+        def generate_tag(authenticated_data, ciphertext)
+          length = [authenticated_data.length * 8].pack('Q>') # 64bit big endian
+
+          to_sign = authenticated_data + @iv + ciphertext + length
+          signature = OpenSSL::HMAC.digest(self.class.hash, mac_key, to_sign)
+
+          signature[0...mac_key.length]
+        end
+
+        def mac_key
+          @key[0...self.class.key_length / 2]
+        end
+
+        def enc_key
+          @key[self.class.key_length / 2..-1]
+        end
+
+        def cipher
+          @cipher ||= Cipher.for(self.class.cipher_name)
+        end
+
+        def self.included(base)
+          base.extend(ClassMethods)
+        end
+
+        module ClassMethods
+          def available?
+            Cipher.for(cipher_name)
+            true
+          rescue NotImplementedError
+            false
+          end
+        end
+      end
+    end
+  end
+end