encookie 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 84167f668043958eead4609ed8af9aac231f59bb
+  data.tar.gz: d93981c2c83e486aff8f7b8b0f291a9e533e1348
+SHA512:
+  metadata.gz: 1487a5f3d2dd9a31201ef7c6a6ec31e5dd4f0e28b34f0233d7917e11239f90fd3ab91432ad80d4160b6eb86a29a1b1f41e0feecf91f74d9dbc23a9a3dc345715
+  data.tar.gz: d90f0bc9724a1ad6fa90763654225b063c26ed10a741838085689a1f83f7f49d4cfebacc7d7a5e64e68b0b268ce781f17f1473b60dee11b9b58a37cfc91d0bda

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/README.md

@@ -0,0 +1,28 @@
+# Encookie
+
+`encookie` is a Ruby gem that provides a Rack session middleware implementation.
+This implementation stores all data in the HTTP cookies - like `Rack::Session::Cookie`,
+but also encrypts the contents of the cookies so it cannot be read by the user.
+
+Encryption **and** authentication is provided by OpenSSL's `aes-128-gcm` cipher.
+This means that there is no need for a separate MAC step or a second key.
+
+## Usage
+
+```ruby
+# Gemfile
+gem 'encookie'
+
+# config.ru
+require 'encookie'
+key = ['7881e46e1e40484756485019038703c2'].pack 'H*'
+use Rack::Session::Encookie, key: key
+
+# app.rb
+get '/' do
+  session[:yourdata] = 'super secret persistent data'
+end
+````
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/glassechidna/encookie.
+

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/encookie.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = 'encookie'
+  spec.version       = '0.0.1'
+  spec.authors       = ['Aidan Steele']
+  spec.email         = ['aidan.steele@glassechidna.com.au']
+
+  spec.summary       = %q{Write a short summary, because Rubygems requires one.}
+  # spec.homepage      = 'TODO: Put your gem's website or public repo URL here.'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_dependency 'rack'
+  spec.add_dependency 'multi_json'
+end

data/lib/encookie.rb

@@ -0,0 +1,7 @@
+require 'rack'
+require 'openssl'
+require 'multi_json'
+require 'base64'
+
+require 'encookie/cryptor'
+require 'encookie/cookie'

data/lib/encookie/cookie.rb

@@ -0,0 +1,66 @@
+module Rack
+  module Session
+    class Encookie
+      def initialize(app, options={})
+        @app = app
+        @name = options[:name] || 'rack.session'
+        @key = options[:key]
+        @default_options = { domain: nil, path: '/'}.merge(options)
+        fail 'A secret is required' unless @key
+      end
+
+      def call(env)
+        load_session env
+        status, headers, body = @app.call env
+        commit_session env, status, headers, body
+      end
+
+      def load_session(env)
+        request = Rack::Request.new env
+        env['rack.session.options'] = @default_options.dup
+
+        cookieval = request.cookies[@name]
+        enc = cookieval_to_encrypted cookieval
+        json = ::Encookie::Cryptor.decrypt ciphertext: enc.ciphertext, key: @key, iv: enc.iv, auth_tag: enc.auth_tag
+        session_data = MultiJson.load json, symbolize_keys: true
+
+        env['rack.session'] = session_data
+      rescue
+        env['rack.session'] = Hash.new
+      end
+
+      def commit_session(env, status, headers, body)
+        options = env['rack.session.options']
+
+        session_data = env['rack.session']
+        json = MultiJson.dump session_data
+        enc = ::Encookie::Cryptor.encrypt plaintext: json, key: @key
+        cookieval = encrypted_to_cookieval enc
+
+        if session_data.size > (4096 - @name.size)
+          env['rack.errors'].puts 'Warning! Rack::Session::Cookie data size exceeds 4K. Content dropped.'
+        else
+          cookie = Hash.new
+          cookie[:value] = cookieval
+          cookie[:expires] = Time.now + options[:expire_after] unless options[:expire_after].nil?
+          Utils.set_cookie_header! headers, @name, cookie.merge(options)
+        end
+
+        [status, headers, body]
+      end
+
+      def encrypted_to_cookieval(encrypted)
+        combined = encrypted.iv + encrypted.auth_tag + encrypted.ciphertext
+        Base64.urlsafe_encode64 combined
+      end
+
+      def cookieval_to_encrypted(cookieval)
+        combined = Base64.urlsafe_decode64 cookieval
+        iv = combined[0..11]
+        auth_tag = combined[12..27]
+        ciphertext = combined[28..-1]
+        ::Encookie::Cryptor::Encrypted.new ciphertext, iv, auth_tag
+      end
+    end
+  end
+end

data/lib/encookie/cryptor.rb

@@ -0,0 +1,26 @@
+module Encookie
+  class Cryptor
+    Encrypted = Struct.new(:ciphertext, :iv, :auth_tag)
+
+    def self.encrypt(plaintext:, key:)
+      cipher = OpenSSL::Cipher.new 'aes-128-gcm'
+      cipher.encrypt
+      cipher.key = key
+      iv = cipher.random_iv
+      cipher.auth_data = ''
+      ciphertext = cipher.update(plaintext) + cipher.final
+      auth_tag = cipher.auth_tag
+      Encrypted.new(ciphertext, iv, auth_tag)
+    end
+
+    def self.decrypt(ciphertext:, key:, iv:, auth_tag:)
+      cipher = OpenSSL::Cipher.new 'aes-128-gcm'
+      cipher.decrypt
+      cipher.key = key
+      cipher.iv = iv
+      cipher.auth_tag = auth_tag
+      cipher.auth_data = ''
+      cipher.update(ciphertext) + cipher.final
+    end
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: encookie
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Aidan Steele
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: rack
+  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: multi_json
+  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'
+description: 
+email:
+- aidan.steele@glassechidna.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- encookie.gemspec
+- lib/encookie.rb
+- lib/encookie/cookie.rb
+- lib/encookie/cryptor.rb
+homepage: 
+licenses: []
+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.1
+signing_key: 
+specification_version: 4
+summary: Write a short summary, because Rubygems requires one.
+test_files: []