Skip to content

Latest commit

 

History

History
96 lines (68 loc) · 4.15 KB

README.md

File metadata and controls

96 lines (68 loc) · 4.15 KB
Raw

Crev - Code REView system that we desperately need

Implementations

Introduction

You're ultimately responsible for vetting your dependencies.

But in a world of NPM/PIP/Cargo/RubyGems - how do you do that? Can you keep up with ever-changing ecosystem?

Crev is an actual code review system as opposed to typically practiced code-change review system.

Crev is scalable, distributed, and social. Users publish and circulate results of their reviews: potentially warning about problems, malicious code, or just encouraging high quality by peer review.

Crev allows building a personal web of trust in other people and the code they use and review.

Crev is a tool we desperately need yesterday. It protects against compromised dev accounts, intentional malicious code, typosquatting, compromised package registries, or just plain poor quality.

Vision

We would like Crev to become a general language- and ecosystem-agnostic system for establishing trust in Open Source code. We would like to have frontends integrated with all the major Open Source package managers and ecosystems, and many independent and interoperable tools building on top of it.

Overview

At it's core Crev defines a simple, human-readable data format to communicate trust in code (results of code review) and people (reputation).

Using tools implementing Crev, you can generate cryptographically signed artifacts (Proofs).

Here is an example of a Package Review Proof that describes results of reviewing a whole package (library, crate, etc.):

-----BEGIN CREV PACKAGE REVIEW-----
version: -1
date: "2018-12-16T00:09:27.905713993-08:00"
from:
  id-type: crev
  id: 8iUv_SPgsAQ4paabLfs1D9tIptMnuSRZ344_M-6m9RE
  url: "https://github.com/dpc/crev-proofs"
package:
  source: "https://crates.io"
  name: default
  version: 0.1.2
  digest: RtL75KvBdj_Zk42wp2vzNChkT1RDUdLxbWovRvEm1yA
review:
  thoroughness: high
  understanding: high
  rating: positive
comment: "I'm the author, and this crate is trivial"
-----BEGIN CREV PACKAGE REVIEW SIGNATURE-----
QpigffpvOnK7KNdDzQSNRt8bkOFYP_LOLE-vOZ2lu6Je5jvF3t4VZddZDDnPhxaY9zEQurozqTiYAHX8nXz5CQ
-----END CREV PACKAGE REVIEW-----

Proofs are published and exchanged in a similar way that Open Source code is, for other people to benefit from.

Fundamental beliefs of Crev design:

  • Trust is about people and community, not automatic scans, arbitrary metrics, process, or bureaucracy. You can't replace a human judgment with an algorithm. Tools can only help make such a judgment.
  • Code quality, risk management, and trust requirements are subjective, contextual, and personal. Islands of Trust must grow organically.
  • Not many people can review all their dependencies, but if every user at least skimmed through a couple of them, and shared that information with others, we would be in a much better situation.
  • Trust should be spread redundantly between many people, so one compromised or malicious actor can't abuse the system.
  • Crev does not have to be perfect. Instead it should be robust, simple and flexible, so it can evolve to be good enough.

Further reading

For more concrete information, see cargo-crev - first and currently most advanced implementation of Crev.