Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/moontechs/filament-webauthn
Passwordless login for your Filament app. Webauthn server-side and front-end components.
https://github.com/moontechs/filament-webauthn
2fa 2factor fido fido2 filament filament-plugin filamentphp laravel laravel-filament php relying-party two-factor-authentication webauthn
Last synced: 2 months ago
JSON representation
Passwordless login for your Filament app. Webauthn server-side and front-end components.
- Host: GitHub
- URL: https://github.com/moontechs/filament-webauthn
- Owner: moontechs
- License: mit
- Created: 2022-10-06T15:55:21.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-18T22:58:20.000Z (about 2 years ago)
- Last Synced: 2024-11-16T09:38:00.792Z (2 months ago)
- Topics: 2fa, 2factor, fido, fido2, filament, filament-plugin, filamentphp, laravel, laravel-filament, php, relying-party, two-factor-authentication, webauthn
- Language: PHP
- Homepage:
- Size: 498 KB
- Stars: 13
- Watchers: 0
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Filament Webauthn Authentication (FIDO)
[](https://packagist.org/packages/moontechs/filament-webauthn)
[](https://github.com/moontechs/filament-webauthn/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/moontechs/filament-webauthn/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[](https://packagist.org/packages/moontechs/filament-webauthn)
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:
```bash
composer require moontechs/filament-webauthn
```
You should publish and run the migrations with:
```bash
php artisan vendor:publish --tag="filament-webauthn-migrations"
php artisan migrate
```
You can publish the config file with:
```bash
php artisan vendor:publish --tag="filament-webauthn-config"
```
This is the contents of the published config file:
```php
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
```bash
php artisan vendor:publish --tag="filament-webauthn-views"
```
You can publish the translation file with:
```bash
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](https://filamentphp.com/docs/2.x/admin/dashboard/getting-started#customizing-widget-width))
### Registration button (without widget)
* Add `` 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 `` 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
```bash
composer test
```
## Credits
- [Michael Kozii](https://github.com/mkoziy)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.