oauth_im 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8208d820c7e100554ecce30e7059fd4d082679a90875a6345a19cb072c010f2c
-  data.tar.gz: 4210b53980b4d73a75bd4a48ec5318d2369e22e7d3db15253b5d706dd4c46821
+  metadata.gz: 7c32ade2f9c543728b3946076d1f8cad2566f06f4959c20b7c67613b6c296240
+  data.tar.gz: ad6148ef5c4bed447ee4468ef03825a5802b9df3f3a0dd096bda20f4024b803a
 SHA512:
-  metadata.gz: 38d9767641f6b8b691cfc1ceaabac18db7bfdade8f04d4110d669c3c5b48f9e0a501931c859650d7976f458225233e97eb475f92b8dcb2ca9b2b66488c596cfc
-  data.tar.gz: 2ed159a29e9164d3aec610e20559a65fe6386e065945b942f7b1dded21a4aac0bc7f38ac2333b2a0a529134273286700dff636a65ba75518ee1586cd677ff0cb
+  metadata.gz: 4824f3121b1ee2e24c0f706041c0295335a9efd35317442c5e1c857836224b88713ee61d1d1ae0694d01acd8559ef363ad44047393bb2b00128af96a97b60603
+  data.tar.gz: 656cbad5b4111347e5b0f277fcb99d9ac794fc8defccc1d49cb0637d1971d21f900315ab731f6d3eec16b9606f4b2de2902028d8a6bb8ddc13630a74aa261b78

data/README.md

@@ -46,22 +46,24 @@ module OauthIm
     config.client_id      = ENV['FUSION_AUTH_CLIENT_ID']
     config.client_secret  = ENV['FUSION_AUTH_CLIENT_SECRET']
 
-    #################################################################################
-    # 1. Find signing key name on the app details name.                             #
-    # 2. Look up the key (by name) under Key Master tab under Settings:             #
-    #    https://illustrativemath-dev.fusionauth.io/admin/key/                      #
-    # 3. The key should be either HMAC or RSA.                                      #
-    #   - If HMAC, view the Secret under Details. You will need to click to reveal. #
-    #   - If RSA, copy the PEM encoded public key as-is.                            #
-    # Note: You don't need both keys --- TokenDecoder will use the one available.   #
-    #################################################################################
+    ####################################################################################
+    # 1. Find signing key name on the app details pane. (See RSA v. HMAC screenshots.) #
+    # 2. Look up the key (by name) under Key Master tab under Settings:                #
+    #    https://illustrativemath-dev.fusionauth.io/admin/key/                         #
+    # 3. The key should be either HMAC or RSA.                                         #
+    #   - If HMAC, view the Secret under Details. You will need to click to reveal.    #
+    #   - If RSA, copy the PEM encoded public key as-is.                               #
+    # Note: You don't need both keys --- TokenDecoder will use the one available.      #
+    ####################################################################################
     config.hmac           = ENV['FUSION_AUTH_HMAC']
     config.rsa_public     = ENV['FUSION_AUTH_RSA_PUBLIC]
   end
 end
 ```
 
-* The `ENV` variable values can be obtained from the OAuth provider.
+### Environment
+
+The `ENV` variable values can be obtained from the OAuth provider.
 * Here is [an article at FusionAuth](https://fusionauth.io/blog/2020/12/14/how-to-securely-implement-oauth-rails) describing many of these settings.
 * The `callback_route` setting is used in two related ways:
   * It [defines a route](https://github.com/illustrativemathematics/oauth_im/blob/main/config/routes.rb#L4) to the [`OAuthIm::ClientController#callback`
@@ -75,7 +77,30 @@ end
     must be entered in the OAuth provider's list of authorized
     redirect URLs.
 
+### RSA v. HMAC
+
+To determine the access token signing key, find the name of the key and then look it up
+on the Settings|Key Master pane. (See screenshots.)
+
+* Inspect your app settings. The screenshot shows this being done for the app
+  `Kendall Hunt - Terraform`.
+
+  ![app settings](./docs/images/fa-app-settings.png?raw=true)
+
+* Find the name of the token. The screenshot shows this being done for the app
+  `Kendall Hunt - Terraform`. You will need to scroll down the page to the `JWT` section.
+
+  ![token name](./docs/images/fa-signing-key-name.png?raw=true)
+
+* Look up this signing token under Home|Settings|Key Master. The screenshot shows this being done
+  for the signing token `KendallHunt-Terraform (12)`.
+  * For RSA tokens like this one, use the PEM encoded public key as-is.
+  * For HMAC tokens, view the secret under Details (click to reveal).
+
+  ![token name](./docs/images/fa-access-token.png?raw=true)
+
 ## Usage
+
 ### Helpers for Logging in and Out
 The engine provides [two endpoints](https://github.com/illustrativemathematics/oauth_im/blob/main/config/routes.rb#L5-L6) for logging in and out, and exposes
 corresponding view helpers. These are accessible from the main app as:
@@ -154,6 +179,9 @@ After many false starts, this repo includes two (seemingly functional) github wo
 
 ## Version History
 
+### 0.8.2
+* README
+
 ### 0.8.1
 * Tightened up test environment helpers.
 

data/lib/oauth_im/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OauthIm
-  VERSION = '0.8.1'
+  VERSION = '0.8.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oauth_im
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
 platform: ruby
 authors:
 - Eric Connally
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-26 00:00:00.000000000 Z
+date: 2022-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt