📝 Libraries built on top of the oauth2 gem that implement OIDC

pboling · pboling · commit f4e2ba3239a8 · 2025-08-31T04:15:57.000-06:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - refresh token guidance for public clients,
   - simplified client definitions)
 - document how to implement an OIDC client with this gem in OIDC.md
+  - also, list libraries built on top of the oauth2 gem that implement OIDC
 ### Changed
 ### Deprecated
 ### Removed
diff --git a/OIDC.md b/OIDC.md
@@ -1,6 +1,19 @@
 # OpenID Connect (OIDC) with ruby-oauth/oauth2
 
-This document complements the OAuth 2.1 notes already present in the repository by focusing on OpenID Connect (OIDC) 1.0 usage patterns when using this gem as an OAuth 2.0 client library.
+## OIDC Libraries
+
+Libraries built on top of the oauth2 gem that implement OIDC.
+
+- [gamora](https://github.com/amco/gamora-rb) - OpenID Connect Relying Party for Rails apps
+- [omniauth-doximity-oauth2](https://github.com/doximity/omniauth-doximity-oauth2) - OmniAuth strategy for Doximity, supporting OIDC, and using PKCE
+- [omniauth-himari](https://github.com/sorah/himari) - OmniAuth strategy to act as OIDC RP and use [Himari](https://github.com/sorah/himari) for OP
+- [omniauth-mit-oauth2](https://github.com/MITLibraries/omniauth-mit-oauth2) - OmniAuth strategy for MIT OIDC
+
+If any other libraries would like to be added to this list, please open an issue or pull request.
+
+## Raw OIDC with ruby-oauth/oauth2
+
+This document complements the inline documentation by focusing on OpenID Connect (OIDC) 1.0 usage patterns when using this gem as an OAuth 2.0 client library.
 
 Scope of this document
 - Audience: Developers building an OAuth 2.0/OIDC Relying Party (RP, aka client) in Ruby.
diff --git a/docs/OAuth2.html b/docs/OAuth2.html
@@ -415,7 +415,7 @@ <h3 class="signature first" id="configure-class_method">
 </div>
 
       <div id="footer">
-  Generated on Sun Aug 31 03:59:47 2025 by
+  Generated on Sun Aug 31 04:15:43 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/OAuth2/AccessToken.html b/docs/OAuth2/AccessToken.html
@@ -3069,7 +3069,7 @@ <h3 class="signature " id="to_hash-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Sun Aug 31 03:59:47 2025 by
+  Generated on Sun Aug 31 04:15:43 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/OAuth2/Authenticator.html b/docs/OAuth2/Authenticator.html
@@ -883,7 +883,7 @@ <h3 class="signature first" id="apply-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Sun Aug 31 03:59:47 2025 by
+  Generated on Sun Aug 31 04:15:43 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/OAuth2/Client.html b/docs/OAuth2/Client.html
@@ -2656,7 +2656,7 @@ <h3 class="signature " id="token_url-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Sun Aug 31 03:59:47 2025 by
+  Generated on Sun Aug 31 04:15:43 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/OAuth2/Error.html b/docs/OAuth2/Error.html
@@ -772,7 +772,7 @@ <h3 class="signature " id="response-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Sun Aug 31 03:59:47 2025 by
+  Generated on Sun Aug 31 04:15:43 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/OAuth2/FilteredAttributes.html b/docs/OAuth2/FilteredAttributes.html
@@ -335,7 +335,7 @@ <h3 class="signature first" id="inspect-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Sun Aug 31 03:59:47 2025 by
+  Generated on Sun Aug 31 04:15:43 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/OAuth2/FilteredAttributes/ClassMethods.html b/docs/OAuth2/FilteredAttributes/ClassMethods.html
@@ -280,7 +280,7 @@ <h3 class="signature " id="filtered_attributes-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Sun Aug 31 03:59:47 2025 by
+  Generated on Sun Aug 31 04:15:43 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/OAuth2/Response.html b/docs/OAuth2/Response.html
@@ -1619,7 +1619,7 @@ <h3 class="signature " id="status-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Sun Aug 31 03:59:47 2025 by
+  Generated on Sun Aug 31 04:15:43 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/OAuth2/Strategy.html b/docs/OAuth2/Strategy.html
@@ -107,7 +107,7 @@ <h2>Defined Under Namespace</h2>
 </div>
 
       <div id="footer">
-  Generated on Sun Aug 31 03:59:47 2025 by
+  Generated on Sun Aug 31 04:15:43 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/OAuth2/Strategy/Assertion.html b/docs/OAuth2/Strategy/Assertion.html
@@ -481,7 +481,7 @@ <h3 class="signature " id="get_token-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Sun Aug 31 03:59:48 2025 by
+  Generated on Sun Aug 31 04:15:43 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/OAuth2/Strategy/AuthCode.html b/docs/OAuth2/Strategy/AuthCode.html
@@ -483,7 +483,7 @@ <h3 class="signature " id="get_token-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Sun Aug 31 03:59:48 2025 by
+  Generated on Sun Aug 31 04:15:43 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/OAuth2/Strategy/Base.html b/docs/OAuth2/Strategy/Base.html
@@ -195,7 +195,7 @@ <h3 class="signature first" id="initialize-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Sun Aug 31 03:59:47 2025 by
+  Generated on Sun Aug 31 04:15:43 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/OAuth2/Strategy/ClientCredentials.html b/docs/OAuth2/Strategy/ClientCredentials.html
@@ -343,7 +343,7 @@ <h3 class="signature " id="get_token-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Sun Aug 31 03:59:48 2025 by
+  Generated on Sun Aug 31 04:15:43 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/OAuth2/Strategy/Implicit.html b/docs/OAuth2/Strategy/Implicit.html
@@ -420,7 +420,7 @@ <h3 class="signature " id="get_token-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Sun Aug 31 03:59:47 2025 by
+  Generated on Sun Aug 31 04:15:43 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/OAuth2/Strategy/Password.html b/docs/OAuth2/Strategy/Password.html
@@ -374,7 +374,7 @@ <h3 class="signature " id="get_token-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Sun Aug 31 03:59:48 2025 by
+  Generated on Sun Aug 31 04:15:43 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/OAuth2/Version.html b/docs/OAuth2/Version.html
@@ -111,7 +111,7 @@ <h2>
 </div>
 
       <div id="footer">
-  Generated on Sun Aug 31 03:59:47 2025 by
+  Generated on Sun Aug 31 04:15:43 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/_index.html b/docs/_index.html
@@ -366,7 +366,7 @@ <h2>Namespace Listing A-Z</h2>
 </div>
 
       <div id="footer">
-  Generated on Sun Aug 31 03:59:46 2025 by
+  Generated on Sun Aug 31 04:15:42 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/file.CHANGELOG.html b/docs/file.CHANGELOG.html
@@ -78,11 +78,15 @@ <h3 id="added">Added</h3>
     </ul>
   </li>
   <li>document how to implement an OIDC client with this gem in OIDC.md
-    <h3 id="changed">Changed</h3>
-    <h3 id="deprecated">Deprecated</h3>
-    <h3 id="removed">Removed</h3>
-    <h3 id="fixed">Fixed</h3>
-    <h3 id="security">Security</h3>
+    <ul>
+      <li>also, list libraries built on top of the oauth2 gem that implement OIDC
+        <h3 id="changed">Changed</h3>
+        <h3 id="deprecated">Deprecated</h3>
+        <h3 id="removed">Removed</h3>
+        <h3 id="fixed">Fixed</h3>
+        <h3 id="security">Security</h3>
+      </li>
+    </ul>
   </li>
 </ul>
 
@@ -1240,7 +1244,7 @@ <h2 id="001---2010-04-22">
 </div></div>
 
       <div id="footer">
-  Generated on Sun Aug 31 03:59:47 2025 by
+  Generated on Sun Aug 31 04:15:42 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/file.CITATION.html b/docs/file.CITATION.html
@@ -82,7 +82,7 @@
 </div></div>
 
       <div id="footer">
-  Generated on Sun Aug 31 03:59:47 2025 by
+  Generated on Sun Aug 31 04:15:42 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/file.CODE_OF_CONDUCT.html b/docs/file.CODE_OF_CONDUCT.html
@@ -191,7 +191,7 @@ <h2 id="attribution">Attribution</h2>
 </div></div>
 
       <div id="footer">
-  Generated on Sun Aug 31 03:59:47 2025 by
+  Generated on Sun Aug 31 04:15:42 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/file.CONTRIBUTING.html b/docs/file.CONTRIBUTING.html
@@ -274,7 +274,7 @@ <h4 id="manual-process">Manual process</h4>
 </div></div>
 
       <div id="footer">
-  Generated on Sun Aug 31 03:59:47 2025 by
+  Generated on Sun Aug 31 04:15:42 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/file.FUNDING.html b/docs/file.FUNDING.html
@@ -104,7 +104,7 @@ <h1 id="another-way-to-support-open-source-software">Another Way to Support Open
 </div></div>
 
       <div id="footer">
-  Generated on Sun Aug 31 03:59:47 2025 by
+  Generated on Sun Aug 31 04:15:42 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/file.LICENSE.html b/docs/file.LICENSE.html
@@ -60,7 +60,7 @@
       <div id="content"><div id='filecontents'>MIT License<br><br>Copyright (c) 2017-2025 Peter H. Boling, of Galtzo.com, and oauth2 contributors<br>Copyright (c) 2011-2013 Michael Bleigh and Intridea, Inc.<br><br>Permission is hereby granted, free of charge, to any person obtaining a copy<br>of this software and associated documentation files (the "Software"), to deal<br>in the Software without restriction, including without limitation the rights<br>to use, copy, modify, merge, publish, distribute, sublicense, and/or sell<br>copies of the Software, and to permit persons to whom the Software is<br>furnished to do so, subject to the following conditions:<br><br>The above copyright notice and this permission notice shall be included in all<br>copies or substantial portions of the Software.<br><br>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR<br>IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,<br>FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE<br>AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER<br>LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,<br>OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE<br>SOFTWARE.</div></div>
 
       <div id="footer">
-  Generated on Sun Aug 31 03:59:47 2025 by
+  Generated on Sun Aug 31 04:15:42 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/file.OIDC.html b/docs/file.OIDC.html
@@ -59,7 +59,26 @@
 
       <div id="content"><div id='filecontents'><h1 id="openid-connect-oidc-with-ruby-oauthoauth2">OpenID Connect (OIDC) with ruby-oauth/oauth2</h1>
 
-<p>This document complements the OAuth 2.1 notes already present in the repository by focusing on OpenID Connect (OIDC) 1.0 usage patterns when using this gem as an OAuth 2.0 client library.</p>
+<h2 id="oidc-libraries">OIDC Libraries</h2>
+
+<p>Libraries built on top of the oauth2 gem that implement OIDC.</p>
+
+<ul>
+  <li>
+<a href="https://github.com/amco/gamora-rb">gamora</a> - OpenID Connect Relying Party for Rails apps</li>
+  <li>
+<a href="https://github.com/doximity/omniauth-doximity-oauth2">omniauth-doximity-oauth2</a> - OmniAuth strategy for Doximity, supporting OIDC, and using PKCE</li>
+  <li>
+<a href="https://github.com/sorah/himari">omniauth-himari</a> - OmniAuth strategy to act as OIDC RP and use <a href="https://github.com/sorah/himari">Himari</a> for OP</li>
+  <li>
+<a href="https://github.com/MITLibraries/omniauth-mit-oauth2">omniauth-mit-oauth2</a> - OmniAuth strategy for MIT OIDC</li>
+</ul>
+
+<p>If any other libraries would like to be added to this list, please open an issue or pull request.</p>
+
+<h2 id="raw-oidc-with-ruby-oauthoauth2">Raw OIDC with ruby-oauth/oauth2</h2>
+
+<p>This document complements the inline documentation by focusing on OpenID Connect (OIDC) 1.0 usage patterns when using this gem as an OAuth 2.0 client library.</p>
 
 <p>Scope of this document</p>
 <ul>
@@ -228,7 +247,7 @@
 </div></div>
 
       <div id="footer">
-  Generated on Sun Aug 31 03:59:47 2025 by
+  Generated on Sun Aug 31 04:15:42 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/file.README.html b/docs/file.README.html
@@ -1327,7 +1327,7 @@ <h3 id="please-give-the-project-a-star--">Please give the project a star ⭐ ♥
 </div></div>
 
       <div id="footer">
-  Generated on Sun Aug 31 03:59:47 2025 by
+  Generated on Sun Aug 31 04:15:42 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/file.REEK.html b/docs/file.REEK.html
@@ -61,7 +61,7 @@
 </div></div>
 
       <div id="footer">
-  Generated on Sun Aug 31 03:59:47 2025 by
+  Generated on Sun Aug 31 04:15:42 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/file.RUBOCOP.html b/docs/file.RUBOCOP.html
@@ -161,7 +161,7 @@ <h2 id="benefits-of-rubocop_gradual">Benefits of rubocop_gradual</h2>
 </div></div>
 
       <div id="footer">
-  Generated on Sun Aug 31 03:59:47 2025 by
+  Generated on Sun Aug 31 04:15:42 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/file.SECURITY.html b/docs/file.SECURITY.html
@@ -113,7 +113,7 @@ <h2 id="enterprise-support">Enterprise Support</h2>
 </div></div>
 
       <div id="footer">
-  Generated on Sun Aug 31 03:59:47 2025 by
+  Generated on Sun Aug 31 04:15:42 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/file.access_token.html b/docs/file.access_token.html
@@ -84,7 +84,7 @@
 </div></div>
 
       <div id="footer">
-  Generated on Sun Aug 31 03:59:47 2025 by
+  Generated on Sun Aug 31 04:15:42 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/file.authenticator.html b/docs/file.authenticator.html
@@ -81,7 +81,7 @@
 </div></div>
 
       <div id="footer">
-  Generated on Sun Aug 31 03:59:47 2025 by
+  Generated on Sun Aug 31 04:15:42 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/file.client.html b/docs/file.client.html
@@ -111,7 +111,7 @@
 </div></div>
 
       <div id="footer">
-  Generated on Sun Aug 31 03:59:47 2025 by
+  Generated on Sun Aug 31 04:15:42 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/file.error.html b/docs/file.error.html
@@ -68,7 +68,7 @@
 </div></div>
 
       <div id="footer">
-  Generated on Sun Aug 31 03:59:47 2025 by
+  Generated on Sun Aug 31 04:15:42 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/file.filtered_attributes.html b/docs/file.filtered_attributes.html
@@ -66,7 +66,7 @@
 </div></div>
 
       <div id="footer">
-  Generated on Sun Aug 31 03:59:47 2025 by
+  Generated on Sun Aug 31 04:15:42 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/file.oauth2-2.0.10.gem.html b/docs/file.oauth2-2.0.10.gem.html
@@ -61,7 +61,7 @@
 </div></div>
 
       <div id="footer">
-  Generated on Sun Aug 31 03:59:47 2025 by
+  Generated on Sun Aug 31 04:15:42 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/file.oauth2-2.0.11.gem.html b/docs/file.oauth2-2.0.11.gem.html
@@ -61,7 +61,7 @@
 </div></div>
 
       <div id="footer">
-  Generated on Sun Aug 31 03:59:47 2025 by
+  Generated on Sun Aug 31 04:15:42 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/file.oauth2-2.0.12.gem.html b/docs/file.oauth2-2.0.12.gem.html
diff --git a/docs/file.oauth2-2.0.13.gem.html b/docs/file.oauth2-2.0.13.gem.html
diff --git a/docs/file.oauth2.html b/docs/file.oauth2.html
diff --git a/docs/file.response.html b/docs/file.response.html
diff --git a/docs/file.strategy.html b/docs/file.strategy.html
diff --git a/docs/file.version.html b/docs/file.version.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/top-level-namespace.html b/docs/top-level-namespace.html
