omniauth-slack-openid 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f5fb3e5f96c832e24bbd7dc23c9e4ee0e1f8858a78beebdfdd7b0fe172c3a32e
+  data.tar.gz: ec3f3ae44d759f1a40f34fe5e5a953b1bc120e9c9fd93678834c54f4c4d202ba
+SHA512:
+  metadata.gz: 132b6519d589788e032f2994fb23663eb0765ec97efc11aa218ea98774aca4a1b6faa776ae4c492062876698ae3e6f3730d4bc3cfc8ecc6c2290719dc1defdbe
+  data.tar.gz: a58d54b112c70ae11395f19a1fca400bee3a5f3ad9a22b2fef67f0b48e50f2f930a77e97e2b4d49bdc9b55d3d374255a1536667b60989e43b4400b5a6cdb11ee

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 1.0.0
+
+* Initial version

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 amkisko
+
+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,60 @@
+# omniauth_slack_openid.rb
+
+[![Gem Version](https://badge.fury.io/rb/omniauth-slack-openid.svg)](https://badge.fury.io/rb/omniauth-slack-openid) [![Test Status](https://github.com/amkisko/omniauth_slack_openid.rb/actions/workflows/test.yml/badge.svg)](https://github.com/amkisko/omniauth_slack_openid.rb/actions/workflows/test.yml)
+
+An OmniAuth strategy for Slack's OAuth2 API.
+
+Sponsored by [Kisko Labs](https://www.kiskolabs.com).
+
+## Install
+
+Using Bundler:
+```sh
+bundle add omniauth-slack-openid
+```
+
+Using RubyGems:
+```sh
+gem install omniauth-slack-openid
+```
+
+## Gemfile
+
+```ruby
+gem 'omniauth-slack-openid'
+```
+
+## Usage with Devise
+
+Add the following to your `config/initializers/devise.rb`:
+
+```ruby
+  config.omniauth(
+    :slack_openid,
+    ENV.fetch("SLACK_CLIENT_ID"),
+    ENV.fetch("SLACK_CLIENT_SECRET"),
+    {
+      scope: "openid,email,profile",
+      redirect_uri: Rails.env.development? ? "https://localhost:3000/user/auth/slack_openid/callback" : nil,
+      provider_ignores_state: Rails.env.development?
+    }
+  )
+```
+
+In order to test the callback in development, try logging in and then manually update URL to use http instead of https.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/amkisko/omniauth_slack_openid.rb
+
+## Publishing
+
+```sh
+rm omniauth-slack-openid-*.gem
+gem build omniauth-slack-openid.gemspec
+gem push omniauth-slack-openid-*.gem
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/omniauth/slack_openid/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module SlackOpenid
+    VERSION = '1.0.0'
+  end
+end

data/lib/omniauth/slack_openid.rb

@@ -0,0 +1,2 @@
+require 'omniauth/slack_openid/version'
+require 'omniauth/strategies/slack_openid'

data/lib/omniauth/strategies/slack_openid.rb

@@ -0,0 +1,79 @@
+require 'omniauth/strategies/oauth2'
+
+module OmniAuth
+  module Strategies
+    class SlackOpenid < OmniAuth::Strategies::OAuth2
+      AUTH_OPTIONS = %i[scope user_scope team team_domain].freeze
+
+      INFO_DATA =
+        Data.define(
+          :user_id,
+          :team_id,
+          :email,
+          :email_verified,
+          :name,
+          :picture,
+          :given_name,
+          :family_name,
+          :locale,
+          :team_name,
+          :team_domain
+        )
+
+      option :name, "slack_openid"
+      option :client_options,
+             {
+               site: "https://slack.com",
+               authorize_url: "/openid/connect/authorize",
+               token_url: "/api/openid.connect.token"
+             }
+
+      option :redirect_uri
+
+      def self.generate_uid(team_id, user_id)
+        "#{team_id}-#{user_id}"
+      end
+
+      uid do
+        self.class.generate_uid(
+          raw_info["https://slack.com/team_id"],
+          raw_info["https://slack.com/user_id"]
+        )
+      end
+
+      info do {
+        name: raw_info["name"],
+        email: raw_info["email"],
+        image: raw_info["picture"]
+      } end
+
+      extra do
+        {
+          data:
+            INFO_DATA.new(
+              user_id: raw_info["https://slack.com/user_id"],
+              team_id: raw_info["https://slack.com/team_id"],
+              email: raw_info["email"],
+              email_verified: raw_info["email_verified"],
+              name: raw_info["name"],
+              picture: raw_info["picture"],
+              given_name: raw_info["given_name"],
+              family_name: raw_info["family_name"],
+              locale: raw_info["locale"],
+              team_name: raw_info["https://slack.com/team_name"],
+              team_domain: raw_info["https://slack.com/team_domain"]
+            ),
+          raw_info: raw_info
+        }
+      end
+
+      def callback_url
+        options.redirect_uri || (full_host + script_name + callback_path)
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get("/api/openid.connect.userInfo").parsed
+      end
+    end
+  end
+end

data/lib/omniauth-slack-openid.rb

@@ -0,0 +1 @@
+require 'omniauth/slack_openid'

data/omniauth-slack-openid.gemspec

@@ -0,0 +1,43 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/omniauth/slack_openid/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name = "omniauth-slack-openid"
+  gem.version = OmniAuth::SlackOpenid::VERSION
+
+  repository_url = "https://github.com/amkisko/omniauth-slack-openid.rb"
+  root_files = %w(CHANGELOG.md LICENSE.md README.md)
+  root_files << "#{gem.name}.gemspec"
+
+  gem.license = "MIT"
+
+  gem.platform = Gem::Platform::RUBY
+
+  gem.authors = ["Andrei Makarov"]
+  gem.email = ["andrei@kiskolabs.com"]
+  gem.homepage = repository_url
+  gem.summary = %q{Slack OAuth2 strategy for OmniAuth}
+  gem.description = gem.summary
+  gem.metadata = {
+    "homepage" => repository_url,
+    "source_code_uri" => repository_url,
+    "bug_tracker_uri" => "#{repository_url}/issues",
+    "changelog_uri" => "#{repository_url}/blob/main/CHANGELOG.md",
+    "rubygems_mfa_required" => "true"
+  }
+
+  gem.executables = Dir.glob("bin/*").map{ |f| File.basename(f) }
+  gem.files = Dir.glob("lib/**/*.rb") + Dir.glob("bin/**/*") + root_files
+  gem.test_files = Dir.glob("spec/**/*_spec.rb")
+
+  gem.required_ruby_version = ">= 1.9.3"
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'omniauth', '~> 2'
+  gem.add_runtime_dependency 'omniauth-oauth2', '~> 1'
+
+  gem.add_development_dependency 'bundler', '~> 2'
+  gem.add_development_dependency 'rake', '~> 13'
+  gem.add_development_dependency 'pry-byebug'
+  gem.add_development_dependency 'rspec', '~> 3'
+end

data/spec/omniauth/strategies/slack_openid_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::SlackOpenid do
+  let(:user_name) { 'brent' }
+  let(:user_email) { 'bront@slack-corp.com' }
+  let(:raw_info) {
+    {
+      "ok" => true,
+      "sub" => "U0R7JM",
+      "https://slack.com/user_id" => "U0R7JM",
+      "https://slack.com/team_id" => "T0R7GR",
+      "email" => user_email,
+      "email_verified" => true,
+      "date_email_verified" => 1622128723,
+      "name" => user_name,
+      "picture" => "https://secure.gravatar.com/....png",
+      "given_name" => "Bront",
+      "family_name" => "Labradoodle",
+      "locale" => "en-US",
+      "https://slack.com/team_name" => "kraneflannel",
+      "https://slack.com/team_domain" => "kraneflannel",
+      "https://slack.com/user_image_24" => "...",
+      "https://slack.com/user_image_32" => "...",
+      "https://slack.com/user_image_48" => "...",
+      "https://slack.com/user_image_72" => "...",
+      "https://slack.com/user_image_192" => "...",
+      "https://slack.com/user_image_512" => "...",
+      "https://slack.com/team_image_34" => "...",
+      "https://slack.com/team_image_44" => "...",
+      "https://slack.com/team_image_68" => "...",
+      "https://slack.com/team_image_88" => "...",
+      "https://slack.com/team_image_102" => "...",
+      "https://slack.com/team_image_132" => "...",
+      "https://slack.com/team_image_230" => "...",
+      "https://slack.com/team_image_default" => true
+    }
+  }
+  let(:dummy_rack_app) { [200, {}, ['dummy']] }
+  let(:options) { {} }
+
+  subject(:strategy) { OmniAuth::Strategies::SlackOpenid.new(dummy_rack_app, options) }
+
+  describe 'options' do
+    subject { strategy.options }
+
+    it { expect(subject.client_options.site).to eq('https://slack.com') }
+    it { expect(subject.client_options.authorize_url).to eq('/openid/connect/authorize') }
+    it { expect(subject.client_options.token_url).to eq('/api/openid.connect.token') }
+  end
+
+  describe '#info' do
+    before do
+      allow(strategy).to receive(:raw_info) { raw_info }
+    end
+
+    subject { strategy.info }
+
+    it { expect(subject[:name]).to eq(user_name) }
+    it { expect(subject[:email]).to eq(user_email) }
+  end
+
+  describe '#uid' do
+    before do
+      allow(strategy).to receive(:raw_info) { raw_info }
+    end
+
+    subject { strategy.uid }
+
+    it { expect(subject).to eq('T0R7GR-U0R7JM') }
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-slack-openid
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Andrei Makarov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: Slack OAuth2 strategy for OmniAuth
+email:
+- andrei@kiskolabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.md
+- README.md
+- lib/omniauth-slack-openid.rb
+- lib/omniauth/slack_openid.rb
+- lib/omniauth/slack_openid/version.rb
+- lib/omniauth/strategies/slack_openid.rb
+- omniauth-slack-openid.gemspec
+- spec/omniauth/strategies/slack_openid_spec.rb
+homepage: https://github.com/amkisko/omniauth-slack-openid.rb
+licenses:
+- MIT
+metadata:
+  homepage: https://github.com/amkisko/omniauth-slack-openid.rb
+  source_code_uri: https://github.com/amkisko/omniauth-slack-openid.rb
+  bug_tracker_uri: https://github.com/amkisko/omniauth-slack-openid.rb/issues
+  changelog_uri: https://github.com/amkisko/omniauth-slack-openid.rb/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Slack OAuth2 strategy for OmniAuth
+test_files:
+- spec/omniauth/strategies/slack_openid_spec.rb