encrypted_form_fields 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d6aea0ee8b40654f443b625193e3e98ee3bdb5f0
+  data.tar.gz: 551356231ce1ec66184686a3a60a58836b0c27e0
+SHA512:
+  metadata.gz: 462c4c84e0d97d4758ceae69511301ef5f8918972989e84a1a7db79fa21e247c0cf99bd3661ff7d3bac9a65a6e0bf2273839299823d8b6c656c3435757cb197c
+  data.tar.gz: 58a4a166da91bdf453a3a6c05de33ed37db5c7bc0bfe6614b5c148567bf5ae3f6e5714889c338bb0d35bcd499f1b4b3b7c34b739aa8daa6144a6fc97449d2cb7

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ville Lautanala
+
+MIT License
+
+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,59 @@
+# EncryptedFormFields [![Build Status](https://travis-ci.org/lautis/encrypted_form_fields.png)](https://travis-ci.org/lautis/encrypted_form_fields)
+
+Encrypted form fields for Rails apps.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'encrypted_form_fields'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install encrypted_form_fields
+
+## Usage
+
+Configure necessary encryption keys in Rails initializer:
+
+```ruby
+EncryptedFormFields.secret_key_base = # your secret key base
+EncryptedFormFields.secret_token = # your secret token
+
+```
+
+Create encrypted inputs in your view:
+
+```erb
+
+<%= form_for(user) do |f| %>
+  <%= f.encrypted_field :secrets %>
+  <%= encrypted_field_tag :field_name, "secret data" %>
+<% end %>
+
+```
+
+Then access the data in controller:
+
+```ruby
+
+class SomeController
+  def create
+    # do stuff...
+    encrypted_params # This will contain values of encrypted parameters
+    # do stuff...
+  end
+end
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/lautis/encrypted_form_fields/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.pattern = "test/*_test.rb"
+end
+
+task default: :test

data/encrypted_form_fields.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'encrypted_form_fields/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "encrypted_form_fields"
+  spec.version       = EncryptedFormFields::VERSION
+  spec.authors       = ["Ville Lautanala"]
+  spec.email         = ["lautis@gmail.com"]
+  spec.summary       = %q{Encrypted form fields for Rails}
+  spec.description   = %q{Encrypted form fields for Rails}
+  spec.homepage      = "https://github.com/lautis/encrypted_form_fields"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "actionpack", "~> 4.0.0"
+  spec.add_runtime_dependency "activesupport", "~> 4.0.0"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "minitest"
+end

data/lib/encrypted_form_fields.rb

@@ -0,0 +1,50 @@
+require "action_controller"
+require "action_view"
+require "active_support/message_encryptor"
+
+require "encrypted_form_fields/version"
+require "encrypted_form_fields/encrypted_parameters"
+require "encrypted_form_fields/helpers/form_builder"
+require 'encrypted_form_fields/railtie' if defined?(Rails)
+
+module EncryptedFormFields
+  class << self
+    def secret_key_base=(key)
+      @encryptor = nil
+      @secret_key_base = key
+    end
+
+    def secret_key_base
+      @secret_key_base
+    end
+
+    def secret_token=(key)
+      @encryptor = nil
+      @secret_token = key
+    end
+
+    def secret_token
+      @secret_token
+    end
+
+    def prefix_name(name)
+      first, rest = name.split("[", 2)
+      rest = "[" + rest if rest
+      "_encrypted[#{first}]#{rest}"
+    end
+
+    delegate :encrypt_and_sign, :decrypt_and_verify, to: :encryptor
+
+    private
+
+    def encryptor
+      @encryptor ||= begin
+        key = ActiveSupport::KeyGenerator.new(secret_token).generate_key(secret_key_base)
+        ActiveSupport::MessageEncryptor.new(key)
+      end
+    end
+  end
+end
+
+ActionController::Base.send(:include, EncryptedFormFields::EncryptedParameters)
+ActionView::Helpers::FormBuilder.send(:include, EncryptedFormFields::Helpers::FormBuilder)

data/lib/encrypted_form_fields/encrypted_parameters.rb

@@ -0,0 +1,31 @@
+module EncryptedFormFields
+  module EncryptedParameters
+    # Decrypt encrypted parameters
+    def encrypted_params
+      @encrypted_params ||= decrypt_value(params["_encrypted"] || {})
+    end
+
+    private
+
+    def decrypt_array(array)
+      array.map(&method(:decrypt_value))
+    end
+
+    def decrypt_hash(hash)
+      hash.inject({}.with_indifferent_access) do |result, (key, value)|
+        result[key] = decrypt_value(value)
+        result
+      end
+    end
+
+    def decrypt_value(value)
+      if value.is_a?(Hash)
+        decrypt_hash(value)
+      elsif value.is_a?(Array)
+        decrypt_array(value)
+      else
+        EncryptedFormFields.decrypt_and_verify(value)
+      end
+    end
+  end
+end

data/lib/encrypted_form_fields/helpers/encrypted_field.rb

@@ -0,0 +1,20 @@
+require 'action_view/helpers/tags/hidden_field'
+
+module EncryptedFormFields
+  module Helpers
+    class EncryptedField < ActionView::Helpers::Tags::HiddenField
+      def initialize(object_name, method_name, template_object, options = {})
+        super(object_name, method_name, template_object, options.dup)
+        value = @options.with_indifferent_access.fetch("value") { value_before_type_cast(object) }
+        @options["value"] = EncryptedFormFields.encrypt_and_sign(value)
+        @object_name = EncryptedFormFields.prefix_name(@object_name)
+      end
+
+      class << self
+        def field_type
+          "hidden"
+        end
+      end
+    end
+  end
+end

data/lib/encrypted_form_fields/helpers/form_builder.rb

@@ -0,0 +1,15 @@
+module EncryptedFormFields
+  module Helpers
+    module FormBuilder
+      def encrypted_field(method, options = {})
+        @template.encrypted_field(@object_name, method, objectify_options(options))
+      end
+
+      private
+
+      def objectify_options(options)
+        @default_options.merge(options.merge(object: @object))
+      end
+    end
+  end
+end

data/lib/encrypted_form_fields/helpers/form_helper.rb

@@ -0,0 +1,18 @@
+require 'encrypted_form_fields/helpers/encrypted_field'
+
+module EncryptedFormFields
+  module Helpers
+    module FormHelper
+      # Returns a hidden and encrypted input tag for accessing a specified
+      # attribute (identified by +method+) on an object assigned to the template
+      # (identified by +object+).
+      #
+      # ==== Examples
+      #   encrypted_field(:user, :email_verified_at)
+      #   # => <input type="hidden" id="_encrypted_user_email_verified_at" name="_encrypted[user][email_verified_at]" value="#{encrypt(@user.email_verified_at})" />
+      def encrypted_field(object_name, method, options = {})
+        EncryptedField.new(object_name, method, self, options).render
+      end
+    end
+  end
+end

data/lib/encrypted_form_fields/helpers/form_tag_helper.rb

@@ -0,0 +1,25 @@
+module EncryptedFormFields
+  module Helpers
+    module FormTagHelper
+      # Creates a hidden input field used with encrypted content. Use this field
+      # to transmit data that user shouldn't see or be able to modify.
+      #
+      # ==== Options
+      # * Creates standard HTML attributes for the tag.
+      #
+      # ==== Examples
+      #   encrypted_field_tag 'email_verified_at', Time.now.to_s
+      #   => <input id="email_verified_at" name="_encrypted_email_verified_at" type="hidden" value="[encrypted]" />
+      def encrypted_field_tag(name, value = nil, options = {})
+        encrypted_value = EncryptedFormFields.encrypt_and_sign(value)
+        prefixed_name = EncryptedFormFields.prefix_name(name)
+        tag :input, {
+          "type" => "hidden",
+          "name" => prefixed_name,
+          "id" => sanitize_to_id(name),
+          "value" => encrypted_value
+        }.update(options.stringify_keys)
+      end
+    end
+  end
+end

data/lib/encrypted_form_fields/railtie.rb

@@ -0,0 +1,12 @@
+# lib/my_gem/railtie.rb
+require "encrypted_form_fields/helpers/form_tag_helper"
+require "encrypted_form_fields/helpers/form_helper"
+
+module EncryptedFormFields
+  class Railtie < Rails::Railtie
+    initializer "encrypted_form_fields.view_helpers" do
+      ActionView::Base.send(:include, EncryptedFormFields::Helpers::FormHelper)
+      ActionView::Base.send(:include, EncryptedFormFields::Helpers::FormTagHelper)
+    end
+  end
+end

data/lib/encrypted_form_fields/version.rb

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

data/test/encrypted_parameters_test.rb

@@ -0,0 +1,27 @@
+require 'test_helper'
+
+class EncryptedParametersTest < MiniTest::Unit::TestCase
+  def test_missing_encrypted_params
+    controller = MockController.new({})
+    assert_equal({}, controller.encrypted_params)
+  end
+
+  def test_invalid_encrypted_params
+    controller = MockController.new({"_encrypted" => {"key" => "value"}})
+    assert_raises ActiveSupport::MessageVerifier::InvalidSignature do
+      controller.encrypted_params
+    end
+  end
+
+  def test_properly_encrypted_params
+    value = EncryptedFormFields.encrypt_and_sign("value")
+    controller = MockController.new({"_encrypted" => {"key" => value}})
+    assert_equal({"key" => "value"}, controller.encrypted_params)
+
+    controller = MockController.new({"_encrypted" => {"key" => [value]}})
+    assert_equal({"key" => ["value"]}, controller.encrypted_params)
+
+    controller = MockController.new({"_encrypted" => {"key" => {"nested" => value}}})
+    assert_equal({"key" => {"nested" => "value"}}, controller.encrypted_params)
+  end
+end

data/test/form_builder_test.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+require 'encrypted_form_fields/helpers/form_helper'
+
+class FormBuilderTest < MiniTest::Unit::TestCase
+  def setup
+    super
+    @template = Object.new
+    @template.extend ActionView::Helpers::FormHelper
+    @template.extend EncryptedFormFields::Helpers::FormHelper
+    @template.extend ActionView::Helpers::FormOptionsHelper
+    @object = Struct.new(:bar).new(SecureRandom.base64)
+  end
+
+  def test_encrypted_form_tag
+    form_builder = ActionView::Helpers::FormBuilder.new(:foo, @object, @template, {})
+    tag = HTML::Document.new(form_builder.encrypted_field(:bar)).find(tag: "input")
+    decrypted_value = EncryptedFormFields.decrypt_and_verify(tag.attributes["value"])
+    assert_equal @object.bar, decrypted_value
+    assert_equal "_encrypted[foo][bar]", tag.attributes["name"]
+    assert_equal "hidden", tag.attributes["type"]
+    assert_equal "_encrypted_foo_bar", tag.attributes["id"]
+  end
+end

data/test/form_tag_helper_test.rb

@@ -0,0 +1,15 @@
+require 'test_helper'
+require 'encrypted_form_fields/helpers/form_tag_helper'
+
+class FormTagHelperTest < ActionView::TestCase
+  tests EncryptedFormFields::Helpers::FormTagHelper
+
+  def test_encrypted_form_tag
+    tag = HTML::Document.new(encrypted_field_tag "field", "value").find(tag: "input")
+    decrypted_value = EncryptedFormFields.decrypt_and_verify(tag.attributes["value"])
+    assert_equal "value", decrypted_value
+    assert_equal "_encrypted[field]", tag.attributes["name"]
+    assert_equal "hidden", tag.attributes["type"]
+    assert_equal "field", tag.attributes["id"]
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,23 @@
+ENV['RAILS_ENV'] = 'test'
+require 'minitest/unit'
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'securerandom'
+require 'encrypted_form_fields'
+
+EncryptedFormFields.secret_key_base = SecureRandom.hex
+EncryptedFormFields.secret_token = SecureRandom.hex
+
+class MockController
+  attr_accessor :request
+
+  def initialize(params = {})
+    @params = params
+  end
+
+  def params
+    ActionController::Parameters.new(@params)
+  end
+end
+
+MockController.send(:include, EncryptedFormFields::EncryptedParameters)

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: encrypted_form_fields
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ville Lautanala
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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'
+description: Encrypted form fields for Rails
+email:
+- lautis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- encrypted_form_fields.gemspec
+- lib/encrypted_form_fields.rb
+- lib/encrypted_form_fields/encrypted_parameters.rb
+- lib/encrypted_form_fields/helpers/encrypted_field.rb
+- lib/encrypted_form_fields/helpers/form_builder.rb
+- lib/encrypted_form_fields/helpers/form_helper.rb
+- lib/encrypted_form_fields/helpers/form_tag_helper.rb
+- lib/encrypted_form_fields/railtie.rb
+- lib/encrypted_form_fields/version.rb
+- test/encrypted_parameters_test.rb
+- test/form_builder_test.rb
+- test/form_tag_helper_test.rb
+- test/test_helper.rb
+homepage: https://github.com/lautis/encrypted_form_fields
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Encrypted form fields for Rails
+test_files:
+- test/encrypted_parameters_test.rb
+- test/form_builder_test.rb
+- test/form_tag_helper_test.rb
+- test/test_helper.rb