]>
Commit | Line | Data |
---|---|---|
1 | //#[macro_use] | |
2 | extern crate proxmox_backup; | |
3 | ||
4 | use failure::*; | |
5 | //use std::os::unix::io::AsRawFd; | |
6 | use chrono::{Local, TimeZone}; | |
7 | use std::path::{Path, PathBuf}; | |
8 | use std::collections::HashMap; | |
9 | ||
10 | use proxmox_backup::tools; | |
11 | use proxmox_backup::cli::*; | |
12 | use proxmox_backup::api_schema::*; | |
13 | use proxmox_backup::api_schema::router::*; | |
14 | use proxmox_backup::client::*; | |
15 | use proxmox_backup::backup::*; | |
16 | //use proxmox_backup::backup::image_index::*; | |
17 | //use proxmox_backup::config::datastore; | |
18 | //use proxmox_backup::pxar::encoder::*; | |
19 | //use proxmox_backup::backup::datastore::*; | |
20 | ||
21 | use serde_json::{json, Value}; | |
22 | //use hyper::Body; | |
23 | use std::sync::Arc; | |
24 | use regex::Regex; | |
25 | use xdg::BaseDirectories; | |
26 | ||
27 | use lazy_static::lazy_static; | |
28 | use futures::*; | |
29 | use tokio::sync::mpsc; | |
30 | ||
31 | lazy_static! { | |
32 | static ref BACKUPSPEC_REGEX: Regex = Regex::new(r"^([a-zA-Z0-9_-]+\.(?:pxar|img|conf)):(.+)$").unwrap(); | |
33 | ||
34 | static ref REPO_URL_SCHEMA: Arc<Schema> = Arc::new( | |
35 | StringSchema::new("Repository URL.") | |
36 | .format(BACKUP_REPO_URL.clone()) | |
37 | .max_length(256) | |
38 | .into() | |
39 | ); | |
40 | } | |
41 | ||
42 | ||
43 | fn record_repository(repo: &BackupRepository) { | |
44 | ||
45 | let base = match BaseDirectories::with_prefix("proxmox-backup") { | |
46 | Ok(v) => v, | |
47 | _ => return, | |
48 | }; | |
49 | ||
50 | // usually $HOME/.cache/proxmox-backup/repo-list | |
51 | let path = match base.place_cache_file("repo-list") { | |
52 | Ok(v) => v, | |
53 | _ => return, | |
54 | }; | |
55 | ||
56 | let mut data = tools::file_get_json(&path, None).unwrap_or(json!({})); | |
57 | ||
58 | let repo = repo.to_string(); | |
59 | ||
60 | data[&repo] = json!{ data[&repo].as_i64().unwrap_or(0) + 1 }; | |
61 | ||
62 | let mut map = serde_json::map::Map::new(); | |
63 | ||
64 | loop { | |
65 | let mut max_used = 0; | |
66 | let mut max_repo = None; | |
67 | for (repo, count) in data.as_object().unwrap() { | |
68 | if map.contains_key(repo) { continue; } | |
69 | if let Some(count) = count.as_i64() { | |
70 | if count > max_used { | |
71 | max_used = count; | |
72 | max_repo = Some(repo); | |
73 | } | |
74 | } | |
75 | } | |
76 | if let Some(repo) = max_repo { | |
77 | map.insert(repo.to_owned(), json!(max_used)); | |
78 | } else { | |
79 | break; | |
80 | } | |
81 | if map.len() > 10 { // store max. 10 repos | |
82 | break; | |
83 | } | |
84 | } | |
85 | ||
86 | let new_data = json!(map); | |
87 | ||
88 | let _ = tools::file_set_contents(path, new_data.to_string().as_bytes(), None); | |
89 | } | |
90 | ||
91 | fn complete_repository(_arg: &str, _param: &HashMap<String, String>) -> Vec<String> { | |
92 | ||
93 | let mut result = vec![]; | |
94 | ||
95 | let base = match BaseDirectories::with_prefix("proxmox-backup") { | |
96 | Ok(v) => v, | |
97 | _ => return result, | |
98 | }; | |
99 | ||
100 | // usually $HOME/.cache/proxmox-backup/repo-list | |
101 | let path = match base.place_cache_file("repo-list") { | |
102 | Ok(v) => v, | |
103 | _ => return result, | |
104 | }; | |
105 | ||
106 | let data = tools::file_get_json(&path, None).unwrap_or(json!({})); | |
107 | ||
108 | if let Some(map) = data.as_object() { | |
109 | for (repo, _count) in map { | |
110 | result.push(repo.to_owned()); | |
111 | } | |
112 | } | |
113 | ||
114 | result | |
115 | } | |
116 | ||
117 | fn backup_directory<P: AsRef<Path>>( | |
118 | client: &BackupClient, | |
119 | dir_path: P, | |
120 | archive_name: &str, | |
121 | chunk_size: Option<usize>, | |
122 | all_file_systems: bool, | |
123 | verbose: bool, | |
124 | crypt_config: Option<Arc<CryptConfig>>, | |
125 | ) -> Result<(), Error> { | |
126 | ||
127 | let pxar_stream = PxarBackupStream::open(dir_path.as_ref(), all_file_systems, verbose)?; | |
128 | let chunk_stream = ChunkStream::new(pxar_stream, chunk_size); | |
129 | ||
130 | let (tx, rx) = mpsc::channel(10); // allow to buffer 10 chunks | |
131 | ||
132 | let stream = rx | |
133 | .map_err(Error::from) | |
134 | .and_then(|x| x); // flatten | |
135 | ||
136 | // spawn chunker inside a separate task so that it can run parallel | |
137 | tokio::spawn( | |
138 | tx.send_all(chunk_stream.then(|r| Ok(r))) | |
139 | .map_err(|_| {}).map(|_| ()) | |
140 | ); | |
141 | ||
142 | client.upload_stream(archive_name, stream, "dynamic", None, crypt_config).wait()?; | |
143 | ||
144 | Ok(()) | |
145 | } | |
146 | ||
147 | fn backup_image<P: AsRef<Path>>( | |
148 | client: &BackupClient, | |
149 | image_path: P, | |
150 | archive_name: &str, | |
151 | image_size: u64, | |
152 | chunk_size: Option<usize>, | |
153 | _verbose: bool, | |
154 | crypt_config: Option<Arc<CryptConfig>>, | |
155 | ) -> Result<(), Error> { | |
156 | ||
157 | let path = image_path.as_ref().to_owned(); | |
158 | ||
159 | let file = tokio::fs::File::open(path).wait()?; | |
160 | ||
161 | let stream = tokio::codec::FramedRead::new(file, tokio::codec::BytesCodec::new()) | |
162 | .map_err(Error::from); | |
163 | ||
164 | let stream = FixedChunkStream::new(stream, chunk_size.unwrap_or(4*1024*1024)); | |
165 | ||
166 | client.upload_stream(archive_name, stream, "fixed", Some(image_size), crypt_config).wait()?; | |
167 | ||
168 | Ok(()) | |
169 | } | |
170 | ||
171 | fn strip_chunked_file_expenstions(list: Vec<String>) -> Vec<String> { | |
172 | ||
173 | let mut result = vec![]; | |
174 | ||
175 | for file in list.into_iter() { | |
176 | if file.ends_with(".didx") { | |
177 | result.push(file[..file.len()-5].to_owned()); | |
178 | } else if file.ends_with(".fidx") { | |
179 | result.push(file[..file.len()-5].to_owned()); | |
180 | } else { | |
181 | result.push(file); // should not happen | |
182 | } | |
183 | } | |
184 | ||
185 | result | |
186 | } | |
187 | ||
188 | /* not used: | |
189 | fn list_backups( | |
190 | param: Value, | |
191 | _info: &ApiMethod, | |
192 | _rpcenv: &mut dyn RpcEnvironment, | |
193 | ) -> Result<Value, Error> { | |
194 | ||
195 | let repo_url = tools::required_string_param(¶m, "repository")?; | |
196 | let repo: BackupRepository = repo_url.parse()?; | |
197 | ||
198 | let mut client = HttpClient::new(repo.host(), repo.user())?; | |
199 | ||
200 | let path = format!("api2/json/admin/datastore/{}/backups", repo.store()); | |
201 | ||
202 | let result = client.get(&path, None)?; | |
203 | ||
204 | record_repository(&repo); | |
205 | ||
206 | // fixme: implement and use output formatter instead .. | |
207 | let list = result["data"].as_array().unwrap(); | |
208 | ||
209 | for item in list { | |
210 | ||
211 | let id = item["backup-id"].as_str().unwrap(); | |
212 | let btype = item["backup-type"].as_str().unwrap(); | |
213 | let epoch = item["backup-time"].as_i64().unwrap(); | |
214 | ||
215 | let backup_dir = BackupDir::new(btype, id, epoch); | |
216 | ||
217 | let files = item["files"].as_array().unwrap().iter().map(|v| v.as_str().unwrap().to_owned()).collect(); | |
218 | let files = strip_chunked_file_expenstions(files); | |
219 | ||
220 | for filename in files { | |
221 | let path = backup_dir.relative_path().to_str().unwrap().to_owned(); | |
222 | println!("{} | {}/{}", backup_dir.backup_time().format("%c"), path, filename); | |
223 | } | |
224 | } | |
225 | ||
226 | //Ok(result) | |
227 | Ok(Value::Null) | |
228 | } | |
229 | */ | |
230 | ||
231 | fn list_backup_groups( | |
232 | param: Value, | |
233 | _info: &ApiMethod, | |
234 | _rpcenv: &mut dyn RpcEnvironment, | |
235 | ) -> Result<Value, Error> { | |
236 | ||
237 | let repo_url = tools::required_string_param(¶m, "repository")?; | |
238 | let repo: BackupRepository = repo_url.parse()?; | |
239 | ||
240 | let client = HttpClient::new(repo.host(), repo.user())?; | |
241 | ||
242 | let path = format!("api2/json/admin/datastore/{}/groups", repo.store()); | |
243 | ||
244 | let mut result = client.get(&path, None).wait()?; | |
245 | ||
246 | record_repository(&repo); | |
247 | ||
248 | // fixme: implement and use output formatter instead .. | |
249 | let list = result["data"].as_array_mut().unwrap(); | |
250 | ||
251 | list.sort_unstable_by(|a, b| { | |
252 | let a_id = a["backup-id"].as_str().unwrap(); | |
253 | let a_backup_type = a["backup-type"].as_str().unwrap(); | |
254 | let b_id = b["backup-id"].as_str().unwrap(); | |
255 | let b_backup_type = b["backup-type"].as_str().unwrap(); | |
256 | ||
257 | let type_order = a_backup_type.cmp(b_backup_type); | |
258 | if type_order == std::cmp::Ordering::Equal { | |
259 | a_id.cmp(b_id) | |
260 | } else { | |
261 | type_order | |
262 | } | |
263 | }); | |
264 | ||
265 | for item in list { | |
266 | ||
267 | let id = item["backup-id"].as_str().unwrap(); | |
268 | let btype = item["backup-type"].as_str().unwrap(); | |
269 | let epoch = item["last-backup"].as_i64().unwrap(); | |
270 | let last_backup = Local.timestamp(epoch, 0); | |
271 | let backup_count = item["backup-count"].as_u64().unwrap(); | |
272 | ||
273 | let group = BackupGroup::new(btype, id); | |
274 | ||
275 | let path = group.group_path().to_str().unwrap().to_owned(); | |
276 | ||
277 | let files = item["files"].as_array().unwrap().iter().map(|v| v.as_str().unwrap().to_owned()).collect(); | |
278 | let files = strip_chunked_file_expenstions(files); | |
279 | ||
280 | println!("{:20} | {} | {:5} | {}", path, last_backup.format("%c"), | |
281 | backup_count, tools::join(&files, ' ')); | |
282 | } | |
283 | ||
284 | //Ok(result) | |
285 | Ok(Value::Null) | |
286 | } | |
287 | ||
288 | fn list_snapshots( | |
289 | param: Value, | |
290 | _info: &ApiMethod, | |
291 | _rpcenv: &mut dyn RpcEnvironment, | |
292 | ) -> Result<Value, Error> { | |
293 | ||
294 | let repo_url = tools::required_string_param(¶m, "repository")?; | |
295 | let repo: BackupRepository = repo_url.parse()?; | |
296 | ||
297 | let path = tools::required_string_param(¶m, "group")?; | |
298 | let group = BackupGroup::parse(path)?; | |
299 | ||
300 | let client = HttpClient::new(repo.host(), repo.user())?; | |
301 | ||
302 | let path = format!("api2/json/admin/datastore/{}/snapshots", repo.store()); | |
303 | ||
304 | let result = client.get(&path, Some(json!({ | |
305 | "backup-type": group.backup_type(), | |
306 | "backup-id": group.backup_id(), | |
307 | }))).wait()?; | |
308 | ||
309 | record_repository(&repo); | |
310 | ||
311 | // fixme: implement and use output formatter instead .. | |
312 | let list = result["data"].as_array().unwrap(); | |
313 | ||
314 | for item in list { | |
315 | ||
316 | let id = item["backup-id"].as_str().unwrap(); | |
317 | let btype = item["backup-type"].as_str().unwrap(); | |
318 | let epoch = item["backup-time"].as_i64().unwrap(); | |
319 | ||
320 | let snapshot = BackupDir::new(btype, id, epoch); | |
321 | ||
322 | let path = snapshot.relative_path().to_str().unwrap().to_owned(); | |
323 | ||
324 | let files = item["files"].as_array().unwrap().iter().map(|v| v.as_str().unwrap().to_owned()).collect(); | |
325 | let files = strip_chunked_file_expenstions(files); | |
326 | ||
327 | println!("{} | {} | {}", path, snapshot.backup_time().format("%c"), tools::join(&files, ' ')); | |
328 | } | |
329 | ||
330 | Ok(Value::Null) | |
331 | } | |
332 | ||
333 | fn forget_snapshots( | |
334 | param: Value, | |
335 | _info: &ApiMethod, | |
336 | _rpcenv: &mut dyn RpcEnvironment, | |
337 | ) -> Result<Value, Error> { | |
338 | ||
339 | let repo_url = tools::required_string_param(¶m, "repository")?; | |
340 | let repo: BackupRepository = repo_url.parse()?; | |
341 | ||
342 | let path = tools::required_string_param(¶m, "snapshot")?; | |
343 | let snapshot = BackupDir::parse(path)?; | |
344 | ||
345 | let mut client = HttpClient::new(repo.host(), repo.user())?; | |
346 | ||
347 | let path = format!("api2/json/admin/datastore/{}/snapshots", repo.store()); | |
348 | ||
349 | let result = client.delete(&path, Some(json!({ | |
350 | "backup-type": snapshot.group().backup_type(), | |
351 | "backup-id": snapshot.group().backup_id(), | |
352 | "backup-time": snapshot.backup_time().timestamp(), | |
353 | }))).wait()?; | |
354 | ||
355 | record_repository(&repo); | |
356 | ||
357 | Ok(result) | |
358 | } | |
359 | ||
360 | fn start_garbage_collection( | |
361 | param: Value, | |
362 | _info: &ApiMethod, | |
363 | _rpcenv: &mut dyn RpcEnvironment, | |
364 | ) -> Result<Value, Error> { | |
365 | ||
366 | let repo_url = tools::required_string_param(¶m, "repository")?; | |
367 | let repo: BackupRepository = repo_url.parse()?; | |
368 | ||
369 | let mut client = HttpClient::new(repo.host(), repo.user())?; | |
370 | ||
371 | let path = format!("api2/json/admin/datastore/{}/gc", repo.store()); | |
372 | ||
373 | let result = client.post(&path, None).wait()?; | |
374 | ||
375 | record_repository(&repo); | |
376 | ||
377 | Ok(result) | |
378 | } | |
379 | ||
380 | fn parse_backupspec(value: &str) -> Result<(&str, &str), Error> { | |
381 | ||
382 | if let Some(caps) = BACKUPSPEC_REGEX.captures(value) { | |
383 | return Ok((caps.get(1).unwrap().as_str(), caps.get(2).unwrap().as_str())); | |
384 | } | |
385 | bail!("unable to parse directory specification '{}'", value); | |
386 | } | |
387 | ||
388 | fn create_backup( | |
389 | param: Value, | |
390 | _info: &ApiMethod, | |
391 | _rpcenv: &mut dyn RpcEnvironment, | |
392 | ) -> Result<Value, Error> { | |
393 | ||
394 | let repo_url = tools::required_string_param(¶m, "repository")?; | |
395 | ||
396 | let backupspec_list = tools::required_array_param(¶m, "backupspec")?; | |
397 | ||
398 | let repo: BackupRepository = repo_url.parse()?; | |
399 | ||
400 | let all_file_systems = param["all-file-systems"].as_bool().unwrap_or(false); | |
401 | ||
402 | let verbose = param["verbose"].as_bool().unwrap_or(false); | |
403 | ||
404 | let chunk_size_opt = param["chunk-size"].as_u64().map(|v| (v*1024) as usize); | |
405 | ||
406 | if let Some(size) = chunk_size_opt { | |
407 | verify_chunk_size(size)?; | |
408 | } | |
409 | ||
410 | let keyfile = param["keyfile"].as_str().map(|p| PathBuf::from(p)); | |
411 | ||
412 | let backup_id = param["host-id"].as_str().unwrap_or(&tools::nodename()); | |
413 | ||
414 | let mut upload_list = vec![]; | |
415 | ||
416 | enum BackupType { PXAR, IMAGE, CONFIG }; | |
417 | ||
418 | for backupspec in backupspec_list { | |
419 | let (target, filename) = parse_backupspec(backupspec.as_str().unwrap())?; | |
420 | ||
421 | use std::os::unix::fs::FileTypeExt; | |
422 | ||
423 | let metadata = match std::fs::metadata(filename) { | |
424 | Ok(m) => m, | |
425 | Err(err) => bail!("unable to access '{}' - {}", filename, err), | |
426 | }; | |
427 | let file_type = metadata.file_type(); | |
428 | ||
429 | let extension = Path::new(target).extension().map(|s| s.to_str().unwrap()).unwrap(); | |
430 | ||
431 | match extension { | |
432 | "pxar" => { | |
433 | if !file_type.is_dir() { | |
434 | bail!("got unexpected file type (expected directory)"); | |
435 | } | |
436 | upload_list.push((BackupType::PXAR, filename.to_owned(), target.to_owned(), 0)); | |
437 | } | |
438 | "img" => { | |
439 | ||
440 | if !(file_type.is_file() || file_type.is_block_device()) { | |
441 | bail!("got unexpected file type (expected file or block device)"); | |
442 | } | |
443 | ||
444 | let size = tools::image_size(&PathBuf::from(filename))?; | |
445 | ||
446 | if size == 0 { bail!("got zero-sized file '{}'", filename); } | |
447 | ||
448 | upload_list.push((BackupType::IMAGE, filename.to_owned(), target.to_owned(), size)); | |
449 | } | |
450 | "conf" => { | |
451 | if !file_type.is_file() { | |
452 | bail!("got unexpected file type (expected regular file)"); | |
453 | } | |
454 | upload_list.push((BackupType::CONFIG, filename.to_owned(), target.to_owned(), metadata.len())); | |
455 | } | |
456 | _ => { | |
457 | bail!("got unknown archive extension '{}'", extension); | |
458 | } | |
459 | } | |
460 | } | |
461 | ||
462 | let backup_time = Local.timestamp(Local::now().timestamp(), 0); | |
463 | ||
464 | let client = HttpClient::new(repo.host(), repo.user())?; | |
465 | record_repository(&repo); | |
466 | ||
467 | println!("Starting backup"); | |
468 | println!("Client name: {}", tools::nodename()); | |
469 | println!("Start Time: {}", backup_time.to_rfc3339()); | |
470 | ||
471 | let crypt_config = match keyfile { | |
472 | None => None, | |
473 | Some(path) => { | |
474 | let (key, _) = load_and_decrtypt_key(&path, get_encryption_key_password)?; | |
475 | Some(Arc::new(CryptConfig::new(key)?)) | |
476 | } | |
477 | }; | |
478 | ||
479 | let client = client.start_backup(repo.store(), "host", &backup_id, verbose).wait()?; | |
480 | ||
481 | for (backup_type, filename, target, size) in upload_list { | |
482 | match backup_type { | |
483 | BackupType::CONFIG => { | |
484 | println!("Upload config file '{}' to '{:?}' as {}", filename, repo, target); | |
485 | client.upload_blob(&filename, &target, crypt_config.clone(), true).wait()?; | |
486 | } | |
487 | BackupType::PXAR => { | |
488 | println!("Upload directory '{}' to '{:?}' as {}", filename, repo, target); | |
489 | backup_directory( | |
490 | &client, | |
491 | &filename, | |
492 | &target, | |
493 | chunk_size_opt, | |
494 | all_file_systems, | |
495 | verbose, | |
496 | crypt_config.clone(), | |
497 | )?; | |
498 | } | |
499 | BackupType::IMAGE => { | |
500 | println!("Upload image '{}' to '{:?}' as {}", filename, repo, target); | |
501 | backup_image( | |
502 | &client, | |
503 | &filename, | |
504 | &target, | |
505 | size, | |
506 | chunk_size_opt, | |
507 | verbose, | |
508 | crypt_config.clone(), | |
509 | )?; | |
510 | } | |
511 | } | |
512 | } | |
513 | ||
514 | client.finish().wait()?; | |
515 | ||
516 | let end_time = Local.timestamp(Local::now().timestamp(), 0); | |
517 | let elapsed = end_time.signed_duration_since(backup_time); | |
518 | println!("Duration: {}", elapsed); | |
519 | ||
520 | println!("End Time: {}", end_time.to_rfc3339()); | |
521 | ||
522 | Ok(Value::Null) | |
523 | } | |
524 | ||
525 | fn complete_backup_source(arg: &str, param: &HashMap<String, String>) -> Vec<String> { | |
526 | ||
527 | let mut result = vec![]; | |
528 | ||
529 | let data: Vec<&str> = arg.splitn(2, ':').collect(); | |
530 | ||
531 | if data.len() != 2 { | |
532 | result.push(String::from("root.pxar:/")); | |
533 | result.push(String::from("etc.pxar:/etc")); | |
534 | return result; | |
535 | } | |
536 | ||
537 | let files = tools::complete_file_name(data[1], param); | |
538 | ||
539 | for file in files { | |
540 | result.push(format!("{}:{}", data[0], file)); | |
541 | } | |
542 | ||
543 | result | |
544 | } | |
545 | ||
546 | fn restore( | |
547 | param: Value, | |
548 | _info: &ApiMethod, | |
549 | _rpcenv: &mut dyn RpcEnvironment, | |
550 | ) -> Result<Value, Error> { | |
551 | ||
552 | let repo_url = tools::required_string_param(¶m, "repository")?; | |
553 | let repo: BackupRepository = repo_url.parse()?; | |
554 | ||
555 | let archive_name = tools::required_string_param(¶m, "archive-name")?; | |
556 | ||
557 | let mut client = HttpClient::new(repo.host(), repo.user())?; | |
558 | ||
559 | record_repository(&repo); | |
560 | ||
561 | let path = tools::required_string_param(¶m, "snapshot")?; | |
562 | ||
563 | let query; | |
564 | ||
565 | if path.matches('/').count() == 1 { | |
566 | let group = BackupGroup::parse(path)?; | |
567 | ||
568 | let path = format!("api2/json/admin/datastore/{}/snapshots", repo.store()); | |
569 | let result = client.get(&path, Some(json!({ | |
570 | "backup-type": group.backup_type(), | |
571 | "backup-id": group.backup_id(), | |
572 | }))).wait()?; | |
573 | ||
574 | let list = result["data"].as_array().unwrap(); | |
575 | if list.len() == 0 { | |
576 | bail!("backup group '{}' does not contain any snapshots:", path); | |
577 | } | |
578 | ||
579 | query = tools::json_object_to_query(json!({ | |
580 | "backup-type": group.backup_type(), | |
581 | "backup-id": group.backup_id(), | |
582 | "backup-time": list[0]["backup-time"].as_i64().unwrap(), | |
583 | "archive-name": archive_name, | |
584 | }))?; | |
585 | } else { | |
586 | let snapshot = BackupDir::parse(path)?; | |
587 | ||
588 | query = tools::json_object_to_query(json!({ | |
589 | "backup-type": snapshot.group().backup_type(), | |
590 | "backup-id": snapshot.group().backup_id(), | |
591 | "backup-time": snapshot.backup_time().timestamp(), | |
592 | "archive-name": archive_name, | |
593 | }))?; | |
594 | } | |
595 | ||
596 | let target = tools::required_string_param(¶m, "target")?; | |
597 | ||
598 | if archive_name.ends_with(".pxar") { | |
599 | let path = format!("api2/json/admin/datastore/{}/pxar?{}", repo.store(), query); | |
600 | ||
601 | println!("DOWNLOAD FILE {} to {}", path, target); | |
602 | ||
603 | let target = PathBuf::from(target); | |
604 | let writer = PxarDecodeWriter::new(&target, true)?; | |
605 | client.download(&path, Box::new(writer)).wait()?; | |
606 | } else { | |
607 | bail!("unknown file extensions - unable to download '{}'", archive_name); | |
608 | } | |
609 | ||
610 | Ok(Value::Null) | |
611 | } | |
612 | ||
613 | fn prune( | |
614 | mut param: Value, | |
615 | _info: &ApiMethod, | |
616 | _rpcenv: &mut dyn RpcEnvironment, | |
617 | ) -> Result<Value, Error> { | |
618 | ||
619 | let repo_url = tools::required_string_param(¶m, "repository")?; | |
620 | let repo: BackupRepository = repo_url.parse()?; | |
621 | ||
622 | let mut client = HttpClient::new(repo.host(), repo.user())?; | |
623 | ||
624 | let path = format!("api2/json/admin/datastore/{}/prune", repo.store()); | |
625 | ||
626 | param.as_object_mut().unwrap().remove("repository"); | |
627 | ||
628 | let result = client.post(&path, Some(param)).wait()?; | |
629 | ||
630 | record_repository(&repo); | |
631 | ||
632 | Ok(result) | |
633 | } | |
634 | ||
635 | // like get, but simply ignore errors and return Null instead | |
636 | fn try_get(repo: &BackupRepository, url: &str) -> Value { | |
637 | ||
638 | let client = match HttpClient::new(repo.host(), repo.user()) { | |
639 | Ok(v) => v, | |
640 | _ => return Value::Null, | |
641 | }; | |
642 | ||
643 | let mut resp = match client.get(url, None).wait() { | |
644 | Ok(v) => v, | |
645 | _ => return Value::Null, | |
646 | }; | |
647 | ||
648 | if let Some(map) = resp.as_object_mut() { | |
649 | if let Some(data) = map.remove("data") { | |
650 | return data; | |
651 | } | |
652 | } | |
653 | Value::Null | |
654 | } | |
655 | ||
656 | fn extract_repo(param: &HashMap<String, String>) -> Option<BackupRepository> { | |
657 | ||
658 | let repo_url = match param.get("repository") { | |
659 | Some(v) => v, | |
660 | _ => return None, | |
661 | }; | |
662 | ||
663 | let repo: BackupRepository = match repo_url.parse() { | |
664 | Ok(v) => v, | |
665 | _ => return None, | |
666 | }; | |
667 | ||
668 | Some(repo) | |
669 | } | |
670 | ||
671 | fn complete_backup_group(_arg: &str, param: &HashMap<String, String>) -> Vec<String> { | |
672 | ||
673 | let mut result = vec![]; | |
674 | ||
675 | let repo = match extract_repo(param) { | |
676 | Some(v) => v, | |
677 | _ => return result, | |
678 | }; | |
679 | ||
680 | let path = format!("api2/json/admin/datastore/{}/groups", repo.store()); | |
681 | ||
682 | let data = try_get(&repo, &path); | |
683 | ||
684 | if let Some(list) = data.as_array() { | |
685 | for item in list { | |
686 | if let (Some(backup_id), Some(backup_type)) = | |
687 | (item["backup-id"].as_str(), item["backup-type"].as_str()) | |
688 | { | |
689 | result.push(format!("{}/{}", backup_type, backup_id)); | |
690 | } | |
691 | } | |
692 | } | |
693 | ||
694 | result | |
695 | } | |
696 | ||
697 | fn complete_group_or_snapshot(arg: &str, param: &HashMap<String, String>) -> Vec<String> { | |
698 | ||
699 | let mut result = vec![]; | |
700 | ||
701 | let repo = match extract_repo(param) { | |
702 | Some(v) => v, | |
703 | _ => return result, | |
704 | }; | |
705 | ||
706 | if arg.matches('/').count() < 2 { | |
707 | let groups = complete_backup_group(arg, param); | |
708 | for group in groups { | |
709 | result.push(group.to_string()); | |
710 | result.push(format!("{}/", group)); | |
711 | } | |
712 | return result; | |
713 | } | |
714 | ||
715 | let mut parts = arg.split('/'); | |
716 | let query = tools::json_object_to_query(json!({ | |
717 | "backup-type": parts.next().unwrap(), | |
718 | "backup-id": parts.next().unwrap(), | |
719 | })).unwrap(); | |
720 | ||
721 | let path = format!("api2/json/admin/datastore/{}/snapshots?{}", repo.store(), query); | |
722 | ||
723 | let data = try_get(&repo, &path); | |
724 | ||
725 | if let Some(list) = data.as_array() { | |
726 | for item in list { | |
727 | if let (Some(backup_id), Some(backup_type), Some(backup_time)) = | |
728 | (item["backup-id"].as_str(), item["backup-type"].as_str(), item["backup-time"].as_i64()) | |
729 | { | |
730 | let snapshot = BackupDir::new(backup_type, backup_id, backup_time); | |
731 | result.push(snapshot.relative_path().to_str().unwrap().to_owned()); | |
732 | } | |
733 | } | |
734 | } | |
735 | ||
736 | result | |
737 | } | |
738 | ||
739 | fn complete_archive_name(_arg: &str, param: &HashMap<String, String>) -> Vec<String> { | |
740 | ||
741 | let mut result = vec![]; | |
742 | ||
743 | let repo = match extract_repo(param) { | |
744 | Some(v) => v, | |
745 | _ => return result, | |
746 | }; | |
747 | ||
748 | let snapshot = match param.get("snapshot") { | |
749 | Some(path) => { | |
750 | match BackupDir::parse(path) { | |
751 | Ok(v) => v, | |
752 | _ => return result, | |
753 | } | |
754 | } | |
755 | _ => return result, | |
756 | }; | |
757 | ||
758 | let query = tools::json_object_to_query(json!({ | |
759 | "backup-type": snapshot.group().backup_type(), | |
760 | "backup-id": snapshot.group().backup_id(), | |
761 | "backup-time": snapshot.backup_time().timestamp(), | |
762 | })).unwrap(); | |
763 | ||
764 | let path = format!("api2/json/admin/datastore/{}/files?{}", repo.store(), query); | |
765 | ||
766 | let data = try_get(&repo, &path); | |
767 | ||
768 | if let Some(list) = data.as_array() { | |
769 | for item in list { | |
770 | if let Some(filename) = item.as_str() { | |
771 | result.push(filename.to_owned()); | |
772 | } | |
773 | } | |
774 | } | |
775 | ||
776 | strip_chunked_file_expenstions(result) | |
777 | } | |
778 | ||
779 | fn complete_chunk_size(_arg: &str, _param: &HashMap<String, String>) -> Vec<String> { | |
780 | ||
781 | let mut result = vec![]; | |
782 | ||
783 | let mut size = 64; | |
784 | loop { | |
785 | result.push(size.to_string()); | |
786 | size = size * 2; | |
787 | if size > 4096 { break; } | |
788 | } | |
789 | ||
790 | result | |
791 | } | |
792 | ||
793 | fn get_encryption_key_password() -> Result<Vec<u8>, Error> { | |
794 | ||
795 | // fixme: implement other input methods | |
796 | ||
797 | use std::env::VarError::*; | |
798 | match std::env::var("PBS_ENCRYPTION_PASSWORD") { | |
799 | Ok(p) => return Ok(p.as_bytes().to_vec()), | |
800 | Err(NotUnicode(_)) => bail!("PBS_ENCRYPTION_PASSWORD contains bad characters"), | |
801 | Err(NotPresent) => { | |
802 | // Try another method | |
803 | } | |
804 | } | |
805 | ||
806 | // If we're on a TTY, query the user for a password | |
807 | if crate::tools::tty::stdin_isatty() { | |
808 | return Ok(crate::tools::tty::read_password("Encryption Key Password: ")?); | |
809 | } | |
810 | ||
811 | bail!("no password input mechanism available"); | |
812 | } | |
813 | ||
814 | fn key_create( | |
815 | param: Value, | |
816 | _info: &ApiMethod, | |
817 | _rpcenv: &mut dyn RpcEnvironment, | |
818 | ) -> Result<Value, Error> { | |
819 | ||
820 | let path = tools::required_string_param(¶m, "path")?; | |
821 | let path = PathBuf::from(path); | |
822 | ||
823 | let kdf = param["kdf"].as_str().unwrap_or("scrypt"); | |
824 | ||
825 | let key = proxmox::sys::linux::random_data(32)?; | |
826 | ||
827 | if kdf == "scrypt" { | |
828 | // always read passphrase from tty | |
829 | if !crate::tools::tty::stdin_isatty() { | |
830 | bail!("unable to read passphrase - no tty"); | |
831 | } | |
832 | ||
833 | let password = crate::tools::tty::read_password("Encryption Key Password: ")?; | |
834 | ||
835 | let key_config = encrypt_key_with_passphrase(&key, &password)?; | |
836 | ||
837 | store_key_config(&path, false, key_config)?; | |
838 | ||
839 | Ok(Value::Null) | |
840 | } else if kdf == "none" { | |
841 | let created = Local.timestamp(Local::now().timestamp(), 0); | |
842 | ||
843 | store_key_config(&path, false, KeyConfig { | |
844 | kdf: None, | |
845 | created, | |
846 | modified: created, | |
847 | data: key, | |
848 | })?; | |
849 | ||
850 | Ok(Value::Null) | |
851 | } else { | |
852 | unreachable!(); | |
853 | } | |
854 | } | |
855 | ||
856 | fn key_import_master_pubkey( | |
857 | param: Value, | |
858 | _info: &ApiMethod, | |
859 | _rpcenv: &mut dyn RpcEnvironment, | |
860 | ) -> Result<Value, Error> { | |
861 | ||
862 | let path = tools::required_string_param(¶m, "path")?; | |
863 | let path = PathBuf::from(path); | |
864 | ||
865 | let pem_data = proxmox_backup::tools::file_get_contents(&path)?; | |
866 | ||
867 | if let Err(err) = openssl::pkey::PKey::public_key_from_pem(&pem_data) { | |
868 | bail!("Unable to decode PEM data - {}", err); | |
869 | } | |
870 | ||
871 | let base = BaseDirectories::with_prefix("proxmox-backup")?; | |
872 | ||
873 | // usually $HOME/.config/proxmox-backup/master-public.pem | |
874 | let target_path = base.place_config_file("master-public.pem")?; | |
875 | ||
876 | proxmox_backup::tools::file_set_contents(&target_path, &pem_data, None)?; | |
877 | ||
878 | println!("Imported public master key to {:?}", target_path); | |
879 | ||
880 | Ok(Value::Null) | |
881 | } | |
882 | ||
883 | fn key_create_master_key( | |
884 | _param: Value, | |
885 | _info: &ApiMethod, | |
886 | _rpcenv: &mut dyn RpcEnvironment, | |
887 | ) -> Result<Value, Error> { | |
888 | ||
889 | // we need a TTY to query the new password | |
890 | if !crate::tools::tty::stdin_isatty() { | |
891 | bail!("unable to create master key - no tty"); | |
892 | } | |
893 | ||
894 | let rsa = openssl::rsa::Rsa::generate(4096)?; | |
895 | let pkey = openssl::pkey::PKey::from_rsa(rsa)?; | |
896 | ||
897 | let new_pw = String::from_utf8(crate::tools::tty::read_password("Master Key Password: ")?)?; | |
898 | let verify_pw = String::from_utf8(crate::tools::tty::read_password("Verify Password: ")?)?; | |
899 | ||
900 | if new_pw != verify_pw { | |
901 | bail!("Password verification fail!"); | |
902 | } | |
903 | ||
904 | if new_pw.len() < 5 { | |
905 | bail!("Password is too short!"); | |
906 | } | |
907 | ||
908 | let pub_key: Vec<u8> = pkey.public_key_to_pem()?; | |
909 | let filename_pub = "master-public.pem"; | |
910 | println!("Writing public master key to {}", filename_pub); | |
911 | proxmox_backup::tools::file_set_contents(filename_pub, pub_key.as_slice(), None)?; | |
912 | ||
913 | let cipher = openssl::symm::Cipher::aes_256_cbc(); | |
914 | let priv_key: Vec<u8> = pkey.private_key_to_pem_pkcs8_passphrase(cipher, new_pw.as_bytes())?; | |
915 | ||
916 | let filename_priv = "master-private.pem"; | |
917 | println!("Writing private master key to {}", filename_priv); | |
918 | proxmox_backup::tools::file_set_contents(filename_priv, priv_key.as_slice(), None)?; | |
919 | ||
920 | Ok(Value::Null) | |
921 | } | |
922 | ||
923 | fn key_change_passphrase( | |
924 | param: Value, | |
925 | _info: &ApiMethod, | |
926 | _rpcenv: &mut dyn RpcEnvironment, | |
927 | ) -> Result<Value, Error> { | |
928 | ||
929 | let path = tools::required_string_param(¶m, "path")?; | |
930 | let path = PathBuf::from(path); | |
931 | ||
932 | let kdf = param["kdf"].as_str().unwrap_or("scrypt"); | |
933 | ||
934 | // we need a TTY to query the new password | |
935 | if !crate::tools::tty::stdin_isatty() { | |
936 | bail!("unable to change passphrase - no tty"); | |
937 | } | |
938 | ||
939 | let (key, created) = load_and_decrtypt_key(&path, get_encryption_key_password)?; | |
940 | ||
941 | if kdf == "scrypt" { | |
942 | ||
943 | let new_pw = String::from_utf8(crate::tools::tty::read_password("New Password: ")?)?; | |
944 | let verify_pw = String::from_utf8(crate::tools::tty::read_password("Verify Password: ")?)?; | |
945 | ||
946 | if new_pw != verify_pw { | |
947 | bail!("Password verification fail!"); | |
948 | } | |
949 | ||
950 | if new_pw.len() < 5 { | |
951 | bail!("Password is too short!"); | |
952 | } | |
953 | ||
954 | let mut new_key_config = encrypt_key_with_passphrase(&key, new_pw.as_bytes())?; | |
955 | new_key_config.created = created; // keep original value | |
956 | ||
957 | store_key_config(&path, true, new_key_config)?; | |
958 | ||
959 | Ok(Value::Null) | |
960 | } else if kdf == "none" { | |
961 | let modified = Local.timestamp(Local::now().timestamp(), 0); | |
962 | ||
963 | store_key_config(&path, true, KeyConfig { | |
964 | kdf: None, | |
965 | created, // keep original value | |
966 | modified, | |
967 | data: key.to_vec(), | |
968 | })?; | |
969 | ||
970 | Ok(Value::Null) | |
971 | } else { | |
972 | unreachable!(); | |
973 | } | |
974 | } | |
975 | ||
976 | fn key_mgmt_cli() -> CliCommandMap { | |
977 | ||
978 | let kdf_schema: Arc<Schema> = Arc::new( | |
979 | StringSchema::new("Key derivation function. Choose 'none' to store the key unecrypted.") | |
980 | .format(Arc::new(ApiStringFormat::Enum(&["scrypt", "none"]))) | |
981 | .default("scrypt") | |
982 | .into() | |
983 | ); | |
984 | ||
985 | let key_create_cmd_def = CliCommand::new( | |
986 | ApiMethod::new( | |
987 | key_create, | |
988 | ObjectSchema::new("Create a new encryption key.") | |
989 | .required("path", StringSchema::new("File system path.")) | |
990 | .optional("kdf", kdf_schema.clone()) | |
991 | )) | |
992 | .arg_param(vec!["path"]) | |
993 | .completion_cb("path", tools::complete_file_name); | |
994 | ||
995 | let key_change_passphrase_cmd_def = CliCommand::new( | |
996 | ApiMethod::new( | |
997 | key_change_passphrase, | |
998 | ObjectSchema::new("Change the passphrase required to decrypt the key.") | |
999 | .required("path", StringSchema::new("File system path.")) | |
1000 | .optional("kdf", kdf_schema.clone()) | |
1001 | )) | |
1002 | .arg_param(vec!["path"]) | |
1003 | .completion_cb("path", tools::complete_file_name); | |
1004 | ||
1005 | let key_create_master_key_cmd_def = CliCommand::new( | |
1006 | ApiMethod::new( | |
1007 | key_create_master_key, | |
1008 | ObjectSchema::new("Create a new 4096 bit RSA master pub/priv key pair.") | |
1009 | )); | |
1010 | ||
1011 | let key_import_master_pubkey_cmd_def = CliCommand::new( | |
1012 | ApiMethod::new( | |
1013 | key_import_master_pubkey, | |
1014 | ObjectSchema::new("Import a new RSA public key and use it as master key. The key is expected to be in '.pem' format.") | |
1015 | .required("path", StringSchema::new("File system path.")) | |
1016 | )) | |
1017 | .arg_param(vec!["path"]) | |
1018 | .completion_cb("path", tools::complete_file_name); | |
1019 | ||
1020 | let cmd_def = CliCommandMap::new() | |
1021 | .insert("create".to_owned(), key_create_cmd_def.into()) | |
1022 | .insert("create-master-key".to_owned(), key_create_master_key_cmd_def.into()) | |
1023 | .insert("import-master-pubkey".to_owned(), key_import_master_pubkey_cmd_def.into()) | |
1024 | .insert("change-passphrase".to_owned(), key_change_passphrase_cmd_def.into()); | |
1025 | ||
1026 | cmd_def | |
1027 | } | |
1028 | ||
1029 | ||
1030 | fn main() { | |
1031 | ||
1032 | let backup_source_schema: Arc<Schema> = Arc::new( | |
1033 | StringSchema::new("Backup source specification ([<label>:<path>]).") | |
1034 | .format(Arc::new(ApiStringFormat::Pattern(&BACKUPSPEC_REGEX))) | |
1035 | .into() | |
1036 | ); | |
1037 | ||
1038 | let backup_cmd_def = CliCommand::new( | |
1039 | ApiMethod::new( | |
1040 | create_backup, | |
1041 | ObjectSchema::new("Create (host) backup.") | |
1042 | .required("repository", REPO_URL_SCHEMA.clone()) | |
1043 | .required( | |
1044 | "backupspec", | |
1045 | ArraySchema::new( | |
1046 | "List of backup source specifications ([<label.ext>:<path>] ...)", | |
1047 | backup_source_schema, | |
1048 | ).min_length(1) | |
1049 | ) | |
1050 | .optional( | |
1051 | "keyfile", | |
1052 | StringSchema::new("Path to encryption key. All data will be encrypted using this key.")) | |
1053 | .optional( | |
1054 | "verbose", | |
1055 | BooleanSchema::new("Verbose output.").default(false)) | |
1056 | .optional( | |
1057 | "host-id", | |
1058 | StringSchema::new("Use specified ID for the backup group name ('host/<id>'). The default is the system hostname.")) | |
1059 | .optional( | |
1060 | "chunk-size", | |
1061 | IntegerSchema::new("Chunk size in KB. Must be a power of 2.") | |
1062 | .minimum(64) | |
1063 | .maximum(4096) | |
1064 | .default(4096) | |
1065 | ) | |
1066 | )) | |
1067 | .arg_param(vec!["repository", "backupspec"]) | |
1068 | .completion_cb("repository", complete_repository) | |
1069 | .completion_cb("backupspec", complete_backup_source) | |
1070 | .completion_cb("keyfile", tools::complete_file_name) | |
1071 | .completion_cb("chunk-size", complete_chunk_size); | |
1072 | ||
1073 | let list_cmd_def = CliCommand::new( | |
1074 | ApiMethod::new( | |
1075 | list_backup_groups, | |
1076 | ObjectSchema::new("List backup groups.") | |
1077 | .required("repository", REPO_URL_SCHEMA.clone()) | |
1078 | )) | |
1079 | .arg_param(vec!["repository"]) | |
1080 | .completion_cb("repository", complete_repository); | |
1081 | ||
1082 | let snapshots_cmd_def = CliCommand::new( | |
1083 | ApiMethod::new( | |
1084 | list_snapshots, | |
1085 | ObjectSchema::new("List backup snapshots.") | |
1086 | .required("repository", REPO_URL_SCHEMA.clone()) | |
1087 | .required("group", StringSchema::new("Backup group.")) | |
1088 | )) | |
1089 | .arg_param(vec!["repository", "group"]) | |
1090 | .completion_cb("group", complete_backup_group) | |
1091 | .completion_cb("repository", complete_repository); | |
1092 | ||
1093 | let forget_cmd_def = CliCommand::new( | |
1094 | ApiMethod::new( | |
1095 | forget_snapshots, | |
1096 | ObjectSchema::new("Forget (remove) backup snapshots.") | |
1097 | .required("repository", REPO_URL_SCHEMA.clone()) | |
1098 | .required("snapshot", StringSchema::new("Snapshot path.")) | |
1099 | )) | |
1100 | .arg_param(vec!["repository", "snapshot"]) | |
1101 | .completion_cb("repository", complete_repository) | |
1102 | .completion_cb("snapshot", complete_group_or_snapshot); | |
1103 | ||
1104 | let garbage_collect_cmd_def = CliCommand::new( | |
1105 | ApiMethod::new( | |
1106 | start_garbage_collection, | |
1107 | ObjectSchema::new("Start garbage collection for a specific repository.") | |
1108 | .required("repository", REPO_URL_SCHEMA.clone()) | |
1109 | )) | |
1110 | .arg_param(vec!["repository"]) | |
1111 | .completion_cb("repository", complete_repository); | |
1112 | ||
1113 | let restore_cmd_def = CliCommand::new( | |
1114 | ApiMethod::new( | |
1115 | restore, | |
1116 | ObjectSchema::new("Restore backup repository.") | |
1117 | .required("repository", REPO_URL_SCHEMA.clone()) | |
1118 | .required("snapshot", StringSchema::new("Group/Snapshot path.")) | |
1119 | .required("archive-name", StringSchema::new("Backup archive name.")) | |
1120 | .required("target", StringSchema::new("Target directory path.")) | |
1121 | )) | |
1122 | .arg_param(vec!["repository", "snapshot", "archive-name", "target"]) | |
1123 | .completion_cb("repository", complete_repository) | |
1124 | .completion_cb("snapshot", complete_group_or_snapshot) | |
1125 | .completion_cb("archive-name", complete_archive_name) | |
1126 | .completion_cb("target", tools::complete_file_name); | |
1127 | ||
1128 | let prune_cmd_def = CliCommand::new( | |
1129 | ApiMethod::new( | |
1130 | prune, | |
1131 | proxmox_backup::api2::admin::datastore::add_common_prune_prameters( | |
1132 | ObjectSchema::new("Prune backup repository.") | |
1133 | .required("repository", REPO_URL_SCHEMA.clone()) | |
1134 | ) | |
1135 | )) | |
1136 | .arg_param(vec!["repository"]) | |
1137 | .completion_cb("repository", complete_repository); | |
1138 | ||
1139 | let cmd_def = CliCommandMap::new() | |
1140 | .insert("backup".to_owned(), backup_cmd_def.into()) | |
1141 | .insert("forget".to_owned(), forget_cmd_def.into()) | |
1142 | .insert("garbage-collect".to_owned(), garbage_collect_cmd_def.into()) | |
1143 | .insert("list".to_owned(), list_cmd_def.into()) | |
1144 | .insert("prune".to_owned(), prune_cmd_def.into()) | |
1145 | .insert("restore".to_owned(), restore_cmd_def.into()) | |
1146 | .insert("snapshots".to_owned(), snapshots_cmd_def.into()) | |
1147 | .insert("key".to_owned(), key_mgmt_cli().into()); | |
1148 | ||
1149 | hyper::rt::run(futures::future::lazy(move || { | |
1150 | run_cli_command(cmd_def.into()); | |
1151 | Ok(()) | |
1152 | })); | |
1153 | ||
1154 | } |