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

Add README for context directory. #91

Closed
wants to merge 2 commits into from
Closed

Conversation

msporny
Copy link
Member

@msporny msporny commented Oct 29, 2019

Migrated PR from w3c-ccg/did-spec#272

contexts/README.md Outdated Show resolved Hide resolved
@iherman
Copy link
Member

iherman commented Oct 29, 2019

@msporny which context file should I use to set up the redirection? There are two files in the contexts directory.

@msporny
Copy link
Member Author

msporny commented Oct 29, 2019

which context file should I use to set up the redirection?

This one (as a general live redirect pre-CR):

...did-core/contexts/did-v1.jsonld

@iherman
Copy link
Member

iherman commented Oct 29, 2019

@msporny understood, but #5 has not yet been closed, as far as I know; until that is done, we should not merge this, imho.


The current system for DID context versioning is:

1. Use `https://www.w3.org/2019/did/v1` as an alias to the latest version of the
Copy link
Contributor

@OR13 OR13 Feb 7, 2020

Choose a reason for hiding this comment

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

The specific file that this resolves to should be linked here. We should also make it clear that file is meant to be the only one that received PRs for new property definitions.

Copy link
Contributor

@OR13 OR13 left a comment

Choose a reason for hiding this comment

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

We need to make it clear how to contribute to context definitions, by providing the location of the files that are acceptable to edit, and instructions for how to provide human readable documentation.

If you are defining a property on sec I think this is currently not possible to do... I'd like to see all the context files and definitions needs to support dids hosted in this repo.

If people have to go crawling github and redirects, the documentation will never be up to date.

@msporny
Copy link
Member Author

msporny commented Feb 7, 2020

If you are defining a property on sec I think this is currently not possible to do... I'd like to see all the context files and definitions needs to support dids hosted in this repo.

Yes, that'd be great. There were a number of companies at W3C, Microsoft being one of them, that objected to this group working on anything "security related". There is a section in our charter called "Out of Scope" that says "Out of Scope: Defining specific authentication, signing, or cryptography mechanisms. Scope is limited to defining extension points for these mechanisms." -- now, it's arguable that we could specify a security context within this group, but it's really the wrong group to do that... that should be up to the upcoming Linked Data Security WG.

I'd prefer to do that work in this group just so there is a normative reference, but there be political dragons here.

@OR13
Copy link
Contributor

OR13 commented Feb 7, 2020

Just to be clear, Microsoft objected to a common vocabulary around the expression of key material and signing algorithms (security related concepts)?

If thats true, I'd like Microsoft's objection in writing and publicly visible for all to see... thats completely antithetical to what we are doing here...

@csuwildcat @selfissued can you provide clarity on how you think a centralized registry is different from defining security related terms in a single location?

I'm having trouble seeing how these are different.

@csuwildcat
Copy link
Contributor

csuwildcat commented Feb 7, 2020 via email

@OR13
Copy link
Contributor

OR13 commented Feb 7, 2020

So its Microsoft's official position that the only acceptable registry is one thats not machine readable and looks like a text document, https://tools.ietf.org/html/rfc7517 ?

You guys need to put your position in writing.

@selfissued
Copy link
Contributor

I'm not aware of any objections on Microsoft's part to using registries to enable a common interpretation of security-related identifiers, such as algorithm names and meanings, etc. Quite to the contrary! We helped author such registries, including the numerous registries at https://www.iana.org/assignments/jose/jose.xhtml and https://www.iana.org/assignments/jwt/jwt.xhtml.

To support the use of secp256k1 by this and other communities, I'm registering identifiers for using it in the specification https://tools.ietf.org/html/draft-ietf-cose-webauthn-algorithms. Others can do the same for algorithm identifiers (and other identifiers) that they care about.

@csuwildcat
Copy link
Contributor

csuwildcat commented Feb 7, 2020 via email

@OR13
Copy link
Contributor

OR13 commented Feb 7, 2020

I'd like us to agree to a machine readable format for the did core registry... we have JSON-Schema and JSON-LD, we can programmatically generate xhtml, text or pdf or whatever we want from them... Can we get a clear yes from Microsoft to supporting a machine readable format for the did core registry?

@selfissued
Copy link
Contributor

It's not clear to me that a machine-readable registry is any more necessary than a machine-readable version of the DID Core spec. In both cases, it's programmers who are the audience of the specifications that they reference and it's programmers who write code to implement and conform to the specified behaviors, whether they're specified in the core spec or specs referenced from registries established in the core spec.

Don't get me wrong, I'm not philosophically opposed to machine-readable data formats, but I'd want to understand why they're necessary before deciding to also have them. The human-readable registries at the IETF have worked very well in practice, as one useful data point.

@OR13
Copy link
Contributor

OR13 commented Feb 7, 2020

A machine readable version of the registry will facilitate interoperability via software tests.

Spec compliance could be testable. You can't easily test conformance with xhtml or text... the process of verifying JOSE implementations is tedious and involves things like: https://tools.ietf.org/html/rfc7520

The first thing an implementer does is convert these examples to structured data that can be imported into a test suite.

https://github.com/panva/jose/blob/4460c4c88f106878a9c56575a3a69c7eea35fccc/test/cookbook/recipes/4_8.multiple_signatures.js

https://tools.ietf.org/html/rfc7520#section-3.3

In a world where we published JSON Schema & JSON-LD definitions for the core registry, you could pass a json object, and instantly know if it was core compliant, linked data, or extended...

With all the property definitions also being human readable via an xhtml or text version derived from the machine readable one.

interoperability compliance should be testable, we should make it as easy as possible by using a machine readable format for the did core registry, and generate the human readable documentation from it.

@msporny
Copy link
Member Author

msporny commented Feb 7, 2020

We should make it as easy as possible by using a machine readable format for the did core registry, and generate the human readable documentation from it.

I strongly support the position that @OR13 is making above.

@OR13
Copy link
Contributor

OR13 commented Feb 7, 2020

Moving this discussion to an issue: #187

IMO we should consider closing all PRs that would be impacted by the registry changes until we have a foundation to build on... including this one.

@OR13 OR13 self-requested a review March 5, 2020 23:14
@OR13
Copy link
Contributor

OR13 commented Mar 5, 2020

We should be adding this to https://github.com/w3c/did-core-registry context folder.

I think this is blocked by: w3c/did-extensions#13

@OR13
Copy link
Contributor

OR13 commented Mar 15, 2020

@msporny I suggest closing this, I've already moved the content to w3c/did-extensions#11

@msporny
Copy link
Member Author

msporny commented Mar 15, 2020

@msporny I suggest closing this, I've already moved the content to w3c/did-extensions#11

If @dmitrizagidulin agrees (he opened the original PR), we can close this.

@msporny
Copy link
Member Author

msporny commented Mar 23, 2020

Closing, PR overtaken by events.

@msporny msporny closed this Mar 23, 2020
@msporny msporny deleted the dmitri-context-readme branch April 10, 2020 02:35
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.

7 participants