Skip to content
This repository was archived by the owner on Mar 25, 2024. It is now read-only.

Commit f020f9e

Browse files
committed
Add some info on the U2F protocol to the README
1 parent 9320271 commit f020f9e

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,13 @@ A PHP implementation of the FIDO U2F authentication standard
44

55
## Introduction
66

7-
This library is designed to allow easy integration of U2F hardware keys to an existing user authentication scheme.
7+
U2F, or Universal Second Factor, is a new authentication protocol designed "to augment the security of their existing password infrastructure by adding a strong second factor to user login"[1](https://fidoalliance.org/specs/fido-u2f-v1.0-nfc-bt-amendment-20150514/fido-u2f-overview.html#background). It allows websites to replace the need for a companion app (such as Google Authenticator) with a single hardware token that will work across any website supporting the U2F protocol.
8+
9+
This library is designed to allow easy integration of the U2F protocol to an existing user authentication scheme.
810
It handles the parsing and validating all of the raw message formats, and translates them into standard PHP objects.
911

10-
Note that use of the word "key" here refers to a USB "key" or dongle; however, the device may connect with the browser over a different protocol (such as Bluetooth or NFC).
11-
Unless otherwise stated, "key" should be interpreted to mean "FIDO U2F Token".
12+
Note that use of the word "key" throughout this document should be interpreted to mean "FIDO U2F Token".
13+
These are often USB "keys" but can also be NFC or Bluetooth devices.
1214

1315
There are two main operations that you will need to understand for a successful integration: registration and authentication.
1416
Registration is the act of associating a key that the end-user is physically in posession of with their existing account; authentication is where that key is used to cryptographically sign a message from your application to verify posession of said key.

0 commit comments

Comments
 (0)