omniauth-nusso 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 372fca1755b7d777832e456d32d9d7dab95536c03233f40b455bd9b74ff8ee62
+  data.tar.gz: 5ba79e279f4659e2d36b4c850cbbf14cf5993ae47617c3b244454a8eff15ed3c
+SHA512:
+  metadata.gz: c4164359e4e306012663329fd253c6a42dcd810c78cc261646feacbc257328d2f1c8af6f8e22a64f91f00114c44b6a4fecaf3b747acc926b36a6f1bd27763c55
+  data.tar.gz: 4eefac39a22768fc388f1908212dff3bdb0cc90b97c6c9aa725a0690d9720ff92002c1b382347d9f684ce4e08fcfbfd57c6ea71942145893690a21a5a9ca872e

data/.circleci/config.yml

@@ -0,0 +1,29 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.6.5
+        environment:
+          BUNDLER_VERSION: 2.1.4
+    steps:
+      - checkout
+      - run:
+          name: Install Bundler 2.1.4
+          command: gem install --no-doc bundler:2.1.4
+      - restore_cache:
+          keys:
+            - bundle-{{ checksum "Gemfile" }}-{{ checksum "omniauth-nusso.gemspec" }}
+            - bundle- # used if checksum fails
+      - run:
+          name: Install dependencies
+          command: bundle check --path=vendor/bundle || bundle install --path=vendor/bundle --jobs 4 --retry 3
+      - save_cache:
+          key: bundle-{{ checksum "Gemfile" }}-{{ checksum "omniauth-nusso.gemspec" }}
+          paths:
+            - "vendor/bundle"
+      - run:
+          name: Run Rubocop
+          command: bundle exec rubocop
+      - run:
+          name: Run Specs
+          command: bundle exec rspec spec

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,13 @@
+inherit_from: .rubocop_todo.yml
+
+inherit_gem:
+  bixby: bixby_default.yml
+
+inherit_mode:
+  merge:
+    - Exclude
+
+AllCops:
+  Exclude:
+    - "spec/**/*"
+  TargetRubyVersion: 2.3

data/.rubocop_todo.yml

@@ -0,0 +1,13 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-03-23 14:23:42 -0500 using RuboCop version 0.63.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 3
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 87

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in omniauth-nusso.gemspec
+gemspec
+
+gem 'omniauth', '~> 1.0'

data/LICENSE

@@ -0,0 +1,15 @@
+##########################################################################
+# Copyright 2020 Northwestern University Library
+# Additional copyright may be held by others, as reflected in the commit log
+#
+# 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,37 @@
+# OmniAuth::Nusso
+
+[OmniAuth](https://github.com/omniauth/omniauth) strategy for use with Northwestern University Agentless SSO.
+
+[![CircleCI](https://circleci.com/gh/nulib/omniauth-nusso.svg?style=svg)](https://circleci.com/gh/nulib/omniauth-nusso)
+[![Coverage Status](https://coveralls.io/repos/github/nulib/omniauth-nusso/badge.svg?branch=master)](https://coveralls.io/github/nulib/omniauth-nusso?branch=master)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omniauth-nusso'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install omniauth-nusso
+
+## Usage
+
+TODO
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nulib/omniauth-nusso.
+

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'omniauth/nusso'
+
+# 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/omniauth/nusso.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'omniauth/nusso/version'
+require 'omniauth/strategies/nusso'

data/lib/omniauth/nusso/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module OmniAuth
+  module Nusso
+    VERSION = '0.1.0'
+  end
+end

data/lib/omniauth/strategies/nusso.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'json'
+require 'omniauth'
+require 'pry'
+
+module OmniAuth
+  module Strategies
+    class Nusso
+      class AuthException < RuntimeError; end
+
+      include OmniAuth::Strategy
+
+      args [:base_url, :consumer_key]
+      option :base_url, nil
+      option :consumer_key, nil
+      option :sso_cookie, 'nusso'
+      option :include_attributes, true
+
+      ATTRIBUTE_MAP = {
+        name: 'displayName',
+        email: 'mail',
+        first_name: 'givenName',
+        last_name: 'sn',
+        phone: 'telephoneNumber',
+        description: 'title'
+      }.freeze
+
+      def connection
+        @connection ||= Faraday::Connection.new(options.base_url)
+      end
+
+      protected
+
+        def request_phase
+          response = get('get-ldap-redirect-url', goto: callback_url)
+          redirect response['redirecturl']
+        end
+
+        def callback_phase
+          token = request.cookies[options.sso_cookie]
+          response = get('validateWebSSOToken', webssotoken: token)
+          @user_info = { 'uid' => response['netid'] }
+          if options.include_attributes
+            @user_info.merge!(get_directory_attributes(token))
+          end
+          super
+        rescue AuthException => err
+          fail!(err.message)
+        end
+
+        uid { @user_info['uid'] }
+
+        info do
+          Hash[
+            ATTRIBUTE_MAP.map do |key, user_info_key|
+              [key, @user_info[user_info_key]]
+            end
+          ]
+        end
+
+        extra { { raw_info: @user_info } }
+
+      private
+
+        def get(path, headers)
+          headers = headers.merge(apikey: options.consumer_key)
+          response = connection.get(path, nil, headers)
+          case response.status
+          when 200..299
+            JSON.parse(response.body)
+          when 407
+            raise AuthException, "Missing or Invalid Token"
+          else
+            raise AuthException, "Unknown Response"
+          end
+        end
+
+        def get_directory_attributes(token)
+          response = get("validate-with-directory-search-response", webssotoken: token)
+          Hash[
+            response['results'].first.map do |k, v|
+              case v
+              when [] then nil
+              when "" then nil
+              when Array then [k, v.first]
+              else [k, v]
+              end
+            end.compact
+          ]
+        end
+    end
+  end
+end

data/lib/omniauth_nusso.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'omniauth/nusso'

data/omniauth-nusso.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative 'lib/omniauth/nusso/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'omniauth-nusso'
+  spec.version       = OmniAuth::Nusso::VERSION
+  spec.license       = 'Apache-2.0'
+  spec.authors       = ['Brendan Quinn']
+  spec.email         = ['brendan-quinn@northwestern.edu']
+
+  spec.summary       = 'OmniAuth strategy for Northwestern University Agentless SSO.'
+  spec.homepage      = 'https://github.com/nulib/omniauth-nusso'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/nulib/omniauth-nusso'
+
+  # 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(__dir__)) 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_runtime_dependency 'omniauth'
+  spec.add_runtime_dependency 'faraday'
+
+  spec.add_development_dependency 'bixby', '~> 2.0'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'coveralls', '~> 0.8.3'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'webmock'
+end

data/tags

@@ -0,0 +1,11 @@
+!_TAG_FILE_FORMAT	2	/extended format; --format=1 will not append ;" to lines/
+!_TAG_FILE_SORTED	1	/0=unsorted, 1=sorted, 2=foldcase/
+!_TAG_PROGRAM_AUTHOR	Darren Hiebert	/dhiebert@users.sourceforge.net/
+!_TAG_PROGRAM_NAME	Exuberant Ctags	//
+!_TAG_PROGRAM_URL	http://ctags.sourceforge.net	/official site/
+!_TAG_PROGRAM_VERSION	5.8	//
+Error	lib/omniauth/nusso.rb	/^    class Error < StandardError; end$/;"	c	class:Omniauth.Nusso
+Nusso	lib/omniauth/nusso.rb	/^  module Nusso$/;"	m	class:Omniauth
+Nusso	lib/omniauth/nusso/version.rb	/^  module Nusso$/;"	m	class:Omniauth
+Omniauth	lib/omniauth/nusso.rb	/^module Omniauth$/;"	m
+Omniauth	lib/omniauth/nusso/version.rb	/^module Omniauth$/;"	m

metadata

@@ -0,0 +1,230 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-nusso
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brendan Quinn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  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: faraday
+  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: bixby
+  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: 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: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- brendan-quinn@northwestern.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/omniauth/nusso.rb
+- lib/omniauth/nusso/version.rb
+- lib/omniauth/strategies/nusso.rb
+- lib/omniauth_nusso.rb
+- omniauth-nusso.gemspec
+- tags
+homepage: https://github.com/nulib/omniauth-nusso
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/nulib/omniauth-nusso
+  source_code_uri: https://github.com/nulib/omniauth-nusso
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: OmniAuth strategy for Northwestern University Agentless SSO.
+test_files: []