Skip to content

fix: render secret-bearing service configs with 0600 permissions #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rafa-stacks merged 2 commits into from
Aug 17, 2026
+39 −14
Merged

fix: render secret-bearing service configs with 0600 permissions #28

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
69f7eef
fix: render secret-bearing service configs with 0600 permissions
rafa-stacks Aug 17, 2026
64e5638
dont render env in tests
rafa-stacks Aug 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 39 additions & 14 deletions src/config/render.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,9 +147,10 @@ pub fn render(deployment: &Deployment, data_dir: &Path) -> Result<PathBuf> {
if deployment.stacks_node.mode == ServiceMode::Enabled {
chainstate_subdir("stacks-node")?;
std::fs::create_dir_all(dir.join("stacks-node"))?;
std::fs::write(
dir.join("stacks-node/Config.toml"),
format!("{GENERATED_HEADER}{}", node_config_toml(deployment)),
// Carries the bitcoind rpc password and node auth token -> 0600.
secrets::write_0600(
&dir.join("stacks-node/Config.toml"),
&format!("{GENERATED_HEADER}{}", node_config_toml(deployment)),
)?;
Comment thread
rafa-stacks marked this conversation as resolved.
compose
.services
Expand All @@ -159,9 +160,10 @@ pub fn render(deployment: &Deployment, data_dir: &Path) -> Result<PathBuf> {
if deployment.stacks_signer.mode == ServiceMode::Enabled {
chainstate_subdir("stacks-signer")?;
std::fs::create_dir_all(dir.join("stacks-signer"))?;
std::fs::write(
dir.join("stacks-signer/signer.toml"),
format!("{GENERATED_HEADER}{}", signer_config_toml(deployment)),
// Carries the node auth token (auth_password) -> 0600.
secrets::write_0600(
&dir.join("stacks-signer/signer.toml"),
&format!("{GENERATED_HEADER}{}", signer_config_toml(deployment)),
)?;
compose
.services
Expand All @@ -170,9 +172,10 @@ pub fn render(deployment: &Deployment, data_dir: &Path) -> Result<PathBuf> {

if deployment.stacks_api.mode == ServiceMode::Enabled {
std::fs::create_dir_all(dir.join("stacks-api"))?;
std::fs::write(
dir.join("stacks-api/.env"),
format!("{GENERATED_HEADER}{}", api_env(deployment)),
// Carries PG_PASSWORD and the node auth token -> 0600.
secrets::write_0600(
&dir.join("stacks-api/.env"),
&format!("{GENERATED_HEADER}{}", api_env(deployment)),
)?;
compose
.services
Expand All @@ -181,9 +184,10 @@ pub fn render(deployment: &Deployment, data_dir: &Path) -> Result<PathBuf> {

if deployment.stacks_mesh_api.mode == ServiceMode::Enabled {
std::fs::create_dir_all(dir.join("stacks-mesh-api"))?;
std::fs::write(
dir.join("stacks-mesh-api/.env"),
format!("{GENERATED_HEADER}{}", mesh_api_env(deployment)),
// Carries the node auth token -> 0600.
secrets::write_0600(
&dir.join("stacks-mesh-api/.env"),
&format!("{GENERATED_HEADER}{}", mesh_api_env(deployment)),
)?;
compose
.services
Expand Down Expand Up @@ -223,7 +227,8 @@ pub fn render(deployment: &Deployment, data_dir: &Path) -> Result<PathBuf> {
if deployment.stacks_node.mode == ServiceMode::External
&& let Some(snippet) = apply_to_your_node(deployment)
{
std::fs::write(dir.join("apply-to-your-node.toml"), snippet)?;
// Carries the node auth token -> 0600.
secrets::write_0600(&dir.join("apply-to-your-node.toml"), &snippet)?;
}

Ok(dir)
Expand Down Expand Up @@ -838,7 +843,7 @@ mod tests {
// internal wiring is offset-blind: the API still reaches postgres
// and the node at their in-network ports
let env = api_env(&s);
assert!(env.contains("PG_PORT=5432"), "got: {env}");
assert!(env.contains("PG_PORT=5432"));
assert!(!env.contains("5532"), "offset leaked into internal wiring");

// the default deployment keeps the historical naming and ports
Expand All @@ -848,6 +853,26 @@ mod tests {
assert_eq!(node_service(&s).ports[0], "20443:20443");
}

Comment thread
rafa-stacks marked this conversation as resolved.
#[test]
fn secret_bearing_rendered_files_are_owner_only() {
use std::os::unix::fs::PermissionsExt;
let dir = std::env::temp_dir().join(format!("stacksup-perm-test-{}", std::process::id()));
let _ = std::fs::remove_dir_all(&dir);
std::fs::create_dir_all(&dir).unwrap();
render(&deployment(TESTNET_FULL), &dir).unwrap();
for f in [
"rendered/stacks-node/Config.toml",
"rendered/stacks-signer/signer.toml",
"rendered/stacks-api/.env",
"rendered/stacks-mesh-api/.env",
"rendered/secrets/pg_password",
] {
Comment thread
rafa-stacks marked this conversation as resolved.
let mode = std::fs::metadata(dir.join(f)).unwrap().permissions().mode();
assert_eq!(mode & 0o777, 0o600, "{f} should be 0600");
}
let _ = std::fs::remove_dir_all(&dir);
}

#[test]
fn compose_file_embeds_project_name() {
let dir = std::env::temp_dir().join(format!("stacksup-name-test-{}", std::process::id()));
Expand Down
Loading