feat(cli): connection flags + DX (quiet logging, random port, best-effort TLS)

packages/cipherstash-proxy/src/cli/mod.rs

@@ -21,11 +21,23 @@ const DEFAULT_CONFIG_FILE: &str = "cipherstash-proxy.toml";
 /// CipherStash Proxy keeps your sensitive data in PostgreSQL encrypted and searchable, with no changes to SQL.
 ///
 pub struct Args {
+    /// Optional full PostgreSQL connection string, e.g.
+    /// "postgres://user:pass@host:5432/dbname".
+    /// Sets host, port, user, password and database name at once.
+    /// Individual flags below override matching parts of the URL.
+    #[arg(long, value_name = "URL", verbatim_doc_comment)]
+    pub database_url: Option<String>,
+
     /// Optional database host to connect to.
     /// Uses env or config file if not specified.
     #[arg(short = 'H', long)]
     pub db_host: Option<String>,
 
+    /// Optional database port to connect to.
+    /// Uses env or config file if not specified.
+    #[arg(short = 'P', long)]
+    pub db_port: Option<u16>,
+
     /// Optional database name to connect to.
     /// Uses env or config file if not specified.
     #[arg(value_name = "DBNAME")]
@@ -36,6 +48,31 @@ pub struct Args {
     #[arg(short = 'u', long)]
     pub db_user: Option<String>,
 
+    /// Optional database password.
+    /// Uses env or config file if not specified.
+    /// Prefer CS_DATABASE__PASSWORD or --database-url to avoid leaking the
+    /// password into shell history / the process list.
+    #[arg(short = 'W', long, verbatim_doc_comment)]
+    pub db_password: Option<String>,
+
+    /// Disable inbound (client-facing) TLS: the proxy listens for client
+    /// connections in plaintext. Overrides any CS_TLS__* env / config.
+    /// Use for local development only. Does not affect the connection from the
+    /// proxy to the database.
+    #[arg(long, verbatim_doc_comment, conflicts_with = "tls")]
+    pub no_tls: bool,
+
+    /// Require inbound (client-facing) TLS. Startup fails if TLS is not
+    /// configured or the certificate/key are invalid. Without this flag the
+    /// proxy uses TLS when configured and falls back to plaintext otherwise.
+    #[arg(long, verbatim_doc_comment)]
+    pub tls: bool,
+
+    /// Enable verbose (debug) logging. Without it the proxy logs errors only.
+    /// An explicit --log-level / CS_LOG__LEVEL or a config file takes precedence.
+    #[arg(long, verbatim_doc_comment)]
+    pub debug: bool,
+
     /// Optional path to a CipherStash Proxy configuration file.
     ///
     /// Default is "cipherstash-proxy.toml".

packages/cipherstash-proxy/src/config/tandem.rs

@@ -108,15 +108,31 @@ impl TandemConfig {
             config.log.format = args.log_format;
         }
 
+        // --no-tls forces a plaintext inbound listener, ignoring any CS_TLS__*
+        // env / config. (Does not affect the proxy -> database connection.)
+        if args.no_tls {
+            if config.tls.is_some() {
+                println!("Disabling inbound TLS (--no-tls): the proxy will listen without TLS");
+            }
+            config.tls = None;
+            config.server.require_tls = false;
+        }
+
         Ok(config)
     }
 
     pub fn build_path(path: &str) -> Result<Self, Error> {
         let args = Args {
             config_file_path: path.to_string(),
+            database_url: None,
             db_host: None,
+            db_port: None,
             db_name: None,
             db_user: None,
+            db_password: None,
+            no_tls: false,
+            tls: false,
+            debug: false,
             log_level: LogConfig::default_log_level(),
             log_format: LogConfig::default_log_format(),
             command: None,
@@ -169,20 +185,37 @@ impl TandemConfig {
                 env
             }));
 
-        // Command line arguments override env vars
+        // Command line arguments override env vars.
+        // A full connection string is applied first; individual flags below
+        // then override matching parts of it.
+        if let Some(url) = &args.database_url {
+            println!("Overriding database connection from --database-url");
+            apply_database_url(url)?;
+        }
+
         if let Some(db_host) = &args.db_host {
             println!("Overriding database host from command line argument");
             env::set_var("CS_DATABASE__HOST", db_host);
         }
 
+        if let Some(db_port) = &args.db_port {
+            println!("Overriding database port from command line argument");
+            env::set_var("CS_DATABASE__PORT", db_port.to_string());
+        }
+
         if let Some(dbname) = &args.db_name {
             println!("Overriding database name from command line argument");
             env::set_var("CS_DATABASE__NAME", dbname);
         }
 
         if let Some(db_user) = &args.db_user {
             println!("Overriding database user from command line argument");
-            env::set_var("CS_DATABASE__USER", db_user);
+            env::set_var("CS_DATABASE__USERNAME", db_user);
+        }
+
+        if let Some(db_password) = &args.db_password {
+            println!("Overriding database password from command line argument");
+            env::set_var("CS_DATABASE__PASSWORD", db_password);
         }
 
         // Source order is important!
@@ -361,6 +394,47 @@ static RE: LazyLock<Regex> = LazyLock::new(|| Regex::new(r"`([^`]+)`").unwrap())
 ///
 /// Extracts a field name (if present) from a config::ConfigError string
 /// This is called in `build` if a ConfigError message contains the string `missing field`
+/// Parse a PostgreSQL connection string (e.g.
+/// "postgres://user:pass@host:5432/dbname") and set the corresponding
+/// CS_DATABASE__* env vars for each component present. Individual --db-* flags
+/// are applied after this and take precedence.
+fn apply_database_url(url: &str) -> Result<(), Error> {
+    use std::str::FromStr;
+
+    let pg =
+        tokio_postgres::Config::from_str(url).map_err(|err| ConfigError::InvalidParameter {
+            name: "database-url".to_string(),
+            value: err.to_string(),
+        })?;
+
+    if let Some(host) = pg.get_hosts().iter().find_map(|h| match h {
+        tokio_postgres::config::Host::Tcp(host) => Some(host.clone()),
+        _ => None,
+    }) {
+        env::set_var("CS_DATABASE__HOST", host);
+    }
+
+    if let Some(port) = pg.get_ports().first() {
+        env::set_var("CS_DATABASE__PORT", port.to_string());
+    }
+
+    if let Some(user) = pg.get_user() {
+        env::set_var("CS_DATABASE__USERNAME", user);
+    }
+
+    if let Some(password) = pg.get_password() {
+        if let Ok(password) = std::str::from_utf8(password) {
+            env::set_var("CS_DATABASE__PASSWORD", password);
+        }
+    }
+
+    if let Some(dbname) = pg.get_dbname() {
+        env::set_var("CS_DATABASE__NAME", dbname);
+    }
+
+    Ok(())
+}
+
 /// Expected string is in the forms:
 ///     "missing field `{field}}` for key `{key}`"
 ///     "missing field `{field}}`"
@@ -419,6 +493,40 @@ mod tests {
 
     const CS_PREFIX: &str = "CS_TEST";
 
+    #[test]
+    /// --database-url sets each CS_DATABASE__* var, including USERNAME (not USER
+    /// -- a previous bug set the wrong var so --db-user was a silent no-op).
+    fn database_url_sets_connection_env() {
+        use crate::config::tandem::apply_database_url;
+        with_no_cs_vars(|| {
+            temp_env::with_vars_unset(
+                [
+                    "CS_DATABASE__HOST",
+                    "CS_DATABASE__PORT",
+                    "CS_DATABASE__USERNAME",
+                    "CS_DATABASE__USER",
+                    "CS_DATABASE__PASSWORD",
+                    "CS_DATABASE__NAME",
+                ],
+                || {
+                    apply_database_url("postgres://alice:s3cret@db.example.com:5430/orders")
+                        .unwrap();
+
+                    assert_eq!(
+                        std::env::var("CS_DATABASE__HOST").unwrap(),
+                        "db.example.com"
+                    );
+                    assert_eq!(std::env::var("CS_DATABASE__PORT").unwrap(), "5430");
+                    assert_eq!(std::env::var("CS_DATABASE__USERNAME").unwrap(), "alice");
+                    assert_eq!(std::env::var("CS_DATABASE__PASSWORD").unwrap(), "s3cret");
+                    assert_eq!(std::env::var("CS_DATABASE__NAME").unwrap(), "orders");
+                    // The old (buggy) variable name must not be set.
+                    assert!(std::env::var("CS_DATABASE__USER").is_err());
+                },
+            );
+        });
+    }
+
     #[test]
     /// the env vars from stash setup should be the preferred option
     /// File -> extended env (generated by the config struct layout) -> stash setup env

packages/cipherstash-proxy/src/connect/mod.rs

@@ -51,16 +51,35 @@ pub async fn database(config: &DatabaseConfig) -> Result<Client, Error> {
     Ok(client)
 }
 
-pub async fn bind_with_retry(server: &ServerConfig) -> TcpListener {
-    let address = &server.to_socket_address();
+pub async fn bind_with_retry(server: &ServerConfig, allow_random_fallback: bool) -> TcpListener {
+    let address = server.to_socket_address();
     let mut retry_count = 0;
 
     loop {
-        match TcpListener::bind(address).await {
+        match TcpListener::bind(&address).await {
             Ok(listener) => {
-                info!(msg = "Server waiting for connections", address);
+                report_listening(&listener);
                 return listener;
             }
+            // The configured port is in use, but it's only the default (not
+            // explicitly set), so fall back to an OS-assigned port and report it
+            // rather than failing.
+            Err(err) if err.kind() == std::io::ErrorKind::AddrInUse && allow_random_fallback => {
+                match TcpListener::bind(format!("{}:0", server.host)).await {
+                    Ok(listener) => {
+                        println!(
+                            "Port {} is already in use; listening on an OS-assigned port instead.",
+                            server.port
+                        );
+                        report_listening(&listener);
+                        return listener;
+                    }
+                    Err(err) => {
+                        error!(msg = "Error binding connection", error = err.to_string());
+                        std::process::exit(exitcode::CONFIG);
+                    }
+                }
+            }
             Err(err) => {
                 if retry_count > MAX_RETRY_COUNT {
                     error!(
@@ -80,6 +99,21 @@ pub async fn bind_with_retry(server: &ServerConfig) -> TcpListener {
     }
 }
 
+/// Report the address the proxy is listening on. Uses `println!` so the
+/// listening address (including an OS-assigned fallback port) is always visible,
+/// even when logging is quiet.
+fn report_listening(listener: &TcpListener) {
+    match listener.local_addr() {
+        Ok(addr) => {
+            println!("CipherStash Proxy listening on {addr}");
+            info!(msg = "Server waiting for connections", address = %addr);
+        }
+        Err(_) => {
+            info!(msg = "Server waiting for connections");
+        }
+    }
+}
+
 pub async fn connect_with_retry(addr: &str) -> Result<TcpStream, Error> {
     let mut retry_count = 0;
 
@@ -157,3 +191,28 @@ pub fn configure(stream: &TcpStream) {
         }
     }
 }
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[tokio::test]
+    async fn bind_falls_back_to_random_port_when_default_in_use() {
+        // Occupy a port, then ask bind_with_retry to bind the same one.
+        let occupied = TcpListener::bind("127.0.0.1:0").await.unwrap();
+        let occupied_port = occupied.local_addr().unwrap().port();
+
+        let server = ServerConfig {
+            host: "127.0.0.1".to_string(),
+            port: occupied_port,
+            ..ServerConfig::default()
+        };
+
+        // With fallback allowed, it binds a different OS-assigned port.
+        let listener = bind_with_retry(&server, true).await;
+        let bound_port = listener.local_addr().unwrap().port();
+
+        assert_ne!(bound_port, occupied_port);
+        assert_ne!(bound_port, 0);
+    }
+}