rapid-rack 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 831e03b9b52922e691d108fb9024efba4023466d
+  data.tar.gz: 2414708416a8601ea94973d7621a4bb9b6ecee9f
+SHA512:
+  metadata.gz: d6c8d860e14a7d95c5b7492608ec2c9ce79d8ec529887788a3ee91a61ef33fdb8a0703cb1d1cdf4b7fb8b620385feab85d61a97dd9387cfe5510913e2c3f9965
+  data.tar.gz: 063184cd00302abfb4a13309c63203edc90e37832b157c5e9215ef52b3dbb600a99726014662c11d8c85d6800020864f4809db2622a96970653758ebfaaed29b

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+spec/dummy/log

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,6 @@
+Documentation:
+  Enabled: false
+
+Style/FileName:
+  Exclude:
+    - lib/rapid-rack.rb

data/.simplecov

@@ -0,0 +1,3 @@
+SimpleCov.start do
+  add_filter 'spec'
+end

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,16 @@
+guard :bundler do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(/^spec\/.+_spec\.rb$/)
+  watch(/^lib\/(.+)\.rb$/) { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^spec/(dummy|support)/.+\.rb}) { 'spec' }
+  watch('spec/spec_helper.rb') { 'spec' }
+end
+
+guard :rubocop do
+  watch(/.+\.rb$/)
+  watch(/(?:.+\/)?\.rubocop\.yml$/) { |m| File.dirname(m[0]) }
+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

@@ -0,0 +1,165 @@
+# RapidRack
+
+[AAF Rapid Connect](https://rapid.aaf.edu.au) authentication plugin for
+Rack-based web applications. Contains Rails-specific extensions for consumption
+by Rails applications.
+
+Author: Shaun Mangelsdorf
+
+```
+Copyright 2014, Australian Access Federation
+
+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.
+```
+
+## Installation
+
+Add the `rapid-rack` dependency to your application's `Gemfile`:
+
+```
+gem 'rapid-rack'
+```
+
+Use Bundler to install the dependency:
+
+```
+bundle install
+```
+
+Create a Receiver class, which will receive the validated claim from Rapid
+Connect and establish a session for the authenticated subject.
+
+```ruby
+module MyApplication
+  class MyReceiver
+    # Helper mixin which provides default behaviour for the Receiver class
+    include RapidRack::DefaultReceiver
+
+    # Default implementation of Redis-backed replay detection
+    include RapidRack::RedisRegistry
+
+    # Receives the contents of the 'https://aaf.edu.au/attributes' claim from
+    # Rapid Connect, and returns a set of attributes appropriate for passing in
+    # to the `subject` method.
+    def map_attributes(attrs)
+      {
+        targeted_id: attrs['edupersontargetedid'],
+        name: attrs['displayname'],
+        email: attrs['mail']
+      }
+    end
+
+    # Receives a set of attributes returned by `map_attributes`, and is
+    # responsible for either creating a new user record, or updating an existing
+    # user record to ensure attributes are current.
+    #
+    # Must return the subject, and the subject must have an `id` method to work
+    # with the DefaultReceiver mixin.
+    def subject(attrs)
+      identifier = attrs.slice(:targeted_id)
+      MyOwnUserClass.find_or_initialize_by(identifier).tap do |subject|
+        subject.update_attributes!(attrs)
+      end
+    end
+  end
+end
+```
+
+### Integrating with a Rack application
+
+Map the `RapidRack::Authenticator` app to a path in your application:
+
+```ruby
+Rack::Builder.new do
+  use Rack::Lint
+
+  map '/auth' do
+    opts = { ... }
+    run RapidRack::Authenticator.new(opts)
+  end
+
+  run MyApplication
+end
+```
+
+`opts` must be the same arguments derived from the Rails configuration below,
+that is:
+
+* `url` — The URL provided during registration with Rapid Connect
+* `secret` — Your extremely secure secret
+* `issuer` — The `iss` claim to expect. This is the identifier of the
+  Rapid Connect server you're authenticating against
+* `audience` — The `aus` claim to expect. This is your own service's
+  identifier
+* `receiver` — **String** representing the fully qualified class name of
+  your receiver class
+* `error_handler` *(optional)* — **String** representing the fully
+  qualified class name of your error handler class
+
+In the `opts` hash, all keys must be symbols.
+
+### Integrating with a Rails application
+
+Add a `config/rapidconnect.yml` file to your application, with the
+deployment-specific options described above:
+
+```yaml
+---
+url: https://rapid.example.com/url/provided/by/registration
+secret: very_secure_secret_you_generated_yourself
+issuer: https://rapid.example.com
+audience: https://yourapp.example.org
+```
+
+Configure the receiver, and optional error handler in `config/application.rb`:
+
+```ruby
+module MyApplication
+  class Application < Rails::Application
+    # ...
+
+    config.rapid_rack.receiver = 'MyApplication::MyReceiver'
+    config.rapid_rack.error_handler = 'MyApplication::MyErrorHandler'
+  end
+end
+```
+
+Mount the `RapidRack::Engine` engine in your Rails app. In `config/routes.rb`:
+
+```ruby
+Rails.application.routes.draw do
+  mount RapidRack::Engine => '/auth'
+
+  # ...
+end
+```
+
+Redirect to `/auth/login` to force authentication. By default, the subject id is
+available as `session[:subject_id]`. For example:
+
+```ruby
+class WelcomeController < ApplicationController
+  before_action do
+    @subject = session[:subject_id] && MyOwnUserClass.find(session[:subject_id])
+    redirect_to('/auth/login') if @subject.nil?
+  end
+
+  def index
+  end
+end
+```
+
+## Contributing
+
+Refer to [GitHub Flow](https://guides.github.com/introduction/flow/) for
+help contributing to this project.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: [:spec, :rubocop]