rails-param_cryptable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ef8bfbf13fe2db87fdcb77a0a5da3c8bb8bb00156b3d652790a6b83b61835fef
+  data.tar.gz: e9b2a82072fdd71409c5f02282e390dba194a6a0beaa860da98cbfb1d07e5226
+SHA512:
+  metadata.gz: 641eb57f5f2108cfad5ad5f03685559f0f0bd8667975b7ee37904aeb7b4a71505edba9775617ed472b484e7be0a94687a79697ee9387b10fade61882a1493ffe
+  data.tar.gz: 07b8d56c7e0b2d5b31209936d684679646ef1c65be5c084821007d62a20554fcaaa5a428db1d7d78de6bd7530971c25817b4b53df09dfe15149f368e2b9ffeac

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## Master
+
+## v0.1.0
+
+- Initial release

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 hi@pelle.codes. 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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rails-param_cryptable.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Pelle ten Cate
+
+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,67 @@
+# Rails::ParamCryptable
+
+A simple gem for Rails >= 5.2, that can encrypt URL parameters, intentionally meant to help you obfuscate
+ordinary IDs without having to rely on a separate database-stored secret token.
+
+Turns your
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails-param_cryptable'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+In this example, we will encrypt the ID of our OrdersController, turning **example.com/orders/123** into **example.com/orders/203e39202d326d13**
+
+In your credentials (`rails credentials:edit --environment=production`), add a 16-bytes long value for param_cryptable_key.
+
+```ruby
+param_cryptable_key: CTYcQtYN3ELVM5Lu
+```
+
+In your controller:
+
+```ruby
+class OrdersController < ApplicationController
+  include ParamCryptable
+
+  crypt_param :id
+```
+
+This will automagically expect the `:id` param to be encrypted, and decrypt it for you.
+
+And wherever you want to create an URL:
+
+```ruby
+# From within the controller
+  orders_path(encrypt(@order.id))
+
+# From everywhere else
+module OrdersHelper
+  def my_link_href_helper
+    order_path(ParamCryptable.encrypt(@order.id))
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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/[USERNAME]/rails-param_cryptable. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rails-param_cryptable/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).s

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,86 @@
+require "param_cryptable/version"
+
+module ParamCryptable
+  extend ActiveSupport::Concern
+
+  class Error < StandardError; end
+
+    extend ActiveSupport::Concern
+
+    included do
+      delegate :crypt_params, to: :class
+    end
+
+    # Encrypt any value for use by crypt_params
+    #
+    # @param [Object] text The text to encrypt. This method calls `.to_s` on it.
+    # @return [String] The encrypted representation
+    def self.encrypt(text)
+      cipher = OpenSSL::Cipher.new('blowfish').encrypt
+      cipher.key = Rails.application.credentials.param_cryptable_key
+
+      s = cipher.update(text.to_s) + cipher.final
+      s.unpack1('H*')
+    end
+
+    class_methods do
+      # attr_accessor really needs a default / initial value setting...
+      #
+      # @return [Array] Crypt Params stored in class instance variable.
+      def crypt_params
+        @crypt_params ||= []
+      end
+
+      # Expect this param to be encrypted, if present, and attempt to decrypt it before accessing
+      #
+      # @param [Symbol, Hash] param The parameter to expect to be crypted
+      # @param [Array] tree Internally used for recursion
+      def crypt_param(param, tree = [])
+        if param.is_a?(Hash)
+          key, value = param.first
+          crypt_param(value, tree + [key])
+        else
+          crypt_params << tree + [param]
+        end
+      end
+    end
+
+    # Encrypt any value for use by crypt_params
+    #
+    # @param [Object] text The text to encrypt. This method calls `.to_s` on it.
+    # @return [String] The encrypted representation
+    def encrypt(text)
+      ParamCryptable.encrypt(text)
+    end
+
+    private
+
+    # Override for ActionController#params that decrypts all registered crypt_params if they are
+    # provided as strings in the request.
+    #
+    # @return [ActionController::Parameters]
+    def params
+      @params ||= super.tap do |params|
+        crypt_params.each do |crypt_param|
+          local_params =
+            if crypt_param.size > 1
+              params.dig(*crypt_param[0..-2])
+            else
+              params
+            end
+          if local_params[crypt_param.last].is_a? String
+            local_params[crypt_param.last] = decrypt(local_params[crypt_param.last])
+          end
+        end
+      end
+    end
+
+    def decrypt(code)
+      cipher = OpenSSL::Cipher.new('blowfish').decrypt
+      cipher.key = Rails.application.credentials.param_cryptable_key
+      s = [code].pack('H*').unpack('C*').pack('c*')
+
+      cipher.update(s) + cipher.final
+    end
+
+end

data/lib/param_cryptable/version.rb

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

data/rails-param_cryptable.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/param_cryptable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails-param_cryptable"
+  spec.version       = ParamCryptable::VERSION
+  spec.authors       = ["Pelle ten Cate"]
+  spec.email         = ["hi@pelle.codes"]
+
+  spec.summary       = %q{Encrypted URL parameters for Rails}
+  spec.description   = %q{Simple encryption for URL parameters in rails, meant as a drop-in obfuscation layer for IDs}
+  spec.homepage      = "https://github.com/pelletencate/rails-param_cryptable"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/pelletencate/rails-param_cryptable/blob/main/CHANGELOG.md"
+
+  spec.add_dependency 'rails', '>= 5.2.0'
+
+  # 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"]
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: rails-param_cryptable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pelle ten Cate
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+description: Simple encryption for URL parameters in rails, meant as a drop-in obfuscation
+  layer for IDs
+email:
+- hi@pelle.codes
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/param_cryptable.rb
+- lib/param_cryptable/version.rb
+- rails-param_cryptable.gemspec
+homepage: https://github.com/pelletencate/rails-param_cryptable
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/pelletencate/rails-param_cryptable
+  source_code_uri: https://github.com/pelletencate/rails-param_cryptable
+  changelog_uri: https://github.com/pelletencate/rails-param_cryptable/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Encrypted URL parameters for Rails
+test_files: []