Fwd: [CCSS] Definitions section – Clarifications – some structural changes (#13)

2 views
Skip to first unread message

mper...@cryptoconsortium.org

unread,
Apr 14, 2015, 1:26:46 AM4/14/15
to ccss-steeri...@googlegroups.com
In case you aren't fooling the git repository, a new pull request has been posted by Matt Smith from Gem.

Please provide comments on github when you have a chance to review. 

Sent from my mobile device

Begin forwarded message:

From: Matt Smith <notifi...@github.com>
Date: April 13, 2015 at 21:46:17 EDT
To: CryptoConsortium/CCSS <CC...@noreply.github.com>
Subject: [CCSS] Definitions section – Clarifications – some structural changes (#13)
Reply-To: CryptoConsortium/CCSS <reply+00a8d656f5944effae3ede4f8a89e8c6a5e2857...@reply.github.com>

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.)

You can view, comment on, or merge this pull request online at:

  https://github.com/CryptoConsortium/CCSS/pull/13

Commit Summary

  • Added Definitions link
  • Formatting and spacing consistency - trailing whitespace - stray unclosed <p> tag
  • definitions stub
  • Merge branch 'master' of github.com:CryptoConsortium/CCSS into gh-pages
  • refactored to eliminate unnecessary for loops
  • somewhat hacky method of adding definition links inline in aspect description/levels
  • begin adding definitions.
  • Adding definitions
  • More definitions. Clarified the 1.01-level1 requirement regarding backups.
  • ampersand
  • Added note about Dual_EC backdoor
  • More definitions, address,wallet,hdwallet,multisig
  • Added definition links and clarified the distinction between 'wallet' and 'address' in the wallet-generation section
  • typo
  • linkified Key Storage and clarified that backup requirements don't apply to end-user assets (where it's impossible to enforce for any user-facing system)
  • More definitions and clarifications
  • Added definition tags and clarified that only organizational key holders 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.
  • Merge remote-tracking branch 'upstream/gh-pages' into gh-pages
  • definition-tagged Key Compromise Policy stuff
  • def-linked 1.06
  • def-linked 2.02
  • def-linked 2.03 and added a proofofreserve definition
  • formatting
  • renamed definitions to 6_ because of changelog conflict

File Changes

Patch Links:

—
Reply to this email directly or view it on GitHub.

Joshua McDougall

unread,
Apr 22, 2015, 10:34:23 AM4/22/15
to ccss-steeri...@googlegroups.com
Hi All,

After going through this pull request, I don't see anything that drastically changes the standard and would warrant some deeper discussion. The improvements to the CCSS site in this PR are fantastic, especially relating to the way definitions are now incorporated (not to mention also existent!).  

If there are no other concerns, I am going to merge it in later today.

Thanks,
Josh
Reply all
Reply to author
Forward
0 new messages