Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dagnelies committed Apr 8, 2023
1 parent b8616b1 commit 76b7644
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -319,27 +319,30 @@ Remarks

### The `challenge` is critical

It should be truly random. Otherwise, your whole implementation might become vulnerable.
The challenge must be a random value.
Otherwise, your implementation might become vulnerable to replay attacks.


### There can be multiple credentials per user ID

Unlike traditional authentication, you can have multiple public/private key pairs per user: one per device.


### Authentication does *not* provide `username` out of the box

Only `credentialId` is provided during the authentication.

So either you maintain a mapping `credentialId -> username` in your database, or you add the `username` in your frontend to backend communication.


### Let the platform choose the user

You can *not* specify any credential ids during authentication. In that case, the platform will pop-up a default dialog to let you pick a user and perform authentication. Of course, the look and feel is platform specific.


### This library simplifies a few things by using sensible defaults


Unlike the [webauthn protocol](), some defaults are different:
Unlike the [WebAuthn protocol](https://w3c.github.io/webauthn/), some defaults are different:

- The `timeout` is one minute by default.
- If the device can act as authenticator itself, it is preferred instead of asking which authenticator type to use.
Expand Down

0 comments on commit 76b7644

Please sign in to comment.