base64_token 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6687033029161045990b0fef4b18631af2a93621
+  data.tar.gz: 3c24bb165af866a248f24d43a973ea837bcc29fb
+SHA512:
+  metadata.gz: ff78fc36d0a5039405fad8663f2fd7eef99ee2e9fc5ed69a9004f2e4dde6c88b4fb4c3d4706a63d6318863288bbaaaec663eba468ab61455b5f4cc1cb1e382c7
+  data.tar.gz: 96a5b13c33e8091d4978588762daf3b051c1cdb3a94547d8384ad420f0dab66ab7ff2f8fde9cb3e92f11c735207b7cab808afde4112fc7a629a012939c0dd7cf

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,59 @@
+# We need to configure exemptions for blocks that we generally accept to be
+# long, since they are less comparable to methods and more comparable to
+# modules/classes.
+Metrics/BlockLength:
+  ExcludedMethods:
+    - describe
+    - namespace
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+# Encoding comments are not neccessary in all 2.x versions of ruby, since
+# UTF-8 has become the default encoding.
+Style/Encoding:
+  EnforcedStyle: never
+  Enabled: true
+  Exclude:
+    - '*.gemspec'
+
+# Ruby 2.3 introduced optional automatic freezing of string literals
+# This might become default in future versions.
+# For details on this feature see the internet, e.g. https://wyeworks.com/blog/2015/12/1/immutable-strings-in-ruby-2-dot-3
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always
+
+# This cop tries to make you use module_funtion instead of extend self
+# This is bad because both have their own use-case and should not be used
+# and sometimes cannot be used to do the same thing
+Style/ModuleFunction:
+  Enabled: false
+
+# While it is very often useful to separate numbers after every three digits
+# for readability, this mostly doesn't make sense if the number doesn't
+# represent an amount but rather an identifier. Thus the use of underscores
+# every three digits is recommended but not enforced.
+Style/NumericLiterals:
+  Enabled: false
+
+# Do not force the same one letter variable names for all occurences of inject
+Style/SingleLineBlockParams:
+  Enabled: false
+
+# No significant improvement in speed or memory usage apparent. Readability is
+# atrocious.
+Performance/Casecmp:
+  Enabled: false
+
+# Not safe in a rails context, since Relation.count is != Enumerable.count
+Performance/Count:
+  Enabled: false
+
+# Does not make sense when dealing with non-ActiveRecord like mongoid. That
+# Mongoid for example throws error if find_by returns nothing (but we expect
+# nil)
+Rails/FindBy:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.7
+
+script:
+  - bundle exec rspec
+  - bundle exec rubocop

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 1.0.0 (2017-01-19)
+
+* Initial release

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in base64_token.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Beko Käuferportal GmbH
+
+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,55 @@
+[![Gem Version](https://badge.fury.io/rb/base64_token.svg)](https://badge.fury.io/rb/base64_token)
+[![Build Status](https://travis-ci.org/kaeuferportal/base64_token.svg?branch=master)](https://travis-ci.org/kaeuferportal/base64_token)
+
+# Base64Token
+
+This gem allows you to take a ruby hash and turn it into an encrypted token
+that you can later convert back to your original hash.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'base64_token', '~> 1.0'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install base64_token
+
+## Usage
+
+````ruby
+# Set the encryption key used for your token. You should store that somewhere
+# if you want to recognize your own tokens at a later time.
+Base64Token.encryption_key = Base64Token.generate_key
+=> "BgPrrt4Ltd7rYlsloSEs+cVuxcaLdjkTRFAjKWViIWo=\n"
+
+token = Base64Token.generate(user_id: 42, valid_to: '2017-01-19T13:37:00')
+=> "fTsJg-2iOA5F3YC2i5tlGcWUE-npnZwSEezA-yRfhLL8aV_KE6AuGIZH5YAdgE-lLhiNUmuWCFkxlgUJy7TjdmJFscxzeS-l3CTD1or6nwR0-zHA7B-Q"
+
+Base64Token.parse(token)
+=> {:user_id=>42, :valid_to=>"2017-01-19T13:37:00"}
+````
+
+Note that:
+
+* your hash is converted to JSON intermediately, so you can (re)store anything
+  that you can serialize to JSON
+* to ensure consistency before and after deserialization, all hash keys have to be
+  symbols
+
+## Development
+
+You can run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kaeuferportal/base64_token.

data/Rakefile

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

data/base64_token.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'base64_token/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'base64_token'
+  spec.version       = Base64Token::VERSION
+  spec.authors       = ['Beko Käuferportal GmbH']
+  spec.email         = ['oss@kaeuferportal.de']
+  spec.summary       = 'Encodes ruby hashes as encrypted and URL-safe tokens.'
+  spec.homepage      = 'https://github.com/kaeuferportal/base64_token'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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.required_ruby_version = '>= 2.1.0'
+
+  spec.add_dependency 'rbnacl', '>= 3.0.0', '< 5.0'
+  spec.add_dependency 'rbnacl-libsodium', '~> 1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '0.47.1'
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'base64_token'
+
+# 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,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/base64_token.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+require 'base64'
+require 'base64_token/version'
+require 'json'
+
+require 'rbnacl/libsodium'
+require 'rbnacl'
+
+module Base64Token
+  class Error < StandardError; end
+  class ConfigurationError < StandardError; end
+
+  class << self
+    def generate(**hash)
+      json = JSON.generate(hash)
+      cipher = encrypt(json)
+      Base64.urlsafe_encode64(cipher)
+    end
+
+    def parse(token)
+      return {} if !token || token.strip.empty?
+      cipher = base64_decode(token)
+      json = decrypt(cipher)
+      JSON.parse(json).map { |k, v| [k.to_sym, v] }.to_h
+    end
+
+    def generate_key
+      Base64.encode64(RbNaCl::Random.random_bytes(RbNaCl::SecretBox.key_bytes))
+    end
+
+    def encryption_key=(key)
+      @encryption_key = key
+      @crypto_box = nil
+    end
+
+    private
+
+    def encrypt(plaintext)
+      crypto_box.encrypt(plaintext)
+    end
+
+    def base64_decode(string)
+      Base64.urlsafe_decode64(string)
+    rescue ArgumentError => e
+      raise Error, e.message
+    end
+
+    def decrypt(ciphertext)
+      crypto_box.decrypt(ciphertext)
+    rescue RbNaCl::CryptoError => e
+      raise Error, e.message
+    end
+
+    def crypto_box
+      @crypto_box ||= begin
+        unless @encryption_key
+          raise ConfigurationError, 'Encryption key not set.'
+        end
+
+        key = Base64.decode64(@encryption_key)
+        RbNaCl::SimpleBox.from_secret_key(key)
+      end
+    end
+  end
+end

data/lib/base64_token/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module Base64Token
+  VERSION = '1.0.0'.freeze
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: base64_token
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Beko Käuferportal GmbH
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rbnacl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rbnacl-libsodium
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.47.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.47.1
+description: 
+email:
+- oss@kaeuferportal.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- base64_token.gemspec
+- bin/console
+- bin/setup
+- lib/base64_token.rb
+- lib/base64_token/version.rb
+homepage: https://github.com/kaeuferportal/base64_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: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Encodes ruby hashes as encrypted and URL-safe tokens.
+test_files: []