secure_web_token 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d62f802df65f418dedc52fd9fe852f09c92cea0e74efe06c54597fd3fbe410dc
+  data.tar.gz: '08f76fb02c959b5cf49b7ff731dbf9ea7c237bd247e202d6d83cc2212ab0dd4f'
+SHA512:
+  metadata.gz: df1633e508328bd2820e276eaf8cd2b39685a2a0ed95268142e6237de7372ff412446afdbba549dc29bf7700d9f9769184d3ea260fc2ed693351ba0da406e8a8
+  data.tar.gz: f48caa901014958d012747644a3eb99e7feb1906d2f75f698a5e11b7e8f2fb2e0f1f5992aef9c6d9c19da6b6b13e2e110befd1923ec74a8c660f19a61951a06d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Sampson Crowley
+
+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,31 @@
+# SecureWebToken
+Generate, encrypt, and decrypt signed JSON web tokens using secure defaults for encryption
+
+## Usage
+Coming Soon
+
+## Installation
+Add this line to your application's Gemfile:
+```ruby
+gem 'secure_web_token'
+```
+And then execute:
+```bash
+$ bundle
+```
+
+Or add and install directly with bundler:
+```ruby
+bundle add 'secure_web_token'
+```
+
+Or install it directly with:
+```bash
+$ gem install secure_web_token
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/secure_web_token.rb

@@ -0,0 +1,128 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require 'jwt'
+require 'jwe'
+
+class SecureWebToken
+  CHARACTERS = [
+    *('a'..'z'),
+    *('A'..'Z'),
+    *(0..9).map(&:to_s),
+    *'!@#$%^&*()'.split('')
+  ].freeze
+
+  DEFAULT_OPTIONS = { enc:  'A256GCM', alg: 'dir', zip: 'DEF' }.freeze
+
+  class << self
+    def decode(payload, sig_key = nil, enc_key = nil)
+      sig_key ||= signing_key
+      enc_key ||= encryption_key
+      decrypted = ::JWE.decrypt(payload, enc_key)
+
+      ::JWT.decode(decrypted, sig_key, true, algorithm: 'HS512')[0]
+    end
+    alias_method :read, :decode
+    alias_method :decrypt, :decode
+    alias_method :deflate, :decode
+
+    def default_encryption_key
+      if defined?(@default_enc_key) && is_present?(@default_enc_key)
+        if @default_enc_key.respond_to? :call then
+          get_presence(@default_enc_key.call) || gen_encryption_key
+        else
+          @default_enc_key
+        end
+      else
+        gen_encryption_key
+      end
+    end
+
+    def default_encryption_key=(value_or_callable)
+      @default_enc_key = value_or_callable
+    end
+
+    def default_signing_key
+      if defined?(@default_sig_key) && is_present?(@default_sig_key)
+        if @default_sig_key.respond_to? :call then
+          get_presence(@default_sig_key.call) || gen_signing_key
+        else
+          @default_sig_key
+        end
+      else
+        gen_signing_key
+      end
+    end
+
+    def default_signing_key=(value_or_callable)
+      @default_sig_key = value_or_callable
+    end
+
+    def encode(payload, sig_key = nil, enc_key = nil, options = nil)
+      sig_key ||= signing_key
+      enc_key ||= encryption_key
+      options ||= encrypt_options
+      encoded = ::JWT.encode(payload, sig_key, 'HS512')
+
+      ::JWE.encrypt(encoded, enc_key, **options)
+    end
+    alias_method :create, :encode
+    alias_method :encrypt, :encode
+    alias_method :inflate, :encode
+
+    def encrypt_options
+      @encrypt_options ||= DEFAULT_OPTIONS
+    end
+
+    def encrypt_options=(options)
+      @encrypt_options = (options || DEFAULT_OPTIONS)
+    end
+
+    def encryption_key
+      @encryption_key ||= default_encryption_key
+    end
+
+    def encryption_key=(key)
+      @encryption_key = (key || gen_encryption_key)
+    end
+
+    def gen_encryption_key
+      SecureRandom.random_bytes(32)
+    end
+
+    def gen_signing_key(length = 50)
+      (0...length).map { CHARACTERS[rand(CHARACTERS.length)] }.join
+    end
+
+    def signing_key
+      @signing_key ||= default_signing_key
+    end
+
+    def signing_key=(key)
+      @signing_key = (key || gen_signing_key)
+    end
+
+    private
+      def is_blank?(object)
+        object.respond_to?(:blank?) ?
+          object.blank? :
+          is_empty?(object)
+      end
+
+      def is_empty?(object)
+        object.respond_to?(:empty?) ? !!object.empty? : !object
+      end
+
+      def is_present?(object)
+        object.respond_to?(:present?) ? object.present? : !blank?(object)
+      end
+
+      def get_presence(object)
+        if object.respond_to?(:presence)
+          object.presence
+        elsif is_present?(object)
+          object
+        end
+      end
+  end
+end

data/lib/secure_web_token/version.rb

@@ -0,0 +1,3 @@
+class SecureWebToken
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: secure_web_token
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sampson Crowley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: jwe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: Generate, encrypt, and decrypt signed JSON web tokens
+email:
+- sampsonsprojects@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/secure_web_token.rb
+- lib/secure_web_token/version.rb
+homepage: https://github.com/SampsonCrowley/secure_web_token
+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: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Secure defaults for encrypted JWTs
+test_files: []