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

Jump to bottom

Add "rotateDidFrom" and "rotateDidTo" to support DID Rotation #32

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add "rotateDidFrom" and "rotateDidTo" to support DID Rotation #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
40dac4e
Add "rotateDidFrom" and "rotateDidTo"
peacekeeper Jan 23, 2024
071767e
Fix bug in example, found by @fabianekc during ID WG call on 29th Jan…
peacekeeper Jan 29, 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
75 changes: 74 additions & 1 deletion index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1060,6 +1060,63 @@ <h3 id="diddocumentoperationdeactivate"><a class="toc-anchor" href="#diddocument
</code></pre>
<p>In the above example, a client instructs a DID Registrar to first remove a verification method from a DID document,
and then deactivate the DID.</p>
<h3 id="diddocumentoperationrotatedidfrom"><a class="toc-anchor" href="#diddocumentoperationrotatedidfrom" >§</a> <code>didDocumentOperation=&quot;rotateDidFrom&quot;</code></h3>
<p>DID Rotation is the process of changing a DID from an original DID to a new DID. To complete a DID Rotation process,
both the original DID and the DID have to be updated, as documented in <a href="#ref:DID-ROTATION" >[DID-ROTATION]</a>.</p>
<p>This section defines the value <code>rotateDidFrom</code> for the <a href="#diddocumentoperation" ><code>didDocumentOperation</code> input field</a>.
This instructs the DID Registrar to update the original DID of a DID Rotation process. This operation also requires
the presence of a <code>newDid</code> option in the <a href="#options" ><code>options</code> input field</a> to indicate the new DID.</p>
<p>Example:</p>
<pre class="language-json"><code class="language-json"><span class="token punctuation">{</span>
<span class="token property">"did"</span><span class="token operator">:</span> <span class="token string">"did:example:123"</span><span class="token punctuation">,</span>
<span class="token property">"options"</span><span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token property">"newDid"</span><span class="token operator">:</span> <span class="token string">"did:example:789"</span>
<span class="token punctuation">}</span><span class="token punctuation">,</span>
<span class="token property">"secret"</span><span class="token operator">:</span> <span class="token punctuation">{</span> ... <span class="token punctuation">}</span><span class="token punctuation">,</span>
<span class="token property">"didDocumentOperation"</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token string">"rotateDidFrom"</span><span class="token punctuation">]</span><span class="token punctuation">,</span>
<span class="token property">"didDocument"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token null keyword">null</span> <span class="token punctuation">]</span>
<span class="token punctuation">}</span>
</code></pre>
<p>The above example is functionally equivalent to the following operation:</p>
<pre class="language-json"><code class="language-json"><span class="token punctuation">{</span>
<span class="token property">"did"</span><span class="token operator">:</span> <span class="token string">"did:example:123"</span><span class="token punctuation">,</span>
<span class="token property">"options"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token punctuation">}</span><span class="token punctuation">,</span>
<span class="token property">"secret"</span><span class="token operator">:</span> <span class="token punctuation">{</span> ... <span class="token punctuation">}</span><span class="token punctuation">,</span>
<span class="token property">"didDocumentOperation"</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token string">"addToDidDocument"</span><span class="token punctuation">,</span> <span class="token string">"deactivate"</span><span class="token punctuation">]</span><span class="token punctuation">,</span>
<span class="token property">"didDocument"</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token punctuation">{</span>
<span class="token property">"alsoKnownAs"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token string">"did:example:789"</span> <span class="token punctuation">]</span>
<span class="token punctuation">}</span><span class="token punctuation">,</span>
<span class="token null keyword">null</span><span class="token punctuation">]</span>
<span class="token punctuation">}</span>
</code></pre>
<h3 id="diddocumentoperationrotatedidto"><a class="toc-anchor" href="#diddocumentoperationrotatedidto" >§</a> <code>didDocumentOperation=&quot;rotateDidTo&quot;</code></h3>
<p>DID Rotation is the process of changing a DID from an original DID to a new DID. To complete a DID Rotation process,
both the original DID and the new DID have to be updated, as documented in <a href="#ref:DID-ROTATION" >[DID-ROTATION]</a>.</p>
<p>This section defines the value <code>rotateDidTo</code> for the <a href="#diddocumentoperation" ><code>didDocumentOperation</code> input field</a>.
This instructs the DID Registrar to update the new DID of a DID Rotation process. This operation also requires
the presence of an <code>originalDid</code> option in the <a href="#options" ><code>options</code> input field</a> to indicate the original DID.</p>
<p>Example:</p>
<pre class="language-json"><code class="language-json"><span class="token punctuation">{</span>
<span class="token property">"did"</span><span class="token operator">:</span> <span class="token string">"did:example:789"</span><span class="token punctuation">,</span>
<span class="token property">"options"</span><span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token property">"originalDid"</span><span class="token operator">:</span> <span class="token string">"did:example:123"</span>
<span class="token punctuation">}</span><span class="token punctuation">,</span>
<span class="token property">"secret"</span><span class="token operator">:</span> <span class="token punctuation">{</span> ... <span class="token punctuation">}</span><span class="token punctuation">,</span>
<span class="token property">"didDocumentOperation"</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token string">"rotateDidTo"</span><span class="token punctuation">]</span><span class="token punctuation">,</span>
<span class="token property">"didDocument"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token null keyword">null</span> <span class="token punctuation">]</span>
<span class="token punctuation">}</span>
</code></pre>
<p>The above example is functionally equivalent to the following operation:</p>
<pre class="language-json"><code class="language-json"><span class="token punctuation">{</span>
<span class="token property">"did"</span><span class="token operator">:</span> <span class="token string">"did:example:789"</span><span class="token punctuation">,</span>
<span class="token property">"options"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token punctuation">}</span><span class="token punctuation">,</span>
<span class="token property">"secret"</span><span class="token operator">:</span> <span class="token punctuation">{</span> ... <span class="token punctuation">}</span><span class="token punctuation">,</span>
<span class="token property">"didDocumentOperation"</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token string">"addToDidDocument"</span><span class="token punctuation">]</span><span class="token punctuation">,</span>
<span class="token property">"didDocument"</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token punctuation">{</span>
<span class="token property">"alsoKnownAs"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token string">"did:example:123"</span> <span class="token punctuation">]</span>
<span class="token punctuation">}</span><span class="token punctuation">]</span>
<span class="token punctuation">}</span>
</code></pre>
<h2 id="architecture-considerations"><a class="toc-anchor" href="#architecture-considerations" >§</a> Architecture Considerations</h2>
<p>In order to implement a library or tool that supports the above interfaces for
creating, updating, and deactivating DIDs in a method-agnostic way, we can imagine
Expand Down Expand Up @@ -1108,7 +1165,8 @@ <h2 id="https-binding"><a class="toc-anchor" href="#https-binding" >§</a> HTTPS
<li><strong>500</strong>, if an internal error has occurred.</li>
</ul>
<p>See <a href="https://github.com/decentralized-identity/universal-registrar/blob/main/swagger/api.yml">here</a> for an OpenAPI definition.</p>
<h2 id="normative-references"><a class="toc-anchor" href="#normative-references" >§</a> Normative References</h2>
<h2 id="references"><a class="toc-anchor" href="#references" >§</a> References</h2>
<h3 id="normative-references"><a class="toc-anchor" href="#normative-references" >§</a> Normative References</h3>
<p>
<dl class="reference-list">
<dt id="ref:DID-CORE">DID-CORE</dt>
Expand Down Expand Up @@ -1137,6 +1195,14 @@ <h2 id="normative-references"><a class="toc-anchor" href="#normative-references"

</dl>
</p>
<h3 id="informative-references"><a class="toc-anchor" href="#informative-references" >§</a> Informative References</h3>
<dl>
<dt id="ref:DID-ROTATION">DID-ROTATION</dt>
<dd>
<cite><a href="https://www.ownyourdata.eu/en/did-rotation/">DID Rotation</a></cite>.
OwnYourData. <span class="reference-status">Status: Blog post.</span>
</dd>
</dl>
<h2 id="acknowledgements"><a class="toc-anchor" href="#acknowledgements" >§</a> Acknowledgements</h2>
<img align="left" src="images/logo-ngitrustchain.png" width="115">
<p>Supported by <a path-0="trustchain.ngi.eu"path-1=""href="https://trustchain.ngi.eu/" >NGI TRUSTCHAIN</a>, which is made possible with financial support from the European Commission’s <a path-0="ngi.eu"path-1=""href="https://ngi.eu/" >Next Generation Internet</a> programme.</p>
Expand Down Expand Up @@ -1254,11 +1320,18 @@ <h3 id="other-resources"><a class="toc-anchor" href="#other-resources" >§</a> O
<ul>
<li><a href="#optionsrequestverificationmethod" ><code>options.requestVerificationMethod</code></a></li>
<li><a href="#diddocumentoperationdeactivate" ><code>didDocumentOperation=&quot;deactivate&quot;</code></a></li>
<li><a href="#diddocumentoperationrotatedidfrom" ><code>didDocumentOperation=&quot;rotateDidFrom&quot;</code></a></li>
<li><a href="#diddocumentoperationrotatedidto" ><code>didDocumentOperation=&quot;rotateDidTo&quot;</code></a></li>
</ul>
</li>
<li><a href="#architecture-considerations" >Architecture Considerations</a></li>
<li><a href="#https-binding" >HTTPS Binding</a></li>
<li><a href="#references" >References</a>
<ul>
<li><a href="#normative-references" >Normative References</a></li>
<li><a href="#informative-references" >Informative References</a></li>
</ul>
</li>
<li><a href="#acknowledgements" >Acknowledgements</a></li>
<li><a href="#appendix" >Appendix</a>
<ul>
Expand Down
89 changes: 88 additions & 1 deletion spec/spec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1238,6 +1238,81 @@ Example:
In the above example, a client instructs a DID Registrar to first remove a verification method from a DID document,
and then deactivate the DID.

### `didDocumentOperation="rotateDidFrom"`

DID Rotation is the process of changing a DID from an original DID to a new DID. To complete a DID Rotation process,
both the original DID and the DID have to be updated, as documented in [[DID-ROTATION]](#ref:DID-ROTATION).

This section defines the value `rotateDidFrom` for the [`didDocumentOperation` input field](#diddocumentoperation).
This instructs the DID Registrar to update the original DID of a DID Rotation process. This operation also requires
the presence of a `newDid` option in the [`options` input field](#options) to indicate the new DID.

Example:

```json
{
"did": "did:example:123",
"options": {
"newDid": "did:example:789"
},
"secret": { ... },
"didDocumentOperation": ["rotateDidFrom"],
"didDocument": [ null ]
}
```

The above example is functionally equivalent to the following operation:

```json
{
"did": "did:example:123",
"options": { },
"secret": { ... },
"didDocumentOperation": ["addToDidDocument", "deactivate"],
"didDocument": [{
"alsoKnownAs": [ "did:example:789" ]
},
null]
}
```

### `didDocumentOperation="rotateDidTo"`

DID Rotation is the process of changing a DID from an original DID to a new DID. To complete a DID Rotation process,
both the original DID and the new DID have to be updated, as documented in [[DID-ROTATION]](#ref:DID-ROTATION).

This section defines the value `rotateDidTo` for the [`didDocumentOperation` input field](#diddocumentoperation).
This instructs the DID Registrar to update the new DID of a DID Rotation process. This operation also requires
the presence of an `originalDid` option in the [`options` input field](#options) to indicate the original DID.

Example:

```json
{
"did": "did:example:789",
"options": {
"originalDid": "did:example:123"
},
"secret": { ... },
"didDocumentOperation": ["rotateDidTo"],
"didDocument": [ null ]
}
```

The above example is functionally equivalent to the following operation:

```json
{
"did": "did:example:789",
"options": { },
"secret": { ... },
"didDocumentOperation": ["addToDidDocument"],
"didDocument": [{
"alsoKnownAs": [ "did:example:123" ]
}]
}
```

## Architecture Considerations

In order to implement a library or tool that supports the above interfaces for
Expand Down Expand Up @@ -1295,10 +1370,22 @@ The following HTTP status codes are used for the [`deactivate()` function](#deac

See <a href="https://github.com/decentralized-identity/universal-registrar/blob/main/swagger/api.yml">here</a> for an OpenAPI definition.

## Normative References
## References

### Normative References

[[spec]]

### Informative References

<dl>
<dt id="ref:DID-ROTATION">DID-ROTATION</dt>
<dd>
<cite><a href="https://www.ownyourdata.eu/en/did-rotation/">DID Rotation</a></cite>.
OwnYourData. <span class="reference-status">Status: Blog post.</span>
</dd>
</dl>

## Acknowledgements

<img align="left" src="images/logo-ngitrustchain.png" width="115">
Expand Down