Skip to content

Remove registry #376

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.

Sign up for GitHub

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Remove registry #376

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
207 changes: 8 additions & 199 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,8 +117,7 @@ <h2 class="informative">
credential/presentation requests|presentation=] [=digital
credential/exchange protocols=], credential [=digital credential/issuance
request|issuance=] [=digital credential/issuance protocols|protocols=]
and credential formats. However, to promote interoperability this
document includes a [[[#protocol-registry]]].
and credential formats.
</p>
<p>
The API is designed to support the following goals:
Expand Down Expand Up @@ -517,8 +516,7 @@ <h2>
<dd>
A standardized protocol used for exchanging a [=digital credential=]
between a [=holder=] and a [=verifier=]. A protocol is identified by a
[=digital credential/protocol identifier=]. See section also
[[[#protocol-registry]]].
[=digital credential/protocol identifier=].
</dd>
<dt>
<dfn data-dfn-for="digital credential">Protocol identifier</dfn>
Expand All @@ -537,7 +535,7 @@ <h2>
A standardized protocol used for communication between an [=issuer=]
and a [=holder=] during the issuance of a [=digital credential=]. The
issuance protocol is identified by a [=digital credential/protocol
identifier=]. See also section [[[#protocol-registry]]].
identifier=].
</dd>
</dl><!--
// MARK: The Digital Credentials API
Expand Down Expand Up @@ -641,9 +639,8 @@ <h4>
denotes the [=digital credential/exchange protocol=].
</p>
<p>
The {{DigitalCredentialCreateRequest/protocol}} member's value can be one
of the well-defined protocol identifiers defined in
[[[#protocol-registry]]] or a custom protocol identifier.
The {{DigitalCredentialCreateRequest/protocol}} member's value must be
a [=digital credential/protocol identifier=].
</p>
<h4>
The `data` member
Expand Down Expand Up @@ -715,9 +712,8 @@ <h4>
member denotes the [=digital credential/issuance protocol=].
</p>
<p>
The {{DigitalCredentialCreateRequest/protocol}} member's value is be one
of the well-defined keys defined in [[[#protocol-registry]]] or any other
custom one.
The {{DigitalCredentialCreateRequest/protocol}} member's value must be
a [=digital credential/protocol identifier=].
</p>
<h4>
The `data` member
Expand Down Expand Up @@ -994,185 +990,6 @@ <h2>
</dd>
</dl>
</section>
<h2 id="protocol-registry">
Registry of protocols
</h2>
<p>
Initiating the registration a protocol is done by <a href=
"https://github.com/w3c-fedid/digital-credentials/issues">filing an
issue</a> in our GitHub repository.
</p>
<p>
The following is the registry of [=digital credential/exchange
protocols=] and [=digital credential/issuance protocols=] that are
supported by this specification.
</p>
<p class="note" title="Official Registry" data-cite="w3c-process">
It is expected that this registry will be become a [=W3C registry=] in
the future.
</p><!--
// MARK: General inclusion criteria
-->
<h3>
General inclusion criteria
</h3>
<aside class="note">
The below criteria are a work in progress and are likely to change as
this document evolves.
</aside>
<p>
To be included in the registry, the [=digital credential/exchange
protocol=]:
</p>
<ol>
<li>MUST be standardized at a <a href=
"https://www.w3.org/liaisons/">consortium the W3C liaises with</a>
</li>
<li>MUST be defined in a specification which is freely and publicly
available at the stable URL listed in the registry.
</li>
<li>MUST define a representation, as either a [[WebIDL]] [=dictionary=]
or a JSON object, of the [=digital credential/exchange protocol=] request
structure (i.e., the [=dictionary=] which defines the semantics and
validation of the {{DigitalCredentialGetRequest}}'s
{{DigitalCredentialGetRequest/data}} member) and the [=digital
credential/issuance protocol=] request structure (i.e., the
[=dictionary=] which defines the semantics and validation of the
{{DigitalCredentialCreateRequest}}'s
{{DigitalCredentialCreateRequest/data}} member).
</li>
<li>MUST define a representation, as either a [[WebIDL]] [=dictionary=]
or a JSON object, of the [=digital credential/exchange protocol=]
response structure (i.e., the [=dictionary=] which defines the semantics
and validation of the {{DigitalCredential}}'s {{DigitalCredential/data}}
member.
</li>
<li>MUST define validation rules for members of the request and response
structures.
</li>
<li>MUST have undergone privacy review by the W3C's <a href=
"https://www.w3.org/groups/wg/privacy/">Privacy Working Group</a> and
<a href="https://www.w3.org/groups/wg/fedid/">Federated Identity Working
Group</a>.
<aside class="note" title="Organizing reviews">
Once an expression of registration is received via GitHub, the
registry maintainers will organize the privacy review with the
<a href="https://www.w3.org/groups/wg/privacy/">Privacy Working
Group</a> . Please see the [[[security-privacy-questionnaire]]] for
the kind of questions that will be asked of the protocol you are
registering.
</aside>
</li>
<li>MUST have undergone security review by the <a href=
"https://www.w3.org/groups/ig/security/">Security Interest Group</a>.
</li>
<li>MUST have implementation commitment from at least one browser engine,
one credential provider/wallet, and one issuer or verifier (depending on
the protocol type). Each component MUST be from independent
organizations.
</li>
<li>MUST have formally recorded consensus by the Federated Identity
Working Group to be included in the registry.
</li>
</ol>
<h4>
Presentation-specific inclusion criteria
</h4>
<p>
To be included as a presentation protocol in the registry (used with
`navigator.credentials.get`), the [=digital credential/exchange
protocol=]:
</p>
<ol>
<li>MUST support response encryption.
</li>
<li>MUST encrypt any response containing personally identifiable
information (PII).
</li>
</ol><!--
// MARK: Change process
-->
<h3>
Change process
</h3>
<p>
To add a new [=digital credential/exchange protocol=] to the registry, or
to update an existing one:
</p>
<dl>
<dt>
Define a [=digital credential/protocol identifier=].
</dt>
<dd>
The [=digital credential/protocol identifier=] MUST be a unique string
that is not already in use in the registry. The [=digital
credential/protocol identifier=] MUST uniquely define the set of
required parameters and/or behavior that a digital credential provider
implementation needs to support to successfully handle the request. If
the set of required parameters or behaviors is updated in a way which
would require a digital credential provider to also require an update
to remain functional, a new protocol identifier MUST be assigned and be
added to the registry.
</dd>
<dt>
Specify a <dfn data-dfn-for="registry" data-local-lt="type">protocol
type</dfn>.
</dt>
<dd>
The protocol type is either "Presentation" for presentation protocols
used with `navigator.credentials.get` or "Issuance" for issuance
protocols used with `navigator.credentials.create`.
</dd>
<dt>
<dfn data-dfn-for="registry" data-local-lt="description">Describe the
protocol</dfn>.
</dt>
<dd>
The description MUST be a brief summary of the protocol's purpose and
use case.
</dd>
<dt>
Provide a <dfn data-dfn-for="registry" data-local-lt="link">link to the
specification</dfn>.
</dt>
<dd>
The specification MUST be a stable URL that points to the authoritative
source for the protocol, including validation rules.
</dd>
</dl>
<p>
[=User agents=] MUST support the following [=digital credential/exchange
protocols=]:
</p>
<table class="data">
<caption>
Table of officially registered [=digital credential/exchange
protocols=].
</caption>
<thead>
<tr>
<th>
[=digital credential/Protocol identifier=]
</th>
<th>
[=registry/Type=]
</th>
<th>
[=registry/Description=]
</th>
<th>
[=registry/link|Specification=]
</th>
</tr>
</thead>
<tbody>
<tr>
<td colspan="4">
Coming soon...
</td>
</tr>
</tbody>
</table>
<section class="informative">
<!--
// MARK: Security Considerations
Expand Down Expand Up @@ -1359,8 +1176,7 @@ <h3>
The Digital Credentials API is designed to mediate requests for
digital credentials from websites, being agnostic to the credential
format and the information contained in it, as well as the protocol
used to exchange it (within the bounds on the protocol registry
inclusion criteria). This and other key design choices are derived
used to exchange it. This and other key design choices are derived
from the goal of providing a more secure and private credential
exchange experience for users than the existing alternatives (e.g.,
[[custom-schemes]]), that is still compatible with common exchange
Expand Down Expand Up @@ -1449,13 +1265,6 @@ <h3>
information are crucial to the [=user agent=]'s goal of protecting
user privacy.
</p>
<p>
The protocol registry for the Digital Credentials API is designed to
ensure that, among other requirements, supported protocols facilitate
specific privacy-enhancing capabilities. Protocols are required to
undergo privacy review by the W3C's <a href=
"https://www.w3.org/groups/wg/privacy/">Privacy Working Group</a>.
</p>
<h4>
Exchange Protocol Considerations for User Privacy
</h4>
Expand Down
Loading