README

Supported Public Keys

Installation

You can install the package via composer:

composer require laranex/laravel-biometric-auth

You can publish and run the migrations with:

php artisan vendor:publish --tag="biometric-auth-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="biometric-auth-config"

This is the contents of the published config file:

<?php

return [
    'table' => env('BIOMETRIC_AUTH_TABLE', 'biometrics'),

    // You will need to be explicit about the encryption padding and hash algorithm when working with RSA keys.
    // For the rest of the algorithms, the package will automatically detect with the help of phpseclib.
    'rsa' => [
        'encryption_padding' => \phpseclib3\Crypt\RSA::SIGNATURE_PKCS1,
        'hash_algorithm' => 'sha256',
    ],
];

Usage

// Use Laranex\LaravelBiometricAuth\Traits\HasBiometrics in your Authenticable Model such as User, Admin
class User extends Authenticatable {
    use Laranex\LaravelBiometricAuth\Traits\HasBiometrics;
}

// Register a new biometric
$user->createBiometric("Base 64 encoded public key");

// Create a challenge for biometric authentication
$biometric = Laranex\LaravelBiometricAuth\Facades\LaravelBiometricAuth::getBiometric("UUID of a biometric");

// Verify the signature
Laranex\LaravelBiometricAuth\Facades\LaravelBiometricAuth::verifyBiometric("UUID of a biometric", "Signature");

// Get the user of verified biometric key
$user = Biometric::find("UUID of a biometric")->instance;

// Revoke a biometric
$user->revokeBiometric("UUID of a biometric");

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

laranex / laravel-biometric-auth

Maintainers

Details