carwash 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e6576ac51de59d7fdccb1fcb5c591cf9e38680f9
+  data.tar.gz: 6988e960d2d76d58ab9732f86b837676a8778d0a
+SHA512:
+  metadata.gz: f5b1ebf5ba0738aabf8fdf39645732998834da2ffae9ae3840c38bc039f1f2ee3a2eac7208310f96124a00f0275e291d13af0d9ef7e24bcaa63cb13a859dd817
+  data.tar.gz: 0d9c5db4ea69d11b676fe710d6f314861f451bfe875fb0b3c654ba2949800c951e04264256ead8ae2f78692af9823e740d91b72b74b48dce4dbf83315e51d2a3

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+/carwash-*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.4

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.4
+before_install: gem install bundler -v 1.14.6

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Nathan Clark
+
+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,52 @@
+# Carwash
+
+Log sanitizer. Obscures passwords and other potentially sensitive values in log
+entries.
+
+## Features
+
+* Learns potentially sensitive values by looking for keys like "PASSWORD" and
+  "TOKEN", then obscures them wherever they subsequently occur.
+* Seeds the list of sensitive values from environment variables and Rails'
+  `secrets.yml`.
+* Additional sensitive keys and values can be added as needed, if you have
+  a known source of secured config values that could potentially end up
+  (accidentally) showing up in logs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'carwash'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install carwash
+
+## Usage
+
+```ruby
+scrubber = Carwash::Scrubber.new
+
+scrubber.add_sensitive_key("CERT")
+scrubber.add_sensitive_value("P@ssw0rd")
+scrubber.add_sensitive_value("mysecret")
+
+log_lines.each do |line|
+  puts scrubber.scrub(line)
+end
+```
+
+Or to scrub an entire input stream line by line and print it to stdout:
+
+```
+scrubber.scrub_stream(input_stream, STDOUT)
+```
+
+See `Carwash::Scrubber` for the rest of the API.

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 "carwash"
+
+# 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/carwash.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'carwash/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "carwash"
+  spec.version       = Carwash::VERSION
+  spec.authors       = ["Nathan Clark"]
+  spec.email         = ["nathan.clark@tokenshift.com"]
+  spec.license       = "MIT"
+
+  spec.summary       = %q{Scrubs potentially sensitive values from log entries.}
+  spec.homepage      = "http://github.com/tokenshift/ruby_carwash"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/carwash.rb

@@ -0,0 +1,10 @@
+require "carwash/version"
+
+require "carwash/uri_password_discoverer"
+require "carwash/value_discoverer"
+require "carwash/xml_value_discoverer"
+
+require "carwash/scrubber"
+
+module Carwash
+end

data/lib/carwash/scrubber.rb

@@ -0,0 +1,117 @@
+require "set"
+
+# Keeps track of values known/suspected to be sensitive (passwords, etc) and
+# obscures them in lines of text.
+class Carwash::Scrubber
+  DEFAULT_OBSCURE_WITH   = "********"
+  DEFAULT_SENSITIVE_KEYS = %w[key password secret token]
+
+  attr_accessor :obscure_with
+  attr_reader :sensitive_keys
+
+  def initialize(sensitive_keys: DEFAULT_SENSITIVE_KEYS,
+                 obscure_with: DEFAULT_OBSCURE_WITH,
+                 check_for_rails: true,
+                 check_env_vars: true)
+    @obscure_with = obscure_with
+
+    @sensitive_keys = Set.new(sensitive_keys.map(&:to_s).map(&:downcase))
+    @sensitive_vals = Set.new
+
+    if check_for_rails && defined? Rails
+      @sensitive_keys += Rails.configuration.filter_parameters.map(&:to_s).map(&:downcase).compact
+      @sensitive_keys += Rails.application.secrets.keys.map(&:to_s).map(&:downcase).compact
+      @sensitive_vals += Rails.application.secrets.values.map(&:to_s).map(&:downcase).compact
+    end
+
+    if check_env_vars
+      ENV.each do |env_key, env_val|
+        @sensitive_keys.each do |key|
+          if env_key =~ %r{[_-]?#{key}}i
+            @sensitive_vals.add env_val.downcase
+          end
+        end
+      end
+    end
+  end
+
+  # Adds a string to the list of known sensitive values. Useful for adding
+  # passwords/keys that are known at startup time, without relying on value
+  # discovery.
+  def add_sensitive_value(value)
+    @sensitive_vals.add(value.to_s.downcase)
+  end
+
+  # Adds a string to the list of sensitive keys, to be used when learning new
+  # values to be obscured.
+  def add_sensitive_key(key)
+    @sensitive_keys.add(key.to_s.downcase)
+  end
+
+  # Look for sensitive keys in a line of text and "learn" the associated
+  # potentially sensitive values. E.g. if "PASSWORD" is set as a sensitive key,
+  # the line "PASSWORD=super_secret" will add "super_secret" to the list of
+  # known sensitive values.
+  def discover_sensitive_values(line)
+    value_discoverers.each do |discoverer|
+      @sensitive_vals += discoverer.discover(line).map(&:to_s).map(&:downcase)
+    end
+  end
+
+  # Go through a line of text and obscure any potentially sensitive values
+  # detected. Returns the line with replacements made.
+  #
+  # NOTE: Does *not* discover/learn values from the line; use `#scrub` to both
+  # discover and obscure based on the line.
+  def obscure_sensitive_values(line, obscure_with: self.obscure_with)
+    line = line.clone
+    obscure_sensitive_values!(line, obscure_with: obscure_with)
+    line
+  end
+
+  # Go through a line of text and obscure any potentially sensitive values
+  # detected. Makes replacements in place.
+  def obscure_sensitive_values!(line, obscure_with: self.obscure_with)
+    @sensitive_vals.each do |val|
+      line.gsub!(val, obscure_with)
+    end
+  end
+
+  # Scans the line to try and discover potentially sensitive values, then
+  # obscures all sensitive values known. Returns the line with replacements
+  # made.
+  def scrub(line, obscure_with: self.obscure_with)
+    discover_sensitive_values(line)
+    obscure_sensitive_values(line, obscure_with: obscure_with)
+  end
+
+  # Scans the line to try and discover potentially sensitive values, then
+  # obscures all sensitive values known. Makes replacements in place.
+  def scrub!(line, obscure_with: self.obscure_with)
+    discover_sensitive_values(line)
+    obscure_sensitive_values!(line, obscure_with: obscure_with)
+  end
+
+  # Learns from and scrubs each line of an input stream, writing the result to 
+  # the given output stream.
+  def scrub_stream(input, output)
+    input.each_line do |line|
+      output.puts(scrub(line))
+    end
+  end
+
+  private
+
+  # Provides a list of value discovers to use when attempting to learn
+  # sensitive values from input text.
+  def value_discoverers
+    Enumerator.new do |y|
+      @sensitive_keys.each do |key|
+        y << Carwash::ValueDiscoverer.new(key)
+        y << Carwash::XmlValueDiscoverer.new(key)
+      end
+
+      y << Carwash::UriPasswordDiscoverer.new
+    end
+  end
+end

data/lib/carwash/uri_password_discoverer.rb

@@ -0,0 +1,11 @@
+# Scans for occurrences of a password baked into a URI (e.g. a database
+# connection string), of the form `scheme://username:PASSWORD@hostname`.
+class Carwash::UriPasswordDiscoverer
+  URI_PASSWORD_PATTERN= %r{:([0-9a-z_\.\-~%]+?)@}i
+
+  def discover(line)
+    line.scan(URI_PASSWORD_PATTERN).map(&:first).map { |password|
+      CGI::unescape(password)
+    }
+  end
+end

data/lib/carwash/value_discoverer.rb

@@ -0,0 +1,33 @@
+# Scans for occurrences of a key in a line of text and returns any associated
+# values.
+#
+# Looks for the following patterns of key-value pairs:
+# KEY=value
+# KEY='value'
+# KEY="value"
+# KEY value
+# KEY 'value'
+# KEY "value"
+# KEY: value
+# KEY => value
+class Carwash::ValueDiscoverer < Struct.new(:key)
+  def discover(line)
+    patterns.flat_map { |pattern|
+      line.scan(pattern).map(&:first)
+    }.reject(&:nil?).reject(&:empty?).map(&:downcase).map { |val|
+      unescape_value(val)
+    }
+  end
+
+  def patterns
+    @patterns ||= [
+      %r{#{key}['"]?\s*(?:=>|=|:|\s+)\s*'((?:\\'|[^'])+)'}i,
+      %r{#{key}['"]?\s*(?:=>|=|:|\s+)\s*"((?:\\"|[^"])+)"}i,
+      %r{#{key}['"]?\s*(?:=>|=|:|\s+)\s*((?:\\\s|\\"|\\'|[^\s'"])+)}i
+    ]
+  end
+
+  def unescape_value(value)
+    value.gsub(/\\(.)/) { $1 }
+  end
+end

data/lib/carwash/version.rb

@@ -0,0 +1,3 @@
+module Carwash
+  VERSION = "1.0.0"
+end

data/lib/carwash/xml_value_discoverer.rb

@@ -0,0 +1,17 @@
+require 'rexml/document'
+
+# Discovers values in the format <key>value, which may occur in XML/HTML.
+# XML attribute values are already handled using the basic ValueDiscoverer,
+# since they match the `key="value"` format that it handles.
+class Carwash::XmlValueDiscoverer < Struct.new(:key)
+  def discover(line)
+    line.scan(%r{[^/]#{key}>(?:([^<]+)|<!\[CDATA\[(.*?)\]\])}i)
+      .map(&:compact)
+      .flatten(1)
+      .map { |val| unescape_value(val) }
+  end
+
+  def unescape_value(value)
+    REXML::Text::unnormalize(value)
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: carwash
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nathan Clark
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- nathan.clark@tokenshift.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- carwash.gemspec
+- lib/carwash.rb
+- lib/carwash/scrubber.rb
+- lib/carwash/uri_password_discoverer.rb
+- lib/carwash/value_discoverer.rb
+- lib/carwash/version.rb
+- lib/carwash/xml_value_discoverer.rb
+homepage: http://github.com/tokenshift/ruby_carwash
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Scrubs potentially sensitive values from log entries.
+test_files: []