🥸 masq2 / Masq

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.

I've summarized my thoughts in this blog post.

Masq2 is a mountable Rails engine for operating an OpenID 2.0 identity provider. It supplies account and persona management, an Active Record-backed OpenID store, and support for SReg, Attribute Exchange, PAPE, and optional YubiKey-backed multi-factor authentication.

Masq2 implements OpenID 2.0, not OpenID Connect (OIDC). It is intended for maintaining an existing OpenID provider or a controlled identity service whose relying parties still use the OpenID 2.0 protocol.

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 🎖️
... 💖	🧊 🐙 🛖 🧪

Compatible with MRI Ruby 2.7+, JRuby, and TruffleRuby. CI workflows and Appraisals are generated for MRI Ruby 2.7+. 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.

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

Support tiers describe what this project's CI actually exercises, not what may work in an untested environment:

• Parallel support: CI runs the test suite with multiple workers available.
• Unsupported: the engine/platform combination is not covered by CI and is not a project compatibility claim.

Available as part of the Tidelift Subscription.

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:

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

bundle add masq2

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

gem install masq2

Masq2 reads config/masq.yml from the host Rails application, evaluates ERB in that file, and selects the entry for Rails.env. Mount the engine at the provider path your relying parties will use:

# config/routes.rb
mount Masq::Engine => "/openid"

Configure the selected environment with the public provider name and host, mail delivery settings, whether SSL is required, registration and password policy, and the Attribute Exchange mappings your provider exposes. The reference configuration is test/internal/config/masq.yml.

Set can_use_yubikey: true only when YubiKey credentials are configured. For a public provider, use HTTPS, set the production host to the externally visible hostname, and review trusted_domains before enabling automatic authentication or trusting Basic Auth credentials.

After configuring config/masq.yml, mount the engine and use its provider routes from the relying party's OpenID configuration:

# config/routes.rb
mount Masq::Engine => "/openid"

Masq2 supplies account/persona management and the OpenID server endpoints. The host application remains responsible for its database, mail delivery, and production HTTPS configuration.

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.

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!

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!

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

See SECURITY.md.

If you need some ideas of where to help, you could work on adding more code coverage, 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.

See CONTRIBUTING.md.

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

Made with contributors-img.

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

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("masq2", "~> 1.0")

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.

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

See LICENSE.md for the official copyright notice.

• Copyright (c) 2012 Andrey Korobkov
• Copyright (c) 2012-2014 Dennis Reimann
• Copyright (c) 2012 Jean-Philippe Garcia Ballester
• Copyright (c) 2012 Kerri Miller
• Copyright (c) 2013, 2015 Bardoe Bess
• Copyright (c) 2016-2019 Bardoe Besselaar
• Copyright (c) 2024-2026 Peter H. Boling
• Copyright (c) 2025 Annibelle Boling

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.

💌 💌 💌

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

Thanks for RTFM. ☺️