openstax_auth 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c94d632ecd0b4eb33521d4ea151a1e4ad441904d27b36da6da1c152fe8d5ef68
+  data.tar.gz: 9c59c1264d2fc58800a6dfe8ea6d65d3ecf32467466be038a61719f1e5711243
+SHA512:
+  metadata.gz: ea52d1b0e469d251152aa0fac49df44d666a073f59d1b15eee9570d7fe9126da4e014578c5a07643fe52156e3a2f9365875e28a119ee7e3dbdc0aa947acc2567
+  data.tar.gz: 594a4c58eb9ba9ddf08253929b18ad493925d19462e380e5d57168b364cf803a5f88f81866bb9c7219baf3c4b3b6bff48565429057e43548803eb56a92c94ed8

data/.github/workflows/tests.yml

@@ -0,0 +1,31 @@
+name: Tests
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  tests:
+    timeout-minutes: 10
+    runs-on: ubuntu-18.04
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+      - uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gems-pr-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-gems-pr-
+      - name: Test
+        run: |
+          gem install bundler --force --no-document --version 2.1.4
+          bundle config path vendor/bundle
+          bundle config jobs 2
+          bundle install
+          bundle exec rspec

data/.gitignore

@@ -0,0 +1,12 @@
+.bundle/
+log/*.log
+pkg/
+*.gem
+Gemfile.lock
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/db/
+spec/dummy/.sass-cache
+.byebug_history
+.DS_Store
+.rspec_status

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Rice University
+
+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,52 @@
+# openstax_auth
+
+**This is a fork of openstax/auth-rails that eliminates the ActiveSupport dependency as well as the no-longer-used "strategy 1".**
+
+Provides utilities to get user information from cookies within OpenStax rack-based apps.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'openstax_auth', git: 'https://github.com/openstax/auth-ruby.git', ref: 'some_commit_sha_here'
+```
+
+(this gem is not published to rubygems)
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+This gem contains strategies for extracting user information from cookies.  As OpenStax authentication cookies evolve over time, new strategies will be added and old ones will no longer be used.
+
+### Strategy 2
+
+The only strategy in this gem.
+
+Configure the `strategy_2` settings:
+
+```ruby
+OpenStax::Auth.configure do |config|
+  config.strategy2.signature_public_key = "blah"
+  config.strategy2.encryption_private_key = "blah"
+  config.strategy2.cookie_name = "blah"
+  config.strategy2.encryption_algorithm = 'dir'
+  config.strategy2.encryption_method = 'A256GCM'
+  config.strategy2.signature_algorithm = 'RS256'
+end
+```
+
+And then `require 'openstax/auth/strategy_2'` in the code that needs it.
+
+## Development
+
+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.
+
+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).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

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

@@ -0,0 +1,56 @@
+module OpenStax
+  module Auth
+    class Configuration
+      attr_reader :strategy2
+
+      class ConfigFields
+        def self.attr_accessor(*vars, required: false)
+          super(*vars)
+          vars.each do |v|
+            define_singleton_method(v) do
+              val = instance_variable_get "@#{v.to_s}".to_sym
+              raise "#{v} not set" if (val.nil? || val == "") && required
+              val
+            end
+          end
+        end
+      end
+
+      class Strategy2 < ConfigFields
+        attr_accessor :signature_public_key, required: true
+        attr_accessor :encryption_private_key, required: true
+        attr_accessor :cookie_name, required: true
+        attr_accessor :encryption_algorithm, required: true
+        attr_accessor :encryption_method, required: true
+        attr_accessor :signature_algorithm, required: true
+      end
+
+      def initialize
+        @strategy2 = Strategy2.new
+      end
+    end
+
+    class << self
+      ###########################################################################
+      #
+      # Configuration machinery.
+      #
+      # To configure OpenStax Auth, put the following code in your
+      # application's initialization logic
+      # (eg. in the config/initializers in a Rails app)
+      #
+      #   OpenStax::Auth.configure do |config|
+      #     config.<parameter name> = <parameter value>
+      #     ...
+      #   end
+      #
+      def configure
+        yield configuration
+      end
+
+      def configuration
+        @configuration ||= Configuration.new
+      end
+    end
+  end
+end

data/lib/openstax/auth/strategy_2.rb

@@ -0,0 +1,68 @@
+require 'json/jwt'
+require 'forwardable'
+
+module OpenStax
+  module Auth
+    module Strategy2
+      extend Forwardable
+      extend self
+
+      def_delegators :configuration,
+                     :cookie_name,
+                     :signature_public_key,
+                     :signature_algorithm,
+                     :encryption_private_key,
+                     :encryption_algorithm,
+                     :encryption_method
+
+      def user_uuid(request)
+        (decrypt(request) || {}).dig('sub', 'uuid')
+      end
+
+      def decrypt(request)
+        auth_header = request.headers['Authorization'] || ''
+        cookie = auth_header.start_with?('Bearer ') ?
+          auth_header.sub('Bearer ', '') : request.cookies[cookie_name]
+        return if cookie.nil? || cookie.empty?
+
+        begin
+          # Decoding is the reverse of what accounts does to encode a cookie:
+          # accounts first asymmetric encodes the cookie w/ the signature private
+          # key, then it next symmetric encodes that result w/ the encryption
+          # private key.
+
+          # Step 1:  symmetric decode the cookie with the encryption private key
+          encrypted = JSON::JWT.decode(
+            cookie,
+            rsa_encryption_private_key,
+            encryption_algorithm.to_s,
+            encryption_method.to_s
+          ).plain_text
+
+          # Step 2:  asymmetric decode the previous step with the signature public key
+          JSON::JWT.decode(
+            encrypted,
+            rsa_signature_public_key,
+            signature_algorithm.to_sym
+          )
+        rescue JSON::JWT::Exception, OpenSSL::Cipher::CipherError
+          nil
+        end
+      end
+
+      private
+
+      def configuration
+        OpenStax::Auth.configuration.strategy2
+      end
+
+      def rsa_signature_public_key
+        OpenSSL::PKey::RSA.new signature_public_key
+      end
+
+      def rsa_encryption_private_key
+        OpenSSL::PKey::RSA.new encryption_private_key rescue encryption_private_key
+      end
+    end
+  end
+end

data/lib/openstax/auth/version.rb

@@ -0,0 +1,5 @@
+module OpenStax
+  module Auth
+    VERSION = "0.2.0"
+  end
+end

data/lib/openstax_auth.rb

@@ -0,0 +1,7 @@
+require "openstax/auth/version"
+require "openstax/auth/configuration"
+
+module OpenStax
+  module Auth
+  end
+end

data/openstax_auth.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "openstax/auth/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "openstax_auth"
+  spec.version       = OpenStax::Auth::VERSION
+  spec.authors       = ["JP Slavinsky"]
+  spec.email         = ["jps@rice.edu"]
+
+  spec.summary       = %q{Provides utilities to get user information from cookies within OpenStax Ruby apps.}
+  spec.description   = %q{Provides utilities to get user information from cookies within OpenStax Ruby apps.}
+  spec.homepage      = "https://github.com/openstax/auth-ruby"
+  spec.license       = "MIT"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/openstax/auth-ruby"
+
+  # 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.require_paths = ["lib"]
+
+  spec.add_dependency "json-jwt"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: openstax_auth
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- JP Slavinsky
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json-jwt
+  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: 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: Provides utilities to get user information from cookies within OpenStax
+  Ruby apps.
+email:
+- jps@rice.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/tests.yml"
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/openstax/auth/configuration.rb
+- lib/openstax/auth/strategy_2.rb
+- lib/openstax/auth/version.rb
+- lib/openstax_auth.rb
+- openstax_auth.gemspec
+homepage: https://github.com/openstax/auth-ruby
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/openstax/auth-ruby
+  source_code_uri: https://github.com/openstax/auth-ruby
+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.4
+signing_key:
+specification_version: 4
+summary: Provides utilities to get user information from cookies within OpenStax Ruby
+  apps.
+test_files: []