oidc 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c44f542b5c5d86f83dded13bdf0256a209178610b54ba4501261506a3f2ce611
+  data.tar.gz: ebb8d39a32a3414b869ea9c603bc0af7175caacfe6e81971a6e3fd60fe2c14dd
+SHA512:
+  metadata.gz: 197c2bca2194a332bd89e3740bd98141925e0cf64e88b534b477e7d02a4ad1499c7fd9751cb13eadf0c9a99b0e9b23b2af69f5d5ed6b2a956edc71ee1bf01b09
+  data.tar.gz: 83351e3eccbbe80ddab3265e7f37b173114f15d72bf9ee555bdbab8f4a9de893352c154bfa49e5d7a8fb0b3cada3ab3317d46b909de6252760713870c81f4814

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format=documentation

data/.rubocop.yml

@@ -0,0 +1,28 @@
+AllCops:
+  TargetRubyVersion: 2.7
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/ClassLength:
+  Max: 200
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/AbcSize:
+  Max: 35
+
+Metrics/Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 10

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## [Released]
+
+## [0.0.1] - 2024-07-21
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# 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, 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 e-mail 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 slmusayev@gmail.com. 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.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Suleyman Musayev
+
+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,46 @@
+= Oidc
+
+OpenID Connect Server & Client Library
+
+== Installation
+
+  gem install oidc
+
+== Resources
+
+* View Source on GitHub (https://github.com/nov/oidc)
+* Report Issues on GitHub (https://github.com/nov/oidc/issues)
+* Subscribe Update Info (https://www.facebook.com/Oidc.rb)
+
+== Examples
+
+=== Provider
+
+* Running on Heroku (https://connect-op.herokuapp.com)
+* Source on GitHub (https://github.com/nov/oidc_sample)
+
+* Simpler Version (https://github.com/nov/oidc_sample2)
+
+=== Relying Party
+
+* Running on Heroku (https://connect-rp.herokuapp.com)
+* Source on GitHub (https://github.com/nov/oidc_sample_rp)
+
+There is also OpenID Foudation Certified RP implementation using this gem below.
+
+* Running on Heroku (https://connect-rp-certified.herokuapp.com)
+* Source on GitHub (https://github.com/nov/connect-rp-certified)
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2011 nov matake. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/oidc/access_token/mtls.rb

@@ -0,0 +1,9 @@
+module Oidc
+  class AccessToken::MTLS < AccessToken
+    def initialize(attributes = {})
+      super
+      http_client.ssl.client_key  = attributes[:private_key] || client.private_key
+      http_client.ssl.client_cert = attributes[:certificate] || client.certificate
+    end
+  end
+end

data/lib/oidc/access_token.rb

@@ -0,0 +1,45 @@
+module Oidc
+  class AccessToken < Rack::OAuth2::AccessToken::Bearer
+    attr_required :client
+    attr_optional :id_token
+
+    def initialize(attributes = {})
+      super
+      @token_type = :bearer
+    end
+
+    def userinfo!(params = {})
+      hash = resource_request do
+        get client.userinfo_uri, params
+      end
+      ResponseObject::UserInfo.new hash
+    end
+
+    def to_mtls(attributes = {})
+      (required_attributes + optional_attributes).each do |key|
+        attributes[key] = self.send(key)
+      end
+      MTLS.new attributes
+    end
+
+    private
+
+    def resource_request
+      res = yield
+      case res.status
+      when 200
+        res.body.with_indifferent_access
+      when 400
+        raise BadRequest.new('API Access Faild', res)
+      when 401
+        raise Unauthorized.new('Access Token Invalid or Expired', res)
+      when 403
+        raise Forbidden.new('Insufficient Scope', res)
+      else
+        raise HttpError.new(res.status, 'Unknown HttpError', res)
+      end
+    end
+  end
+end
+
+require 'oidc/access_token/mtls'

data/lib/oidc/client/registrar.rb

@@ -0,0 +1,186 @@
+module Oidc
+  class Client
+    class Registrar
+      include ActiveModel::Validations, AttrRequired, AttrOptional
+
+      class RegistrationFailed < HttpError; end
+
+      cattr_accessor :plural_uri_attributes, :metadata_attributes
+      singular_uri_attributes = [
+        :logo_uri,
+        :client_uri,
+        :policy_uri,
+        :tos_uri,
+        :jwks_uri,
+        :sector_identifier_uri,
+        :initiate_login_uri
+      ]
+      singular_attributes = [
+        :application_type,
+        :client_name,
+        :jwks,
+        :subject_type,
+        :id_token_signed_response_alg,
+        :id_token_encrypted_response_alg,
+        :id_token_encrypted_response_enc,
+        :userinfo_signed_response_alg,
+        :userinfo_encrypted_response_alg,
+        :userinfo_encrypted_response_enc,
+        :request_object_signing_alg,
+        :request_object_encryption_alg,
+        :request_object_encryption_enc,
+        :token_endpoint_auth_method,
+        :token_endpoint_auth_signing_alg,
+        :default_max_age,
+        :require_auth_time
+      ] + singular_uri_attributes
+      self.plural_uri_attributes = [
+        :redirect_uris,
+        :request_uris
+      ]
+      plural_attributes = [
+        :response_types,
+        :grant_types,
+        :contacts,
+        :default_acr_values,
+      ] + plural_uri_attributes
+      self.metadata_attributes = singular_attributes + plural_attributes
+      required_metadata_attributes = [
+        :redirect_uris
+      ]
+      attr_required :endpoint
+      attr_optional :initial_access_token
+      attr_required(*required_metadata_attributes)
+      attr_optional(*(metadata_attributes - required_metadata_attributes))
+
+      validates(*required_attributes,   presence: true)
+      validates :sector_identifier_uri, presence: {if: :sector_identifier_required?}
+      validates(*singular_uri_attributes, url: true, allow_nil: true)
+      validate :validate_plural_uri_attributes
+      validate :validate_contacts
+
+      def initialize(endpoint, attributes = {})
+        self.endpoint = endpoint
+        self.initial_access_token = attributes[:initial_access_token]
+        self.class.metadata_attributes.each do |_attr_|
+          self.send "#{_attr_}=", attributes[_attr_]
+        end
+      end
+
+      def sector_identifier
+        if valid_uri?(sector_identifier_uri)
+          URI.parse(sector_identifier_uri).host
+        else
+          hosts = redirect_uris.collect do |redirect_uri|
+            if valid_uri?(redirect_uri, nil)
+              URI.parse(redirect_uri).host
+            else
+              nil
+            end
+          end.compact.uniq
+          if hosts.size == 1
+            hosts.first
+          else
+            nil
+          end
+        end
+      end
+
+      def as_json(options = {})
+        validate!
+        self.class.metadata_attributes.inject({}) do |hash, _attr_|
+          value = self.send _attr_
+          hash.merge! _attr_ => value unless value.nil?
+          hash
+        end
+      end
+
+      def register!
+        handle_response do
+          http_client.post endpoint, to_json, 'Content-Type' => 'application/json'
+        end
+      end
+
+      def read
+        # TODO: Do we want this feature even if we don't have rotate secret nor update metadata support?
+      end
+
+      def validate!
+        valid? or raise ValidationFailed.new(self)
+      end
+
+      private
+
+      def sector_identifier_required?
+        subject_type.to_s == 'pairwise' &&
+        sector_identifier.blank?
+      end
+
+      def valid_uri?(uri, schemes = ['http', 'https'])
+        # NOTE: specify nil for schemes to allow any schemes
+        URI::regexp(schemes).match(uri).present?
+      end
+
+      def validate_contacts
+        if contacts
+          include_invalid = contacts.any? do |contact|
+            begin
+              mail = Mail::Address.new(contact)
+              mail.address != contact || mail.domain.split(".").length <= 1
+            rescue
+              :invalid
+            end
+          end
+          errors.add :contacts, 'includes invalid email' if include_invalid
+        end
+      end
+
+      def validate_plural_uri_attributes
+        self.class.plural_uri_attributes.each do |_attr_|
+          if (uris = self.send(_attr_))
+            include_invalid = uris.any? do |uri|
+              !valid_uri?(uri, nil)
+            end
+            errors.add _attr_, 'includes invalid URL' if include_invalid
+          end
+        end
+      end
+
+      def http_client
+        case initial_access_token
+        when nil
+          Oidc.http_client
+        when Rack::OAuth2::AccessToken::Bearer
+          initial_access_token
+        else
+          Rack::OAuth2::AccessToken::Bearer.new(
+            access_token: initial_access_token
+          )
+        end
+      end
+
+      def handle_response
+        response = yield
+        case response.status
+        when 200..201
+          handle_success_response response
+        else
+          handle_error_response response
+        end
+      end
+
+      def handle_success_response(response)
+        credentials = response.body.with_indifferent_access
+        Client.new(
+          identifier: credentials[:client_id],
+          secret:     credentials[:client_secret],
+          expires_in: credentials[:expires_in]
+        )
+      end
+
+      def handle_error_response(response)
+        raise RegistrationFailed.new(response.status, 'Client Registration Failed', response)
+      end
+    end
+  end
+end

data/lib/oidc/client.rb

@@ -0,0 +1,43 @@
+module Oidc
+  class Client < Rack::OAuth2::Client
+    attr_optional :userinfo_endpoint, :expires_in
+
+    def initialize(attributes = {})
+      super attributes
+      self.userinfo_endpoint ||= '/userinfo'
+    end
+
+    def authorization_uri(params = {})
+      params[:scope] = setup_required_scope params[:scope]
+      params[:prompt] = Array(params[:prompt]).join(' ')
+      super
+    end
+
+    def userinfo_uri
+      absolute_uri_for userinfo_endpoint
+    end
+
+    private
+
+    def setup_required_scope(scopes)
+      _scopes_ = Array(scopes).join(' ').split(' ')
+      _scopes_ << 'openid' unless _scopes_.include?('openid')
+      _scopes_
+    end
+
+    def handle_success_response(response)
+      token_hash = response.body.with_indifferent_access
+      token_type = (@forced_token_type || token_hash[:token_type]).try(:downcase)
+      case token_type
+      when 'bearer'
+        AccessToken.new token_hash.merge(client: self)
+      else
+        raise Exception.new("Unexpected Token Type: #{token_type}")
+      end
+    end
+  end
+end
+
+Dir[File.dirname(__FILE__) + '/client/*.rb'].each do |file|
+  require file
+end

data/lib/oidc/connect_object.rb

@@ -0,0 +1,52 @@
+module Oidc
+  class ConnectObject
+    include ActiveModel::Validations, AttrRequired, AttrOptional
+
+    attr_accessor :raw_attributes
+
+    def initialize(attributes = {})
+      all_attributes.each do |_attr_|
+        self.send :"#{_attr_}=", attributes[_attr_]
+      end
+      self.raw_attributes = attributes
+      attr_missing!
+    end
+
+    def self.all_attributes
+      required_attributes + optional_attributes
+    end
+    def all_attributes
+      self.class.all_attributes
+    end
+
+    def require_at_least_one_attributes
+      all_blank = all_attributes.all? do |key|
+        self.send(key).blank?
+      end
+      errors.add :base, 'At least one attribute is required' if all_blank
+    end
+
+    def as_json(options = {})
+      options ||= {} # options can be nil when to_json is called without options
+      validate! unless options[:skip_validation]
+      all_attributes.inject({}) do |hash, _attr_|
+        value = self.send(_attr_)
+        hash.merge! _attr_ => case value
+        when ConnectObject
+          value.as_json options
+        else
+          value
+        end
+      end.delete_if do |key, value|
+        value.nil?
+      end
+    end
+
+    def validate!
+      valid? or raise ValidationFailed.new(self)
+    end
+  end
+end
+
+require 'oidc/request_object'
+require 'oidc/response_object'

data/lib/oidc/discovery/provider/config/resource.rb

@@ -0,0 +1,39 @@
+require "openssl"
+
+module Oidc
+  module Discovery
+    module Provider
+      class Config
+        class Resource < SWD::Resource
+          undef_required_attributes :principal, :service
+
+          class Expired < SWD::Resource::Expired; end
+
+          def initialize(uri)
+            @host = uri.host
+            @port = uri.port unless [80, 443].include?(uri.port)
+            @path = File.join uri.path, '.well-known/openid-configuration'
+            attr_missing!
+          end
+
+          def endpoint
+            SWD.url_builder.build [nil, host, port, path, nil, nil]
+          rescue URI::Error => e
+            raise SWD::Exception.new(e.message)
+          end
+
+          private
+
+          def to_response_object(hash)
+            Response.new(hash)
+          end
+
+          def cache_key
+            sha256 = OpenSSL::Digest::SHA256.hexdigest host
+            "swd:resource:opneid-conf:#{sha256}"
+          end
+        end
+      end
+    end
+  end
+end