⭐️ including OAuth 2.1 draft spec & OpenID Connect (OIDC)
if ci_badges.map(&:color).detect { it != "green"} ☝️ let me know, as I may have missed the discord 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.
OAuth 2.0 is the industry-standard protocol for authorization. OAuth 2.0 focuses on client developer simplicity while providing specific authorization flows for web applications, desktop applications, mobile phones, and living room devices. This is a RubyGem for implementing OAuth 2.0 clients (not servers) in Ruby applications.
curl --request POST \
--url 'https://login.microsoftonline.com/REDMOND_REDACTED/oauth2/token' \
--header 'content-type: application/x-www-form-urlencoded' \
--data grant_type=client_credentials \
--data client_id=REDMOND_CLIENT_ID \
--data client_secret=REDMOND_CLIENT_SECRET \
--data resource=REDMOND_RESOURCE_UUID
NOTE: In the ruby version below, certain params are passed to the get_token call, instead of the client creation.
OAuth2::Client.new(
"REDMOND_CLIENT_ID", # client_id
"REDMOND_CLIENT_SECRET", # client_secret
auth_scheme: :request_body, # Other modes are supported: :basic_auth, :tls_client_auth, :private_key_jwt
token_url: "oauth2/token", # relative path, except with leading `/`, then absolute path
site: "https://login.microsoftonline.com/REDMOND_REDACTED",
). # The base path for token_url when it is relative
client_credentials. # There are many other types to choose from!
get_token(resource: "REDMOND_RESOURCE_UUID")
NOTE: header - The content type specified in the curl is already the default!
docker compose -f docker-compose-ssl.yml up -d --wait
ruby examples/e2e.rb
# If your machine is slow or Docker pulls are cold, increase the wait:
E2E_WAIT_TIMEOUT=120 ruby examples/e2e.rb
# The mock server serves HTTP on 8080; the example points to http://localhost:8080 by default.
The output should be something like this:
➜ ruby examples/e2e.rb
Access token (truncated): eyJraWQiOiJkZWZhdWx0...
userinfo status: 200
userinfo body: {"sub" => "demo-sub", "aud" => ["demo-aud"], "nbf" => 1757816758000, "iss" => "http://localhost:8080/default", "exp" => 1757820358000, "iat" => 1757816758000, "jti" => "d63b97a7-ebe5-4dea-93e6-d542caba6104"}
E2E complete
Make sure to shut down the mock server when you are done:
docker compose -f docker-compose-ssl.yml down
Troubleshooting: validate connectivity to the mock server
Notes
If it seems like you are in the wrong place, you might try one of these:
| Tokens to Remember |   |
|---|---|
| Works with JRuby | -AABBCC?style=for-the-badge&logo=ruby&logoColor=red){kind=icon} -AABBCC?style=for-the-badge&logo=ruby&logoColor=red){kind=icon} -AABBCC?style=for-the-badge&logo=ruby&logoColor=red){kind=icon}    |
| Works with Truffle Ruby | -AABBCC?style=for-the-badge&logo=ruby&logoColor=pink){kind=icon} -AABBCC?style=for-the-badge&logo=ruby&logoColor=pink){kind=icon}   |
| Works with MRI Ruby 3 |       |
| Works with MRI Ruby 2 | -AABBCC?style=for-the-badge&logo=ruby&logoColor=white){kind=icon}      |
| Support & Community |      |
| Source |     |
| Documentation |     |
| Compliance |      |
| Style |     |
| Maintainer 🎖️ |      |
... 💖 |     🧊 🐙 🛖 🧪 |
allow-failures feature, and until they do flaky EOL-platform builds get dropped, so YMMV. Accept patches so long as they don't break the platforms that do run in CI.allow-failures feature, and until they do flaky EOL-platform builds get dropped, so YMMV. Accept patches so long as they don't break the platforms that do run in CI.faraday @ v0, v1, v2, HEAD ⏩️ lostisland/faradayjwt @ v1, v2, v3, HEAD ⏩️ jwt/ruby-jwtlogger @ v1.2, v1.5, v1.7, HEAD ⏩️ ruby/loggermulti_xml @ v0.5, v0.6, v0.7, HEAD ⏩️ sferik/multi_xmlrack @ v1.2, v1.6, v2, v3, HEAD ⏩️ rack/racksnaky_hash @ v2, HEAD ⏩️ ruby-oauth/snaky_hashversion_gem @ v1, HEAD ⏩️ ruby-oauth/version_gemThe last two were extracted from this gem. They are part of the ruby-oauth org,
and are developed in tight collaboration with this gem.
Also, where reasonable, tested against the runtime dependencies of those dependencies:
hashie @ v0, v1, v2, v3, v4, v5, HEAD ⏩️ hashie/hashieThis project sits underneath a large portion of the authorization systems on the internet. According to GitHub's project tracking, which I believe only reports on public projects, 100,000+ projects, and 500+ packages depend on this project.
That means it is painful for the Ruby community when this gem forces updates to its runtime dependencies.
As a result, great care, and a lot of time, have been invested to ensure this gem is working with all the leading versions per each minor version of Ruby of all the runtime dependencies it can install with.
What does that mean specifically for the runtime dependencies?
We have 100% test coverage of lines and branches, and this test suite runs across a very large matrix. It wouldn't be possible without appraisal2.
| 🚚 Amazing test matrix was brought to you by | 🔎 appraisal2 🔎 and the color 💚 green 💚 |
|---|---|
| 👟 Check it out! | ✨ github.com/appraisal-rb/appraisal2 ✨ |
* MIT license; The only guarantees I make are for enterprise support.
The various versions of each are tested via the Ruby test matrix, along with whatever Ruby includes them.
If you use a gem version of a core Ruby library it should work fine!
| Federated DVCS Repository | Status | Issues | PRs | Wiki | CI | Discussions |
|---|---|---|---|---|---|---|
| 🧪 ruby-oauth/oauth2 on GitLab | The Truth | 💚 | 💚 | 💚 | 🏀 Tiny Matrix | ➖ |
| 🧊 ruby-oauth/oauth2 on CodeBerg | An Ethical Mirror (Donate) | 💚 | 💚 | ➖ | ⭕️ No Matrix | ➖ |
| 🐙 ruby-oauth/oauth2 on GitHub | Another Mirror | 💚 | 💚 | ➖ | 💯 Full Matrix | 💚 |
| 🤼 OAuth Ruby Google Group | "Active" | ➖ | ➖ | ➖ | ➖ | 💚 |
| 🎮️ Discord Server | | Let's | talk | about | this | library! |
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.
@Pointy Haired Boss: An enterprise support subscription is "never gonna let you down", and supports open source maintainersAlternatively:
| Version | Release Date | CHANGELOG | README |
|---|---|---|---|
| 2.0.17 | 2025-09-15 | v2.0.17 CHANGELOG | v2.0.17 README |
| 2.0.16 | 2025-09-14 | v2.0.16 CHANGELOG | v2.0.16 README |
| 2.0.15 | 2025-09-08 | v2.0.15 CHANGELOG | v2.0.15 README |
| 2.0.14 | 2025-08-31 | v2.0.14 CHANGELOG | v2.0.14 README |
| 2.0.13 | 2025-08-30 | v2.0.13 CHANGELOG | v2.0.13 README |
| 2.0.12 | 2025-05-31 | v2.0.12 CHANGELOG | v2.0.12 README |
| 2.0.11 | 2025-05-23 | v2.0.11 CHANGELOG | v2.0.11 README |
| 2.0.10 | 2025-05-17 | v2.0.10 CHANGELOG | v2.0.10 README |
| 2.0.9 | 2022-09-16 | v2.0.9 CHANGELOG | v2.0.9 README |
| 2.0.8 | 2022-09-01 | v2.0.8 CHANGELOG | v2.0.8 README |
| 2.0.7 | 2022-08-22 | v2.0.7 CHANGELOG | v2.0.7 README |
| 2.0.6 | 2022-07-13 | v2.0.6 CHANGELOG | v2.0.6 README |
| 2.0.5 | 2022-07-07 | v2.0.5 CHANGELOG | v2.0.5 README |
| 2.0.4 | 2022-07-01 | v2.0.4 CHANGELOG | v2.0.4 README |
| 2.0.3 | 2022-06-28 | v2.0.3 CHANGELOG | v2.0.3 README |
| 2.0.2 | 2022-06-24 | v2.0.2 CHANGELOG | v2.0.2 README |
| 2.0.1 | 2022-06-22 | v2.0.1 CHANGELOG | v2.0.1 README |
| 2.0.0 | 2022-06-21 | v2.0.0 CHANGELOG | v2.0.0 README |
| Version | Release Date | CHANGELOG | README |
|---|---|---|---|
| 1.4.11 | Sep 16, 2022 | v1.4.11 CHANGELOG | v1.4.11 README |
| 1.4.10 | Jul 1, 2022 | v1.4.10 CHANGELOG | v1.4.10 README |
| 1.4.9 | Feb 20, 2022 | v1.4.9 CHANGELOG | v1.4.9 README |
| 1.4.8 | Feb 18, 2022 | v1.4.8 CHANGELOG | v1.4.8 README |
| 1.4.7 | Mar 19, 2021 | v1.4.7 CHANGELOG | v1.4.7 README |
| 1.4.6 | Mar 19, 2021 | v1.4.6 CHANGELOG | v1.4.6 README |
| 1.4.5 | Mar 18, 2021 | v1.4.5 CHANGELOG | v1.4.5 README |
| 1.4.4 | Feb 12, 2020 | v1.4.4 CHANGELOG | v1.4.4 README |
| 1.4.3 | Jan 29, 2020 | v1.4.3 CHANGELOG | v1.4.3 README |
| 1.4.2 | Oct 1, 2019 | v1.4.2 CHANGELOG | v1.4.2 README |
| 1.4.1 | Oct 13, 2018 | v1.4.1 CHANGELOG | v1.4.1 README |
| 1.4.0 | Jun 9, 2017 | v1.4.0 CHANGELOG | v1.4.0 README |
| Version | Release Date | Readme |
|---|---|---|
| 1.3.1 | Mar 3, 2017 | https://gitlab.com/ruby-oauth/oauth2/-/blob/v1.3.1/README.md |
| 1.3.0 | Dec 27, 2016 | https://gitlab.com/ruby-oauth/oauth2/-/blob/v1.3.0/README.md |
| Version | Release Date | Readme |
|---|---|---|
| 1.2.0 | Jun 30, 2016 | https://gitlab.com/ruby-oauth/oauth2/-/blob/v1.2.0/README.md |
| 1.1.0 | Jan 30, 2016 | https://gitlab.com/ruby-oauth/oauth2/-/blob/v1.1.0/README.md |
| 1.0.0 | May 23, 2014 | https://gitlab.com/ruby-oauth/oauth2/-/blob/v1.0.0/README.md |
| < 1.0.0 | Find here | https://gitlab.com/ruby-oauth/oauth2/-/tags |
Install the gem and add to the application's Gemfile by executing:
bundle add oauth2
If bundler is not being used to manage dependencies, install the gem by executing:
gem install oauth2
This gem is cryptographically signed, and has verifiable SHA-256 and SHA-512 checksums by stone_checksums. Be sure the gem you install hasn’t been tampered with by following the instructions below.
Add my public key (if you haven’t already, expires 2045-04-29) as a trusted certificate:
gem cert --add <(curl -Ls https://raw.github.com/galtzo-floss/certs/main/pboling.pem)
You only need to do that once. Then proceed to install with:
gem install oauth2 -P MediumSecurity
The MediumSecurity trust profile will verify signed gems, but allow the installation of unsigned dependencies.
This is necessary because not all of oauth2’s dependencies are signed, so we cannot use HighSecurity.
If you want to up your security game full-time:
bundle config set --global trust-policy MediumSecurity
NOTE: Be prepared to track down certs for signed gems and add them the same way you added mine.
kid for key discovery and managementapplication/vdn.api+json, application/vnd.collection+json, application/hal+json, application/problem+jsonOAuth2::Client#get_token:
:access_token_class (AccessToken); user specified class to use for all calls to get_tokenOAuth2::AccessToken#initialize:
:expires_latency (nil); number of seconds by which AccessToken validity will be reduced to offset latencyresponse.parsed.to_h to retain the original case, and the original wasn't snake case, as the keys in the result will be snake case.snaky: false option.:auth_scheme is now :basic_auth (instead of :request_body)
Targeted ruby compatibility is non-EOL versions of Ruby, currently 3.2, 3.3, and 3.4.
Compatibility is further distinguished as "Best Effort Support" or "Incidental Support" for older versions of Ruby.
This gem will install on Ruby versions >= v2.2 for 2.x releases.
See 1-4-stable branch for older rubies.
This gem is tested against MRI, JRuby, and Truffleruby. Each of those has varying versions that target a specific version of MRI Ruby. This gem should work in the just-listed Ruby engines according to the targeted MRI compatibility in the table below. If you would like to add support for additional engines, see gemfiles/README.md, then submit a PR to the correct maintenance branch as according to the table below.
If something doesn't work on one of these interpreters, it's a bug.
This library may inadvertently work (or seem to work) on other Ruby implementations, however support will only be provided for the versions listed above.
If you would like this library to support another Ruby version, you may volunteer to be a maintainer. Being a maintainer entails making sure all tests run and pass on that implementation. When something breaks on your implementation, you will be responsible for providing patches in a timely fashion. If critical issues for a particular implementation exist at the time of a major release, support for that Ruby version may be dropped.
| Ruby OAuth2 Version | Maintenance Branch | Targeted Support | Best Effort Support | Incidental Support | |
|---|---|---|---|---|---|
| 1️⃣ | 2.0.x | main | 3.2, 3.3, 3.4 | 2.5, 2.6, 2.7, 3.0, 3.1 | 2.2, 2.3, 2.4 |
| 2️⃣ | 1.4.x | 1-4-stable | 3.2, 3.3, 3.4 | 2.5, 2.6, 2.7, 3.0, 3.1 | 1.9, 2.0, 2.1, 2.2, 2.3, 2.4 |
| 3️⃣ | older | N/A | Best of luck to you! | Please upgrade! |
NOTE: The 1.4 series will only receive critical security updates. See SECURITY.md.
You can turn on additional warnings.
OAuth2.configure do |config|
# Turn on a warning like:
# OAuth2::AccessToken.from_hash: `hash` contained more than one 'token' key
config.silence_extra_tokens_warning = false # default: true
# Set to true if you want to also show warnings about no tokens
config.silence_no_tokens_warning = false # default: true,
end
The "extra tokens" problem comes from ambiguity in the spec about which token is the right token.
Some OAuth 2.0 standards legitimately have multiple tokens.
You may need to subclass OAuth2::AccessToken, or write your own custom alternative to it, and pass it in.
Specify your custom class with the access_token_class option.
If you only need one token you can, as of v2.0.10,
specify the exact token name you want to extract via the OAuth2::AccessToken using
the token_name option.
You'll likely need to do some source diving. This gem has 100% test coverage for lines and branches, so the specs are a great place to look for ideas. If you have time and energy please contribute to the documentation!
authorize_url and token_url are on site root (Just Works!)require "oauth2"
client = OAuth2::Client.new("client_id", "client_secret", site: "https://example.org")
# => #<OAuth2::Client:0x00000001204c8288 @id="client_id", @secret="client_sec...
client.auth_code.authorize_url(redirect_uri: "http://localhost:8080/oauth2/callback")
# => "https://example.org/oauth/authorize?client_id=client_id&redirect_uri=http%3A%2F%2Flocalhost%3A8080%2Foauth2%2Fcallback&response_type=code"
access = client.auth_code.get_token("authorization_code_value", redirect_uri: "http://localhost:8080/oauth2/callback", headers: {"Authorization" => "Basic some_password"})
response = access.get("/api/resource", params: {"query_foo" => "bar"})
response.class.name
# => OAuth2::Response
authorize_url and token_url (Not on site root, Just Works!)In above example, the default Authorization URL is oauth/authorize and default Access Token URL is oauth/token, and, as they are missing a leading /, both are relative.
client = OAuth2::Client.new("client_id", "client_secret", site: "https://example.org/nested/directory/on/your/server")
# => #<OAuth2::Client:0x00000001204c8288 @id="client_id", @secret="client_sec...
client.auth_code.authorize_url(redirect_uri: "http://localhost:8080/oauth2/callback")
# => "https://example.org/nested/directory/on/your/server/oauth/authorize?client_id=client_id&redirect_uri=http%3A%2F%2Flocalhost%3A8080%2Foauth2%2Fcallback&response_type=code"
authorize_url and token_urlYou can specify custom URLs for authorization and access token, and when using a leading / they will not be relative, as shown below:
client = OAuth2::Client.new(
"client_id",
"client_secret",
site: "https://example.org/nested/directory/on/your/server",
authorize_url: "/jaunty/authorize/",
token_url: "/stirrups/access_token",
)
# => #<OAuth2::Client:0x00000001204c8288 @id="client_id", @secret="client_sec...
client.auth_code.authorize_url(redirect_uri: "http://localhost:8080/oauth2/callback")
# => "https://example.org/jaunty/authorize/?client_id=client_id&redirect_uri=http%3A%2F%2Flocalhost%3A8080%2Foauth2%2Fcallback&response_type=code"
client.class.name
# => OAuth2::Client
response = access.get("/api/resource", params: {"query_foo" => "bar"})
# Even if the actual response is CamelCase. it will be made available as snaky:
JSON.parse(response.body) # => {"accessToken"=>"aaaaaaaa", "additionalData"=>"additional"}
response.parsed # => {"access_token"=>"aaaaaaaa", "additional_data"=>"additional"}
response.parsed.access_token # => "aaaaaaaa"
response.parsed[:access_token] # => "aaaaaaaa"
response.parsed.additional_data # => "additional"
response.parsed[:additional_data] # => "additional"
response.parsed.class.name # => SnakyHash::StringKeyed (from snaky_hash gem)
As of v2.0.11, if you need to serialize the parsed result, you can!
There are two ways to do this, globally, or discretely. The discrete way is recommended.
Globally configure SnakyHash::StringKeyed to use the serializer. Put this in your code somewhere reasonable (like an initializer for Rails).
SnakyHash::StringKeyed.class_eval do
extend SnakyHash::Serializer
end
Discretely configure a custom Snaky Hash class to use the serializer.
class MySnakyHash < SnakyHash::StringKeyed
# Give this hash class `dump` and `load` abilities!
extend SnakyHash::Serializer
end
# And tell your client to use the custom class in each call:
client = OAuth2::Client.new("client_id", "client_secret", site: "https://example.org/oauth2")
token = client.get_token({snaky_hash_klass: MySnakyHash})
These extensions work regardless of whether you used the global or discrete config above.
There are a few hacks you may need in your class to support Ruby < 2.4.2 or < 2.6. They are likely not needed if you are on a newer Ruby. See response_spec.rb if you need to study the hacks for older Rubies.
class MySnakyHash < SnakyHash::StringKeyed
# Give this hash class `dump` and `load` abilities!
extend SnakyHash::Serializer
#### Serialization Extentions
#
# Act on the non-hash values (including the values of hashes) as they are dumped to JSON
# In other words, this retains nested hashes, and only the deepest leaf nodes become bananas.
# WARNING: This is a silly example!
dump_value_extensions.add(:to_fruit) do |value|
"banana" # => Make values "banana" on dump
end
# Act on the non-hash values (including the values of hashes) as they are loaded from the JSON dump
# In other words, this retains nested hashes, and only the deepest leaf nodes become ***.
# WARNING: This is a silly example!
load_value_extensions.add(:to_stars) do |value|
"***" # Turn dumped bananas into *** when they are loaded
end
# Act on the entire hash as it is prepared for dumping to JSON
# WARNING: This is a silly example!
dump_hash_extensions.add(:to_cheese) do |value|
if value.is_a?(Hash)
value.transform_keys do |key|
split = key.split("_")
first_word = split[0]
key.sub(first_word, "cheese")
end
else
value
end
end
# Act on the entire hash as it is loaded from the JSON dump
# WARNING: This is a silly example!
load_hash_extensions.add(:to_pizza) do |value|
if value.is_a?(Hash)
res = klass.new
value.keys.each_with_object(res) do |key, result|
split = key.split("_")
last_word = split[-1]
new_key = key.sub(last_word, "pizza")
result[new_key] = value[key]
end
res
else
value
end
end
end
See response_spec.rb, or the ruby-oauth/snaky_hash gem for more ideas.
response = access.get("/api/resource", params: {"query_foo" => "bar"}, snaky: false)
JSON.parse(response.body) # => {"accessToken"=>"aaaaaaaa", "additionalData"=>"additional"}
response.parsed # => {"accessToken"=>"aaaaaaaa", "additionalData"=>"additional"}
response.parsed["accessToken"] # => "aaaaaaaa"
response.parsed["additionalData"] # => "additional"
response.parsed.class.name # => Hash (just, regular old Hash)
Set an environment variable as per usual (e.g. with dotenv).
# will log both request and response, including bodies
ENV["OAUTH_DEBUG"] = "true"
By default, debug output will go to $stdout. This can be overridden when
initializing your OAuth2::Client.
require "oauth2"
client = OAuth2::Client.new(
"client_id",
"client_secret",
site: "https://example.org",
logger: Logger.new("example.log", "weekly"),
)
The AccessToken methods #get, #post, #put and #delete and the generic #request
will return an instance of the #OAuth2::Response class.
This instance contains a #parsed method that will parse the response body and
return a Hash-like SnakyHash::StringKeyed if the Content-Type is application/x-www-form-urlencoded or if
the body is a JSON object. It will return an Array if the body is a JSON
array. Otherwise, it will return the original body string.
The original response body, headers, and status can be accessed via their respective methods.
If you have an existing Access Token for a user, you can initialize an instance
using various class methods including the standard new, from_hash (if you have
a hash of the values), or from_kvform (if you have an
application/x-www-form-urlencoded encoded string of the values).
Options (since v2.0.x unless noted):
Note: Verb-dependent mode was added in v2.0.15 to support providers like Instagram that require query mode for GET and header mode for POST/DELETE.
On 400+ status code responses, an OAuth2::Error will be raised. If it is a
standard OAuth2 error response, the body will be parsed and #code and #description will contain the values provided from the error and
error_description parameters. The #response property of OAuth2::Error will
always contain the OAuth2::Response instance.
If you do not want an error to be raised, you may use :raise_errors => false
option on initialization of the client. In this case the OAuth2::Response
instance will be returned as usual and on 400+ status code responses, the
Response instance will contain the OAuth2::Error instance.
Note on OAuth 2.1 (draft):
References:
Currently, the Authorization Code, Implicit, Resource Owner Password Credentials, Client Credentials, and Assertion
authentication grant types have helper strategy classes that simplify client
use. They are available via the #auth_code,
#implicit,
#password,
#client_credentials, and
#assertion methods respectively.
These aren't full examples, but demonstrative of the differences between usage for each strategy.
auth_url = client.auth_code.authorize_url(redirect_uri: "http://localhost:8080/oauth/callback")
access = client.auth_code.get_token("code_value", redirect_uri: "http://localhost:8080/oauth/callback")
auth_url = client.implicit.authorize_url(redirect_uri: "http://localhost:8080/oauth/callback")
# get the token params in the callback and
access = OAuth2::AccessToken.from_kvform(client, query_string)
access = client.password.get_token("username", "password")
access = client.client_credentials.get_token
# Client Assertion Strategy
# see: https://tools.ietf.org/html/rfc7523
claimset = {
iss: "http://localhost:3001",
aud: "http://localhost:8080/oauth2/token",
sub: "me@example.com",
exp: Time.now.utc.to_i + 3600,
}
assertion_params = [claimset, "HS256", "secret_key"]
access = client.assertion.get_token(assertion_params)
# The `access` (i.e. access token) is then used like so:
access.token # actual access_token string, if you need it somewhere
access.get("/api/stuff") # making api calls with access token
If you want to specify additional headers to be sent out with the request, add a 'headers' hash under 'params':
access = client.auth_code.get_token("code_value", redirect_uri: "http://localhost:8080/oauth/callback", headers: {"Some" => "Header"})
You can always use the #request method on the OAuth2::Client instance to make
requests for tokens for any Authentication grant type.
require "oauth2"
client = OAuth2::Client.new(
ENV["CLIENT_ID"],
ENV["CLIENT_SECRET"],
site: "https://provider.example.com",
redirect_uri: "https://my.app.example.com/oauth/callback",
)
# Step 1: redirect user to consent
state = SecureRandom.hex(16)
auth_url = client.auth_code.authorize_url(scope: "openid profile email", state: state)
# redirect_to auth_url
# Step 2: handle the callback
# params[:code], params[:state]
raise "state mismatch" unless params[:state] == state
access = client.auth_code.get_token(params[:code])
# Step 3: call APIs
profile = access.get("/api/v1/me").parsed
client = OAuth2::Client.new(ENV["CLIENT_ID"], ENV["CLIENT_SECRET"], site: "https://provider.example.com")
access = client.client_credentials.get_token(audience: "https://api.example.com")
resp = access.get("/v1/things")
access = client.password.get_token("jdoe", "s3cret", scope: "read")
# This converts a Postman/Net::HTTP multipart token request to oauth2 gem usage.
# JHipster UAA typically exposes the token endpoint at /uaa/oauth/token.
# The original snippet included:
# - Basic Authorization header for the client (web_app:changeit)
# - X-XSRF-TOKEN header from a cookie (some deployments require it)
# - grant_type=password with username/password and client_id
# Using oauth2 gem, you don't need to build multipart bodies; the gem sends
# application/x-www-form-urlencoded as required by RFC 6749.
require "oauth2"
client = OAuth2::Client.new(
"web_app", # client_id
"changeit", # client_secret
site: "http://localhost:8080/uaa",
token_url: "/oauth/token", # absolute under site (or "oauth/token" relative)
auth_scheme: :basic_auth, # sends HTTP Basic Authorization header
)
# If your UAA requires an XSRF header for the token call, provide it as a header.
# Often this is not required for token endpoints, but if your gateway enforces it,
# obtain the value from the XSRF-TOKEN cookie and pass it here.
xsrf_token = ENV["X_XSRF_TOKEN"] # e.g., pulled from a prior set-cookie value
access = client.password.get_token(
"admin", # username
"admin", # password
headers: xsrf_token ? {"X-XSRF-TOKEN" => xsrf_token} : {},
# JHipster commonly also accepts/needs the client_id in the body; include if required:
# client_id: "web_app",
)
puts access.token
puts access.to_hash # full token response
Notes:
Providers like Instagram require the access token to be sent differently depending on the HTTP verb:
Since v2.0.15, you can configure an AccessToken with a verb‑dependent mode. The gem will choose how to send the token based on the request method.
Example: exchanging and refreshing long‑lived Instagram tokens, and making API calls
require "oauth2"
# NOTE: Users authenticate via Facebook Login to obtain a short‑lived user token (not shown here).
# See Facebook Login docs for obtaining the initial short‑lived token.
client = OAuth2::Client.new(nil, nil, site: "https://graph.instagram.com")
# Start with a short‑lived token you already obtained via Facebook Login
short_lived = OAuth2::AccessToken.new(
client,
ENV["IG_SHORT_LIVED_TOKEN"],
# Key part: verb‑dependent mode
mode: {get: :query, post: :header, delete: :header},
)
# 1) Exchange for a long‑lived token (Instagram requires GET with access_token in query)
# Endpoint: GET https://graph.instagram.com/access_token
# Params: grant_type=ig_exchange_token, client_secret=APP_SECRET
exchange = short_lived.get(
"/access_token",
params: {
grant_type: "ig_exchange_token",
client_secret: ENV["IG_APP_SECRET"],
# access_token param will be added automatically by the AccessToken (mode => :query for GET)
},
)
long_lived_token_value = exchange.parsed["access_token"]
long_lived = OAuth2::AccessToken.new(
client,
long_lived_token_value,
mode: {get: :query, post: :header, delete: :header},
)
# 2) Refresh the long‑lived token (Instagram uses GET with token in query)
# Endpoint: GET https://graph.instagram.com/refresh_access_token
refresh_resp = long_lived.get(
"/refresh_access_token",
params: {grant_type: "ig_refresh_token"},
)
long_lived = OAuth2::AccessToken.new(
client,
refresh_resp.parsed["access_token"],
mode: {get: :query, post: :header, delete: :header},
)
# 3) Typical API GET request (token in query automatically)
me = long_lived.get("/me", params: {fields: "id,username"}).parsed
# 4) Example POST (token sent via Bearer header automatically)
# Note: Replace the path/params with a real Instagram Graph API POST you need,
# such as publishing media via the Graph API endpoints.
# long_lived.post("/me/media", body: {image_url: "https://...", caption: "hello"})
Tips:
When the server issues a refresh_token, you can refresh manually or implement an auto-refresh wrapper.
if access.expired?
access = access.refresh
end
class AutoRefreshingToken
def initialize(token_provider, store: nil)
@token = token_provider
@store = store # e.g., something that responds to read/write for token data
end
def with(&blk)
tok = ensure_fresh!
blk ? blk.call(tok) : tok
rescue OAuth2::Error => e
# If a 401 suggests token invalidation, try one refresh and retry once
if e.response && e.response.status == 401 && @token.refresh_token
@token = @token.refresh
@store.write(@token.to_hash) if @store
retry
end
raise
end
private
def ensure_fresh!
if @token.expired? && @token.refresh_token
@token = @token.refresh
@store.write(@token.to_hash) if @store
end
@token
end
end
# usage
keeper = AutoRefreshingToken.new(access)
keeper.with { |tok| tok.get("/v1/protected") }
Persist the token across processes using AccessToken#to_hash and AccessToken.from_hash(client, hash).
You can revoke either the access token or the refresh token.
# Revoke the current access token
access.revoke(token_type_hint: :access_token)
# Or explicitly revoke the refresh token (often also invalidates associated access tokens)
access.revoke(token_type_hint: :refresh_token)
Some providers require OAuth requests (including the token request and subsequent API calls) to be sender‑constrained using mutual TLS (mTLS). With this gem, you enable mTLS by providing a client certificate/private key to Faraday via connection_opts.ssl and, if your provider requires it for client authentication, selecting the tls_client_auth auth_scheme.
Example using PEM files (certificate and key):
require "oauth2"
require "openssl"
client = OAuth2::Client.new(
ENV.fetch("CLIENT_ID"),
ENV.fetch("CLIENT_SECRET"),
site: "https://example.com",
authorize_url: "/oauth/authorize/",
token_url: "/oauth/token/",
auth_scheme: :tls_client_auth, # if your AS requires mTLS-based client authentication
connection_opts: {
ssl: {
client_cert: OpenSSL::X509::Certificate.new(File.read("localhost.pem")),
client_key: OpenSSL::PKey::RSA.new(File.read("localhost-key.pem")),
# Optional extras, uncomment as needed:
# ca_file: "/path/to/ca-bundle.pem", # custom CA(s)
# verify: true # enable server cert verification (recommended)
},
},
)
# Example token request (any grant type can be used). The mTLS handshake
# will occur automatically on HTTPS calls using the configured cert/key.
access = client.client_credentials.get_token
# Subsequent resource requests will also use mTLS on HTTPS endpoints of `site`:
resp = access.get("/v1/protected")
Notes:
OAuth2::Client.new(
id,
secret,
site: "https://provider.example.com",
auth_scheme: :basic_auth, # default. Alternatives: :request_body, :tls_client_auth, :private_key_jwt
)
client = OAuth2::Client.new(
id,
secret,
site: "https://provider.example.com",
connection_opts: {
request: {open_timeout: 5, timeout: 15},
proxy: ENV["HTTPS_PROXY"],
ssl: {verify: true},
},
) do |faraday|
faraday.request(:url_encoded)
# faraday.response :logger, Logger.new($stdout) # see OAUTH_DEBUG below
faraday.adapter(:net_http_persistent) # or any Faraday adapter you need
end
Some APIs expect repeated key parameters to be sent as flat params rather than arrays. Faraday provides FlatParamsEncoder for this purpose. You can configure the oauth2 client to use it when building requests.
require "faraday"
client = OAuth2::Client.new(
id,
secret,
site: "https://api.example.com",
# Pass Faraday connection options to make FlatParamsEncoder the default
connection_opts: {
request: {params_encoder: Faraday::FlatParamsEncoder},
},
) do |faraday|
faraday.request(:url_encoded)
faraday.adapter(:net_http)
end
access = client.client_credentials.get_token
# Example of a GET with two flat filter params (not an array):
# Results in: ?filter=order.clientCreatedTime%3E1445006997000&filter=order.clientCreatedTime%3C1445611797000
resp = access.get(
"/v1/orders",
params: {
# Provide the values as an array; FlatParamsEncoder expands them as repeated keys
filter: [
"order.clientCreatedTime>1445006997000",
"order.clientCreatedTime<1445611797000",
],
},
)
If you instead need to build a raw Faraday connection yourself, the equivalent configuration is:
conn = Faraday.new("https://api.example.com", request: {params_encoder: Faraday::FlatParamsEncoder})
The library follows up to max_redirects (default 5).
You can override per-client via options[:max_redirects].
resp = access.get("/v1/thing")
resp.status # Integer
resp.headers # Hash
resp.body # String
resp.parsed # SnakyHash::StringKeyed or Array when JSON array
begin
access.get("/v1/forbidden")
rescue OAuth2::Error => e
e.code # OAuth2 error code (when present)
e.description # OAuth2 error description (when present)
e.response # OAuth2::Response (full access to status/headers/body)
end
client = OAuth2::Client.new(id, secret, site: site, raise_errors: false)
res = client.request(:get, "/v1/maybe-errors")
if res.status == 429
sleep res.headers["retry-after"].to_i
end
If a provider requires non-standard parameters or headers, you can call client.get_token directly:
access = client.get_token({
grant_type: "client_credentials",
audience: "https://api.example.com",
headers: {"X-Custom" => "value"},
parse: :json, # override parsing
})
id_token (a JWT), this gem surfaces it but does not validate the signature. Use a JWT library and your provider's JWKs to verify it.auth_scheme: :private_key_jwt and ensure your key configuration matches the provider requirements.OAUTH_DEBUG=true to enable verbose Faraday logging (uses the client-provided logger).While ruby-oauth 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 (although currently Open Collective is our preferred funding platform).
If you're working in a company that's making significant use of ruby-oauth tools we'd appreciate it if you suggest to your company to become a ruby-oauth sponsor.
You can support the development of ruby-oauth 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. |
No backers yet. Be the first!
Support us with a monthly donation and help us continue our activities. [Become a backer]
No sponsors 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]
How wonderful it is that nobody need wait a single moment before starting to improve the world.
—Anne Frank
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 — totaling 79 hours of FLOSS coding over just the past seven days, a pretty regular week for me. 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
To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.
For more see SECURITY.md.
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 reek, 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-oauth/oauth2/-/graphs/main
This Library adheres to .
Violations of this scheme should be reported as bugs.
Specifically, if a minor or patch version is released that breaks backward compatibility,
a new version should be immediately released that restores compatibility.
Breaking changes to the public API will only be introduced with new major versions.
dropping support for a platform is both obviously and objectively a breaking change
—Jordan Harband (@ljharb, maintainer of SemVer) in SemVer issue 716
I understand that policy doesn't work universally ("exceptions to every rule!"), but it is the policy here. As such, in many cases it is good to specify a dependency on this library using the Pessimistic Version Constraint with two digits of precision.
For example:
spec.add_dependency("oauth2", "~> 2.0")
SemVer should, IMO, but doesn't explicitly, say that dropping support for specific Platforms is a breaking change to an API. It is obvious to many, but not all, and since the spec is silent, the bike shedding is endless.
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:
See CHANGELOG.md for a list of releases.
The gem is available as open source under the terms of
the MIT License .
See LICENSE.txt for the official Copyright Notice.
Maintainers have teeth and need to pay their dentists. After getting laid off in an RIF in March and filled with many dozens of rejections, I'm now spending ~60+ hours a week 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 👇️ Join the Discord.
To say "thanks!" ☝️ Join the Discord or 👇️ send money.
💌
Thanks for RTFM. ☺️
FAQs
Unknown package
We found that oauth2 demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
/Security News
Socket researchers uncover how threat actors weaponize Discord across the npm, PyPI, and RubyGems ecosystems to exfiltrate sensitive data.
Security News
Socket now integrates with Bun 1.3’s Security Scanner API to block risky packages at install time and enforce your organization’s policies in local dev and CI.
Research
The Socket Threat Research Team is tracking weekly intrusions into the npm registry that follow a repeatable adversarial playbook used by North Korean state-sponsored actors.
