W3C home > Mailing lists > Public > public-webauthn@w3.org > May 2017

[webauthn] `AuthenticationExtensions` typedef name is confusing; also there are issues with its description

From: =JeffH via GitHub <sysbot+gh@w3.org>
Date: Tue, 23 May 2017 00:23:52 +0000
To: public-webauthn@w3.org
Message-ID: <issues.opened-230554222-1495499030-sysbot+gh@w3.org>
equalsJeffH has just created a new issue for https://github.com/w3c/webauthn:

== `AuthenticationExtensions` typedef name is confusing; also there are issues with its description ==
see [4.7. Authentication Extensions (typedef AuthenticationExtensions)](https://www.w3.org/TR/webauthn/#iface-authentication-extensions)

the name "AuthenticationExtensions" is confusing (to me at least) because "extensions" may be requested in both `[[Create]](options)` {#createCredential}  and `[[DiscoverFromExternalSource]](options)` {#getAssertion} methods, and there are two extension subtypes: "authenticator extensions" and "client extensions".

Additionally, this same typedef is used to return extension results within the [PublicKeyCredential object](https://www.w3.org/TR/webauthn/#iface-pkcredential). 

I suggest we rename this object "WebAuthenticationExtensionData".  then having subtypes denoted as "authenticator extensions" and "client extensions" because they are just abbreviated names for e.g. "authenticator web authentication extension" and "client web authentication extension".

I note that we do use the term "web authentication" in a few key manners, and it seems to me this ought to be one of them. 

Additionally, I suggest we rename [§8 WebAuthn Extensions](https://www.w3.org/TR/webauthn/#extensions) to be "§8 Web Authentication Extensions".

I can address this as part of addressing this as a part of finishing PR #464.




Please view or discuss this issue at https://github.com/w3c/webauthn/issues/471 using your GitHub account
Received on Tuesday, 23 May 2017 00:23:58 UTC

This archive was generated by hypermail 2.4.0 : Tuesday, 5 July 2022 07:26:26 UTC