Authentication

Overview

The Password Manager API uses Laravel Sanctum for API token authentication. Sanctum provides a lightweight authentication system for SPAs (single page applications), mobile applications, and simple token-based APIs.

How Sanctum Works

Sanctum offers two authentication methods:

API Token Authentication - Simple token-based authentication for third-party API consumers
SPA Authentication - Cookie-based authentication for first-party single-page applications

For this API, we primarily use API token authentication.

Installation

Sanctum is already included in the project dependencies:

"require": {
    "laravel/sanctum": "^3.0"
}

The personal_access_tokens table is created during migration and stores API tokens:

php artisan migrate

User Model Configuration

The User model is already configured with the HasApiTokens trait:

app/Models/User.php

use Laravel\Sanctum\HasApiTokens;

class User extends Authenticatable
{
    use HasApiTokens, HasFactory, Notifiable;

    protected $fillable = [
        'name',
        'email',
        'password',
    ];
}

This trait provides methods for issuing and managing API tokens.

Sanctum Configuration

The Sanctum configuration is located at config/sanctum.php:

Stateful Domains

Domains that receive stateful API authentication:

config/sanctum.php

'stateful' => explode(',', env('SANCTUM_STATEFUL_DOMAINS', sprintf(
    '%s%s',
    'localhost,localhost:3000,127.0.0.1,127.0.0.1:8000,::1',
    Sanctum::currentApplicationUrlWithPort()
))),

Add your frontend domain to SANCTUM_STATEFUL_DOMAINS in .env for SPA authentication.

Token Expiration

By default, tokens do not expire:

config/sanctum.php

'expiration' => null,

To set token expiration (in minutes):

.env

SANCTUM_EXPIRATION=1440  # 24 hours

Authentication Guards

Sanctum uses the web guard by default:

config/sanctum.php

'guard' => ['web'],

Issuing API Tokens

To issue API tokens to users, create an authentication endpoint:

routes/api.php

use Illuminate\Http\Request;
use Illuminate\Support\Facades\Hash;
use App\Models\User;

Route::post('/login', function (Request $request) {
    $request->validate([
        'email' => 'required|email',
        'password' => 'required',
    ]);

    $user = User::where('email', $request->email)->first();

    if (! $user || ! Hash::check($request->password, $user->password)) {
        return response()->json([
            'message' => 'Invalid credentials'
        ], 401);
    }

    $token = $user->createToken('api-token')->plainTextToken;

    return response()->json([
        'token' => $token,
        'user' => $user
    ]);
});

Token Abilities

You can assign specific abilities (permissions) to tokens:

$token = $user->createToken('api-token', ['password:read', 'password:create'])->plainTextToken;

Protecting Routes

IMPORTANT: The current API routes in routes/api.php are NOT protected by authentication. All endpoints are publicly accessible by default.

To secure your API, add the auth:sanctum middleware to protect routes:

routes/api.php

use App\Http\Controllers\Api\passwordsController;

Route::middleware('auth:sanctum')->group(function () {
    Route::get('/listPassword', [passwordsController::class, 'listPasswords']);
    Route::get('/getPassword/{id}', [passwordsController::class, 'showPasswords']);
    Route::post('/createPassword', [passwordsController::class, 'createPasswords']);
    Route::post('/updatePassword/{id}', [passwordsController::class, 'updatePasswords']);
    Route::post('/deletePassword/{id}', [passwordsController::class, 'deletePasswords']);
});

After adding authentication middleware, all requests to these endpoints will require a valid API token.

Making Authenticated Requests

Include the API token in the Authorization header:

curl -X GET http://localhost:8000/api/listPassword \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

Using JavaScript

fetch('http://localhost:8000/api/listPassword', {
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Accept': 'application/json'
  }
})
.then(response => response.json())
.then(data => console.log(data));

Using Postman

Select the Authorization tab
Choose Bearer Token as the type
Paste your API token in the Token field

Accessing Authenticated User

In your controllers, access the authenticated user:

public function listPasswords(Request $request)
{
    $user = $request->user(); // Get authenticated user
    
    // Your logic here
}

Token Management

Revoking Tokens

Revoke all tokens for a user:

// Revoke all tokens
$user->tokens()->delete();

Revoke the current token:

$request->user()->currentAccessToken()->delete();

Revoke a specific token:

$user->tokens()->where('id', $tokenId)->delete();

Logout Endpoint

Create a logout endpoint to revoke tokens:

routes/api.php

Route::middleware('auth:sanctum')->post('/logout', function (Request $request) {
    $request->user()->currentAccessToken()->delete();
    
    return response()->json([
        'message' => 'Logged out successfully'
    ]);
});

Checking Token Abilities

If you’ve assigned abilities to tokens, check them in your code:

if ($request->user()->tokenCan('password:create')) {
    // User has permission to create passwords
}

Or use middleware:

Route::post('/createPassword', [passwordsController::class, 'createPasswords'])
    ->middleware(['auth:sanctum', 'abilities:password:create']);

CORS Configuration

For cross-origin requests, ensure CORS is properly configured in config/cors.php:

config/cors.php

'paths' => ['api/*', 'sanctum/csrf-cookie'],
'allowed_origins' => ['http://localhost:3000'], // Your frontend URL
'allowed_methods' => ['*'],
'allowed_headers' => ['*'],
'supports_credentials' => true,

Update .env with your frontend URL:

SANCTUM_STATEFUL_DOMAINS=localhost:3000,127.0.0.1:3000

Security Best Practices

Use HTTPS in production - Always transmit tokens over secure connections
Set token expiration - Configure reasonable expiration times for tokens
Implement rate limiting - Protect authentication endpoints from brute force attacks
Rotate tokens - Issue new tokens periodically and revoke old ones
Validate requests - Always validate incoming request data
Store tokens securely - Never expose tokens in URLs or client-side code
Monitor token usage - Track last_used_at in the personal_access_tokens table

Rate Limiting

Add rate limiting to authentication endpoints:

routes/api.php

use Illuminate\Support\Facades\RateLimiter;

Route::middleware('throttle:6,1')->group(function () {
    Route::post('/login', [AuthController::class, 'login']);
});

This limits login attempts to 6 per minute.

Testing Authentication

Test your protected endpoints:

# Create a user (if you have a registration endpoint)
curl -X POST http://localhost:8000/api/register \
  -H "Content-Type: application/json" \
  -d '{"name":"John Doe","email":"john@example.com","password":"password123"}'

# Login to get token
curl -X POST http://localhost:8000/api/login \
  -H "Content-Type: application/json" \
  -d '{"email":"john@example.com","password":"password123"}'

# Use the token to access protected routes
curl -X GET http://localhost:8000/api/listPassword \
  -H "Authorization: Bearer YOUR_TOKEN_HERE" \
  -H "Accept: application/json"

Get Started

Configuration

Overview

How Sanctum Works

Installation

User Model Configuration

Sanctum Configuration

Stateful Domains

Token Expiration

Authentication Guards

Issuing API Tokens

Token Abilities

Protecting Routes

Making Authenticated Requests

Using JavaScript

Using Postman

Accessing Authenticated User

Token Management

Revoking Tokens

Logout Endpoint

Checking Token Abilities

CORS Configuration

Security Best Practices

Rate Limiting

Testing Authentication

Build docs developers (and LLMs) love

Get Started

Configuration

Documentation Index

​Overview

​How Sanctum Works

​Installation

​User Model Configuration

​Sanctum Configuration

​Stateful Domains

​Token Expiration

​Authentication Guards

​Issuing API Tokens

​Token Abilities

​Protecting Routes

​Making Authenticated Requests

​Using JavaScript

​Using Postman

​Accessing Authenticated User

​Token Management

​Revoking Tokens

​Logout Endpoint

​Checking Token Abilities

​CORS Configuration

​Security Best Practices

​Rate Limiting

​Testing Authentication

Build docs developers (and LLMs) love

Overview

How Sanctum Works

Installation

User Model Configuration

Sanctum Configuration

Stateful Domains

Token Expiration

Authentication Guards

Issuing API Tokens

Token Abilities

Protecting Routes

Making Authenticated Requests

Using JavaScript

Using Postman

Accessing Authenticated User

Token Management

Revoking Tokens

Logout Endpoint

Checking Token Abilities

CORS Configuration

Security Best Practices

Rate Limiting

Testing Authentication