Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .jules/sentinel.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,8 @@
**Vulnerability:** The `maybe_write_text` utility function was using `std::fs::write`, which resulted in sensitive data (like PSBT files and offers) being saved with insecure default file permissions, making them readable by other users on a shared system.
**Learning:** Even generic utility functions used for saving user-requested command outputs must use secure file permissions (`0o600`) if the data they handle (like PSBTs and offers) is sensitive.
**Prevention:** Always use `crate::paths::write_secure_file` instead of `std::fs::write` for all file writing operations that might contain sensitive material in this codebase.

## 2024-03-24 - Path Traversal in Snapshot Management
**Vulnerability:** The `snapshot` command directly interpolated user-provided names into file paths (`snap_dir.join(format!("{name}.json"))`) without validation.
**Learning:** This allowed path traversal (e.g., `../something`) which could lead to arbitrary file reads or writes outside the dedicated snapshot directory, potentially exposing sensitive data.
**Prevention:** Always sanitize and validate user-provided file names using an explicit allowlist (like `crate::utils::validate_file_name`) before joining them to directory paths.
2 changes: 2 additions & 0 deletions src/commands/snapshot.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ pub async fn run(cli: &Cli, args: &SnapshotArgs) -> Result<CommandOutput, AppErr

match &args.action {
SnapshotAction::Save { name, overwrite } => {
crate::utils::validate_file_name(name)?;
let source = read_profile(&profile_path)?;
let destination = snap_dir.join(format!("{name}.json"));
if destination.exists() && !(*overwrite || cli.yes) {
Expand All @@ -27,6 +28,7 @@ pub async fn run(cli: &Cli, args: &SnapshotArgs) -> Result<CommandOutput, AppErr
})
}
SnapshotAction::Restore { name } => {
crate::utils::validate_file_name(name)?;
if !confirm(&format!("Are you sure you want to restore snapshot '{name}'? This will overwrite your current profile."), cli) {
return Err(AppError::Internal("aborted by user".to_string()));
}
Expand Down
33 changes: 33 additions & 0 deletions src/utils.rs
Original file line number Diff line number Diff line change
Expand Up @@ -219,3 +219,36 @@ pub fn parse_indices(s: Option<&str>) -> Result<Vec<usize>, AppError> {
}
Ok(indices)
}

pub fn validate_file_name(name: &str) -> Result<(), AppError> {
if name.is_empty() {
return Err(AppError::Invalid("file name cannot be empty".to_string()));
}
for c in name.chars() {
if !c.is_ascii_alphanumeric() && c != '_' && c != '-' {
return Err(AppError::Invalid(format!(
"invalid character in file name: '{}'",
c
)));
}
}
Ok(())
}

#[cfg(test)]
mod tests {
use super::*;

#[test]
fn test_validate_file_name() {
assert!(validate_file_name("valid_name-123").is_ok());
assert!(validate_file_name("valid").is_ok());

assert!(validate_file_name("").is_err());
assert!(validate_file_name("../invalid").is_err());
assert!(validate_file_name("invalid/name").is_err());
assert!(validate_file_name("invalid\\name").is_err());
assert!(validate_file_name("invalid name").is_err());
assert!(validate_file_name("invalid.name").is_err());
}
}
Loading