jwk-loader 0.1.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95cc2cfa71f70b65862e3be731568a8f935934ed814f45d282eed64c713e5e71
-  data.tar.gz: 3d9d2ba513abc82c1a8f356287622829b784b3e4fa89746cf517c036301c905c
+  metadata.gz: e77eb1ce66789b0d37f9d200ae80d5af43b7de7745f00bfe0548b87301120c79
+  data.tar.gz: 5d71e2e2cc5f4caa96b076c7528e03e6e257e306176f935e2683d3781cb1f8db
 SHA512:
-  metadata.gz: d8cb52c884a168816011173d453f0567c023f17e78f10badd5da583fbf4af6445723d434d7a77ee6d0f51bd645a6f2eaf4a9019646a0f568403a7286f4d03819
-  data.tar.gz: 76b90c92b4af19b21aa1ddd07d9e7b300042f3521301094b00576aee491fe602e7e70e9a6dd2ed166a1b2f50b5f0ceb0f21bfee3bb8433ee965d4e4e08067f64
+  metadata.gz: c3d808d24e6c331db89d5cd8cad4bce5ce94e36e9d8ad99c2a18588bcb8043416b04239da6a0b899d4c193591e6736cee0198358bbb5abc163b007251e445397
+  data.tar.gz: 025ce184c452c2d8dcf632ee823d98e215a80c011db6d75bd253d44ad4a66e8a4f95dd1eb013fd2fdb51a6dbc1540ea59fbaef931e8239a8b18951da327b86f1

data/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "1.1.0"
+}

data/.rubocop.yml

@@ -17,6 +17,7 @@ Layout/LineLength:
 Naming/FileName:
   Exclude:
     - 'lib/jwk-loader.rb'
+    - 'spec/jwk-loader_spec.rb'
 
 Metrics/BlockLength:
   Exclude:

data/CHANGELOG.md

@@ -1,9 +1,21 @@
-## [Unreleased]
+# Changelog
 
-## [0.1.1] - 2022-08-26
+## [1.1.0](https://github.com/anakinj/jwk-loader/compare/v1.0.0...v1.1.0) (2024-08-10)
 
-- make sure 'net/http' is required [#1](https://github.com/anakinj/jwk-loader/pull/2) ([@lukad](https://github.com/lukad)).
 
-## [0.1.0] - 2022-07-06
+### Features
 
-- Initial release
+* Official support for Ruby 3.2 and 3.3 ([2f6079f](https://github.com/anakinj/jwk-loader/commit/2f6079fd490a4918524974ffb1d897abbf875787))
+
+## [1.0.0](https://github.com/anakinj/jwk-loader/compare/v0.1.1...v1.0.0) (2023-12-28)
+
+### Features
+
+- `jwk_loader/test` for convenience for testing without external dependencies. [#6](https://github.com/anakinj/jwk-loader/pull/6) ([@anakinj](https://github.com/anakinj))
+- Serialize the cached key sets into `JWT::JWK:Set` to avoid generating OpenSSL PKeys for each time the keys are used. [#6](https://github.com/anakinj/jwk-loader/pull/6) ([@anakinj](https://github.com/anakinj))
+
+## [1.0.0](https://github.com/anakinj/jwk-loader/compare/v0.1.0...v0.1.1) (2022-08-26)
+
+### Fixes
+
+- make sure 'net/http' is required [#2](https://github.com/anakinj/jwk-loader/pull/2) ([@lukad](https://github.com/lukad)).

data/Gemfile

@@ -2,14 +2,11 @@
 
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in jwk-loader.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
-gem "rspec", "~> 3.0"
-gem "rubocop", "~> 1.32.0"
+gem "rake"
+gem "rspec"
+gem "rubocop"
 gem "simplecov"
 gem "vcr"
 gem "webmock"
-
-gem "jwt"

data/README.md

@@ -1,6 +1,9 @@
-# JwkLoader
+# jwk-loader
 
-This gem can be used in combination with the [jwt](https://rubygems.org/gems/jwt) gem as the mechanism to load and cache the JWKs in the application.
+[![Gem Version](https://badge.fury.io/rb/jwk-loader.svg)](https://badge.fury.io/rb/jwk-loader)
+[![Build status](https://github.com/anakinj/jwk-loader/actions/workflows/test.yml/badge.svg)](https://github.com/anakinj/jwk-loader/actions/workflows/test.yml)
+
+This gem can be used in combination with the [ruby-jwt](https://rubygems.org/gems/jwt) gem as the mechanism to load and cache the JWKs.
 
 ## Installation
 
@@ -16,16 +19,56 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ### Using as a jwks loader when decoding JWT tokens
 
-```
+```ruby
 require "jwt"
 require "jwk-loader"
 
 JWT.decode(token, nil, true, algorithm: "RS512", jwks: JwkLoader.for_uri(uri: "https://url/to/public/jwks") )
 ```
 
+### Testing endpoints protected by JWT tokens
+
+When testing HTTP endpoints protected by asymmetric JWT keys the mechanism in `jwk_loader/test` can be used to simplify the process.
+
+```ruby
+require 'jwk_loader/test'
+
+RSpec.describe 'GET /protected' do
+  include JwkLoader::Test
+
+  context 'when called with a valid token' do
+    let(:token) { sign_test_token(token_payload: { user_id: "user" }, jwk_endpoint: "https://url/to/public/jwks") }
+    subject(:response) { get('/protected', { 'HTTP_AUTHORIZATION' => "Bearer #{token}" }) }
+
+    it 'is a success' do
+      expect(response.status).to eq(200)
+    end
+  end
+end
+```
+
 ### Configuring the gem
 
-TODO: Will probably be implemented at some point
+```ruby
+require "jwt-loader"
+
+JwkLoader.configure do |config|
+  config[:cache] = YetAnotherCache.new
+  config[:cache_grace_period] = 999
+end
+```
+
+or in alternative
+
+```ruby
+require "jwt-loader"
+
+JwkLoader.configure do |config|
+  config.cache = YetAnotherCache.new
+  config.cache_grace_period = 999
+end
+```
+
 
 ## Development
 

data/jwk-loader.gemspec

@@ -32,4 +32,5 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
   spec.add_dependency "concurrent-ruby"
+  spec.add_dependency "jwt", "~> 2.6"
 end

data/lib/jwk-loader.rb

@@ -5,9 +5,37 @@ require_relative "jwk_loader/jwks"
 require_relative "jwk_loader/jwks_uri_provider"
 require_relative "jwk_loader/memory_cache"
 require_relative "jwk_loader/error"
+require_relative "jwk_loader/config/config"
 
 module JwkLoader
-  def self.for_uri(**options)
-    JwksUriProvider.new(**options)
+  class << self
+    def for_uri(**options)
+      options[:cache] ||= config[:cache]
+      options[:cache_grace_period] ||= config[:cache_grace_period]
+      JwksUriProvider.new(**options)
+    end
+
+    def cache
+      config[:cache]
+    end
+
+    def configure
+      yield config
+    end
+
+    def config
+      @config ||= JwkLoader::Config.new.tap do |cfg|
+        cfg[:cache] = MemoryCache.new
+        cfg[:cache_grace_period] = 900
+      end
+    end
+
+    def reset!
+      @config = nil
+    end
+
+    def memory_store
+      @memory_store ||= MemoryCache.new
+    end
   end
 end

data/lib/jwk_loader/config/config.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module JwkLoader
+  class Config
+    class ConfigurationNotFound < JwkLoader::Error
+      def initialize(key)
+        super("Configuration for #{key} not available")
+      end
+    end
+
+    def []=(key, value)
+      registry[key] = value
+    end
+
+    def [](key)
+      registry[key] || (raise ConfigurationNotFound, key)
+    end
+
+    def method_missing(name, *args)
+      return send(:[]=, name.to_s[0..-2].to_sym, *args) if name.to_s.end_with?("=")
+
+      send(:[], name, *args)
+    end
+
+    def respond_to_missing?(_name, _include_private)
+      true
+    end
+
+    private
+
+    def registry
+      @registry ||= {}
+    end
+  end
+end

data/lib/jwk_loader/jwks.rb

@@ -14,6 +14,10 @@ module JwkLoader
         from_json(response.body)
       end
 
+      def from_memory(uri)
+        JwkLoader.memory_store.fetch(uri)
+      end
+
       def from_json(jwks_json)
         JSON.parse(jwks_json, symbolize_names: true)
       end

data/lib/jwk_loader/jwks_uri_provider.rb

@@ -1,16 +1,12 @@
 # frozen_string_literal: true
 
 module JwkLoader
-  def self.cache
-    @cache ||= MemoryCache.new
-  end
-
   class JwksUriProvider
     attr_reader :uri, :cache, :cache_grace_period
 
-    def initialize(uri:, cache: JwkLoader.cache, cache_grace_period: 900)
+    def initialize(uri:, cache:, cache_grace_period:)
       @uri          = uri
-      @cache        = cache || MemoryCache.new
+      @cache        = cache
       @cache_grace_period = cache_grace_period
     end
 
@@ -22,7 +18,7 @@ module JwkLoader
     private
 
     def jwks
-      from_cache || from_uri
+      from_cache || from_memory || from_uri
     end
 
     def invalidate_cache!
@@ -35,12 +31,17 @@ module JwkLoader
       cache_entry&.fetch(:jwks)
     end
 
+    def from_memory
+      JwkLoader::Jwks.from_memory(uri)
+    end
+
     def cache_entry
       cache.fetch(uri)
     end
 
     def from_uri
-      JwkLoader::Jwks.from_uri(uri).tap do |jwks|
+      data = JwkLoader::Jwks.from_uri(uri)
+      JWT::JWK::Set.new(data).tap do |jwks|
         cache.store(uri, jwks: jwks, fetched_at: Time.now)
       end
     end

data/lib/jwk_loader/test.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module JwkLoader
+  module Test
+    def generate_signing_key(algorithm:)
+      case algorithm
+      when "RS256", "RS384", "RS512"
+        OpenSSL::PKey::RSA.new(2048)
+      when "ES256"
+        OpenSSL::PKey::EC.generate("prime256v1")
+      else
+        raise "Unsupported algorithm: #{algorithm}"
+      end
+    end
+
+    def test_signing_key_for(jwk_endpoint:, algorithm: "RS512")
+      key_set = JwkLoader.memory_store.fetch(jwk_endpoint)
+
+      if key_set.nil?
+        key_set = JWT::JWK::Set.new([generate_signing_key(algorithm: algorithm)])
+        JwkLoader.memory_store.store(jwk_endpoint, key_set)
+      end
+
+      key_set.first
+    end
+
+    def sign_test_token(token_payload:, jwk_endpoint:, algorithm: "RS512")
+      key = test_signing_key_for(jwk_endpoint: jwk_endpoint, algorithm: algorithm)
+      JWT.encode(token_payload, key.signing_key, algorithm, kid: key[:kid])
+    end
+  end
+end

data/lib/jwk_loader/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JwkLoader
-  VERSION = "0.1.1"
+  VERSION = "1.1.0"
 end

data/release-please-config.json

@@ -0,0 +1,9 @@
+{
+  "release-type": "ruby",
+  "include-v-in-tag": true,
+  "packages": {
+    ".": {
+      "version-file": "lib/jwk_loader/version.rb"
+    }
+  }
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jwk-loader
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Joakim Antman
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-26 00:00:00.000000000 Z
+date: 2024-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -24,13 +24,28 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: 
 email:
 - antmanj@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".release-please-manifest.json"
 - ".rspec"
 - ".rubocop.yml"
 - CHANGELOG.md
@@ -41,11 +56,14 @@ files:
 - Rakefile
 - jwk-loader.gemspec
 - lib/jwk-loader.rb
+- lib/jwk_loader/config/config.rb
 - lib/jwk_loader/error.rb
 - lib/jwk_loader/jwks.rb
 - lib/jwk_loader/jwks_uri_provider.rb
 - lib/jwk_loader/memory_cache.rb
+- lib/jwk_loader/test.rb
 - lib/jwk_loader/version.rb
+- release-please-config.json
 homepage: https://github.com/anakinj/jwk-loader
 licenses:
 - MIT
@@ -53,9 +71,9 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/anakinj/jwk-loader
   source_code_uri: https://github.com/anakinj/jwk-loader
-  changelog_uri: https://github.com/anakinj/jwk-loader/blob/0.1.1/CHANGELOG.md
+  changelog_uri: https://github.com/anakinj/jwk-loader/blob/1.1.0/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -70,8 +88,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.5.11
+signing_key: 
 specification_version: 4
 summary: Tooling for handling JWK loading, parsing and caching
 test_files: []