mauth-client 6.1.1 → 6.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 902839b0bccce8c448cea26ff7e83788858f71b3906974a4c3bba27817271f21
-  data.tar.gz: 64f2fc3fb6f213099c4b8d657754e1c440ea610fe02b90c20c22794fe14b46dd
+  metadata.gz: be045713042cd9a25e7b0219d959c1208c66b700c8a113130d7865d91e17db7d
+  data.tar.gz: 155e903f0fa2fafabf2167c9d908398259ec2c9336b7f953bda83efe13667559
 SHA512:
-  metadata.gz: 6e4422f2ea53a1b36506a0544cd62dc3ab37fee032acda93e81d2ef364eb924059f905db7ea08196c4229009f742d405c22c0c069807534570dd09e5d3e85ae7
-  data.tar.gz: 56a0f91951fbaba3923291e51240caf53ec91037b200878f29af6a4412c88f9b087cfab9b325a13a22fd8b1fd71389748dab204c80142461a82aa0c78cb9cad6
+  metadata.gz: 8c97d131c0f9aef554ab5ebb7fd06193ec50a50f7a81fc93a184ba30b5b91bf870c560a06ce9c5dfeb19dab7cb7410c771b355fbbfb1055e56327147c32c5a6a
+  data.tar.gz: 446f8d0a681376361e3b9eabd86b20f3bfe2d28bdb028edf0b78c6e21f9222a7eaed5de3ba4fecd5afa95059698a14f6f4aaeba083d31ff5c55f618b9cbcdb12

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "spec/fixtures/mauth-protocol-test-suite"]
+	path = spec/fixtures/mauth-protocol-test-suite
+	url = https://github.com/mdsol/mauth-protocol-test-suite.git

data/.rspec

@@ -1,2 +1 @@
 --color
---tag ~protocol_suite

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## v6.2.0
+* Drop legacy security token expiry in favor of honoring server cache headers via Faraday HTTP Cache Middleware.
+
 ## v6.1.1
 * Replace `URI.escape` with `CGI.escape` in SecurityTokenCacher to suppress "URI.escape is obsolete" warning.
 

data/CONTRIBUTING.md

@@ -1,5 +1,22 @@
 # Contributing
 
+## Cloning the Repo
+
+This repo contains the submodule `mauth-protocol-test-suite` so requires a flag when initially cloning in order to clone and init submodules.
+
+```
+git clone --recurse-submodules git@github.com:mdsol/mauth-client-ruby.git
+```
+
+If you have already cloned a version of this repo before the submodule was introduced in version 6.1.2 then run
+
+```
+cd spec/fixtures/mauth-protocol-test-suite
+git submodule update --init
+```
+
+to init the submodule.
+
 ## General Information
 
 * Check out the latest develop to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
@@ -19,14 +36,6 @@ Next, run the tests:
 bundle exec rspec
 ```
 
-# Running mauth-protocol-test-suite
-
-To run the mauth-protocol-test-suite clone the latest test suite onto your machine and place it in the same parent directory as this repo (or supply the ENV var `TEST_SUITE_RELATIVE_PATH` with the path to the test suite relative to this repo). Then run:
-
-```
-bundle exec rspec --tag protocol_suite
-```
-
 ## Running Benchmark
 
 If you make changes which could affect performance, please run the benchmark before and after the change as a sanity check.

data/doc/implementations.md

@@ -4,8 +4,7 @@
 - Clojure: [clojure-mauth-client](https://github.com/mdsol/clojure-mauth-client)
 - Go: [go-mauth-client](https://github.com/mdsol/go-mauth-client)
 - Java: [mauth-jvm-clients](https://github.com/mdsol/mauth-jvm-clients)
-- Python:
-  - [requests-mauth](https://github.com/mdsol/requests-mauth)
-  - [flask-mauth](https://github.com/mdsol/flask-mauth)
+- Python: [mauth-client-python](https://github.com/mdsol/mauth-client-python)
 - R: [RMauthClient](https://github.com/mdsol/RMauthClient)
 - Ruby: [mauth-client-ruby](https://github.com/mdsol/mauth-client-ruby)
+- Rust: [mauth-client-rust](https://github.com/mdsol/mauth-client-rust)

data/lib/mauth/client/security_token_cacher.rb

@@ -1,15 +1,11 @@
+require 'faraday-http-cache'
+require 'oj'
+
 module MAuth
   class Client
     module LocalAuthenticator
       class SecurityTokenCacher
 
-        class ExpirableSecurityToken < Struct.new(:security_token, :create_time)
-          CACHE_LIFE = 60
-          def expired?
-            create_time + CACHE_LIFE < Time.now
-          end
-        end
-
         def initialize(mauth_client)
           @mauth_client = mauth_client
           # TODO: should this be UnableToSignError?
@@ -20,7 +16,7 @@ module MAuth
         end
 
         def get(app_uuid)
-          if !@cache[app_uuid] || @cache[app_uuid].expired?
+          if !@cache[app_uuid]
             # url-encode the app_uuid to prevent trickery like escaping upward with ../../ in a malicious
             # app_uuid - probably not exploitable, but this is the right way to do it anyway.
             url_encoded_app_uuid = CGI.escape(app_uuid)
@@ -32,15 +28,8 @@ module MAuth
               raise UnableToAuthenticateError, msg
             end
             if response.status == 200
-              begin
-                security_token = JSON.parse(response.body)
-              rescue JSON::ParserError => e
-                msg =  "mAuth service responded with unparseable json: #{response.body}\n#{e.class}: #{e.message}"
-                @mauth_client.logger.error("Unable to authenticate with MAuth. Exception #{msg}")
-                raise UnableToAuthenticateError, msg
-              end
               @cache_write_lock.synchronize do
-                @cache[app_uuid] = ExpirableSecurityToken.new(security_token, Time.now)
+                @cache[app_uuid] = security_token_from(response.body)
               end
             elsif response.status == 404
               # signing with a key mAuth doesn't know about is considered inauthentic
@@ -49,11 +38,19 @@ module MAuth
               @mauth_client.send(:mauth_service_response_error, response)
             end
           end
-          @cache[app_uuid].security_token
+          @cache[app_uuid]
         end
 
         private
 
+        def security_token_from(response_body)
+          JSON.parse response_body
+        rescue JSON::ParserError => e
+          msg =  "mAuth service responded with unparseable json: #{response_body}\n#{e.class}: #{e.message}"
+          @mauth_client.logger.error("Unable to authenticate with MAuth. Exception #{msg}")
+          raise UnableToAuthenticateError, msg
+        end
+
         def signed_mauth_connection
           require 'faraday'
           require 'mauth/faraday'
@@ -61,6 +58,7 @@ module MAuth
           @signed_mauth_connection ||= ::Faraday.new(@mauth_client.mauth_baseurl, @mauth_client.faraday_options) do |builder|
             builder.use MAuth::Faraday::MAuthClientUserAgent
             builder.use MAuth::Faraday::RequestSigner, 'mauth_client' => @mauth_client
+            builder.use :http_cache, serializer: Oj, logger: MAuth::Client.new.logger, shared_cache: false
             builder.adapter ::Faraday.default_adapter
           end
         end

data/lib/mauth/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MAuth
-  VERSION = '6.1.1'
+  VERSION = '6.2.0'
 end

data/mauth-client.gemspec

@@ -20,6 +20,8 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'faraday', '>= 0.9', '< 2.0'
   spec.add_dependency 'faraday_middleware', '>= 0.9', '< 2.0'
+  spec.add_dependency 'faraday-http-cache', '>= 2.0', '< 3.0'
+  spec.add_dependency 'oj', '~> 3.0'
   spec.add_dependency 'term-ansicolor', '~> 1.0'
   spec.add_dependency 'coderay', '~> 1.0'
   spec.add_dependency 'rack'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mauth-client
 version: !ruby/object:Gem::Version
-  version: 6.1.1
+  version: 6.2.0
 platform: ruby
 authors:
 - Matthew Szenher
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-15 00:00:00.000000000 Z
+date: 2021-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -53,6 +53,40 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-http-cache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
   requirement: !ruby/object:Gem::Requirement
@@ -268,6 +302,7 @@ extra_rdoc_files: []
 files:
 - ".fossa.yml"
 - ".gitignore"
+- ".gitmodules"
 - ".rspec"
 - ".travis.yml"
 - ".yardopts"