pco-url 1.9.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99cbb60244f43f127c3396fde9cae695bb63fa83
-  data.tar.gz: 36445a79cde986af12548eec067b880655c7cbcb
+  metadata.gz: 5ad5229c15a12077f471c25fca3288c285b2c687
+  data.tar.gz: aadeaab05a5ea105f5ad32d30fabbfd32c00cb6c
 SHA512:
-  metadata.gz: 75427e67cbe1af5d0247aaf07d5612299f73298681497aa88a0db04f3c64bf144ce8f610e6249286628af416772afa5a7903bb8646d50bc51ca55eb4f8f92c25
-  data.tar.gz: 55b872ca020c14c13344872fdcdc84b3fe2d0a8156fb2c991ca2e9d247fd509f0bcc158715a214d4030ea6922f46599e40cf20beaff90e218b9eb9a848bb9fbc
+  metadata.gz: 27e08f5cdc63de25d4cfcedfde96a4c8b06612adee3553c5d7ed43b5b37734ec70c609b9aaf1a3578f5b5d13769aa282460d4d8cb02af5ca49d16cf6c8b03053
+  data.tar.gz: 6a055c9dbb973275dceb0e909e3abea22dc7513b8d633e8f97b1ee2cd3bc485040d973e64525f9d4e1f76087ffdaac372c2e40d219152cdda8c75ad51719aa28

data/.circleci/config.yml

@@ -0,0 +1,70 @@
+version: 2 # use CircleCI 2.0
+jobs: # a collection of steps
+  "ruby-2.3": # runs not using Workflows must have a `build` job as entry point
+    docker: # run the steps with Docker
+      - image: circleci/ruby:2.3
+        environment: # environment variables for primary container
+          BUNDLE_JOBS: 3
+          BUNDLE_RETRY: 3
+          BUNDLE_PATH: vendor/bundle
+    steps: # a collection of executable commands
+      - checkout # special step to check out source code to working directory
+
+      # Restore bundle cache
+      - restore_cache:
+          keys:
+            - pco-url-bundle-v2-ruby23-{{ checksum "pco-url.gemspec" }}
+            - pco-url-bundle-v2-ruby23-
+
+      - run:
+          name: Bundle Install
+          command: bundle check || bundle install
+
+      # Store bundle cache
+      - save_cache:
+          key: pco-url-bundle-v2-ruby23-{{ checksum "pco-url.gemspec" }}
+          paths:
+            - vendor/bundle
+
+      - run:
+          name: Run rspec
+          command: |
+            bundle exec rspec --format progress
+
+  "ruby-2.4": # runs not using Workflows must have a `build` job as entry point
+    docker: # run the steps with Docker
+      - image: circleci/ruby:2.4
+        environment: # environment variables for primary container
+          BUNDLE_JOBS: 3
+          BUNDLE_RETRY: 3
+          BUNDLE_PATH: vendor/bundle
+    steps: # a collection of executable commands
+      - checkout # special step to check out source code to working directory
+
+      # Restore bundle cache
+      - restore_cache:
+          keys:
+            - pco-url-bundle-v2-ruby24-{{ checksum "pco-url.gemspec" }}
+            - pco-url-bundle-v2-ruby24-
+
+      - run:
+          name: Bundle Install
+          command: bundle check || bundle install
+
+      # Store bundle cache
+      - save_cache:
+          key: pco-url-bundle-v2-ruby24-{{ checksum "pco-url.gemspec" }}
+          paths:
+            - vendor/bundle
+
+      - run:
+          name: Run rspec
+          command: |
+            bundle exec rspec --format progress
+
+workflows:
+  version: 2
+  build:
+    jobs:
+      - "ruby-2.3"
+      - "ruby-2.4"

data/.rubocop.yml

@@ -1,3 +1,6 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
 Style/StringLiterals:
   Enabled: true
   EnforcedStyle: double_quotes
@@ -8,5 +11,5 @@ Metrics/LineLength:
 Style/Documentation:
   Enabled: false
 
-Style/SingleSpaceBeforeFirstArg:
-  Enabled: false
+Layout/SpaceBeforeFirstArg:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.3.7

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# v2.0.0 (2018-09-21)
+
+* Chore: inline URLcrypt for threadsafety
+
 # 1.9.0
 
 * Chore: Update URL for local dev to use pco.test and churchcenter.test

data/README.md

@@ -46,4 +46,45 @@ PCO::URL.accounts("test")
 
 PCO::URL.accounts("test", "working")
 # => "https://accounts-test1.planningcenteronline.com/test/working"
-```
+```
+
+### Encryption
+
+`pco-url` includes URL-safe encryption utilites in the `PCO::URL::Encryption` module.
+
+It uses `aes-256-cbc` for encryption, and the code is ported from [URLcrypt](https://github.com/cheerful/URLcrypt).
+
+The encryption/decryption key **should** be 32 bytes. In Ruby <= 2.3, a longer key will be automatically truncated by the `OpenSSL` library, but starting with Ruby >= 2.4, the encryption will fail if the key is not exactly 32 bytes. If you currently are using a key that isn't 32 bytes, you will have to change the key to upgrade to Ruby 2.4.
+
+#### Setup
+
+`PCO::URL::Encryption` can be used with a global default encryption key, or a specific key for each encrypt/decrypt step.
+
+To set a default key:
+
+```ruby
+# for example, in an initializer
+
+PCO::URL::Encryption.default_key = "32 bytes of randomness"
+```
+
+**note:** if you set a default key, `pco-url` will raise an error on any attempt to modify the default key. If you need to use multiple keys in your app, use the keyword argument syntax to set it for each encryption/decryption.
+
+#### Usage
+
+To encrypt with the global default key
+
+```ruby
+# encrypt with the global default key
+PCO::URL::Encryption.encrypt("sekret") # => qmj1w631bs6hd3cyf8h5kv37n3Zxxvgyr4j5jvsll0x65f7vcm9sm
+
+# decrypt with the global default key
+PCO::URL::Encryption.decrypt("qmj1w631bs6hd3cyf8h5kv37n3Zxxvgyr4j5jvsll0x65f7vcm9sm") # => sekret
+
+# encrypt with a specific key
+thirty_two_byte_string = "192c0ba7369e27f4b04fa304030712c8"
+
+PCO::URL::Encryption.encrypt("sekret", key: thirty_two_byte_string) # => rxnfnstyt6fvs618A8Abwtg1c1Zyqhgf0lhtqtmypc4t0zlhxyr02
+
+PCO::URL::Encryption.decrypt("rxnfnstyt6fvs618A8Abwtg1c1Zyqhgf0lhtqtmypc4t0zlhxyr02", key: thirty_two_byte_string) # => sekret
+```

data/lib/pco/url.rb

@@ -1,14 +1,14 @@
 require_relative "url/version"
 require_relative "url/church_center"
 require_relative "url/get"
+require_relative "url/encryption"
 require "uri"
-require "URLcrypt"
 
 module PCO
   class URL
     class << self
       def decrypt_query_params(string)
-        URLcrypt.decrypt(string)
+        Encryption.decrypt(string)
       end
 
       def parse(string)
@@ -62,7 +62,7 @@ module PCO
       @path = @path[1..-1] if @path && @path[0] == "/"
 
       if query
-        @query = encrypt_query_params ? "_e=#{URLcrypt.encrypt(query)}" : query
+        @query = encrypt_query_params ? "_e=#{Encryption.encrypt(query)}" : query
       end
     end
 

data/lib/pco/url/encryption.rb

@@ -0,0 +1,122 @@
+# Sourced from https://github.com/cheerful/URLcrypt/blob/v0.1.1/lib/URLcrypt.rb
+#
+# Copyright (c) 2013-2015 Thomas Fuchs
+# Copyright (c) 2007-2011 Samuel Tesla
+#
+# 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.
+
+require "openssl"
+
+module PCO
+  class URL
+    module Encryption
+      class DecryptError < ::ArgumentError; end
+      class MissingKeyError < ::ArgumentError; end
+
+      # avoid vowels to not generate four-letter words, etc.
+      # this is important because those words can trigger spam
+      # filters when URLs are used in emails
+      TABLE = "1bcd2fgh3jklmn4pqrstAvwxyz567890".freeze
+
+      class Chunk
+        def initialize(bytes)
+          @bytes = bytes
+        end
+
+        def decode # rubocop:disable Metrics/AbcSize
+          bytes = @bytes.take_while { |c| c != 61 } # strip padding
+          bytes = bytes.find_all { |b| !TABLE.index(b.chr).nil? } # remove invalid characters
+          n = (bytes.length * 5.0 / 8.0).floor
+          p = bytes.length < 8 ? 5 - (n * 8) % 5 : 0
+          c = bytes.inject(0) { |m, o| (m << 5) + TABLE.index(o.chr) } >> p
+          (0..(n - 1)).to_a.reverse.collect { |i| ((c >> i * 8) & 0xff).chr }
+        end
+
+        def encode # rubocop:disable Metrics/AbcSize
+          n = (@bytes.length * 8.0 / 5.0).ceil
+          p = n < 8 ? 5 - (@bytes.length * 8) % 5 : 0
+          c = @bytes.inject(0) { |m, o| (m << 8) + o } << p
+          [
+            (0..(n - 1)).to_a.reverse.collect { |i| TABLE[(c >> i * 5) & 0x1f].chr },
+            ("=" * (8 - n))
+          ]
+        end
+      end
+
+      class << self
+        def default_key=(key)
+          raise(<<~ERR) if defined?(@default_key) && @default_key != key
+            Don't change the default_key during the life of a process.
+            This configuration variable is meant to be set once on boot and not
+            touched again.
+
+            If your app needs to use multiple keys, pass them in explicitly to `encrypt`
+            and `decrypt`
+          ERR
+
+          @default_key = key
+        end
+
+        def decrypt(data, key: @default_key)
+          raise MissingKeyError, "default key or key: argument must be set" if key.nil?
+          iv, encrypted = data.split("Z").map { |part| decode(part) }
+          raise DecryptError, "not a valid string to decrypt" unless iv && encrypted
+          decrypter = cipher(:decrypt, key: key)
+          decrypter.iv = iv
+          decrypter.update(encrypted) + decrypter.final
+        end
+
+        def encrypt(data, key: @default_key)
+          raise MissingKeyError, "default key or key: argument must be set" if key.nil?
+          crypter = cipher(:encrypt, key: key)
+          crypter.iv = iv = crypter.random_iv
+          "#{encode(iv)}Z#{encode(crypter.update(data) + crypter.final)}"
+        end
+
+        private
+
+        def chunks(str, size)
+          result = []
+          bytes = str.bytes
+          while bytes.any?
+            result << Chunk.new(bytes.take(size))
+            bytes = bytes.drop(size)
+          end
+          result
+        end
+
+        # strip "=" padding, because we don"t need it
+        def encode(data)
+          chunks(data, 5).collect(&:encode).flatten.join.tr("=", "")
+        end
+
+        def decode(data)
+          chunks(data, 8).collect(&:decode).flatten.join
+        end
+
+        def cipher(mode, key:)
+          cipher = OpenSSL::Cipher.new("aes-256-cbc")
+          cipher.public_send(mode)
+          cipher.key = key
+          cipher
+        end
+      end
+    end
+  end
+end

data/lib/pco/url/version.rb

@@ -1,5 +1,5 @@
 module PCO
   class URL
-    VERSION = "1.9.0"
+    VERSION = "2.0.0".freeze
   end
 end

data/pco-url.gemspec

@@ -17,8 +17,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "urlcrypt", ">= 0.1.1"
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", ">= 3.0.0", "< 4"
+  spec.add_development_dependency "rubocop", "0.54.0"
 end

data/spec/.rubocop.yml

@@ -0,0 +1,4 @@
+inherit_from: ../.rubocop.yml
+
+Metrics/BlockLength:
+  Max: 200

data/spec/pco/url/encryption_spec.rb

@@ -0,0 +1,121 @@
+require "spec_helper"
+
+describe PCO::URL::Encryption do
+  # rubocop:disable Metrics/LineLength
+  TEST_DEFAULT_KEY = "b01b94f55e543afee167392ea43f8245".freeze
+  TEST_SPECIFIC_KEY = "97f44346e1cfa9f5fc19463fd182c495".freeze
+  # rubocop:enable Metrics/LineLength
+
+  after { reset_encryption_default_key }
+
+  it "gets mad if you try to change the default key" do
+    described_class.default_key = "key!"
+
+    expect { described_class.default_key = "new key!" }.to raise_error(/change the default_key/i)
+  end
+
+  context "without a specific key" do
+    context "when a default key is set" do
+      it "encrypts and decrypts correctly" do
+        described_class.default_key = TEST_DEFAULT_KEY
+        encrypted = described_class.encrypt("BoJack")
+        decrypted = described_class.decrypt(encrypted)
+
+        expect(decrypted).to eq("BoJack")
+      end
+
+      it "decrypts correctly" do
+        described_class.default_key = TEST_DEFAULT_KEY
+        encrypted = "gktp1A49k6kmbz7ktfwrzwlmc2Zn8t95d4lq9bc62mr252d0542k1"
+
+        expect(described_class.decrypt(encrypted)).to eq("Horseman")
+      end
+    end
+
+    context "when no default key is set" do
+      it "fails loudly because no key is set" do
+        expect { described_class.encrypt("value") }.to raise_error(described_class::MissingKeyError)
+        expect { described_class.decrypt("value") }.to raise_error(described_class::MissingKeyError)
+      end
+    end
+  end
+
+  context "using a specified key" do
+    it "encrypts and decrypts correctly" do
+      encrypted = described_class.encrypt("You are Secretariat", key: TEST_SPECIFIC_KEY)
+      decrypted = described_class.decrypt(encrypted, key: TEST_SPECIFIC_KEY)
+
+      expect(decrypted).to eq("You are Secretariat")
+    end
+
+    it "decrypts correctly" do
+      encrypted = "lbklbyhw9pkgs3mqtc5p000xz1Zqrdrkf1f3phmhvzfksgg2Aqdg78kngpv3r5zz1fll6z5cvn96j11"
+
+      expect(described_class.decrypt(encrypted, key: TEST_SPECIFIC_KEY)).to eq("Do the funky Spiderman")
+    end
+  end
+
+  context "the original URLcrypt tests" do
+    def private_encode(plain)
+      described_class.send(:encode, plain)
+    end
+
+    def private_decode(encded)
+      described_class.send(:decode, encded)
+    end
+
+    def expect_bytes_equal(string1, string2)
+      bytes1 = string1.bytes.to_a.join(":")
+      bytes2 = string2.bytes.to_a.join(":")
+      expect(bytes1).to eq(bytes2)
+    end
+
+    def expect_decoding(encoded, plain)
+      expect_bytes_equal(plain, private_decode(encoded))
+    end
+
+    def expect_encoding(encoded, plain)
+      expect_bytes_equal(encoded, private_encode(plain))
+    end
+
+    it "test empty string" do
+      expect_encoding("", "")
+      expect_decoding("", "")
+    end
+
+    it "encodes and decodes properly" do
+      encoded = "111gc86f4nxw5zj1b3qmhpb14n5h25l4m7111"
+      plain = "\0\0awesome \n ü string\0\0"
+
+      expect_encoding(encoded, plain)
+      expect_decoding(encoded, plain)
+    end
+
+    it "test invalid decoding" do
+      expect_decoding("ZZZZZ", "")
+    end
+
+    it "test arbitrary byte strings" do
+      0.step(1500, 17) do |n|
+        original = (0..n).map { rand(256).chr }.join
+        encoded = private_encode(original)
+        expect_decoding(encoded, original)
+      end
+    end
+
+    it "test encryption" do
+      described_class.default_key = "3c3ff314c12b786da43a50b571c0aedc"
+
+      original  = "hello world!"
+      encrypted = described_class.encrypt(original)
+      expect(described_class.decrypt(encrypted)).to eq(original)
+    end
+
+    it "test decrypt error" do
+      described_class.default_key = "some key"
+      expect { described_class.decrypt("just some plaintext") }
+        .to raise_error(described_class::DecryptError)
+        .with_message("not a valid string to decrypt")
+    end
+  end
+end

data/spec/pco_url_spec.rb

@@ -14,8 +14,12 @@ APPLICATIONS = [
 
 describe PCO::URL do
   before :all do
-    URLcrypt.key = "984e9002e680dc9b9c2556434c47f7e4782191f52063277901e4a009797652e0" \
-                   "8f28be069dfb4d4a1e3c9ab09fedab59be2c9b6486748bf44030182815ee4987"
+    PCO::URL::Encryption.default_key =
+      "\xF7\xFE\x99I\x1EkO\xD4\xD3\v\x96\x8A\b\x17\xD8m\x01jr\x8F\xA0L.\xB3\xF3\x12\xD7c\x16\xA8\xD0."
+  end
+
+  after :all do
+    reset_encryption_default_key
   end
 
   describe "defaults" do
@@ -177,7 +181,7 @@ describe PCO::URL do
     end
 
     it "encrypts and decrypts URL parameters" do
-      expect(URLcrypt.decrypt(subject.query.gsub("_e=", ""))).to eq("foo=bar")
+      expect(PCO::URL::Encryption.decrypt(subject.query.gsub("_e=", ""))).to eq("foo=bar")
     end
 
     it "decrypts using #decrypt_query_params" do

data/spec/spec_helper.rb

@@ -5,6 +5,11 @@ RSpec.configure do |config|
   config.color = true
   config.filter_run focus: true
   config.run_all_when_everything_filtered = true
+
+  def reset_encryption_default_key
+    return unless PCO::URL::Encryption.instance_variable_defined?(:@default_key)
+    PCO::URL::Encryption.remove_instance_variable(:@default_key)
+  end
 end
 
 class Rails

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: pco-url
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 2.0.0
 platform: ruby
 authors:
 - James Miller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-08 00:00:00.000000000 Z
+date: 2018-09-24 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: urlcrypt
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.1.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -72,6 +58,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.54.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.54.0
 description: 
 email:
 - bensie@gmail.com
@@ -79,21 +79,25 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".editorconfig"
 - ".gitignore"
 - ".rubocop.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- circle.yml
 - lib/pco/url.rb
 - lib/pco/url/church_center.rb
+- lib/pco/url/encryption.rb
 - lib/pco/url/get.rb
 - lib/pco/url/version.rb
 - pco-url.gemspec
+- spec/.rubocop.yml
 - spec/pco/url/church_center_spec.rb
+- spec/pco/url/encryption_spec.rb
 - spec/pco_url_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/ministrycentered/pco-url
@@ -116,11 +120,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Generate URLs for PCO apps in all environments
 test_files:
+- spec/.rubocop.yml
 - spec/pco/url/church_center_spec.rb
+- spec/pco/url/encryption_spec.rb
 - spec/pco_url_spec.rb
 - spec/spec_helper.rb

data/circle.yml

@@ -1,3 +0,0 @@
-machine:
-  ruby:
-    version: 2.2.1