@zpg6-test-pkgs/better-auth
Version:
The most comprehensive authentication library for TypeScript.
820 lines (814 loc) • 34.5 kB
JavaScript
'use strict';
const z = require('zod/v4');
const betterCall = require('better-call');
const socialProviders_index = require('../../shared/better-auth.afydZyFs.cjs');
const session = require('../../shared/better-auth.DmBU2Klq.cjs');
const cookies_index = require('../../shared/better-auth.l2-e84v_.cjs');
require('../../shared/better-auth.BIMq4RPW.cjs');
require('../../shared/better-auth.B6fIklBU.cjs');
require('../../shared/better-auth.B3274wGK.cjs');
const fetch = require('@better-fetch/fetch');
require('@better-auth/utils/base64');
const jose = require('jose');
require('../../shared/better-auth.C1hdVENX.cjs');
require('@better-auth/utils/hash');
require('../../crypto/index.cjs');
require('@noble/ciphers/chacha');
require('@noble/ciphers/utils');
require('@noble/ciphers/webcrypto');
require('@noble/hashes/scrypt');
require('@better-auth/utils');
require('@better-auth/utils/hex');
require('@noble/hashes/utils');
require('../../shared/better-auth.CYeOI8C-.cjs');
require('@better-auth/utils/random');
require('../../shared/better-auth.DRmln2Nr.cjs');
require('../../shared/better-auth.ANpbi45u.cjs');
require('jose/errors');
require('../../shared/better-auth.vPQBmXQL.cjs');
require('../../shared/better-auth.Bg6iw3ig.cjs');
require('@better-auth/utils/hmac');
require('@better-auth/utils/binary');
require('defu');
function _interopNamespaceCompat(e) {
if (e && typeof e === 'object' && 'default' in e) return e;
const n = Object.create(null);
if (e) {
for (const k in e) {
n[k] = e[k];
}
}
n.default = e;
return n;
}
const z__namespace = /*#__PURE__*/_interopNamespaceCompat(z);
const sso = (options) => {
return {
id: "sso",
endpoints: {
/**
* ### Endpoint
*
* POST `/sso/register`
*
* ### API Methods
*
* **server:**
* `auth.api.createOIDCProvider`
*
* **client:**
* `authClient.sso.register`
*
* @see [Read our docs to learn more.](https://better-auth.com/docs/plugins/sso#api-method-sso-register)
*/
createOIDCProvider: session.createAuthEndpoint(
"/sso/register",
{
method: "POST",
body: z__namespace.object({
providerId: z__namespace.string().meta({
description: 'The ID of the provider. This is used to identify the provider during login and callback. Eg: "example-provider"'
}),
issuer: z__namespace.string().meta({
description: 'The issuer url of the provider. Eg: "https://idp.example.com"'
}),
domain: z__namespace.string().meta({
description: 'The domain of the provider. This is used for email matching. Eg: "example.com"'
}),
clientId: z__namespace.string().meta({
description: 'The client ID. Eg: "1234567890"'
}),
clientSecret: z__namespace.string().meta({
description: 'The client secret. Eg: "1234567890"'
}),
authorizationEndpoint: z__namespace.string().meta({
description: 'The authorization endpoint. Eg: "https://idp.example.com/authorize"'
}).optional(),
tokenEndpoint: z__namespace.string().meta({
description: 'The token endpoint. Eg: "https://idp.example.com/token"'
}).optional(),
userInfoEndpoint: z__namespace.string().meta({
description: 'The user info endpoint. Eg: "https://idp.example.com/userinfo"'
}).optional(),
tokenEndpointAuthentication: z__namespace.enum(["client_secret_post", "client_secret_basic"]).meta({
description: `The authentication method for the token endpoint. Defaults to 'client_secret_post'. Eg: "client_secret_post"`
}).optional(),
jwksEndpoint: z__namespace.string().meta({
description: 'The JWKS endpoint. Eg: "https://idp.example.com/.well-known/jwks.json"'
}).optional(),
discoveryEndpoint: z__namespace.string().optional(),
scopes: z__namespace.array(z__namespace.string()).meta({
description: "The scopes to request. Defaults to ['openid', 'email', 'profile', 'offline_access']. Eg: ['openid', 'email', 'profile']"
}).optional(),
pkce: z__namespace.boolean().meta({
description: "Whether to use PKCE for the authorization flow. Eg: true"
}).default(true).optional(),
mapping: z__namespace.object({
id: z__namespace.string().meta({
description: `The field in the user info response that contains the id. Defaults to 'sub'. Eg: "sub"`
}),
email: z__namespace.string().meta({
description: `The field in the user info response that contains the email. Defaults to 'email'. Eg: "email"`
}),
emailVerified: z__namespace.string().meta({
description: `The field in the user info response that contains whether the email is verified. defaults to 'email_verified'. Eg: "email_verified"`
}).optional(),
name: z__namespace.string().meta({
description: `The field in the user info response that contains the name. Defaults to 'name'. Eg: "name"`
}),
image: z__namespace.string().meta({
description: `The field in the user info response that contains the image. Defaults to 'picture'. Eg: "picture"`
}).optional(),
extraFields: z__namespace.record(z__namespace.string(), z__namespace.any()).optional()
}).optional(),
organizationId: z__namespace.string().meta({
description: 'If organization plugin is enabled, the organization id to link the provider to. Eg: "some-org-id"'
}).optional(),
overrideUserInfo: z__namespace.boolean().meta({
description: "Override user info with the provider info. Defaults to false"
}).default(false).optional()
}),
use: [session.sessionMiddleware],
metadata: {
openapi: {
summary: "Register an OIDC provider",
description: "This endpoint is used to register an OIDC provider. This is used to configure the provider and link it to an organization",
responses: {
"200": {
description: "OIDC provider created successfully",
content: {
"application/json": {
schema: {
type: "object",
properties: {
issuer: {
type: "string",
format: "uri",
description: "The issuer URL of the provider"
},
domain: {
type: "string",
description: "The domain of the provider, used for email matching"
},
oidcConfig: {
type: "object",
properties: {
issuer: {
type: "string",
format: "uri",
description: "The issuer URL of the provider"
},
pkce: {
type: "boolean",
description: "Whether PKCE is enabled for the authorization flow"
},
clientId: {
type: "string",
description: "The client ID for the provider"
},
clientSecret: {
type: "string",
description: "The client secret for the provider"
},
authorizationEndpoint: {
type: "string",
format: "uri",
nullable: true,
description: "The authorization endpoint URL"
},
discoveryEndpoint: {
type: "string",
format: "uri",
description: "The discovery endpoint URL"
},
userInfoEndpoint: {
type: "string",
format: "uri",
nullable: true,
description: "The user info endpoint URL"
},
scopes: {
type: "array",
items: { type: "string" },
nullable: true,
description: "The scopes requested from the provider"
},
tokenEndpoint: {
type: "string",
format: "uri",
nullable: true,
description: "The token endpoint URL"
},
tokenEndpointAuthentication: {
type: "string",
enum: [
"client_secret_post",
"client_secret_basic"
],
nullable: true,
description: "Authentication method for the token endpoint"
},
jwksEndpoint: {
type: "string",
format: "uri",
nullable: true,
description: "The JWKS endpoint URL"
},
mapping: {
type: "object",
nullable: true,
properties: {
id: {
type: "string",
description: "Field mapping for user ID (defaults to 'sub')"
},
email: {
type: "string",
description: "Field mapping for email (defaults to 'email')"
},
emailVerified: {
type: "string",
nullable: true,
description: "Field mapping for email verification (defaults to 'email_verified')"
},
name: {
type: "string",
description: "Field mapping for name (defaults to 'name')"
},
image: {
type: "string",
nullable: true,
description: "Field mapping for image (defaults to 'picture')"
},
extraFields: {
type: "object",
additionalProperties: { type: "string" },
nullable: true,
description: "Additional field mappings"
}
},
required: ["id", "email", "name"]
}
},
required: [
"issuer",
"pkce",
"clientId",
"clientSecret",
"discoveryEndpoint"
],
description: "OIDC configuration for the provider"
},
organizationId: {
type: "string",
nullable: true,
description: "ID of the linked organization, if any"
},
userId: {
type: "string",
description: "ID of the user who registered the provider"
},
providerId: {
type: "string",
description: "Unique identifier for the provider"
},
redirectURI: {
type: "string",
format: "uri",
description: "The redirect URI for the provider callback"
}
},
required: [
"issuer",
"domain",
"oidcConfig",
"userId",
"providerId",
"redirectURI"
]
}
}
}
}
}
}
}
},
async (ctx) => {
const body = ctx.body;
const issuerValidator = z__namespace.string().url();
if (issuerValidator.safeParse(body.issuer).error) {
throw new betterCall.APIError("BAD_REQUEST", {
message: "Invalid issuer. Must be a valid URL"
});
}
const provider = await ctx.context.adapter.create({
model: "ssoProvider",
data: {
issuer: body.issuer,
domain: body.domain,
oidcConfig: JSON.stringify({
issuer: body.issuer,
clientId: body.clientId,
clientSecret: body.clientSecret,
authorizationEndpoint: body.authorizationEndpoint,
tokenEndpoint: body.tokenEndpoint,
tokenEndpointAuthentication: body.tokenEndpointAuthentication,
jwksEndpoint: body.jwksEndpoint,
pkce: body.pkce,
discoveryEndpoint: body.discoveryEndpoint || `${body.issuer}/.well-known/openid-configuration`,
mapping: body.mapping,
scopes: body.scopes,
userInfoEndpoint: body.userInfoEndpoint,
overrideUserInfo: ctx.body.overrideUserInfo || options?.defaultOverrideUserInfo || false
}),
organizationId: body.organizationId,
userId: ctx.context.session.user.id,
providerId: body.providerId
}
});
return ctx.json({
...provider,
oidcConfig: JSON.parse(provider.oidcConfig),
redirectURI: `${ctx.context.baseURL}/sso/callback/${provider.providerId}`
});
}
),
/**
* ### Endpoint
*
* POST `/sign-in/sso`
*
* ### API Methods
*
* **server:**
* `auth.api.signInSSO`
*
* **client:**
* `authClient.signIn.sso`
*
* @see [Read our docs to learn more.](https://better-auth.com/docs/plugins/sign-in#api-method-sign-in-sso)
*/
signInSSO: session.createAuthEndpoint(
"/sign-in/sso",
{
method: "POST",
body: z__namespace.object({
email: z__namespace.string().meta({
description: `The email address to sign in with. This is used to identify the issuer to sign in with. It's optional if the issuer is provided. Eg: "john@example.com"`
}).optional(),
organizationSlug: z__namespace.string().meta({
description: 'The slug of the organization to sign in with. Eg: "example-org"'
}).optional(),
providerId: z__namespace.string().meta({
description: 'The ID of the provider to sign in with. This can be provided instead of email or issuer. Eg: "example-provider"'
}).optional(),
domain: z__namespace.string().meta({
description: 'The domain of the provider. Eg: "example.com"'
}).optional(),
callbackURL: z__namespace.string().meta({
description: 'The URL to redirect to after login. Eg: "https://example.com/callback"'
}),
errorCallbackURL: z__namespace.string().meta({
description: 'The URL to redirect to after login. Eg: "https://example.com/callback"'
}).optional(),
newUserCallbackURL: z__namespace.string().meta({
description: 'The URL to redirect to after login if the user is new. Eg: "https://example.com/new-user"'
}).optional(),
scopes: z__namespace.array(z__namespace.string()).meta({
description: "Scopes to request from the provider."
}).optional(),
requestSignUp: z__namespace.boolean().meta({
description: "Explicitly request sign-up. Useful when disableImplicitSignUp is true for this provider. Eg: true"
}).optional()
}),
metadata: {
openapi: {
summary: "Sign in with SSO provider",
description: "This endpoint is used to sign in with an SSO provider. It redirects to the provider's authorization URL",
requestBody: {
content: {
"application/json": {
schema: {
type: "object",
properties: {
email: {
type: "string",
description: "The email address to sign in with. This is used to identify the issuer to sign in with. It's optional if the issuer is provided"
},
issuer: {
type: "string",
description: "The issuer identifier, this is the URL of the provider and can be used to verify the provider and identify the provider during login. It's optional if the email is provided"
},
providerId: {
type: "string",
description: "The ID of the provider to sign in with. This can be provided instead of email or issuer"
},
callbackURL: {
type: "string",
description: "The URL to redirect to after login"
},
errorCallbackURL: {
type: "string",
description: "The URL to redirect to after login"
},
newUserCallbackURL: {
type: "string",
description: "The URL to redirect to after login if the user is new"
}
},
required: ["callbackURL"]
}
}
}
},
responses: {
"200": {
description: "Authorization URL generated successfully for SSO sign-in",
content: {
"application/json": {
schema: {
type: "object",
properties: {
url: {
type: "string",
format: "uri",
description: "The authorization URL to redirect the user to for SSO sign-in"
},
redirect: {
type: "boolean",
description: "Indicates that the client should redirect to the provided URL",
enum: [true]
}
},
required: ["url", "redirect"]
}
}
}
}
}
}
}
},
async (ctx) => {
const body = ctx.body;
let { email, organizationSlug, providerId, domain } = body;
if (!email && !organizationSlug && !domain && !providerId) {
throw new betterCall.APIError("BAD_REQUEST", {
message: "email, organizationSlug, domain or providerId is required"
});
}
domain = body.domain || email?.split("@")[1];
let orgId = "";
if (organizationSlug) {
orgId = await ctx.context.adapter.findOne({
model: "organization",
where: [
{
field: "slug",
value: organizationSlug
}
]
}).then((res) => {
if (!res) {
return "";
}
return res.id;
});
}
const provider = await ctx.context.adapter.findOne({
model: "ssoProvider",
where: [
{
field: providerId ? "providerId" : orgId ? "organizationId" : "domain",
value: providerId || orgId || domain
}
]
}).then((res) => {
if (!res) {
return null;
}
return {
...res,
oidcConfig: JSON.parse(res.oidcConfig)
};
});
if (!provider) {
throw new betterCall.APIError("NOT_FOUND", {
message: "No provider found for the issuer"
});
}
const state = await socialProviders_index.generateState(ctx);
const redirectURI = `${ctx.context.baseURL}/sso/callback/${provider.providerId}`;
const authorizationURL = await socialProviders_index.createAuthorizationURL({
id: provider.issuer,
options: {
clientId: provider.oidcConfig.clientId,
clientSecret: provider.oidcConfig.clientSecret
},
redirectURI,
state: state.state,
codeVerifier: provider.oidcConfig.pkce ? state.codeVerifier : void 0,
scopes: ctx.body.scopes || [
"openid",
"email",
"profile",
"offline_access"
],
authorizationEndpoint: provider.oidcConfig.authorizationEndpoint
});
return ctx.json({
url: authorizationURL.toString(),
redirect: true
});
}
),
callbackSSO: session.createAuthEndpoint(
"/sso/callback/:providerId",
{
method: "GET",
query: z__namespace.object({
code: z__namespace.string().optional(),
state: z__namespace.string(),
error: z__namespace.string().optional(),
error_description: z__namespace.string().optional()
}),
metadata: {
isAction: false,
openapi: {
summary: "Callback URL for SSO provider",
description: "This endpoint is used as the callback URL for SSO providers. It handles the authorization code and exchanges it for an access token",
responses: {
"302": {
description: "Redirects to the callback URL"
}
}
}
}
},
async (ctx) => {
const { code, state, error, error_description } = ctx.query;
const stateData = await socialProviders_index.parseState(ctx);
if (!stateData) {
const errorURL2 = ctx.context.options.onAPIError?.errorURL || `${ctx.context.baseURL}/error`;
throw ctx.redirect(`${errorURL2}?error=invalid_state`);
}
const { callbackURL, errorURL, newUserURL, requestSignUp } = stateData;
if (!code || error) {
throw ctx.redirect(
`${errorURL || callbackURL}?error=${error}&error_description=${error_description}`
);
}
const provider = await ctx.context.adapter.findOne({
model: "ssoProvider",
where: [
{
field: "providerId",
value: ctx.params.providerId
}
]
}).then((res) => {
if (!res) {
return null;
}
return {
...res,
oidcConfig: JSON.parse(res.oidcConfig)
};
});
if (!provider) {
throw ctx.redirect(
`${errorURL || callbackURL}/error?error=invalid_provider&error_description=provider not found`
);
}
let config = provider.oidcConfig;
const discovery = await fetch.betterFetch(provider.oidcConfig.discoveryEndpoint);
if (discovery.data) {
config = {
tokenEndpoint: discovery.data.token_endpoint,
tokenEndpointAuthentication: discovery.data.token_endpoint_auth_method,
userInfoEndpoint: discovery.data.userinfo_endpoint,
scopes: ["openid", "email", "profile", "offline_access"],
...provider.oidcConfig
};
}
if (!config.tokenEndpoint) {
throw ctx.redirect(
`${errorURL || callbackURL}/error?error=invalid_provider&error_description=token_endpoint_not_found`
);
}
const tokenResponse = await socialProviders_index.validateAuthorizationCode({
code,
codeVerifier: provider.oidcConfig.pkce ? stateData.codeVerifier : void 0,
redirectURI: `${ctx.context.baseURL}/sso/callback/${provider.providerId}`,
options: {
clientId: provider.oidcConfig.clientId,
clientSecret: provider.oidcConfig.clientSecret
},
tokenEndpoint: config.tokenEndpoint,
authentication: config.tokenEndpointAuthentication === "client_secret_post" ? "post" : "basic"
}).catch((e) => {
if (e instanceof fetch.BetterFetchError) {
throw ctx.redirect(
`${errorURL || callbackURL}?error=invalid_provider&error_description=${e.message}`
);
}
return null;
});
if (!tokenResponse) {
throw ctx.redirect(
`${errorURL || callbackURL}/error?error=invalid_provider&error_description=token_response_not_found`
);
}
let userInfo = null;
if (tokenResponse.idToken) {
const idToken = jose.decodeJwt(tokenResponse.idToken);
if (!config.jwksEndpoint) {
throw ctx.redirect(
`${errorURL || callbackURL}/error?error=invalid_provider&error_description=jwks_endpoint_not_found`
);
}
const verified = await socialProviders_index.validateToken(
tokenResponse.idToken,
config.jwksEndpoint
).catch((e) => {
ctx.context.logger.error(e);
return null;
});
if (!verified) {
throw ctx.redirect(
`${errorURL || callbackURL}/error?error=invalid_provider&error_description=token_not_verified`
);
}
if (verified.payload.iss !== provider.issuer) {
throw ctx.redirect(
`${errorURL || callbackURL}/error?error=invalid_provider&error_description=issuer_mismatch`
);
}
const mapping = config.mapping || {};
userInfo = {
...Object.fromEntries(
Object.entries(mapping.extraFields || {}).map(
([key, value]) => [key, verified.payload[value]]
)
),
id: idToken[mapping.id || "sub"],
email: idToken[mapping.email || "email"],
emailVerified: idToken[mapping.emailVerified || "email_verified"],
name: idToken[mapping.name || "name"],
image: idToken[mapping.image || "picture"]
};
}
if (!userInfo) {
if (!config.userInfoEndpoint) {
throw ctx.redirect(
`${errorURL || callbackURL}/error?error=invalid_provider&error_description=user_info_endpoint_not_found`
);
}
const userInfoResponse = await fetch.betterFetch(config.userInfoEndpoint, {
headers: {
Authorization: `Bearer ${tokenResponse.accessToken}`
}
});
if (userInfoResponse.error) {
throw ctx.redirect(
`${errorURL || callbackURL}/error?error=invalid_provider&error_description=${userInfoResponse.error.message}`
);
}
userInfo = userInfoResponse.data;
}
if (!userInfo.email || !userInfo.id) {
throw ctx.redirect(
`${errorURL || callbackURL}/error?error=invalid_provider&error_description=missing_user_info`
);
}
const linked = await socialProviders_index.handleOAuthUserInfo(ctx, {
userInfo: {
email: userInfo.email,
name: userInfo.name || userInfo.email,
id: userInfo.id,
image: userInfo.image,
emailVerified: userInfo.emailVerified || false
},
account: {
idToken: tokenResponse.idToken,
accessToken: await socialProviders_index.setTokenUtil(
tokenResponse.accessToken,
ctx.context
),
refreshToken: await socialProviders_index.setTokenUtil(
tokenResponse.refreshToken,
ctx.context
),
accountId: userInfo.id,
providerId: provider.providerId,
accessTokenExpiresAt: tokenResponse.accessTokenExpiresAt,
refreshTokenExpiresAt: tokenResponse.refreshTokenExpiresAt,
scope: tokenResponse.scopes?.join(",")
},
callbackURL,
disableSignUp: options?.disableImplicitSignUp && !requestSignUp,
overrideUserInfo: config.overrideUserInfo
});
if (linked.error) {
throw ctx.redirect(
`${errorURL || callbackURL}/error?error=${linked.error}`
);
}
const { session, user } = linked.data;
if (options?.provisionUser) {
await options.provisionUser({
user,
userInfo,
token: tokenResponse,
provider
});
}
if (provider.organizationId && !options?.organizationProvisioning?.disabled) {
const isOrgPluginEnabled = ctx.context.options.plugins?.find(
(plugin) => plugin.id === "organization"
);
if (isOrgPluginEnabled) {
const isAlreadyMember = await ctx.context.adapter.findOne({
model: "member",
where: [
{ field: "organizationId", value: provider.organizationId },
{ field: "userId", value: user.id }
]
});
if (!isAlreadyMember) {
const role = options?.organizationProvisioning?.getRole ? await options.organizationProvisioning.getRole({
user,
userInfo,
token: tokenResponse,
provider
}) : options?.organizationProvisioning?.defaultRole || "member";
await ctx.context.adapter.create({
model: "member",
data: {
organizationId: provider.organizationId,
userId: user.id,
role,
createdAt: /* @__PURE__ */ new Date(),
updatedAt: /* @__PURE__ */ new Date()
}
});
}
}
}
await cookies_index.setSessionCookie(ctx, {
session,
user
});
let toRedirectTo;
try {
const url = linked.isRegister ? newUserURL || callbackURL : callbackURL;
toRedirectTo = url.toString();
} catch {
toRedirectTo = linked.isRegister ? newUserURL || callbackURL : callbackURL;
}
throw ctx.redirect(toRedirectTo);
}
)
},
schema: {
ssoProvider: {
fields: {
issuer: {
type: "string",
required: true
},
oidcConfig: {
type: "string",
required: false
},
samlConfig: {
type: "string",
required: false
},
userId: {
type: "string",
references: {
model: "user",
field: "id"
}
},
providerId: {
type: "string",
required: true,
unique: true
},
organizationId: {
type: "string",
required: false
},
domain: {
type: "string",
required: true
}
}
}
}
};
};
exports.sso = sso;