robur/webauthn: An implementation of webauthn in OCaml.

An implementation of webauthn in OCaml.

Find a file

Reynir Björnsson 1e79dea71a Refactor rc script		2024-09-18 16:26:15 +02:00
bin	Update to newer dependencies	2024-09-13 11:30:02 +02:00
flash_message	Update to dream.1.0.0~alpha4 and cmdliner>=1.1.0	2023-02-17 09:47:26 +01:00
misc/rc.d	Refactor rc script	2024-09-18 16:26:15 +02:00
src	Update to newer dependencies	2024-09-13 11:30:02 +02:00
CHANGES.md	Prepare release 0.2.0	2024-09-13 17:22:12 +02:00
dune-project	dune-project: disable formatting	2021-10-07 10:02:03 +00:00
LICENSE.md	Add BSD 2-clause license in LICENSE.md	2021-11-18 15:01:45 +01:00
README.md	Update README.md	2023-10-01 22:53:37 -04:00
webauthn.opam	Update webauthn.opam	2024-09-13 14:30:22 +02:00

README.md

WebAuthn - authenticating users to services using public key cryptography

WebAuthn is a web standard published by the W3C. Its goal is to standardize an interface for authenticating users to web-based applications and services using public key cryptography. Modern web browsers support WebAuthn functionality.

WebAuthn provides two functions: register and authenticate. Usually the public-private keypair is stored on an external device, called a security key (Yubikey, Trustkey etc.) or inside a platform(OS) authenticator. Platform authenticators are available on all modern platforms, such as Windows, Mac, Android and iOS. After the public key is registered, it can be used to authenticate to the same service.

This module does not preserve a database of registered public keys, their credential ID, usernames and pending challenges - instead this data must be stored by a client of this API in a database or other persistent storage.

WebAuthn specification at W3C

A basic demonstration server is provided (bin/webauthn_demo), running at webauthn-demo.robur.coop.

Documentation

API documentation is available online.

Installation

opam install webauthn will install this library.