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

Definitions section – Clarifications – some structural changes #13

Merged
merged 24 commits into from Apr 22, 2015

Conversation

Projects
None yet
2 participants
@thedoctor
Contributor

thedoctor commented Apr 14, 2015

Hey guys,

Sorry for the poor packaging of this PR, it's pretty bulky and touches a lot of stuff. Also I just noticed the changelog stuff today, so I'll have to add quite a few entries there, but I figured it'd be worth submitting this first so the changes can be reviewed.

In this PR, main changes:

  • Slight modifications to the way aspects were being loaded into the aspects page to eliminate some redundancy.
  • Pipe the data loaded from _data/aspects through markdown to allow for internal links.
  • Add a Definitions section and a bunch of definitions for terms that either I thought needed clarification for the purposes of the spec, or might be obscure to uninformed readers. Several definitions are stubs, and all should be reviewed to make sure I didn't write anything controversial or ridiculous (or wrong) – they have edit/discussion links for convenience. Also, I tagged the first occurrence of each defined term in each section with a link. (There is a minor hack in 1_aspects.html to get these to display properly)
  • Formatting (normalized indentation, swapped out smart-quotes where I saw them, and removed trailing whitespace)
  • Added hyperlinks where possible to external resources (RFCs, NIST pubs, etc)
  • Actual clarifications to the level requirements. Most notable changes include
    • the definition of 'actor' and a note about backups in 101-KeySeedGeneration
    • a clearer distinction between 'wallet' and 'address' in 102-WalletCreation
    • clarification of to whom backup requirements apply in 103-KeyStorage
    • clarification of multi-factor authentication requirements in 104-KeyUsage (I removed the requirement of a username/password combination and generalized to requiring an identifier (username, email) and then the previous number + 1 authentication factors.)

thedoctor added some commits Mar 17, 2015

Merge branch 'master' of github.com:CryptoConsortium/CCSS into gh-pages
Conflicts:
	_data/aspects/101-KeySeedGeneration.yml
Added definition links and clarified the distinction between 'wallet…
…' and 'address' in the wallet-generation section
linkified Key Storage and clarified that backup requirements don't a…
…pply to end-user assets (where it's impossible to enforce for any user-facing system)
Added definition tags and clarified that only organizational key hol…
…ders must meet identity verification/background check requirements -- also clarified that a password is optional so long as the number of authentication factors is sufficiently high -- I recommend we examine the background check requirement as it's still very vague, but I'm not sure how to best address that.
@Abstrct

This comment has been minimized.

Show comment
Hide comment
@Abstrct

Abstrct Apr 15, 2015

Contributor

I'm still working on taking in all the changes but I just wanted to quickly say thank you. This is an awesome contribution and I look forward to hitting that inviting green button up there.

Since there are a mix of changes to the repository/page, and changes to the standard itself, I will hold off to give everyone a chance to comment.

Contributor

Abstrct commented Apr 15, 2015

I'm still working on taking in all the changes but I just wanted to quickly say thank you. This is an awesome contribution and I look forward to hitting that inviting green button up there.

Since there are a mix of changes to the repository/page, and changes to the standard itself, I will hold off to give everyone a chance to comment.

Abstrct added a commit that referenced this pull request Apr 22, 2015

Merge pull request #13 from GemHQ/gh-pages
Definitions section – Clarifications – some structural changes

@Abstrct Abstrct merged commit f0ec483 into CryptoConsortium:gh-pages Apr 22, 2015

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment