omniauth-okta 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 38df3b55712de59cb23523883470194544d4bce3
+  data.tar.gz: 216d413ed26f5d19e9cd30891a2d3594e17d8990
+SHA512:
+  metadata.gz: 0e7b53deafd73f07efee1f988cdee305542dbbefdbae4a1d7d0e63309a2bc0bac91502b816e9ac77ac5561302bc5c03f935a72307fc7ceb0849508624ce5fd6f
+  data.tar.gz: 88199e697905e10481d5c5b7e3cb1af8f766b17a1f03f6059cbf4b86341840a163777c3b8837d94abd87796da70074dc0ac925d33c2a8a0681dded3baac31e45

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Dan Andrews
+
+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,139 @@
+# OmniAuth Okta OAuth2 Strategy
+
+Strategy to authenticate with Okta via OAuth2 in OmniAuth.
+
+This strategy uses Okta's OpenID Connect API with OAuth2. See their [developer docs](https://developer.okta.com/docs/api/resources/oidc.html) for more details.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omniauth-okta'
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+```bash
+$ gem install omniauth-okta
+```
+
+### Environment Variables
+
+```bash
+OKTA_CLIENT_ID     # required
+OKTA_CLIENT_SECRET # required
+OKTA_ORG           # required - defaults to 'your-org' if unset
+OKTA_DOMAIN        # optional - defaults to 'okta.com' if unset
+```
+
+### OmniAuth
+
+Here's an example for adding the middleware to a Rails app in `config/initializers/omniauth.rb`:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :okta, ENV['OKTA_CLIENT_ID'], ENV['OKTA_CLIENT_SECRET']
+end
+```
+
+### Devise
+
+First define your application id and secret in `config/initializers/devise.rb`.
+
+Configuration options can be passed as the last parameter here as key/value pairs.
+
+```ruby
+config.omniauth :okta, ENV['OKTA_CLIENT_ID'], ENV['OKTA_CLIENT_SECRET'], {}
+```
+or add options like the following:
+
+```ruby
+  require 'omniauth-okta'
+  config.omniauth(:okta,
+                  ENV['OKTA_CLIENT_ID'],
+                  ENV['OKTA_CLIENT_SECRET'],
+                  :scope => 'openid profile email',
+                  :fields => ['profile', 'email'],
+                  :strategy_class => OmniAuth::Strategies::Okta)
+```
+
+Then add the following to 'config/routes.rb' so the callback routes are defined.
+
+```ruby
+devise_for :users, controllers: { omniauth_callbacks: 'users/omniauth_callbacks' }
+```
+
+Make sure your model is omniauthable. Generally this is "/app/models/user.rb"
+
+```ruby
+devise :omniauthable, omniauth_providers: [:okta]
+```
+
+## Auth Hash
+
+Here's an example of an authentication hash available in the callback by accessing `request.env['omniauth.auth']`:
+
+```ruby
+{
+  "provider" => "okta",
+  "uid" => "0000000000000001",
+  "info" => {
+    "name" => "John Smith",
+    "email" => "john@example.com",
+    "first_name" => "John",
+    "last_name" => "Smith",
+    "image" => "https://photohosting.com/john.jpg"
+  },
+  "credentials" => {
+    "token" => "TOKEN",
+    "expires_at" => 1496617411,
+    "expires" => true
+  },
+  "extra" => {
+    "raw_info" => {
+      "sub" => "0000000000000001",
+      "name" => "John Smith",
+      "locale" => "en-US",
+      "email" => "john@example.com",
+      "picture" => "https://photohosting.com/john.jpg",
+      "website" => "https://example.com",
+      "preferred_username" => "john@example.com",
+      "given_name" => "John",
+      "family_name" => "Smith",
+      "zoneinfo" => "America/Los_Angeles",
+      "updated_at" => 1496611646,
+      "email_verified" => true
+    },
+    "id_token" => "TOKEN",
+    "id_info" => {
+      "ver" => 1,
+      "jti" => "AT.D2sslkfjdsldjf899n090sldkfj",
+      "iss" => "https://your-org.okta.com",
+      "aud" => "https://your-org.okta.com",
+      "sub" => "john@example.com",
+      "iat" => 1496613811,
+      "exp" => 1496617411,
+      "cid" => "CLIENT_ID",
+      "uid" => "0000000000000001",
+      "scp" => ["email", "profile", "openid"]
+    }
+  }
+}
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Omniauth::Okta'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/omniauth-okta.rb

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

data/lib/omniauth-okta/version.rb

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

data/lib/omniauth/strategies/okta.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class Okta < OmniAuth::Strategies::OAuth2
+
+      ORG           = ENV['OKTA_ORG']    || 'your-org'
+      DOMAIN        = ENV['OKTA_DOMAIN'] || 'okta'
+      BASE_URL      = "https://#{ORG}.#{DOMAIN}.com"
+      DEFAULT_SCOPE = %[openid profile email].freeze
+
+      option :name, 'okta'
+
+      option :skip_jwt, false
+      option :jwt_leeway, 60
+
+      option :client_options, {
+        site:          BASE_URL,
+        authorize_url: "#{BASE_URL}/oauth2/v1/authorize",
+        token_url:     "#{BASE_URL}/oauth2/v1/token",
+        response_type: 'id_token'
+      }
+
+      option :scope, DEFAULT_SCOPE
+
+      uid { raw_info['sub'] }
+
+      info do
+        {
+          name:       raw_info['name'],
+          email:      raw_info['email'],
+          first_name: raw_info['given_name'],
+          last_name:  raw_info['family_name'],
+          image:      raw_info['picture']
+        }
+      end
+
+      extra do
+        hash = {}
+        hash[:raw_info] = raw_info unless skip_info?
+        hash[:id_token] = access_token.token
+        if !options[:skip_jwt] && !access_token.token.nil?
+          hash[:id_info] = validated_token(access_token.token)
+        end
+        hash
+      end
+
+      alias :oauth2_access_token :access_token
+
+      def access_token
+        ::OAuth2::AccessToken.new(client, oauth2_access_token.token, {
+          :expires_in => oauth2_access_token.expires_in,
+          :expires_at => oauth2_access_token.expires_at
+        })
+      end
+
+      def raw_info
+        @_raw_info ||= access_token.get('/oauth2/v1/userinfo').parsed || {}
+      rescue ::Errno::ETIMEDOUT
+        raise ::Timeout::Error
+      end
+
+      def request_phase
+        super
+      end
+
+      def callback_phase
+        super
+      end
+
+      def callback_url
+        options[:redirect_uri] || (full_host + script_name + callback_path)
+      end
+
+      def validated_token(token)
+        JWT.decode(token,
+                   nil,
+                   false,
+                   verify_iss:        true,
+                   iss:               BASE_URL,
+                   verify_aud:        true,
+                   aud:               BASE_URL,
+                   verify_sub:        true,
+                   verify_expiration: true,
+                   verify_not_before: true,
+                   verify_iat:        true,
+                   verify_jti:        false,
+                   leeway:            options[:jwt_leeway]
+                   ).first
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-okta
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dan Andrews
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !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'
+description: Unofficial OmniAuth OAuth2 strategy for Okta
+email:
+- daniel.raymond.andrews@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/omniauth-okta.rb
+- lib/omniauth-okta/version.rb
+- lib/omniauth/strategies/okta.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Unofficial OmniAuth OAuth2 strategy for Okta
+test_files: []