oauth_im 0.1.0.beta

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 27cef13d10be77f61bfff0a4faeabea5695f0707dc8edceb2cb47363f1aa4b58
+  data.tar.gz: e429efcb445b1243d4954801abc053bf80b4f6f9543a962d668e4728bb25c65b
+SHA512:
+  metadata.gz: d8a956deb04217dd73f4bf2bd35d6e9390b542e1ce786784088c05593eb607ac0bc19df739052af1dfcc0c820ad59bc18b1fad107ca3e05eaafb7480cd9ce19b
+  data.tar.gz: 5fb848b54191d4c12052786bbfd959069ece2c1b0dda8aab7481a7fe1b262b389e79c76af4108a453aa71b28492d20fdfdff41bed5edd390a7afb668c38ef451

data/LICENSE

@@ -0,0 +1,8 @@
+Copyright (c) 2018, Illustrative Mathematics and Open Up Resources
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,28 @@
+# OauthIm
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'oauth_im'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install oauth_im
+```
+
+## Contributing
+Contribution directions go here.
+
+## 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,18 @@
+require 'bundler/setup'
+
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/oauth_im_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/oauth_im .css

data/app/assets/stylesheets/oauth_im/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/concerns/oauth_im/authenticable.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module OauthIm
+  module Authenticable
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :auth_uid
+      helper_method :authenticated?
+      helper_method :email
+    end
+
+    private
+
+    def authenticated?
+      AppContext.kh_iiab? && logged_in?
+    end
+
+    def email
+      @email ||= jwt_token['email']
+    end
+
+    def auth_uid
+      gon.user_id = session[:user_jwt]['value'].first['jti'] if authenticated?
+    end
+
+    def user_jwt
+      @user_jwt ||= session[:user_jwt] || {}
+    end
+
+    def jwt_token
+      @jwt_token ||= user_jwt['value']&.first || {}
+    end
+
+    def email_verified?
+      jwt_token.present? && jwt_token['email_verified'].present?
+    end
+
+    def current_user
+      @current_user ||=
+        if user_jwt.present?
+          if email_verified?
+            email
+          else
+            head :forbidden
+          end
+        end
+    end
+
+    def logged_in?
+      current_user.present?
+    end
+  end
+end

data/app/controllers/oauth_im/application_controller.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module OauthIm
+  class ApplicationController < ActionController::Base; end
+end

data/app/controllers/oauth_im/client_controller.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'oauth2'
+
+module OauthIm
+  class ClientController < OauthIm::ApplicationController
+    def callback
+      session[:user_jwt] = { value: decoded_token, httponly: true }
+      redirect_to main_app.root_path
+    rescue StandardError
+      head :forbidden
+    end
+
+    def login
+      redirect_to oauth_client.auth_code.authorize_url
+    end
+
+    def logout
+      reset_session
+      redirect_to logout_uri
+    end
+
+    def local_login
+      raise 'Disallowed' unless Rails.env.development?
+
+      session[:userinfo] = { info: { email: 'local_login@example.com' } }
+      redirect_back(fallback_location: main_app.root_path)
+    end
+
+    def local_logout
+      reset_session
+      redirect_back(fallback_location: main_app.root_path)
+    end
+
+    private
+
+    def logout_uri
+      @logout_uri ||= "#{configuration.domain}/oauth2/logout" \
+                      "?post_logout_redirect_uri=#{post_logout_redirect_uri}" \
+                      "&client_id=#{configuration.client_id}"
+    end
+
+    def post_logout_redirect_uri
+      @post_logout_redirect_uri ||= params[:return_to]
+    end
+
+    def decoded_token
+      @decoded_token ||= TokenDecoder.new(access_token, oauth_client.id).decode
+    end
+
+    def access_token
+      @access_token ||= response_hash[:access_token]
+    end
+
+    def response_hash
+      @response_hash ||= auth_code.get_token(params[:code]).to_hash
+    end
+
+    def auth_code
+      @auth_code ||= oauth_client.auth_code
+    end
+
+    def oauth_client
+      @oauth_client = ::OAuth2::Client.new configuration.client_id,
+                                           configuration.client_secret,
+                                           authorize_url: configuration.authorize_url,
+                                           site: configuration.domain,
+                                           token_url: configuration.token_url,
+                                           redirect_uri: callback_url
+    end
+
+    def configuration
+      OauthIm.configuration
+    end
+  end
+end

data/app/helpers/oauth_im/application_helper.rb

@@ -0,0 +1,4 @@
+module OauthIm
+  module ApplicationHelper
+  end
+end

data/app/services/oauth_im/token_decoder.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'jwt'
+
+module OauthIm
+  class TokenDecoder
+    attr_reader :token, :aud
+
+    DECODE_ALGORITHM = 'HS256'
+
+    def initialize(token, aud)
+      @token = token
+      @aud = aud
+    end
+
+    def decode
+      decoded_token
+    end
+
+    private
+
+    def configuration
+      @configuration ||= OauthIm.configuration
+    end
+
+    def decoded_token
+      @decoded_token ||= JWT.decode token, configuration.hmac, true, decode_params
+    end
+
+    def decode_params
+      @decode_params ||= { verify_iss: true,
+                           iss: configuration.iss_domain,
+                           verify_aud: true,
+                           aud: aud,
+                           algorithm: DECODE_ALGORITHM }.freeze
+    end
+  end
+end

data/app/views/layouts/oauth_im/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Oauth im</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "oauth_im/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+OauthIm::Engine.routes.draw do
+  get OauthIm.callback_path, to: 'client#callback'
+  get 'login', to: 'client#login'
+  get 'logout', to: 'client#logout'
+
+  unless Rails.env.production?
+    get 'local_login', to: 'client#local_login'
+    get 'local_logout', to: 'client#local_logout'
+  end
+end

data/lib/oauth_im/configuration.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module OauthIm
+  CONFIGURABLE_FIELDS =
+    %i[api_key
+       authorize_url
+       callback_path
+       client_id
+       client_secret
+       domain
+       hmac
+       iss_domain
+       tenant_id
+       token_url].freeze
+
+  class Configuration
+    attr_reader(* CONFIGURABLE_FIELDS)
+
+    def initialize(config_proxy)
+      CONFIGURABLE_FIELDS.each do |field|
+        instance_variable_set "@#{field}", config_proxy.send(field)
+      end
+    end
+  end
+
+  class ConfigurationProxy
+    attr_accessor(*CONFIGURABLE_FIELDS)
+  end
+end

data/lib/oauth_im/engine.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module OauthIm
+  class Engine < ::Rails::Engine
+    isolate_namespace OauthIm
+
+    # edc: see https://www.hocnest.com/blog/testing-an-engine-with-rspec/
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+  end
+end

data/lib/oauth_im/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module OauthIm
+  VERSION = '0.1.0.beta'
+end

data/lib/oauth_im.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'oauth_im/version'
+require 'oauth_im/engine'
+require 'oauth_im/configuration'
+
+module OauthIm
+  DEFAULT_AUTHORIZE_URL = '/oauth2/authorize'
+  DEFAULT_TOKEN_URL     = '/oauth2/token'
+  DEFAULT_CALLBACK_PATH = 'callback'
+
+  class << self
+    attr_reader :configuration
+  end
+
+  def self.configure
+    raise 'Already configured!' if configuration.present?
+
+    ConfigurationProxy.new.then do |proxy|
+      yield proxy
+      @configuration = Configuration.new proxy
+    end
+  end
+
+  def self.callback_path
+    configuration&.callback_path || DEFAULT_CALLBACK_PATH
+  end
+end

data/lib/tasks/oauth_im_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :oauth_im do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: oauth_im
+version: !ruby/object:Gem::Version
+  version: 0.1.0.beta
+platform: ruby
+authors:
+- Eric Connally
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.pre.2.pre.stable
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.pre.2.pre.stable
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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: Include this gem in Gemfile, add an initializer, and you are good to
+  go.
+email:
+- eric@illustrativemathematics.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/config/oauth_im_manifest.js
+- app/assets/stylesheets/oauth_im/application.css
+- app/controllers/concerns/oauth_im/authenticable.rb
+- app/controllers/oauth_im/application_controller.rb
+- app/controllers/oauth_im/client_controller.rb
+- app/helpers/oauth_im/application_helper.rb
+- app/services/oauth_im/token_decoder.rb
+- app/views/layouts/oauth_im/application.html.erb
+- config/routes.rb
+- lib/oauth_im.rb
+- lib/oauth_im/configuration.rb
+- lib/oauth_im/engine.rb
+- lib/oauth_im/version.rb
+- lib/tasks/oauth_im_tasks.rake
+homepage: https://github.com/illustrativemathematics/oauth_im
+licenses:
+- BSD-3-Clause
+metadata:
+  homepage_uri: https://github.com/illustrativemathematics/oauth_im
+  source_code_uri: https://github.com/illustrativemathematics/oauth_im
+  changelog_uri: https://github.com/illustrativemathematics/oauth_im
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.6
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Provide oauth functionality for IM apps.
+test_files: []