Skip to content
atarashi
Documentation menu

auth/session

Cookie-session auth for Express: signed session middleware, bcrypt hashing and a guard.

Provides: auth, auth:session

Requires: http:express, config:env

Conflicts with: auth

Files it writes

  • src/lib/password.ts (when provides('language:typescript'))
  • src/lib/password.js (when provides('language:javascript'))
  • src/middlewares/auth.ts (when provides('language:typescript'))
  • src/middlewares/auth.js (when provides('language:javascript'))
  • src/types/session.d.ts (when provides('language:typescript'))

Dependencies

  • express-session@^1.18.2
  • bcryptjs@^3.0.2

Development only:

  • @types/express-session@^1.18.2 (when provides('language:typescript'))
  • @types/bcryptjs@^3.0.0 (when provides('language:typescript'))

Environment

VariableRequiredDescription
SESSION_SECRETyesKey used to sign the session cookie; at least 32 characters

What it contributes to other files

FileSlotLine
src/config/env.ts|jsenv-schemaSESSION_SECRET: z.string().min(32, 'SESSION_SECRET must be at least 32 characters'),
src/app.ts|jsimportsimport session from 'express-session';
src/app.ts|jsimportsimport { env } from './config/env.js';
src/app.ts|jsmiddlewareapp.use(

Use it

atarashi new my-app --add auth/session
atarashi add auth/session

Version 1.0.0. Format reference: Authoring blueprints.

Part of the atarashi documentation, written and maintained by Gautam Suthar.