2 extern crate proxmox_backup
;
5 //use std::os::unix::io::AsRawFd;
6 use chrono
::{Local, TimeZone}
;
7 use std
::path
::{Path, PathBuf}
;
8 use std
::collections
::HashMap
;
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::*;
21 use serde_json
::{json, Value}
;
25 use xdg
::BaseDirectories
;
27 use lazy_static
::lazy_static
;
29 use tokio
::sync
::mpsc
;
32 static ref BACKUPSPEC_REGEX
: Regex
= Regex
::new(r
"^([a-zA-Z0-9_-]+\.(?:pxar|img|conf)):(.+)$").unwrap();
34 static ref REPO_URL_SCHEMA
: Arc
<Schema
> = Arc
::new(
35 StringSchema
::new("Repository URL.")
36 .format(BACKUP_REPO_URL
.clone())
43 fn record_repository(repo
: &BackupRepository
) {
45 let base
= match BaseDirectories
::with_prefix("proxmox-backup") {
50 // usually $HOME/.cache/proxmox-backup/repo-list
51 let path
= match base
.place_cache_file("repo-list") {
56 let mut data
= tools
::file_get_json(&path
, None
).unwrap_or(json
!({}
));
58 let repo
= repo
.to_string();
60 data
[&repo
] = json
!{ data[&repo].as_i64().unwrap_or(0) + 1 }
;
62 let mut map
= serde_json
::map
::Map
::new();
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() {
72 max_repo
= Some(repo
);
76 if let Some(repo
) = max_repo
{
77 map
.insert(repo
.to_owned(), json
!(max_used
));
81 if map
.len() > 10 { // store max. 10 repos
86 let new_data
= json
!(map
);
88 let _
= tools
::file_set_contents(path
, new_data
.to_string().as_bytes(), None
);
91 fn complete_repository(_arg
: &str, _param
: &HashMap
<String
, String
>) -> Vec
<String
> {
93 let mut result
= vec
![];
95 let base
= match BaseDirectories
::with_prefix("proxmox-backup") {
100 // usually $HOME/.cache/proxmox-backup/repo-list
101 let path
= match base
.place_cache_file("repo-list") {
106 let data
= tools
::file_get_json(&path
, None
).unwrap_or(json
!({}
));
108 if let Some(map
) = data
.as_object() {
109 for (repo
, _count
) in map
{
110 result
.push(repo
.to_owned());
117 fn backup_directory
<P
: AsRef
<Path
>>(
118 client
: &BackupClient
,
121 chunk_size
: Option
<usize>,
122 all_file_systems
: bool
,
124 crypt_config
: Option
<Arc
<CryptConfig
>>,
125 ) -> Result
<(), Error
> {
127 let pxar_stream
= PxarBackupStream
::open(dir_path
.as_ref(), all_file_systems
, verbose
)?
;
128 let chunk_stream
= ChunkStream
::new(pxar_stream
, chunk_size
);
130 let (tx
, rx
) = mpsc
::channel(10); // allow to buffer 10 chunks
133 .map_err(Error
::from
)
134 .and_then(|x
| x
); // flatten
136 // spawn chunker inside a separate task so that it can run parallel
138 tx
.send_all(chunk_stream
.then(|r
| Ok(r
)))
139 .map_err(|_
| {}
).map(|_
| ())
142 client
.upload_stream(archive_name
, stream
, "dynamic", None
, crypt_config
).wait()?
;
147 fn backup_image
<P
: AsRef
<Path
>>(
148 client
: &BackupClient
,
152 chunk_size
: Option
<usize>,
154 crypt_config
: Option
<Arc
<CryptConfig
>>,
155 ) -> Result
<(), Error
> {
157 let path
= image_path
.as_ref().to_owned();
159 let file
= tokio
::fs
::File
::open(path
).wait()?
;
161 let stream
= tokio
::codec
::FramedRead
::new(file
, tokio
::codec
::BytesCodec
::new())
162 .map_err(Error
::from
);
164 let stream
= FixedChunkStream
::new(stream
, chunk_size
.unwrap_or(4*1024*1024));
166 client
.upload_stream(archive_name
, stream
, "fixed", Some(image_size
), crypt_config
).wait()?
;
171 fn strip_server_file_expenstions(list
: Vec
<String
>) -> Vec
<String
> {
173 let mut result
= vec
![];
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 if file
.ends_with(".blob") {
181 result
.push(file
[..file
.len()-5].to_owned());
183 result
.push(file
); // should not happen
194 _rpcenv: &mut dyn RpcEnvironment,
195 ) -> Result<Value, Error> {
197 let repo_url = tools::required_string_param(¶m, "repository")?;
198 let repo: BackupRepository = repo_url.parse()?;
200 let mut client = HttpClient::new(repo.host(), repo.user())?;
202 let path = format!("api2/json/admin/datastore/{}/backups", repo.store());
204 let result = client.get(&path, None)?;
206 record_repository(&repo);
208 // fixme: implement and use output formatter instead ..
209 let list = result["data"].as_array().unwrap();
213 let id = item["backup-id"].as_str().unwrap();
214 let btype = item["backup-type"].as_str().unwrap();
215 let epoch = item["backup-time"].as_i64().unwrap();
217 let backup_dir = BackupDir::new(btype, id, epoch);
219 let files = item["files"].as_array().unwrap().iter().map(|v| v.as_str().unwrap().to_owned()).collect();
220 let files = strip_server_file_expenstions(files);
222 for filename in files {
223 let path = backup_dir.relative_path().to_str().unwrap().to_owned();
224 println!("{} | {}/{}", backup_dir.backup_time().format("%c"), path, filename);
233 fn list_backup_groups(
236 _rpcenv
: &mut dyn RpcEnvironment
,
237 ) -> Result
<Value
, Error
> {
239 let repo_url
= tools
::required_string_param(¶m
, "repository")?
;
240 let repo
: BackupRepository
= repo_url
.parse()?
;
242 let client
= HttpClient
::new(repo
.host(), repo
.user())?
;
244 let path
= format
!("api2/json/admin/datastore/{}/groups", repo
.store());
246 let mut result
= client
.get(&path
, None
).wait()?
;
248 record_repository(&repo
);
250 // fixme: implement and use output formatter instead ..
251 let list
= result
["data"].as_array_mut().unwrap();
253 list
.sort_unstable_by(|a
, b
| {
254 let a_id
= a
["backup-id"].as_str().unwrap();
255 let a_backup_type
= a
["backup-type"].as_str().unwrap();
256 let b_id
= b
["backup-id"].as_str().unwrap();
257 let b_backup_type
= b
["backup-type"].as_str().unwrap();
259 let type_order
= a_backup_type
.cmp(b_backup_type
);
260 if type_order
== std
::cmp
::Ordering
::Equal
{
269 let id
= item
["backup-id"].as_str().unwrap();
270 let btype
= item
["backup-type"].as_str().unwrap();
271 let epoch
= item
["last-backup"].as_i64().unwrap();
272 let last_backup
= Local
.timestamp(epoch
, 0);
273 let backup_count
= item
["backup-count"].as_u64().unwrap();
275 let group
= BackupGroup
::new(btype
, id
);
277 let path
= group
.group_path().to_str().unwrap().to_owned();
279 let files
= item
["files"].as_array().unwrap().iter().map(|v
| v
.as_str().unwrap().to_owned()).collect();
280 let files
= strip_server_file_expenstions(files
);
282 println
!("{:20} | {} | {:5} | {}", path
, last_backup
.format("%c"),
283 backup_count
, tools
::join(&files
, ' '
));
293 _rpcenv
: &mut dyn RpcEnvironment
,
294 ) -> Result
<Value
, Error
> {
296 let repo_url
= tools
::required_string_param(¶m
, "repository")?
;
297 let repo
: BackupRepository
= repo_url
.parse()?
;
299 let path
= tools
::required_string_param(¶m
, "group")?
;
300 let group
= BackupGroup
::parse(path
)?
;
302 let client
= HttpClient
::new(repo
.host(), repo
.user())?
;
304 let path
= format
!("api2/json/admin/datastore/{}/snapshots", repo
.store());
306 let result
= client
.get(&path
, Some(json
!({
307 "backup-type": group
.backup_type(),
308 "backup-id": group
.backup_id(),
311 record_repository(&repo
);
313 // fixme: implement and use output formatter instead ..
314 let list
= result
["data"].as_array().unwrap();
318 let id
= item
["backup-id"].as_str().unwrap();
319 let btype
= item
["backup-type"].as_str().unwrap();
320 let epoch
= item
["backup-time"].as_i64().unwrap();
322 let snapshot
= BackupDir
::new(btype
, id
, epoch
);
324 let path
= snapshot
.relative_path().to_str().unwrap().to_owned();
326 let files
= item
["files"].as_array().unwrap().iter().map(|v
| v
.as_str().unwrap().to_owned()).collect();
327 let files
= strip_server_file_expenstions(files
);
329 println
!("{} | {} | {}", path
, snapshot
.backup_time().format("%c"), tools
::join(&files
, ' '
));
338 _rpcenv
: &mut dyn RpcEnvironment
,
339 ) -> Result
<Value
, Error
> {
341 let repo_url
= tools
::required_string_param(¶m
, "repository")?
;
342 let repo
: BackupRepository
= repo_url
.parse()?
;
344 let path
= tools
::required_string_param(¶m
, "snapshot")?
;
345 let snapshot
= BackupDir
::parse(path
)?
;
347 let mut client
= HttpClient
::new(repo
.host(), repo
.user())?
;
349 let path
= format
!("api2/json/admin/datastore/{}/snapshots", repo
.store());
351 let result
= client
.delete(&path
, Some(json
!({
352 "backup-type": snapshot
.group().backup_type(),
353 "backup-id": snapshot
.group().backup_id(),
354 "backup-time": snapshot
.backup_time().timestamp(),
357 record_repository(&repo
);
362 fn start_garbage_collection(
365 _rpcenv
: &mut dyn RpcEnvironment
,
366 ) -> Result
<Value
, Error
> {
368 let repo_url
= tools
::required_string_param(¶m
, "repository")?
;
369 let repo
: BackupRepository
= repo_url
.parse()?
;
371 let mut client
= HttpClient
::new(repo
.host(), repo
.user())?
;
373 let path
= format
!("api2/json/admin/datastore/{}/gc", repo
.store());
375 let result
= client
.post(&path
, None
).wait()?
;
377 record_repository(&repo
);
382 fn parse_backupspec(value
: &str) -> Result
<(&str, &str), Error
> {
384 if let Some(caps
) = BACKUPSPEC_REGEX
.captures(value
) {
385 return Ok((caps
.get(1).unwrap().as_str(), caps
.get(2).unwrap().as_str()));
387 bail
!("unable to parse directory specification '{}'", value
);
393 _rpcenv
: &mut dyn RpcEnvironment
,
394 ) -> Result
<Value
, Error
> {
396 let repo_url
= tools
::required_string_param(¶m
, "repository")?
;
398 let backupspec_list
= tools
::required_array_param(¶m
, "backupspec")?
;
400 let repo
: BackupRepository
= repo_url
.parse()?
;
402 let all_file_systems
= param
["all-file-systems"].as_bool().unwrap_or(false);
404 let verbose
= param
["verbose"].as_bool().unwrap_or(false);
406 let chunk_size_opt
= param
["chunk-size"].as_u64().map(|v
| (v
*1024) as usize);
408 if let Some(size
) = chunk_size_opt
{
409 verify_chunk_size(size
)?
;
412 let keyfile
= param
["keyfile"].as_str().map(|p
| PathBuf
::from(p
));
414 let backup_id
= param
["host-id"].as_str().unwrap_or(&tools
::nodename());
416 let mut upload_list
= vec
![];
418 enum BackupType { PXAR, IMAGE, CONFIG }
;
420 for backupspec
in backupspec_list
{
421 let (target
, filename
) = parse_backupspec(backupspec
.as_str().unwrap())?
;
423 use std
::os
::unix
::fs
::FileTypeExt
;
425 let metadata
= match std
::fs
::metadata(filename
) {
427 Err(err
) => bail
!("unable to access '{}' - {}", filename
, err
),
429 let file_type
= metadata
.file_type();
431 let extension
= Path
::new(target
).extension().map(|s
| s
.to_str().unwrap()).unwrap();
435 if !file_type
.is_dir() {
436 bail
!("got unexpected file type (expected directory)");
438 upload_list
.push((BackupType
::PXAR
, filename
.to_owned(), target
.to_owned(), 0));
442 if !(file_type
.is_file() || file_type
.is_block_device()) {
443 bail
!("got unexpected file type (expected file or block device)");
446 let size
= tools
::image_size(&PathBuf
::from(filename
))?
;
448 if size
== 0 { bail!("got zero-sized file '{}'
", filename); }
450 upload_list.push((BackupType::IMAGE, filename.to_owned(), target.to_owned(), size));
453 if !file_type.is_file() {
454 bail!("got unexpected file
type (expected regular file
)");
456 upload_list.push((BackupType::CONFIG, filename.to_owned(), target.to_owned(), metadata.len()));
459 bail!("got unknown archive extension '{}'
", extension);
464 let backup_time = Local.timestamp(Local::now().timestamp(), 0);
466 let client = HttpClient::new(repo.host(), repo.user())?;
467 record_repository(&repo);
469 println!("Starting backup
");
470 println!("Client name
: {}
", tools::nodename());
471 println!("Start Time
: {}
", backup_time.to_rfc3339());
473 let (crypt_config, rsa_encrypted_key) = match keyfile {
474 None => (None, None),
476 let (key, created) = load_and_decrtypt_key(&path, get_encryption_key_password)?;
478 let crypt_config = CryptConfig::new(key)?;
480 let path = master_pubkey_path()?;
482 let pem_data = proxmox_backup::tools::file_get_contents(&path)?;
483 let rsa = openssl::rsa::Rsa::public_key_from_pem(&pem_data)?;
484 let enc_key = crypt_config.generate_rsa_encoded_key(rsa, created)?;
485 (Some(Arc::new(crypt_config)), Some(enc_key))
487 (Some(Arc::new(crypt_config)), None)
492 let client = client.start_backup(repo.store(), "host
", &backup_id, verbose).wait()?;
494 for (backup_type, filename, target, size) in upload_list {
496 BackupType::CONFIG => {
497 println!("Upload config file '{}' to '{:?}'
as {}
", filename, repo, target);
498 client.upload_blob_from_file(&filename, &target, crypt_config.clone(), true).wait()?;
500 BackupType::PXAR => {
501 println!("Upload directory '{}' to '{:?}'
as {}
", filename, repo, target);
509 crypt_config.clone(),
512 BackupType::IMAGE => {
513 println!("Upload image '{}' to '{:?}'
as {}
", filename, repo, target);
521 crypt_config.clone(),
527 if let Some(rsa_encrypted_key) = rsa_encrypted_key {
528 let target = "rsa
-encrypted
.key
";
529 println!("Upload RSA encoded key to '{:?}'
as {}
", repo, target);
530 client.upload_blob_from_data(rsa_encrypted_key, target, None, false).wait()?;
532 // openssl rsautl -decrypt -inkey master-private.pem -in rsa-encrypted.key -out t
534 let mut buffer2 = vec![0u8; rsa.size() as usize];
535 let pem_data = proxmox_backup::tools::file_get_contents("master
-private
.pem
")?;
536 let rsa = openssl::rsa::Rsa::private_key_from_pem(&pem_data)?;
537 let len = rsa.private_decrypt(&buffer, &mut buffer2, openssl::rsa::Padding::PKCS1)?;
538 println!("TEST {} {:?}
", len, buffer2);
542 client.finish().wait()?;
544 let end_time = Local.timestamp(Local::now().timestamp(), 0);
545 let elapsed = end_time.signed_duration_since(backup_time);
546 println!("Duration
: {}
", elapsed);
548 println!("End Time
: {}
", end_time.to_rfc3339());
553 fn complete_backup_source(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
555 let mut result = vec![];
557 let data: Vec<&str> = arg.splitn(2, ':').collect();
560 result.push(String::from("root
.pxar
:/"));
561 result.push(String::from("etc
.pxar
:/etc
"));
565 let files = tools::complete_file_name(data[1], param);
568 result.push(format!("{}
:{}
", data[0], file));
577 _rpcenv: &mut dyn RpcEnvironment,
578 ) -> Result<Value, Error> {
580 let repo_url = tools::required_string_param(¶m, "repository
")?;
581 let repo: BackupRepository = repo_url.parse()?;
583 let archive_name = tools::required_string_param(¶m, "archive
-name
")?;
585 let mut client = HttpClient::new(repo.host(), repo.user())?;
587 record_repository(&repo);
589 let path = tools::required_string_param(¶m, "snapshot
")?;
593 if path.matches('/').count() == 1 {
594 let group = BackupGroup::parse(path)?;
596 let path = format!("api2
/json
/admin
/datastore
/{}
/snapshots
", repo.store());
597 let result = client.get(&path, Some(json!({
598 "backup
-type": group.backup_type(),
599 "backup
-id
": group.backup_id(),
602 let list = result["data
"].as_array().unwrap();
604 bail!("backup group '{}' does not contain any snapshots
:", path);
607 query = tools::json_object_to_query(json!({
608 "backup
-type": group.backup_type(),
609 "backup
-id
": group.backup_id(),
610 "backup
-time
": list[0]["backup
-time
"].as_i64().unwrap(),
611 "archive
-name
": archive_name,
614 let snapshot = BackupDir::parse(path)?;
616 query = tools::json_object_to_query(json!({
617 "backup
-type": snapshot.group().backup_type(),
618 "backup
-id
": snapshot.group().backup_id(),
619 "backup
-time
": snapshot.backup_time().timestamp(),
620 "archive
-name
": archive_name,
624 let target = tools::required_string_param(¶m, "target
")?;
626 if archive_name.ends_with(".pxar
") {
627 let path = format!("api2
/json
/admin
/datastore
/{}
/pxar?{}
", repo.store(), query);
629 println!("DOWNLOAD FILE {} to {}
", path, target);
631 let target = PathBuf::from(target);
632 let writer = PxarDecodeWriter::new(&target, true)?;
633 client.download(&path, Box::new(writer)).wait()?;
635 bail!("unknown file extensions
- unable to download '{}'
", archive_name);
644 _rpcenv: &mut dyn RpcEnvironment,
645 ) -> Result<Value, Error> {
647 let repo_url = tools::required_string_param(¶m, "repository
")?;
648 let repo: BackupRepository = repo_url.parse()?;
650 let file_name = tools::required_string_param(¶m, "file
-name
")?;
652 let keyfile = param["keyfile
"].as_str().map(|p| PathBuf::from(p));
654 let crypt_config = match keyfile {
657 let (key, _) = load_and_decrtypt_key(&path, get_encryption_key_password)?;
658 Some(CryptConfig::new(key)?)
662 let mut client = HttpClient::new(repo.host(), repo.user())?;
664 record_repository(&repo);
666 let path = tools::required_string_param(¶m, "snapshot
")?;
670 if path.matches('/').count() == 1 {
671 let group = BackupGroup::parse(path)?;
673 let path = format!("api2
/json
/admin
/datastore
/{}
/snapshots
", repo.store());
674 let result = client.get(&path, Some(json!({
675 "backup
-type": group.backup_type(),
676 "backup
-id
": group.backup_id(),
679 let list = result["data
"].as_array().unwrap();
681 bail!("backup group '{}' does not contain any snapshots
:", path);
684 query = tools::json_object_to_query(json!({
685 "backup
-type": group.backup_type(),
686 "backup
-id
": group.backup_id(),
687 "backup
-time
": list[0]["backup
-time
"].as_i64().unwrap(),
688 "file
-name
": file_name,
691 let snapshot = BackupDir::parse(path)?;
693 query = tools::json_object_to_query(json!({
694 "backup
-type": snapshot.group().backup_type(),
695 "backup
-id
": snapshot.group().backup_id(),
696 "backup
-time
": snapshot.backup_time().timestamp(),
697 "file
-name
": file_name,
701 let target = tools::required_string_param(¶m, "target
")?;
703 let path = format!("api2
/json
/admin
/datastore
/{}
/download?{}
", repo.store(), query);
705 println!("DOWNLOAD FILE {} to {}
", path, target);
707 if file_name.ends_with(".blob
") {
708 let writer = Vec::with_capacity(1024*1024);
709 let blob_data = client.download(&path, writer).wait()?;
710 let blob = DataBlob::from_raw(blob_data)?;
712 let raw_data = blob.decode(crypt_config.as_ref())?; // fixme
714 crate::tools::file_set_contents(target, &raw_data, None)?;
726 _rpcenv: &mut dyn RpcEnvironment,
727 ) -> Result<Value, Error> {
729 let repo_url = tools::required_string_param(¶m, "repository
")?;
730 let repo: BackupRepository = repo_url.parse()?;
732 let mut client = HttpClient::new(repo.host(), repo.user())?;
734 let path = format!("api2
/json
/admin
/datastore
/{}
/prune
", repo.store());
736 param.as_object_mut().unwrap().remove("repository
");
738 let result = client.post(&path, Some(param)).wait()?;
740 record_repository(&repo);
745 // like get, but simply ignore errors and return Null instead
746 fn try_get(repo: &BackupRepository, url: &str) -> Value {
748 let client = match HttpClient::new(repo.host(), repo.user()) {
750 _ => return Value::Null,
753 let mut resp = match client.get(url, None).wait() {
755 _ => return Value::Null,
758 if let Some(map) = resp.as_object_mut() {
759 if let Some(data) = map.remove("data
") {
766 fn extract_repo(param: &HashMap<String, String>) -> Option<BackupRepository> {
768 let repo_url = match param.get("repository
") {
773 let repo: BackupRepository = match repo_url.parse() {
781 fn complete_backup_group(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
783 let mut result = vec![];
785 let repo = match extract_repo(param) {
790 let path = format!("api2
/json
/admin
/datastore
/{}
/groups
", repo.store());
792 let data = try_get(&repo, &path);
794 if let Some(list) = data.as_array() {
796 if let (Some(backup_id), Some(backup_type)) =
797 (item["backup
-id
"].as_str(), item["backup
-type"].as_str())
799 result.push(format!("{}
/{}
", backup_type, backup_id));
807 fn complete_group_or_snapshot(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
809 let mut result = vec![];
811 let repo = match extract_repo(param) {
816 if arg.matches('/').count() < 2 {
817 let groups = complete_backup_group(arg, param);
818 for group in groups {
819 result.push(group.to_string());
820 result.push(format!("{}
/", group));
825 let mut parts = arg.split('/');
826 let query = tools::json_object_to_query(json!({
827 "backup
-type": parts.next().unwrap(),
828 "backup
-id
": parts.next().unwrap(),
831 let path = format!("api2
/json
/admin
/datastore
/{}
/snapshots?{}
", repo.store(), query);
833 let data = try_get(&repo, &path);
835 if let Some(list) = data.as_array() {
837 if let (Some(backup_id), Some(backup_type), Some(backup_time)) =
838 (item["backup
-id
"].as_str(), item["backup
-type"].as_str(), item["backup
-time
"].as_i64())
840 let snapshot = BackupDir::new(backup_type, backup_id, backup_time);
841 result.push(snapshot.relative_path().to_str().unwrap().to_owned());
849 fn complete_server_file_name(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
851 let mut result = vec![];
853 let repo = match extract_repo(param) {
858 let snapshot = match param.get("snapshot
") {
860 match BackupDir::parse(path) {
868 let query = tools::json_object_to_query(json!({
869 "backup
-type": snapshot.group().backup_type(),
870 "backup
-id
": snapshot.group().backup_id(),
871 "backup
-time
": snapshot.backup_time().timestamp(),
874 let path = format!("api2
/json
/admin
/datastore
/{}
/files?{}
", repo.store(), query);
876 let data = try_get(&repo, &path);
878 if let Some(list) = data.as_array() {
880 if let Some(filename) = item.as_str() {
881 result.push(filename.to_owned());
889 fn complete_archive_name(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
891 let result = complete_server_file_name(arg, param);
893 strip_server_file_expenstions(result)
896 fn complete_chunk_size(_arg: &str, _param: &HashMap<String, String>) -> Vec<String> {
898 let mut result = vec![];
902 result.push(size.to_string());
904 if size > 4096 { break; }
910 fn get_encryption_key_password() -> Result<Vec<u8>, Error> {
912 // fixme: implement other input methods
914 use std::env::VarError::*;
915 match std::env::var("PBS_ENCRYPTION_PASSWORD
") {
916 Ok(p) => return Ok(p.as_bytes().to_vec()),
917 Err(NotUnicode(_)) => bail!("PBS_ENCRYPTION_PASSWORD contains bad characters
"),
919 // Try another method
923 // If we're on a TTY, query the user for a password
924 if crate::tools::tty::stdin_isatty() {
925 return Ok(crate::tools::tty::read_password("Encryption Key Password
: ")?);
928 bail!("no password input mechanism available
");
934 _rpcenv: &mut dyn RpcEnvironment,
935 ) -> Result<Value, Error> {
937 let path = tools::required_string_param(¶m, "path
")?;
938 let path = PathBuf::from(path);
940 let kdf = param["kdf
"].as_str().unwrap_or("scrypt
");
942 let key = proxmox::sys::linux::random_data(32)?;
945 // always read passphrase from tty
946 if !crate::tools::tty::stdin_isatty() {
947 bail!("unable to read passphrase
- no tty
");
950 let password = crate::tools::tty::read_password("Encryption Key Password
: ")?;
952 let key_config = encrypt_key_with_passphrase(&key, &password)?;
954 store_key_config(&path, false, key_config)?;
957 } else if kdf == "none
" {
958 let created = Local.timestamp(Local::now().timestamp(), 0);
960 store_key_config(&path, false, KeyConfig {
973 fn master_pubkey_path() -> Result<PathBuf, Error> {
974 let base = BaseDirectories::with_prefix("proxmox
-backup
")?;
976 // usually $HOME/.config/proxmox-backup/master-public.pem
977 let path = base.place_config_file("master
-public
.pem
")?;
982 fn key_import_master_pubkey(
985 _rpcenv: &mut dyn RpcEnvironment,
986 ) -> Result<Value, Error> {
988 let path = tools::required_string_param(¶m, "path
")?;
989 let path = PathBuf::from(path);
991 let pem_data = proxmox_backup::tools::file_get_contents(&path)?;
993 if let Err(err) = openssl::pkey::PKey::public_key_from_pem(&pem_data) {
994 bail!("Unable to decode PEM data
- {}
", err);
997 let target_path = master_pubkey_path()?;
999 proxmox_backup::tools::file_set_contents(&target_path, &pem_data, None)?;
1001 println!("Imported public master key to {:?}
", target_path);
1006 fn key_create_master_key(
1009 _rpcenv: &mut dyn RpcEnvironment,
1010 ) -> Result<Value, Error> {
1012 // we need a TTY to query the new password
1013 if !crate::tools::tty::stdin_isatty() {
1014 bail!("unable to create master key
- no tty
");
1017 let rsa = openssl::rsa::Rsa::generate(4096)?;
1018 let pkey = openssl::pkey::PKey::from_rsa(rsa)?;
1020 let new_pw = String::from_utf8(crate::tools::tty::read_password("Master Key Password
: ")?)?;
1021 let verify_pw = String::from_utf8(crate::tools::tty::read_password("Verify Password
: ")?)?;
1023 if new_pw != verify_pw {
1024 bail!("Password verification fail
!");
1027 if new_pw.len() < 5 {
1028 bail!("Password is too short
!");
1031 let pub_key: Vec<u8> = pkey.public_key_to_pem()?;
1032 let filename_pub = "master
-public
.pem
";
1033 println!("Writing public master key to {}
", filename_pub);
1034 proxmox_backup::tools::file_set_contents(filename_pub, pub_key.as_slice(), None)?;
1036 let cipher = openssl::symm::Cipher::aes_256_cbc();
1037 let priv_key: Vec<u8> = pkey.private_key_to_pem_pkcs8_passphrase(cipher, new_pw.as_bytes())?;
1039 let filename_priv = "master
-private
.pem
";
1040 println!("Writing private master key to {}
", filename_priv);
1041 proxmox_backup::tools::file_set_contents(filename_priv, priv_key.as_slice(), None)?;
1046 fn key_change_passphrase(
1049 _rpcenv: &mut dyn RpcEnvironment,
1050 ) -> Result<Value, Error> {
1052 let path = tools::required_string_param(¶m, "path
")?;
1053 let path = PathBuf::from(path);
1055 let kdf = param["kdf
"].as_str().unwrap_or("scrypt
");
1057 // we need a TTY to query the new password
1058 if !crate::tools::tty::stdin_isatty() {
1059 bail!("unable to change passphrase
- no tty
");
1062 let (key, created) = load_and_decrtypt_key(&path, get_encryption_key_password)?;
1064 if kdf == "scrypt
" {
1066 let new_pw = String::from_utf8(crate::tools::tty::read_password("New Password
: ")?)?;
1067 let verify_pw = String::from_utf8(crate::tools::tty::read_password("Verify Password
: ")?)?;
1069 if new_pw != verify_pw {
1070 bail!("Password verification fail
!");
1073 if new_pw.len() < 5 {
1074 bail!("Password is too short
!");
1077 let mut new_key_config = encrypt_key_with_passphrase(&key, new_pw.as_bytes())?;
1078 new_key_config.created = created; // keep original value
1080 store_key_config(&path, true, new_key_config)?;
1083 } else if kdf == "none
" {
1084 let modified = Local.timestamp(Local::now().timestamp(), 0);
1086 store_key_config(&path, true, KeyConfig {
1088 created, // keep original value
1099 fn key_mgmt_cli() -> CliCommandMap {
1101 let kdf_schema: Arc<Schema> = Arc::new(
1102 StringSchema::new("Key derivation function
. Choose 'none' to store the key unecrypted
.")
1103 .format(Arc::new(ApiStringFormat::Enum(&["scrypt
", "none
"])))
1108 let key_create_cmd_def = CliCommand::new(
1111 ObjectSchema::new("Create a new encryption key
.")
1112 .required("path
", StringSchema::new("File system path
."))
1113 .optional("kdf
", kdf_schema.clone())
1115 .arg_param(vec!["path
"])
1116 .completion_cb("path
", tools::complete_file_name);
1118 let key_change_passphrase_cmd_def = CliCommand::new(
1120 key_change_passphrase,
1121 ObjectSchema::new("Change the passphrase required to decrypt the key
.")
1122 .required("path
", StringSchema::new("File system path
."))
1123 .optional("kdf
", kdf_schema.clone())
1125 .arg_param(vec!["path
"])
1126 .completion_cb("path
", tools::complete_file_name);
1128 let key_create_master_key_cmd_def = CliCommand::new(
1130 key_create_master_key,
1131 ObjectSchema::new("Create a new
4096 bit RSA master
pub/priv key pair
.")
1134 let key_import_master_pubkey_cmd_def = CliCommand::new(
1136 key_import_master_pubkey,
1137 ObjectSchema::new("Import a new RSA public key and
use it
as master key
. The key is expected to be
in '
.pem' format
.")
1138 .required("path
", StringSchema::new("File system path
."))
1140 .arg_param(vec!["path
"])
1141 .completion_cb("path
", tools::complete_file_name);
1143 let cmd_def = CliCommandMap::new()
1144 .insert("create
".to_owned(), key_create_cmd_def.into())
1145 .insert("create
-master
-key
".to_owned(), key_create_master_key_cmd_def.into())
1146 .insert("import
-master
-pubkey
".to_owned(), key_import_master_pubkey_cmd_def.into())
1147 .insert("change
-passphrase
".to_owned(), key_change_passphrase_cmd_def.into());
1154 let backup_source_schema: Arc<Schema> = Arc::new(
1155 StringSchema::new("Backup source
specification ([<label
>:<path
>]).")
1156 .format(Arc::new(ApiStringFormat::Pattern(&BACKUPSPEC_REGEX)))
1160 let backup_cmd_def = CliCommand::new(
1163 ObjectSchema::new("Create (host
) backup
.")
1164 .required("repository
", REPO_URL_SCHEMA.clone())
1168 "List of backup source
specifications ([<label
.ext
>:<path
>] ...)",
1169 backup_source_schema,
1174 StringSchema::new("Path to encryption key
. All data will be encrypted using this key
."))
1177 BooleanSchema::new("Verbose output
.").default(false))
1180 StringSchema::new("Use specified ID
for the backup group
name ('host
/<id
>'
). The
default is the system hostname
."))
1183 IntegerSchema::new("Chunk size
in KB
. Must be a power of
2.")
1189 .arg_param(vec!["repository
", "backupspec
"])
1190 .completion_cb("repository
", complete_repository)
1191 .completion_cb("backupspec
", complete_backup_source)
1192 .completion_cb("keyfile
", tools::complete_file_name)
1193 .completion_cb("chunk
-size
", complete_chunk_size);
1195 let list_cmd_def = CliCommand::new(
1198 ObjectSchema::new("List backup groups
.")
1199 .required("repository
", REPO_URL_SCHEMA.clone())
1201 .arg_param(vec!["repository
"])
1202 .completion_cb("repository
", complete_repository);
1204 let snapshots_cmd_def = CliCommand::new(
1207 ObjectSchema::new("List backup snapshots
.")
1208 .required("repository
", REPO_URL_SCHEMA.clone())
1209 .required("group
", StringSchema::new("Backup group
."))
1211 .arg_param(vec!["repository
", "group
"])
1212 .completion_cb("group
", complete_backup_group)
1213 .completion_cb("repository
", complete_repository);
1215 let forget_cmd_def = CliCommand::new(
1218 ObjectSchema::new("Forget (remove
) backup snapshots
.")
1219 .required("repository
", REPO_URL_SCHEMA.clone())
1220 .required("snapshot
", StringSchema::new("Snapshot path
."))
1222 .arg_param(vec!["repository
", "snapshot
"])
1223 .completion_cb("repository
", complete_repository)
1224 .completion_cb("snapshot
", complete_group_or_snapshot);
1226 let garbage_collect_cmd_def = CliCommand::new(
1228 start_garbage_collection,
1229 ObjectSchema::new("Start garbage collection
for a specific repository
.")
1230 .required("repository
", REPO_URL_SCHEMA.clone())
1232 .arg_param(vec!["repository
"])
1233 .completion_cb("repository
", complete_repository);
1235 let download_cmd_def = CliCommand::new(
1238 ObjectSchema::new("Download data from backup repository
.")
1239 .required("repository
", REPO_URL_SCHEMA.clone())
1240 .required("snapshot
", StringSchema::new("Group
/Snapshot path
."))
1241 .required("file
-name
", StringSchema::new("File name
."))
1242 .required("target
", StringSchema::new("Target directory path
."))
1243 .optional("keyfile
", StringSchema::new("Path to encryption key
."))
1245 .arg_param(vec!["repository
", "snapshot
", "file
-name
", "target
"])
1246 .completion_cb("repository
", complete_repository)
1247 .completion_cb("snapshot
", complete_group_or_snapshot)
1248 .completion_cb("file
-name
", complete_server_file_name)
1249 .completion_cb("keyfile
", tools::complete_file_name)
1250 .completion_cb("target
", tools::complete_file_name);
1252 let restore_cmd_def = CliCommand::new(
1255 ObjectSchema::new("Restore backup repository
.")
1256 .required("repository
", REPO_URL_SCHEMA.clone())
1257 .required("snapshot
", StringSchema::new("Group
/Snapshot path
."))
1258 .required("archive
-name
", StringSchema::new("Backup archive name
."))
1259 .required("target
", StringSchema::new("Target directory path
."))
1261 .arg_param(vec!["repository
", "snapshot
", "archive
-name
", "target
"])
1262 .completion_cb("repository
", complete_repository)
1263 .completion_cb("snapshot
", complete_group_or_snapshot)
1264 .completion_cb("archive
-name
", complete_archive_name)
1265 .completion_cb("target
", tools::complete_file_name);
1267 let prune_cmd_def = CliCommand::new(
1270 proxmox_backup::api2::admin::datastore::add_common_prune_prameters(
1271 ObjectSchema::new("Prune backup repository
.")
1272 .required("repository
", REPO_URL_SCHEMA.clone())
1275 .arg_param(vec!["repository
"])
1276 .completion_cb("repository
", complete_repository);
1278 let cmd_def = CliCommandMap::new()
1279 .insert("backup
".to_owned(), backup_cmd_def.into())
1280 .insert("forget
".to_owned(), forget_cmd_def.into())
1281 .insert("garbage
-collect
".to_owned(), garbage_collect_cmd_def.into())
1282 .insert("list
".to_owned(), list_cmd_def.into())
1283 .insert("prune
".to_owned(), prune_cmd_def.into())
1284 .insert("download
".to_owned(), download_cmd_def.into())
1285 .insert("restore
".to_owned(), restore_cmd_def.into())
1286 .insert("snapshots
".to_owned(), snapshots_cmd_def.into())
1287 .insert("key
".to_owned(), key_mgmt_cli().into());
1289 hyper::rt::run(futures::future::lazy(move || {
1290 run_cli_command(cmd_def.into());