secure_jwt 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8c111f243ff01928e557b0d764c28bd31075df1d9822127188cc1a62453bffe3
+  data.tar.gz: 420a70833f9ddc621324ddc1bad9fd76ea3b0a682e9e288dc5e3865abc7dd747
+SHA512:
+  metadata.gz: dcf75b7289fb69a0375642f3f54465c37ab11a4d8aebe1e56ea87054d04f6d32be25a23aed52e5e683c6af634e4b220ff77c5c7059c8a540fda3023dcb4c4119
+  data.tar.gz: 27fb10bb12f352353c725881161486f5bd01a574d64fd9e3a4114201155510fd2f9456201802022fb92f8c01ee1b70e1ab027c3c316c6a3d5d908bf8a7834ab1

data/.gitignore

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jlinder@boardpackager.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in secure_jwt.gemspec
+gemspec
+
+gem 'rspec'

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    secure_jwt (0.1.0)
+      jwt
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    jwt (1.5.6)
+    rake (10.5.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec
+  secure_jwt!
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Jeremy Linder
+
+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,84 @@
+# SecureJwt
+
+Signed and encrypted JSON Web Tokens.
+
+This library uses envelope encryption for transport of the contained data. 
+
+This library was written to avoid exiting methods early in case of incorrect signatures or encryption information. This is done to mitigate timing attacks. (However, the library has not been battle tested against timing attack attempts.)
+
+This library follows an encrypt-then-sign approach to doing encryption and signing. It also supports a wide variety of encryption mechanisms, but uses AES-256-GCM by default.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'secure_jwt'
+```
+
+## Usage
+
+
+### With minimally protective encryption (should be used only for dev)
+
+Encrypted, but unsigned, JWT's can be created in the following manner.
+
+```ruby
+jwt = SecureJwt.encrypt "foo"
+
+SecureJwt.decrypt jwt
+```
+
+Encrypted and signed JWT's can be generated as follows.
+
+```ruby
+jwt = SecureJwt.encrypt "foo", "bar"
+
+SecureJwt.decrypt jwt, "bar"
+```
+
+### Better Encryption
+
+The above method uses the default key for encryption. This key will not provide any significant data security. You can significantly enhance your encryption scheme by using a more random key. This can be set as the `:master_key` in an option to the encryption and decryption function. (The reason for the name will be made clear a bit later)
+
+This looks as following:
+
+```ruby
+jwt = SecureJwt.encrypt "foo", "bar", master_key: YOUR_VERY_RANDOM_MASTER_KEY
+
+SecureJwt.decrypt jwt, "bar", master_key: YOUR_VERY_RANDOM_MASTER_KEY
+```
+
+You can also set this master key globally, if you wish as follows:
+
+```ruby
+SecureJwt.configs.master_key = A_STANDARD_MASTER_KEY
+```
+
+### Advanced / Envelope Encryption
+A major purpose of envelope encryption is to take advantage of security hardware without also needing to send larger portions of data to the encryption hardware. A smaller data key is generated and used to symmetrically encrypt the main data and then that key is encrypted, often asymmetrically and using an HSM, and then sent along with the data. 
+
+SecureJwt was built to support this type of encryption and to be flexible to allow one to take advantage key management systems of whatever service they are using (AWS, Google, etc).
+
+Say we have a cloud encryption function `encrypt_with_key(key, value)` and a decryption function `decrypt_with_key(key, value)`, where the `key` represents the master key to our system and the `value` represents whatever it is we want to encrypt/decrypt. We can then approach it as follows:
+
+
+```ruby
+jwt = SecureJwt.encrypt("foo", "bar", master_key: MASTER_KEY) {|value,key| encrypt_with_key key, value }
+
+SecureJwt.decrypt(jwt, "bar", master_key: MASTER_KEY) { |value, key| decrypt_with_key key, value }
+```
+
+And that's it. Simple as that.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/deathbyjer/secure_jwt. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SecureJwt project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/secure_jwt/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "secure_jwt"
+
+# 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/lib/secure_jwt.rb

@@ -0,0 +1,200 @@
+require "securerandom"
+require 'openssl'
+require "base64"
+require "jwt"
+
+require "secure_jwt/version"
+require "secure_jwt/configs"
+
+module SecureJwt
+
+  extend SecureJwt::Configs
+
+  DEFAULT_ALGORITHMS = {
+    jwt: "HS256",
+    data: "aes-256-gcm"
+  }
+
+  class << self
+    def encrypt(payload, signing_key = nil, options = {}, &data_key_encryptor)
+      secure_jwt = JwtTokenImpl.new signing_key, options
+      secure_jwt.encrypt payload, options, &data_key_encryptor
+    end
+
+    def decrypt(jwt_token, signing_key = nil, options = {}, &data_key_decryptor)
+      secure_jwt = JwtTokenImpl.new signing_key, options
+      secure_jwt.decrypt jwt_token, options, &data_key_decryptor
+    end
+  end
+
+  class JwtTokenImpl
+    def initialize(signing_key, options = {})
+      @jwt_algorithm = options[:signing_algorithm] || DEFAULT_ALGORITHMS[:jwt]
+      @jwt_algorithm = nil unless signing_key
+
+      @signing_key = signing_key
+
+      @data_algorithm = options[:data_algorithm] || DEFAULT_ALGORITHMS[:data]
+
+      @master_key = options[:master_key] || SecureJwt.config.master_key || "none"
+    end
+
+    def encrypt(payload, options = {}, &data_key_encryptor)
+      clear!
+
+      data_key = generate_data_key &data_key_encryptor
+      iv = SecureRandom.random_bytes 12
+      encrypted_payload, auth_tag = encrypt_payload payload, {
+        key: data_key[:plain], 
+        iv: iv,
+        auth_data: options[:auth_data] || ""
+      }
+
+      ret = encode_jwt encrypted_payload, {
+        data_key: data_key[:encrypted],
+        iv: iv,
+        auth_tag: auth_tag
+      }
+
+      first_error ? raise(first_error) : ret
+    end
+
+    def decrypt(jwt_token, options = {}, &data_key_decryptor)
+      clear!
+      unformatted_payload, header = decode_jwt jwt_token
+
+      decrypted_data_key = decrypt_data_key header[:data_key], &data_key_decryptor rescue SecureRandom.random_bytes(12)
+      
+      ret = decrypt_payload unformatted_payload, {
+        data_key: decrypted_data_key,
+        iv: header[:iv],
+        auth_tag: header[:tag],
+        auth_data: options[:auth_data] || ""
+      }
+
+      first_error ? raise(first_error) : ret
+    end
+
+    private
+
+    attr_reader :signing_key
+    attr_reader :jwt_algorithm
+    attr_reader :data_algorithm
+    attr_reader :master_key
+
+    attr_reader :first_error
+
+    def clear!
+      @first_error = nil
+    end
+
+    def encode_jwt(encrypted_payload, options = {})
+      headers = { 
+        data_key: Base64.urlsafe_encode64(options[:data_key]), 
+        key: master_key, 
+        iv: Base64.urlsafe_encode64(options[:iv]),
+      }
+
+      headers[:tag] = Base64.urlsafe_encode64(options[:auth_tag]) if options[:auth_tag]
+
+      formatted_payload = { 
+        "payload" => Base64.urlsafe_encode64(encrypted_payload) 
+      }
+
+      JWT.encode formatted_payload, signing_key, jwt_algorithm, headers 
+    end
+
+    def decode_jwt(jwt_token)
+      begin
+        payload, header = JWT.decode jwt_token, signing_key, !!jwt_algorithm, algorithm: jwt_algorithm
+
+        %w(data_key iv tag).each do |key| 
+          header[key] = Base64.urlsafe_decode64 header[key] rescue ""
+        end
+
+        return Base64.urlsafe_decode64(payload["payload"]), header.transform_keys(&:to_sym)
+      rescue JWT::VerificationError, JWT::IncorrectAlgorithm => e
+        self.first_error = e
+        return {"payload": nil}, { }
+      end
+    end
+
+    def encrypt_payload(payload, options = {})
+      cipher = OpenSSL::Cipher.new data_algorithm
+      cipher.encrypt
+
+      begin
+        cipher.key = options[:key]
+        cipher.iv = options[:iv]
+        cipher.auth_data = options[:auth_data] if cipher.authenticated?
+
+        encrypted_payload = cipher.update(payload) + cipher.final
+
+        return encrypted_payload, cipher.authenticated? ? cipher.auth_tag : nil
+      rescue Exception => e
+        self.first_error = e
+        return "", cipher.authenticated? ? "" : nil
+      end
+    end
+
+    def decrypt_payload(unformatted_payload, options = {})
+      begin
+        cipher = OpenSSL::Cipher.new data_algorithm
+        cipher.decrypt
+
+        cipher.key = options[:data_key] || cipher.random_key
+        cipher.iv = options[:iv]
+
+        if cipher.authenticated?
+          cipher.auth_tag = options[:auth_tag]
+          cipher.auth_data = options[:auth_data]
+        end
+
+        return cipher.update(unformatted_payload) + cipher.final
+      rescue Exception => e
+        self.first_error = e
+        nil
+      end
+    end
+
+    def generate_data_key(&block)
+      plain_key = SecureRandom.random_bytes 32
+
+      encrypted_key = block ? block.call(plain_key, master_key) : default_data_key_encryptor(plain_key)
+
+      { plain: plain_key, encrypted: encrypted_key, key: master_key }
+    end
+
+    def decrypt_data_key(encrypted_key, &block)
+      data_key = block ? block.call(encrypted_key, master_key) : default_data_key_decryptor(encrypted_key) rescue nil
+      return data_key unless data_key.nil? 
+
+      self.first_error = OpenSSL::Cipher::CipherError.new("bad decrypt") 
+      nil
+    end
+
+    DEFAULT_KEY_ALGORITHM = "aes-256-cbc"
+    def default_data_key_encryptor(plain_key)
+      cipher = OpenSSL::Cipher.new DEFAULT_KEY_ALGORITHM
+      cipher.encrypt
+
+      cipher.key = Digest::SHA2.digest "key:#{master_key}"
+      cipher.iv = Digest::MD5.digest "iv:#{master_key}"
+      cipher.update(plain_key) + cipher.final
+    end
+
+    def default_data_key_decryptor(encrypted_key)
+      cipher = OpenSSL::Cipher.new DEFAULT_KEY_ALGORITHM
+      cipher.decrypt
+      
+      cipher.key = Digest::SHA2.digest "key:#{master_key || "none"}"
+      cipher.iv = Digest::MD5.digest "iv:#{master_key || "none"}"
+      cipher.update(encrypted_key) + cipher.final
+    end
+
+    def first_error=(error)
+      return if @first_error
+      @first_error = error
+    end
+  end
+end

data/lib/secure_jwt/configs.rb

@@ -0,0 +1,16 @@
+module SecureJwt::Configs
+
+  def config
+    @config ||= Configurator.new
+  end
+
+  class Configurator
+    attr_accessor :master_key
+
+    private
+
+    def clear!
+      @master_key = nil
+    end
+  end
+end

data/lib/secure_jwt/version.rb

@@ -0,0 +1,3 @@
+module SecureJwt
+  VERSION = "0.1.0"
+end

data/secure_jwt.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "secure_jwt/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "secure_jwt"
+  spec.version       = SecureJwt::VERSION
+  spec.authors       = ["Jeremy Linder"]
+  spec.email         = ["linder.jer@gmail.com"]
+
+  spec.summary       = %q{Signed and Encrypted JSON Web Tokens}
+  spec.description   = %q{Automatically encrypt your JWT's using envelope encryption for added safety}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    #spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "jwt"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: secure_jwt
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeremy Linder
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+description: Automatically encrypt your JWT's using envelope encryption for added
+  safety
+email:
+- linder.jer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/secure_jwt.rb
+- lib/secure_jwt/configs.rb
+- lib/secure_jwt/version.rb
+- secure_jwt.gemspec
+homepage: ''
+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.7.7
+signing_key: 
+specification_version: 4
+summary: Signed and Encrypted JSON Web Tokens
+test_files: []