Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

"Registration/login only challenge" typos in WebAuthn Guide #25596

Closed
primozh opened this issue May 16, 2022 · 2 comments · Fixed by #25616
Closed

"Registration/login only challenge" typos in WebAuthn Guide #25596

primozh opened this issue May 16, 2022 · 2 comments · Fixed by #25616

Comments

@primozh
Copy link
Contributor

primozh commented May 16, 2022

Description

In the WebAuthn guide there is an issue with the documentation about Javascript loginOnly function. Title of the subchapter should be changed and also in the code example function used is not the one mentioned in the text.

Suggested change

=== Only invoke the registration challenge and authenticator

The `webAuthn.loginOnly` method invokes the login challenge endpoint, then calls the authenticator and returns 
a https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise[Promise object] containing a
JSON object suitable for being sent to the callback endpoint. You can use that JSON object in order to store the credentials
in hidden form `input` elements, for example, and send it as part of a regular HTML form: 

[source,javascript]
----
webAuthn.login({ name: userName })

Should be changed to "Only invoke the login challenge..." and "webAuth.loginOnly({ name: userName })"

@geoand
Copy link
Contributor

geoand commented May 16, 2022

@primozh would you be interested in providing a fix?

@primozh
Copy link
Contributor Author

primozh commented May 17, 2022

@geoand sure, I'll prepare a PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants