koa-basic-auth-connect

Installation

1npm install koa-basic-auth-connect

Example

1const Koa = require('koa');
2const basicAuth = require('koa-basic-auth-connect');
3
4const app = new Koa();
5
6app.use(basicAuth({
7  users: {'SampleUser': 'password'}
8}));

The middleware checks for a match to the credentials of the received request. It parses the "Authorization" header according to the Basic Authentication protocol and checks if the credentials are legitimate.

If it is correct, a property is added to ctx.state.auth. This object contains an object with user and password properties

If authentication fails, a 401 HTTP response is returned.

Options

1export type FunctionalOption<T>=T | ((ctx: Context) => T);
2
3type Options={
4  users: Users;
5  realm?: FunctionalOption<string>;
6  challenge?: boolean;
7  authorizer?: Authorizer;
8  continueIfUnauthorized?: FunctionalOption<boolean>;
9};

Option	Description	Default
users	Records by User ID and Secret
realm	Set realm on unauthorized response
challenge	Add a challenge header on unauthorized response	false
authorizer	Set custom authorizer function
continueIfUnauthorized	Continue middleware chain when unauthenticated	false

Challenge

By default, the middleware does not add a WWW-Authenticate challenge header to the unauthorized response.

You can be enable that by challenge option. This will cause most browsers to display a popup for entering credentials for unauthenticated responses. You may also add The realm can be used to identify the system to be authenticated and stored by the client.

1app.use(basicAuth({
2  users: {'ChallengeUser': 'psssword'},
3  challenge: true,
4  realm: 'Aiq+LNOl7X+LftH',
5}))

Authorizer

The user and password are passed to the callback (async) function.

For example, you can implement your own authentication like this

1app.use(basicAuth({
2  authorizer: (user: string, password: string) => (password == 'anysecret')
3}))