@auth/core
Version:
Authentication for the Web.
434 lines (433 loc) • 18.4 kB
JavaScript
/**
* Base error class for all Auth.js errors.
* It's optimized to be printed in the server logs in a nicely formatted way
* via the [`logger.error`](https://authjs.dev/reference/core#logger) option.
*/
export class AuthError extends Error {
constructor(message, errorOptions) {
if (message instanceof Error) {
super(undefined, {
cause: { err: message, ...message.cause, ...errorOptions },
});
}
else if (typeof message === "string") {
if (errorOptions instanceof Error) {
errorOptions = { err: errorOptions, ...errorOptions.cause };
}
super(message, errorOptions);
}
else {
super(undefined, message);
}
this.name = this.constructor.name;
// @ts-expect-error https://github.com/microsoft/TypeScript/issues/3841
this.type = this.constructor.type ?? "AuthError";
// @ts-expect-error https://github.com/microsoft/TypeScript/issues/3841
this.kind = this.constructor.kind ?? "error";
Error.captureStackTrace?.(this, this.constructor);
const url = `https://errors.authjs.dev#${this.type.toLowerCase()}`;
this.message += `${this.message ? ". " : ""}Read more at ${url}`;
}
}
export class SignInError extends AuthError {
}
SignInError.kind = "signIn";
/**
* One of the database [`Adapter` methods](https://authjs.dev/reference/core/adapters#methods)
* failed during execution.
*
* :::tip
* If `debug: true` is set, you can check out `[auth][debug]` in the logs to learn more about the failed adapter method execution.
* @example
* ```sh
* [auth][debug]: adapter_getUserByEmail
* { "args": [undefined] }
* ```
* :::
*/
export class AdapterError extends AuthError {
}
AdapterError.type = "AdapterError";
/**
* Thrown when the execution of the [`signIn` callback](https://authjs.dev/reference/core/types#signin) fails
* or if it returns `false`.
*/
export class AccessDenied extends AuthError {
}
AccessDenied.type = "AccessDenied";
/**
* This error occurs when the user cannot finish login.
* Depending on the provider type, this could have happened for multiple reasons.
*
* :::tip
* Check out `[auth][details]` in the logs to know which provider failed.
* @example
* ```sh
* [auth][details]: { "provider": "github" }
* ```
* :::
*
* For an [OAuth provider](https://authjs.dev/getting-started/authentication/oauth), possible causes are:
* - The user denied access to the application
* - There was an error parsing the OAuth Profile:
* Check out the provider's `profile` or `userinfo.request` method to make sure
* it correctly fetches the user's profile.
* - The `signIn` or `jwt` callback methods threw an uncaught error:
* Check the callback method implementations.
*
* For an [Email provider](https://authjs.dev/getting-started/authentication/email), possible causes are:
* - The provided email/token combination was invalid/missing:
* Check if the provider's `sendVerificationRequest` method correctly sends the email.
* - The provided email/token combination has expired:
* Ask the user to log in again.
* - There was an error with the database:
* Check the database logs.
*
* For a [Credentials provider](https://authjs.dev/getting-started/authentication/credentials), possible causes are:
* - The `authorize` method threw an uncaught error:
* Check the provider's `authorize` method.
* - The `signIn` or `jwt` callback methods threw an uncaught error:
* Check the callback method implementations.
*
* :::tip
* Check out `[auth][cause]` in the error message for more details.
* It will show the original stack trace.
* :::
*/
export class CallbackRouteError extends AuthError {
}
CallbackRouteError.type = "CallbackRouteError";
/**
* Thrown when Auth.js is misconfigured and accidentally tried to require authentication on a custom error page.
* To prevent an infinite loop, Auth.js will instead render its default error page.
*
* To fix this, make sure that the `error` page does not require authentication.
*
* Learn more at [Guide: Error pages](https://authjs.dev/guides/pages/error)
*/
export class ErrorPageLoop extends AuthError {
}
ErrorPageLoop.type = "ErrorPageLoop";
/**
* One of the [`events` methods](https://authjs.dev/reference/core/types#eventcallbacks)
* failed during execution.
*
* Make sure that the `events` methods are implemented correctly and uncaught errors are handled.
*
* Learn more at [`events`](https://authjs.dev/reference/core/types#eventcallbacks)
*/
export class EventError extends AuthError {
}
EventError.type = "EventError";
/**
* Thrown when Auth.js is unable to verify a `callbackUrl` value.
* The browser either disabled cookies or the `callbackUrl` is not a valid URL.
*
* Somebody might have tried to manipulate the callback URL that Auth.js uses to redirect the user back to the configured `callbackUrl`/page.
* This could be a malicious hacker trying to redirect the user to a phishing site.
* To prevent this, Auth.js checks if the callback URL is valid and throws this error if it is not.
*
* There is no action required, but it might be an indicator that somebody is trying to attack your application.
*/
export class InvalidCallbackUrl extends AuthError {
}
InvalidCallbackUrl.type = "InvalidCallbackUrl";
/**
* Can be thrown from the `authorize` callback of the Credentials provider.
* When an error occurs during the `authorize` callback, two things can happen:
* 1. The user is redirected to the signin page, with `error=CredentialsSignin&code=credentials` in the URL. `code` is configurable.
* 2. If you throw this error in a framework that handles form actions server-side, this error is thrown, instead of redirecting the user, so you'll need to handle.
*/
export class CredentialsSignin extends SignInError {
constructor() {
super(...arguments);
/**
* The error code that is set in the `code` query parameter of the redirect URL.
*
*
* ⚠ NOTE: This property is going to be included in the URL, so make sure it does not hint at sensitive errors.
*
* The full error is always logged on the server, if you need to debug.
*
* Generally, we don't recommend hinting specifically if the user had either a wrong username or password specifically,
* try rather something like "Invalid credentials".
*/
this.code = "credentials";
}
}
CredentialsSignin.type = "CredentialsSignin";
/**
* One of the configured OAuth or OIDC providers is missing the `authorization`, `token` or `userinfo`, or `issuer` configuration.
* To perform OAuth or OIDC sign in, at least one of these endpoints is required.
*
* Learn more at [`OAuth2Config`](https://authjs.dev/reference/core/providers#oauth2configprofile) or [Guide: OAuth Provider](https://authjs.dev/guides/configuring-oauth-providers)
*/
export class InvalidEndpoints extends AuthError {
}
InvalidEndpoints.type = "InvalidEndpoints";
/**
* Thrown when a PKCE, state or nonce OAuth check could not be performed.
* This could happen if the OAuth provider is configured incorrectly or if the browser is blocking cookies.
*
* Learn more at [`checks`](https://authjs.dev/reference/core/providers#checks)
*/
export class InvalidCheck extends AuthError {
}
InvalidCheck.type = "InvalidCheck";
/**
* Logged on the server when Auth.js could not decode or encode a JWT-based (`strategy: "jwt"`) session.
*
* Possible causes are either a misconfigured `secret` or a malformed JWT or `encode/decode` methods.
*
* :::note
* When this error is logged, the session cookie is destroyed.
* :::
*
* Learn more at [`secret`](https://authjs.dev/reference/core#secret), [`jwt.encode`](https://authjs.dev/reference/core/jwt#encode-1) or [`jwt.decode`](https://authjs.dev/reference/core/jwt#decode-2) for more information.
*/
export class JWTSessionError extends AuthError {
}
JWTSessionError.type = "JWTSessionError";
/**
* Thrown if Auth.js is misconfigured. This could happen if you configured an Email provider but did not set up a database adapter,
* or tried using a `strategy: "database"` session without a database adapter.
* In both cases, make sure you either remove the configuration or add the missing adapter.
*
* Learn more at [Database Adapters](https://authjs.dev/getting-started/database), [Email provider](https://authjs.dev/getting-started/authentication/email) or [Concept: Database session strategy](https://authjs.dev/concepts/session-strategies#database-session)
*/
export class MissingAdapter extends AuthError {
}
MissingAdapter.type = "MissingAdapter";
/**
* Thrown similarily to [`MissingAdapter`](https://authjs.dev/reference/core/errors#missingadapter), but only some required methods were missing.
*
* Make sure you either remove the configuration or add the missing methods to the adapter.
*
* Learn more at [Database Adapters](https://authjs.dev/getting-started/database)
*/
export class MissingAdapterMethods extends AuthError {
}
MissingAdapterMethods.type = "MissingAdapterMethods";
/**
* Thrown when a Credentials provider is missing the `authorize` configuration.
* To perform credentials sign in, the `authorize` method is required.
*
* Learn more at [Credentials provider](https://authjs.dev/getting-started/authentication/credentials)
*/
export class MissingAuthorize extends AuthError {
}
MissingAuthorize.type = "MissingAuthorize";
/**
* Auth.js requires a secret or multiple secrets to be set, but none was not found. This is used to encrypt cookies, JWTs and other sensitive data.
*
* :::note
* If you are using a framework like Next.js, we try to automatically infer the secret from the `AUTH_SECRET`, `AUTH_SECRET_1`, etc. environment variables.
* Alternatively, you can also explicitly set the [`AuthConfig.secret`](https://authjs.dev/reference/core#secret) option.
* :::
*
*
* :::tip
* To generate a random string, you can use the Auth.js CLI: `npx auth secret`
* :::
*/
export class MissingSecret extends AuthError {
}
MissingSecret.type = "MissingSecret";
/**
* Thrown when an Email address is already associated with an account
* but the user is trying an OAuth account that is not linked to it.
*
* For security reasons, Auth.js does not automatically link OAuth accounts to existing accounts if the user is not signed in.
*
* :::tip
* If you trust the OAuth provider to have verified the user's email address,
* you can enable automatic account linking by setting [`allowDangerousEmailAccountLinking: true`](https://authjs.dev/reference/core/providers#allowdangerousemailaccountlinking)
* in the provider configuration.
* :::
*/
export class OAuthAccountNotLinked extends SignInError {
}
OAuthAccountNotLinked.type = "OAuthAccountNotLinked";
/**
* Thrown when an OAuth provider returns an error during the sign in process.
* This could happen for example if the user denied access to the application or there was a configuration error.
*
* For a full list of possible reasons, check out the specification [Authorization Code Grant: Error Response](https://www.rfc-editor.org/rfc/rfc6749#section-4.1.2.1)
*/
export class OAuthCallbackError extends SignInError {
}
OAuthCallbackError.type = "OAuthCallbackError";
/**
* This error occurs during an OAuth sign in attempt when the provider's
* response could not be parsed. This could for example happen if the provider's API
* changed, or the [`OAuth2Config.profile`](https://authjs.dev/reference/core/providers#oauth2configprofile) method is not implemented correctly.
*/
export class OAuthProfileParseError extends AuthError {
}
OAuthProfileParseError.type = "OAuthProfileParseError";
/**
* Logged on the server when Auth.js could not retrieve a session from the database (`strategy: "database"`).
*
* The database adapter might be misconfigured or the database is not reachable.
*
* Learn more at [Concept: Database session strategy](https://authjs.dev/concepts/session-strategies#database)
*/
export class SessionTokenError extends AuthError {
}
SessionTokenError.type = "SessionTokenError";
/**
* Happens when login by [OAuth](https://authjs.dev/getting-started/authentication/oauth) could not be started.
*
* Possible causes are:
* - The Authorization Server is not compliant with the [OAuth 2.0](https://www.ietf.org/rfc/rfc6749.html) or the [OIDC](https://openid.net/specs/openid-connect-core-1_0.html) specification.
* Check the details in the error message.
*
* :::tip
* Check out `[auth][details]` in the logs to know which provider failed.
* @example
* ```sh
* [auth][details]: { "provider": "github" }
* ```
* :::
*/
export class OAuthSignInError extends SignInError {
}
OAuthSignInError.type = "OAuthSignInError";
/**
* Happens when the login by an [Email provider](https://authjs.dev/getting-started/authentication/email) could not be started.
*
* Possible causes are:
* - The email sent from the client is invalid, could not be normalized by [`EmailConfig.normalizeIdentifier`](https://authjs.dev/reference/core/providers/email#normalizeidentifier)
* - The provided email/token combination has expired:
* Ask the user to log in again.
* - There was an error with the database:
* Check the database logs.
*/
export class EmailSignInError extends SignInError {
}
EmailSignInError.type = "EmailSignInError";
/**
* Represents an error that occurs during the sign-out process. This error
* is logged when there are issues in terminating a user's session, either
* by failing to delete the session from the database (in database session
* strategies) or encountering issues during other parts of the sign-out
* process, such as emitting sign-out events or clearing session cookies.
*
* The session cookie(s) are emptied even if this error is logged.
*
*/
export class SignOutError extends AuthError {
}
SignOutError.type = "SignOutError";
/**
* Auth.js was requested to handle an operation that it does not support.
*
* See [`AuthAction`](https://authjs.dev/reference/core/types#authaction) for the supported actions.
*/
export class UnknownAction extends AuthError {
}
UnknownAction.type = "UnknownAction";
/**
* Thrown when a Credentials provider is present but the JWT strategy (`strategy: "jwt"`) is not enabled.
*
* Learn more at [`strategy`](https://authjs.dev/reference/core#strategy) or [Credentials provider](https://authjs.dev/getting-started/authentication/credentials)
*/
export class UnsupportedStrategy extends AuthError {
}
UnsupportedStrategy.type = "UnsupportedStrategy";
/** Thrown when an endpoint was incorrectly called without a provider, or with an unsupported provider. */
export class InvalidProvider extends AuthError {
}
InvalidProvider.type = "InvalidProvider";
/**
* Thrown when the `trustHost` option was not set to `true`.
*
* Auth.js requires the `trustHost` option to be set to `true` since it's relying on the request headers' `host` value.
*
* :::note
* Official Auth.js libraries might attempt to automatically set the `trustHost` option to `true` if the request is coming from a trusted host on a trusted platform.
* :::
*
* Learn more at [`trustHost`](https://authjs.dev/reference/core#trusthost) or [Guide: Deployment](https://authjs.dev/getting-started/deployment)
*/
export class UntrustedHost extends AuthError {
}
UntrustedHost.type = "UntrustedHost";
/**
* The user's email/token combination was invalid.
* This could be because the email/token combination was not found in the database,
* or because the token has expired. Ask the user to log in again.
*/
export class Verification extends AuthError {
}
Verification.type = "Verification";
/**
* Error for missing CSRF tokens in client-side actions (`signIn`, `signOut`, `useSession#update`).
* Thrown when actions lack the double submit cookie, essential for CSRF protection.
*
* CSRF ([Cross-Site Request Forgery](https://owasp.org/www-community/attacks/csrf))
* is an attack leveraging authenticated user credentials for unauthorized actions.
*
* Double submit cookie pattern, a CSRF defense, requires matching values in a cookie
* and request parameter. More on this at [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Glossary/CSRF).
*/
export class MissingCSRF extends SignInError {
}
MissingCSRF.type = "MissingCSRF";
const clientErrors = new Set([
"CredentialsSignin",
"OAuthAccountNotLinked",
"OAuthCallbackError",
"AccessDenied",
"Verification",
"MissingCSRF",
"AccountNotLinked",
"WebAuthnVerificationError",
]);
/**
* Used to only allow sending a certain subset of errors to the client.
* Errors are always logged on the server, but to prevent leaking sensitive information,
* only a subset of errors are sent to the client as-is.
* @internal
*/
export function isClientError(error) {
if (error instanceof AuthError)
return clientErrors.has(error.type);
return false;
}
/**
* Thrown when multiple providers have `enableConditionalUI` set to `true`.
* Only one provider can have this option enabled at a time.
*/
export class DuplicateConditionalUI extends AuthError {
}
DuplicateConditionalUI.type = "DuplicateConditionalUI";
/**
* Thrown when a WebAuthn provider has `enableConditionalUI` set to `true` but no formField has `webauthn` in its autocomplete param.
*
* The `webauthn` autocomplete param is required for conditional UI to work.
*/
export class MissingWebAuthnAutocomplete extends AuthError {
}
MissingWebAuthnAutocomplete.type = "MissingWebAuthnAutocomplete";
/**
* Thrown when a WebAuthn provider fails to verify a client response.
*/
export class WebAuthnVerificationError extends AuthError {
}
WebAuthnVerificationError.type = "WebAuthnVerificationError";
/**
* Thrown when an Email address is already associated with an account
* but the user is trying an account that is not linked to it.
*
* For security reasons, Auth.js does not automatically link accounts to existing accounts if the user is not signed in.
*/
export class AccountNotLinked extends SignInError {
}
AccountNotLinked.type = "AccountNotLinked";
/**
* Thrown when an experimental feature is used but not enabled.
*/
export class ExperimentalFeatureNotEnabled extends AuthError {
}
ExperimentalFeatureNotEnabled.type = "ExperimentalFeatureNotEnabled";