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