Skip to content

Commit

Permalink
Extract formal definition of Human Palatability
Browse files Browse the repository at this point in the history
  • Loading branch information
emlun committed Dec 7, 2017
1 parent 7508d60 commit 64b728e
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions index.bs
Original file line number Diff line number Diff line change
Expand Up @@ -376,6 +376,12 @@ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "S
attestation=], the [=credential key pair=] is also used as the [=attestation key pair=], see [=self attestation=]
for details.


: <dfn>Human Palatability</dfn>
:: An identifier that is [=human palatability|human-palatable=] is intended to be rememberable and reproducible by typical human
users, in contrast to identifiers that are, for example, randomly generated sequences of bits.


: <dfn>Public Key Credential Source</dfn>
:: A [=credential source=] ([[CREDENTIAL-MANAGEMENT-1]]) used by an [=authenticator=] to generate [=authentication assertions=]. A public key credential source has:

Expand Down Expand Up @@ -1403,20 +1409,17 @@ associated.

- When inherited by {{PublicKeyCredentialRpEntity}} it is a human-friendly identifier for the [=[RP]=], intended only
for display. For example, "ACME Corporation", "Wonderful Widgets, Inc." or "Awesome Site".
- When inherited by {{PublicKeyCredentialUserEntity}}, it is a human-palatable identifier for a user account. It is
intended only for display, and SHOULD allow the user to easily tell the difference between user accounts with similar
{{PublicKeyCredentialUserEntity/displayName}}s. For example, "alexm", "alex.p.mueller@acme.com" or "+14255551234". The
[=[RP]=] MAY let the user choose this, and MAY restrict the choice as needed or appropriate. For example, a [=[RP]=]
might choose to map human-palatable [=username=] account identifiers to the {{PublicKeyCredentialEntity/name}}
member of {{PublicKeyCredentialUserEntity}}.
- When inherited by {{PublicKeyCredentialUserEntity}}, it is a [=human palatability|human-palatable=] identifier for a
user account. It is intended only for display, and SHOULD allow the user to easily tell the difference between user
accounts with similar {{PublicKeyCredentialUserEntity/displayName}}s. For example, "alexm", "alex.p.mueller@acme.com"
or "+14255551234". The [=[RP]=] MAY let the user choose this, and MAY restrict the choice as needed or appropriate.
For example, a [=[RP]=] might choose to map [=human palatability|human-palatable=] [=username=] account identifiers to
the {{PublicKeyCredentialEntity/name}} member of {{PublicKeyCredentialUserEntity}}.

[=Authenticators=] MUST accept and store a 64 byte minimum length for a {{PublicKeyCredentialEntity/name}} members's
value. Authenticators MAY truncate a {{PublicKeyCredentialEntity/name}} member's value to a length equal to or greater
than 64 bytes.

Note: An identifier that is human-palatable is intended to be rememberable and reproducible by typical human users, in
contrast to identifiers that are, for example, randomly generated sequences of bits.

: <dfn>icon</dfn>
:: A [=URL serializer|serialized=] URL which resolves to an image associated with the entity. For example, this could be
a user's avatar or a [=[RP]=]'s logo. This URL MUST be an [=a priori authenticated URL=]. [=Authenticators=] MUST
Expand Down

0 comments on commit 64b728e

Please sign in to comment.