Beautiful Open-Source Form Builder
Implement 'require_state' option for OIDC connections and enhance SSO flow
JhumanJ51309c3f8ab6
diff --git a/api/app/Enterprise/Oidc/Requests/StoreOidcConnectionRequest.php b/api/app/Enterprise/Oidc/Requests/StoreOidcConnectionRequest.phpindex 971453935..bd2fafd8d 100644--- a/api/app/Enterprise/Oidc/Requests/StoreOidcConnectionRequest.php+++ b/api/app/Enterprise/Oidc/Requests/StoreOidcConnectionRequest.php@@ -50,6 +50,7 @@ class StoreOidcConnectionRequest extends FormRequest'scopes' => ['nullable', 'array'],'scopes.*' => ['string'],'options' => ['nullable', 'array'],+ 'options.require_state' => ['nullable', 'boolean'],'options.field_mappings' => ['nullable', 'array'],'options.field_mappings.email' => ['nullable', 'string', 'max:255'],'options.field_mappings.name' => ['nullable', 'string', 'max:255'],@@ -74,5 +75,14 @@ class StoreOidcConnectionRequest extends FormRequestif (!$this->has('enabled')) {$this->merge(['enabled' => true]);}++ if (!$this->has('options.require_state')) {+ $options = $this->input('options', []);+ if (!is_array($options)) {+ $options = [];+ }+ $options['require_state'] = true;+ $this->merge(['options' => $options]);+ }}}diff --git a/api/app/Enterprise/Oidc/Requests/UpdateOidcConnectionRequest.php b/api/app/Enterprise/Oidc/Requests/UpdateOidcConnectionRequest.phpindex c410a21dd..eae173e19 100644--- a/api/app/Enterprise/Oidc/Requests/UpdateOidcConnectionRequest.php+++ b/api/app/Enterprise/Oidc/Requests/UpdateOidcConnectionRequest.php@@ -54,6 +54,7 @@ class UpdateOidcConnectionRequest extends FormRequest'scopes' => ['nullable', 'array'],'scopes.*' => ['string'],'options' => ['nullable', 'array'],+ 'options.require_state' => ['nullable', 'boolean'],'options.field_mappings' => ['nullable', 'array'],'options.field_mappings.email' => ['nullable', 'string', 'max:255'],'options.field_mappings.name' => ['nullable', 'string', 'max:255'],diff --git a/api/app/Http/Controllers/Auth/SsoController.php b/api/app/Http/Controllers/Auth/SsoController.phpindex ebd7ecc1e..e26b52ee4 100644--- a/api/app/Http/Controllers/Auth/SsoController.php+++ b/api/app/Http/Controllers/Auth/SsoController.php@@ -10,7 +10,9 @@ use App\Http\Controllers\Auth\Traits\ManagesJWT;use App\Http\Controllers\Controller;use App\Enterprise\Oidc\ProvisioningService;use Illuminate\Http\Request;+use Illuminate\Support\Facades\Cache;use Illuminate\Support\Facades\Log;+use Illuminate\Support\Str;use Symfony\Component\HttpKernel\Exception\HttpException;class SsoController extends Controller@@ -47,6 +49,14 @@ class SsoController extends Controllertry {$driver = $this->connectionManager->buildDriver($connection);++ $requireState = (bool) data_get($connection->options, 'require_state', false);+ if ($requireState) {+ $state = Str::random(32);+ Cache::put("oidc_state_{$state}", true, 600);+ $driver->setState($state);+ }+$redirectUrl = $driver->getRedirectUrl();return response()->json([@@ -83,6 +93,23 @@ class SsoController extends Controller}try {+ $requireState = (bool) data_get($connection->options, 'require_state', false);+ if ($requireState) {+ $state = $request->input('state');+ if (!$state) {+ return response()->json([+ 'message' => 'Missing or invalid state. Please try again.',+ ], 400);+ }++ $stateValid = Cache::pull("oidc_state_{$state}");+ if (!$stateValid) {+ return response()->json([+ 'message' => 'Invalid state. Please try again.',+ ], 400);+ }+ }+$driver = $this->connectionManager->buildDriver($connection);$driver->setRedirectUrl($connection->redirect_url);diff --git a/api/tests/Feature/Enterprise/Oidc/SsoControllerTest.php b/api/tests/Feature/Enterprise/Oidc/SsoControllerTest.phpindex 120cb0bfb..4f904709c 100644--- a/api/tests/Feature/Enterprise/Oidc/SsoControllerTest.php+++ b/api/tests/Feature/Enterprise/Oidc/SsoControllerTest.php@@ -271,6 +271,70 @@ describe('SsoController - Callback', function () {expect($response->json('new_user'))->toBeTrue();});+ it('rejects callback when state is required but missing', function () {+ $connection = IdentityConnection::factory()->create([+ 'slug' => 'state-required',+ 'enabled' => true,+ 'options' => [+ 'require_state' => true,+ ],+ ]);++ $response = $this->getJson("/auth/{$connection->slug}/callback", [+ 'Accept' => 'application/json',+ ]);++ $response->assertStatus(400);+ expect($response->json('message'))->toContain('Missing or invalid state');+ });++ it('accepts callback when state is valid and required', function () {+ $connection = IdentityConnection::factory()->create([+ 'slug' => 'state-valid',+ 'enabled' => true,+ 'options' => [+ 'require_state' => true,+ ],+ ]);++ $state = 'state-token-12345678';+ \Illuminate\Support\Facades\Cache::put("oidc_state_{$state}", true, 600);++ $socialiteUser = createMockSocialiteUser(+ email: '[email protected]',+ name: 'State User'+ );+ $idTokenClaims = createValidIdTokenClaims($connection, 'sub-state');+ $idToken = createMockIdToken($idTokenClaims);++ $mockDriver = Mockery::mock(\App\Enterprise\Oidc\Adapters\OAuthOidcDriver::class);+ $mockDriver->shouldReceive('setRedirectUrl')->andReturnSelf();+ $mockDriver->shouldReceive('getUser')->andReturn($socialiteUser);+ $mockDriver->shouldReceive('getIdToken')->andReturn($idToken);++ $mockConnectionManager = Mockery::mock(\App\Enterprise\Oidc\ConnectionManager::class);+ $mockConnectionManager->shouldReceive('getConnectionBySlug')+ ->with('state-valid')+ ->andReturn($connection);+ $mockConnectionManager->shouldReceive('buildDriver')+ ->with($connection)+ ->andReturn($mockDriver);++ $mockIdTokenVerifier = Mockery::mock(\App\Enterprise\Oidc\IdTokenVerifier::class);+ $mockIdTokenVerifier->shouldReceive('verifySignature')+ ->with($connection, $idToken)+ ->andReturnNull();++ $this->app->instance(\App\Enterprise\Oidc\ConnectionManager::class, $mockConnectionManager);+ $this->app->instance(\App\Enterprise\Oidc\IdTokenVerifier::class, $mockIdTokenVerifier);++ $response = $this->getJson("/auth/{$connection->slug}/callback?state={$state}", [+ 'Accept' => 'application/json',+ ]);++ $response->assertSuccessful();+ });+it('returns 404 for non-existent connection', function () {$mockConnectionManager = Mockery::mock(\App\Enterprise\Oidc\ConnectionManager::class);$mockConnectionManager->shouldReceive('getConnectionBySlug')diff --git a/client/components/workspaces/settings/Oidc.vue b/client/components/workspaces/settings/Oidc.vueindex 88a9a0f2f..6281ade3f 100644--- a/client/components/workspaces/settings/Oidc.vue+++ b/client/components/workspaces/settings/Oidc.vue@@ -92,6 +92,7 @@<script setup>import { useOidcConnections } from '~/composables/query/useOidcConnections'+import { getOidcRequireStateDefault, getOidcRequireStateForEdit } from "~/lib/oidc/connection-options"import OidcConnectionCard from './OidcConnectionCard.vue'import OidcConnectionModal from './OidcConnectionModal.vue'@@ -177,6 +178,7 @@ const connectionForm = useForm({domain: '',enabled: true,options: {+ require_state: getOidcRequireStateDefault(),field_mappings: {email: '',name: ''@@ -233,6 +235,7 @@ const editConnection = (connection) => {enabled: connection.enabled,domain: connection.domain ?? '',options: {+ require_state: getOidcRequireStateForEdit(connection.options),field_mappings: {email: connection.options?.field_mappings?.email ?? '',name: connection.options?.field_mappings?.name ?? ''diff --git a/client/components/workspaces/settings/sso/OidcConnectionModal.vue b/client/components/workspaces/settings/sso/OidcConnectionModal.vueindex 06373f15a..bd298e6d5 100644--- a/client/components/workspaces/settings/sso/OidcConnectionModal.vue+++ b/client/components/workspaces/settings/sso/OidcConnectionModal.vue@@ -98,6 +98,13 @@placeholder="your-client-secret"/>+ <ToggleSwitchInput+ name="options.require_state"+ :form="form"+ label="Require state parameter"+ help="Recommended: validates the state parameter on callback. Disable only if your IdP cannot send state."+ />+<ToggleSwitchInputname="enabled"class="mt-2"diff --git a/client/lib/oidc/connection-options.js b/client/lib/oidc/connection-options.jsnew file mode 100644index 000000000..0e7a4061e--- /dev/null+++ b/client/lib/oidc/connection-options.js@@ -0,0 +1,5 @@+export const getOidcRequireStateDefault = () => true++export const getOidcRequireStateForEdit = (options) => {+ return options?.require_state ?? false+}diff --git a/client/test/unit/oidc-connection-options.test.ts b/client/test/unit/oidc-connection-options.test.tsnew file mode 100644index 000000000..194ad266a--- /dev/null+++ b/client/test/unit/oidc-connection-options.test.ts@@ -0,0 +1,18 @@+import { describe, it, expect } from 'vitest'+import { getOidcRequireStateDefault, getOidcRequireStateForEdit } from '../../lib/oidc/connection-options.js'++describe('oidc connection options', () => {+ it('defaults require_state to true for new connections', () => {+ expect(getOidcRequireStateDefault()).toBe(true)+ })++ it('returns false when require_state is missing', () => {+ expect(getOidcRequireStateForEdit(undefined)).toBe(false)+ expect(getOidcRequireStateForEdit({})).toBe(false)+ })++ it('returns stored require_state for existing connections', () => {+ expect(getOidcRequireStateForEdit({ require_state: true })).toBe(true)+ expect(getOidcRequireStateForEdit({ require_state: false })).toBe(false)+ })+})