2 extern crate proxmox_backup
;
5 use nix
::unistd
::{fork, ForkResult, pipe}
;
6 use std
::os
::unix
::io
::RawFd
;
7 use chrono
::{Local, Utc, TimeZone}
;
8 use std
::path
::{Path, PathBuf}
;
9 use std
::collections
::{HashSet, HashMap}
;
11 use std
::io
::{BufReader, Read, Write, Seek, SeekFrom}
;
12 use std
::os
::unix
::fs
::OpenOptionsExt
;
14 use proxmox
::tools
::fs
::{file_get_contents, file_get_json, file_set_contents, image_size}
;
16 use proxmox_backup
::tools
;
17 use proxmox_backup
::cli
::*;
18 use proxmox_backup
::api2
::types
::*;
19 use proxmox_backup
::api_schema
::*;
20 use proxmox_backup
::api_schema
::router
::*;
21 use proxmox_backup
::client
::*;
22 use proxmox_backup
::backup
::*;
23 use proxmox_backup
::pxar
::{ self, catalog::* }
;
25 //use proxmox_backup::backup::image_index::*;
26 //use proxmox_backup::config::datastore;
27 //use proxmox_backup::pxar::encoder::*;
28 //use proxmox_backup::backup::datastore::*;
30 use serde_json
::{json, Value}
;
32 use std
::sync
::{Arc, Mutex}
;
34 use xdg
::BaseDirectories
;
36 use lazy_static
::lazy_static
;
38 use tokio
::sync
::mpsc
;
41 static ref BACKUPSPEC_REGEX
: Regex
= Regex
::new(r
"^([a-zA-Z0-9_-]+\.(?:pxar|img|conf|log)):(.+)$").unwrap();
43 static ref REPO_URL_SCHEMA
: Arc
<Schema
> = Arc
::new(
44 StringSchema
::new("Repository URL.")
45 .format(BACKUP_REPO_URL
.clone())
52 fn get_default_repository() -> Option
<String
> {
53 std
::env
::var("PBS_REPOSITORY").ok()
56 fn extract_repository_from_value(
58 ) -> Result
<BackupRepository
, Error
> {
60 let repo_url
= param
["repository"]
63 .or_else(get_default_repository
)
64 .ok_or_else(|| format_err
!("unable to get (default) repository"))?
;
66 let repo
: BackupRepository
= repo_url
.parse()?
;
71 fn extract_repository_from_map(
72 param
: &HashMap
<String
, String
>,
73 ) -> Option
<BackupRepository
> {
75 param
.get("repository")
77 .or_else(get_default_repository
)
78 .and_then(|repo_url
| repo_url
.parse
::<BackupRepository
>().ok())
81 fn record_repository(repo
: &BackupRepository
) {
83 let base
= match BaseDirectories
::with_prefix("proxmox-backup") {
88 // usually $HOME/.cache/proxmox-backup/repo-list
89 let path
= match base
.place_cache_file("repo-list") {
94 let mut data
= file_get_json(&path
, None
).unwrap_or(json
!({}
));
96 let repo
= repo
.to_string();
98 data
[&repo
] = json
!{ data[&repo].as_i64().unwrap_or(0) + 1 }
;
100 let mut map
= serde_json
::map
::Map
::new();
103 let mut max_used
= 0;
104 let mut max_repo
= None
;
105 for (repo
, count
) in data
.as_object().unwrap() {
106 if map
.contains_key(repo
) { continue; }
107 if let Some(count
) = count
.as_i64() {
108 if count
> max_used
{
110 max_repo
= Some(repo
);
114 if let Some(repo
) = max_repo
{
115 map
.insert(repo
.to_owned(), json
!(max_used
));
119 if map
.len() > 10 { // store max. 10 repos
124 let new_data
= json
!(map
);
126 let _
= file_set_contents(path
, new_data
.to_string().as_bytes(), None
);
129 fn complete_repository(_arg
: &str, _param
: &HashMap
<String
, String
>) -> Vec
<String
> {
131 let mut result
= vec
![];
133 let base
= match BaseDirectories
::with_prefix("proxmox-backup") {
138 // usually $HOME/.cache/proxmox-backup/repo-list
139 let path
= match base
.place_cache_file("repo-list") {
144 let data
= file_get_json(&path
, None
).unwrap_or(json
!({}
));
146 if let Some(map
) = data
.as_object() {
147 for (repo
, _count
) in map
{
148 result
.push(repo
.to_owned());
155 fn compute_file_csum(file
: &mut std
::fs
::File
) -> Result
<([u8; 32], u64), Error
> {
157 file
.seek(SeekFrom
::Start(0))?
;
159 let mut hasher
= openssl
::sha
::Sha256
::new();
160 let mut buffer
= proxmox
::tools
::vec
::undefined(256*1024);
161 let mut size
: u64 = 0;
164 let count
= match file
.read(&mut buffer
) {
166 Err(ref err
) if err
.kind() == std
::io
::ErrorKind
::Interrupted
=> { continue; }
167 Err(err
) => return Err(err
.into()),
172 size
+= count
as u64;
173 hasher
.update(&buffer
[..count
]);
176 let csum
= hasher
.finish();
182 async
fn backup_directory
<P
: AsRef
<Path
>>(
183 client
: &BackupClient
,
186 chunk_size
: Option
<usize>,
187 device_set
: Option
<HashSet
<u64>>,
189 skip_lost_and_found
: bool
,
190 crypt_config
: Option
<Arc
<CryptConfig
>>,
191 catalog
: Arc
<Mutex
<CatalogBlobWriter
<std
::fs
::File
>>>,
192 ) -> Result
<BackupStats
, Error
> {
194 let pxar_stream
= PxarBackupStream
::open(dir_path
.as_ref(), device_set
, verbose
, skip_lost_and_found
, catalog
)?
;
195 let mut chunk_stream
= ChunkStream
::new(pxar_stream
, chunk_size
);
197 let (mut tx
, rx
) = mpsc
::channel(10); // allow to buffer 10 chunks
200 .map_err(Error
::from
);
202 // spawn chunker inside a separate task so that it can run parallel
203 tokio
::spawn(async
move {
204 let _
= tx
.send_all(&mut chunk_stream
).await
;
208 .upload_stream(archive_name
, stream
, "dynamic", None
, crypt_config
)
214 async
fn backup_image
<P
: AsRef
<Path
>>(
215 client
: &BackupClient
,
219 chunk_size
: Option
<usize>,
221 crypt_config
: Option
<Arc
<CryptConfig
>>,
222 ) -> Result
<BackupStats
, Error
> {
224 let path
= image_path
.as_ref().to_owned();
226 let file
= tokio
::fs
::File
::open(path
).await?
;
228 let stream
= tokio
::codec
::FramedRead
::new(file
, tokio
::codec
::BytesCodec
::new())
229 .map_err(Error
::from
);
231 let stream
= FixedChunkStream
::new(stream
, chunk_size
.unwrap_or(4*1024*1024));
234 .upload_stream(archive_name
, stream
, "fixed", Some(image_size
), crypt_config
)
240 fn strip_server_file_expenstion(name
: &str) -> String
{
242 if name
.ends_with(".didx") {
243 return name
[..name
.len()-5].to_owned();
244 } else if name
.ends_with(".fidx") {
245 return name
[..name
.len()-5].to_owned();
246 } else if name
.ends_with(".blob") {
247 return name
[..name
.len()-5].to_owned();
249 return name
.to_owned(); // should not happen
253 fn list_backup_groups(
256 _rpcenv
: &mut dyn RpcEnvironment
,
257 ) -> Result
<Value
, Error
> {
259 let repo
= extract_repository_from_value(¶m
)?
;
261 let client
= HttpClient
::new(repo
.host(), repo
.user(), None
)?
;
263 let path
= format
!("api2/json/admin/datastore/{}/groups", repo
.store());
265 let mut result
= async_main(async
move {
266 client
.get(&path
, None
).await
269 record_repository(&repo
);
271 // fixme: implement and use output formatter instead ..
272 let list
= result
["data"].as_array_mut().unwrap();
274 list
.sort_unstable_by(|a
, b
| {
275 let a_id
= a
["backup-id"].as_str().unwrap();
276 let a_backup_type
= a
["backup-type"].as_str().unwrap();
277 let b_id
= b
["backup-id"].as_str().unwrap();
278 let b_backup_type
= b
["backup-type"].as_str().unwrap();
280 let type_order
= a_backup_type
.cmp(b_backup_type
);
281 if type_order
== std
::cmp
::Ordering
::Equal
{
288 let output_format
= param
["output-format"].as_str().unwrap_or("text").to_owned();
290 let mut result
= vec
![];
294 let id
= item
["backup-id"].as_str().unwrap();
295 let btype
= item
["backup-type"].as_str().unwrap();
296 let epoch
= item
["last-backup"].as_i64().unwrap();
297 let last_backup
= Utc
.timestamp(epoch
, 0);
298 let backup_count
= item
["backup-count"].as_u64().unwrap();
300 let group
= BackupGroup
::new(btype
, id
);
302 let path
= group
.group_path().to_str().unwrap().to_owned();
304 let files
= item
["files"].as_array().unwrap().iter()
305 .map(|v
| strip_server_file_expenstion(v
.as_str().unwrap())).collect();
307 if output_format
== "text" {
309 "{:20} | {} | {:5} | {}",
311 BackupDir
::backup_time_to_string(last_backup
),
313 tools
::join(&files
, ' '
),
317 "backup-type": btype
,
319 "last-backup": epoch
,
320 "backup-count": backup_count
,
326 if output_format
!= "text" { format_and_print_result(&result.into(), &output_format); }
334 _rpcenv
: &mut dyn RpcEnvironment
,
335 ) -> Result
<Value
, Error
> {
337 let repo
= extract_repository_from_value(¶m
)?
;
339 let output_format
= param
["output-format"].as_str().unwrap_or("text").to_owned();
341 let client
= HttpClient
::new(repo
.host(), repo
.user(), None
)?
;
343 let path
= format
!("api2/json/admin/datastore/{}/snapshots", repo
.store());
345 let mut args
= json
!({}
);
346 if let Some(path
) = param
["group"].as_str() {
347 let group
= BackupGroup
::parse(path
)?
;
348 args
["backup-type"] = group
.backup_type().into();
349 args
["backup-id"] = group
.backup_id().into();
352 let result
= async_main(async
move {
353 client
.get(&path
, Some(args
)).await
356 record_repository(&repo
);
358 let list
= result
["data"].as_array().unwrap();
360 let mut result
= vec
![];
364 let id
= item
["backup-id"].as_str().unwrap();
365 let btype
= item
["backup-type"].as_str().unwrap();
366 let epoch
= item
["backup-time"].as_i64().unwrap();
368 let snapshot
= BackupDir
::new(btype
, id
, epoch
);
370 let path
= snapshot
.relative_path().to_str().unwrap().to_owned();
372 let files
= item
["files"].as_array().unwrap().iter()
373 .map(|v
| strip_server_file_expenstion(v
.as_str().unwrap())).collect();
375 if output_format
== "text" {
376 let size_str
= if let Some(size
) = item
["size"].as_u64() {
381 println
!("{} | {} | {}", path
, size_str
, tools
::join(&files
, ' '
));
383 let mut data
= json
!({
384 "backup-type": btype
,
386 "backup-time": epoch
,
389 if let Some(size
) = item
["size"].as_u64() {
390 data
["size"] = size
.into();
396 if output_format
!= "text" { format_and_print_result(&result.into(), &output_format); }
404 _rpcenv
: &mut dyn RpcEnvironment
,
405 ) -> Result
<Value
, Error
> {
407 let repo
= extract_repository_from_value(¶m
)?
;
409 let path
= tools
::required_string_param(¶m
, "snapshot")?
;
410 let snapshot
= BackupDir
::parse(path
)?
;
412 let mut client
= HttpClient
::new(repo
.host(), repo
.user(), None
)?
;
414 let path
= format
!("api2/json/admin/datastore/{}/snapshots", repo
.store());
416 let result
= async_main(async
move {
417 client
.delete(&path
, Some(json
!({
418 "backup-type": snapshot
.group().backup_type(),
419 "backup-id": snapshot
.group().backup_id(),
420 "backup-time": snapshot
.backup_time().timestamp(),
424 record_repository(&repo
);
432 _rpcenv
: &mut dyn RpcEnvironment
,
433 ) -> Result
<Value
, Error
> {
435 let repo
= extract_repository_from_value(¶m
)?
;
437 let client
= HttpClient
::new(repo
.host(), repo
.user(), None
)?
;
438 async_main(async
move { client.login().await }
)?
;
440 record_repository(&repo
);
448 _rpcenv
: &mut dyn RpcEnvironment
,
449 ) -> Result
<Value
, Error
> {
451 let repo
= extract_repository_from_value(¶m
)?
;
453 delete_ticket_info(repo
.host(), repo
.user())?
;
461 _rpcenv
: &mut dyn RpcEnvironment
,
462 ) -> Result
<Value
, Error
> {
464 let repo
= extract_repository_from_value(¶m
)?
;
466 let path
= tools
::required_string_param(¶m
, "snapshot")?
;
467 let snapshot
= BackupDir
::parse(path
)?
;
469 let keyfile
= param
["keyfile"].as_str().map(|p
| PathBuf
::from(p
));
471 let crypt_config
= match keyfile
{
474 let (key
, _
) = load_and_decrtypt_key(&path
, get_encryption_key_password
)?
;
475 Some(Arc
::new(CryptConfig
::new(key
)?
))
479 let client
= HttpClient
::new(repo
.host(), repo
.user(), None
)?
;
481 async_main(async
move {
482 let client
= client
.start_backup_reader(
484 &snapshot
.group().backup_type(),
485 &snapshot
.group().backup_id(),
486 snapshot
.backup_time(), true).await?
;
488 let backup_index_data
= download_index_blob(client
.clone(), crypt_config
.clone()).await?
;
489 let backup_index
: Value
= serde_json
::from_slice(&backup_index_data
[..])?
;
491 let blob_file
= std
::fs
::OpenOptions
::new()
494 .custom_flags(libc
::O_TMPFILE
)
497 let mut blob_file
= client
.download(CATALOG_BLOB_NAME
, blob_file
).await?
;
499 let (csum
, size
) = compute_file_csum(&mut blob_file
)?
;
500 verify_index_file(&backup_index
, CATALOG_BLOB_NAME
, &csum
, size
)?
;
502 blob_file
.seek(SeekFrom
::Start(0))?
;
504 let reader
= BufReader
::new(blob_file
);
505 let mut catalog_reader
= CatalogBlobReader
::new(reader
, crypt_config
)?
;
507 catalog_reader
.dump()?
;
509 record_repository(&repo
);
517 fn list_snapshot_files(
520 _rpcenv
: &mut dyn RpcEnvironment
,
521 ) -> Result
<Value
, Error
> {
523 let repo
= extract_repository_from_value(¶m
)?
;
525 let path
= tools
::required_string_param(¶m
, "snapshot")?
;
526 let snapshot
= BackupDir
::parse(path
)?
;
528 let output_format
= param
["output-format"].as_str().unwrap_or("text").to_owned();
530 let client
= HttpClient
::new(repo
.host(), repo
.user(), None
)?
;
532 let path
= format
!("api2/json/admin/datastore/{}/files", repo
.store());
534 let mut result
= async_main(async
move {
535 client
.get(&path
, Some(json
!({
536 "backup-type": snapshot
.group().backup_type(),
537 "backup-id": snapshot
.group().backup_id(),
538 "backup-time": snapshot
.backup_time().timestamp(),
542 record_repository(&repo
);
544 let list
: Value
= result
["data"].take();
546 if output_format
== "text" {
547 for item
in list
.as_array().unwrap().iter() {
550 strip_server_file_expenstion(item
["filename"].as_str().unwrap()),
551 item
["size"].as_u64().unwrap_or(0),
555 format_and_print_result(&list
, &output_format
);
561 fn start_garbage_collection(
564 _rpcenv
: &mut dyn RpcEnvironment
,
565 ) -> Result
<Value
, Error
> {
567 let repo
= extract_repository_from_value(¶m
)?
;
569 let mut client
= HttpClient
::new(repo
.host(), repo
.user(), None
)?
;
571 let path
= format
!("api2/json/admin/datastore/{}/gc", repo
.store());
573 let result
= async_main(async
move { client.post(&path, None).await }
)?
;
575 record_repository(&repo
);
580 fn parse_backupspec(value
: &str) -> Result
<(&str, &str), Error
> {
582 if let Some(caps
) = BACKUPSPEC_REGEX
.captures(value
) {
583 return Ok((caps
.get(1).unwrap().as_str(), caps
.get(2).unwrap().as_str()));
585 bail
!("unable to parse directory specification '{}'", value
);
591 _rpcenv
: &mut dyn RpcEnvironment
,
592 ) -> Result
<Value
, Error
> {
594 let repo
= extract_repository_from_value(¶m
)?
;
596 let backupspec_list
= tools
::required_array_param(¶m
, "backupspec")?
;
598 let all_file_systems
= param
["all-file-systems"].as_bool().unwrap_or(false);
600 let skip_lost_and_found
= param
["skip-lost-and-found"].as_bool().unwrap_or(false);
602 let verbose
= param
["verbose"].as_bool().unwrap_or(false);
604 let backup_time_opt
= param
["backup-time"].as_i64();
606 let chunk_size_opt
= param
["chunk-size"].as_u64().map(|v
| (v
*1024) as usize);
608 if let Some(size
) = chunk_size_opt
{
609 verify_chunk_size(size
)?
;
612 let keyfile
= param
["keyfile"].as_str().map(|p
| PathBuf
::from(p
));
614 let backup_id
= param
["backup-id"].as_str().unwrap_or(&proxmox
::tools
::nodename());
616 let backup_type
= param
["backup-type"].as_str().unwrap_or("host");
618 let include_dev
= param
["include-dev"].as_array();
620 let mut devices
= if all_file_systems { None }
else { Some(HashSet::new()) }
;
622 if let Some(include_dev
) = include_dev
{
623 if all_file_systems
{
624 bail
!("option 'all-file-systems' conflicts with option 'include-dev'");
627 let mut set
= HashSet
::new();
628 for path
in include_dev
{
629 let path
= path
.as_str().unwrap();
630 let stat
= nix
::sys
::stat
::stat(path
)
631 .map_err(|err
| format_err
!("fstat {:?} failed - {}", path
, err
))?
;
632 set
.insert(stat
.st_dev
);
637 let mut upload_list
= vec
![];
639 enum BackupType { PXAR, IMAGE, CONFIG, LOGFILE }
;
641 for backupspec
in backupspec_list
{
642 let (target
, filename
) = parse_backupspec(backupspec
.as_str().unwrap())?
;
644 use std
::os
::unix
::fs
::FileTypeExt
;
646 let metadata
= std
::fs
::metadata(filename
)
647 .map_err(|err
| format_err
!("unable to access '{}' - {}", filename
, err
))?
;
648 let file_type
= metadata
.file_type();
650 let extension
= target
.rsplit('
.'
).next()
651 .ok_or(format_err
!("missing target file extenion '{}'", target
))?
;
655 if !file_type
.is_dir() {
656 bail
!("got unexpected file type (expected directory)");
658 upload_list
.push((BackupType
::PXAR
, filename
.to_owned(), format
!("{}.didx", target
), 0));
662 if !(file_type
.is_file() || file_type
.is_block_device()) {
663 bail
!("got unexpected file type (expected file or block device)");
666 let size
= image_size(&PathBuf
::from(filename
))?
;
668 if size
== 0 { bail!("got zero-sized file '{}'
", filename); }
670 upload_list.push((BackupType::IMAGE, filename.to_owned(), format!("{}
.fidx
", target), size));
673 if !file_type.is_file() {
674 bail!("got unexpected file
type (expected regular file
)");
676 upload_list.push((BackupType::CONFIG, filename.to_owned(), format!("{}
.blob
", target), metadata.len()));
679 if !file_type.is_file() {
680 bail!("got unexpected file
type (expected regular file
)");
682 upload_list.push((BackupType::LOGFILE, filename.to_owned(), format!("{}
.blob
", target), metadata.len()));
685 bail!("got unknown archive extension '{}'
", extension);
690 let backup_time = Utc.timestamp(backup_time_opt.unwrap_or(Utc::now().timestamp()), 0);
692 let client = HttpClient::new(repo.host(), repo.user(), None)?;
693 record_repository(&repo);
695 println!("Starting backup
: {}
/{}
/{}
", backup_type, backup_id, BackupDir::backup_time_to_string(backup_time));
697 println!("Client name
: {}
", proxmox::tools::nodename());
699 let start_time = Local::now();
701 println!("Starting protocol
: {}
", start_time.to_rfc3339_opts(chrono::SecondsFormat::Secs, false));
703 let (crypt_config, rsa_encrypted_key) = match keyfile {
704 None => (None, None),
706 let (key, created) = load_and_decrtypt_key(&path, get_encryption_key_password)?;
708 let crypt_config = CryptConfig::new(key)?;
710 let path = master_pubkey_path()?;
712 let pem_data = file_get_contents(&path)?;
713 let rsa = openssl::rsa::Rsa::public_key_from_pem(&pem_data)?;
714 let enc_key = crypt_config.generate_rsa_encoded_key(rsa, created)?;
715 (Some(Arc::new(crypt_config)), Some(enc_key))
717 (Some(Arc::new(crypt_config)), None)
722 async_main(async move {
724 .start_backup(repo.store(), backup_type, &backup_id, backup_time, verbose)
727 let mut file_list = vec![];
729 // fixme: encrypt/sign catalog?
730 let catalog_file = std::fs::OpenOptions::new()
733 .custom_flags(libc::O_TMPFILE)
736 let catalog = Arc::new(Mutex::new(CatalogBlobWriter::new_compressed(catalog_file)?));
737 let mut upload_catalog = false;
739 for (backup_type, filename, target, size) in upload_list {
741 BackupType::CONFIG => {
742 println!("Upload config file '{}' to '{:?}'
as {}
", filename, repo, target);
744 .upload_blob_from_file(&filename, &target, crypt_config.clone(), true)
746 file_list.push((target, stats));
748 BackupType::LOGFILE => { // fixme: remove - not needed anymore ?
749 println!("Upload log file '{}' to '{:?}'
as {}
", filename, repo, target);
751 .upload_blob_from_file(&filename, &target, crypt_config.clone(), true)
753 file_list.push((target, stats));
755 BackupType::PXAR => {
756 upload_catalog = true;
757 println!("Upload directory '{}' to '{:?}'
as {}
", filename, repo, target);
758 catalog.lock().unwrap().start_directory(std::ffi::CString::new(target.as_str())?.as_c_str())?;
759 let stats = backup_directory(
767 crypt_config.clone(),
770 file_list.push((target, stats));
771 catalog.lock().unwrap().end_directory()?;
773 BackupType::IMAGE => {
774 println!("Upload image '{}' to '{:?}'
as {}
", filename, repo, target);
775 let stats = backup_image(
782 crypt_config.clone(),
784 file_list.push((target, stats));
789 // finalize and upload catalog
791 let mutex = Arc::try_unwrap(catalog)
792 .map_err(|_| format_err!("unable to get
catalog (still used
)"))?;
793 let mut catalog_file = mutex.into_inner().unwrap().finish()?;
795 let target = CATALOG_BLOB_NAME;
797 catalog_file.seek(SeekFrom::Start(0))?;
799 let stats = client.upload_blob(catalog_file, target).await?;
800 file_list.push((target.to_owned(), stats));
803 if let Some(rsa_encrypted_key) = rsa_encrypted_key {
804 let target = "rsa
-encrypted
.key
";
805 println!("Upload RSA encoded key to '{:?}'
as {}
", repo, target);
807 .upload_blob_from_data(rsa_encrypted_key, target, None, false, false)
809 file_list.push((format!("{}
.blob
", target), stats));
811 // openssl rsautl -decrypt -inkey master-private.pem -in rsa-encrypted.key -out t
813 let mut buffer2 = vec![0u8; rsa.size() as usize];
814 let pem_data = file_get_contents("master
-private
.pem
")?;
815 let rsa = openssl::rsa::Rsa::private_key_from_pem(&pem_data)?;
816 let len = rsa.private_decrypt(&buffer, &mut buffer2, openssl::rsa::Padding::PKCS1)?;
817 println!("TEST {} {:?}
", len, buffer2);
822 let file_list = file_list.iter()
823 .fold(vec![], |mut acc, (filename, stats)| {
825 "filename
": filename,
827 "csum
": proxmox::tools::digest_to_hex(&stats.csum),
833 "backup
-type": backup_type,
834 "backup
-id
": backup_id,
835 "backup
-time
": backup_time.timestamp(),
839 println!("Upload index
.json to '{:?}'
", repo);
840 let index_data = serde_json::to_string_pretty(&index)?.into();
842 .upload_blob_from_data(index_data, "index
.json
.blob
", crypt_config.clone(), true, true)
845 client.finish().await?;
847 let end_time = Local::now();
848 let elapsed = end_time.signed_duration_since(start_time);
849 println!("Duration
: {}
", elapsed);
851 println!("End Time
: {}
", end_time.to_rfc3339_opts(chrono::SecondsFormat::Secs, false));
857 fn complete_backup_source(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
859 let mut result = vec![];
861 let data: Vec<&str> = arg.splitn(2, ':').collect();
864 result.push(String::from("root
.pxar
:/"));
865 result.push(String::from("etc
.pxar
:/etc
"));
869 let files = tools::complete_file_name(data[1], param);
872 result.push(format!("{}
:{}
", data[0], file));
881 _rpcenv: &mut dyn RpcEnvironment,
882 ) -> Result<Value, Error> {
883 async_main(restore_do(param))
886 async fn download_index_blob(client: Arc<BackupReader>, crypt_config: Option<Arc<CryptConfig>>) -> Result<Vec<u8>, Error> {
888 let index_data = client.download(INDEX_BLOB_NAME, Vec::with_capacity(64*1024)).await?;
889 let blob = DataBlob::from_raw(index_data)?;
891 blob.decode(crypt_config.as_ref().map(Arc::as_ref))
894 fn verify_index_file(backup_index: &Value, name: &str, csum: &[u8; 32], size: u64) -> Result<(), Error> {
896 let files = backup_index["files
"]
898 .ok_or_else(|| format_err!("mailformed index
- missing 'files' property
"))?;
900 let info = files.iter().find(|v| {
901 match v["filename
"].as_str() {
902 Some(filename) => filename == name,
907 let info = match info {
908 None => bail!("index does not contain file '{}'
", name),
912 match info["size
"].as_u64() {
913 None => bail!("index does not contain property 'size'
for file '{}'
", name),
914 Some(expected_size) => {
915 if expected_size != size {
916 bail!("verify index failed
- wrong size
for file '{}'
({}
!= {}
", name, expected_size, size);
921 match info["csum
"].as_str() {
922 None => bail!("index does not contain property 'csum'
for file '{}'
", name),
923 Some(expected_csum) => {
924 let expected_csum = &proxmox::tools::hex_to_digest(expected_csum)?;
925 if expected_csum != csum {
926 bail!("verify index failed
- wrong checksum
for file '{}'
", name);
934 fn dump_image<W: Write>(
935 client: Arc<BackupReader>,
936 crypt_config: Option<Arc<CryptConfig>>,
937 index: FixedIndexReader,
939 ) -> Result<(), Error> {
941 let most_used = index.find_most_used_chunks(8);
943 let mut chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, most_used);
945 // Note: we avoid using BufferedFixedReader, because that add an additional buffer/copy
946 // and thus slows down reading. Instead, directly use RemoteChunkReader
947 for pos in 0..index.index_count() {
948 let digest = index.index_digest(pos).unwrap();
949 let raw_data = chunk_reader.read_chunk(&digest)?;
950 writer.write_all(&raw_data)?;
956 async fn restore_do(param: Value) -> Result<Value, Error> {
957 let repo = extract_repository_from_value(¶m)?;
959 let verbose = param["verbose
"].as_bool().unwrap_or(false);
961 let allow_existing_dirs = param["allow
-existing
-dirs
"].as_bool().unwrap_or(false);
963 let archive_name = tools::required_string_param(¶m, "archive
-name
")?;
965 let client = HttpClient::new(repo.host(), repo.user(), None)?;
967 record_repository(&repo);
969 let path = tools::required_string_param(¶m, "snapshot
")?;
971 let (backup_type, backup_id, backup_time) = if path.matches('/').count() == 1 {
972 let group = BackupGroup::parse(path)?;
974 let path = format!("api2
/json
/admin
/datastore
/{}
/snapshots
", repo.store());
975 let result = client.get(&path, Some(json!({
976 "backup
-type": group.backup_type(),
977 "backup
-id
": group.backup_id(),
980 let list = result["data
"].as_array().unwrap();
982 bail!("backup group '{}' does not contain any snapshots
:", path);
985 let epoch = list[0]["backup
-time
"].as_i64().unwrap();
986 let backup_time = Utc.timestamp(epoch, 0);
987 (group.backup_type().to_owned(), group.backup_id().to_owned(), backup_time)
989 let snapshot = BackupDir::parse(path)?;
990 (snapshot.group().backup_type().to_owned(), snapshot.group().backup_id().to_owned(), snapshot.backup_time())
993 let target = tools::required_string_param(¶m, "target
")?;
994 let target = if target == "-" { None } else { Some(target) };
996 let keyfile = param["keyfile
"].as_str().map(|p| PathBuf::from(p));
998 let crypt_config = match keyfile {
1001 let (key, _) = load_and_decrtypt_key(&path, get_encryption_key_password)?;
1002 Some(Arc::new(CryptConfig::new(key)?))
1006 let server_archive_name = if archive_name.ends_with(".pxar
") {
1007 format!("{}
.didx
", archive_name)
1008 } else if archive_name.ends_with(".img
") {
1009 format!("{}
.fidx
", archive_name)
1011 format!("{}
.blob
", archive_name)
1015 .start_backup_reader(repo.store(), &backup_type, &backup_id, backup_time, true)
1018 let tmpfile = std::fs::OpenOptions::new()
1021 .custom_flags(libc::O_TMPFILE)
1025 let backup_index_data = download_index_blob(client.clone(), crypt_config.clone()).await?;
1026 let backup_index: Value = serde_json::from_slice(&backup_index_data[..])?;
1028 if server_archive_name == INDEX_BLOB_NAME {
1029 if let Some(target) = target {
1030 file_set_contents(target, &backup_index_data, None)?;
1032 let stdout = std::io::stdout();
1033 let mut writer = stdout.lock();
1034 writer.write_all(&backup_index_data)
1035 .map_err(|err| format_err!("unable to pipe data
- {}
", err))?;
1038 } else if server_archive_name.ends_with(".blob
") {
1039 let mut tmpfile = client.download(&server_archive_name, tmpfile).await?;
1041 let (csum, size) = compute_file_csum(&mut tmpfile)?;
1042 verify_index_file(&backup_index, &server_archive_name, &csum, size)?;
1044 tmpfile.seek(SeekFrom::Start(0))?;
1045 let mut reader = DataBlobReader::new(tmpfile, crypt_config)?;
1047 if let Some(target) = target {
1048 let mut writer = std::fs::OpenOptions::new()
1053 .map_err(|err| format_err!("unable to create target file {:?}
- {}
", target, err))?;
1054 std::io::copy(&mut reader, &mut writer)?;
1056 let stdout = std::io::stdout();
1057 let mut writer = stdout.lock();
1058 std::io::copy(&mut reader, &mut writer)
1059 .map_err(|err| format_err!("unable to pipe data
- {}
", err))?;
1062 } else if server_archive_name.ends_with(".didx
") {
1063 let tmpfile = client.download(&server_archive_name, tmpfile).await?;
1065 let index = DynamicIndexReader::new(tmpfile)
1066 .map_err(|err| format_err!("unable to read dynamic index '{}'
- {}
", archive_name, err))?;
1068 // Note: do not use values stored in index (not trusted) - instead, computed them again
1069 let (csum, size) = index.compute_csum();
1071 verify_index_file(&backup_index, &server_archive_name, &csum, size)?;
1073 let most_used = index.find_most_used_chunks(8);
1075 let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, most_used);
1077 let mut reader = BufferedDynamicReader::new(index, chunk_reader);
1079 if let Some(target) = target {
1081 let feature_flags = pxar::flags::DEFAULT;
1082 let mut decoder = pxar::SequentialDecoder::new(&mut reader, feature_flags, |path| {
1084 println!("{:?}
", path);
1088 decoder.set_allow_existing_dirs(allow_existing_dirs);
1091 decoder.restore(Path::new(target), &Vec::new())?;
1093 let mut writer = std::fs::OpenOptions::new()
1095 .open("/dev
/stdout
")
1096 .map_err(|err| format_err!("unable to open
/dev
/stdout
- {}
", err))?;
1098 std::io::copy(&mut reader, &mut writer)
1099 .map_err(|err| format_err!("unable to pipe data
- {}
", err))?;
1101 } else if server_archive_name.ends_with(".fidx
") {
1102 let tmpfile = client.download(&server_archive_name, tmpfile).await?;
1104 let index = FixedIndexReader::new(tmpfile)
1105 .map_err(|err| format_err!("unable to read fixed index '{}'
- {}
", archive_name, err))?;
1107 // Note: do not use values stored in index (not trusted) - instead, computed them again
1108 let (csum, size) = index.compute_csum();
1110 verify_index_file(&backup_index, &server_archive_name, &csum, size)?;
1112 let mut writer = if let Some(target) = target {
1113 std::fs::OpenOptions::new()
1118 .map_err(|err| format_err!("unable to create target file {:?}
- {}
", target, err))?
1120 std::fs::OpenOptions::new()
1122 .open("/dev
/stdout
")
1123 .map_err(|err| format_err!("unable to open
/dev
/stdout
- {}
", err))?
1126 dump_image(client.clone(), crypt_config.clone(), index, &mut writer)?;
1129 bail!("unknown archive file
extension (expected
.pxar of
.img
)");
1138 _rpcenv: &mut dyn RpcEnvironment,
1139 ) -> Result<Value, Error> {
1141 let logfile = tools::required_string_param(¶m, "logfile
")?;
1142 let repo = extract_repository_from_value(¶m)?;
1144 let snapshot = tools::required_string_param(¶m, "snapshot
")?;
1145 let snapshot = BackupDir::parse(snapshot)?;
1147 let mut client = HttpClient::new(repo.host(), repo.user(), None)?;
1149 let keyfile = param["keyfile
"].as_str().map(|p| PathBuf::from(p));
1151 let crypt_config = match keyfile {
1154 let (key, _created) = load_and_decrtypt_key(&path, get_encryption_key_password)?;
1155 let crypt_config = CryptConfig::new(key)?;
1156 Some(Arc::new(crypt_config))
1160 let data = file_get_contents(logfile)?;
1162 let blob = DataBlob::encode(&data, crypt_config.as_ref().map(Arc::as_ref), true)?;
1164 let raw_data = blob.into_inner();
1166 let path = format!("api2
/json
/admin
/datastore
/{}
/upload
-backup
-log
", repo.store());
1169 "backup
-type": snapshot.group().backup_type(),
1170 "backup
-id
": snapshot.group().backup_id(),
1171 "backup
-time
": snapshot.backup_time().timestamp(),
1174 let body = hyper::Body::from(raw_data);
1176 async_main(async move {
1177 client.upload("application
/octet
-stream
", body, &path, Some(args)).await
1184 _rpcenv: &mut dyn RpcEnvironment,
1185 ) -> Result<Value, Error> {
1187 let repo = extract_repository_from_value(¶m)?;
1189 let mut client = HttpClient::new(repo.host(), repo.user(), None)?;
1191 let path = format!("api2
/json
/admin
/datastore
/{}
/prune
", repo.store());
1193 let group = tools::required_string_param(¶m, "group
")?;
1194 let group = BackupGroup::parse(group)?;
1196 param.as_object_mut().unwrap().remove("repository
");
1197 param.as_object_mut().unwrap().remove("group
");
1199 param["backup
-type"] = group.backup_type().into();
1200 param["backup
-id
"] = group.backup_id().into();
1202 let _result = async_main(async move { client.post(&path, Some(param)).await })?;
1204 record_repository(&repo);
1212 _rpcenv: &mut dyn RpcEnvironment,
1213 ) -> Result<Value, Error> {
1215 let repo = extract_repository_from_value(¶m)?;
1217 let output_format = param["output
-format
"].as_str().unwrap_or("text
").to_owned();
1219 let client = HttpClient::new(repo.host(), repo.user(), None)?;
1221 let path = format!("api2
/json
/admin
/datastore
/{}
/status
", repo.store());
1223 let result = async_main(async move { client.get(&path, None).await })?;
1224 let data = &result["data
"];
1226 record_repository(&repo);
1228 if output_format == "text
" {
1229 let total = data["total
"].as_u64().unwrap();
1230 let used = data["used
"].as_u64().unwrap();
1231 let avail = data["avail
"].as_u64().unwrap();
1232 let roundup = total/200;
1235 "total
: {} used
: {}
({}
%) available
: {}
",
1238 ((used+roundup)*100)/total,
1242 format_and_print_result(data, &output_format);
1248 // like get, but simply ignore errors and return Null instead
1249 async fn try_get(repo: &BackupRepository, url: &str) -> Value {
1251 let client = match HttpClient::new(repo.host(), repo.user(), None) {
1253 _ => return Value::Null,
1256 let mut resp = match client.get(url, None).await {
1258 _ => return Value::Null,
1261 if let Some(map) = resp.as_object_mut() {
1262 if let Some(data) = map.remove("data
") {
1269 fn complete_backup_group(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1270 async_main(async { complete_backup_group_do(param).await })
1273 async fn complete_backup_group_do(param: &HashMap<String, String>) -> Vec<String> {
1275 let mut result = vec![];
1277 let repo = match extract_repository_from_map(param) {
1282 let path = format!("api2
/json
/admin
/datastore
/{}
/groups
", repo.store());
1284 let data = try_get(&repo, &path).await;
1286 if let Some(list) = data.as_array() {
1288 if let (Some(backup_id), Some(backup_type)) =
1289 (item["backup
-id
"].as_str(), item["backup
-type"].as_str())
1291 result.push(format!("{}
/{}
", backup_type, backup_id));
1299 fn complete_group_or_snapshot(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1300 async_main(async { complete_group_or_snapshot_do(arg, param).await })
1303 async fn complete_group_or_snapshot_do(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1305 if arg.matches('/').count() < 2 {
1306 let groups = complete_backup_group_do(param).await;
1307 let mut result = vec![];
1308 for group in groups {
1309 result.push(group.to_string());
1310 result.push(format!("{}
/", group));
1315 complete_backup_snapshot_do(param).await
1318 fn complete_backup_snapshot(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1319 async_main(async { complete_backup_snapshot_do(param).await })
1322 async fn complete_backup_snapshot_do(param: &HashMap<String, String>) -> Vec<String> {
1324 let mut result = vec![];
1326 let repo = match extract_repository_from_map(param) {
1331 let path = format!("api2
/json
/admin
/datastore
/{}
/snapshots
", repo.store());
1333 let data = try_get(&repo, &path).await;
1335 if let Some(list) = data.as_array() {
1337 if let (Some(backup_id), Some(backup_type), Some(backup_time)) =
1338 (item["backup
-id
"].as_str(), item["backup
-type"].as_str(), item["backup
-time
"].as_i64())
1340 let snapshot = BackupDir::new(backup_type, backup_id, backup_time);
1341 result.push(snapshot.relative_path().to_str().unwrap().to_owned());
1349 fn complete_server_file_name(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1350 async_main(async { complete_server_file_name_do(param).await })
1353 async fn complete_server_file_name_do(param: &HashMap<String, String>) -> Vec<String> {
1355 let mut result = vec![];
1357 let repo = match extract_repository_from_map(param) {
1362 let snapshot = match param.get("snapshot
") {
1364 match BackupDir::parse(path) {
1372 let query = tools::json_object_to_query(json!({
1373 "backup
-type": snapshot.group().backup_type(),
1374 "backup
-id
": snapshot.group().backup_id(),
1375 "backup
-time
": snapshot.backup_time().timestamp(),
1378 let path = format!("api2
/json
/admin
/datastore
/{}
/files?{}
", repo.store(), query);
1380 let data = try_get(&repo, &path).await;
1382 if let Some(list) = data.as_array() {
1384 if let Some(filename) = item["filename
"].as_str() {
1385 result.push(filename.to_owned());
1393 fn complete_archive_name(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1394 complete_server_file_name(arg, param)
1396 .map(|v| strip_server_file_expenstion(&v))
1400 fn complete_chunk_size(_arg: &str, _param: &HashMap<String, String>) -> Vec<String> {
1402 let mut result = vec![];
1406 result.push(size.to_string());
1408 if size > 4096 { break; }
1414 fn get_encryption_key_password() -> Result<Vec<u8>, Error> {
1416 // fixme: implement other input methods
1418 use std::env::VarError::*;
1419 match std::env::var("PBS_ENCRYPTION_PASSWORD
") {
1420 Ok(p) => return Ok(p.as_bytes().to_vec()),
1421 Err(NotUnicode(_)) => bail!("PBS_ENCRYPTION_PASSWORD contains bad characters
"),
1422 Err(NotPresent) => {
1423 // Try another method
1427 // If we're on a TTY, query the user for a password
1428 if crate::tools::tty::stdin_isatty() {
1429 return Ok(crate::tools::tty::read_password("Encryption Key Password
: ")?);
1432 bail!("no password input mechanism available
");
1438 _rpcenv: &mut dyn RpcEnvironment,
1439 ) -> Result<Value, Error> {
1441 let path = tools::required_string_param(¶m, "path
")?;
1442 let path = PathBuf::from(path);
1444 let kdf = param["kdf
"].as_str().unwrap_or("scrypt
");
1446 let key = proxmox::sys::linux::random_data(32)?;
1448 if kdf == "scrypt
" {
1449 // always read passphrase from tty
1450 if !crate::tools::tty::stdin_isatty() {
1451 bail!("unable to read passphrase
- no tty
");
1454 let password = crate::tools::tty::read_password("Encryption Key Password
: ")?;
1456 let key_config = encrypt_key_with_passphrase(&key, &password)?;
1458 store_key_config(&path, false, key_config)?;
1461 } else if kdf == "none
" {
1462 let created = Local.timestamp(Local::now().timestamp(), 0);
1464 store_key_config(&path, false, KeyConfig {
1477 fn master_pubkey_path() -> Result<PathBuf, Error> {
1478 let base = BaseDirectories::with_prefix("proxmox
-backup
")?;
1480 // usually $HOME/.config/proxmox-backup/master-public.pem
1481 let path = base.place_config_file("master
-public
.pem
")?;
1486 fn key_import_master_pubkey(
1489 _rpcenv: &mut dyn RpcEnvironment,
1490 ) -> Result<Value, Error> {
1492 let path = tools::required_string_param(¶m, "path
")?;
1493 let path = PathBuf::from(path);
1495 let pem_data = file_get_contents(&path)?;
1497 if let Err(err) = openssl::pkey::PKey::public_key_from_pem(&pem_data) {
1498 bail!("Unable to decode PEM data
- {}
", err);
1501 let target_path = master_pubkey_path()?;
1503 file_set_contents(&target_path, &pem_data, None)?;
1505 println!("Imported public master key to {:?}
", target_path);
1510 fn key_create_master_key(
1513 _rpcenv: &mut dyn RpcEnvironment,
1514 ) -> Result<Value, Error> {
1516 // we need a TTY to query the new password
1517 if !crate::tools::tty::stdin_isatty() {
1518 bail!("unable to create master key
- no tty
");
1521 let rsa = openssl::rsa::Rsa::generate(4096)?;
1522 let pkey = openssl::pkey::PKey::from_rsa(rsa)?;
1524 let new_pw = String::from_utf8(crate::tools::tty::read_password("Master Key Password
: ")?)?;
1525 let verify_pw = String::from_utf8(crate::tools::tty::read_password("Verify Password
: ")?)?;
1527 if new_pw != verify_pw {
1528 bail!("Password verification fail
!");
1531 if new_pw.len() < 5 {
1532 bail!("Password is too short
!");
1535 let pub_key: Vec<u8> = pkey.public_key_to_pem()?;
1536 let filename_pub = "master
-public
.pem
";
1537 println!("Writing public master key to {}
", filename_pub);
1538 file_set_contents(filename_pub, pub_key.as_slice(), None)?;
1540 let cipher = openssl::symm::Cipher::aes_256_cbc();
1541 let priv_key: Vec<u8> = pkey.private_key_to_pem_pkcs8_passphrase(cipher, new_pw.as_bytes())?;
1543 let filename_priv = "master
-private
.pem
";
1544 println!("Writing private master key to {}
", filename_priv);
1545 file_set_contents(filename_priv, priv_key.as_slice(), None)?;
1550 fn key_change_passphrase(
1553 _rpcenv: &mut dyn RpcEnvironment,
1554 ) -> Result<Value, Error> {
1556 let path = tools::required_string_param(¶m, "path
")?;
1557 let path = PathBuf::from(path);
1559 let kdf = param["kdf
"].as_str().unwrap_or("scrypt
");
1561 // we need a TTY to query the new password
1562 if !crate::tools::tty::stdin_isatty() {
1563 bail!("unable to change passphrase
- no tty
");
1566 let (key, created) = load_and_decrtypt_key(&path, get_encryption_key_password)?;
1568 if kdf == "scrypt
" {
1570 let new_pw = String::from_utf8(crate::tools::tty::read_password("New Password
: ")?)?;
1571 let verify_pw = String::from_utf8(crate::tools::tty::read_password("Verify Password
: ")?)?;
1573 if new_pw != verify_pw {
1574 bail!("Password verification fail
!");
1577 if new_pw.len() < 5 {
1578 bail!("Password is too short
!");
1581 let mut new_key_config = encrypt_key_with_passphrase(&key, new_pw.as_bytes())?;
1582 new_key_config.created = created; // keep original value
1584 store_key_config(&path, true, new_key_config)?;
1587 } else if kdf == "none
" {
1588 let modified = Local.timestamp(Local::now().timestamp(), 0);
1590 store_key_config(&path, true, KeyConfig {
1592 created, // keep original value
1603 fn key_mgmt_cli() -> CliCommandMap {
1605 let kdf_schema: Arc<Schema> = Arc::new(
1606 StringSchema::new("Key derivation function
. Choose 'none' to store the key unecrypted
.")
1607 .format(Arc::new(ApiStringFormat::Enum(&["scrypt
", "none
"])))
1612 let key_create_cmd_def = CliCommand::new(
1615 ObjectSchema::new("Create a new encryption key
.")
1616 .required("path
", StringSchema::new("File system path
."))
1617 .optional("kdf
", kdf_schema.clone())
1619 .arg_param(vec!["path
"])
1620 .completion_cb("path
", tools::complete_file_name);
1622 let key_change_passphrase_cmd_def = CliCommand::new(
1624 key_change_passphrase,
1625 ObjectSchema::new("Change the passphrase required to decrypt the key
.")
1626 .required("path
", StringSchema::new("File system path
."))
1627 .optional("kdf
", kdf_schema.clone())
1629 .arg_param(vec!["path
"])
1630 .completion_cb("path
", tools::complete_file_name);
1632 let key_create_master_key_cmd_def = CliCommand::new(
1634 key_create_master_key,
1635 ObjectSchema::new("Create a new
4096 bit RSA master
pub/priv key pair
.")
1638 let key_import_master_pubkey_cmd_def = CliCommand::new(
1640 key_import_master_pubkey,
1641 ObjectSchema::new("Import a new RSA public key and
use it
as master key
. The key is expected to be
in '
.pem' format
.")
1642 .required("path
", StringSchema::new("File system path
."))
1644 .arg_param(vec!["path
"])
1645 .completion_cb("path
", tools::complete_file_name);
1647 let cmd_def = CliCommandMap::new()
1648 .insert("create
".to_owned(), key_create_cmd_def.into())
1649 .insert("create
-master
-key
".to_owned(), key_create_master_key_cmd_def.into())
1650 .insert("import
-master
-pubkey
".to_owned(), key_import_master_pubkey_cmd_def.into())
1651 .insert("change
-passphrase
".to_owned(), key_change_passphrase_cmd_def.into());
1660 _rpcenv: &mut dyn RpcEnvironment,
1661 ) -> Result<Value, Error> {
1662 let verbose = param["verbose
"].as_bool().unwrap_or(false);
1664 // This will stay in foreground with debug output enabled as None is
1665 // passed for the RawFd.
1666 return async_main(mount_do(param, None));
1669 // Process should be deamonized.
1670 // Make sure to fork before the async runtime is instantiated to avoid troubles.
1673 Ok(ForkResult::Parent { child: _, .. }) => {
1674 nix::unistd::close(pipe.1).unwrap();
1675 // Blocks the parent process until we are ready to go in the child
1676 let _res = nix::unistd::read(pipe.0, &mut [0]).unwrap();
1679 Ok(ForkResult::Child) => {
1680 nix::unistd::close(pipe.0).unwrap();
1681 nix::unistd::setsid().unwrap();
1682 async_main(mount_do(param, Some(pipe.1)))
1684 Err(_) => bail!("failed to daemonize process
"),
1688 async fn mount_do(param: Value, pipe: Option<RawFd>) -> Result<Value, Error> {
1689 let repo = extract_repository_from_value(¶m)?;
1690 let archive_name = tools::required_string_param(¶m, "archive
-name
")?;
1691 let target = tools::required_string_param(¶m, "target
")?;
1692 let client = HttpClient::new(repo.host(), repo.user(), None)?;
1694 record_repository(&repo);
1696 let path = tools::required_string_param(¶m, "snapshot
")?;
1697 let (backup_type, backup_id, backup_time) = if path.matches('/').count() == 1 {
1698 let group = BackupGroup::parse(path)?;
1700 let path = format!("api2
/json
/admin
/datastore
/{}
/snapshots
", repo.store());
1701 let result = client.get(&path, Some(json!({
1702 "backup
-type": group.backup_type(),
1703 "backup
-id
": group.backup_id(),
1706 let list = result["data
"].as_array().unwrap();
1707 if list.len() == 0 {
1708 bail!("backup group '{}' does not contain any snapshots
:", path);
1711 let epoch = list[0]["backup
-time
"].as_i64().unwrap();
1712 let backup_time = Utc.timestamp(epoch, 0);
1713 (group.backup_type().to_owned(), group.backup_id().to_owned(), backup_time)
1715 let snapshot = BackupDir::parse(path)?;
1716 (snapshot.group().backup_type().to_owned(), snapshot.group().backup_id().to_owned(), snapshot.backup_time())
1719 let keyfile = param["keyfile
"].as_str().map(|p| PathBuf::from(p));
1720 let crypt_config = match keyfile {
1723 let (key, _) = load_and_decrtypt_key(&path, get_encryption_key_password)?;
1724 Some(Arc::new(CryptConfig::new(key)?))
1728 let server_archive_name = if archive_name.ends_with(".pxar
") {
1729 format!("{}
.didx
", archive_name)
1731 bail!("Can only mount pxar archives
.");
1735 .start_backup_reader(repo.store(), &backup_type, &backup_id, backup_time, true)
1738 let tmpfile = std::fs::OpenOptions::new()
1741 .custom_flags(libc::O_TMPFILE)
1744 let backup_index_data = download_index_blob(client.clone(), crypt_config.clone()).await?;
1745 let backup_index: Value = serde_json::from_slice(&backup_index_data[..])?;
1746 if server_archive_name.ends_with(".didx
") {
1747 let tmpfile = client.download(&server_archive_name, tmpfile).await?;
1748 let index = DynamicIndexReader::new(tmpfile)
1749 .map_err(|err| format_err!("unable to read dynamic index '{}'
- {}
", archive_name, err))?;
1751 // Note: do not use values stored in index (not trusted) - instead, computed them again
1752 let (csum, size) = index.compute_csum();
1753 verify_index_file(&backup_index, &server_archive_name, &csum, size)?;
1755 let most_used = index.find_most_used_chunks(8);
1756 let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, most_used);
1757 let reader = BufferedDynamicReader::new(index, chunk_reader);
1759 pxar::Decoder::<Box<dyn pxar::fuse::ReadSeek>, fn(&Path) -> Result<(), Error>>::new(
1763 let options = OsStr::new("ro
,default_permissions
");
1764 let mut session = pxar::fuse::Session::from_decoder(decoder, &options, pipe.is_none())
1765 .map_err(|err| format_err!("pxar mount failed
: {}
", err))?;
1767 // Mount the session but not call fuse deamonize as this will cause
1768 // issues with the runtime after the fork
1769 let deamonize = false;
1770 session.mount(&Path::new(target), deamonize)?;
1772 if let Some(pipe) = pipe {
1773 nix::unistd::chdir(Path::new("/")).unwrap();
1774 // Finish creation of deamon by redirecting filedescriptors.
1775 let nullfd = nix::fcntl::open(
1777 nix::fcntl::OFlag::O_RDWR,
1778 nix::sys::stat::Mode::empty(),
1780 nix::unistd::dup2(nullfd, 0).unwrap();
1781 nix::unistd::dup2(nullfd, 1).unwrap();
1782 nix::unistd::dup2(nullfd, 2).unwrap();
1784 nix::unistd::close(nullfd).unwrap();
1786 // Signal the parent process that we are done with the setup and it can
1788 nix::unistd::write(pipe, &mut [0u8])?;
1789 nix::unistd::close(pipe).unwrap();
1792 let multithreaded = true;
1793 session.run_loop(multithreaded)?;
1795 bail!("unknown archive file
extension (expected
.pxar
)");
1803 let backup_source_schema: Arc<Schema> = Arc::new(
1804 StringSchema::new("Backup source
specification ([<label
>:<path
>]).")
1805 .format(Arc::new(ApiStringFormat::Pattern(&BACKUPSPEC_REGEX)))
1809 let backup_cmd_def = CliCommand::new(
1812 ObjectSchema::new("Create (host
) backup
.")
1816 "List of backup source
specifications ([<label
.ext
>:<path
>] ...)",
1817 backup_source_schema,
1820 .optional("repository
", REPO_URL_SCHEMA.clone())
1824 "Include mountpoints with same st_dev
number (see ``man fstat``
) as specified files
.",
1825 StringSchema::new("Path to file
.").into()
1830 StringSchema::new("Path to encryption key
. All data will be encrypted using this key
."))
1833 BooleanSchema::new("Verbose output
.").default(false))
1835 "skip
-lost
-and
-found
",
1836 BooleanSchema::new("Skip lost
+found directory
").default(false))
1839 BACKUP_TYPE_SCHEMA.clone()
1843 BACKUP_ID_SCHEMA.clone()
1847 BACKUP_TIME_SCHEMA.clone()
1851 IntegerSchema::new("Chunk size
in KB
. Must be a power of
2.")
1857 .arg_param(vec!["backupspec
"])
1858 .completion_cb("repository
", complete_repository)
1859 .completion_cb("backupspec
", complete_backup_source)
1860 .completion_cb("keyfile
", tools::complete_file_name)
1861 .completion_cb("chunk
-size
", complete_chunk_size);
1863 let upload_log_cmd_def = CliCommand::new(
1866 ObjectSchema::new("Upload backup log file
.")
1867 .required("snapshot
", StringSchema::new("Snapshot path
."))
1868 .required("logfile
", StringSchema::new("The path to the log file you want to upload
."))
1869 .optional("repository
", REPO_URL_SCHEMA.clone())
1872 StringSchema::new("Path to encryption key
. All data will be encrypted using this key
."))
1874 .arg_param(vec!["snapshot
", "logfile
"])
1875 .completion_cb("snapshot
", complete_backup_snapshot)
1876 .completion_cb("logfile
", tools::complete_file_name)
1877 .completion_cb("keyfile
", tools::complete_file_name)
1878 .completion_cb("repository
", complete_repository);
1880 let list_cmd_def = CliCommand::new(
1883 ObjectSchema::new("List backup groups
.")
1884 .optional("repository
", REPO_URL_SCHEMA.clone())
1885 .optional("output
-format
", OUTPUT_FORMAT.clone())
1887 .completion_cb("repository
", complete_repository);
1889 let snapshots_cmd_def = CliCommand::new(
1892 ObjectSchema::new("List backup snapshots
.")
1893 .optional("group
", StringSchema::new("Backup group
."))
1894 .optional("repository
", REPO_URL_SCHEMA.clone())
1895 .optional("output
-format
", OUTPUT_FORMAT.clone())
1897 .arg_param(vec!["group
"])
1898 .completion_cb("group
", complete_backup_group)
1899 .completion_cb("repository
", complete_repository);
1901 let forget_cmd_def = CliCommand::new(
1904 ObjectSchema::new("Forget (remove
) backup snapshots
.")
1905 .required("snapshot
", StringSchema::new("Snapshot path
."))
1906 .optional("repository
", REPO_URL_SCHEMA.clone())
1908 .arg_param(vec!["snapshot
"])
1909 .completion_cb("repository
", complete_repository)
1910 .completion_cb("snapshot
", complete_backup_snapshot);
1912 let garbage_collect_cmd_def = CliCommand::new(
1914 start_garbage_collection,
1915 ObjectSchema::new("Start garbage collection
for a specific repository
.")
1916 .optional("repository
", REPO_URL_SCHEMA.clone())
1918 .completion_cb("repository
", complete_repository);
1920 let restore_cmd_def = CliCommand::new(
1923 ObjectSchema::new("Restore backup repository
.")
1924 .required("snapshot
", StringSchema::new("Group
/Snapshot path
."))
1925 .required("archive
-name
", StringSchema::new("Backup archive name
."))
1926 .required("target
", StringSchema::new(r###"Target directory path
. Use '
-' to write to stdandard output
.
1928 We
do not extraxt '
.pxar' archives when writing to stdandard output
.
1933 "allow
-existing
-dirs
",
1934 BooleanSchema::new("Do not fail
if directories already exists
.").default(false))
1935 .optional("repository
", REPO_URL_SCHEMA.clone())
1936 .optional("keyfile
", StringSchema::new("Path to encryption key
."))
1939 BooleanSchema::new("Verbose output
.").default(false)
1942 .arg_param(vec!["snapshot
", "archive
-name
", "target
"])
1943 .completion_cb("repository
", complete_repository)
1944 .completion_cb("snapshot
", complete_group_or_snapshot)
1945 .completion_cb("archive
-name
", complete_archive_name)
1946 .completion_cb("target
", tools::complete_file_name);
1948 let files_cmd_def = CliCommand::new(
1950 list_snapshot_files,
1951 ObjectSchema::new("List snapshot files
.")
1952 .required("snapshot
", StringSchema::new("Snapshot path
."))
1953 .optional("repository
", REPO_URL_SCHEMA.clone())
1954 .optional("output
-format
", OUTPUT_FORMAT.clone())
1956 .arg_param(vec!["snapshot
"])
1957 .completion_cb("repository
", complete_repository)
1958 .completion_cb("snapshot
", complete_backup_snapshot);
1960 let catalog_cmd_def = CliCommand::new(
1963 ObjectSchema::new("Dump catalog
.")
1964 .required("snapshot
", StringSchema::new("Snapshot path
."))
1965 .optional("repository
", REPO_URL_SCHEMA.clone())
1967 .arg_param(vec!["snapshot
"])
1968 .completion_cb("repository
", complete_repository)
1969 .completion_cb("snapshot
", complete_backup_snapshot);
1971 let prune_cmd_def = CliCommand::new(
1974 proxmox_backup::api2::admin::datastore::add_common_prune_prameters(
1975 ObjectSchema::new("Prune backup repository
.")
1976 .required("group
", StringSchema::new("Backup group
."))
1977 .optional("repository
", REPO_URL_SCHEMA.clone())
1980 .arg_param(vec!["group
"])
1981 .completion_cb("group
", complete_backup_group)
1982 .completion_cb("repository
", complete_repository);
1984 let status_cmd_def = CliCommand::new(
1987 ObjectSchema::new("Get repository status
.")
1988 .optional("repository
", REPO_URL_SCHEMA.clone())
1989 .optional("output
-format
", OUTPUT_FORMAT.clone())
1991 .completion_cb("repository
", complete_repository);
1993 let login_cmd_def = CliCommand::new(
1996 ObjectSchema::new("Try to login
. If successful
, store ticket
.")
1997 .optional("repository
", REPO_URL_SCHEMA.clone())
1999 .completion_cb("repository
", complete_repository);
2001 let logout_cmd_def = CliCommand::new(
2004 ObjectSchema::new("Logout (delete stored ticket
).")
2005 .optional("repository
", REPO_URL_SCHEMA.clone())
2007 .completion_cb("repository
", complete_repository);
2009 let mount_cmd_def = CliCommand::new(
2012 ObjectSchema::new("Mount pxar archive
.")
2013 .required("snapshot
", StringSchema::new("Group
/Snapshot path
."))
2014 .required("archive
-name
", StringSchema::new("Backup archive name
."))
2015 .required("target
", StringSchema::new("Target directory path
."))
2016 .optional("repository
", REPO_URL_SCHEMA.clone())
2017 .optional("keyfile
", StringSchema::new("Path to encryption key
."))
2018 .optional("verbose
", BooleanSchema::new("Verbose output
.").default(false))
2020 .arg_param(vec!["snapshot
", "archive
-name
", "target
"])
2021 .completion_cb("repository
", complete_repository)
2022 .completion_cb("snapshot
", complete_group_or_snapshot)
2023 .completion_cb("archive
-name
", complete_archive_name)
2024 .completion_cb("target
", tools::complete_file_name);
2026 let cmd_def = CliCommandMap::new()
2027 .insert("backup
".to_owned(), backup_cmd_def.into())
2028 .insert("upload
-log
".to_owned(), upload_log_cmd_def.into())
2029 .insert("forget
".to_owned(), forget_cmd_def.into())
2030 .insert("catalog
".to_owned(), catalog_cmd_def.into())
2031 .insert("garbage
-collect
".to_owned(), garbage_collect_cmd_def.into())
2032 .insert("list
".to_owned(), list_cmd_def.into())
2033 .insert("login
".to_owned(), login_cmd_def.into())
2034 .insert("logout
".to_owned(), logout_cmd_def.into())
2035 .insert("prune
".to_owned(), prune_cmd_def.into())
2036 .insert("restore
".to_owned(), restore_cmd_def.into())
2037 .insert("snapshots
".to_owned(), snapshots_cmd_def.into())
2038 .insert("files
".to_owned(), files_cmd_def.into())
2039 .insert("status
".to_owned(), status_cmd_def.into())
2040 .insert("key
".to_owned(), key_mgmt_cli().into())
2041 .insert("mount
".to_owned(), mount_cmd_def.into());
2043 run_cli_command(cmd_def.into());
2046 fn async_main<F: Future>(fut: F) -> <F as Future>::Output {
2047 let rt = tokio::runtime::Runtime::new().unwrap();
2048 let ret = rt.block_on(fut);