Various minor but long-overdue updates to existing documentation #974
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
thehenrytsai
requested review from
OR13,
tplooker and
troyronda
as code owners
kdenhartog
reviewed
Dec 9, 2020
| ## Sidetree Client Guidelines | ||
| A Sidetree client manages the private keys and performs document operations on behalf of the DID owner. The Sidetree client needs to comply to the following guidelines to keep the DIDs it manages secure. | ||
|
|
||
| 1. The client MUST keep the operation payload once it is submitted to a Sidetree node until it is generally available and observed. If the submitted operation is not observed, the same operation payload MUST be resubmitted. Submitting a different operation payload would put the DID in risk of a _late publish_ attack which can lead to an unrecoverable DID if the original operation payload contains a recovery key rotation and the recovery key is lost. |
There was a problem hiding this comment.
Is this something that should go in the spec rather than the design docs of the reference implementation?
There was a problem hiding this comment.
@kdenhartog, yes I've been wanting to deprecate this section and only reason I haven't is because the content has yet to be moved/replicated across to the main spec. Let me file a doc bug explicitly to track this.
There was a problem hiding this comment.
Issue #975 filed.
isaacJChen
approved these changes
Dec 9, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.