diff --git a/playground/.env.example b/playground/.env.example index a12b96a..4544229 100644 --- a/playground/.env.example +++ b/playground/.env.example @@ -77,3 +77,7 @@ NUXT_OAUTH_POLAR_CLIENT_SECRET= # Linear NUXT_OAUTH_LINEAR_CLIENT_ID= NUXT_OAUTH_LINEAR_CLIENT_SECRET= +# Zitadel +NUXT_OAUTH_ZITADEL_CLIENT_ID= +NUXT_OAUTH_ZITADEL_CLIENT_SECRET= +NUXT_OAUTH_ZITADEL_DOMAIN= diff --git a/playground/app.vue b/playground/app.vue index e6d7970..9dc5ebf 100644 --- a/playground/app.vue +++ b/playground/app.vue @@ -147,6 +147,12 @@ const providers = computed(() => disabled: Boolean(user.value?.polar), icon: 'i-iconoir-polar-sh', }, + { + label: user.value?.zitadel || 'Zitadel', + to: '/auth/zitadel', + disabled: Boolean(user.value?.zitadel), + icon: 'i-gravity-ui-lock', + }, ].map(p => ({ ...p, prefetch: false, diff --git a/playground/auth.d.ts b/playground/auth.d.ts index 79ef4bc..766ae0a 100644 --- a/playground/auth.d.ts +++ b/playground/auth.d.ts @@ -27,6 +27,7 @@ declare module '#auth-utils' { tiktok?: string dropbox?: string polar?: string + zitadel?: string } interface UserSession { diff --git a/playground/server/routes/auth/zitadel.get.ts b/playground/server/routes/auth/zitadel.get.ts new file mode 100644 index 0000000..31dc071 --- /dev/null +++ b/playground/server/routes/auth/zitadel.get.ts @@ -0,0 +1,15 @@ +export default defineOAuthZitadelEventHandler({ + config: { + scope: ['openid', 'email', 'profile'], + }, + async onSuccess(event, { user }) { + await setUserSession(event, { + user: { + zitadel: user.name, + }, + loggedInAt: Date.now(), + }) + + return sendRedirect(event, '/') + }, +}) diff --git a/src/module.ts b/src/module.ts index 66a3967..bed3dc6 100644 --- a/src/module.ts +++ b/src/module.ts @@ -308,5 +308,12 @@ export default defineNuxtModule({ clientSecret: '', redirectURL: '', }) + // Zitadel OAuth + runtimeConfig.oauth.zitadel = defu(runtimeConfig.oauth.zitadel, { + clientId: '', + clientSecret: '', + domain: '', + redirectURL: '', + }) }, }) diff --git a/src/runtime/server/lib/oauth/zitadel.ts b/src/runtime/server/lib/oauth/zitadel.ts new file mode 100644 index 0000000..351933b --- /dev/null +++ b/src/runtime/server/lib/oauth/zitadel.ts @@ -0,0 +1,131 @@ +import type { H3Event } from 'h3' +import { eventHandler, getQuery, sendRedirect } from 'h3' +import { withQuery } from 'ufo' +import { defu } from 'defu' +import { handleMissingConfiguration, handleAccessTokenErrorResponse, getOAuthRedirectURL, requestAccessToken } from '../utils' +import { useRuntimeConfig, createError } from '#imports' +import type { OAuthConfig } from '#auth-utils' + +export interface OAuthZitadelConfig { + /** + * ZITADEL OAuth Client ID + * @default process.env.NUXT_OAUTH_ZITADEL_CLIENT_ID + */ + clientId?: string + /** + * ZITADEL OAuth Client Secret + * @default process.env.NUXT_OAUTH_ZITADEL_CLIENT_SECRET + */ + clientSecret?: string + /** + * ZITADEL OAuth Domain + * @example .zitadel.cloud + * @default process.env.NUXT_OAUTH_ZITADEL_DOMAIN + */ + domain?: string + /** + * ZITADEL OAuth Scope + * @default ['openid'] + * @see https://zitadel.com/docs/apis/openidoauth/scopes + * @example ['openid', 'profile', 'email'] + */ + scope?: string[] + /** + * Extra authorization parameters to provide to the authorization URL + * @example { ui_locales: 'de-CH de en' } + */ + authorizationParams?: Record + /** + * Redirect URL to allow overriding for situations like prod failing to determine public hostname + * @default process.env.NUXT_OAUTH_ZITADEL_REDIRECT_URL or current URL + */ + redirectURL?: string +} + +export function defineOAuthZitadelEventHandler({ config, onSuccess, onError }: OAuthConfig) { + return eventHandler(async (event: H3Event) => { + config = defu(config, useRuntimeConfig(event).oauth?.zitadel, { + authorizationParams: {}, + }) as OAuthZitadelConfig + + const query = getQuery<{ code?: string, error?: string }>(event) + + if (query.error) { + const error = createError({ + statusCode: 401, + message: `Zitadel login failed: ${query.error || 'Unknown error'}`, + data: query, + }) + if (!onError) throw error + return onError(event, error) + } + + if (!config.clientId || !config.clientSecret || !config.domain) { + return handleMissingConfiguration(event, 'zitadel', ['clientId', 'clientSecret', 'issuerUrl'], onError) + } + + const authorizationURL = `https://${config.domain}/oauth/v2/authorize` + const tokenURL = `https://${config.domain}/oauth/v2/token` + const redirectURL = config.redirectURL || getOAuthRedirectURL(event) + + if (!query.code) { + config.scope = config.scope || ['openid'] + // Redirect to Zitadel OAuth page + + return sendRedirect( + event, + withQuery(authorizationURL, { + response_type: 'code', + client_id: config.clientId, + redirect_uri: redirectURL, + scope: config.scope.join(' '), + ...config.authorizationParams, + }), + ) + } + + const tokens = await requestAccessToken(tokenURL, { + headers: { + 'Authorization': `Basic ${Buffer.from(`${config.clientId}:${config.clientSecret}`).toString('base64')}`, + 'Content-Type': 'application/x-www-form-urlencoded', + }, + body: { + grant_type: 'authorization_code', + client_id: config.clientId, + redirect_uri: redirectURL, + code: query.code, + }, + }) + + if (tokens.error) { + return handleAccessTokenErrorResponse(event, 'zitadel', tokens, onError) + } + + const accessToken = tokens.access_token + // Fetch user info + // eslint-disable-next-line @typescript-eslint/no-explicit-any + const user: any = await $fetch(`https://${config.domain}/oidc/v1/userinfo`, { + headers: { + Authorization: `Bearer ${accessToken}`, + Accept: 'application/json', + }, + }) + + console.log('Zitadel user:', user) + + if (!user) { + const error = createError({ + statusCode: 500, + message: 'Could not get Zitadel user', + data: tokens, + }) + if (!onError) throw error + return onError(event, error) + } + + return onSuccess(event, { + user, + tokens, + }) + }) +} diff --git a/src/runtime/types/oauth-config.ts b/src/runtime/types/oauth-config.ts index e5abff9..9f040b6 100644 --- a/src/runtime/types/oauth-config.ts +++ b/src/runtime/types/oauth-config.ts @@ -1,6 +1,6 @@ import type { H3Event, H3Error } from 'h3' -export type OAuthProvider = 'auth0' | 'battledotnet' | 'cognito' | 'discord' | 'dropbox' | 'facebook' | 'github' | 'gitlab' | 'google' | 'instagram' | 'keycloak' | 'linear' | 'linkedin' | 'microsoft' | 'paypal' | 'polar' | 'spotify' | 'steam' | 'tiktok' | 'twitch' | 'vk' | 'x' | 'xsuaa' | 'yandex' | (string & {}) +export type OAuthProvider = 'auth0' | 'battledotnet' | 'cognito' | 'discord' | 'dropbox' | 'facebook' | 'github' | 'gitlab' | 'google' | 'instagram' | 'keycloak' | 'linear' | 'linkedin' | 'microsoft' | 'paypal' | 'polar' | 'spotify' | 'steam' | 'tiktok' | 'twitch' | 'vk' | 'x' | 'xsuaa' | 'yandex' | 'zitadel' | (string & {}) export type OnError = (event: H3Event, error: H3Error) => Promise | void