demopass 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ec269ae22d7a0e5138aeba6ee954fde6f51ead3c02e1cfe23070bbdec59343cb
+  data.tar.gz: 1fde34f15bb1eed9c1ae52cbd1d3cf4cd38ffc4f87133887b8a095b3204ae475
+SHA512:
+  metadata.gz: d66409aec60d5d756f1668842c65992e2493aa1611e91123214a31298441c4e54e7d1de79724d23714fe74610003ff24f699164f0c7a86ff7b685a1a54ac690d
+  data.tar.gz: 246085789cdb4fef2fb545cac6d897c1755b2d1b6e7f27d6c9056979d62c9c6d5f7da4b44727a5d91181b571e1efaceec3e727b39ba175636e632791419dfc90

data/.circleci/config.yml

@@ -0,0 +1,13 @@
+version: 2.1
+jobs:
+  build:
+    docker:
+      - image: ruby:2.7.2
+    steps:
+      - checkout
+      - run:
+          name: Run the default task
+          command: |
+            gem install bundler -v 2.2.11
+            bundle install
+            bundle exec rake

data/.gitignore

@@ -0,0 +1,2 @@
+/tmp/
+*.gem

data/.rubocop.yml

@@ -0,0 +1,109 @@
+AllCops:
+  TargetRubyVersion: 2.7
+<% unless ENV["CI"] %>
+  Exclude:
+  <% `git status --ignored --porcelain`.scan(/^!!\s+(.*)$/).each do |match| %>
+    - <%= match[0] %>**/*
+  <% end %>
+<% end %>
+
+# Extensions
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+# New rules
+Lint/DuplicateBranch: # (new in 1.3)
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement: # (new in 1.1)
+  Enabled: true
+Lint/EmptyBlock: # (new in 1.1)
+  Enabled: true
+Lint/EmptyClass: # (new in 1.3)
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks: # (new in 1.2)
+  Enabled: true
+Lint/ToEnumArguments: # (new in 1.1)
+  Enabled: true
+Lint/UnexpectedBlockArity: # (new in 1.5)
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator: # (new in 1.1)
+  Enabled: true
+Style/ArgumentsForwarding: # (new in 1.1)
+  Enabled: true
+Style/CollectionCompact: # (new in 1.2)
+  Enabled: true
+Style/DocumentDynamicEvalDefinition: # (new in 1.1)
+  Enabled: true
+Style/NegatedIfElseCondition: # (new in 1.2)
+  Enabled: true
+Style/NilLambda: # (new in 1.3)
+  Enabled: true
+Style/RedundantArgument: # (new in 1.4)
+  Enabled: true
+Style/SwapValues: # (new in 1.1)
+  Enabled: true
+Gemspec/DateAssignment: # (new in 1.10)
+  Enabled: true
+Layout/SpaceBeforeBrackets: # (new in 1.7)
+  Enabled: true
+Lint/AmbiguousAssignment: # (new in 1.7)
+  Enabled: true
+Lint/DeprecatedConstants: # (new in 1.8)
+  Enabled: true
+Lint/LambdaWithoutLiteralBlock: # (new in 1.8)
+  Enabled: true
+Lint/NumberedParameterAssignment: # (new in 1.9)
+  Enabled: true
+Lint/OrAssignmentToConstant: # (new in 1.9)
+  Enabled: true
+Lint/RedundantDirGlobSort: # (new in 1.8)
+  Enabled: true
+Lint/SymbolConversion: # (new in 1.9)
+  Enabled: true
+Lint/TripleQuotes: # (new in 1.9)
+  Enabled: true
+Style/EndlessMethod: # (new in 1.8)
+  Enabled: true
+Style/HashConversion: # (new in 1.10)
+  Enabled: true
+Style/HashExcept: # (new in 1.7)
+  Enabled: true
+Style/IfWithBooleanLiteralBranches: # (new in 1.9)
+  Enabled: true
+
+# Alterations
+Naming/RescuedExceptionsVariableName:
+  Enabled: false
+Style/BlockComments:
+  Exclude:
+    - spec/**/*
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+Style/Documentation:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Layout/AccessModifierIndentation:
+  EnforcedStyle: outdent
+RSpec/NestedGroups:
+  Enabled: false
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+RSpec/MultipleExpectations:
+  Enabled: false
+RSpec/ExampleLength:
+  Enabled: false
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+Layout/ArgumentAlignment:
+  Enabled: false
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: consistent_comma
+Layout/MultilineMethodCallBraceLayout:
+  EnforcedStyle: new_line

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-02-18
+
+- Initial release

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in demopass.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    demopass (0.1.0)
+      rack
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    climate_control (0.2.0)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    method_source (1.0.0)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    pry (0.14.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rack (2.2.3)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.0.3)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.10.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.2.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  climate_control
+  demopass!
+  pry
+  rake (~> 13.0)
+  rspec (~> 3.10)
+  rubocop (~> 1.6)
+  rubocop-rake (~> 0.5)
+  rubocop-rspec (~> 2.0)
+
+BUNDLED WITH
+   2.2.11

data/README.md

@@ -0,0 +1,31 @@
+# Demopass
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'demopass'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install demopass
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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 the created tag, 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/SmartCasual/demopass.

data/Rakefile

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+begin
+  require "rspec/core/rake_task"
+  require "rubocop/rake_task"
+  RSpec::Core::RakeTask.new(:spec)
+  RuboCop::RakeTask.new
+rescue LoadError => exception
+  puts "Library not available: #{exception.message}"
+end
+
+desc "Build, lint, and test"
+task :build_and_test do
+  Rake::Task["lint"].invoke
+  Rake::Task["test"].invoke
+  Rake::Task["build"].invoke unless ENV["CI"]
+end
+
+desc "Lint"
+task lint: :rubocop
+
+desc "Test"
+task test: :spec
+
+desc "Build"
+task :build do
+  system("gem build demopass.gemspec")
+end
+
+task default: :build_and_test

data/bin/console

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/demopass/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "demopass"
+  spec.version       = Demopass::VERSION
+  spec.authors       = ["Elliot Crosby-McCullough"]
+  spec.email         = ["elliot.cm@gmail.com"]
+
+  spec.summary       = "Add simple password protection for demo Rack apps."
+  spec.homepage      = "https://github.com/SmartCasual/demopass"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/SmartCasual/demopass"
+  spec.metadata["changelog_uri"] = "https://github.com/SmartCasual/demopass/blob/master/CHANGELOG.md"
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{\Abin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rack"
+
+  spec.add_development_dependency "climate_control"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.10"
+  spec.add_development_dependency "rubocop", "~> 1.6"
+  spec.add_development_dependency "rubocop-rake", "~> 0.5"
+  spec.add_development_dependency "rubocop-rspec", "~> 2.0"
+end

data/lib/demopass.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "demopass/version"
+require_relative "demopass/app"
+
+module Demopass # rubocop:disable Style/ClassAndModuleChildren
+  class Error < StandardError; end
+end

data/lib/demopass/app.rb

@@ -0,0 +1,77 @@
+require "openssl"
+
+class Demopass::App
+  PASSWORD_PATH = "/demopass".freeze
+  PASSWORD_KEY = "password".freeze
+  TOKEN_KEY = "demopass_token".freeze
+
+  def initialize(downstream)
+    @downstream = downstream
+    @response = Rack::Response.new
+
+    @hmac_key = ENV["DEMOPASS_SECRET"]
+    @password = ENV["DEMOPASS_PASSWORD"]
+
+    raise Demopass::Error, "Please configure DEMOPASS_SECRET and DEMOPASS_PASSWORD" unless @hmac_key && @password
+
+    @digest = OpenSSL::Digest.new("SHA256")
+    @valid_hmac = hmac_for(@password)
+  end
+
+  def call(env)
+    request = Rack::Request.new(env)
+    return @downstream.call(env) if token_valid?(request)
+
+    if (password = extract_password(request))
+      assign_token_and_redirect(password)
+    else
+      respond_with_form
+    end
+
+    @response.finish
+  end
+
+private
+
+  def token_valid?(request)
+    request.cookies[TOKEN_KEY] == @valid_hmac
+  end
+
+  def extract_password(request)
+    return unless request.post? && request.path == PASSWORD_PATH
+
+    request.POST[PASSWORD_KEY]
+  end
+
+  def assign_token_and_redirect(password)
+    @response.set_cookie(TOKEN_KEY, hmac_for(password))
+    @response.redirect("/")
+  end
+
+  def hmac_for(password)
+    OpenSSL::HMAC.new(@hmac_key, @digest)
+      .update(password)
+      .hexdigest
+  end
+
+  FORM = <<~HTML.freeze
+    <!DOCTYPE html>
+    <html lang="en" dir="ltr">
+      <head>
+        <meta charset="utf-8">
+        <title>Demopass authentication</title>
+      </head>
+      <body>
+        <h1>Please enter the demo password</h1>
+        <form action="/demopass" method="post">
+          <input type="password" name="#{PASSWORD_KEY}" />
+          <button>Submit</button>
+        </form>
+      </body>
+    </html>
+  HTML
+
+  def respond_with_form
+    @response.write(FORM)
+  end
+end

data/lib/demopass/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Demopass
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: demopass
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Elliot Crosby-McCullough
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  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: climate_control
+  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: pry
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  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-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description:
+email:
+- elliot.cm@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- demopass.gemspec
+- lib/demopass.rb
+- lib/demopass/app.rb
+- lib/demopass/version.rb
+homepage: https://github.com/SmartCasual/demopass
+licenses: []
+metadata:
+  homepage_uri: https://github.com/SmartCasual/demopass
+  source_code_uri: https://github.com/SmartCasual/demopass
+  changelog_uri: https://github.com/SmartCasual/demopass/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.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: Add simple password protection for demo Rack apps.
+test_files: []