warden_openid_bearer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f228ea62cd8329a39ec230cb8b764c8b83db2557a767c41f0f18b28f35fabe8c
+  data.tar.gz: 11272a48dc32c8063f08957d7e409100bfb14818a0795a86acbf9416b88a2b3d
+SHA512:
+  metadata.gz: 0602d2ade77d620f6aab62b0f0c55e02f4ff4d7ceb360d33c875a18b1318ec4b8664f3d0b0fc8a6eee8c423d8674dbfe1b3ad28feb80d2638489f013171a252c
+  data.tar.gz: dfe6d0e9418db37a762124a8cd94a00ab1127ceef9617acfcbc7bb94683ee92f6f661efde51a570a5b79d0fa21db4f480ac1e868b6ec4250065f73625f419046

data/.rspec

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

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-10-07
+
+- Initial release

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in warden_openid_bearer.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "standard", "~> 1.3"
+
+gem "debug"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Dominique Quatravaux
+
+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,51 @@
+# WardenOpenidBearer
+
+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/warden_openid_bearer`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add warden_openid_bearer
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install warden_openid_bearer
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the Git repository, run `bin/setup` to install dependencies. Then, run `bundle exec rake` to run the test suite and linter checks. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+### Debugger
+
+The `debugger` gem is a development-time requirement (in the Gemfile). In order to activate it:
+
+1. Uncomment the line that says `require "debug"` in `./spec_helper.rb`
+1. Stick `debugger` somewhere in the source or test code
+1. Run the test suite
+
+### Local Install
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+### Release
+
+To release a new version:
+1. Make sure that the version you want to publish is the current `master` branch on GitHub, and that the tests are green
+1. Check out the `master` branch in your working directory
+1. Update the version number in `version.rb`
+1. 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/epfl-si/warden_openid_bearer.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/warden_openid_bearer/cache_mixin.rb

@@ -0,0 +1,33 @@
+module WardenOpenidBearer
+  # We don't need an overengineered approach based on the Rails cache.
+  # No, really.
+  module CacheMixin
+    def cached_by(key, &do_it)
+      # We could support more complex types (e.g. arrays) as
+      # value-type cache keys; but right now, our use cases don't
+      # require it:
+      is_value_type = key.is_a? String
+      cache = if is_value_type
+        @__cache_mixin__cache ||= {}
+      else
+        # Use the ::ObjectSpace::WeakMap private API, because the
+        # endeavor of reinventing weak maps on top of (public)
+        # WeakRef's would be called an inversion of abstraction and
+        # would be considered harmful. Sue me (I have unit tests).
+        @__cache_mixin__weakmap_cache ||= ::ObjectSpace::WeakMap.new
+      end
+
+      now = Time.now()
+
+      if (cached = cache[key])
+        unless respond_to?(:cache_timeout) && now - cached[:fetched_at] > cache_timeout
+          return cached[:payload]
+        end
+      end
+
+      retval = do_it.call
+      cache[key] = {payload: retval, fetched_at: now}
+      retval
+    end
+  end
+end

data/lib/warden_openid_bearer/discovered_config.rb

@@ -0,0 +1,42 @@
+module WardenOpenidBearer
+  # Cacheable configuration (periodically re-)fetched starting from
+  # the OpenID authentication server's “well-known” endpoint
+  class DiscoveredConfig
+    include CacheMixin
+
+    def initialize(metadata_uri)
+      @metadata_uri = metadata_uri
+    end
+
+    # Called by the CacheMixin.
+    def cache_timeout
+      @cache_timeout ||= 900
+    end
+    # Provide a public API for tuning the timeout.
+    attr_writer :cache_timeout
+
+    def jwks
+      json(metadata[:jwks_uri])
+    end
+
+    def issuer
+      metadata[:issuer]
+    end
+
+    def authorization_algs
+      metadata[:authorization_signing_alg_values_supported]
+    end
+
+    private
+
+    def metadata
+      json(@metadata_uri)
+    end
+
+    def json(uri)
+      cached_by(uri) do
+        JSON.parse(Net::HTTP.get_response(URI(uri)).body, symbolize_names: true)
+      end
+    end
+  end
+end

data/lib/warden_openid_bearer/registerer.rb

@@ -0,0 +1,31 @@
+require "warden"
+
+module WardenOpenidBearer
+  # Add this mixin to your `Warden::Strategies::Base` subclass to
+  # streamline the `Warden::Strategies.add()` business.
+  #
+  # If you mix this into `Your::Class` (or inherit from one that
+  # does, such as `OIDCBearer::Strategy`), then you can say
+  #
+  #   manager.default_strategies Your::Class.register!
+  #
+  module Registerer
+    def self.included(klass)
+      klass.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def register!(as_symbol = default_registration_symbol)
+        return @registered_symbol if @registered_symbol
+        Warden::Strategies.add(as_symbol, self)
+        @registered_symbol = as_symbol
+      end
+
+      protected
+
+      def default_registration_symbol
+        name.delete(":").sub(/Strategy$/, "").underscore.to_sym
+      end
+    end
+  end
+end

data/lib/warden_openid_bearer/strategy.rb

@@ -0,0 +1,143 @@
+# Like `WardenOpenidAuth::Strategy` in
+# `lib/warden_openid_auth/strategy.rb` from the `warden_openid_auth`
+# gem, except done right for a modern, split-backend Web application
+# (in which the browser takes charge of the OAuth2 login dance, and
+# the back-end only checks signatures on the JWT claims).
+#
+# You shoud subclass `WardenOpenidBearer::Strategy` and override the
+# `user_of_claims` protected method if you want `env['warden'].user`
+# to be a “real” user object (instead of just a hash of OIDC claims,
+# which is what happens when using `WardenOpenidBearer::Strategy` directly).
+# If you want your Rails app to support more than one OIDC
+# authentication server, you should also subclass
+# `WardenOpenidBearer::Strategy` and override the `metadata_url` method.
+#
+# This class has a `self.register!` method, which makes things
+# (slightly) easier than calling `Warden::Strategies.add` yourself.
+# See `WardenOpenidBearer::Registerer` for details.
+module WardenOpenidBearer
+  class Strategy < Warden::Strategies::Base
+    include WardenOpenidBearer::Registerer # Provides self.register!
+    include WardenOpenidBearer::CacheMixin
+
+    def valid?
+      return if !token
+      # Do the issuer check here, so as to seamlessly support multiple
+      # OIDC issuers inside the same app. If a token is not “for us”,
+      # we want to defer to the other Warden strategy instances in the
+      # stack (one which could typically be another instance of either
+      # WardenOpenidBearer::Strategy, or one of its subclasses); therefore, we
+      # want to return `false` if issuers don't match.
+      untrusted_issuer == config.issuer
+    end
+
+    def authenticate!
+      if (c = claims)
+        success! user_of_claims(c)
+      else
+        # Given that `valid?` did return true previously,
+        # we know the status with precision:
+        fail! "Invalid OIDC bearer token"
+      end
+    rescue JWT::ExpiredSignature
+      fail! "Expired OIDC bearer token"
+    end
+
+    # Overridden to always return false, because we typically *don't*
+    # want persistent sessions for an OpenID-Connect resource server —
+    # Everything we need to know is in the JWT token.
+    def store?
+      false
+    end
+
+    # Made public so that one may tune the `strategy.config.cache_timeout`:
+    def config
+      return @config if @config
+      @config = WardenOpenidBearer::DiscoveredConfig.new(metadata_url)
+      @config.cache_timeout = cache_timeout
+      @config
+    end
+
+    protected
+
+    # Dummy implementation for applications that don't really care
+    # about `env['warden'].user` being an object (or at all). Override
+    # in a subclass if you do care.
+    def user_of_claims(claims)
+      claims
+    end
+
+    # Returns the URL of the OIDC metadata for the authentication server,
+    # which typically ends with `/.well-known/openid-configuration`
+    #
+    # The default implementation obeys the `.openid_metadata_url`
+    # setting, as set in a `WardenOpenidBearer.configure` block. Override
+    # in a subclass if you don't want all your OIDC claims to be
+    # checked against one and the same authentication server. (If you
+    # want to support two authentication servers, for instance, you
+    # should have two subclasses.)
+    def metadata_url
+      WardenOpenidBearer.config.openid_metadata_url
+    end
+
+    # Returns the cache timeout for the security data obtained from
+    # the authentication server.
+    #
+    # The default implementation uses a global configuration. Like
+    # `metadata_url`, you should override this in multiple subclasses
+    # if you want multiple OpenID authentication servers.
+    def cache_timeout
+      WardenOpenidBearer.config.cache_timeout
+    end
+
+    # Returns the JWT token from `request.headers['Authorization']`
+    # (which may or may not be valid)
+    def token
+      # We call this one quite a lot, so we want some caching. Also,
+      # it so happens that Warden only constructs a single instance of
+      # this class and re-uses it across requests (see
+      # `_fetch_strategy` in `lib/warden/proxy.rb`).
+      cached_by(request) do
+        puts request.headers
+        strategy, token = (request.headers["Authorization"] || "").split(" ")
+        token if (strategy || "").downcase == "bearer"
+      end
+    end
+
+    # Returns the JWT claims, only if the cryptographic signature and
+    # other security requirements (in particular, the expiration
+    # timestamp) check out.
+    def claims
+      JWT.decode(token, nil, true, jwt_decode_opts).first
+    end
+
+    def jwt_decode_opts
+      # Note: issuer check was already done in `valid?`, see
+      # explanations there; skip it here.
+      {
+        algorithm: algorithm,
+        verify_expiration: true,
+        verify_not_before: true,
+        verify_iat: true,
+        jwks: config.jwks
+      }
+    end
+
+    def algorithm
+      return untrusted_algorithm if
+          config.authorization_algs.member? untrusted_algorithm
+    end
+
+    def untrusted_fields
+      JWT.decode(token, nil, false)
+    end
+
+    def untrusted_algorithm
+      untrusted_fields.last["alg"]
+    end
+
+    def untrusted_issuer
+      untrusted_fields.first["iss"]
+    end
+  end
+end

data/lib/warden_openid_bearer/version.rb

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

data/lib/warden_openid_bearer.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "dry/configurable"
+
+require_relative "warden_openid_bearer/version"
+require_relative "warden_openid_bearer/registerer"
+require_relative "warden_openid_bearer/cache_mixin"
+require_relative "warden_openid_bearer/discovered_config"
+require_relative "warden_openid_bearer/strategy"
+
+module WardenOpenidBearer
+  extend Dry::Configurable
+
+  setting :openid_metadata_url, constructor: ->(url) { URI(url) }
+  setting :cache_timeout, default: 900
+end

data/sig/warden_openid_bearer.rbs

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

data/warden_openid_bearer.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative "lib/warden_openid_bearer/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "warden_openid_bearer"
+  spec.version = WardenOpenidBearer::VERSION
+  spec.authors = ["Dominique Quatravaux"]
+  spec.email = ["dominique.quatravaux@epfl.ch"]
+
+  spec.summary = "Warden strategy to validate OpenID-Connect bearer tokens"
+  spec.description = <<~END_DESCRIPTION
+
+    This gem is like the `warden_openid_auth` gem, except that it only
+    provides support for the very last step of the OAuth code flow, i.e.
+    when the resource server / relying party (your Ruby Web app)
+    validates and decodes the JWT token.
+
+    Use this gem if your client-side Web (or mobile) app will be taking
+    care of the rest of the OAuth2 motions, such as redirecting (or
+    opening a popup window) to the authentication server at login time,
+    managing and refreshing tokens, doing all these unspeakable things
+    with iframes, etc.
+
+  END_DESCRIPTION
+  spec.homepage = "https://github.com/epfl-si/warden_openid_bearer"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+  spec.metadata["my_side_project_has_a_side_project"] = "https://github.com/epfl-si/rails.starterkit"
+
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "warden", "~> 1.2.0"
+  spec.add_dependency "dry-configurable", "~> 0.15.0"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: warden_openid_bearer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dominique Quatravaux
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: warden
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+description: |2+
+
+  This gem is like the `warden_openid_auth` gem, except that it only
+  provides support for the very last step of the OAuth code flow, i.e.
+  when the resource server / relying party (your Ruby Web app)
+  validates and decodes the JWT token.
+
+  Use this gem if your client-side Web (or mobile) app will be taking
+  care of the rest of the OAuth2 motions, such as redirecting (or
+  opening a popup window) to the authentication server at login time,
+  managing and refreshing tokens, doing all these unspeakable things
+  with iframes, etc.
+
+email:
+- dominique.quatravaux@epfl.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/warden_openid_bearer.rb
+- lib/warden_openid_bearer/cache_mixin.rb
+- lib/warden_openid_bearer/discovered_config.rb
+- lib/warden_openid_bearer/registerer.rb
+- lib/warden_openid_bearer/strategy.rb
+- lib/warden_openid_bearer/version.rb
+- sig/warden_openid_bearer.rbs
+- warden_openid_bearer.gemspec
+homepage: https://github.com/epfl-si/warden_openid_bearer
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/epfl-si/warden_openid_bearer
+  source_code_uri: https://github.com/epfl-si/warden_openid_bearer
+  changelog_uri: https://github.com/epfl-si/warden_openid_bearer/blob/master/CHANGELOG.md
+  my_side_project_has_a_side_project: https://github.com/epfl-si/rails.starterkit
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.11
+signing_key:
+specification_version: 4
+summary: Warden strategy to validate OpenID-Connect bearer tokens
+test_files: []
+...