rails-auth 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 416538aebe66718c2b5a949e4db31b369b5ae612
-  data.tar.gz: b9ac8394d1cbd92dd7cfb82f5ca69f364c7d416b
+  metadata.gz: a492a2d3e2769b62746079b9c9d0d56fa13d9c56
+  data.tar.gz: 6eda7789839d1bb66b642b3c6af8f3ad213f98d9
 SHA512:
-  metadata.gz: 8607664e74138a4ddb645b5ee3a8b23930428e6da4d66570e58ce03cbd333d18c0a49d1522f2386a72ff116c3a815fbc57cf5173c74a81f39d30bf4849984198
-  data.tar.gz: 120db040a14f4f9110c952de51a4c894cb50e2fc94f644f8d86656f94995fd9c910953918ec5ae68ffc50ac1f653e70e042969b807d9d8d661e66cf745a60617
+  metadata.gz: ad6c4c9707ff5067b0e16f2e78f5afd66602b954a828e1a346128c318c5eeff4fdc2da755e3144a5b92c29f4063aff9c1e2645dad1bd420bb34edb08442ffe88
+  data.tar.gz: fe5328588172103e3ef15343dfef43b83261db496830375394a5d0151af5f939e39ce5514db5b0e474ff8cdc861a6ab8ef9137d628655f2034ede34d5bf987bf

data/.rspec

@@ -1,2 +1,4 @@
 --format documentation
 --color
+--order random
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  DisplayCopNames: true
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Metrics/ParameterLists:
+  Max: 5
+  CountKeywordArgs: false
+
+Metrics/LineLength:
+  Max: 128
+
+Metrics/MethodLength:
+  Max: 25
+
+Metrics/AbcSize:
+  Max: 20

data/.travis.yml

@@ -1,4 +1,12 @@
 language: ruby
+sudo: false
+
 rvm:
+  - 2.0.0
+  - 2.1.8
+  - 2.2.4
   - 2.3.0
-before_install: gem install bundler -v 1.11.2
+  - jruby-9.0.4.0
+
+matrix:
+  fast_finish: true

data/CONDUCT.md

@@ -0,0 +1,5 @@
+# Code of Conduct
+
+This project follows the Square Open Source Code of Conduct:
+
+https://corner.squareup.com/codeofconduct.html

data/CONTRIBUTING.md

@@ -0,0 +1,14 @@
+### Sign the CLA
+
+Any contributors to the master *rails-auth* repository must sign the
+[Individual Contributor License Agreement (CLA)]. It's a short form that covers
+our bases and makes sure you're eligible to contribute.
+
+### Submitting a Pull Request
+
+When you have a change you'd like to see in the master repository, send a
+[pull request]. Before we merge your request, we'll make sure you're in the list
+of people who have signed a CLA.
+
+[Individual Contributor License Agreement (CLA)]: https://spreadsheets.google.com/spreadsheet/viewform?formkey=dDViT2xzUHAwRkI3X3k5Z0lQM091OGc6MQ&ndplr=1
+[pull request]: https://github.com/square/rails-auth/pulls

data/Gemfile

@@ -1,4 +1,13 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
+
+group :development do
+  gem "guard-rspec"
+end
+
+group :test do
+  gem "rspec"
+  gem "rubocop", "0.36.0"
+  gem "certificate_authority", require: false
+end
 
-# Specify your gem's dependencies in rails-auth.gemspec
 gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})    { |m| "spec/#{m[1]}_spec.rb" }
+  watch("spec/spec_helper.rb") { "spec" }
+end

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -1,8 +1,19 @@
 # Rails::Auth
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rails/auth`. To experiment with that code, run `bin/console` for an interactive prompt.
+Modular resource-based authentication and authorization for Rails/Rack
 
-TODO: Delete this and the text above, and describe your gem
+## Description
+
+Rails::Auth is a flexible library designed for both authentication (AuthN) and
+authorization (AuthZ) using Rack Middleware. It splits the AuthN and AuthZ
+steps into separate middleware classes, using AuthN middleware to first verify
+request client identities, or "principals", then authorizing the request
+via separate AuthZ middleware that consumes these principals, e.g. access
+control lists (ACLs).
+
+Rails::Auth can be used to authenticate and authorize end users using browser
+cookies, service-to-service requests using X.509 client certificates, or any
+other clients with credentials that have proper authenticating middleware.
 
 ## Installation
 
@@ -22,15 +33,264 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To use Rails::Auth you will need to configure the relevant AuthN and AuthZ
+middleware for your app.
+
+Rails::Auth ships with the following middleware:
+
+* **AuthN**: `Rails::Auth::X509::Middleware`: support for authenticating
+  principals by their SSL/TLS client certificates.
+* **AuthZ**: `Rails::Auth::ACL::Middleware`: support for authorizing requests
+  using Access Control Lists (ACLs).
+
+Documentation of these middleware and how to use them is provided below.
+
+### Access Control Lists (ACLs)
+
+ACLs are the main tool Rails::Auth provides for AuthZ. ACLs use a set of
+route-by-route matchers to control access to particular resources.
+Unlike some Rails AuthZ frameworks, this gem grants/denies access to
+controller actions, rather than helping you provide different content to
+different roles or varying the parameters allowed in, say, an update action.
+
+Rails::Auth encourages the use of YAML files for storing ACL definitions,
+although the use of YAML is not mandatory and the corresponding object
+structure output from `YAML.load` can be passed in instead. The following is
+an example of an ACL definition in YAML:
+
+```yaml
+---
+- resources:
+  - method: ALL
+    path: /foo/bar/.*
+  allow_x509_subject:
+    ou: ponycopter
+  allow_claims:
+    groups: ["example"]
+- resources:
+  - method: ALL
+    path: /_admin/?.*
+  allow_claims:
+    groups: ["admins"]
+- resources:
+  - method: GET
+    path: /internal/frobnobs/.*
+  allow_x509_subject:
+    ou: frobnobber
+- resources:
+  - method: GET
+    path: /
+  allow_all: true
+```
+
+An ACL consists of a list of guard expressions, each of which contains a list
+of resources and a set of predicates which can authorize access to those
+resources. *Any* matching predicate will authorize access to any of the
+resources listed for a given expression.
+
+Resources are defined by the following constraints:
+
+* **method**: The requested HTTP method, or `"ALL"` to allow any method
+* **path**: A regular expression to match the path. `\A` and `\z` are added by
+  default to the beginning and end of the regex to ensure the entire path and
+  not a substring is matched.
+
+Once you've defined an ACL, you'll need to create a corresponding ACL object
+in Ruby and a middleware to authorize requests using that ACL. Add the
+following code anywhere you can modify the middleware chain (e.g. config.ru):
+
+```ruby
+app = MyRackApp.new
+
+acl = Rails::Auth::ACL.from_yaml(
+  File.read("/path/to/my/acl.yaml"),
+  matchers: { allow_claims: MyClaimsPredicate }
+)
+
+acl_auth = Rails::Auth::ACL::Middleware.new(app, acl: acl)
+
+run acl_auth
+```
+
+You'll need to pass in a hash of predicate matchers that correspond to the
+keys in the ACL. See the "X.509 Client Certificates" section below for how
+to configure the middleware for `allow_x509_subject`.
+
+The following predicate matchers are built-in and always available:
+
+* **allow_all**: (options: `true` or `false`) always allow requests to the
+  given resources (so long as `true` is passed as the option)
+
+Custom predicate matchers can be any Ruby class that responds to the `#match`
+method. The full Rack environment is passed to `#match`. The corresponding
+object from the ACL definition is passed to the class's `#initialize` method.
+Here is an example of a simple custom predicate matcher:
+
+```ruby
+class MyClaimsPredicate
+  def initialize(options)
+    @options = options
+  end
+
+  def match(env)
+    claims = Rails::Auth.principals(env)["claims"]
+    return false unless principal
+
+    @options["groups"].any? { |group| claims["groups"].include?(group) }
+  end
+end
+
+```
+
+### X.509 Client Certificates
+
+Add an `Rails::Auth::X509::Middleware` object to your Rack middleware chain to
+verify X.509 client certificates (in e.g. config.ru):
+
+```ruby
+app = MyRackApp.new
+
+acl = Rails::Auth::ACL.from_yaml(
+  File.read("/path/to/my/acl.yaml")
+  matchers: { allow_x509_subject: Rails::Auth::X509::Matcher }
+)
+
+acl_auth = Rails::Auth::ACL::Middleware.new(app, acl: acl)
+
+x509_auth = Rails::Auth::X509::Middleware.new(
+  acl_auth,
+  ca_file: "/path/to/my/cabundle.pem"
+  cert_filters: { 'X-SSL-Client-Cert' => :pem },
+  require_cert: true
+)
 
-## Development
+run x509_auth
+```
+
+The constructor takes the following parameters:
+
+* **app**: the next Rack middleware in the chain. You'll likely want to use
+  an `Rails::Auth::ACL::Middleware` instance as the next middleware in the chain.
+* **ca_file**: Path to the certificate authority (CA) bundle with which to
+  authenticate clients. This will typically be the certificates for the
+  internal CA(s) you use to issue X.509 certificates to internal services, as
+  opposed to commercial CAs typically used by browsers. Client certificates
+  will be ignored unless they can be verified by one of the CAs in this bundle.
+* **cert_filters**: A `Hash` which configures how client certificates are
+  extracted from the Rack environment. You will need to configure your web
+  server to include the certificate in the Rack environment. See notes below
+  for more details.
+* **require_cert**: (default `false`) require a valid client cert in order for
+  the request to complete. This disallows access to your app from any clients
+  who do not have a valid client certificate. When enabled, the middleware
+  will raise the `Rails::Auth::X509::CertificateVerifyFailed` exception.
+
+When creating `Rails::Auth::ACL::Middleware`, make sure to pass in
+`matchers: { allow_x509_subject: Rails::Auth::X509::Matcher }` in order to use
+this predicate in your ACLs. This predicate matcher is not enabled by default.
+
+For client certs to work, you will need to configure your web server to include
+them in your Rack environment, and also configure `cert_filters` correctly to
+filter and process them from the Rack environment.
+
+For example, if you're using nginx + Passenger, you'll need to add something
+like the following to your nginx configuration:
+
+```
+passenger_set_cgi_param X-SSL-Client-Cert $ssl_client_raw_cert;
+```
+
+Once the client certificate is in the Rack environment in some form, you'll
+need to configure a filter object which can convert it from its Rack
+environment form into an `OpenSSL::X509::Certificate` instance. There are
+two built in filters you can reference as symbols to do this:
+
+* `:pem`: parses certificates from the Privacy Enhanced Mail format
+* `:java`:  converts `sun.security.x509.X509CertImpl` object instances
+
+The `cert_filters` parameter is a mapping of Rack environment names to
+corresponding filters:
+
+```ruby
+cert_filters: { 'X-SSL-Client-Cert' => :pem }
+```
+
+In addition to these symbols, a filter can be any object that responds to the
+`#call` method, such as a `Proc`. The following filter will parse PEM
+certificates:
+
+```ruby
+cert_filters: { 'X-SSL-Client-Cert' => proc { |pem| OpenSSL::X509::Certificate.new(pem) } }
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+When certificates are recognized and verified, an `Rails::Auth::X509::Principal`
+object will be added to the Rack environment under `env["rails-auth.principals"]["x509"]`.
+This middleware will never add any certificate to the environment's principals
+that hasn't been verified against the configured CA bundle.
 
-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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+## RSpec integration
+
+Rails::Auth includes built-in matchers that allow you to write tests for your
+ACLs to ensure they have the behavior you expect.
+
+To enable RSpec support, require the following:
+
+```ruby
+require "rails/auth/rspec"
+```
+
+Below is an example of how to write an ACL spec:
+
+```ruby
+RSpec.describe "example_acl.yml", acl_spec: true do
+  let(:example_principals) { x509_principal_hash(ou: "ponycopter") }
+
+  subject do
+    Rails::Auth::ACL.from_yaml(
+      File.read("/path/to/example_acl.yml"),
+      matchers: { allow_x509_subject: Rails::Auth::X509::Matcher }
+    )
+  end
+
+  describe "/path/to/resource" do
+    it { is_expected.to     permit get_request(principals: example_principals) }
+    it { is_expected.not_to permit get_request) }
+  end
+end
+```
+
+The following helper methods are available:
+
+* `x509_principal`, `x509_principal_hash`: create instance doubles of Rails::Auth::X509::Principals
+* Request builders: The following methods build requests from the described path:
+  * `get_request`
+  * `head_request`
+  * `put_request`
+  * `post_request`
+  * `delete_request`
+  * `options_request`
+  * `path_request`
+  * `link_request`
+  * `unlink_request`
+
+The following matchers are available:
+
+* `allow_request`: allows a request with the given Rack environment, and optional principals
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rails-auth.
+Any contributors to the master *rails-auth* repository must sign the
+[Individual Contributor License Agreement (CLA)]. It's a short form that covers
+our bases and makes sure you're eligible to contribute.
+
+When you have a change you'd like to see in the master repository, send a
+[pull request]. Before we merge your request, we'll make sure you're in the list
+of people who have signed a CLA.
+
+[Individual Contributor License Agreement (CLA)]: https://spreadsheets.google.com/spreadsheet/viewform?formkey=dDViT2xzUHAwRkI3X3k5Z0lQM091OGc6MQ&ndplr=1
+[pull request]: https://github.com/square/rails-auth/pulls
+
+## License
 
+Copyright (c) 2016 Square Inc. Distributed under the Apache 2.0 License.
+See LICENSE file for further details.