moontechs/filament-webauthn

Filament webauthn sign in and registration

0.1.8 2022-10-26 20:18 UTC

Requires

• php: >=8.0
• ext-gmp: *
• ext-json: *
• ext-openssl: *
• ext-sodium: *
• filament/filament: ^2.0
• illuminate/contracts: ^9.0
• madwizard/webauthn: ^0.8.1
• spatie/laravel-package-tools: ^1.13.0

Requires (Dev)

• laravel/pint: ^1.0
• nunomaduro/collision: ^6.0
• nunomaduro/larastan: ^2.0.1
• orchestra/testbench: ^7.0
• pestphp/pest: ^1.21
• pestphp/pest-plugin-laravel: ^1.1
• phpstan/extension-installer: ^1.1
• phpstan/phpstan-deprecation-rules: ^1.0
• phpstan/phpstan-phpunit: ^1.0
• phpunit/phpunit: ^9.5

MIT

• Michael Kozii

• laravel
• fido
• webauthn
• moontechs
• filament-webauthn

README

Passwordless login for your Filament app. Web Authentication server-side and front-end components.

The package has the following components:

• registration button and widget
• login form extension to redirect to the webauthn login page
• separate route and page with webauthn login form

Should work with HTTPS and not localhost only.

Installation

You can install the package via composer:

composer require moontechs/filament-webauthn

You should publish and run the migrations with:

php artisan vendor:publish --tag="filament-webauthn-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="filament-webauthn-config"

This is the contents of the published config file:

return [
    'login_page_url' => '/webauthn-login',
    'user' => [
        'auth_identifier' => 'email', // column in users table with unique user id
    ],
    'widget' => [
        'column_span' => '',
    ],
    'register_button' => [
        'icon' => 'heroicon-o-key',
        'class' => 'w-full',
    ],
    'login_button' => [
        'icon' => 'heroicon-o-key',
        'class' => 'w-full',
    ],
    'auth' => [
        'relying_party' => [
            'name' => env('APP_NAME'),
            'origin' => env('APP_URL'),
            'id' => env('APP_HOST', parse_url(env('APP_URL'))['host']),
        ],
        'client_options' => [
            'timeout' => 60000,
            'platform' => '', // available: platform, cross-platform, or leave empty
            'attestation' => 'direct', // available: direct, indirect, none
            'user_verification' => 'required', // available: required, preferred, discouraged
        ],
    ],
];

Optionally, you can publish the views using

php artisan vendor:publish --tag="filament-webauthn-views"

You can publish the translation file with:

php artisan vendor:publish --tag="filament-webauthn-translations"

Usage

• Install the package.
• Publish migrations and migrate.

Registration widget

Only signed-in users can register a device to be able to sign in to use it in the future.

• Register Moontechs\FilamentWebauthn\Widgets\WebauthnRegisterWidget::class widget. Add it to the widgets.register array of the Filament config.

Customization

• Publish the config file
• widget.column_span - widget width (docs)

Registration button (without widget)

• Add <livewire:webauthn-register-button/> in any view.

Customization

• Publish the config file
• register_button.icon - choose any available icon
• register_button.class - add more classes or change the default one

Redirect to the login page button

• Publish Filament login page view php artisan vendor:publish --tag=filament-views
• Add <x-filament-webauthn::login-form-extension /> in the end of the login form.

If you didn't want to use this button, you can use a simple redirect to a named route filament-webauthn.login.

Login form

Customization

• Publish the config file
• login_button.icon - choose any available icon
• login_button.class - add more classes or change the default one

Testing

composer test

Credits

• Michael Kozii
• All Contributors

License

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