Module Middleware/Basic Auth

This depends on @oslojs/crypto, and @oslojs/encoding.

The Basic Auth middleware let's you add a basic authentication to your routes, this can be useful to protect routes that need to be private.

Warning: Basic Auth is not secure by itself, it should be used with HTTPS to ensure the username and password are encrypted. Do not use it to protect sensitive data, use a more secure method instead.

import { createBasicAuthMiddleware } from "remix-utils/middleware/basic-auth";

export const [basicAuthMiddleware] = createBasicAuthMiddleware({
  user: { username: "admin", password: "password" },
});
Copy

To use it, you need to add it to the middleware array in the route where you want to use it.

import { basicAuthMiddleware } from "~/middleware/basic-auth.server";
export const middleware: Route.MiddlewareFunction[] = [basicAuthMiddleware];
Copy

Now, when you access the route you will be prompted to enter the username and password.

The realm option let's you set the realm for the authentication, this is the name of the protected area.

import { createBasicAuthMiddleware } from "remix-utils/middleware/basic-auth";

export const [basicAuthMiddleware] = createBasicAuthMiddleware({
  realm: "My Realm",
  user: { username: "admin", password: "password" },
});
Copy

The user option let's you set the username and password to authenticate, you can also pass an array of users.

import { createBasicAuthMiddleware } from "remix-utils/middleware/basic-auth";

export const [basicAuthMiddleware] = createBasicAuthMiddleware({
  user: [
    { username: "admin", password: "password" },
    { username: "user", password: "password" },
  ],
});
Copy

The verifyUser option let's you pass a function to verify the user, this can be useful to check the user against a database.

import { createBasicAuthMiddleware } from "remix-utils/middleware/basic-auth";

export const [basicAuthMiddleware] = createBasicAuthMiddleware({
  verifyUser(username, password) {
    let user = await getUser(username);
    if (!user) return false;
    return await verifyPassword(password, user.password);
  },
});
Copy

The verifyUser function should return true if the user is authenticated, and false otherwise.

In case of an invalid username or password the middleware will return a 401 status code with a WWW-Authenticate header.

HTTP/1.1 401 Unauthorized
WWW-Authenticate: Basic realm="My Realm"

Unauthorized
Copy

The invalidUserMessage option let's you customize the message sent when the user is invalid.

import { createBasicAuthMiddleware } from "remix-utils/middleware/basic-auth";

export const [basicAuthMiddleware] = createBasicAuthMiddleware({
  invalidUserMessage: "Invalid username or password",
  user: { username: "admin", password: "password" },
});
Copy

And this will be the response when the user is invalid.

HTTP/1.1 401 Unauthorized
WWW-Authenticate: Basic realm="My Realm"

Invalid username or password
Copy

You can also customize the invalidUserMessage by passing a function which will receive the Request and context objects.

import { createBasicAuthMiddleware } from "remix-utils/middleware/basic-auth";

export const [basicAuthMiddleware] = createBasicAuthMiddleware({
  invalidUserMessage({ request, context }) {
    // do something with request or context here
    return { message: `Invalid username or password for ${username}` };
  },
  user: { username: "admin", password: "password" },
});
Copy

In both cases, with a hard-coded value or a function, the invalid message can be a string or an object, if it's an object it will be converted to JSON.

HTTP/1.1 401 Unauthorized
WWW-Authenticate: Basic realm="My Realm"

{"message":"Invalid username or password"}
Copy