sslocal 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fc5b3d34e3f44dc24ac304305a1cbfaf60888ff6496c90a1a4d6142ade226555
+  data.tar.gz: db30eb94f25c9458c6eadb43c8c9fd8a80836bb6bced032647b3116c201a8961
+SHA512:
+  metadata.gz: 04fc271a743ddc37ed8976d5900ae7ec3a7dde455af53d894571586b2f97e2ffc2167a72ec0c61c728efb43deaa151f51114f08c5267974e43e7ed6a620dd21a
+  data.tar.gz: ea541b4193a031ac8b3bed4cfcb9a307c4e2a1b5a349f50ec68cadc327097f1c8994a4469245437fd9a016a77d21e38a3130cf3edcf70d65a518eecbf7a02db9

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,13 @@
+inherit_from:
+  - https://gist.githubusercontent.com/pat/ba3b8ffb1901bfe5439b460943b6b019/raw/.rubocop.yml
+  - https://gist.githubusercontent.com/pat/ba3b8ffb1901bfe5439b460943b6b019/raw/performance.yml
+
+require:
+  - rubocop-packaging
+  - rubocop-performance
+
+AllCops:
+  TargetRubyVersion: 2.7
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false

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 pat@freelancing-gods.com. 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 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake", "~> 12.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Pat Allan
+
+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,53 @@
+# SSLocal
+
+SSLocal helps to make running SSL in your local Ruby development environment as streamlined as possible. Currently it's built to work with Rack apps that use Puma (including Rails).
+
+Please **do not use this gem in production environments** - it's only meant for local development.
+
+## Installation
+
+1. Install [mkcert](https://github.com/FiloSottile/mkcert)
+2. Add `config/certificates` to your application's `.gitignore` file.
+3. Add this gem to your application's Gemfile - ideally just for the development environment.
+
+```ruby
+gem "sslocal", group: :development
+```
+
+4. Add the following lines to the end of your `config/puma.rb` file - adjusting the environment variable name if appropriate.
+
+```ruby
+if ENV.fetch("RAILS_ENV", "development") == "development"
+  require "sslocal"
+  plugin :sslocal
+end
+```
+
+## Usage
+
+1. Ensure the `config/certificates` folder exists (`mkdir -p config/certificates`).
+2. Generate the local certificate via `mkcert`:
+
+```sh
+mkcert --cert-file config/certificates/development.crt \
+  --key-file config/certificates/development.key \
+  localhost 127.0.0.1
+```
+
+3. Boot your Rack/Rails app (whether via `rails server`, Foreman, Overmind, etc), and it should automatically use SSL using the generated certificate files.
+
+If you're using SSLocal with a Rails app, it will change your app's settings dynamically to use HTTPS for Webpacker and ActionCable (if they're being used). However, if you are using Webpacker, you'll almost certainly want to install and set up [the SSLocal library for JavaScript](https://github.com/pat/sslocal-js) as well to keep matching protocols.
+
+If you want to switch back to HTTP, just delete the certificate files and restart your Rack/Rails app. The certificate files are not precious, and can be deleted/regenerated as much as you like.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pat/sslocal-rb. 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/pat/sslocal-rb/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is copyright Pat Allan, 2020, and is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in SSLocal's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/pat/sslocal-rb/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "sslocal"
+
+# 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/puma/plugin/sslocal.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "puma"
+require "puma/plugin"
+require "sslocal/puma_rebinder"
+
+module Puma
+  class Plugin
+    class SSLocal
+      # Puma 4.x supplies an argument, but 5.x does not. We don't need it
+      # either way.
+      def initialize(_loader = nil); end
+
+      # We don't actually want to modify the configuration here, as it only
+      # impacts the file_config values. user_config values take precedence,
+      # and the only way to cleanly impact those is via the launcher object
+      # supplied in the `start` call.
+      def config(_dsl); end
+
+      # User-provided configuration (command-line arguments, environment
+      # variables) take precedence over file-provided configuration (such as in
+      # config/puma.rb). If there are certificate files present, we want each
+      # configuration to use SSL if appropriate, so we rebind each one.
+      def start(launcher)
+        launcher.config.configure do |user_config, file_config, default_config|
+          ::SSLocal::PumaRebinder.call(user_config)
+          ::SSLocal::PumaRebinder.call(file_config)
+          ::SSLocal::PumaRebinder.call(default_config)
+        end
+      end
+    end
+  end
+end

data/lib/sslocal.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Sslocal
+end
+
+if defined?(Puma)
+  require "puma/plugin/sslocal"
+  Puma::Plugins.register("sslocal", Puma::Plugin::SSLocal)
+end
+
+require "sslocal/railtie" if defined?(Rails)

data/lib/sslocal/puma_rebinder.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "sslocal/state"
+
+module SSLocal
+  # Takes a Puma configuration/dsl object, and - if there are any non-SSL TCP
+  # bindings and if the expected certificate files exist - then change those
+  # bindings to use SSL with the certificate files.
+  #
+  # If there's an unexpected binding string, then return to the originally
+  # supplied bindings.
+  class PumaRebinder
+    UnexpectedBindFormat = Class.new(StandardError)
+
+    def self.call(dsl)
+      new(dsl).call
+    end
+
+    def initialize(dsl)
+      @dsl = dsl
+      @binds = dsl.get(:binds)
+    end
+
+    def call
+      return if binds.nil?
+      return unless state.enabled?
+
+      dsl.clear_binds!
+      rebind
+    rescue UnexpectedBindFormat => error
+      puts "SSLocal: ssl not enabled due to #{error.message}"
+      reset
+    end
+
+    private
+
+    attr_reader :dsl, :binds
+
+    def environment
+      @environment ||= dsl.get(:environment)
+    end
+
+    def host_and_port(bind)
+      matches = bind.scan(%r{\Atcp://(.*):(\d+)\z}).first
+      if matches.nil? || matches.length != 2
+        raise UnexpectedBindFormat, "unexpected bind format #{bind}"
+      end
+
+      matches.first.empty? ? ["0.0.0.0", matches.last] : matches
+    end
+
+    def rebind
+      binds.each do |bind|
+        if bind.start_with?("tcp://")
+          dsl.ssl_bind(
+            *host_and_port(bind),
+            :key => state.key_path, :cert => state.cert_path
+          )
+        else
+          dsl.bind(bind)
+        end
+      end
+    end
+
+    def reset
+      dsl.clear_binds!
+      binds.each { |bind| dsl.bind(bind) }
+    end
+
+    def state
+      @state ||= ::SSLocal::State.new(environment)
+    end
+  end
+end

data/lib/sslocal/railtie.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "sslocal/state"
+
+module SSLocal
+  class Railtie < Rails::Railtie
+    initializer "sslocal.set_up_webpacker", :before => "webpacker.proxy" do
+      state = SSLocal::State.new(Rails.env.to_s)
+      Webpacker.config.dev_server[:https] = true if state.enabled?
+    end
+
+    config.after_initialize do |app|
+      state = SSLocal::State.new(Rails.env.to_s)
+      next unless state.enabled?
+
+      policy = app.config.content_security_policy&.connect_src
+      next if policy.blank?
+
+      secure_policy = policy.collect do |item|
+        item.gsub("http://", "https://").gsub("ws://", "wss://")
+      end
+      app.config.content_security_policy.connect_src(*secure_policy)
+    end
+  end
+end

data/lib/sslocal/state.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module SSLocal
+  class State
+    attr_reader :environment
+
+    def initialize(environment)
+      @environment = environment
+    end
+
+    def cert_path
+      File.expand_path("config/certificates/#{environment}.crt")
+    end
+
+    def enabled?
+      File.exist?(key_path) && File.exist?(cert_path)
+    end
+
+    def key_path
+      File.expand_path("config/certificates/#{environment}.key")
+    end
+  end
+end

data/spec/puma/plugin/sslocal_spec.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "puma/plugin/sslocal"
+
+RSpec.describe Puma::Plugin::SSLocal do
+  it "responds to initialize without an argument" do
+    expect { described_class.new }.to_not raise_error
+  end
+
+  it "responds to initialize with an argument" do
+    expect { described_class.new double }.to_not raise_error
+  end
+
+  it "responds to config" do
+    expect { subject.config double }.to_not raise_error
+  end
+
+  describe "#start" do
+    let(:launcher) { double(:launcher, :config => configuration) }
+    let(:configuration) { double(:configuration) }
+    let(:user_config) { double }
+    let(:file_config) { double }
+    let(:default_config) { double }
+    let(:rebinder) { double(:rebinder, :call => nil) }
+
+    before :each do
+      allow(configuration).to receive(:configure).
+        and_yield(user_config, file_config, default_config)
+
+      stub_const("SSLocal::PumaRebinder", rebinder)
+    end
+
+    it "rebinds the user configuration" do
+      subject.start(launcher)
+
+      expect(rebinder).to have_received(:call).with(user_config)
+    end
+
+    it "rebinds the file configuration" do
+      subject.start(launcher)
+
+      expect(rebinder).to have_received(:call).with(file_config)
+    end
+
+    it "rebinds the default configuration" do
+      subject.start(launcher)
+
+      expect(rebinder).to have_received(:call).with(default_config)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "sslocal"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/sslocal/puma_rebinder_spec.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "sslocal/puma_rebinder"
+
+RSpec.describe SSLocal::PumaRebinder do
+  let(:dsl) do
+    double(:dsl, :clear_binds! => nil, :ssl_bind => nil, :bind => nil)
+  end
+  let(:binds) { ["tcp://0.0.0.0:3000"] }
+  let(:state) do
+    double(:state, :enabled? => true, :key_path => "my.key",
+      :cert_path => "my.crt")
+  end
+
+  subject { described_class }
+
+  before :each do
+    allow(dsl).to receive(:get).with(:binds).and_return(binds)
+    allow(dsl).to receive(:get).with(:environment).and_return("test")
+
+    allow(SSLocal::State).to receive(:new).and_return(state)
+  end
+
+  it "does nothing if there are no binds" do
+    allow(dsl).to receive(:get).with(:binds).and_return(nil)
+
+    subject.call dsl
+
+    expect(dsl).to_not have_received(:clear_binds!)
+  end
+
+  it "loads the state for the supplied environment" do
+    subject.call dsl
+
+    expect(SSLocal::State).to have_received(:new).with("test")
+  end
+
+  it "does nothing if the state is disabled" do
+    allow(state).to receive(:enabled?).and_return(false)
+
+    subject.call dsl
+
+    expect(dsl).to_not have_received(:clear_binds!)
+  end
+
+  it "replaces TCP bindings with SSL" do
+    subject.call dsl
+
+    expect(dsl).to have_received(:ssl_bind).with(
+      "0.0.0.0", "3000", :key => "my.key", :cert => "my.crt"
+    )
+  end
+
+  it "does not modify unix bindings" do
+    allow(dsl).to receive(:get).with(:binds).and_return(["unix:///path.socket"])
+
+    subject.call dsl
+
+    expect(dsl).to have_received(:bind).with("unix:///path.socket")
+  end
+
+  it "uses 0.0.0.0 if the binding does not specify a host" do
+    allow(dsl).to receive(:get).with(:binds).and_return(["tcp://:4000"])
+
+    subject.call dsl
+
+    expect(dsl).to have_received(:ssl_bind).with(
+      "0.0.0.0", "4000", :key => "my.key", :cert => "my.crt"
+    )
+  end
+
+  it "does not modify any bindings if there's an unknown TCP format" do
+    allow(dsl).to receive(:get).with(:binds).and_return(["tcp://foo"])
+
+    subject.call dsl
+
+    expect(dsl).to have_received(:bind).with("tcp://foo")
+  end
+end

data/spec/sslocal/state_spec.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "sslocal/state"
+
+RSpec.describe SSLocal::State do
+  subject { described_class.new "test" }
+
+  before :each do
+    allow(File).to receive(:exist?).and_return(false)
+  end
+
+  describe "#enabled?" do
+    it "returns true if both files exist" do
+      allow(File).to receive(:exist?).with(
+        File.expand_path("config/certificates/test.key")
+      ).and_return(true)
+
+      allow(File).to receive(:exist?).with(
+        File.expand_path("config/certificates/test.crt")
+      ).and_return(true)
+
+      expect(subject).to be_enabled
+    end
+
+    it "returns false if only the key file exists" do
+      allow(File).to receive(:exist?).with(
+        File.expand_path("config/certificates/test.key")
+      ).and_return(true)
+
+      allow(File).to receive(:exist?).with(
+        File.expand_path("config/certificates/test.crt")
+      ).and_return(false)
+
+      expect(subject).to_not be_enabled
+    end
+
+    it "returns false if only the cert file exists" do
+      allow(File).to receive(:exist?).with(
+        File.expand_path("config/certificates/test.key")
+      ).and_return(false)
+
+      allow(File).to receive(:exist?).with(
+        File.expand_path("config/certificates/test.crt")
+      ).and_return(true)
+
+      expect(subject).to_not be_enabled
+    end
+
+    it "returns false if neither file exists" do
+      allow(File).to receive(:exist?).with(
+        File.expand_path("config/certificates/test.key")
+      ).and_return(false)
+
+      allow(File).to receive(:exist?).with(
+        File.expand_path("config/certificates/test.crt")
+      ).and_return(false)
+
+      expect(subject).to_not be_enabled
+    end
+  end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: sslocal
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pat Allan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: puma
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-packaging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: 
+email:
+- pat@freelancing-gods.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/puma/plugin/sslocal.rb
+- lib/sslocal.rb
+- lib/sslocal/puma_rebinder.rb
+- lib/sslocal/railtie.rb
+- lib/sslocal/state.rb
+- spec/puma/plugin/sslocal_spec.rb
+- spec/spec_helper.rb
+- spec/sslocal/puma_rebinder_spec.rb
+- spec/sslocal/state_spec.rb
+homepage: https://github.com/pat/sslocal-rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/pat/sslocal-rb
+  source_code_uri: https://github.com/pat/sslocal-rb
+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: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Make local environment SSL as streamlined as possible.
+test_files:
+- bin/setup
+- bin/console
+- spec/spec_helper.rb
+- spec/puma/plugin/sslocal_spec.rb
+- spec/sslocal/state_spec.rb
+- spec/sslocal/puma_rebinder_spec.rb
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Rakefile