From 53f1a541aa58167c6c02308694d4c9476da86f80 Mon Sep 17 00:00:00 2001 From: wbamberg Date: Mon, 5 Aug 2024 11:37:07 -0700 Subject: [PATCH] Rework PublicKeyCredentialRequestOptions intro; add a glossary page for authenticator --- files/en-us/glossary/authenticator/index.md | 19 +++++++++++++++++++ .../index.md | 4 +++- 2 files changed, 22 insertions(+), 1 deletion(-) create mode 100644 files/en-us/glossary/authenticator/index.md diff --git a/files/en-us/glossary/authenticator/index.md b/files/en-us/glossary/authenticator/index.md new file mode 100644 index 000000000000000..e7fc50a3b2c5dfe --- /dev/null +++ b/files/en-us/glossary/authenticator/index.md @@ -0,0 +1,19 @@ +--- +title: Authenticator +slug: Glossary/Authenticator +page-type: glossary-definition +--- + +{{GlossarySidebar}} + +An **authenticator** is an entity that is inside or attached to the user's device, and that can perform the cryptographic operations needed to register and authenticate users, and securely store the cryptographic keys used in these operations. + +An authenticator might be integrated into the device, like the [Touch ID](https://en.wikipedia.org/wiki/Touch_ID) system in Apple devices or the [Windows Hello](https://en.wikipedia.org/wiki/Windows_10#System_security) system, or it might be a removable module like a [Yubikey](https://en.wikipedia.org/wiki/YubiKey). + +The [Web Authentication API](/en-US/docs/Web/API/Web_Authentication_API) makes authenticators available to websites as part of the [Credential Management API](/en-US/docs/Web/API/Credential_Management_API). This enables websites to use authenticators to generate {{glossary("credential", "credentials")}} based on {{glossary("public-key cryptography")}}, which can then be used to sign users into websites. + +## See also + +- Related glossary terms: + - {{glossary("Authentication")}} + - {{glossary("Credential")}} diff --git a/files/en-us/web/api/publickeycredentialrequestoptions/index.md b/files/en-us/web/api/publickeycredentialrequestoptions/index.md index a044d2e28b265c0..f5e080c753441c1 100644 --- a/files/en-us/web/api/publickeycredentialrequestoptions/index.md +++ b/files/en-us/web/api/publickeycredentialrequestoptions/index.md @@ -7,7 +7,9 @@ spec-urls: https://w3c.github.io/webauthn/#dictdef-publickeycredentialrequestopt {{APIRef("Web Authentication API")}}{{securecontext_header}} -The **`PublicKeyCredentialRequestOptions`** dictionary represents the object passed to {{domxref("CredentialsContainer.get()")}} as the value of the `publicKey` option: that is, when using `get()` to generate an assertion using the [Web Authentication API](/en-US/docs/Web/API/Web_Authentication_API). +The **`PublicKeyCredentialRequestOptions`** dictionary represents the object passed to {{domxref("CredentialsContainer.get()")}} as the value of the `publicKey` option:. + +It is used to request a {{domxref("PublicKeyCredential")}} provided by an {{glossary("authenticator")}} that supports the [Web Authentication API](/en-US/docs/Web/API/Web_Authentication_API). ## Instance properties