scratch-auth-express

KO | EN

gitlite — search

#typescript #go #golang #machine-learning #rust #docker #macos #nodejs #java #windows #pytorch #security #mcp #open-source

scratch-auth-express

(★ 9)

Scratch Auth integration for Express. Just plug and play, minimal setup required

scratch-auth-express Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Scratch Auth integration for Express

- Plug and play, minimal setup required
- Easy to use

## Installation

```
npm install sa-express
```

## Usage

```js
const express = require('express');
const scratchauth = require('sa-express');

const app = express();

### Options

| Name             | Description                                                                                                                                                                       | Default                                       |
| ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- |
| `secret`         | Secret that `cookie-session` will use. It should be stored securely in an environment variable.                                                                                   | _No default; this option is required_         |
| `appName`        | Name for Scratch Auth to use on the login page.                                                                                                                                   | `''`                                          |
| `loginRoute`     | Route for redirecting the user to Scratch Auth.                                                                                                                                   | `'/auth/login'`                               |
| `verifyRoute`    | Route for verifying Scratch Auth's repsonse.                                                                                                                                      | `'/auth/verify'`                              |
| `logoutRoute`    | Route for logging the user out.                                                                                                                                                   | `'/auth/logout'`                              |
| `logoutRedirect` | Route to redirect to after logging out.                                                                                                                                           | `'/'`                                         |
| `domain`         | The domain of your app. This is only needed if your app unexpectedly redirects to localhost instead of your app's domain. It should not include `http[s]://` or a trailing slash. | `''`                                          |
| `succeeded`      | Called when the user has been logged in successfully.                                                                                                                             | `(req, res) => res.redirect('/')`             |
| `failed`         | Called when auth has failed.                                                                                                                                                      | `(req, res) => res.send('Auth failed')`       |
| `cookie`         | [More options here.](https://github.com/expressjs/cookie-session#cookie-options)                                                                                                  | By default lasts 7 days with `sameSite: lax`. |

### Using Auth/Protected Routes

Calling `scratchauth` returns a middleware for protected routes. It will redirect the user if they are not logged in. By default, the redirect route is whatever you passed for `loginRoute`.

```js
app.get('/dashboard', needsAuth(), (req, res) => {
  res.send(`Welcome to your dashboard, ${res.locals.username}!`);
});
```

You can manually implement protected routes by using `res.locals.loggedIn`:

```js
app.get('/dashboard', (req, res) => {
  if (res.locals.loggedIn) {
    res.send(`Welcome to your dashboard, ${res.locals.username}!`);
  } else {
    res.redirect('/auth/login');
  }
});
```

In fact, `needsAuth` uses `res.locals.loggedIn` under the hood, so both of the methods are equivalent.

## Demo Application

A demo can be found in demo/.

scratch-auth-express

scratch-auth-express Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

scratch-auth-express

scratch-auth-express Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README