summaryrefslogtreecommitdiff
path: root/README.adoc
diff options
context:
space:
mode:
Diffstat (limited to 'README.adoc')
-rw-r--r--README.adoc27
1 files changed, 18 insertions, 9 deletions
diff --git a/README.adoc b/README.adoc
index f389a83..6fe0272 100644
--- a/README.adoc
+++ b/README.adoc
@@ -1,8 +1,10 @@
1== libfido2 1== libfido2
2 2
3image:https://api.travis-ci.org/Yubico/libfido2.svg?branch=master["Build Status (Travis)", link="https://travis-ci.org/Yubico/libfido2"] 3image:https://github.com/yubico/libfido2/workflows/linux/badge.svg["Linux Build Status (github actions)", link="https://github.com/Yubico/libfido2/actions"]
4image:https://github.com/yubico/libfido2/workflows/windows/badge.svg["windows build status (github actions)", link="https://github.com/Yubico/libfido2/actions"] 4image:https://github.com/yubico/libfido2/workflows/macos/badge.svg["macOS Build Status (github actions)", link="https://github.com/Yubico/libfido2/actions"]
5image:https://img.shields.io/badge/license-BSD-blue.svg["License", link="https://raw.githubusercontent.com/Yubico/libfido2/master/LICENSE"] 5image:https://github.com/yubico/libfido2/workflows/windows/badge.svg["Windows Build Status (github actions)", link="https://github.com/Yubico/libfido2/actions"]
6image:https://github.com/yubico/libfido2/workflows/fuzzer/badge.svg["Fuzz Status (github actions)", link="https://github.com/Yubico/libfido2/actions"]
7image:https://oss-fuzz-build-logs.storage.googleapis.com/badges/libfido2.svg["Fuzz Status (oss-fuzz)", link="https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened&can=1&q=proj:libfido2"]
6 8
7*libfido2* provides library functionality and command-line tools to 9*libfido2* provides library functionality and command-line tools to
8communicate with a FIDO device over USB, and to verify attestation and 10communicate with a FIDO device over USB, and to verify attestation and
@@ -14,7 +16,7 @@ For usage, see the `examples/` directory.
14 16
15=== License 17=== License
16 18
17*libfido2* is licensed under the BSD 2-clause license. See the _LICENSE_ 19*libfido2* is licensed under the BSD 2-clause license. See the LICENSE
18file for the full license text. 20file for the full license text.
19 21
20=== Supported Platforms 22=== Supported Platforms
@@ -31,11 +33,17 @@ is also available.
31 33
32==== Releases 34==== Releases
33 35
34The current release of *libfido2* is 1.4.0. Please consult Yubico's 36The current release of *libfido2* is 1.5.0. Please consult Yubico's
35https://developers.yubico.com/libfido2/Releases[release page] for source 37https://developers.yubico.com/libfido2/Releases[release page] for source
36and binary releases. 38and binary releases.
37 39
38==== Ubuntu 40==== Ubuntu 20.04 (Focal)
41
42 $ sudo apt install libfido2-1
43 $ sudo apt install libfido2-dev
44 $ sudo apt install libfido2-doc
45
46==== Ubuntu 18.04 (Bionic) and 16.04 (Xenial)
39 47
40 $ sudo apt install software-properties-common 48 $ sudo apt install software-properties-common
41 $ sudo apt-add-repository ppa:yubico/stable 49 $ sudo apt-add-repository ppa:yubico/stable
@@ -52,15 +60,16 @@ Or from source, on UNIX-like systems:
52 $ make -C build 60 $ make -C build
53 $ sudo make -C build install 61 $ sudo make -C build install
54 62
55Depending on the platform, the PKG_CONFIG_PATH environment variable may need to 63Depending on the platform,
56be set. 64https://www.freedesktop.org/wiki/Software/pkg-config/[pkg-config] may need to
65be installed, or the PKG_CONFIG_PATH environment variable set.
57 66
58*libfido2* depends on https://github.com/pjk/libcbor[libcbor] and 67*libfido2* depends on https://github.com/pjk/libcbor[libcbor] and
59https://www.openssl.org[OpenSSL]. On Linux, libudev (part of 68https://www.openssl.org[OpenSSL]. On Linux, libudev (part of
60https://www.freedesktop.org/wiki/Software/systemd[systemd]) is also required. 69https://www.freedesktop.org/wiki/Software/systemd[systemd]) is also required.
61 70
62For complete, OS-specific installation instructions, please refer to the 71For complete, OS-specific installation instructions, please refer to the
63`.travis/` (Linux, MacOS) and `windows/` directories. 72`.actions/` (Linux, MacOS) and `windows/` directories.
64 73
65On Linux, you will need to add a udev rule to be able to access the FIDO 74On Linux, you will need to add a udev rule to be able to access the FIDO
66device, or run as root. For example, the udev rule may contain the following: 75device, or run as root. For example, the udev rule may contain the following: