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.

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

Add initial spec #57

Merged
merged 26 commits into from
Feb 3, 2024
Merged

Add initial spec #57

Show file tree
Hide file tree
Changes from 25 commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
ba926b3
Add initial spec
marcoscaceres Jan 24, 2024
9a9d3c7
Update index.html
marcoscaceres Jan 25, 2024
162129b
Update index.html
marcoscaceres Jan 25, 2024
68db42b
Fix driver's license globally
marcoscaceres Jan 25, 2024
a67821a
Update index.html
marcoscaceres Jan 25, 2024
cdd1a7e
Update index.html
marcoscaceres Jan 25, 2024
75f8df0
More review feedback
marcoscaceres Jan 25, 2024
2d71181
Add issue links
marcoscaceres Jan 25, 2024
fbe4aca
Remove API from title
marcoscaceres Jan 25, 2024
d7cea1d
fix typo
marcoscaceres Jan 25, 2024
f341cd0
remove use of the word mobile
marcoscaceres Jan 25, 2024
e1f8ca4
tidy
marcoscaceres Jan 25, 2024
36fd3f2
line length
marcoscaceres Jan 25, 2024
108835e
Remove publicKey for now
marcoscaceres Jan 26, 2024
ca22e32
move args to same line for requestIdentity
marcoscaceres Jan 26, 2024
374f16f
Introduce navigator.identity instead
marcoscaceres Feb 2, 2024
5707747
Apply suggestions from code review
marcoscaceres Feb 2, 2024
eb83d00
Apply suggestions from code review
marcoscaceres Feb 2, 2024
00e8fce
Update index.html
marcoscaceres Feb 2, 2024
a4983d1
Small fixes
marcoscaceres Feb 2, 2024
47f6576
Apply suggestions from code review
marcoscaceres Feb 3, 2024
5403d14
Update index.html
marcoscaceres Feb 3, 2024
a07ba87
Update index.html
marcoscaceres Feb 3, 2024
1993c6c
Update index.html
marcoscaceres Feb 3, 2024
b9ad3ad
tidy + xref fix
marcoscaceres Feb 3, 2024
06d9a61
Update index.html
marcoscaceres Feb 3, 2024
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
310 changes: 310 additions & 0 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,310 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>
Digital Identities
samuelgoto marked this conversation as resolved.
Show resolved Hide resolved
samuelgoto marked this conversation as resolved.
Show resolved Hide resolved
</title>
<script src="https://www.w3.org/Tools/respec/respec-w3c" class=
"remove"></script>
<script class="remove">
"use strict";
// See https://github.com/w3c/respec/wiki/ for how to configure ReSpec
var respecConfig = {
github: "WICG/digital-credentials",
marcoscaceres marked this conversation as resolved.
Show resolved Hide resolved
editors: [
{
name: "Marcos Caceres",
email: "marcosc@apple.com",
company: "Apple Inc.",
companyURL: "https://apple.com",
},
{
name: "Sam Goto",
email: "goto@google.com",
company: "Google Inc.",
companyURL: "https://google.com",
},
// Add additional editors here.
marcoscaceres marked this conversation as resolved.
Show resolved Hide resolved
// https://github.com/w3c/respec/wiki/editors
],
shortName: "digital-identity",
specStatus: "CG-DRAFT",
group: "wicg",
localBiblio: {
},
xref: {
profile: "web-platform",
},
};
</script>
</head>
<body data-cite="credential-management-1">
<section id="abstract">
<p>
This document specifies an API to allow user agents to mediate access
to, and representing, a verifiably-issued digital identity (e.g. a
government issued digital driver's license, a passport issued by a
country, a student card or diploma issued by a university, an employee
card issued by a company, a passenger's boarding pass issued by an
airline, a profile issued by an online social network, membership
cards, vaccination records, etc) license). The API builds on
[[[credential-management-1]]] as a means to request a digital identity
from the user agent or underlying platform.
</p>
</section>
samuelgoto marked this conversation as resolved.
Show resolved Hide resolved
<section id="sotd">
<p>
This is an unofficial proposal.
</p>
</section>
<h2>
Introduction
</h2>
<p>
TBW
</p>
<h2>
Model
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are operating at the browser level, so our definition of "Credential" (in the Credential Manager sense) is different than other group's definition of "Credential", but there are many other concepts that I think are well articulated by the ISO and Verifiable Credentials community.

Here is one example of a data model that I think has a lot of good definitions.

I'm wondering if we are going to get held back agreeing on these definitions, and if we are better off just having the WebIDLs in this initial PR to unblock implementation ... WDYT?

Happy to go either way, but my intuition is that the WebIDL without the definitions more minimally viable.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's run with this for now but let's definitely start taking definitions/concepts from other specs if we can. However, we should control whatever we feel strongly fall squarely in the purview of our spec.

</h2>
<dl class="definitions" data-sort="">
<dt>
<dfn>Identity credential</dfn>
samuelgoto marked this conversation as resolved.
Show resolved Hide resolved
</dt>
<dd>
<p>
A specialized type of [=credential=] corresponding to the real-world
identity of a person enabling a <a data-cite=
"vc-data-model-2.0#dfn-verifier">verifier</a> to make authentication
decisions based on identity statements verifiably made by an
[=issuer=].
</p>
<aside class="Note">
[=Credentials=] that are classified as [=identity credentials=]
always inherit from the {{Identity}} interface.
</aside>
</dd>
<dt>
<dfn data-local-lt="digital identities">Digital identity</dfn>
</dt>
<dd>
<p>
A digital representation of an [=identity credential=], such as a
digital driver's license or passport, embodying verifiable claims
about an individual's identity. Issued by a trusted [=digital
identity/issuer=], it enables authenticated interactions.
</p>
<aside class="note">
[=Digital identities=] are represented as instances of the
{{DigitalIdentity}} interface.
</aside>
</dd>
<dt>
<dfn>Identity credential provider</dfn>
</dt>
<dd>
An application or service that provides a user interface for selecting
and/or querying a [=digital identity=], such as a digital wallet that
manages various identity documents and credentials.
</dd>
<dt>
<dfn data-for="digital identity">Request protocol</dfn>
</dt>
<dd>
A standardized format for requesting a [=digital identity=], designed
to ensure the secure, private, and interoperable exchange of identity
information. See section [[[#protocol-registry]]].
</dd>
<dt>
<dfn data-for="Digital identity">Issuer</dfn>
</dt>
<dd>
The entity that issues a [=digital identity=], such as a government
agency or certified organizations.
</dd>
</dl>
<h2>
Scope
</h2>
<p>
The following items are within the scope of this specification:
</p>
<ul>
<li>Requesting a [=digital identity=], including mechanisms for secure
presentation.
</li>
</ul>
<p>
The following items are out of scope:
</p>
<ul>
<li>Issuance process for establishing a [=digital identity=].
</li>
<li>UI/UX considerations, with the exception of privacy considerations,
which are addressed to ensure the protection of user data during the
request process.
</li>
</ul>
<h2>
Extensions to the `Navigator` interface
</h2>
<pre class="idl">
partial interface Navigator {
[SecureContext, SameObject] readonly attribute CredentialsContainer identity;
};
</pre>
<h3>
The `identity` attribute
</h3>
<p data-dfn-for="Navigator">
The <dfn>identity</dfn> attribute provides access to the the underlying
{{CredentialsContainer}} for managing [=identity credentials=].
</p>
<h3>
Extensions to Credential Management API
</h3>
<aside class="issue" data-number="65"></aside>
<h2>
Extensions to `CredentialRequestOptions` dictionary
</h2>
<pre class="idl">
partial dictionary CredentialRequestOptions {
sequence&lt;IdentityRequestProvider&gt; providers;
samuelgoto marked this conversation as resolved.
Show resolved Hide resolved
};
</pre>
<h3>
The `providers` member
</h3>
<p>
The <dfn data-dfn-for="CredentialRequestOptions">providers</dfn> member
is a sequence of [=digital identity/request protocol=] that can
potentially be handled by a user's selected [=identity credential
provider=].
</p>
<h2>
The `IdentityRequestProvider` dictionary
</h2>
<p>
The {{IdentityRequestProvider}} dictionary is used to specify a [=digital
identity/request protocol=] and structured request, which the user agent
MAY match against a [=identity credential provider=].
</p>
<pre class="idl">
dictionary IdentityRequestProvider {
required DOMString protocol;
required DOMString request;
};
</pre>
<h3>
The `protocol` member
</h3>
<p>
The <dfn data-dfn-for="IdentityRequestProvider">protocol</dfn> member
denotes the [=digital identity/request protocol=] when requesting an
identify credential.
</p>
<p>
The {{IdentityRequestProvider/protocol}} member's value is be one of the
well-defined keys defined in [[[#protocol-registry]]] or any other custom
one.
</p>
<h3>
The `request` member
</h3>
<p>
The <dfn data-dfn-for="IdentityRequestProvider">request</dfn> member is
the request to be handled by the user's selected [=identity credential
provider=].
</p>
<h2>
The `Identity` interface
</h2>
<p>
The <dfn>Identity</dfn> interface is used in the API to represent
[=credentials=] that are classified as an [=identity credential=].
</p>
<pre class="idl">
[Exposed=Window]
interface Identity : Credential {
// Future things...
};
</pre>
<h2>
The `DigitalIdentity` interface
</h2>
<p>
The <dfn>DigitalIdentity</dfn> interface represents a [=digital
identity=].
</p>
<pre class="idl">
[Exposed=Window, SecureContext]
interface DigitalIdentity : Identity {
readonly attribute DOMString protocol;
readonly attribute ArrayBuffer data;
marcoscaceres marked this conversation as resolved.
Show resolved Hide resolved
};
</pre>
<h3>
The `protocol` member
</h3>
<p>
The <dfn data-dfn-for="DigitalIdentity">protocol</dfn> member is the
[=digital identity/request protocol=] that was used to request the
[=identity credential=].
</p>
<h3>
The `data` member
</h3>
<p>
The <dfn data-dfn-for="DigitalIdentity">data</dfn> member is the
credential's encrypted data.
</p>
<h2 id="protocol-registry">
Registry of protocols for requesting digital identity
</h2>
<p>
The following is the registry of [=digital identity/request 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>
<h3>
Inclusion criteria
</h3>
<p>
To be included in the registry...
</p>
<aside class="issue" data-number="58"></aside>
<p>
[=User agents=] MUST support the following [=digital identity/request
protocols=]:
</p>
<table class="data">
<caption>
Table of officially registered [=digital identity/request protocols=].
</caption>
<thead>
<tr>
<th>
Protocol identifier
</th>
<th>
Description
</th>
<th>
Specification
</th>
</tr>
</thead>
<tbody>
<tr>
<td colspan="3">
Coming soon...
</td>
</tr>
</tbody>
</table>
<section id="conformance"></section>
</body>
</html>
6 changes: 6 additions & 0 deletions tidyconfig.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
char-encoding: utf8
indent: yes
indent-spaces: 2
wrap: 80
tidy-mark: no
custom-tags: yes