DID Method Onion Specification
part of the torgap technology family
This specification describes a W3C DID Method related to Tor Hidden Services.
The web-hosted version of the spec itself is at: https://blockchaincommons.github.io/did-method-onion/
The spec text can be edited as PRs to the html at: https://github.com/BlockchainCommons/did-method-onion/blob/main/index.html.
This spec text supports conversion that leverages the W3C CCG Respec template's javascript, though that feature is currently turned off in this release as we have not yet submitted this spec to the W3C Credentials Community Group (CCG), nor have they accepted it as a work item.
Additional Information
did-oniondiscussion in the Airgapped Wallet Community- W3C Credentials Community Group public group email archive
Goals
Our medium-term goal is to submit this specification to the W3C Credentials Community Group. However, we want to incubate it more at Blockchain Commons first.
The addition of this did:onion spec has been proposed to the DID Method Registry in PR 163 but we are required to finish the "Security and Privacy Considerations" section.
In particular, we'd like to review more with our community how close we want to keep did:onion to did:web, and if we want to incorporate some elements of did:peer or KERI or to leverage services like Open Time Stamps.
Contributions
We encourage public contributions through issues and pull requests! Please review CONTRIBUTING.md for details on our development process. All contributions to this repository need a GPG signed Contributor License Agreement. This signature is required as it will allow us to move this spec to be under W3C community Contributor License Agreement later.
While we prefer the creation of Issues and Pull Requests about this spec in this GitHub repository, discussions often occur in the public Airgapped Wallet Community as well.
Status - Experimental and Early Provisional
DID Method Onion Specification is currently under active development and in the early experimental phase. It should not be used for production tasks until it has had further testing and auditing.
Origin, Authors, Copyright & Licenses
Unless otherwise noted (either in this /README.md or in the file's header comments) the contents of this repository are Copyright © 2020 by Blockchain Commons, LLC, and are licensed under the spdx:BSD-2-Clause Plus Patent License.
In most cases, the authors, copyright, and license for each file reside in header comments in the source code. When it does not, we have attempted to attribute it accurately in the table below.
Derived from…
DID Method Onion Specification is either derived from or was inspired by:
Used with…
These are other projects that work with or leverage DID Method Onion Specification:
- Tor — The Tor Project
- DID W3C Working Draft — The W3C Draft, by Drummond Reed (Evernym), Manu Sporny (Digital Bazaar), Markus Sabadello (Danube Tech), Dave Longley (Digital Bazaar), Christopher Allen (Blockchain Commons), Ryan Grant, and Jonathan Holt, DO, MS (ConsenSys Health)
Financial Support
DID Method Onion Specification is a project of Blockchain Commons. We are proudly a "not-for-profit" social benefit corporation committed to open source & open development. Our work is funded entirely by donations and collaborative partnerships with people like you. Every contribution will be spent on building open tools, technologies, and techniques that sustain and advance blockchain and internet security infrastructure and promote an open web.
To financially support further development of DID Method Onion Specification and other projects, please consider becoming a Patron of Blockchain Commons through ongoing monthly patronage as a GitHub Sponsor. You can also support Blockchain Commons with bitcoins at our BTCPay Server.
Contributing
We encourage public contributions through issues and pull requests! Please review CONTRIBUTING.md for details on our development process. All contributions to this repository require a GPG signed Contributor License Agreement.
Discussions
The best place to talk about Blockchain Commons and its projects is in our GitHub Discussions areas.
Gordian System Discussions. For users and developers of the Gordian system, including the Gordian Server, Bitcoin Standup technology, QuickConnect, and the Gordian Wallet. If you want to talk about our linked full-node and wallet technology, suggest new additions to our Bitcoin Standup standards, or discuss the implementation our standalone wallet, the Discussions area of the main Gordian repo is the place.
Wallet Standard Discussions. For standards and open-source developers who want to talk about wallet standards, please use the Discussions area of the Airgapped Signing repo. This is where you can talk about projects like our LetheKit and command line tools such as seedtool, both of which are intended to testbed wallet technologies, plus the libraries that we've built to support your own deployment of wallet technology such as bc-bip39, bc-slip39, bc-shamir, Shamir Secret Key Recovery, bc-ur, and the bc-crypto-base. If it's a wallet-focused technology or a more general discussion of wallet standards,discuss it here.
Blockchain Commons Discussions. For developers, interns, and patrons of Blockchain Commons, please use the discussions area of the Community repo to talk about general Blockchain Commons issues, the intern program, or topics other than the Gordian System or the wallet standards, each of which have their own discussion areas.
Other Questions & Problems
As an open-source, open-development community, Blockchain Commons does not have the resources to provide direct support of our projects. Please consider the discussions area as a locale where you might get answers to questions. Alternatively, please use this repository's issues feature. Unfortunately, we can not make any promises on response time.
If your company requires support to use our projects, please feel free to contact us directly about options. We may be able to offer you a contract for support from one of our contributors, or we might be able to point you to another entity who can offer the contractual support that you need.
Credits
The following people directly contributed to this repository. You can add your name here by getting involved. The first step is learning how to contribute from our CONTRIBUTING.md documentation.
| Name | Role | Github | GPG Fingerprint | |
|---|---|---|---|---|
| Christopher Allen | Principal Architect | @ChristopherA | \ChristopherA@LifeWithAlacrity.com\ | FDFE 14A5 4ECB 30FC 5D22 74EF F8D3 6C91 3574 05ED |
| Orie Steele | Developer | @OR13 | \orie@transmute.industries\ | 3BCA C9A8 82DE FE70 3FD5 2079 E9CB 06E7 1794 A713 |
Responsible Disclosure
We want to keep all of our software safe for everyone. If you have discovered a security vulnerability, we appreciate your help in disclosing it to us in a responsible manner. We are unfortunately not able to offer bug bounties at this time.
We do ask that you offer us good faith and use best efforts not to leak information or harm any user, their data, or our developer community. Please give us a reasonable amount of time to fix the issue before you publish it. Do not defraud our users or us in the process of discovery. We promise not to bring legal action against researchers who point out a problem provided they do their best to follow the these guidelines.
Reporting a Vulnerability
Please report suspected security vulnerabilities in private via email to ChristopherA@BlockchainCommons.com (do not use this email for support). Please do NOT create publicly viewable issues for suspected security vulnerabilities.
The following keys may be used to communicate sensitive information to developers:
| Name | Fingerprint |
|---|---|
| Christopher Allen | FDFE 14A5 4ECB 30FC 5D22 74EF F8D3 6C91 3574 05ED |
You can import a key by running the following command with that individual’s fingerprint: gpg --recv-keys "<fingerprint>" Ensure that you put quotes around fingerprints that contain spaces.