package webauthn

All checked builds pass
  1. Overview
  2. Docs
WebAuthn - authenticating users to services using public key cryptography

Install 

dune-project
 Dependency

github.com Readme Changelog BSD-2-Clause License Edit opam file Versions (2)

Authors

  1. R
    Reynir Björnsson <reynir@reynir.dk>
  2. H
    Hannes Mehnert <hannes@mehnert.org>

Maintainers

  1. T
    team@robur.coop

Sources

webauthn-0.2.0.tbz
sha256=74a13e1cb421c3e06b18c09e01097edafebd3b5169d600cf1da5449bf013c622
sha512=71e23aea56e6edc95fa01643cad00c3a3edea2a9cc5c1c921c4afd54bcdeaba4c9768251b8eee9c6a0f5819c9a1780507922d3012b559cf0d5949ca03cac4482

Description

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

WebAuthn provides two funcitons: register and authenticate. Usually the public and private keypair is stored on an external token (Yuikey etc.) or part of the platform (TPM). 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.

Demo server WebAuthn specification at W3C

Added to opam-repository:

README

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.

Dependencies (12)

  1. ohex >= "0.2.0"
  2. cbor >= "0.5"
  3. base64 >= "3.1.0"
  4. x509 >= "1.0.2"
  5. ocplib-endian
  6. mirage-crypto-rng >= "1.1.0"
  7. mirage-crypto-ec >= "1.1.0"
  8. digestif
  9. ppx_deriving_yojson
  10. yojson
  11. dune >= "2.7"
  12. ocaml >= "4.08.0"

Dev Dependencies (5)

  1. lwt dev
  2. logs dev
  3. cmdliner dev & >= "1.1.0"
  4. ppx_blob dev
  5. dream dev & >= "1.0.0~alpha7"

Optional Dependencies

None

Used by

None

Conflicts (1)

  1. result < "1.5"

Build status

Results of building webauthn with each compiler on check.ci.ocaml.org, run of against opam-repository 8a77e58. All results for this package.

Each result links to its build log. To keep crawlers from overloading the site, build logs require a GitHub sign-in (see ocurrent/opam-health-check). On your first log, GitHub asks you to “Authorize opam-health-check”, the OCurrent app that runs these checks; it sees only your public profile, not your repositories. The sign-in lasts 30 days.

Version OCaml 4.11 OCaml 4.14 OCaml 5.2 OCaml 5.4 OCaml 5.5
0.2.0 (this version) n/a good good good good
0.1.0 good good good good good
  • good Package successfully built
  • partial One of the dependencies failed to build
  • bad Package failed to build
  • n/a Package is not available in this environment
  • internal Internal failure