ovarun/laravel-hmac-auth

Secure HMAC authentication module for Laravel APIs

v1.0.0 2025-07-24 21:18 UTC

Requires

• php: ^8.0
• illuminate/support: ^10.0

MIT

• Arun o v

README

Secure, stateless HMAC authentication for Laravel APIs — built for partner APIs, internal microservices, and multi-platform consumers (Angular, .NET, Python, Drupal).

📦 Requirements

• PHP 8.0+
• Laravel 10.x
• Composer
• OpenSSL / hash_pbkdf2 support

🚀 Installation

Install directly via Packagist:

composer require ovarun/laravel-hmac-auth

Publish the config and migrations:

php artisan vendor:publish --tag=hmac-auth
php artisan migrate

⚙️ Initial Setup

Run the interactive setup to auto-generate secure HMAC key and salt:

php artisan hmac:setup

This adds to your .env:

HMAC_SECRET_GENERATOR_KEY='...'
HMAC_SECRET_GENERATOR_SALT='...'

These are used for deterministic, secure secret generation per client.

🔐 Register HMAC Clients

Register a new client via:

php artisan hmac:client-create

• Prompts for Client Name (and optional Client ID)
• Normalizes ID (lowercase, hyphenated, clean)
• Generates PBKDF2-based 256-bit secret
• Saves to hmac_clients table

🛡 Middleware Usage

Apply HMAC protection to your API routes.

Register Middleware in app/Http/Kernel.php:

'verify.hmac' => \Ovarun\HmacAuth\Http\Middleware\VerifyHmacSignature::class,

Use in Routes:

Route::middleware('verify.hmac')->group(function () {
    Route::post('/api/secure-endpoint', [SecureController::class, 'handle']);
});

📤 Client-Side Authentication

Clients must include these HTTP headers:

X-CLIENT-ID: partner-app-1
X-TIMESTAMP: 2025-07-24T14:05:00Z
X-SIGNATURE: {hmac_sha256_signature}

Signature is built from:

$message = $timestamp . $method . $path . $body

Then:

hash_hmac('sha256', $message, $clientSecret);

🧪 Security Best Practices

• Always use HTTPS
• Rotate secrets on a schedule
• Use short timestamp tolerance (config/hmac.php)
• Pair with IP whitelisting or rate limits
• Never log or expose the secret in responses

📄 License

MIT © arun o v