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
|
use std::env;
use chrono::Utc;
use atuin_common::utils::uuid_v7;
use regex::RegexSet;
use crate::{secrets::SECRET_PATTERNS, settings::Settings};
mod builder;
/// Client-side history entry.
///
/// Client stores data unencrypted, and only encrypts it before sending to the server.
///
/// To create a new history entry, use one of the builders:
/// - [`History::import()`] to import an entry from the shell history file
/// - [`History::capture()`] to capture an entry via hook
/// - [`History::from_db()`] to create an instance from the database entry
//
// ## Implementation Notes
//
// New fields must should be added to `encryption::{encode, decode}` in a backwards
// compatible way. (eg sensible defaults and updating the nfields parameter)
#[derive(Debug, Clone, PartialEq, Eq, sqlx::FromRow)]
pub struct History {
/// A client-generated ID, used to identify the entry when syncing.
///
/// Stored as `client_id` in the database.
pub id: String,
/// When the command was run.
pub timestamp: chrono::DateTime<Utc>,
/// How long the command took to run.
pub duration: i64,
/// The exit code of the command.
pub exit: i64,
/// The command that was run.
pub command: String,
/// The current working directory when the command was run.
pub cwd: String,
/// The session ID, associated with a terminal session.
pub session: String,
/// The hostname of the machine the command was run on.
pub hostname: String,
/// Timestamp, which is set when the entry is deleted, allowing a soft delete.
pub deleted_at: Option<chrono::DateTime<Utc>>,
}
impl History {
#[allow(clippy::too_many_arguments)]
fn new(
timestamp: chrono::DateTime<Utc>,
command: String,
cwd: String,
exit: i64,
duration: i64,
session: Option<String>,
hostname: Option<String>,
deleted_at: Option<chrono::DateTime<Utc>>,
) -> Self {
let session = session
.or_else(|| env::var("ATUIN_SESSION").ok())
.unwrap_or_else(|| uuid_v7().as_simple().to_string());
let hostname = hostname.unwrap_or_else(|| {
format!(
"{}:{}",
env::var("ATUIN_HOST_NAME").unwrap_or_else(|_| whoami::hostname()),
env::var("ATUIN_HOST_USER").unwrap_or_else(|_| whoami::username())
)
});
Self {
id: uuid_v7().as_simple().to_string(),
timestamp,
command,
cwd,
exit,
duration,
session,
hostname,
deleted_at,
}
}
/// Builder for a history entry that is imported from shell history.
///
/// The only two required fields are `timestamp` and `command`.
///
/// ## Examples
/// ```
/// use atuin_client::history::History;
///
/// let history: History = History::import()
/// .timestamp(chrono::Utc::now())
/// .command("ls -la")
/// .build()
/// .into();
/// ```
///
/// If shell history contains more information, it can be added to the builder:
/// ```
/// use atuin_client::history::History;
///
/// let history: History = History::import()
/// .timestamp(chrono::Utc::now())
/// .command("ls -la")
/// .cwd("/home/user")
/// .exit(0)
/// .duration(100)
/// .build()
/// .into();
/// ```
///
/// Unknown command or command without timestamp cannot be imported, which
/// is forced at compile time:
///
/// ```compile_fail
/// use atuin_client::history::History;
///
/// // this will not compile because timestamp is missing
/// let history: History = History::import()
/// .command("ls -la")
/// .build()
/// .into();
/// ```
pub fn import() -> builder::HistoryImportedBuilder {
builder::HistoryImported::builder()
}
/// Builder for a history entry that is captured via hook.
///
/// This builder is used only at the `start` step of the hook,
/// so it doesn't have any fields which are known only after
/// the command is finished, such as `exit` or `duration`.
///
/// ## Examples
/// ```rust
/// use atuin_client::history::History;
///
/// let history: History = History::capture()
/// .timestamp(chrono::Utc::now())
/// .command("ls -la")
/// .cwd("/home/user")
/// .build()
/// .into();
/// ```
///
/// Command without any required info cannot be captured, which is forced at compile time:
///
/// ```compile_fail
/// use atuin_client::history::History;
///
/// // this will not compile because `cwd` is missing
/// let history: History = History::capture()
/// .timestamp(chrono::Utc::now())
/// .command("ls -la")
/// .build()
/// .into();
/// ```
pub fn capture() -> builder::HistoryCapturedBuilder {
builder::HistoryCaptured::builder()
}
/// Builder for a history entry that is imported from the database.
///
/// All fields are required, as they are all present in the database.
///
/// ```compile_fail
/// use atuin_client::history::History;
///
/// // this will not compile because `id` field is missing
/// let history: History = History::from_db()
/// .timestamp(chrono::Utc::now())
/// .command("ls -la".to_string())
/// .cwd("/home/user".to_string())
/// .exit(0)
/// .duration(100)
/// .session("somesession".to_string())
/// .hostname("localhost".to_string())
/// .deleted_at(None)
/// .build()
/// .into();
/// ```
pub fn from_db() -> builder::HistoryFromDbBuilder {
builder::HistoryFromDb::builder()
}
pub fn success(&self) -> bool {
self.exit == 0 || self.duration == -1
}
pub fn should_save(&self, settings: &Settings) -> bool {
let secret_regex = SECRET_PATTERNS.iter().map(|f| f.1);
let secret_regex = RegexSet::new(secret_regex).expect("Failed to build secrets regex");
!(self.command.starts_with(' ')
|| settings.history_filter.is_match(&self.command)
|| settings.cwd_filter.is_match(&self.cwd)
|| (secret_regex.is_match(&self.command)) && settings.secrets_filter)
}
}
#[cfg(test)]
mod tests {
use regex::RegexSet;
use crate::settings::Settings;
use super::History;
// Test that we don't save history where necessary
#[test]
fn privacy_test() {
let mut settings = Settings::default();
settings.cwd_filter = RegexSet::new(["^/supasecret"]).unwrap();
settings.history_filter = RegexSet::new(["^psql"]).unwrap();
let normal_command: History = History::capture()
.timestamp(chrono::Utc::now())
.command("echo foo")
.cwd("/")
.build()
.into();
let with_space: History = History::capture()
.timestamp(chrono::Utc::now())
.command(" echo bar")
.cwd("/")
.build()
.into();
let stripe_key: History = History::capture()
.timestamp(chrono::Utc::now())
.command("curl foo.com/bar?key=sk_test_1234567890abcdefghijklmnop")
.cwd("/")
.build()
.into();
let secret_dir: History = History::capture()
.timestamp(chrono::Utc::now())
.command("echo ohno")
.cwd("/supasecret")
.build()
.into();
let with_psql: History = History::capture()
.timestamp(chrono::Utc::now())
.command("psql")
.cwd("/supasecret")
.build()
.into();
assert!(normal_command.should_save(&settings));
assert!(!with_space.should_save(&settings));
assert!(!stripe_key.should_save(&settings));
assert!(!secret_dir.should_save(&settings));
assert!(!with_psql.should_save(&settings));
}
#[test]
fn disable_secrets() {
let mut settings = Settings::default();
settings.secrets_filter = false;
let stripe_key: History = History::capture()
.timestamp(chrono::Utc::now())
.command("curl foo.com/bar?key=sk_test_1234567890abcdefghijklmnop")
.cwd("/")
.build()
.into();
assert!(stripe_key.should_save(&settings));
}
}
|
