Skip to content

Commit

Permalink
Start some design docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dpc committed Aug 24, 2018
1 parent 09ce0ef commit 5641e47
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 0 deletions.
13 changes: 13 additions & 0 deletions .art/settings.toml
@@ -0,0 +1,13 @@
# ---- Artifact Project Settings ----

# Paths containing artifact markdown/toml files
artifact_paths = ["design"]

# Paths to exclude when loading artifacts
exclude_artifact_paths = []

# Paths containing code that has artifact links
code_paths = []

# Paths to exclude when searching through code
exclude_code_paths = []
29 changes: 29 additions & 0 deletions design/purpose.md
@@ -0,0 +1,29 @@
# REQ-purpose

The main goal of this project is to solve trust problems
of downstream users of ecosystems like NPM/Cargo/Pip etc.
and potentially any organization utilizing source code written
by multiple people.

No matter how strict the security of such ecosystems are,
any downstream users stay vulnerable to:

* poor quality of upstream libraries
* maliciousness of the authors of upstream libraries
* compromised accounts

and while "vetting your dependencies" and upgrading conservatively
is responsibility of the downstream user, in practice it's unrealistic,
because it does not scale.

This is solved by:

* Making a cryptographically verifiable code review information become a part
of source code in a way similar to how documentation is a part of source code
in any modern code-bases. (Review Proofs)
* Making personal, technical trust information explicit and cryptographically verifiable
in a similar fashion.
* Establishing common set of formats and artifacts to allow
exchanging such artifacts of code review and personal trust.
* Building tools helping downstream users judge, verify and enforce trust
and safety requirements based on the above.

0 comments on commit 5641e47

Please sign in to comment.