balrog 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d547df9399a56595525e88ceedc04c00d5cb8f85cee27416207936a073c7dd1a
+  data.tar.gz: '075180b9db86f64cc1f158d03e9b7207979b9cf0641af2d849f1cdc64b7117b8'
+SHA512:
+  metadata.gz: 8b2232fc4ef9d7f6f520e6b38f9d495d192258429451fe664ba526f49859f089682219b998dcc0ae5f1d3170cb3943a048a5638475d7869162f2ed63b44f3612
+  data.tar.gz: b7a2f314a0b1cd7afd0ff667c2d6799f760ac0c91be8e1f204c108a2a10ffb09df9f99aa594e161168782f03926c95ae012f02b508c1e2fe62bd88e2b8169fc3

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.DS_Store

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.0
+before_install: gem install bundler -v 2.0.1

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 dev@pixielabs.io. 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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    balrog (0.1.0)
+      bcrypt (~> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    bcrypt (3.1.12)
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  balrog!
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Pixie Labs
+
+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,84 @@
+# Balrog
+
+![Balrog logo](https://user-images.githubusercontent.com/32128719/55335192-9566a000-5492-11e9-9449-746de68fbe94.png)
+
+Balrog is a lightweight authorization library for Ruby on Rails that can
+protect your routes with a single username & password combination.
+
+Balrog is an alternative to `http_basic_authentication_with` that provides some
+advantages:
+
+* Uses a password hash instead of a plaintext password.
+* Provides a lightweight HTML form instead of inconsistent basic
+  authentication.
+* Better support for password managers (which often don't support basic
+  authentication dialog boxes).
+
+## Requirements
+
+Balrog is designed to be used with Ruby on Rails applications, and has been
+tested against Ruby on Rails 5.
+
+## Installation
+
+Add the gem to your Gemfile:
+
+```ruby
+gem 'balrog'
+```
+
+Run the installer to generate an initializer:
+
+```
+$ bundle exec rails generate balrog:install
+Enter New Password:
+Confirm New Password:
+      create  config/initializers/balrog.rb
+$
+```
+
+## Regenerating a password hash
+
+If you need to create a new password, modify the hash in the Balrog initializer.
+You can generate a new hash with the provided Rake task:
+
+```
+$ bundle exec rails balrog:generate_hash
+New password: *******
+Type again: *******
+
+$2a$04$8U/Yun3MZ5..FuT9yUJNK.F2uUuHagtvsD.CNc5lSZegzq9eJjwqu
+
+Copy this hash into config/initializers/balrog.rb
+```
+
+## Restricting access in a controller
+
+```ruby
+class AdminController < ApplicationController
+  before_action :authenticate_with_balrog!
+end
+```
+
+## Contributing
+
+Before contributing, please read the [code of conduct](CODE_OF_CONDUCT.md).
+- Check out the latest master to make sure the feature hasn't been implemented
+  or the bug hasn't been fixed yet.
+- Check out the issue tracker to make sure someone already hasn't requested it
+  and/or contributed it.
+- Fork the project.
+- Start a feature/bugfix branch.
+- Commit and push until you are happy with your contribution.
+- Please try not to mess with the package.json, version, or history. If you
+  want to have your own version, or is otherwise necessary, that is fine, but
+  please isolate to its own commit so we can cherry-pick around it.
+
+
+## TODO
+
+ * Restricting access via `routes.rb`
+ * Logout
+ * Test coverage
+ * Check it's OK with Ruby on Rails 6
+ * Expire sessions

data/Rakefile

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

data/app/assets/stylesheets/balrog/gate.css

@@ -0,0 +1,57 @@
+section {
+  text-align: center;
+  position: fixed;
+  top: 40%;
+  left: 50%;
+  transform: translate(-50%, -50%);
+  padding: 5%;
+  background-color: white;
+  box-shadow: 0px 0px 20px darkslategrey;
+}
+
+body {
+  background-color: slategray;
+  font-family: 'Helvetica Neue', 'Helvetica', Calibri, 'Trebuchet MS', sans-serif;
+}
+
+footer {
+  display: flex;
+  position: fixed;
+  right: 0;
+  bottom: 0;
+}
+
+.logo {
+  max-width: 100px;
+  padding: 20px;
+  align-self: center;
+}
+
+button {
+  -webkit-appearance: button;
+  overflow: visible;
+  text-transform: none;
+  -webkit-transition-duration: 0.4s;
+  transition-duration: 0.4s;
+  transition-property: background-color;
+  background-color: rgb(241, 81, 81);
+  color: white;
+  font-size: 20px;
+  font-family: 'Helvetica Neue', 'Helvetica', Calibri, 'Trebuchet MS', sans-serif;
+  cursor: pointer;
+  padding: 8px 10px;
+  border: 0;
+  font-weight: 100;
+  letter-spacing: 1px;
+}
+
+button:hover {
+  background-color: rgb(201, 41, 41);
+}
+
+input {
+  font-size: 20px;
+  padding: 5px 10px;
+  font-family: 'Helvetica Neue', 'Helvetica', Calibri, 'Trebuchet MS', sans-serif;
+}
+

data/app/views/balrog/gate.html.erb

@@ -0,0 +1,26 @@
+<!doctype html>
+<html lang=en>
+<head>
+  <meta charset=utf-8>
+  <title>Login</title>
+  <%= stylesheet_link_tag "balrog/gate" %>
+</head>
+
+<body>
+
+  <section>
+    <form action='/balrog/signin' method='POST'>
+      <input autofocus type='password' name='password' placeholder='Password'>
+      <button type='submit'>Login</button>
+    </form>
+  </section>
+
+  <footer>
+    <a href="https://github.com/pixielabs/balrog" target="_blank">
+      <%= image_tag "balrog/logo.png", class: 'logo' %>
+    </a>
+  </footer>
+
+</body>
+
+</html>

data/balrog.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "balrog/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "balrog"
+  spec.version       = Balrog::VERSION
+  spec.authors       = ["Pixie Labs"]
+  spec.email         = ["dev@pixielabs.io"]
+
+  spec.summary       = %q{An alternative to HTTP basic auth}
+  spec.description   = %q{Balrog is a lightweight authorization library for Ruby on Rails that can protect your routes with a single password.}
+  spec.homepage      = "https://github.com/pixielabs/balrog"
+  spec.license       = "MIT"
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_dependency "bcrypt", "~> 3.0"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "balrog"
+
+# 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/balrog.rb

@@ -0,0 +1,7 @@
+require_relative "balrog/version"
+module Balrog 
+  require_relative 'balrog/middleware'
+  require_relative 'balrog/engine'
+  require_relative 'balrog/rake_tasks'
+  require_relative 'balrog/generators'
+end 

data/lib/balrog/engine.rb

@@ -0,0 +1,18 @@
+require_relative 'helpers'
+
+class Balrog::Engine < Rails::Engine
+  # Make the Balrog helpers available in any controller.
+  initializer "balrog.configure_rails_initialization" do 
+    ActiveSupport.on_load(:action_controller) do
+      include Balrog::Helpers
+    end
+  end
+
+  # Precompile the Balrog assets
+  initializer "balrog.assets.precompile" do |app|
+    app.config.assets.precompile += %w( 
+      balrog/gate.css
+      balrog/logo.png
+    )
+  end
+end

data/lib/balrog/generators.rb

@@ -0,0 +1,6 @@
+# This Railtie makes the Balrog Generators available from the command line.
+class Balrog::Generators < Rails::Railtie
+  generators do
+    require File.join(File.dirname(__FILE__), 'generators', 'install_generator')
+  end
+end

data/lib/balrog/generators/install_generator.rb

@@ -0,0 +1,15 @@
+require_relative '../password_hasher'
+
+class Balrog::InstallGenerator < Rails::Generators::Base
+
+  desc "Creates a balrog initializer and configures it with the provided password (you'll be prompted for it)."
+  def create_initializer_file
+    password_hash = PasswordHasher.encrypt_password
+    contents = <<~EOF
+      Rails.application.config.middleware.use Balrog::Middleware do
+        password_hash '#{password_hash}'
+      end
+    EOF
+    create_file "config/initializers/balrog.rb", contents
+  end
+end

data/lib/balrog/helpers.rb

@@ -0,0 +1,8 @@
+# Helpers methods are made available in all controllers by the code in engine.rb.
+module Balrog::Helpers
+  def authenticate_with_balrog!
+    unless session[:balrog] == 'authenticated'
+      render 'balrog/gate', layout: nil
+    end
+  end
+end

data/lib/balrog/middleware.rb

@@ -0,0 +1,66 @@
+require 'bcrypt'
+
+# Public: Balrog middleware that handles form submissions, checking the
+# password against the configured hash, and setting a session variable if
+# they match.
+#
+# This is typically set up in an initialize when you run
+# `rails g balrog:install`, and looks a bit like this:
+#
+#    Rails.application.config.middleware.use Balrog::Middleware do
+#      password_hash '<bcrypt hash>'
+#    end
+class Balrog::Middleware
+  def initialize(app, &block)
+    @app = app
+    instance_eval(&block) if block_given?
+  end
+
+  def call(env)
+    path = env["PATH_INFO"]
+    method = env["REQUEST_METHOD"]
+    if method == 'POST' && path == '/balrog/signin'
+      handle_login(env)
+    else
+      @app.call(env)
+    end
+  end
+
+  private
+
+  def password_hash(input)
+    @password_hash = BCrypt::Password.new(input)
+  end
+
+  def handle_login(env)
+    if env['rack.request.form_hash']
+      submitted_password = env['rack.request.form_hash']['password']
+    end
+
+    unless submitted_password
+      return [302, {"Location" => referer}, [""]]
+    end
+
+    unless @password_hash
+      warn <<~EOF
+
+        !! Balrog has not been configured with a password_hash. You shall not
+        !! pass! When adding Balrog::Middleware to your middleware stack, pass
+        !! in a block and call `password_hash` passing in a bcrypt hash.
+        !!
+        !! Check out https://github.com/pixielabs/balrog for more information.
+
+      EOF
+    end
+
+    if @password_hash == submitted_password
+      env['rack.session'][:balrog] = 'authenticated'
+    end
+
+    referer = env["HTTP_REFERER"] || '/'
+
+    [302, {"Location" => referer}, [""]]
+  end
+
+end
+

data/lib/balrog/password_hasher.rb

@@ -0,0 +1,18 @@
+require 'bcrypt'
+require 'io/console'
+
+class PasswordHasher
+  def self.encrypt_password
+    print "Enter New Password: "
+    password = STDIN.noecho(&:gets).chomp
+    print "\nConfirm New Password: "
+    if password == STDIN.noecho(&:gets).chomp then
+      password_hash = BCrypt::Password.create(password)
+      puts "\n"
+      password_hash 
+    else 
+      puts "\n"
+      warn 'Passwords did not match :('
+    end
+  end
+end

data/lib/balrog/rake_tasks.rb

@@ -0,0 +1,6 @@
+# This Railtie makes the Balrog Rake tasks available from the command line.
+class Balrog::RakeTasks < Rails::Railtie
+  rake_tasks do
+    load File.join(File.dirname(__FILE__), 'tasks', 'generate_hash.rake')
+  end
+end

data/lib/balrog/tasks/generate_hash.rake

@@ -0,0 +1,6 @@
+require_relative '../password_hasher'
+
+desc 'Prompts for a password, and returns a bcrypt hash that can be passed to password_hash when configuring Balrog'
+task "balrog:generate_hash" do
+  puts PasswordHasher.encrypt_password
+end

data/lib/balrog/version.rb

@@ -0,0 +1,3 @@
+module Balrog
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: balrog
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pixie Labs
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bcrypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !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: Balrog is a lightweight authorization library for Ruby on Rails that
+  can protect your routes with a single password.
+email:
+- dev@pixielabs.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/assets/images/balrog/logo.png
+- app/assets/stylesheets/balrog/gate.css
+- app/views/balrog/gate.html.erb
+- balrog.gemspec
+- bin/console
+- bin/setup
+- lib/balrog.rb
+- lib/balrog/engine.rb
+- lib/balrog/generators.rb
+- lib/balrog/generators/install_generator.rb
+- lib/balrog/helpers.rb
+- lib/balrog/middleware.rb
+- lib/balrog/password_hasher.rb
+- lib/balrog/rake_tasks.rb
+- lib/balrog/tasks/generate_hash.rake
+- lib/balrog/version.rb
+homepage: https://github.com/pixielabs/balrog
+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: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: An alternative to HTTP basic auth
+test_files: []