mpociot/laravel-face-auth

Use Microsoft Face API as a authentication method in your Laravel app.

0.1.0 2017-03-13 06:36 UTC

Requires

• php: ^7.0
• guzzlehttp/guzzle: ^6.0
• intervention/image: ^2.3
• mockery/mockery: ^0.9.9

Requires (Dev)

• orchestra/testbench: ^3.4
• phpunit/phpunit: ^6.0

MIT

• Marcel Pociot

• mpociot
• laravel-face-auth

README

This package uses Microsoft's cognitive API to identify faces instead of passwords for your Laravel application.

Disclaimer

Any kind of Face Recognition, using the camera of the device as a form of Authentication is flawed. You only need to hold a good photo in front of the camera to by pass it. Using this for authentication is like shooting in your own foot and contributing for a more insecure web.

Please do not use face recognition as an alternative for password authentication in a production system!

Installation

You can install the package via Composer:

$ composer require mpociot/laravel-face-auth

Add the service provider to your config/app.php:

Mpociot\FaceAuth\FaceAuthServiceProvider::class,

In your config/auth.php, change the auth driver to faceauth:

'providers' => [
    'users' => [
        'driver' => 'faceauth',
        'model' => App\User::class,
    ],
]

Publish the configuration:

$ php artisan vendor:publish --provider="Mpociot\FaceAuth\FaceAuthServiceProvider"

Edit the newly published config/faceauth.php file and enter your Face API key.

Usage and authorization

The face authentication works, by using a reference image of your user and matching it against a uploaded image upon login. So this pretty much is the same flow as comparing two password hashes.

When you register your users, you need to make sure that you store a photo of the users face - this is basically his password.

In order for this package, to find the user photo, your User model needs to implement the FaceAuthenticatable interface.

This interface only has one single public method getFaceAuthPhoto(). This method needs to return the content of the user photo.

Example:

class User extends Authenticatable implements FaceAuthenticatable
{

    public function getFaceAuthPhoto()
    {
        return File::get(storage_path('facces') . $this->id . '.png');
    }
    
}

Your login form now needs a photo field (the name can be configured) - this field should contain a base64 representation of the image, the user uses to log in.

If you want a simple way to capture the user image from the webcam, take a look at the vue-webcam Vue.js component.

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Marcel Pociot
• All Contributors

License

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