govdelivery-crypt 3.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7578fbf111ac783542fea3e327515383fd37ff2a
+  data.tar.gz: b317cb5e0e5803b4e5461707815b34824c81c836
+SHA512:
+  metadata.gz: 60802e7a8bc5c2a00c414e9b261308769e7dcfd598e71001750e62cc4964fa7061295edc7328ad4d38054c67f3389bd3008d6c14a335488ba85baa6c62419049
+  data.tar.gz: 212241e298d5736b2329f99fb4d3b1bd87dc53b67fe32de42ae4478da4f2f89f8ff3e794532f7a80308deadd0aa67c62c8a2af289e2755b040e8762cf38de2bd

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/README.md

@@ -0,0 +1,48 @@
+# Govdelivery::Crypt
+
+This is where we encrypt and decrypt things. Uses include:
+
+* TMS recipient IDs
+* CC bulletin recipient identifiers
+
+There is also some Java code in BP2 that needs to be compatible with GovDelivery::Crypt::XSubscriber. Blacklist extends
+this gem to support some old methods for encrypting subscriber IDs that we souldn't be using anymore
+
+CI build tests on multiple rubies, the idea is that MRI and JRuby apps alike can use this.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'govdelivery-crypt', require: 'govdelivery/crypt'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install govdelivery-crypt
+
+Run the tests:
+
+    $ rake test
+
+## Usage
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/govdelivery-crypt/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,24 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+# you also need to do this in your gemspec:
+# if spec.respond_to?(:metadata)
+#   spec.metadata['allowed_push_host'] = "http://prod-rubygems1-ep.tops.gdi"
+# end
+module Bundler
+  class GemHelper
+    GEM_HOST = "http://prod-rubygems1-ep.tops.gdi"
+
+    protected
+    def rubygem_push(path)
+      sh("gem push '#{path}' --host #{GEM_HOST}")
+      Bundler.ui.confirm "Pushed #{name} #{version} to #{GEM_HOST}."
+    end
+  end
+end
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "govdelivery/crypt"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/govdelivery-crypt

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'govdelivery/crypt'
+GovDelivery::Crypt::Cli.new(ARGV)

data/govdelivery-crypt.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'govdelivery/crypt/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "govdelivery-crypt"
+  spec.version       = GovDelivery::Crypt::VERSION
+  spec.authors       = ["Benjamin Ortega"]
+  spec.email         = ["ben.ortega@gmail.com"]
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "http://prod-rubygems1-ep.tops.gdi"
+  end
+
+  spec.summary       = %q{encryption wrappers for GovDelivery Ruby projects}
+  spec.description   = %q{Encrypt and decrypt things to your heart's content.}
+  spec.homepage      = "http://www.govdelivery.com"
+  spec.license       = ""
+
+  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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest-spec-context"
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'multi_json'
+end

data/lib/govdelivery/crypt.rb

@@ -0,0 +1,11 @@
+require "govdelivery/crypt/version"
+require 'openssl'
+require 'base64'
+
+require 'active_support/core_ext/object/blank'
+require 'multi_json'
+require 'govdelivery/crypt/cli'
+require 'govdelivery/crypt/errors'
+require 'govdelivery/crypt/open_ssl'
+require 'govdelivery/crypt/x_subscriber'
+require 'govdelivery/crypt/x_tms_recipient'

data/lib/govdelivery/crypt/cli.rb

@@ -0,0 +1,36 @@
+require 'optparse'
+
+module GovDelivery
+  module Crypt
+    class Cli
+      def initialize(args)
+        options = OptionParser.new do |opts|
+          opts.banner = "Usage: govdelivery_crypt [options] (encrypted string)"
+
+          opts.on("-tCODE", "--tms-recipient=CODE", "Decrypt TMS recipient") do |encrypted_string|
+            puts GovDelivery::Crypt::XTmsRecipient.decrypt(encrypted_string)
+            exit
+          end
+
+          opts.on("-sCODE", "--subscriber=CODE", "Decrypt subscriber") do |encrypted_string|
+            puts GovDelivery::Crypt::XSubscriber.decrypt(encrypted_string)
+            exit
+          end
+
+          opts.on_tail("-h", "--help", "Show this message") do
+            puts opts
+            exit
+          end
+
+          # Another typical switch to print the version.
+          opts.on_tail("--version", "Show version") do
+            puts GovDelivery::Crypt::Version
+            exit
+          end
+        end.parse!(args)
+
+        puts "No options specified, see `govdelivery-crypt --help` for options"
+      end
+    end
+  end
+end

data/lib/govdelivery/crypt/errors.rb

@@ -0,0 +1,6 @@
+module GovDelivery
+  module Crypt
+    class Undecipherable < StandardError
+    end
+  end
+end

data/lib/govdelivery/crypt/open_ssl.rb

@@ -0,0 +1,27 @@
+module GovDelivery
+  module Crypt
+    module OpenSSL
+      CIPHER = 'AES-256-ECB'
+
+      def to_crypt(string, key)
+        aes = get_aes(:encrypt, key)
+        Base64.strict_encode64("#{aes.update(string)+aes.final}")
+      end
+
+      def from_crypt(string, key)
+        aes = get_aes(:decrypt, key)
+        aes.update(Base64.strict_decode64(string))+aes.final
+      end
+
+
+      private
+
+      def get_aes(method, key)
+        aes = ::OpenSSL::Cipher::Cipher.new(CIPHER)
+        aes.send(method)
+        aes.key = key
+        aes
+      end
+    end
+  end
+end

data/lib/govdelivery/crypt/version.rb

@@ -0,0 +1,5 @@
+module GovDelivery
+  module Crypt
+    VERSION = "3.1.0"
+  end
+end

data/lib/govdelivery/crypt/x_subscriber.rb

@@ -0,0 +1,111 @@
+module GovDelivery
+  module Crypt
+    class Undecipherable < StandardError
+    end
+
+    class XSubscriber
+
+      # GD2 stored original email addresses in a header using a homebrew TEA implementation
+      # that doesn't appear to be compatible with other implementations. We shouldn't need this
+      # and it would only work in Java if we did include it, so including for posterity only.
+      class Version1
+
+        def encrypt(string)
+          raise NotImplementedError.new('X-Subscriber version 1 encryption is not implemented')
+        end
+
+        def decrypt(string)
+          raise NotImplementedError.new('X-Subscriber version 1 decryption is not implemented')
+        end
+
+        def decrypted_hash(string)
+          raise NotImplementedError.new('X-Subscriber version 1 decryption is not implemented')
+        end
+
+      end
+
+      # AES-256-ECB encryption of original email address
+      class Version2
+        include ::GovDelivery::Crypt::OpenSSL
+
+        KEY=Digest::SHA1.hexdigest('GovDelivery DCM x-subscriber secret key')[0..31]
+
+        def version
+          '2'
+        end
+
+        def encrypt(string)
+          "#{version}.#{to_crypt(string, KEY)}".strip
+        end
+
+        # returns a string representing the recipient's email address
+        def decrypt(string)
+          from_crypt(string, KEY)
+        end
+
+        # returns a subset of v3 payload data for forward compatibility with systems using v3 format
+        def decrypted_hash(string)
+          {'email' => from_crypt(string, KEY)}
+        end
+      end
+
+      # AES-256-ECB encryption of a JSON hash including
+      # email - original recipient email address
+      # src - original message sender and type
+      # user_id - ID of recipient in sending system
+      # mailing_id - ID of mailing in sending system
+      class Version3 < Version2
+
+        def version
+          '3'
+        end
+
+        # returns the payload JSON as a string
+        def decrypt(string)
+          from_crypt(string, KEY)
+        end
+
+        # returns the payload JSON transformed into a hash
+        def decrypted_hash(string)
+          MultiJson.load(from_crypt(string, KEY))
+        end
+      end
+
+      class << self
+
+
+        def encrypt(email, src=nil, mailing_id=nil, user_id=nil)
+          if src || mailing_id || user_id
+            Version3.new.encrypt(
+              MultiJson.dump(src:        src,
+                             email:      email,
+                             mailing_id: mailing_id,
+                             user_id:    user_id))
+          else
+            Version2.new.encrypt(email)
+          end
+        end
+
+        def decrypt(encrypted_address)
+          raise Undecipherable.new('X-subscriber header is missing or blank') if encrypted_address.blank?
+
+          parts         = encrypted_address.split('.')
+          email_address = case parts.first
+                            when '2'
+                              Version2.new.decrypted_hash(parts[1].to_s)
+                            when '3'
+                              Version3.new.decrypted_hash(parts[1].to_s)
+                            else
+                              Version1.new.decrypted_hash(encrypted_address)
+                          end
+
+          raise Undecipherable.new("X-Subscriber value #{encrypted_address} could not be parsed (got #{email_address})") unless email_address.is_a?(Hash)
+          email_address
+        end
+
+
+      end
+
+    end
+  end
+end

data/lib/govdelivery/crypt/x_tms_recipient.rb

@@ -0,0 +1,49 @@
+module GovDelivery
+  module Crypt
+    class XTmsRecipient
+      # AES-256-ECB encryption of original email and TMS-XACT recipient ID
+      class Version1
+        include ::GovDelivery::Crypt::OpenSSL
+
+        DELIMITER = "::"
+        KEY       = "e5004a37c17c9c94139fd7b2e82b61b1"
+
+        attr_accessor :email, :recipient_id
+
+        def initialize(email=nil, recipient_id=nil)
+          @email        = email
+          @recipient_id = recipient_id
+        end
+
+        # email::recipient_id
+        def encrypt
+          string = [@email, @recipient_id].join('::')
+          "1.#{to_crypt(string, KEY)}".strip
+        end
+
+        # email::recipient_id
+        def decrypt(input)
+          @email, @recipient_id = from_crypt(input, KEY).split(DELIMITER)
+          self
+        end
+      end
+
+      class << self
+
+        def encrypt(*args)
+          Version1.new(*args).encrypt
+        end
+
+        def decrypt(payload)
+          raise Undecipherable.new('payload is missing or blank') if payload.blank?
+
+          parts = payload.split('.')
+          return Version1.new.decrypt(parts[1]) if parts.first=='1'
+          raise Undecipherable.new('payload is invalid')
+        end
+
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: govdelivery-crypt
+version: !ruby/object:Gem::Version
+  version: 3.1.0
+platform: ruby
+authors:
+- Benjamin Ortega
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: minitest-spec-context
+  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: activesupport
+  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: Encrypt and decrypt things to your heart's content.
+email:
+- ben.ortega@gmail.com
+executables:
+- govdelivery-crypt
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/govdelivery-crypt
+- govdelivery-crypt.gemspec
+- lib/govdelivery/crypt.rb
+- lib/govdelivery/crypt/cli.rb
+- lib/govdelivery/crypt/errors.rb
+- lib/govdelivery/crypt/open_ssl.rb
+- lib/govdelivery/crypt/version.rb
+- lib/govdelivery/crypt/x_subscriber.rb
+- lib/govdelivery/crypt/x_tms_recipient.rb
+homepage: http://www.govdelivery.com
+licenses:
+- ''
+metadata:
+  allowed_push_host: http://prod-rubygems1-ep.tops.gdi
+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.0.14.1
+signing_key: 
+specification_version: 4
+summary: encryption wrappers for GovDelivery Ruby projects
+test_files: []