Skip to content

Commit 68f5e2b

Browse files
authored
Merge pull request #147 from Yubico/doc/readme
Doc/readme
2 parents 91a116b + 397adb5 commit 68f5e2b

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

README

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,8 @@ In addition to the main `webauthn-server-core` module, there are also:
5757
interface, which by default comes preloaded with attestation metadata for Yubico devices.
5858

5959
- `webauthn-server-core-minimal`: Alternative distribution of `webauthn-server-core`,
60-
without a dependency on BouncyCastle.
61-
If depending on this module instead of `webauthn-server-core`,
62-
you may have to add your own JCA providers to support some signature algorithms.
60+
not dependent on BouncyCastle.
61+
Using it means you may have to add your own JCA providers to support some signature algorithms.
6362
In particular, OpenJDK 14 and earlier does not include providers for the EdDSA family of algorithms.
6463

6564

@@ -81,7 +80,7 @@ In addition to the main `webauthn-server-core` module, there are also:
8180
=== Non-features
8281

8382
This library has no concept of accounts, sessions, permissions or identity
84-
federation, and it's not an authentication framework; it only deals with
83+
federation, and it is not an authentication framework; it only deals with
8584
executing the WebAuthn authentication mechanism. Sessions, account management
8685
and other higher level concepts can make use of this authentication mechanism,
8786
but the authentication mechanism alone does not make a security system.
@@ -110,7 +109,7 @@ The client side involves:
110109
1. Call `navigator.credentials.create()` or `.get()`,
111110
passing the result from `RelyingParty.startRegistration(...)` or `.startAssertion(...)` as the argument.
112111
2. Encode the result of the successfully resolved promise and return it to the server.
113-
For this you'll need some way to encode `Uint8Array` values;
112+
For this you need some way to encode `Uint8Array` values;
114113
this guide will assume use of link:https://github.com/beatgammit/base64-js[base64-js].
115114
However the built-in parser methods for
116115
link:https://developers.yubico.com/java-webauthn-server/JavaDoc/webauthn-server-core/latest/com/yubico/webauthn/data/PublicKeyCredential.html[`PublicKeyCredential`]
@@ -190,7 +189,7 @@ String credentialCreateJson = request.toCredentialsCreateJson();
190189
return credentialCreateJson; // Send to client
191190
----------
192191

193-
You'll need to keep this `PublicKeyCredentialCreationOptions` object in temporary storage
192+
You will need to keep this `PublicKeyCredentialCreationOptions` object in temporary storage
194193
so you can also pass it into `finishRegistration(...)` later.
195194

196195
Now call the WebAuthn API on the client side:
@@ -266,7 +265,7 @@ try {
266265
----------
267266

268267
Finally, if the previous step was successful, store the new credential in your database.
269-
Here's an example of things you'll likely want to store:
268+
Here is an example of things you will likely want to store:
270269

271270
[source,java]
272271
----------
@@ -308,7 +307,7 @@ String credentialGetJson = request.toCredentialsGetJson();
308307
return credentialGetJson; // Send to client
309308
----------
310309

311-
Again, you'll need to keep this `PublicKeyCredentialRequestOptions` object in temporary storage
310+
Again, you will need to keep this `PublicKeyCredentialRequestOptions` object in temporary storage
312311
so you can also pass it into `finishAssertion(...)` later.
313312

314313
Now call the WebAuthn API on the client side:

0 commit comments

Comments
 (0)