openid_backchannel_logout 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 763a37be3d48c7a97844aac81708338c7ed7611aaa45d9bda3f4dc9ee2de5999
+  data.tar.gz: 17b07998e9ed65452a81b931dff14d8c3a1606ce9ac34eedfb085228245af16e
+SHA512:
+  metadata.gz: 181bf76cf0cd74622e4dc302072e8887ccab1dbe1f4fcf88b2ae978308a24d42789b3498d691ba4fe120c8b69d1c37171d1e58cd4070f33fc6e61240e15361b4
+  data.tar.gz: e414c4f742bc57cda4777b52028f4c8b413e9de27b7d4b597e3c5d77d0ec7ece2b2835a413eb3940b93c74ce06040a735982ec25f9766d644086d912434cb3fb

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Nguyen Ngoc Hai
+
+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,43 @@
+# OpenidBackchannelLogout
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/openid_backchannel_logout`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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 the created tag, 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/[USERNAME]/openid_backchannel_logout. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/openid_backchannel_logout/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the OpenidBackchannelLogout project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/openid_backchannel_logout/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+task default: %i[]

data/lib/generators/openid_backchannel_logout/install/install_generator.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module OpenidBackchannelLogout
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __dir__)
+
+      def create_initializer
+        copy_file 'initializer.rb', 'config/initializers/openid_backchannel_logout.rb'
+      end
+
+      def create_controller
+        template 'backchannel_logouts_controller.rb', 'app/controllers/api/internal/backchannel_logouts_controller.rb'
+      end
+
+      def create_routes
+        routes_file = File.join('config', 'routes.rb')
+        route_to_add = "resource :backchannel_logout, only: :create\n"
+
+        if File.readlines(routes_file).grep(/resource :backchannel_logout/).any?
+          say_status('skipped', 'Routes for backchannel_logout already exist, skipping.', :yellow)
+        else
+          content = File.read(routes_file)
+
+          if content.match?(/namespace :internal(,.*)? do/)
+            # Inject into the existing `namespace :internal` block
+            inject_into_file routes_file, "      #{route_to_add}", after: /namespace :internal(,.*)? do\n/
+            say_status('added', 'Route added to existing namespace :internal.', :green)
+          elsif content.match?(/namespace :api(,.*)? do/)
+            inject_into_file routes_file, <<-RUBY, after: /namespace :api(,.*)? do\n/
+    namespace :internal do
+      #{route_to_add.strip}
+    end
+            RUBY
+            say_status('added', 'Namespace :internal created and route added.', :green)
+          else
+            inject_into_file routes_file, <<-RUBY, after: /Rails.application.routes.draw(,.*)? do\n/
+  namespace :api, defaults: { format: 'json' } do
+    namespace :internal do
+      #{route_to_add.strip}
+    end
+  end
+            RUBY
+            say_status('added', 'Namespace :api and :internal created, and route added.', :green)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/generators/openid_backchannel_logout/templates/backchannel_logouts_controller.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Api
+  module Internal
+    class BackchannelLogoutsController < ActionController::API
+      def create
+        OpenidBackchannelLogout::Executor.new.call(request) do |sub, sid|
+          Rails.logger.info("Logging out user with sub: #{sub}, sid: #{sid}")
+          # TODO: Implement the logic to logout the user
+        end
+
+        render plain: 'Logout successful', status: :ok
+      rescue StandardError => e
+        Rails.logger.error("Backchannel logout error: #{e.message}")
+        render plain: e.message, status: :bad_request
+      end
+    end
+  end
+end

data/lib/generators/openid_backchannel_logout/templates/initializer.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+OpenidBackchannelLogout.configure do |config|
+  config.issuer = ENV.fetch('OIDC_ISSUER', '') # OpenID Provider
+  config.audience = ENV.fetch('OIDC_CLIENT_ID', '') # Your Client ID
+end

data/lib/openid_backchannel_logout/configuration.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative 'error'
+
+module OpenidBackchannelLogout
+  class Configuration
+    attr_accessor :issuer, :audience
+
+    def validate!
+      raise Error::IssuerNotConfiguredError unless issuer.present?
+      raise Error::AudienceNotConfiguredError unless audience.present?
+    end
+  end
+end

data/lib/openid_backchannel_logout/error.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module OpenidBackchannelLogout
+  module Error
+    class EncodeError < StandardError; end
+    class DecodeError < StandardError; end
+    class MissingLogoutTokenError < StandardError; end
+    class InvalidLogoutTokenError < DecodeError; end
+
+    class MissingRequiredClaimError < DecodeError
+      def initialize(claim)
+        super("Missing #{claim} claim")
+      end
+    end
+
+    class MissingSubOrSidClaimError < DecodeError; end
+    class InvalidAlgorithmError < DecodeError; end
+    class InvalidIatError < DecodeError; end
+
+    class InvalidIssuerError < DecodeError
+      def initialize(expected_issuer, actual_issuer)
+        super("Invalid iss claim. Expected: #{expected_issuer}, but received: #{actual_issuer || '<none>'}")
+      end
+    end
+
+    class InvalidAudError < DecodeError
+      def initialize(expected_audience, actual_audience)
+        super("Invalid aud claim. Expected: #{expected_audience}, but received: #{actual_audience || '<none>'}")
+      end
+    end
+
+    class InvalidEventsError < DecodeError; end
+    class TokenExpiredError < DecodeError; end
+
+    class InvalidNonceError < DecodeError
+      def message
+        'Nonce claim is not allowed in Logout Token'
+      end
+    end
+
+    class IssuerNotConfiguredError < StandardError
+      def message
+        'Issuer must be set in OpenidBackchannelLogout configuration'
+      end
+    end
+
+    class AudienceNotConfiguredError < StandardError
+      def message
+        'Audience (Client ID) must be set in OpenidBackchannelLogout configuration'
+      end
+    end
+
+    class NoBlockProvidedError < StandardError; end
+  end
+end

data/lib/openid_backchannel_logout/executor.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require_relative 'error'
+require_relative 'token_validator'
+
+module OpenidBackchannelLogout
+  class Executor
+    def initialize
+      @expected_issuer = OpenidBackchannelLogout.configuration.issuer
+      @expected_audience = OpenidBackchannelLogout.configuration.audience
+    end
+
+    def call(request)
+      logout_token = extract_token(request)
+      raise Error::MissingLogoutTokenError unless logout_token
+
+      jwks_uri = fetch_jwks_uri
+
+      validator = TokenValidator.new(
+        logout_token,
+        jwks_uri,
+        @expected_issuer,
+        @expected_audience
+      )
+
+      validator.valid!
+
+      payload = validator.decoded_token.first
+      sub = payload['sub']
+      sid = payload['sid']
+
+      raise Error::NoBlockProvidedError, 'No block provided for handling sub and sid' unless block_given?
+
+      yield(sub, sid)
+    end
+
+    private
+
+    def extract_token(request)
+      request.params[:logout_token]
+    end
+
+    def fetch_jwks_uri
+      discovery_url = "#{@expected_issuer}/.well-known/openid-configuration"
+      response = Net::HTTP.get(URI(discovery_url))
+      discovery_data = JSON.parse(response)
+
+      discovery_data['jwks_uri'] || raise(Error::DecodeError, 'JWKS URI not found in discovery document')
+    rescue JSON::ParserError
+      raise Error::DecodeError, 'Failed to parse OpenID Connect discovery document'
+    rescue StandardError => e
+      raise Error::DecodeError, "Failed to fetch JWKS URI: #{e.message}"
+    end
+  end
+end

data/lib/openid_backchannel_logout/token_validator.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require 'jwt'
+require 'net/http'
+require 'json'
+
+module OpenidBackchannelLogout
+  class TokenValidator
+    attr_reader :decoded_token
+
+    EVENT_KEY = 'http://schemas.openid.net/event/backchannel-logout'
+
+    def initialize(jwt_token, jwks_uri, expected_issuer, expected_audience, options = {})
+      @jwt_token = jwt_token
+      @jwks_uri = jwks_uri
+      @expected_issuer = expected_issuer
+      @expected_audience = expected_audience
+
+      # TODO: Implement validation for claims that are not required by the spec
+      # https://openid.net/specs/openid-connect-backchannel-1_0.html
+      @options = options
+    end
+
+    def valid!
+      decode_and_validate_token
+      validate_claims
+    end
+
+    private
+
+    def decode_and_validate_token
+      header = JWT.decode(@jwt_token, nil, false).last
+      raise Error::InvalidAlgorithmError if header['alg'] == 'none'
+
+      @decoded_token = JWT.decode(@jwt_token, nil, true,
+                                  algorithms: [header['alg']],
+                                  jwks: jwks_keys)
+    end
+
+    def jwks_keys
+      @jwks_keys ||= begin
+        response = Net::HTTP.get(URI(@jwks_uri))
+        JSON.parse(response)['keys']
+      end
+    end
+
+    def validate_claims
+      payload = @decoded_token.first
+
+      validate_required_claims(payload)
+    end
+
+    def validate_required_claims(payload)
+      validate_iss(payload['iss'])
+      validate_aud(payload['aud'])
+      validate_timestamps(payload['iat'], payload['exp'])
+      validate_events(payload['events'])
+      validate_subject_or_session(payload)
+      validate_no_nonce(payload)
+    end
+
+    def validate_iss(iss)
+      raise Error::InvalidIssuerError.new(@expected_issuer, iss) unless iss == @expected_issuer
+    end
+
+    def validate_aud(aud)
+      return if Array(aud).include?(@expected_audience)
+
+      raise Error::InvalidAudError.new(@expected_audience, Array(aud))
+    end
+
+    def validate_timestamps(iat, exp)
+      raise Error::MissingRequiredClaimError, :iat unless iat
+      raise Error::MissingRequiredClaimError, :exp unless exp
+
+      raise Error::TokenExpiredError if Time.now.to_i > exp
+    end
+
+    def validate_events(events)
+      raise Error::MissingRequiredClaimError, :events unless events
+      raise Error::InvalidEventsError unless events.key?(EVENT_KEY)
+    end
+
+    def validate_subject_or_session(payload)
+      raise Error::MissingSubOrSidClaimError unless payload['sub'] || payload['sid']
+    end
+
+    def validate_no_nonce(payload)
+      raise Error::InvalidNonceError if payload.key?('nonce')
+    end
+  end
+end

data/lib/openid_backchannel_logout/version.rb

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

data/lib/openid_backchannel_logout.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'openid_backchannel_logout/configuration'
+require 'openid_backchannel_logout/executor'
+
+module OpenidBackchannelLogout
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+
+      configuration.validate!
+    end
+  end
+end

data/sig/openid_backchannel_logout.rbs

@@ -0,0 +1,4 @@
+module OpenidBackchannelLogout
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: openid_backchannel_logout
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nguyen Ngoc Hai
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: 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'
+description: A Ruby implementation of OpenID Connect Backchannel Logout, as defined
+  in the OpenID Connect Back-Channel Logout 1.0 specification.
+email:
+- ngochai220998@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/openid_backchannel_logout/install/install_generator.rb
+- lib/generators/openid_backchannel_logout/templates/backchannel_logouts_controller.rb
+- lib/generators/openid_backchannel_logout/templates/initializer.rb
+- lib/openid_backchannel_logout.rb
+- lib/openid_backchannel_logout/configuration.rb
+- lib/openid_backchannel_logout/error.rb
+- lib/openid_backchannel_logout/executor.rb
+- lib/openid_backchannel_logout/token_validator.rb
+- lib/openid_backchannel_logout/version.rb
+- sig/openid_backchannel_logout.rbs
+homepage: https://github.com/NgocHai220998/openid_backchannel_logout.git
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/NgocHai220998/openid_backchannel_logout.git
+  source_code_uri: https://github.com/NgocHai220998/openid_backchannel_logout.git
+  changelog_uri: https://github.com/NgocHai220998/openid_backchannel_logout.git
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key: 
+specification_version: 4
+summary: A Ruby implementation of OpenID Connect Backchannel Logout
+test_files: []