Merge pull request #9192 from Turbo87/fix-tls

Use `postgres-native-tls` to connect to the database with TLS

Author: Turbo87

Cargo.lock

@@ -91,11 +91,13 @@ tikv-jemallocator = { version = "=0.6.0", features = ['unprefixed_malloc_on_supp
 lettre = { version = "=0.11.7", default-features = false, features = ["file-transport", "smtp-transport", "native-tls", "hostname", "builder"] }
 minijinja = "=2.1.0"
 mockall = "=0.13.0"
+native-tls = "=0.2.12"
 oauth2 = "=4.4.2"
 object_store = { version = "=0.10.2", features = ["aws"] }
 p256 = "=0.13.2"
 parking_lot = "=0.12.3"
 paste = "=1.0.15"
+postgres-native-tls = "=0.5.0"
 prometheus = { version = "=0.13.4", default-features = false }
 quick-xml = "=0.36.1"
 rand = "=0.8.5"
@@ -113,6 +115,7 @@ tar = "=0.4.41"
 tempfile = "=3.10.1"
 thiserror = "=1.0.63"
 tokio = { version = "=1.39.2", features = ["net", "signal", "io-std", "io-util", "rt-multi-thread", "macros", "process"]}
+tokio-postgres = "=0.7.11"
 toml = "=0.8.15"
 tower = "=0.4.13"
 tower-http = { version = "=0.5.2", features = ["add-extension", "fs", "catch-panic", "timeout", "compression-full"] }

Cargo.toml

@@ -1,7 +1,7 @@
 //! Application-wide components in a struct accessible from each request
 
 use crate::config;
-use crate::db::{connection_url, ConnectionConfig};
+use crate::db::{connection_url, make_manager_config, ConnectionConfig};
 use std::ops::Deref;
 use std::sync::Arc;
 
@@ -88,7 +88,8 @@ impl App {
             };
 
             let url = connection_url(&config.db, config.db.primary.url.expose_secret());
-            let manager = AsyncDieselConnectionManager::<AsyncPgConnection>::new(url);
+            let manager_config = make_manager_config(config.db.enforce_tls);
+            let manager = AsyncDieselConnectionManager::new_with_config(url, manager_config);
 
             DeadpoolPool::builder(manager)
                 .runtime(Runtime::Tokio1)
@@ -108,7 +109,8 @@ impl App {
             };
 
             let url = connection_url(&config.db, pool_config.url.expose_secret());
-            let manager = AsyncDieselConnectionManager::<AsyncPgConnection>::new(url);
+            let manager_config = make_manager_config(config.db.enforce_tls);
+            let manager = AsyncDieselConnectionManager::new_with_config(url, manager_config);
 
             let pool = DeadpoolPool::builder(manager)
                 .runtime(Runtime::Tokio1)

src/app.rs

@@ -15,6 +15,7 @@ extern crate tracing;
 
 use anyhow::Context;
 use crates_io::cloudfront::CloudFront;
+use crates_io::db::make_manager_config;
 use crates_io::fastly::Fastly;
 use crates_io::storage::Storage;
 use crates_io::team_repo::TeamRepoImpl;
@@ -27,7 +28,6 @@ use crates_io_index::RepositoryConfig;
 use crates_io_worker::Runner;
 use diesel_async::pooled_connection::deadpool::Pool;
 use diesel_async::pooled_connection::AsyncDieselConnectionManager;
-use diesel_async::AsyncPgConnection;
 use reqwest::Client;
 use secrecy::ExposeSecret;
 use std::sync::Arc;
@@ -82,7 +82,8 @@ fn main() -> anyhow::Result<()> {
     let fastly = Fastly::from_environment(client.clone());
     let team_repo = TeamRepoImpl::default();
 
-    let manager = AsyncDieselConnectionManager::<AsyncPgConnection>::new(db_url);
+    let manager_config = make_manager_config(config.db.enforce_tls);
+    let manager = AsyncDieselConnectionManager::new_with_config(db_url, manager_config);
     let deadpool = Pool::builder(manager).max_size(10).build().unwrap();
 
     let environment = Environment::builder()

src/bin/background-worker.rs

@@ -0,0 +1,11 @@
+-----BEGIN CERTIFICATE-----
+MIIBozCCAUqgAwIBAgIJAMDLUd0ypWHdMAoGCCqGSM49BAMDMCUxIzAhBgNVBAMM
+GnJqamxwMmxnbWJjanZvamV4YjN3NndsNTVlMB4XDTI0MDYwNTA2MjcyOVoXDTQ0
+MDUzMTA2MjcyOVowJTEjMCEGA1UEAwwacmpqbHAybGdtYmNqdm9qZXhiM3c2d2w1
+NWUwWTATBgcqhkjOPQIBBggqhkjOPQMBBwNCAAS4J3uDAfsWOQFD6XAwpPWOvviY
+kCPqyJ37OGMOhA70zvQKOnxTmrKu2p7lsyVrnbCtD4Ve11CouI4iDPeVmK/wo2Mw
+YTAPBgNVHRMBAf8EBTADAQH/MA4GA1UdDwEB/wQEAwIBBjAdBgNVHQ4EFgQUy5m8
+qXuAIReA7KFV1fKaHLPZo14wHwYDVR0jBBgwFoAUy5m8qXuAIReA7KFV1fKaHLPZ
+o14wCgYIKoZIzj0EAwMDRwAwRAIgQfpsO+B96Xse+ushnl+0Abx2tx0F5ac+K0L/
+x4uyKP4CIBaCSz+Oa/rG30W2F0VVtJN8guKFvnCMy7Gg/XCGGx8l
+-----END CERTIFICATE-----

src/certs/crunchy.pem

@@ -1,4 +1,8 @@
-//! Certificates from <https://letsencrypt.org/certificates/>.
-
+/// Certificate from <https://letsencrypt.org/certificates/>.
 pub const ISRG_ROOT_X1: &[u8] = include_bytes!("./isrg-root-x1.pem");
+
+/// Certificate from <https://letsencrypt.org/certificates/>.
 pub const ISRG_ROOT_X2: &[u8] = include_bytes!("./isrg-root-x2.pem");
+
+/// crates.io team certificate from <https://crunchybridge.com/>.
+pub const CRUNCHY: &[u8] = include_bytes!("./crunchy.pem");

src/certs/mod.rs

@@ -1,6 +1,10 @@
+use crate::certs::CRUNCHY;
 use diesel::{Connection, ConnectionResult, PgConnection, QueryResult};
 use diesel_async::pooled_connection::deadpool::{Hook, HookError};
+use diesel_async::pooled_connection::ManagerConfig;
 use diesel_async::{AsyncPgConnection, RunQueryDsl};
+use native_tls::{Certificate, TlsConnector};
+use postgres_native_tls::MakeTlsConnector;
 use secrecy::ExposeSecret;
 use std::time::Duration;
 use url::Url;
@@ -43,6 +47,53 @@ fn maybe_append_url_param(url: &mut Url, key: &str, value: &str) {
     }
 }
 
+/// Create a new [ManagerConfig] for the database connection pool, which can
+/// be used with [diesel_async::pooled_connection::AsyncDieselConnectionManager::new_with_config()].
+pub fn make_manager_config(enforce_tls: bool) -> ManagerConfig<AsyncPgConnection> {
+    let mut manager_config = ManagerConfig::default();
+    manager_config.custom_setup =
+        Box::new(move |url| Box::pin(establish_async_connection(url, enforce_tls)));
+    manager_config
+}
+
+/// Establish a new database connection with the given URL.
+///
+/// Adapted from <https://github.com/weiznich/diesel_async/blob/v0.5.0/examples/postgres/pooled-with-rustls/src/main.rs>.
+async fn establish_async_connection(
+    url: &str,
+    enforce_tls: bool,
+) -> ConnectionResult<AsyncPgConnection> {
+    use diesel::ConnectionError::BadConnection;
+
+    let cert = Certificate::from_pem(CRUNCHY).map_err(|err| BadConnection(err.to_string()))?;
+
+    let connector = TlsConnector::builder()
+        .add_root_certificate(cert)
+        // On OSX the native TLS stack is complaining about the long validity
+        // period of the certificate, so if locally we don't enforce TLS
+        // connections, we also don't enforce the validity of the certificate.
+        //
+        // Similarly, on CI the native TLS stack is complaining about the
+        // certificate being self-signed. On CI we are connecting to a locally
+        // running database, so we also don't need to enforce the validity of
+        // the certificate either.
+        .danger_accept_invalid_certs(!enforce_tls)
+        .build()
+        .map_err(|err| BadConnection(err.to_string()))?;
+
+    let connector = MakeTlsConnector::new(connector);
+    let result = tokio_postgres::connect(url, connector).await;
+    let (client, conn) = result.map_err(|err| BadConnection(err.to_string()))?;
+
+    tokio::spawn(async move {
+        if let Err(e) = conn.await {
+            eprintln!("Database connection: {e}");
+        }
+    });
+
+    AsyncPgConnection::try_from(client).await
+}
+
 #[derive(Debug, Clone, Copy)]
 pub struct ConnectionConfig {
     pub statement_timeout: Duration,

src/db.rs

@@ -172,7 +172,8 @@ impl From<EmailError> for BoxedAppError {
 }
 
 impl From<diesel_async::pooled_connection::deadpool::PoolError> for BoxedAppError {
-    fn from(_err: diesel_async::pooled_connection::deadpool::PoolError) -> BoxedAppError {
+    fn from(err: diesel_async::pooled_connection::deadpool::PoolError) -> BoxedAppError {
+        error!("Database pool error: {err}");
         service_unavailable()
     }
 }