WebAuthn TYPO3 Extension
========================

|Build Status| |GitHub| |TYPO3 Version| |codecov| |packagist|

This TYPO3 extension gives access to a second login form which uses the
`WebAuthn standard <https://webauthn.io>`__. Backend users are able to
login using a WebAuthn Authenticator. They also have the ability to
register one or more WebAuthn Authenticators. This is achieved by using
the `Webauthn
Framework <https://github.com/web-auth/webauthn-framework>`__.

Installation
------------

This extension only works when installed in composer mode. If you are
not familiar using composer together with TYPO3 yet, you can find a `how
to on the TYPO3 website <https://composer.typo3.org/>`__.

You can install the extension with the following command:

::

   composer require cvc/typo3-webauthn

The Extension does not require any further configuration. After it is
activated, a second login provider can be used to login using a WebAuthn
authenticator.

Configuration
-------------

You can reach the extension configuration under “settings” in the
Install tool of TYPO3.

The following options are available:

-  ``secondFactorLogin``: If ``true``, then the user must provide their
   username, password and WebAuthn authenticator in order to login. If
   the user has not registered any authenticator yet, then they can
   login without the authenticator as a second factor. If ``false``,
   then the user can decide whether to login with their username and
   password or with their WebAuthn authenticator only.

Usage
-----

Login
~~~~~

To Login with your previously registered WebAuthn Authenticator, you
have to select “Login with WebAuthn” on the login screen. Enter your
username, press enter, and follow the instructions on the screen to
proceed.

.. figure:: Documentation/images/login.png
   :alt: Picture with login process

   Picture with login process

Register credentials
~~~~~~~~~~~~~~~~~~~~

In the backend module “WebAuthn Authenticators” new WebAuthn
Authenticators can be registered. Press on register WebAuthn
Authenticator. If you want, you can enter a description for the
credential you are about to register.

.. figure:: Documentation/images/registration.png
   :alt: Picture with registration process

   Picture with registration process

.. |Build Status| image:: https://travis-ci.org/cvc-digital/typo3-webauthn.svg?branch=master
   :target: https://travis-ci.org/cvc-digital/typo3-webauthn
.. |GitHub| image:: https://img.shields.io/github/license/cvc-digital/typo3-webauthn
   :target: https://github.com/cvc-digital/typo3-webauthn/blob/master/LICENSE
.. |TYPO3 Version| image:: https://img.shields.io/badge/TYPO3-%5E9.5%20%7C%7C%20%5E10.4-orange
   :target: https://extensions.typo3.org/extension/cvc_webauthn
.. |codecov| image:: https://codecov.io/gh/cvc-digital/typo3-webauthn/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/cvc-digital/typo3-webauthn
.. |packagist| image:: https://img.shields.io/packagist/v/cvc/typo3-webauthn
   :target: https://packagist.org/packages/cvc/typo3-webauthn