🫵 OmniAuth::OpenID

if ci_badges.map(&:color).detect { it != "green"} ☝️ let me know on Discord or RubyForum, as I may have missed the notification.

---

if ci_badges.map(&:color).all? { it == "green"} 👇️ send money so I can do more of this. FLOSS maintenance is now my full-time job.

👣 How will this project approach the September 2025 hostile takeover of RubyGems? 🚑️

I've summarized my thoughts in this blog post.

🌻 Synopsis

omniauth-openid is the legacy OpenID strategy for OmniAuth. It delegates discovery, redirects, and response verification to rack-openid and ruby-openid, then exposes the verified identifier as the OmniAuth UID and maps SReg and Attribute Exchange values into the auth hash.

This is OpenID 1.x/2.0 support, not OpenID Connect (OIDC). Use it when an application still needs to authenticate against an OpenID 2.0 provider.

💡 Info you can shake a stick at

Tokens to Remember
Works with JRuby
Works with Truffle Ruby
Works with MRI Ruby 4
Works with MRI Ruby 3
Works with MRI Ruby 2
Support & Community
Source
Documentation
Compliance
Style
Maintainer 🎖️
... 💖	🧊 🐙 🛖 🧪

Compatibility

Compatible with MRI Ruby 2.4.0+, and concordant releases of JRuby, and TruffleRuby. CI workflows and Appraisals are generated for MRI Ruby 2.4+. This test floor is configured by ruby.test_minimum in .kettle-jem.yml and may be higher than the gem's runtime compatibility floor when legacy Rubies are not practical for the current toolchain.

The amazing test matrix is powered by the kettle-dev stack.

How kettle-dev manages complexity in tests

Gem	Source	Role	Total downloads
appraisal2	GitHub	multi-dependency Appraisal matrix generation
appraisal2-rubocop	GitHub	RuboCop Appraisal generator integration
kettle-dev	GitHub	development, release, and CI workflow tooling
kettle-jem	GitHub	Appraisals & CI workflow templates
kettle-soup-cover	GitHub	SimpleCov coverage policy and reporting
kettle-test	GitHub	standard test runner and coverage harness
rubocop-lts	GitHub	Ruby-version-aware linting
turbo_tests2	GitHub	parallel test execution

Federated DVCS

Find this repo on federated forges (Coming soon!)

Federated DVCS Repository	Status	Issues	PRs	Wiki	CI
🧪 ruby-openid/omniauth-openid on GitLab	The Truth	💚	💚	💚	🐭 Tiny Matrix
🧊 ruby-openid/omniauth-openid on CodeBerg	An Ethical Mirror (Donate)	💚	💚	➖	⭕️ No Matrix
🐙 ruby-openid/omniauth-openid on GitHub	Another Mirror	💚	💚	💚	💯 Full Matrix

Enterprise Support

Available as part of the Tidelift Subscription.

Need enterprise-level guarantees?

The maintainers of this and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use.

• 💡Subscribe for support guarantees covering all your FLOSS dependencies
• 💡Tidelift is part of Sonar
• 💡Tidelift pays maintainers to maintain the software you depend on!
  📊@Pointy Haired Boss: An enterprise support subscription is "never gonna let you down", and supports open source maintainers

Alternatively:

• 
• 
• 
• 

✨ Installation

Install the gem and add to the application's Gemfile by executing:

bundle add omniauth-openid

If bundler is not being used to manage dependencies, install the gem by executing:

gem install omniauth-openid

⚙️ Configuration

Configure the strategy through OmniAuth::Builder, as shown below. A durable OpenID::Store is important in a real deployment: the default memory store is appropriate only for a single process and loses associations and nonce state when the process restarts. OpenID::Store::Filesystem is suitable for a single host; use a shared store implementation for a multi-process or multi-host app.

The strategy accepts these primary options:

Option	Purpose
store	OpenID association and nonce store.
identifier	Fixed provider or identity URL; omit it to ask the user.
identifier_param	Request parameter used for a user-supplied identifier; defaults to openid_url.
required / optional	SReg or AX attributes requested from the provider.
immediate	Request an immediate response instead of allowing provider interaction.
trust_root	Explicit relying-party realm, or a callable that derives one.

🔧 Basic Usage

Use the strategy as application middleware:

require "omniauth-openid"
require "openid/store/filesystem"

use Rack::Session::Cookie
use OmniAuth::Strategies::OpenID, store: OpenID::Store::Filesystem.new("/tmp")

Then simply direct users to /auth/open_id to prompt them for their OpenID identifier. You may also pre-set the identifier by passing an identifier parameter to the URL (Example: /auth/open_id?openid_url=yahoo.com).

A list of all OpenID stores is available at http://github.com/openid/ruby-openid/tree/master/lib/openid/store/

OmniAuth Builder

If OpenID is one of several authentication strategies, use the OmniAuth Builder:

require "omniauth-openid"
require "openid/store/filesystem"

use OmniAuth::Builder do
  provider :open_id, store: OpenID::Store::Filesystem.new("/tmp")
end

Configured Identifiers

You may pre-configure an OpenID identifier. For example, to use Google's main OpenID endpoint:

use OmniAuth::Builder do
  provider :open_id, nil, :name => 'google', :identifier => 'https://www.google.com/accounts/o8/id'
end

Note the use of nil, which will trigger ruby-openid's default Memory Store.

Please contribute some documentation if you have the gumption! The maintainer's time is limited, and sometimes the authors of PRs with new options don't update this readme. 😭

🦷 FLOSS Funding

While ruby-openid tools are free software and will always be, the project would benefit immensely from some funding. Raising a monthly budget of... "dollars" would make the project more sustainable.

We welcome both individual and corporate sponsors! We also offer a wide array of funding channels to account for your preferences. Currently, Open Collective is our preferred funding platform.

If you're working in a company that's making significant use of ruby-openid tools we'd appreciate it if you suggest to your company to become a ruby-openid sponsor.

You can support the development of ruby-openid tools via GitHub Sponsors, Liberapay, PayPal, Open Collective and Tidelift.

📍 NOTE
If doing a sponsorship in the form of donation is problematic for your company from an accounting standpoint, we'd recommend the use of Tidelift, where you can get a support-like subscription instead.

Open Collective for Individuals

Support us with a monthly donation and help us continue our activities. [Become a backer]

NOTE: kettle-readme-backers updates this list every day, automatically.

No backers yet. Be the first!

Open Collective for Organizations

Become a sponsor and get your logo on our README on GitHub with a link to your site. [Become a sponsor]

NOTE: kettle-readme-backers updates this list every day, automatically.

No sponsors yet. Be the first!

Another way to support open-source

I’m driven by a passion to foster a thriving open-source community – a space where people can tackle complex problems, no matter how small. Revitalizing libraries that have fallen into disrepair, and building new libraries focused on solving real-world challenges, are my passions. I was recently affected by layoffs, and the tech jobs market is unwelcoming. I’m reaching out here because your support would significantly aid my efforts to provide for my family, and my farm (11 🐔 chickens, 2 🐶 dogs, 3 🐰 rabbits, 8 🐈‍ cats).

If you work at a company that uses my work, please encourage them to support me as a corporate sponsor. My work on gems you use might show up in bundle fund.

I’m developing a new library, floss_funding, designed to empower open-source developers like myself to get paid for the work we do, in a sustainable way. Please give it a look.

Floss-Funding.dev: 👉️ No network calls. 👉️ No tracking. 👉️ No oversight. 👉️ Minimal crypto hashing. 💡 Easily disabled nags

🔐 Security

See SECURITY.md.

🤝 Contributing

If you need some ideas of where to help, you could work on adding more code coverage, or if it is already 💯 (see below) check issues or PRs, or use the gem and think about how it could be better.

We so if you make changes, remember to update it.

See CONTRIBUTING.md for more detailed instructions.

🚀 Release Instructions

See CONTRIBUTING.md.

Code Coverage

Coverage service badges

🪇 Code of Conduct

Everyone interacting with this project's codebases, issue trackers, chat rooms and mailing lists agrees to follow the .

🌈 Contributors

Made with contributors-img.

Also see GitLab Contributors: https://gitlab.com/ruby-openid/omniauth-openid/-/graphs/main

⭐️ Star History

📌 Versioning

This library follows for its public API where practical. For most applications, prefer the Pessimistic Version Constraint with two digits of precision.

For example:

spec.add_dependency("omniauth-openid", "~> 2.0")

📌 Is "Platform Support" part of the public API? More details inside.

Dropping support for a platform can be a breaking change for affected users. If a release changes supported platforms, it should be called out clearly in the changelog and versioned with that impact in mind.

To get a better understanding of how SemVer is intended to work over a project's lifetime, read this article from the creator of SemVer:

• "Major Version Numbers are Not Sacred"

See CHANGELOG.md for a list of releases.

📄 License

The gem is available as open source under the terms of the MIT .

© Copyright

See LICENSE.md for the official copyright notice.

Copyright holders

• Copyright (c) 2010 Alex Kirmse
• Copyright (c) 2010 James A. Rosen
• Copyright (c) 2010-2011 Michael Bleigh
• Copyright (c) 2011 Boy van Amstel
• Copyright (c) 2011 Erik Michaels-Ober
• Copyright (c) 2011 Marc Beyerlin
• Copyright (c) 2012 SixArm
• Copyright (c) 2014 DianthuDia
• Copyright (c) 2016 Bryan Talbot
• Copyright (c) 2017 tmilewski
• Copyright (c) 2021 Bobby McDonald
• Copyright (c) 2021 Jordan Owens
• Copyright (c) 2023, 2025 Joel Parker Henderson
• Copyright (c) 2025 Annibelle Boling
• Copyright (c) 2025-2026 Peter H. Boling

🤑 A request for help

Maintainers have teeth and need to pay their dentists. After getting laid off in an RIF in March, and encountering difficulty finding a new one, I began spending most of my time building open source tools. I'm hoping to be able to pay for my kids' health insurance this month, so if you value the work I am doing, I need your support. Please consider sponsoring me or the project.

To join the community or get help, use the RubyForum or Discord.

To say "thanks!" ☝️ Join the community or 👇️ send money.

💌 💌 💌

Please give the project a star ⭐ ♥.

Many parts of this project are actively managed by a kettle-jem smart template utilizing StructuredMerge.org merge contracts.

Thanks for RTFM. ☺️

Field	Value
Package	omniauth-openid
Description	🫵 OpenID (not OIDC) strategy for OmniAuth.
Homepage	https://github.com/ruby-openid/omniauth-openid
Source	https://github.com/ruby-openid/omniauth-openid
License	MIT
Funding	https://github.com/sponsors/pboling, https://ko-fi.com/pboling, https://liberapay.com/pboling/donate, https://opencollective.com/ruby-openid, https://thanks.dev/u/gh/pboling, https://tidelift.com/funding/github/rubygems/omniauth-openid, https://www.buymeacoffee.com/pboling