forked from w3c/did-extensions
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
3209 lines (3042 loc) · 86 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html>
<head>
<title>
DID Specification Registries
</title>
<meta content='text/html; charset=utf-8' http-equiv='Content-Type'><!--
=== NOTA BENE ===
For the three scripts below, if your spec resides on dev.w3 you can check them
out in the same tree and use relative links so that they'll work offline.
-->
<script class='remove'
src='https://www.w3.org/Tools/respec/respec-w3c'>
</script><!--script src='./respec-w3c-common.js' class='remove'></script-->
<script class="remove" type="text/javascript">
var respecConfig = {
wgPublicList: "public-did-wg",
group: "did",
// specification status (e.g., WD, LCWD, NOTE, etc.). If in doubt use ED.
specStatus: "ED",
// the specification's short name, as in http://www.w3.org/TR/short-name/
shortName: "did-spec-registries",
edDraftURI: "https://w3c.github.io/did-spec-registries/",
// subtitle
subtitle: "The interoperability registry for Decentralized Identifiers",
// if you wish the publication date to be other than today, set this
//publishDate: "2019-11-07",
// if there is a previously published draft, uncomment this and set its YYYY-MM-DD date
// and its maturity status
// previousPublishDate: "1977-03-15",
// previousMaturity: "WD",
// extend the bibliography entries
github: {
repoURL: "https://github.com/w3c/did-spec-registries/",
branch: "master"
},
includePermalinks: false,
// editors, add as many as you like
// only "name" is required
editors: [{
name: "Orie Steele",
url: "https://www.linkedin.com/in/or13b/",
company: "Transmute",
companyURL: "https://www.transmute.industries/",
w3cid: 109171
}, {
name: "Manu Sporny",
url: "http://manu.sporny.org/",
company: "Digital Bazaar",
companyURL: "https://digitalbazaar.com/",
w3cid: 41758
}],
// authors, add as many as you like.
// This is optional, uncomment if you have authors as well as editors.
// only "name" is required. Same format as editors.
authors: [{
name: "Orie Steele",
url: "https://www.linkedin.com/in/or13b/",
company: "Transmute",
companyURL: "https://www.transmute.industries/",
w3cid: 109171
}, {
name: "Manu Sporny",
url: "http://manu.sporny.org/",
company: "Digital Bazaar",
companyURL: "https://digitalbazaar.com/",
w3cid: 41758
}
]
};
</script>
<style>
pre .highlight {
font-weight: bold;
color: green;
}
pre .comment {
color: SteelBlue;
-webkit-user-select: none;
-moz-user-select: none;
-ms-user-select: none;
user-select: none;
}
</style>
</head>
<body>
<section id='abstract'>
<p>
This document serves as an official registry for all known global parameters,
properties, and values used by the Decentralized Identifier ecosystem.
</p>
</section>
<section id='sotd'>
<p>
This registry is under active development and implementers are advised
against using the registry unless they are directly involved with the
W3C DID Working Group.
</p>
<p>
Comments regarding this document are welcome. Please file issues
directly on <a href="https://github.com/w3c/did-spec-registries/issues/">GitHub</a>,
or send them
to <a href="mailto:[email protected]">[email protected]</a> (
<a href="mailto:[email protected]?subject=subscribe">subscribe</a>,
<a href="https://lists.w3.org/Archives/Public/public-did-wg/">archives</a>).
</p>
<p>
Portions of the work on this specification have been funded by the
United States Department of Homeland Security's Science and Technology
Directorate under contracts HSHQDC-16-R00012-H-SB2016-1-002, 70RSAT20T00000010,
and HSHQDC-17-C-00019. The content of this specification does not
necessarily reflect the position or the policy of the U.S. Government
and no official endorsement should be inferred.
</p>
<p>
Work on this registry has also been supported by the Rebooting the
Web of Trust community facilitated by Christopher Allen, Shannon
Appelcline, Kiara Robles, Brian Weller, Betty Dhamers, Kaliya Young,
Kim Hamilton Duffy, Manu Sporny, Drummond Reed, Joe Andrieu, and
Heather Vescent, Dmitri Zagidulin, and Dan Burnett.
</p>
</section>
<section id="conformance"></section>
<section class="informative">
<h1>Introduction</h1>
<p>
This document serves as an official registry for all known global parameters,
properties, and values used by the Decentralized Identifier ecosystem.
</p>
</section>
<section>
<h1>The Registration Process</h1>
<p>
Software implementers might find that the existing Decentralized Identifier Core
specification [[DID-CORE]] is not entirely capable of addressing their use case
and might need to add a new parameters, properties, or values to this registry
in order to achieve their use case in a globally interoperable fashion. In order
to add a new parameter, property, or value to this registry, an implementer MUST
submit a modification request for this registry, as a GitHub Pull Request, where
the modification request adheres to the following rules:
</p>
<ol>
<li>
Any addition to the DID Core Registries MUST specify a human readable
description of the addition.
</li>
<li>
Any addition to the DID Core Registries MUST link, via at least a URL,
preferably a content-integrity protected one, to the defining specification so
that implementers can implement the property.
</li>
<li>
Any addition to the DID Core Registries that is a property or value, MUST
specify a machine readable JSON-LD Context for the addition.
<ul>
<li>
The JSON-LD Context MUST be included in full as part of the submission.
</li>
<li>
A namespace URI MUST be provided for the JSON-LD Context so that consumer
implementations can consistently map a URI to the full context.
</li>
<li>
The URI provided MUST be persistent, and link all terms to their associated
human readable descriptions.
</li>
<li>
The URI provided SHOULD resolve or link to the full context contents.
</li>
<li>
JSON-LD Contexts MUST be versioned and MUST NOT be date stamped.
</li>
<li>
JSON-LD Contexts SHOULD use scoped terms and MUST use the <code>@protected</code>
feature to eliminate the possibility of term conflicts.
</li>
</ul>
</li>
<li>
Properties in the DID Core Registries MUST NOT be removed, only deprecated.
</li>
<li>
Properties definitions in the DID Core Registries MUST include a Concise Data Definition Language (CDDL) [[RFC8610]] of the
Property and it's Abstract Data model structure.
</li>
</ol>
<p class="issue">
Should CDDL be used as the Data Definition Language to formalize the constraints of the CBOR and JSON representation of a DID document? (see <a href="https://github.com/w3c/did-spec-registries/issues/153">issue #153</a>).
</p>
<p>
Additions that do not meet these criteria MUST NOT be accepted. Entries that
are identified to cause interoperability problems MAY be marked as such
at the discretion of the maintainers of this registry, and if possible, after
consultation with the entry maintainer.
</p>
<p>
Any submission to the registries that meet all the criteria listed above will be
accepted for inclusion. These registries enumerate all known mechanisms that
meet a minimum bar, without choosing between them.
</p>
</section>
<section>
<h1>Properties</h1>
<p>
The following section defines the properties available for use in a DID
document. Note that some of these properties are defined in the
<a href="https://www.w3.org/TR/did-core">DID Core Specification</a>, and
others are defined elsewhere and may be method- or domain-specific. Please read
the associated specifications to ensure that the properties you use are
appropriate for your implementation. The properties are arranged here according
to the purpose they serve.
</p>
<p class="issue">
This registry is a work in progress and some properties are missing normative
definitions. We are working on this! This does NOT mean that in future it will
be possible to submit items to the registry without normative definitions (see <a href="#the-registration-process"></a>).
</p>
<p>
Concise Data Defition Lanuage (CDDL) provides a succint data defition for representing JSON and CBOR core representations of
a DID document as described in the <a href="https://www.w3.org/TR/did-core/#core-representations" target="_blank">DID Core Specification</a> and associated properties registered in this <a href="https://w3c.github.io/did-spec-registries/" target="_blank">DID Spec Registeries</a>.
The draft composite CDDL definition for the entire DID Document Specifation and associated
registeries can be found <a href="cddl/did-document.cddl" target="_blank">here</a>.
Additionally, each Property, Class and Type are described separately below and can be found below the `CDDL` column and apply to JSON and CBOR representations only.
</p>
<section>
<h3>Base properties</h3>
<p>
These properties are foundational to DID documents, and are expected to be
useful to all DID methods.
<section>
<h4>@context</h4>
<table class="simple" style="width: 100%;">
<thead>
<tr>
<th>Normative Definition</th>
<th>JSON-LD</th>
<th>CDDL</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="https://www.w3.org/TR/did-core/#production-0">DID Core</a>
</td>
<td>
<a href="https://www.w3.org/ns/did/v1">DID Core context</a>
</td>
<td>
</td>
</tr>
</tbody>
</table>
<p class="issue">
This is an active area of debate regarding if <code>@context</code> belongs as a base property in the
DID Core. See <a href="https://github.com/w3c/did-core/issues/432">issue
#283</a>.
</p>
<pre class="example" title="Example of @context property">
{
"@context": [
"https://www.w3.org/ns/did/v1",
"https://example.com/blockchain-identity/v1"
],
...
}
</pre>
</section>
<section>
<h4>id</h4>
<table class="simple" style="width: 100%;">
<thead>
<tr>
<th>Normative Definition</th>
<th>JSON-LD</th>
<th>CDDL</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="https://www.w3.org/TR/did-core/#did-subject">DID Core</a>
</td>
<td>
<a href="https://www.w3.org/ns/did/v1">DID Core context</a>
</td>
<td>
<a href="cddl/id.cddl" target="_blank">id.cddl</a>
</td>
</tr>
</tbody>
</table>
<pre class="example" title="Example of id property">
{
"id": "did:example:123",
...
}
</pre>
</section>
<section>
<h4>controller</h4>
<table class="simple" style="width: 100%;">
<thead>
<tr>
<th>Normative Definition</th>
<th>JSON-LD</th>
<th>CDDL</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="https://www.w3.org/TR/did-core/#authorization-and-delegation">DID Core</a>
</td>
<td>
<a href="https://www.w3.org/ns/did/v1">DID Core context</a>
</td>
<td>
<a href="cddl/controller.cddl" target="_blank">controller.cddl</a>
</td>
</tr>
</tbody>
</table>
<pre class="example" title="Example of controller property">
{
"controller": "did:example:123",
...
}
</pre>
</section>
<section>
<h4>verificationMethod</h4>
<table class="simple" style="width: 100%;">
<thead>
<tr>
<th>Normative Definition</th>
<th>JSON-LD</th>
<th>CDDL</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="https://www.w3.org/TR/did-core/#dfn-verification-method">DID Core Terminology</a> <span class="issue">(property definition pending)</span>
</td>
<td>
<a href="https://www.w3.org/ns/did/v1">DID Core context</a>
</td>
<td>
<a href="cddl/verificationMethod.cddl" target="_blank">verificationMethod.cddl</a>
</td>
</tr>
</tbody>
</table>
</section>
<section>
<h4>publicKey</h4>
<p class="issue">
This property may be replaced entirely by <code>verificationMethod</code> in
DID Core. See <a href="https://github.com/w3c/did-core/issues/283">issue
#283</a>.
</p>
<table class="simple" style="width: 100%;">
<thead>
<tr>
<th>Normative Definition</th>
<th>JSON-LD</th>
<th>CDDL</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="https://www.w3.org/TR/did-core/#dfn-publickey">DID Core</a>
</td>
<td>
<a href="https://www.w3.org/ns/did/v1">DID Core context</a>
</td>
<td>
<a href="cddl/publicKey.cddl" target="_blank">publicKey.cddl</a>
</td>
</tr>
</tbody>
</table>
<pre class="example" title="Example of publicKey property">
{
"id": "did:example:123",
"publicKey": [
{
"id": "did:example:123#ZC2jXTO6t4R501bfCXv3RxarZyUbdP2w_psLwMuY6ec",
"type": "Ed25519VerificationKey2018",
"controller": "did:example:123",
"publicKeyBase58": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV"
},
{
"id": "did:example:123#WjKgJV7VRw3hmgU6--4v15c0Aewbcvat1BsRFTIqa5Q",
"type": "EcdsaSecp256k1VerificationKey2019",
"controller": "did:example:123",
"publicKeyJwk": {
"crv": "secp256k1",
"x": "NtngWpJUr-rlNNbs0u-Aa8e16OwSJu6UiFf0Rdo1oJ4",
"y": "qN1jKupJlFsPFc1UkWinqljv4YE0mq_Ickwnjgasvmo",
"kty": "EC",
"kid": "WjKgJV7VRw3hmgU6--4v15c0Aewbcvat1BsRFTIqa5Q"
}
}
]
}
</pre>
</section>
<section>
<h4>service</h4>
<table class="simple" style="width: 100%;">
<thead>
<tr>
<th>Normative Definition</th>
<th>JSON-LD</th>
<th>CDDL</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="https://www.w3.org/TR/did-core/#service-endpoints">DID Core</a>
</td>
<td>
<a href="https://www.w3.org/ns/did/v1">DID Core context</a>
</td>
<td>
<a href="cddl/service.cddl" target="_blank">service.cddl</a>
</td>
</tr>
</tbody>
</table>
<pre class="example" title="Example of service and serviceEndpoint properties">
{
...
"service": [{
"id": "did:example:123#edv",
"type": "EncryptedDataVault",
"serviceEndpoint": "https://edv.example.com/"
}]
}
</pre>
</section>
</section>
<section>
<h3>Services</h3>
<p>
These terms are properties or types belonging to objects in the value of
<a href="#service"></a>.
</p>
<section>
<h4>serviceEndpoint</h4>
<table class="simple" style="width: 100%;">
<thead>
<tr>
<th>Normative Definition</th>
<th>JSON-LD</th>
<th>CDDL</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="https://www.w3.org/TR/did-core/#service-endpoints">DID Core</a>
</td>
<td>
<a href="https://www.w3.org/ns/did/v1">DID Core context</a>
</td>
<td>
<a href="cddl/serviceEndpoint.cddl" target="_blank">serviceEndpoint.cddl</a>
</td>
</tr>
</tbody>
</table>
<pre class="example" title="Example of service and serviceEndpoint properties">
{
...
"service": [{
"id": "did:example:123#edv",
"type": "EncryptedDataVault",
"serviceEndpoint": "https://edv.example.com/"
}]
}
</pre>
</section>
</section>
<section>
<h3>Verification relationships</h3>
<p>
A DID document expresses the relationship between the DID subject and a
verification method using a
<a href="https://w3c.github.io/did-core/#dfn-verification-relationship">
verification relationship</a>.
</p>
<section>
<h4>assertionMethod</h4>
<table class="simple" style="width: 100%;">
<thead>
<tr>
<th>Normative Definition</th>
<th>JSON-LD</th>
<th>CDDL</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="https://w3id.org/security/#assertionMethod">security-vocab</a>
</td>
<td>
<a href="https://www.w3.org/ns/did/v1">DID Core context</a>
</td>
<td>
<a href="cddl/assertionMethod.cddl" target="_blank">assertionMethod.cddl</a>
</td>
</tr>
</tbody>
</table>
<pre class="example" title="Example of assertionMethod property">
{
...
"publicKey": [{
"id": "did:example:123#WjKgJV7VRw3hmgU6--4v15c0Aewbcvat1BsRFTIqa5Q",
"type": "EcdsaSecp256k1VerificationKey2019",
"controller": "did:example:123",
"publicKeyJwk": {
"crv": "secp256k1",
"x": "NtngWpJUr-rlNNbs0u-Aa8e16OwSJu6UiFf0Rdo1oJ4",
"y": "qN1jKupJlFsPFc1UkWinqljv4YE0mq_Ickwnjgasvmo",
"kty": "EC",
"kid": "WjKgJV7VRw3hmgU6--4v15c0Aewbcvat1BsRFTIqa5Q"
}
}],
"assertionMethod": [{
"id": "did:example:123#z6MkpzW2izkFjNwMBwwvKqmELaQcH8t54QL5xmBdJg9Xh1y4",
"type": "Ed25519VerificationKey2018",
"controller": "did:example:123",
"publicKeyBase58": "BYEz8kVpPqSt5T7DeGoPVUrcTZcDeX5jGkGhUQBWmoBg"
},
"did:example:123#WjKgJV7VRw3hmgU6--4v15c0Aewbcvat1BsRFTIqa5Q"
]
}
</pre>
</section>
<section>
<h4>authentication</h4>
<table class="simple" style="width: 100%;">
<thead>
<tr>
<th>Normative Definition</th>
<th>JSON-LD</th>
<th>CDDL</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="https://www.w3.org/TR/did-core/#authentication">DID Core</a>
</td>
<td>
<a href="https://www.w3.org/ns/did/v1">DID Core context</a>
</td>
<td>
<a href="cddl/authentication.cddl" target="_blank">authentication.cddl</a>
</td>
</tr>
</tbody>
</table>
<pre class="example" title="Example of authentication property">
{
...
"publicKey": [{
"id": "did:example:123#WjKgJV7VRw3hmgU6--4v15c0Aewbcvat1BsRFTIqa5Q",
"type": "EcdsaSecp256k1VerificationKey2019",
"controller": "did:example:123",
"publicKeyJwk": {
"crv": "secp256k1",
"x": "NtngWpJUr-rlNNbs0u-Aa8e16OwSJu6UiFf0Rdo1oJ4",
"y": "qN1jKupJlFsPFc1UkWinqljv4YE0mq_Ickwnjgasvmo",
"kty": "EC",
"kid": "WjKgJV7VRw3hmgU6--4v15c0Aewbcvat1BsRFTIqa5Q"
}
}],
"authentication": [{
"id": "did:example:123#z6MkpzW2izkFjNwMBwwvKqmELaQcH8t54QL5xmBdJg9Xh1y4",
"type": "Ed25519VerificationKey2018",
"controller": "did:example:123",
"publicKeyBase58": "BYEz8kVpPqSt5T7DeGoPVUrcTZcDeX5jGkGhUQBWmoBg"
},
"did:example:123#WjKgJV7VRw3hmgU6--4v15c0Aewbcvat1BsRFTIqa5Q"
]
}
</pre>
</section>
<section>
<h4>capabilityDelegation</h4>
<table class="simple" style="width: 100%;">
<thead>
<tr>
<th>Normative Definition</th>
<th>JSON-LD</th>
<th>CDDL</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="https://w3id.org/security/#capabilityDelegation">security-vocab</a>
</td>
<td>
<a href="https://www.w3.org/ns/did/v1">DID Core context</a>
</td>
<td>
<a href="cddl/capabilityDelegation.cddl" target="_blank">capabilityDelegation.cddl</a>
</td>
</tr>
</tbody>
</table>
<pre class="example" title="Example of capabilityDelegation property">
{
...
"publicKey": [{
"id": "did:example:123#WjKgJV7VRw3hmgU6--4v15c0Aewbcvat1BsRFTIqa5Q",
"type": "EcdsaSecp256k1VerificationKey2019",
"controller": "did:example:123",
"publicKeyJwk": {
"crv": "secp256k1",
"x": "NtngWpJUr-rlNNbs0u-Aa8e16OwSJu6UiFf0Rdo1oJ4",
"y": "qN1jKupJlFsPFc1UkWinqljv4YE0mq_Ickwnjgasvmo",
"kty": "EC",
"kid": "WjKgJV7VRw3hmgU6--4v15c0Aewbcvat1BsRFTIqa5Q"
}
}],
"capabilityDelegation": [{
"id": "did:example:123#z6MkpzW2izkFjNwMBwwvKqmELaQcH8t54QL5xmBdJg9Xh1y4",
"type": "Ed25519VerificationKey2018",
"controller": "did:example:123",
"publicKeyBase58": "BYEz8kVpPqSt5T7DeGoPVUrcTZcDeX5jGkGhUQBWmoBg"
},
"did:example:123#WjKgJV7VRw3hmgU6--4v15c0Aewbcvat1BsRFTIqa5Q"
]
}
</pre>
</section>
<section>
<h4>capabilityInvocation</h4>
<table class="simple" style="width: 100%;">
<thead>
<tr>
<th>Normative Definition</th>
<th>JSON-LD</th>
<th>CDDL</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="https://w3id.org/security/#capabilityInvocation">security-vocab</a>
</td>
<td>
<a href="https://www.w3.org/ns/did/v1">DID Core context</a>
</td>
<td>
<a href="cddl/capabilityInvocation.cddl" target="_blank">capabilityInvocation.cddl</a>
</td>
</tr>
</tbody>
</table>
<pre class="example" title="Example of capabilityInvocation property">
{
...
"publicKey": [{
"id": "did:example:123#WjKgJV7VRw3hmgU6--4v15c0Aewbcvat1BsRFTIqa5Q",
"type": "EcdsaSecp256k1VerificationKey2019",
"controller": "did:example:123",
"publicKeyJwk": {
"crv": "secp256k1",
"x": "NtngWpJUr-rlNNbs0u-Aa8e16OwSJu6UiFf0Rdo1oJ4",
"y": "qN1jKupJlFsPFc1UkWinqljv4YE0mq_Ickwnjgasvmo",
"kty": "EC",
"kid": "WjKgJV7VRw3hmgU6--4v15c0Aewbcvat1BsRFTIqa5Q"
}
}],
"capabilityInvocation": [{
"id": "did:example:123#z6MkpzW2izkFjNwMBwwvKqmELaQcH8t54QL5xmBdJg9Xh1y4",
"type": "Ed25519VerificationKey2018",
"controller": "did:example:123",
"publicKeyBase58": "BYEz8kVpPqSt5T7DeGoPVUrcTZcDeX5jGkGhUQBWmoBg"
},
"did:example:123#WjKgJV7VRw3hmgU6--4v15c0Aewbcvat1BsRFTIqa5Q"
]
}
</pre>
</section>
<section>
<h4>keyAgreement</h4>
<table class="simple" style="width: 100%;">
<thead>
<tr>
<th>Normative Definition</th>
<th>JSON-LD</th>
<th>CDDL</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="https://w3id.org/security/#keyAgreement">security-vocab</a>
</td>
<td>
<a href="https://www.w3.org/ns/did/v1">DID Core context</a>
</td>
<td>
<a href="cddl/keyAgreement.cddl" target="_blank">keyAgreement.cddl</a>
</td>
</tr>
</tbody>
</table>
<pre class="example" title="Example of keyAgreement property">
{
...
"keyAgreement": [
{
"id": "did:example:123#zC9ByQ8aJs8vrNXyDhPHHNNMSHPcaSgNpjjsBYpMMjsTdS",
"type": "X25519KeyAgreementKey2019",
"controller": "did:example:123",
"publicKeyBase58": "9hFgmPVfmBZwRvFEyniQDBkz9LmV7gDEqytWyGZLmDXE"
}
]
}
</pre>
</section>
</section>
<section>
<h3>Verification method properties</h3>
<p>
These properties are for use on a verification method object, not on the DID document itself.
</p>
<section>
<h4>ethereumAddress</h4>
<table class="simple" style="width: 100%;">
<thead>
<tr>
<th>Normative Definition</th>
<th>JSON-LD</th>
<th>CDDL</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="https://identity.foundation/EcdsaSecp256k1RecoverySignature2020/#ethereumAddress">ESRS2020</a>
</td>
<td>
<a href="https://identity.foundation/EcdsaSecp256k1RecoverySignature2020/lds-ecdsa-secp256k1-recovery2020-0.0.jsonld">esrs2020</a>
</td>
<td>
<a href="cddl/ethereumAddress.cddl" target="_blank">ethereumAddress.cddl</a>
</td>
</tr>
</tbody>
</table>
<pre class="example" title="Example of ethereumAddress property">
{
"@context":[
"https://www.w3.org/ns/did/v1",
"https://identity.foundation/EcdsaSecp256k1RecoverySignature2020#"
],
"id":"did:example:123",
"publicKey":[{
"id": "did:example:123#vm-3",
"controller": "did:example:123",
"type": "EcdsaSecp256k1RecoveryMethod2020",
"ethereumAddress": "0xF3beAC30C498D9E26865F34fCAa57dBB935b0D74"
}]
}
</pre>
</section>
<section>
<h4>publicKeyHex</h4>
<table class="simple" style="width: 100%;">
<thead>
<tr>
<th>Normative Definition</th>
<th>JSON-LD</th>
<th>CDDL</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="https://w3id.org/security#publicKeyHex">PublicKeyHex</a>
</td>
<td>
<a href="https://w3id.org/security/v3-unstable">PublicKeyHex</a>
</td>
<td>
</td>
<td>
<a href="cddl/publicKeyHex.cddl" target="_blank">publicKeyHex.cddl</a>
</td>
</tr>
</tbody>
</table>
<pre class="example" title="Example of publicKeyHex property">
{
"@context":[
"https://www.w3.org/ns/did/v1",
"https://identity.foundation/EcdsaSecp256k1RecoverySignature2020#"
],
"id":"did:example:123",
"publicKey":[{
"id": "did:example:123#vm-2",
"controller": "did:example:123",
"type": "EcdsaSecp256k1RecoveryMethod2020",
"publicKeyHex": "027560af3387d375e3342a6968179ef3c6d04f5d33b2b611cf326d4708badd7770"
}]
}
</pre>
</section>
<section>
<h4>publicKeyJwk</h4>
<table class="simple" style="width: 100%;">
<thead>
<tr>
<th>Normative Definition</th>
<th>JSON-LD</th>
<th>CDDL</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<span class="issue">Normative definition pending</span>
</td>
<td>
<a href="https://www.w3.org/ns/did/v1">DID Core context</a>
</td>
<td>
<a href="cddl/publicKeyJwk.cddl" target="_blank">publicKeyJwk.cddl</a>
</td>
</tr>
</tbody>
</table>
<pre class="example" title="Example of publicKeyJwk property">
{
"id": "did:example:123#_Qq0UL2Fq651Q0Fjd6TvnYE-faHiOpRlPVQcY_-tA4A",
"type": "JsonWebKey2020",
"controller": "did:example:123",
"publicKeyJwk": {
"crv": "Ed25519",
"x": "VCpo2LMLhn6iWku8MKvSLg2ZAoC-nlOyPVQaO3FxVeQ",
"kty": "OKP",
"kid": "_Qq0UL2Fq651Q0Fjd6TvnYE-faHiOpRlPVQcY_-tA4A"
}
},
</pre>
</section>
<section>
<h4>publicKeyBase58</h4>
<table class="simple" style="width: 100%;">
<thead>
<tr>
<th>Normative Definition</th>
<th>JSON-LD</th>
<th>CDDL</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="https://w3id.org/security/#publicKeyBase58">security-vocab</a>
</td>
<td>
<a href="https://www.w3.org/ns/did/v1">DID Core context</a>
</td>
<td>
<a href="cddl/publicKeyBase58.cddl" target="_blank">publicKeyBase58.cddl</a>
</td>
</tr>
</tbody>
</table>
</section>
<section>
<h3>Verification method types</h3>
<p>
These are <em>classes</em> not a <em>properties</em> - in other words, use them
for the value of <code>type</code> in a verification method object.
</p>
<section>
<h4>JsonWebKey2020</h4>
<p class="issue">
<a href="https://github.com/w3c/did-core/issues/240">ISSUE 240 on DID Core</a>: The duplication and/or possible interaction of properties held in a JWK and a verification method are an active topic of discussion in the Working Group. Implementers are cautioned that the behavior of values associated with this property are not stable and might change in the future.
</p>
<table class="simple" style="width: 100%;">
<thead>
<tr>
<th>Normative Definition</th>
<th>JSON-LD</th>
<th>CDDL</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<span class="issue">Normative definition pending</span>
</td>
<td>
<a href="https://www.w3.org/ns/did/v1">DID Core context</a>
</td>
<td>
<a href="cddl/verificationMethodTypes.cddl" target="_blank">verificationMethodTypes.cddl</a>
</td>
</tr>
</tbody>
</table>
<pre class="example" title="Example of JsonWebKey2020 class">
{
"id": "did:example:123#_TKzHv2jFIyvdTGF1Dsgwngfdg3SH6TpDv0Ta1aOEkw",
"type": "JsonWebKey2020",
"controller": "did:example:123",