snb4crazy / laravel-magic-link-auth

v1.0.0 2026-10-27 21:03 UTC

Requires

• php: ^8.2
• illuminate/auth: ^11.0|^12.0|^13.0
• illuminate/contracts: ^11.0|^12.0|^13.0
• illuminate/database: ^11.0|^12.0|^13.0
• illuminate/http: ^11.0|^12.0|^13.0
• illuminate/mail: ^11.0|^12.0|^13.0
• illuminate/routing: ^11.0|^12.0|^13.0
• illuminate/support: ^11.0|^12.0|^13.0
• illuminate/validation: ^11.0|^12.0|^13.0

Requires (Dev)

• laravel/pint: ^1.17
• orchestra/testbench: ^9.0|^10.0
• phpunit/phpunit: ^11.0

MIT

• Authentication
• laravel
• sanctum
• magic-link

Published on Packagist.org on 2026-10-27 21:09 UTC

README

Reusable Laravel package for passwordless "magic link" login, designed for API backends (including Laravel Sanctum token issuing).

Integration guides

• Laravel backend integration examples
• Flutter/mobile app integration examples

Features

• POST /api/auth/magic-link/request to request a one-time login link
• POST /api/auth/magic-link/exchange to exchange link token for authenticated payload
• One-time token consumption with expiry window
• Enumeration-safe request response (same success message for known/unknown emails)
• Configurable route prefix, middleware, TTL, lookup model/column, and frontend/deep-link URL
• Optional verified-email requirement and optional existing-token revocation

Installation

composer require snb4crazy/laravel-magic-link-auth
php artisan migrate

Publish package config when you need customization:

php artisan vendor:publish --tag=magic-link-auth-config

Configuration

Default file: config/magic-link-auth.php

MAGIC_LINK_FRONTEND_URL=myapp://auth/magic-link
MAGIC_LINK_TTL_MINUTES=15
MAGIC_LINK_EXCHANGE_CANDIDATE_LIMIT=5
MAGIC_LINK_REQUIRE_VERIFIED_EMAIL=false
MAGIC_LINK_ISSUE_SANCTUM_TOKEN=true
MAGIC_LINK_REVOKE_EXISTING_TOKENS=false

Important options

• MAGIC_LINK_FRONTEND_URL: Link base URL included in email (email + token query params are appended).
• MAGIC_LINK_EXCHANGE_CANDIDATE_LIMIT: Limits how many latest active tokens are checked on exchange (performance tuning).
• MAGIC_LINK_ISSUE_SANCTUM_TOKEN: When true, the package returns token + token_type if user model supports createToken.
• MAGIC_LINK_REQUIRE_VERIFIED_EMAIL: When true, unverified users receive 403 during exchange.

API Contract

Request magic link

POST /api/auth/magic-link/request

{
  "email": "[e-mail]"
}

Always returns:

{
  "message": "If that email is registered, a magic link has been sent."
}

Exchange magic link

POST /api/auth/magic-link/exchange

{
  "email": "[e-mail]",
  "token": "64-char-token-from-link"
}

Session mode response:

{
  "user": { "...": "..." },
  "message": "Logged in successfully."
}

Token mode response:

{
  "user": { "...": "..." },
  "token": "plain-text-api-token",
  "token_type": "Bearer"
}

Integration Notes

Laravel backend integration

• Ensure your user model is configured in auth.providers.users.model.
• If using token mode, your user model must expose createToken(...) (for example via Sanctum's HasApiTokens).
• Named routes are available: magic-link-auth.request and magic-link-auth.exchange.

Mobile/Flutter deep-link integration

Set MAGIC_LINK_FRONTEND_URL to your app deep link (for example myapp://auth/magic-link). The package appends email and token, which your app can read and submit to /exchange.

Development and testing

Run the package test suite:

composer test