Skip to content

Installation

This framework contains several sub-packages that you don’t necessarily need. It is highly recommended to install what you need and not the whole framework.

The preferred way to install the library you need is to use composer:

composer require web-auth/webauthn-lib

If you use Symfony Framework, you may be interested in the bundle:

composer require web-auth/webauthn-symfony-bundle

For the Stimulus controllers (frontend integration), pull them straight from npm via AssetMapper or your favourite bundler — see Symfony UX Installation for details:

php bin/console importmap:require @web-auth/webauthn-stimulus

Warning

The legacy PHP package web-auth/webauthn-stimulus is deprecated since v5.3.0 and will be removed in 6.0.0. Install the controllers via npm instead.

Requirements

  • PHP: 8.2 or higher
  • Symfony (for the bundle): 6.4, 7.x, or 8.0+
  • Extensions: openssl

Info

Changed in v5.4.0: ext-json is no longer required by the packages. It is enabled by default in every supported PHP version and cannot be disabled since PHP 8.0.