Skip to content
This repository has been archived by the owner on Dec 12, 2021. It is now read-only.

Latest commit

 

History

History
47 lines (36 loc) · 1.92 KB

architecture.md

File metadata and controls

47 lines (36 loc) · 1.92 KB
Raw

Architecture

Technology

Upvote runs on Google App Engine (Python) with an AngularJS frontend. Upvote is built using Bazel.

Storage

Upvote uses both Cloud Datastore and BigQuery to store its data. Upvote generally stores active application state (e.g. execution policy, client settings) in Datastore and offloads historical data to BigQuery.

NOTE: BigQuery export is disabled by default. See setup section for instructions on how to enable it.

Schema

  • User: A user accessing Upvote's frontend (identified by their email address).
  • Host: A machine running an application whitelisting client.
  • Blockable: An entity for which execution policy can be created. This includes Binaries, Certificates, and Packages.
  • Event: An execution event (e.g. block, allow) unique to a User-Host-Blockable triple.
    • These are deduped to the execution's most recent occurrence.
    • Metadata about the number of occurrences, the time of the least recent, and the time of the most recent are retained across dedupes.
  • Rule: An execution policy. It can apply to one host or all hosts. It can specify a whitelist or a blacklist.
  • Vote: An upvote or downvote on a Blockable. It carries variable weight depending on the user who cast it.

Rule, Event, Host, and all Blockable types have platform-specific variants (e.g. Bit9Rule, SantaEvent).

Application Whitelisting Clients

Upvote supports Santa on macOS, a Google-built whitelisting client, and Bit9 (now known as Carbon Black Protection) on Windows. Upvote has a dedicated App Engine module for both the Santa sync API as well as the Bit9 sync process.

NOTE: Deployed modules that aren't serving traffic won't cost anything in App Engine.