1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
//! `clash debug` — composable debugging tools for policy enforcement.
//!
//! Provides subcommands to view audit logs, replay commands against
//! the current policy, and inspect sandbox enforcement details.
use anyhow::Result;
use clap::Subcommand;
use tracing::{Level, instrument};
/// Subcommands for `clash debug`.
#[derive(Subcommand, Debug)]
pub enum DebugCmd {
/// View audit log entries
Log {
/// Only show entries from sessions matching this substring
#[arg(long)]
session: Option<String>,
/// Exclude entries from sessions matching this substring
#[arg(long)]
exclude_session: Option<String>,
/// Show entries from the last duration (e.g., "5m", "1h", "30s")
#[arg(long)]
since: Option<String>,
/// Filter by effect: allow, deny, or ask
#[arg(long)]
effect: Option<String>,
/// Filter by tool name (e.g., Bash, Read)
#[arg(long)]
tool: Option<String>,
/// Maximum number of entries to show
#[arg(short = 'n', long, default_value = "50")]
limit: usize,
/// Output as JSON
#[arg(long)]
json: bool,
},
/// Re-evaluate a command against the current policy
Replay {
/// Tool type: bash, read, write, edit (or full name like Bash, Read, etc.)
tool: Option<String>,
/// The command, file path, or noun to check (remaining args joined)
#[arg(trailing_var_arg = true)]
args: Vec<String>,
/// Replay the last logged command
#[arg(long)]
last: bool,
/// Only consider entries from sessions matching this substring (for --last)
#[arg(long)]
session: Option<String>,
/// Output as JSON
#[arg(long)]
json: bool,
},
/// Show sandbox enforcement details for a command
Sandbox {
/// Tool type or audit log hash (e.g., bash, read, or a hex id from `clash debug log`)
tool: Option<String>,
/// The command, file path, or noun to inspect (remaining args joined)
#[arg(trailing_var_arg = true)]
args: Vec<String>,
/// Inspect the last logged command
#[arg(long)]
last: bool,
/// Actually execute the command under sandbox enforcement
#[arg(long, short = 'x')]
exec: bool,
/// Only consider entries from sessions matching this substring (for --last)
#[arg(long)]
session: Option<String>,
/// Output as JSON
#[arg(long)]
json: bool,
},
}
pub fn run(cmd: DebugCmd) -> Result<()> {
match cmd {
DebugCmd::Log {
session,
exclude_session,
since,
effect,
tool,
limit,
json,
} => run_log(session, exclude_session, since, effect, tool, limit, json),
DebugCmd::Replay {
tool,
args,
last,
session,
json,
} => run_replay(tool, args, last, session, json),
DebugCmd::Sandbox {
tool,
args,
last,
exec,
session,
json,
} => run_sandbox(tool, args, last, exec, session, json),
}
}
#[instrument(level = Level::TRACE)]
fn run_log(
session: Option<String>,
exclude_session: Option<String>,
since: Option<String>,
effect: Option<String>,
tool: Option<String>,
limit: usize,
json: bool,
) -> Result<()> {
use crate::debug::log;
// Always read all sessions — filtering happens via LogFilter.
let entries = log::read_all_session_logs()?;
let since_ts = if let Some(ref dur) = since {
let duration_secs = log::parse_duration(dur)?;
let now = std::time::SystemTime::now()
.duration_since(std::time::UNIX_EPOCH)
.unwrap_or_default()
.as_secs_f64();
Some(now - duration_secs)
} else {
None
};
let filter = log::LogFilter {
effect,
tool,
session,
exclude_session,
since: since_ts,
limit,
};
let filtered = log::filter_entries(entries, &filter);
if json {
println!("{}", log::format_json(&filtered)?);
} else {
println!("{}", log::format_table(&filtered));
}
Ok(())
}
fn run_replay(
tool: Option<String>,
args: Vec<String>,
last: bool,
session: Option<String>,
json: bool,
) -> Result<()> {
use crate::debug::replay;
let result = if last {
replay::replay_last(session.as_deref())?
} else {
let tool = tool.ok_or_else(|| {
anyhow::anyhow!(
"specify a tool to replay, e.g.: clash debug replay bash \"git push\"\n\
or pass an id from `clash debug log`: clash debug replay <id>\n\
or use --last to replay the most recent logged command"
)
})?;
// If the argument looks like a hex hash and there are no extra args,
// look it up in the audit log.
if args.is_empty() && tool.len() <= 7 && tool.chars().all(|c| c.is_ascii_hexdigit()) {
replay::replay_hash(&tool)?
} else {
let input = if args.is_empty() {
None
} else {
Some(args.join(" "))
};
let cwd = std::env::current_dir()
.map(|p| p.to_string_lossy().into_owned())
.unwrap_or_default();
replay::replay_from_args(&tool, input.as_deref(), &cwd, None)?
}
};
if json {
println!("{}", result.format_json()?);
} else {
println!("{}", result.format_human());
}
Ok(())
}
#[instrument(level = Level::TRACE)]
fn run_sandbox(
tool: Option<String>,
args: Vec<String>,
last: bool,
exec: bool,
session: Option<String>,
json: bool,
) -> Result<()> {
use crate::debug::sandbox;
// Resolve the audit log entry when using --last or a hash reference.
let resolved_entry = if last {
let mut entries = crate::debug::log::read_all_session_logs()?;
if let Some(filter) = session.as_deref() {
entries.retain(|e| e.session_id.contains(filter));
}
Some(
entries
.pop()
.ok_or_else(|| anyhow::anyhow!("no audit log entries found"))?,
)
} else if let Some(ref tool) = tool {
if args.is_empty() && tool.len() <= 7 && tool.chars().all(|c| c.is_ascii_hexdigit()) {
Some(crate::debug::log::find_by_hash(tool)?)
} else {
None
}
} else {
None
};
// --exec: actually run the command under sandbox enforcement.
if exec {
let entry = resolved_entry.ok_or_else(|| {
anyhow::anyhow!(
"--exec requires an audit log reference\n\
usage: clash debug sandbox --exec <id>\n\
usage: clash debug sandbox --exec --last"
)
})?;
return sandbox::exec_entry(&entry);
}
// Inspect mode (default).
let report = if let Some(entry) = resolved_entry {
sandbox::inspect_with_mode(
&entry.tool_name,
Some(&entry.tool_input_summary),
entry.mode.as_deref(),
)?
} else {
let tool = tool.ok_or_else(|| {
anyhow::anyhow!(
"specify a tool to inspect, e.g.: clash debug sandbox bash \"git push\"\n\
or pass an id from `clash debug log`: clash debug sandbox <id>\n\
or use --last to inspect the most recent logged command"
)
})?;
let input = if args.is_empty() {
None
} else {
Some(args.join(" "))
};
sandbox::inspect(&tool, input.as_deref())?
};
if json {
println!("{}", report.format_json()?);
} else {
println!("{}", report.format_human());
}
Ok(())
}