Merge pull request #13 from geico/server/begin-tuxtape-server

Begin `tuxtape-server`

Author: graysonguarino

Cargo.lock

@@ -0,0 +1,7 @@
+[workspace]
+resolver = "3"
+
+members = [
+    "tuxtape-server",
+    "tuxtape-server/tuxtape-database-bridge"
+]

Cargo.toml

@@ -8,11 +8,16 @@ message Vulnerability {
   // Instances of this Vulnerability across different MainlineKernelVersions.
   // Will be empty if no instances exist in the managed fleet.
   repeated VulnerabilityInstance instances = 1;
-
+  // A custom description that can be set for a Vulnerability.
+  // Since a Vulnerability almost always describes a Cve, and since CVEs being
+  // patched are typically evaluated by NIST, this value is most useful when
+  // patching a Vulnerability which has not yet been catalogued as a CVE.
+  // Usually, the description for the CVE will be more useful.
+  optional string description = 2;
   // The CVE that this Vulnerability describes.
   // A Vulnerability will always describe a Cve unless a CVE has not yet been
   // published for this Vulnerability.
-  optional Cve cve = 2;
+  optional Cve cve = 3;
 }
 
 // An instance of a Vulnerability.

proto/tuxtape/common/v1/vulnerability.proto

@@ -0,0 +1,14 @@
+[package]
+name = "tuxtape-server"
+edition = "2024"
+description = "The central server for a complete TuxTape environment."
+
+[dependencies]
+clap = { version = "4.5", features = ["derive", "env"] }
+tokio = { version = "1.44", features = ["full"] }
+color-eyre = "0.6"
+tuxtape-database-bridge = { path = "tuxtape-database-bridge" }
+
+[[bin]]
+name = "tuxtape-server"
+path = "src/main.rs"

tuxtape-server/Cargo.toml

@@ -0,0 +1,9 @@
+# For documentation on how to configure this file,
+# see https://diesel.rs/guides/configuring-diesel-cli
+
+[print_schema]
+file = "tuxtape-database-bridge/src/schema.rs"
+custom_type_derives = ["diesel::query_builder::QueryId", "Clone"]
+
+[migrations_directory]
+dir = "migrations"

tuxtape-server/diesel.toml

@@ -0,0 +1,9 @@
+DROP TABLE vulnerability;
+DROP TABLE vulnerability_instance;
+DROP TABLE vulnerability_instance_affected_file;
+DROP TABLE cve;
+DROP TABLE mainline_kernel_release;
+DROP TABLE kernel_release;
+DROP TABLE kernel_source;
+DROP TABLE kernel_file;
+DROP TABLE meta;

tuxtape-server/migrations/2025-03-18-193149_init/down.sql

@@ -0,0 +1,81 @@
+-- Initializes the TuxTape database
+
+CREATE TABLE vulnerability (
+    id INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
+    description TEXT
+);
+
+CREATE TABLE vulnerability_instance (
+    id INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
+    vulnerability_id INTEGER NOT NULL,
+    description TEXT,
+    mainline_kernel_release_introduced_id INTEGER,
+    mainline_kernel_release_fixed_id INTEGER,
+    fixed_commit TEXT,
+    patch_diff TEXT,
+    FOREIGN KEY(vulnerability_id) REFERENCES vulnerability(id),
+    FOREIGN KEY(mainline_kernel_release_introduced_id) REFERENCES mainline_kernel_release(id),
+    FOREIGN KEY(mainline_kernel_release_fixed_id) REFERENCES mainline_kernel_release(id)
+);
+
+CREATE TABLE vulnerability_instance_affected_file (
+    id INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
+    vulnerability_instance_id INTEGER NOT NULL,
+    file_path TEXT NOT NULL,
+    FOREIGN KEY(vulnerability_instance_id) REFERENCES vulnerability_instance(id)
+);
+
+CREATE TABLE cve (
+    id INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
+    cve_id TEXT NOT NULL,
+    vulnerability_id INTEGER NOT NULL,
+    base_score REAL,
+    attack_vector TEXT,
+    attack_complexity TEXT,
+    privileges_required TEXT,
+    user_interaction TEXT,
+    scope TEXT,
+    confidentiality_impact TEXT,
+    integrity_impact TEXT,
+    availability_impact TEXT,
+    description TEXT,
+    FOREIGN KEY(vulnerability_id) REFERENCES vulnerability(id)
+);
+
+CREATE TABLE mainline_kernel_release (
+    id INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
+    version_major INTEGER NOT NULL,
+    version_minor INTEGER NOT NULL,
+    version_patch INTEGER NOT NULL,
+    version_extra TEXT NOT NULL,
+    UNIQUE (version_major, version_minor, version_patch, version_extra)
+);
+
+CREATE TABLE kernel_release (
+    id INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
+    mainline_kernel_release_id INTEGER NOT NULL,
+    version_local TEXT,
+    FOREIGN KEY(mainline_kernel_release_id) REFERENCES mainline_kernel_release(id),
+    UNIQUE (version_local)
+);
+
+CREATE TABLE kernel_source (
+    id INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
+    kernel_release_id INTEGER NOT NULL,
+    url TEXT NOT NULL,
+    FOREIGN KEY(kernel_release_id) REFERENCES kernel_release(id),
+    UNIQUE (kernel_release_id, url)
+);
+
+CREATE TABLE kernel_file (
+    id INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
+    kernel_release_id INTEGER NOT NULL,
+    file_path TEXT NOT NULL,
+    FOREIGN KEY(kernel_release_id) REFERENCES kernel_release(id)
+);
+
+CREATE TABLE meta (
+    id INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT CHECK (id = 1),
+    based_on_vulns_commit TEXT NOT NULL,
+    last_run_unix_time INTEGER NOT NULL
+);

tuxtape-server/migrations/2025-03-18-193149_init/up.sql

@@ -0,0 +1,29 @@
+use clap::Parser;
+use tuxtape_database_bridge::connection::DatabaseBackend;
+
+#[derive(clap::ValueEnum, Clone, Debug)]
+pub enum CliDatabaseBackend {
+    Pg,
+    Sqlite,
+}
+
+impl From<CliDatabaseBackend> for DatabaseBackend {
+    fn from(val: CliDatabaseBackend) -> Self {
+        match val {
+            CliDatabaseBackend::Pg => DatabaseBackend::Pg,
+            CliDatabaseBackend::Sqlite => DatabaseBackend::Sqlite,
+        }
+    }
+}
+
+#[derive(Parser, Debug)]
+#[command(version, about, long_about = None)]
+pub struct Cli {
+    /// The URL to the database. If Postgres, this should be a web URL. If SQLite, this should be a
+    /// path to the database file, either relative or absolute.
+    #[arg(short('d'), long, default_value = concat!(env!("HOME"), "/.cache/tuxtape-server/db.db3"))]
+    pub db_url: String,
+    /// The database backend. If Postgres, this should "pg". If SQLite, this should be "sqlite".
+    #[arg(short('b'), long, default_value = "sqlite")]
+    pub db_backend: CliDatabaseBackend,
+}

tuxtape-server/src/cli.rs

@@ -0,0 +1 @@
+// TODO

tuxtape-server/src/grpc/mod.rs

@@ -0,0 +1,21 @@
+use clap::Parser;
+use cli::Cli;
+use color_eyre::{Result, eyre::eyre};
+
+mod cli;
+
+#[tokio::main]
+async fn main() -> Result<()> {
+    let args = Cli::parse();
+
+    // Attempt to connect to database and exit early and loudly if failed.
+    let mut conn = tuxtape_database_bridge::connection::establish_connection(
+        args.db_backend.into(),
+        &args.db_url,
+    )?;
+
+    // Run any pending database migrations before proceeding.
+    tuxtape_database_bridge::migration::run_pending_migrations(&mut conn).map_err(|e| eyre!(e))?;
+
+    Ok(())
+}