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.

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

Write and update documentation for Account Recovery and ODIS #150

Merged
merged 51 commits into from
Apr 1, 2022

Conversation

nategraf
Copy link
Contributor

@nategraf nategraf commented Oct 21, 2021

In order to document the recent work on account recovery and ODIS, this PR includes new pages as well as updates to existing pages.

  • Create a new docs section for ODIS to highlight it as a flexible primitive with expanded use cases.
  • Add a page describing encrypted cloud backup
  • Add a page describing the key hardening use case for ODIS
  • Add pages describing the Domains API for ODIS and linking to the specification
  • Update the Valora accounts page to be more general and include more information
  • Update various other docs related to identity and account recovery
  • Remove the SUMMARY.md file which was used by GitBook but is no longer used.

Related issues

@netlify
Copy link

netlify bot commented Oct 21, 2021

Deploy Preview for celo-docs ready!

Name Link
🔨 Latest commit a8ef69a
🔍 Latest deploy log https://app.netlify.com/sites/celo-docs/deploys/6247735702f4080008cfd220
😎 Deploy Preview https://deploy-preview-150--celo-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

As of October 2021, ODIS operates with 7 signers and a threshold of 5 (i.e. $$m=7, k=5$$).
As a result, 5 of the 7 parties must cooperate in order to produce an output from the OPRF function, and as long as at least 3 are honest and secure, no unauthorized requests will be served.

<!-- TODO(victor): Once the new set is in production, information about the 7 operators should be included here -->
Copy link
Contributor

Choose a reason for hiding this comment

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

👍

Copy link
Contributor

@codyborn codyborn left a comment

Choose a reason for hiding this comment

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

Looks good 😎
Left some small comments

Copy link
Contributor Author

@nategraf nategraf left a comment

Choose a reason for hiding this comment

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

Thanks for the review @codyborn

This context information is used to decide what rate limit and/or authentication should be applied to the request, and is combined into the result to ensure output is unique to the context.

As an example, a Domain for hashing an account password might specify an application username of "vitalik.eth" (context) and a cap of 10 password attempts (rate-limiting parameter).
These would be combined with the user's password (blinded input) in the POPRF, which acts as a one-way function, to form the final output.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Addressed in 3d86ab1

@nategraf nategraf merged commit 31ca098 into main Apr 1, 2022
@therealharpaljadeja therealharpaljadeja deleted the victor/account-recovery-docs branch April 1, 2024 10:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

(Step 2) Create Docs for celo.docs.org (Docusaurus)
3 participants