AdonisJS Auth

For detailed guides, installation instructions, configuration details, and API references, please refer to the official AdonisJS documentation website.

https://docs.adonisjs.com/guides/authentication/introduction

To ensure AuthService knows about your configured guards, you must augment the Authenticators interface. This is typically done in a declaration file after defining your auth configuration.

declare module '@adonisjs/auth/types' {
  interface Authenticators {
    web: SessionGuardFactory
    api: TokenGuardFactory
  }
}

The InitializeAuthMiddleware is responsible for creating a request-specific Authenticator instance for every HTTP request. It attaches the auth object to the HttpContext, making it available throughout your application's request lifecycle.

Important: This middleware does not protect routes from unauthenticated users. It only initializes the authentication mechanism. To protect routes, you must use the auth middleware instead.

When registered, this middleware:

1. Adds ctx.auth to the HttpContext.
2. Shares the auth instance with the Edge template engine (if ctx.view is present) so you can check authentication status directly in your templates.

// Registering the middleware in your router
router.use([() => import('#middleware/initialize_auth_middleware')])

Use the defineConfig function to set up the authentication configuration for your AdonisJS application. This function allows you to specify a default guard and a map of available guards.

Each guard in the guards object can be a GuardFactory (a function that returns a guard) or a GuardConfigProvider (an object that resolves to a guard, often used for asynchronous loading or dependency injection). The defineConfig function ensures that all guards are properly resolved before being passed to the auth service.

import { defineConfig } from '@adonisjs/auth'
import { sessionGuard, sessionUserProvider } from '@adonisjs/auth/session'

const authConfig = defineConfig({
  default: 'web',
  guards: {
    web: sessionGuard({
      useRememberMeTokens: false,
      provider: sessionUserProvider({
        model: () => import('#models/user')
      })
    })
  }
})

When writing browser-based authentication tests using Japa and Playwright, you can use the authBrowserClient plugin to easily authenticate users within your browser context. This allows you to perform page visits as a logged-in user by automatically setting the necessary cookies or session data.

To use it, import authBrowserClient and add it to your Japa configuration plugins array, passing the AdonisJS app service instance.

import { authBrowserClient } from '@adonisjs/auth/plugins/japa/browser_client'

export const plugins: PluginFn[] = [
  authBrowserClient(app)
]

When writing integration tests for API-based authentication using the Japa test runner, you can use the authApiClient plugin. This plugin extends the Japa ApiClient to allow you to easily simulate authenticated requests by calling loginAs or withGuard on your API requests. This automatically handles the underlying authentication logic (like setting headers, sessions, or cookies) for the test request.

import { authApiClient } from '@adonisjs/auth/plugins/japa/api_client'

export const plugins: PluginFn[] = [
  authApiClient(app)
]

The docker-compose.yml file provides a PostgreSQL 11 service. Configuration is driven by the following environment variables from your .env file:

• PG_DATABASE: The name of the database to create.
• PG_USER: The username for the database.
• PG_PASSWORD: The password for the user.
• PG_PORT: The host port to map to the container's 5432 port.

services:
  pg:
    image: postgres:11
    environment:
      - POSTGRES_DB=$PG_DATABASE
      - POSTGRES_USER=$PG_USER
      - POSTGRES_PASSWORD=$PG_PASSWORD
    ports:
      - $PG_PORT:5432

The docker-compose.yml file provides a Microsoft SQL Server 2019 service. Configuration is driven by the following environment variables from your .env file:

• MSSQL_PASSWORD: The password for the SA (System Administrator) user.
• MSSQL_PORT: The host port to map to the container's 1433 port.

Note: The service automatically sets ACCEPT_EULA='Y' to accept the End User License Agreement.

services:
  mssql:
    image: mcr.microsoft.com/mssql/server:2019-latest
    environment:
      - SA_PASSWORD=$MSSQL_PASSWORD
      - ACCEPT_EULA='Y'
    ports:
      - $MSSQL_PORT:1433