omniauth-entra_id_jwt 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8864bca7676bb8175472b16a52a5c6e31eeb9567f1ea2d269e0632be8138c69a
+  data.tar.gz: 066d87a184e3e68e9918b059326d027f8b6e9a9f1026b94145b173ee7a651b45
+SHA512:
+  metadata.gz: 40467da993f4669256ab1687c300dfacdb03f8333ab63aeb2d1730decc7d12e9cb97f407d6fff8372808461a75bc3f826edcae5fe4efdfc722936a58f2fcd6e1
+  data.tar.gz: 3d3852311ccb992378c8bcce5a7d6887895aac890c04c7dd895c85a81b366f78d52479d4a42731b05d4e798e0cf05f357ad0635fd9a757369e312c6c96ab1de0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-03-10
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 collabital
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Benjamin Elias
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,252 @@
+# OmniAuth::Entra::Id::JWT
+
+OAuth 2 authentication with [Entra ID API](https://learn.microsoft.com/en-us/entra/identity-platform/v2-overview) using the [JWT Bearer flow](https://oauth.net/2/jwt/). In Microsoft Entra, this is referred to as the [On Behalf Of](https://learn.microsoft.com/en-us/entra/identity-platform/v2-oauth2-on-behalf-of-flow) flow.i
+
+The rationale for this gem is:
+
+* Several Entra ID gems are no longer supported
+* None of these gems support the JWT Bearer flow
+
+The JWT Bearer flow can be used to share credentials between front-end and back-end systems. This allows your application to initially authenticate a user using front-end flows (e.g. Javascript browser or SPA). Completing a JWT Bearer flow then allows a Rails server to make API calls under the user's identity with its own back-end token.
+
+Before using this gem, ensure you can successfully receive a JWT token through your front-end. This can be done using the [Microsoft Authentication Library](https://learn.microsoft.com/en-us/entra/identity-platform/msal-overview) implementation applicable to your front-end framework.
+
+This gem does **not** support more common OAuth2.0 authentication flows, such as [Authorization Code flow](https://learn.microsoft.com/en-us/entra/identity-platform/v2-oauth2-auth-code-flow) or [Client Credentials flow](https://learn.microsoft.com/en-us/entra/identity-platform/v2-oauth2-client-creds-grant-flow). **If you do not need to share credentials between the front-end and back-end systems, use another gem such as [omniauth-entra-id](https://github.com/pond/omniauth-entra-id) or [omniauth-oauth2-generic](https://github.com/omniauth/omniauth-oauth2-generic).**
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+Start by reading OmniAuth documentation on a more generic authentication strategy, for example [OAuth2 Generic](https://github.com/omniauth/omniauth-oauth2-generic). Background information can be found at [OmniAuth#Getting-Started](https://github.com/omniauth/omniauth#getting-started).
+
+This gem implements an OmniAuth strategy, and more information can be found at [Using Devise with OmniAuth](https://github.com/heartcombo/devise/wiki/OmniAuth:-Overview). 
+
+> **Note**: Given the POST request to `user_entra_id_jwt_omniauth_token` is made by a front-end script, there is no use for the 'authorize' route (`user_entra_id_jwt_omniauth_authorize`) that is generated automatically by OmniAuth.
+
+### Configuration Storage
+
+You will probably want to store your `client_id` as an environment variable, so that it can be shared between the front-end and back-end parts of your application. You can then store `client_secret` as a [Rails Credential](https://guides.rubyonrails.org/security.html#custom-credentials), as it is only required on the server.
+
+### TL;DR Version
+
+After the gem is installed, the TLDR version using Devise is as follows.
+
+Add OmniAuth fields to your User model:
+
+```bash
+rails g migration AddOmniauthToUsers provider:string uid:string
+rake db:migrate
+```
+
+Configure Devise to use the `entra_id_jwt` strategy:
+
+```ruby
+# config/initializers/devise.rb
+
+Devise.setup do |config|
+  ...
+  config.omniauth(
+    :entra_id_jwt,
+    {
+      client_id:     ENV['ENTRA_CLIENT_ID'],
+      client_secret: Rails.application.credentials.entra_client_secret
+    }
+  )
+  ...
+end
+```
+
+Enable this strategy for your User model:
+
+```ruby
+# app/models/user.rb
+
+class User < ApplicationRecord
+  ...
+  devise :omniauthable, omniauth_providers: %i[entra_id_jwt]
+  ...
+end
+```
+
+Configure a route for the controller:
+
+```ruby
+# config/routes.rb
+
+Rails.application.routes.draw do
+  ...
+  devise_for :users, controllers: { omniauth_callbacks: 'users/omniauth_callbacks' }
+  ...
+end
+```
+
+Create a controller to receive the route (the code below assumes all content is rendered in Rails, not client-side):
+
+```ruby
+# app/controllers/users/omniauth_callbacks_controller.rb
+
+class Users::OmniauthCallbacksController < Devise::OmniauthCallbacksController
+  # See https://github.com/omniauth/omniauth/wiki/FAQ#rails-session-is-clobbered-after-callback-on-developer-strategy
+  skip_before_action :verify_authenticity_token, only: :entra_id_jwt
+
+  def entra_id_jwt
+    # You need to implement the method below in your model (e.g. app/models/user.rb)
+    @user = User.from_omniauth(request.env["omniauth.auth"])
+
+    if @user.persisted?
+      sign_in_and_redirect @user, event: :authentication # this will throw if @user is not activated
+      set_flash_message(:notice, :success, kind: "Entra") if is_navigational_format?
+    else
+      session["devise.entra_data"] = request.env["omniauth.auth"].except(:extra) # Removing extra as it can overflow some session stores
+      redirect_to new_user_registration_url
+    end
+  end
+
+  def failure
+    redirect_to root_path
+  end
+end
+```
+
+Add a `#from_omniauth` method to your User:
+
+```ruby
+# app/models/user.rb
+
+class User < ApplicationRecord
+  ...
+  def self.from_omniauth(auth)
+    find_or_create_by(provider: auth.provider, uid: auth.uid) do |user|
+      user.email = auth.info.email
+      user.password = Devise.friendly_token[0, 20]
+      user.name = auth.info.name   # assuming the user model has a name
+      # If you are using confirmable and the provider(s) you use validate emails, 
+      # uncomment the line below to skip the confirmation emails.
+      # user.skip_confirmation!
+    end
+  end
+  ...
+end
+```
+
+Test your application, with some helpful hints in [OmniAuth Integration Testing](https://github.com/omniauth/omniauth/wiki/Integration-Testing).
+
+#### Front End Configuration
+
+Your front-end will need to submit a POST request to the `user_entra_id_jwt_omniauth_callback` route, which is probably something like `/users/auth/entra_id_jwt/callback` unless you have customized this as a Devise route.
+
+The POST request needs to include at least a `code` parameter.
+
+### Configuration options
+
+All of the items listed below are optional, unless noted otherwise. They can be provided either in a static configuration Hash as shown in examples above, or via *read accessor instance methods* in a provider class (more on this later).
+
+| Option | Use |
+| ------ | --- |
+| `client_id`        | **Mandatory.** Client ID for the 'application' (integration) configured on the Entra side. Found via the Entra UI. |
+| `client_secret`    | **Mandatory.** Client secret for the 'application' (integration) configured on the Entra side. Found via the Entra UI. Don't give this if using client assertion flow. |
+| `tenant_id`        | Entra Tenant ID for multi-tenanted use. Default is `common`. Forms part of the Entra OAuth URL - `{base}/{tenant_id}/oauth2/v2.0/...` |
+| `base_url`         | Location of Entra login page, for specialised requirements; default is `OmniAuth::Strategies::EntraId::BASE_URL` (at the time of writing, this is `https://login.microsoftonline.com`). |
+| `authorize_params` | Additional parameters passed as URL query data in the initial OAuth redirection to Microsoft. See below for more. Empty Hash default. |
+| `scope`            | If defined, sets (overwriting, if already present) `scope` inside `authorize_params`. Default is `OmniAuth::Strategies::EntraId::DEFAULT_SCOPE` (at the time of writing, this is `'openid profile email'`).  |
+| `grant_type`            | If defined, sets (overwriting, if already present) `grant_type` inside `authorize_params`. Default is `urn:ietf:params:oauth:grant-type:jwt-bearer`.  |
+| `requested_token_use`            | If defined, sets (overwriting, if already present) `requested_token_use` inside `authorize_params`. Default is `on_behalf_of`.  |
+
+These can be added to the existing configuration:
+
+```ruby
+# config/initializers/devise.rb
+
+Devise.setup do |config|
+  ...
+  config.omniauth(
+    :entra_id_jwt,
+    {
+      client_id:     ENV['ENTRA_CLIENT_ID'],
+      client_secret: Rails.application.credentials.entr_client_secret,
+      scope: 'openid profile email offline_access'
+    }
+  )
+  ...
+end
+```
+
+### Dynamic options via a custom provider class
+
+Similar to [OmniAuth::Entra::Id](https://github.com/pond/omniauth-entra-id/tree/master?tab=readme-ov-file#dynamic-options-via-a-custom-provider-class), the options can be made dynamic by implementing a provider class.
+
+```ruby
+# config/initializers/devise.rb
+
+Devise.setup do |config|
+  ...
+  config.omniauth(:entra_id_jwt, EntraIdProvider)
+  ...
+end
+```
+
+and then creating an appropriate provider (here the `scope` is dependent on a request variable):
+
+```ruby
+class EntraIdProvider
+  def initialize(strategy)
+    @strategy = strategy
+  end
+
+  def client_id
+    ENV['ENTRA_CLIENT_ID']
+  end
+
+  def client_secret
+    Rails.application.credentials.entra_client_secret
+  end
+
+  def scope
+    return 'openid profile email offline_access' if @strategy.request.params['offline']
+    'openid profile email'
+  end
+end
+
+```
+
+### Authorize URL
+
+Given the JWT token is already available, there is no use for the `user_entra_id_jwt_omniauth_authorize` route that is generated automatically by OmniAuth. Attempting to access this route will raise a `NotImplementedError`, which you can rescue from if you wish.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/omniauth-entra_id_jwt. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/omniauth-entra_id_jwt/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the OmniAuth::Entra::Id::JWT project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/omniauth-entra_id_jwt/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/coverage/.last_run.json

@@ -0,0 +1,5 @@
+{
+  "result": {
+    "line": 100.0
+  }
+}

data/coverage/.resultset.json

@@ -0,0 +1,155 @@
+{
+  "RSpec": {
+    "coverage": {
+      "/home/benny/omniauth-entra_id_jwt/lib/omniauth/entra_id_jwt.rb": {
+        "lines": [
+          1,
+          1
+        ]
+      },
+      "/home/benny/omniauth-entra_id_jwt/lib/omniauth/strategies/entra_id_jwt.rb": {
+        "lines": [
+          null,
+          null,
+          1,
+          null,
+          1,
+          1,
+          1,
+          1,
+          null,
+          1,
+          1,
+          null,
+          1,
+          1,
+          null,
+          null,
+          null,
+          null,
+          1,
+          null,
+          1,
+          63,
+          63,
+          null,
+          63,
+          1,
+          null,
+          null,
+          62,
+          null,
+          62,
+          62,
+          null,
+          62,
+          62,
+          1,
+          61,
+          29,
+          null,
+          32,
+          null,
+          62,
+          null,
+          62,
+          null,
+          62,
+          62,
+          null,
+          null,
+          null,
+          62,
+          29,
+          null,
+          33,
+          null,
+          null,
+          null,
+          null,
+          62,
+          29,
+          null,
+          33,
+          null,
+          null,
+          62,
+          null,
+          null,
+          1,
+          44,
+          null,
+          null,
+          null,
+          null,
+          1,
+          null,
+          52,
+          null,
+          null,
+          null,
+          null,
+          null,
+          null,
+          null,
+          null,
+          null,
+          null,
+          null,
+          null,
+          1,
+          null,
+          62,
+          null,
+          null,
+          null,
+          null,
+          null,
+          null,
+          1,
+          1,
+          null,
+          null,
+          1,
+          470,
+          470,
+          null,
+          null,
+          1,
+          44,
+          44,
+          null,
+          null,
+          1,
+          null,
+          1,
+          33,
+          null,
+          null,
+          1,
+          33,
+          null,
+          null,
+          null,
+          null,
+          1,
+          44,
+          43,
+          null,
+          null,
+          null,
+          43,
+          null,
+          42,
+          null,
+          null,
+          null,
+          null,
+          null,
+          1
+        ]
+      }
+    },
+    "timestamp": 1750382784
+  }
+}