Skip to content

feat: OIDC support for jwks #497

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hareland wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat: OIDC support for jwks #497

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d9c27d5
feat: add support for jwks
hareland Feb 2, 2026
cf87c85
feat: pass claims & type IdToken
hareland Feb 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 33 additions & 4 deletions src/runtime/server/lib/oauth/oidc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ import { createError, eventHandler, getQuery, sendRedirect } from 'h3'
import type { QueryObject } from 'ufo'
import { withQuery } from 'ufo'
import type { RequestAccessTokenBody } from '../utils'
import { getOAuthRedirectURL, handleAccessTokenErrorResponse, handleInvalidState, handleMissingConfiguration, handlePkceVerifier, handleState, requestAccessToken, handleNonce, parseJwt } from '../utils'
import { verifyJwt, getOAuthRedirectURL, handleAccessTokenErrorResponse, handleInvalidState, handleMissingConfiguration, handlePkceVerifier, handleState, requestAccessToken, handleNonce, parseJwt } from '../utils'
import type { JWTPayload } from 'jose'

export interface OAuthOidcConfig {
/**
Expand Down Expand Up @@ -230,6 +231,8 @@ interface OidcTokens {
id_token?: string
refresh_token?: string
expires_in?: number
jwks_uri?: string
issuer?: string
}

interface OIDCConfiguration {
Expand All @@ -238,10 +241,14 @@ interface OIDCConfiguration {
userinfo_endpoint?: string
}

interface IdTokenPayload extends JWTPayload {
nonce?: string
}

/**
* Event handler for generic OAuth using OIDC and PKCE.
*/
export function defineOAuthOidcEventHandler<TUser = OidcUser>({ config, onSuccess, onError }: OAuthConfig<OAuthOidcConfig, { user: TUser, tokens: OidcTokens }>) {
export function defineOAuthOidcEventHandler<TUser = OidcUser>({ config, onSuccess, onError }: OAuthConfig<OAuthOidcConfig, { user: TUser, tokens: OidcTokens, claims?: IdTokenPayload }>) {
return eventHandler(async (event: H3Event) => {
config = defu(config, useRuntimeConfig(event).oauth.oidc, {
scope: ['openid'],
Expand Down Expand Up @@ -313,9 +320,30 @@ export function defineOAuthOidcEventHandler<TUser = OidcUser>({ config, onSucces
if (tokens.error) {
return handleAccessTokenErrorResponse(event, 'oidc', tokens, onError)
}

// Since not all OIDC providers support the userinfo endpoint,
// this should probably be allowed as "user" when verified?
let claims: IdTokenPayload | undefined
if (tokens.id_token) {
const claims = parseJwt(tokens.id_token)
if (!oidcConfig.jwks_uri || !oidcConfig.issuer) {
claims = parseJwt(tokens.id_token)
}
else {
claims = await verifyJwt(tokens.id_token, {
publicJwkUrl: oidcConfig.jwks_uri,
issuer: oidcConfig.issuer,
audience: config.clientId,
})
}

if (!claims) {
const error = createError({
statusCode: 401,
message: 'OIDC login failed: invalid id_token',
})
if (!onError) throw error
return onError(event, error)
}

if (claims.nonce !== nonce) {
const error = createError({
statusCode: 401,
Expand Down Expand Up @@ -343,6 +371,7 @@ export function defineOAuthOidcEventHandler<TUser = OidcUser>({ config, onSucces
return onSuccess(event, {
user,
tokens,
claims,
})
})
}