omniauth-whop 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f40b76c685c120d98586cb32a4670b466134edbda04ee483b3a0de3b76cf59fc
+  data.tar.gz: 15ef0db76b1671082773a4da4f829770d77875a8d2478bc03ac85cdf86816d4e
+SHA512:
+  metadata.gz: 4e7e8e928104b20a7e20e1cdef47316a5c321cb747df23d2fabb90fb14bdf63539aae8cc0ae14b96b7e388dda0217b7f9d4e6e65b025119b45022d7431b54cdf
+  data.tar.gz: be2e6da775f51fb68f3612918ba9460d7cc0a8dfb98a545beac4bbfd5e008d035da3dd8beb3d2dffe0903a5bbb58c56450ca4a6b91c27ad678916b0ef720a1fc

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## 0.1.0
+
+- Initial Whop OmniAuth strategy with PKCE, state and nonce validation.
+- Verified ES256 ID tokens and matching UserInfo subjects.
+- Standard OmniAuth user profile and token mapping.
+- Sandbox support, Rails/Devise instructions, and a runnable Rack demo.

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Yaroslav Shmarov
+
+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,153 @@
+# OmniAuth Whop
+
+[![CI](https://github.com/yshmarov/omniauth-whop/actions/workflows/ci.yml/badge.svg)](https://github.com/yshmarov/omniauth-whop/actions/workflows/ci.yml)
+
+Add **Sign in with Whop** to a Ruby or Rails app.
+
+A community-maintained [OmniAuth](https://github.com/omniauth/omniauth) strategy by [Yaroslav Shmarov](https://github.com/yshmarov). Not affiliated with or endorsed by Whop. For payments, see [pay-whop](https://github.com/yshmarov/pay-whop).
+
+- Authorization code flow with S256 PKCE and state validation.
+- Fresh nonce for each login; concurrent sign-ins supported.
+- ES256 ID token signature, issuer, audience, expiry, issued-at, nonce, and authorized-party validation.
+- UserInfo subject checked against the verified ID token.
+- Sandbox support. No Rails or Whop SDK dependency.
+
+Requires Ruby 3.2+ and OmniAuth 2 (via `omniauth-oauth2`).
+
+Verified with a real Whop sandbox login on November 15, 2026: authorization, code exchange, signature/claim validation, and UserInfo profile mapping. Production credentials have not been exercised.
+
+## Installation
+
+```ruby
+# Gemfile
+gem "omniauth-whop"
+
+# Rails applications also need request-phase CSRF protection:
+gem "omniauth-rails_csrf_protection"
+```
+
+Then run `bundle install`.
+
+## Configure your Whop app
+
+1. Open your business's **Developer → Apps** page in [Whop sandbox](https://sandbox.whop.com/).
+2. Create an app and open its OAuth settings. Use a name such as `OmniAuth Ruby Sandbox`; Whop rejects app names containing `whop`.
+3. Register your exact callback URL, including protocol and path:
+   - Rails: `http://localhost:3000/auth/whop/callback`
+   - Devise: `http://localhost:3000/users/auth/whop/callback`
+   - Included Rack demo: `http://localhost:9292/auth/whop/callback`
+4. Save the app's client ID and client secret as `WHOP_CLIENT_ID` and `WHOP_CLIENT_SECRET`.
+5. Under **Permissions**, add `oauth:token_exchange`, enter a short explanation, and save. This app API key permission enables the client secret to exchange authorization codes. It is separate from the user-facing `openid profile email` OAuth scopes. See [Whop's authentication guide](https://whop.com/blog/add-user-authentication/).
+
+Use credentials from the same environment as the strategy. Register an HTTPS callback for production and omit `sandbox: true`.
+
+## Rails
+
+```ruby
+# config/initializers/omniauth.rb
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :whop,
+           ENV.fetch("WHOP_CLIENT_ID"),
+           ENV.fetch("WHOP_CLIENT_SECRET"),
+           sandbox: ENV["WHOP_SANDBOX"] == "true"
+end
+```
+
+Initiate sign-in with a POST form:
+
+```erb
+<%= button_to "Sign in with Whop", "/auth/whop", data: { turbo: false } %>
+```
+
+Route `GET /auth/whop/callback` to your sessions controller and read `request.env["omniauth.auth"]`. Route `GET /auth/failure` to your failure handler. Your application owns account creation, account linking, and its login session.
+
+Use `(provider, uid)` as the external identity. Do not automatically link existing accounts using an unverified email address. Email, name, nickname, and image may be absent.
+
+## Devise
+
+Use Devise's configuration instead of installing the middleware a second time:
+
+```ruby
+# config/initializers/devise.rb
+config.omniauth :whop,
+                ENV.fetch("WHOP_CLIENT_ID"),
+                ENV.fetch("WHOP_CLIENT_SECRET"),
+                sandbox: ENV["WHOP_SANDBOX"] == "true"
+```
+
+Add `:omniauthable, omniauth_providers: [:whop]` to your existing `devise` declaration, register an OmniAuth callbacks controller in your Devise routes, and implement its `whop` action using `request.env["omniauth.auth"]`.
+
+```erb
+<%= button_to "Sign in with Whop", user_whop_omniauth_authorize_path,
+              data: { turbo: false } %>
+```
+
+Keep `omniauth-rails_csrf_protection` installed for Devise too.
+
+## Auth hash
+
+```ruby
+{
+  provider: "whop",
+  uid: "user_example",
+  info: {
+    name: "Example User",
+    nickname: "example",
+    email: "example@example.com",
+    email_verified: true,
+    image: "https://example.com/avatar.png"
+  },
+  credentials: {
+    token: "ACCESS_TOKEN",
+    refresh_token: "REFRESH_TOKEN", # when provided
+    expires_at: 1_800_000_000,       # when provided
+    expires: true
+  },
+  extra: {
+    raw_info: { "sub" => "user_example", "..." => "..." }
+  }
+}
+```
+
+Tokens are credentials. Keep them out of logs and browser responses; encrypt them at rest if your application needs to retain them. This strategy authenticates users; checking purchases or membership access is a separate application concern.
+
+## Options
+
+| Option | Default | Purpose |
+| --- | --- | --- |
+| `sandbox` | `false` | Use `https://sandbox-api.whop.com` for OAuth, UserInfo, and signing keys. Pass a Ruby boolean. |
+| `scope` | `"openid profile email"` | Space-separated scopes. `openid` is always included because identity tokens are validated. |
+| `issuer` | `"https://api.whop.com"` | Expected signed ID token issuer. Whop's sandbox discovery document advertises the same issuer. |
+| `client_options` | Whop endpoints | Standard `omniauth-oauth2` client options. Requests default to 5-second connect and 15-second request timeouts. |
+
+Leave PKCE and state validation enabled. The strategy fetches signing keys from the configured environment for each login, avoiding stale-key failures after rotation. Identity comes from a verified ID token plus the authenticated UserInfo endpoint; it never trusts a decoded, unverified JWT.
+
+## Run the sandbox demo
+
+```sh
+git clone https://github.com/yshmarov/omniauth-whop.git
+cd omniauth-whop
+bundle install
+cp .env.example .env
+# Set the sandbox client ID and secret in .env.
+bundle exec rackup examples/config.ru --host localhost --port 9292
+```
+
+Open `http://localhost:9292` and click **Sign in with Whop**. The demo displays the provider, user ID, and profile after a successful callback. It does not display or save access/refresh tokens. Its generated session secret changes on restart; set `SESSION_SECRET` to a random value of at least 64 bytes for a stable local session.
+
+## Development
+
+```sh
+bundle install
+bundle exec rake
+bundle exec rubocop
+gem build omniauth-whop.gemspec
+```
+
+Tests exercise the real OmniAuth middleware and HTTP boundary with generated signing keys and stubbed Whop responses. External HTTP is disabled in the test suite. CI runs Ruby 3.2, 3.3, 3.4, and 4.0.
+
+Report bugs with a minimal reproduction, Ruby/gem versions, and the failure type. Do not include credentials, authorization codes, or customer data. To report a security issue privately, use [GitHub's security advisory form](https://github.com/yshmarov/omniauth-whop/security/advisories/new).
+
+## License
+
+[MIT](LICENSE)

data/lib/omniauth/strategies/whop.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require "omniauth-oauth2"
+require "jwt"
+
+module OmniAuth
+  module Strategies
+    # Whop OAuth authorization-code flow with PKCE and verified OIDC identity.
+    class Whop < OAuth2
+      option :name, "whop"
+      option :scope, "openid profile email"
+      option :pkce, true
+      option :sandbox, false
+      # Whop's sandbox discovery document also advertises this issuer.
+      option :issuer, "https://api.whop.com"
+      option :client_options, {
+        site: "https://api.whop.com",
+        authorize_url: "/oauth/authorize",
+        token_url: "/oauth/token",
+        auth_scheme: :request_body,
+        connection_opts: { request: { timeout: 15, open_timeout: 5 } }
+      }
+
+      uid { raw_info.fetch("sub") }
+
+      info do
+        {
+          name: raw_info["name"],
+          nickname: raw_info["preferred_username"],
+          email: raw_info["email"],
+          image: raw_info["picture"],
+          email_verified: raw_info["email_verified"]
+        }.compact
+      end
+
+      extra { { raw_info: raw_info } }
+
+      def client
+        oauth_client = super
+        oauth_client.site = "https://sandbox-api.whop.com" if options.sandbox
+        oauth_client
+      end
+
+      def authorize_params
+        params = super
+        params[:scope] = (["openid"] + params[:scope].to_s.split).uniq.join(" ")
+        params[:nonce] = SecureRandom.urlsafe_base64(32)
+        nonces = session.fetch("omniauth.whop.nonces", {}).dup
+        nonces[params.fetch(:state)] = params[:nonce]
+        session["omniauth.whop.nonces"] = nonces.to_a.last(3).to_h
+        params
+      end
+
+      def callback_phase
+        nonces = session.fetch("omniauth.whop.nonces", {}).dup
+        @expected_nonce = nonces.delete(request.params["state"])
+        session["omniauth.whop.nonces"] = nonces
+        super
+      rescue JWT::DecodeError, JSON::ParserError, KeyError => e
+        fail!(:invalid_credentials, CallbackError.new(:invalid_identity, e.class.name))
+      end
+
+      def raw_info
+        @raw_info ||= begin
+          profile = access_token.get("/oauth/userinfo").parsed
+          unless profile.is_a?(Hash) && profile["sub"] == @id_token_claims.fetch("sub")
+            raise CallbackError.new(:invalid_identity, "UserInfo subject does not match ID token")
+          end
+
+          profile
+        end
+      end
+
+      def callback_url
+        full_host + callback_path
+      end
+
+      protected
+
+      def build_access_token
+        token = super
+        validate_id_token!(token.params["id_token"])
+        token
+      end
+
+      def validate_id_token!(id_token)
+        if id_token.to_s.empty? || @expected_nonce.to_s.empty?
+          raise CallbackError.new(:invalid_identity,
+                                  "Missing ID token or nonce")
+        end
+
+        jwks = client.request(:get, "/.well-known/jwks.json", parse: :json, snaky: false).parsed
+        @id_token_claims = JWT.decode(
+          id_token, nil, true,
+          algorithms: ["ES256"], jwks: jwks,
+          iss: options.issuer, verify_iss: true,
+          aud: options.client_id, verify_aud: true,
+          verify_iat: true, required_claims: %w[iss sub aud exp iat nonce]
+        ).first
+        unless secure_compare(@id_token_claims["nonce"].to_s, @expected_nonce)
+          raise CallbackError.new(:invalid_identity, "ID token nonce mismatch")
+        end
+        raise CallbackError.new(:invalid_identity, "Missing ID token subject") if @id_token_claims["sub"].to_s.empty?
+
+        audiences = Array(@id_token_claims["aud"])
+        authorized_party = @id_token_claims["azp"]
+        return unless (audiences.size > 1 || authorized_party) && authorized_party != options.client_id
+
+        raise CallbackError.new(:invalid_identity, "ID token authorized party mismatch")
+      end
+    end
+  end
+end

data/lib/omniauth/whop/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module OmniAuth
+  module Whop
+    VERSION = "0.1.0"
+  end
+end

data/lib/omniauth-whop.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "omniauth/whop/version"
+require "omniauth/strategies/whop"

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-whop
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yaroslav Shmarov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.1
+description: A community OmniAuth strategy for Whop with PKCE, verified OpenID Connect
+  ID tokens, and sandbox support.
+email:
+- yshmarov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/omniauth-whop.rb
+- lib/omniauth/strategies/whop.rb
+- lib/omniauth/whop/version.rb
+homepage: https://github.com/yshmarov/omniauth-whop
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/yshmarov/omniauth-whop
+  changelog_uri: https://github.com/yshmarov/omniauth-whop/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Sign in with Whop for OmniAuth
+test_files: []