2 use nix
::unistd
::{fork, ForkResult, pipe}
;
3 use std
::os
::unix
::io
::RawFd
;
4 use chrono
::{Local, Utc, TimeZone}
;
5 use std
::path
::{Path, PathBuf}
;
6 use std
::collections
::{HashSet, HashMap}
;
8 use std
::io
::{Write, Seek, SeekFrom}
;
9 use std
::os
::unix
::fs
::OpenOptionsExt
;
11 use proxmox
::{sortable, identity}
;
12 use proxmox
::tools
::fs
::{file_get_contents, file_get_json, replace_file, CreateOptions, image_size}
;
13 use proxmox
::api
::{ApiHandler, ApiMethod, RpcEnvironment}
;
14 use proxmox
::api
::schema
::*;
15 use proxmox
::api
::cli
::*;
16 use proxmox
::api
::api
;
18 use proxmox_backup
::tools
;
19 use proxmox_backup
::api2
::types
::*;
20 use proxmox_backup
::client
::*;
21 use proxmox_backup
::backup
::*;
22 use proxmox_backup
::pxar
::{ self, catalog::* }
;
24 //use proxmox_backup::backup::image_index::*;
25 //use proxmox_backup::config::datastore;
26 //use proxmox_backup::pxar::encoder::*;
27 //use proxmox_backup::backup::datastore::*;
29 use serde_json
::{json, Value}
;
31 use std
::sync
::{Arc, Mutex}
;
33 use xdg
::BaseDirectories
;
36 use tokio
::sync
::mpsc
;
38 proxmox
::api
::const_regex
! {
39 BACKUPSPEC_REGEX
= r
"^([a-zA-Z0-9_-]+\.(?:pxar|img|conf|log)):(.+)$";
42 const REPO_URL_SCHEMA
: Schema
= StringSchema
::new("Repository URL.")
43 .format(&BACKUP_REPO_URL
)
47 const BACKUP_SOURCE_SCHEMA
: Schema
= StringSchema
::new(
48 "Backup source specification ([<label>:<path>]).")
49 .format(&ApiStringFormat
::Pattern(&BACKUPSPEC_REGEX
))
52 const KEYFILE_SCHEMA
: Schema
= StringSchema
::new(
53 "Path to encryption key. All data will be encrypted using this key.")
56 const CHUNK_SIZE_SCHEMA
: Schema
= IntegerSchema
::new(
57 "Chunk size in KB. Must be a power of 2.")
63 fn get_default_repository() -> Option
<String
> {
64 std
::env
::var("PBS_REPOSITORY").ok()
67 fn extract_repository_from_value(
69 ) -> Result
<BackupRepository
, Error
> {
71 let repo_url
= param
["repository"]
74 .or_else(get_default_repository
)
75 .ok_or_else(|| format_err
!("unable to get (default) repository"))?
;
77 let repo
: BackupRepository
= repo_url
.parse()?
;
82 fn extract_repository_from_map(
83 param
: &HashMap
<String
, String
>,
84 ) -> Option
<BackupRepository
> {
86 param
.get("repository")
88 .or_else(get_default_repository
)
89 .and_then(|repo_url
| repo_url
.parse
::<BackupRepository
>().ok())
92 fn record_repository(repo
: &BackupRepository
) {
94 let base
= match BaseDirectories
::with_prefix("proxmox-backup") {
99 // usually $HOME/.cache/proxmox-backup/repo-list
100 let path
= match base
.place_cache_file("repo-list") {
105 let mut data
= file_get_json(&path
, None
).unwrap_or_else(|_
| json
!({}
));
107 let repo
= repo
.to_string();
109 data
[&repo
] = json
!{ data[&repo].as_i64().unwrap_or(0) + 1 }
;
111 let mut map
= serde_json
::map
::Map
::new();
114 let mut max_used
= 0;
115 let mut max_repo
= None
;
116 for (repo
, count
) in data
.as_object().unwrap() {
117 if map
.contains_key(repo
) { continue; }
118 if let Some(count
) = count
.as_i64() {
119 if count
> max_used
{
121 max_repo
= Some(repo
);
125 if let Some(repo
) = max_repo
{
126 map
.insert(repo
.to_owned(), json
!(max_used
));
130 if map
.len() > 10 { // store max. 10 repos
135 let new_data
= json
!(map
);
137 let _
= replace_file(path
, new_data
.to_string().as_bytes(), CreateOptions
::new());
140 fn complete_repository(_arg
: &str, _param
: &HashMap
<String
, String
>) -> Vec
<String
> {
142 let mut result
= vec
![];
144 let base
= match BaseDirectories
::with_prefix("proxmox-backup") {
149 // usually $HOME/.cache/proxmox-backup/repo-list
150 let path
= match base
.place_cache_file("repo-list") {
155 let data
= file_get_json(&path
, None
).unwrap_or_else(|_
| json
!({}
));
157 if let Some(map
) = data
.as_object() {
158 for (repo
, _count
) in map
{
159 result
.push(repo
.to_owned());
166 async
fn view_task_result(
170 ) -> Result
<(), Error
> {
171 let data
= &result
["data"];
172 if output_format
== "text" {
173 if let Some(upid
) = data
.as_str() {
174 display_task_log(client
, upid
, true).await?
;
177 format_and_print_result(&data
, &output_format
);
183 async
fn backup_directory
<P
: AsRef
<Path
>>(
184 client
: &BackupWriter
,
187 chunk_size
: Option
<usize>,
188 device_set
: Option
<HashSet
<u64>>,
190 skip_lost_and_found
: bool
,
191 crypt_config
: Option
<Arc
<CryptConfig
>>,
192 catalog
: Arc
<Mutex
<CatalogWriter
<SenderWriter
>>>,
193 ) -> Result
<BackupStats
, Error
> {
195 let pxar_stream
= PxarBackupStream
::open(dir_path
.as_ref(), device_set
, verbose
, skip_lost_and_found
, catalog
)?
;
196 let mut chunk_stream
= ChunkStream
::new(pxar_stream
, chunk_size
);
198 let (mut tx
, rx
) = mpsc
::channel(10); // allow to buffer 10 chunks
201 .map_err(Error
::from
);
203 // spawn chunker inside a separate task so that it can run parallel
204 tokio
::spawn(async
move {
205 while let Some(v
) = chunk_stream
.next().await
{
206 let _
= tx
.send(v
).await
;
211 .upload_stream(archive_name
, stream
, "dynamic", None
, crypt_config
)
217 async
fn backup_image
<P
: AsRef
<Path
>>(
218 client
: &BackupWriter
,
222 chunk_size
: Option
<usize>,
224 crypt_config
: Option
<Arc
<CryptConfig
>>,
225 ) -> Result
<BackupStats
, Error
> {
227 let path
= image_path
.as_ref().to_owned();
229 let file
= tokio
::fs
::File
::open(path
).await?
;
231 let stream
= tokio_util
::codec
::FramedRead
::new(file
, tokio_util
::codec
::BytesCodec
::new())
232 .map_err(Error
::from
);
234 let stream
= FixedChunkStream
::new(stream
, chunk_size
.unwrap_or(4*1024*1024));
237 .upload_stream(archive_name
, stream
, "fixed", Some(image_size
), crypt_config
)
243 fn strip_server_file_expenstion(name
: &str) -> String
{
245 if name
.ends_with(".didx") || name
.ends_with(".fidx") || name
.ends_with(".blob") {
246 name
[..name
.len()-5].to_owned()
248 name
.to_owned() // should not happen
256 schema
: REPO_URL_SCHEMA
,
260 schema
: OUTPUT_FORMAT
,
266 /// List backup groups.
267 async
fn list_backup_groups(param
: Value
) -> Result
<Value
, Error
> {
269 let repo
= extract_repository_from_value(¶m
)?
;
271 let client
= HttpClient
::new(repo
.host(), repo
.user(), None
)?
;
273 let path
= format
!("api2/json/admin/datastore/{}/groups", repo
.store());
275 let mut result
= client
.get(&path
, None
).await?
;
277 record_repository(&repo
);
279 // fixme: implement and use output formatter instead ..
280 let list
= result
["data"].as_array_mut().unwrap();
282 list
.sort_unstable_by(|a
, b
| {
283 let a_id
= a
["backup-id"].as_str().unwrap();
284 let a_backup_type
= a
["backup-type"].as_str().unwrap();
285 let b_id
= b
["backup-id"].as_str().unwrap();
286 let b_backup_type
= b
["backup-type"].as_str().unwrap();
288 let type_order
= a_backup_type
.cmp(b_backup_type
);
289 if type_order
== std
::cmp
::Ordering
::Equal
{
296 let output_format
= param
["output-format"].as_str().unwrap_or("text").to_owned();
298 let mut result
= vec
![];
302 let id
= item
["backup-id"].as_str().unwrap();
303 let btype
= item
["backup-type"].as_str().unwrap();
304 let epoch
= item
["last-backup"].as_i64().unwrap();
305 let last_backup
= Utc
.timestamp(epoch
, 0);
306 let backup_count
= item
["backup-count"].as_u64().unwrap();
308 let group
= BackupGroup
::new(btype
, id
);
310 let path
= group
.group_path().to_str().unwrap().to_owned();
312 let files
= item
["files"].as_array().unwrap().iter()
313 .map(|v
| strip_server_file_expenstion(v
.as_str().unwrap())).collect();
315 if output_format
== "text" {
317 "{:20} | {} | {:5} | {}",
319 BackupDir
::backup_time_to_string(last_backup
),
321 tools
::join(&files
, ' '
),
325 "backup-type": btype
,
327 "last-backup": epoch
,
328 "backup-count": backup_count
,
334 if output_format
!= "text" { format_and_print_result(&result.into(), &output_format); }
343 schema
: REPO_URL_SCHEMA
,
348 description
: "Backup group.",
352 schema
: OUTPUT_FORMAT
,
358 /// List backup snapshots.
359 async
fn list_snapshots(param
: Value
) -> Result
<Value
, Error
> {
361 let repo
= extract_repository_from_value(¶m
)?
;
363 let output_format
= param
["output-format"].as_str().unwrap_or("text").to_owned();
365 let client
= HttpClient
::new(repo
.host(), repo
.user(), None
)?
;
367 let path
= format
!("api2/json/admin/datastore/{}/snapshots", repo
.store());
369 let mut args
= json
!({}
);
370 if let Some(path
) = param
["group"].as_str() {
371 let group
= BackupGroup
::parse(path
)?
;
372 args
["backup-type"] = group
.backup_type().into();
373 args
["backup-id"] = group
.backup_id().into();
376 let mut result
= client
.get(&path
, Some(args
)).await?
;
378 record_repository(&repo
);
380 if output_format
!= "text" {
381 format_and_print_result(&result
["data"], &output_format
);
382 return Ok(Value
::Null
);
385 let mut list
: Vec
<SnapshotListItem
> = serde_json
::from_value(result
["data"].take())?
;
386 list
.sort_unstable_by(|a
, b
| a
.backup_time
.cmp(&b
.backup_time
));
390 let snapshot
= BackupDir
::new(item
.backup_type
, item
.backup_id
, item
.backup_time
);
392 let path
= snapshot
.relative_path().to_str().unwrap().to_owned();
394 let files
= item
.files
.iter()
395 .map(|v
| strip_server_file_expenstion(&v
))
398 let size_str
= if let Some(size
) = item
.size
{
403 println
!("{} | {} | {}", path
, size_str
, tools
::join(&files
, ' '
));
413 schema
: REPO_URL_SCHEMA
,
418 description
: "Snapshot path.",
423 /// Forget (remove) backup snapshots.
424 async
fn forget_snapshots(param
: Value
) -> Result
<Value
, Error
> {
426 let repo
= extract_repository_from_value(¶m
)?
;
428 let path
= tools
::required_string_param(¶m
, "snapshot")?
;
429 let snapshot
= BackupDir
::parse(path
)?
;
431 let mut client
= HttpClient
::new(repo
.host(), repo
.user(), None
)?
;
433 let path
= format
!("api2/json/admin/datastore/{}/snapshots", repo
.store());
435 let result
= client
.delete(&path
, Some(json
!({
436 "backup-type": snapshot
.group().backup_type(),
437 "backup-id": snapshot
.group().backup_id(),
438 "backup-time": snapshot
.backup_time().timestamp(),
441 record_repository(&repo
);
450 schema
: REPO_URL_SCHEMA
,
456 /// Try to login. If successful, store ticket.
457 async
fn api_login(param
: Value
) -> Result
<Value
, Error
> {
459 let repo
= extract_repository_from_value(¶m
)?
;
461 let client
= HttpClient
::new(repo
.host(), repo
.user(), None
)?
;
462 client
.login().await?
;
464 record_repository(&repo
);
473 schema
: REPO_URL_SCHEMA
,
479 /// Logout (delete stored ticket).
480 fn api_logout(param
: Value
) -> Result
<Value
, Error
> {
482 let repo
= extract_repository_from_value(¶m
)?
;
484 delete_ticket_info(repo
.host(), repo
.user())?
;
493 schema
: REPO_URL_SCHEMA
,
498 description
: "Snapshot path.",
504 async
fn dump_catalog(param
: Value
) -> Result
<Value
, Error
> {
506 let repo
= extract_repository_from_value(¶m
)?
;
508 let path
= tools
::required_string_param(¶m
, "snapshot")?
;
509 let snapshot
= BackupDir
::parse(path
)?
;
511 let keyfile
= param
["keyfile"].as_str().map(PathBuf
::from
);
513 let crypt_config
= match keyfile
{
516 let (key
, _
) = load_and_decrtypt_key(&path
, &get_encryption_key_password
)?
;
517 Some(Arc
::new(CryptConfig
::new(key
)?
))
521 let client
= HttpClient
::new(repo
.host(), repo
.user(), None
)?
;
523 let client
= BackupReader
::start(
525 crypt_config
.clone(),
527 &snapshot
.group().backup_type(),
528 &snapshot
.group().backup_id(),
529 snapshot
.backup_time(),
533 let manifest
= client
.download_manifest().await?
;
535 let index
= client
.download_dynamic_index(&manifest
, CATALOG_NAME
).await?
;
537 let most_used
= index
.find_most_used_chunks(8);
539 let chunk_reader
= RemoteChunkReader
::new(client
.clone(), crypt_config
, most_used
);
541 let mut reader
= BufferedDynamicReader
::new(index
, chunk_reader
);
543 let mut catalogfile
= std
::fs
::OpenOptions
::new()
546 .custom_flags(libc
::O_TMPFILE
)
549 std
::io
::copy(&mut reader
, &mut catalogfile
)
550 .map_err(|err
| format_err
!("unable to download catalog - {}", err
))?
;
552 catalogfile
.seek(SeekFrom
::Start(0))?
;
554 let mut catalog_reader
= CatalogReader
::new(catalogfile
);
556 catalog_reader
.dump()?
;
558 record_repository(&repo
);
567 schema
: REPO_URL_SCHEMA
,
572 description
: "Snapshot path.",
575 schema
: OUTPUT_FORMAT
,
581 /// List snapshot files.
582 async
fn list_snapshot_files(param
: Value
) -> Result
<Value
, Error
> {
584 let repo
= extract_repository_from_value(¶m
)?
;
586 let path
= tools
::required_string_param(¶m
, "snapshot")?
;
587 let snapshot
= BackupDir
::parse(path
)?
;
589 let output_format
= param
["output-format"].as_str().unwrap_or("text").to_owned();
591 let client
= HttpClient
::new(repo
.host(), repo
.user(), None
)?
;
593 let path
= format
!("api2/json/admin/datastore/{}/files", repo
.store());
595 let mut result
= client
.get(&path
, Some(json
!({
596 "backup-type": snapshot
.group().backup_type(),
597 "backup-id": snapshot
.group().backup_id(),
598 "backup-time": snapshot
.backup_time().timestamp(),
601 record_repository(&repo
);
603 let list
: Value
= result
["data"].take();
605 if output_format
== "text" {
606 for item
in list
.as_array().unwrap().iter() {
609 strip_server_file_expenstion(item
["filename"].as_str().unwrap()),
610 item
["size"].as_u64().unwrap_or(0),
614 format_and_print_result(&list
, &output_format
);
624 schema
: REPO_URL_SCHEMA
,
628 schema
: OUTPUT_FORMAT
,
634 /// Start garbage collection for a specific repository.
635 async
fn start_garbage_collection(param
: Value
) -> Result
<Value
, Error
> {
637 let repo
= extract_repository_from_value(¶m
)?
;
638 let output_format
= param
["output-format"].as_str().unwrap_or("text").to_owned();
640 let mut client
= HttpClient
::new(repo
.host(), repo
.user(), None
)?
;
642 let path
= format
!("api2/json/admin/datastore/{}/gc", repo
.store());
644 let result
= client
.post(&path
, None
).await?
;
646 record_repository(&repo
);
648 view_task_result(client
, result
, &output_format
).await?
;
653 fn parse_backupspec(value
: &str) -> Result
<(&str, &str), Error
> {
655 if let Some(caps
) = (BACKUPSPEC_REGEX
.regex_obj
)().captures(value
) {
656 return Ok((caps
.get(1).unwrap().as_str(), caps
.get(2).unwrap().as_str()));
658 bail
!("unable to parse directory specification '{}'", value
);
661 fn spawn_catalog_upload(
662 client
: Arc
<BackupWriter
>,
663 crypt_config
: Option
<Arc
<CryptConfig
>>,
666 Arc
<Mutex
<CatalogWriter
<SenderWriter
>>>,
667 tokio
::sync
::oneshot
::Receiver
<Result
<BackupStats
, Error
>>
670 let (catalog_tx
, catalog_rx
) = mpsc
::channel(10); // allow to buffer 10 writes
671 let catalog_stream
= catalog_rx
.map_err(Error
::from
);
672 let catalog_chunk_size
= 512*1024;
673 let catalog_chunk_stream
= ChunkStream
::new(catalog_stream
, Some(catalog_chunk_size
));
675 let catalog
= Arc
::new(Mutex
::new(CatalogWriter
::new(SenderWriter
::new(catalog_tx
))?
));
677 let (catalog_result_tx
, catalog_result_rx
) = tokio
::sync
::oneshot
::channel();
679 tokio
::spawn(async
move {
680 let catalog_upload_result
= client
681 .upload_stream(CATALOG_NAME
, catalog_chunk_stream
, "dynamic", None
, crypt_config
)
684 if let Err(ref err
) = catalog_upload_result
{
685 eprintln
!("catalog upload error - {}", err
);
689 let _
= catalog_result_tx
.send(catalog_upload_result
);
692 Ok((catalog
, catalog_result_rx
))
700 description
: "List of backup source specifications ([<label.ext>:<path>] ...)",
702 schema
: BACKUP_SOURCE_SCHEMA
,
706 schema
: REPO_URL_SCHEMA
,
710 description
: "Include mountpoints with same st_dev number (see ``man fstat``) as specified files.",
714 description
: "Path to file.",
718 schema
: KEYFILE_SCHEMA
,
721 "skip-lost-and-found": {
723 description
: "Skip lost+found directory.",
727 schema
: BACKUP_TYPE_SCHEMA
,
731 schema
: BACKUP_ID_SCHEMA
,
735 schema
: BACKUP_TIME_SCHEMA
,
739 schema
: CHUNK_SIZE_SCHEMA
,
745 /// Create (host) backup.
746 async
fn create_backup(
749 _rpcenv
: &mut dyn RpcEnvironment
,
750 ) -> Result
<Value
, Error
> {
752 let repo
= extract_repository_from_value(¶m
)?
;
754 let backupspec_list
= tools
::required_array_param(¶m
, "backupspec")?
;
756 let all_file_systems
= param
["all-file-systems"].as_bool().unwrap_or(false);
758 let skip_lost_and_found
= param
["skip-lost-and-found"].as_bool().unwrap_or(false);
760 let verbose
= param
["verbose"].as_bool().unwrap_or(false);
762 let backup_time_opt
= param
["backup-time"].as_i64();
764 let chunk_size_opt
= param
["chunk-size"].as_u64().map(|v
| (v
*1024) as usize);
766 if let Some(size
) = chunk_size_opt
{
767 verify_chunk_size(size
)?
;
770 let keyfile
= param
["keyfile"].as_str().map(PathBuf
::from
);
772 let backup_id
= param
["backup-id"].as_str().unwrap_or(&proxmox
::tools
::nodename());
774 let backup_type
= param
["backup-type"].as_str().unwrap_or("host");
776 let include_dev
= param
["include-dev"].as_array();
778 let mut devices
= if all_file_systems { None }
else { Some(HashSet::new()) }
;
780 if let Some(include_dev
) = include_dev
{
781 if all_file_systems
{
782 bail
!("option 'all-file-systems' conflicts with option 'include-dev'");
785 let mut set
= HashSet
::new();
786 for path
in include_dev
{
787 let path
= path
.as_str().unwrap();
788 let stat
= nix
::sys
::stat
::stat(path
)
789 .map_err(|err
| format_err
!("fstat {:?} failed - {}", path
, err
))?
;
790 set
.insert(stat
.st_dev
);
795 let mut upload_list
= vec
![];
797 enum BackupType { PXAR, IMAGE, CONFIG, LOGFILE }
;
799 let mut upload_catalog
= false;
801 for backupspec
in backupspec_list
{
802 let (target
, filename
) = parse_backupspec(backupspec
.as_str().unwrap())?
;
804 use std
::os
::unix
::fs
::FileTypeExt
;
806 let metadata
= std
::fs
::metadata(filename
)
807 .map_err(|err
| format_err
!("unable to access '{}' - {}", filename
, err
))?
;
808 let file_type
= metadata
.file_type();
810 let extension
= target
.rsplit('
.'
).next()
811 .ok_or_else(|| format_err
!("missing target file extenion '{}'", target
))?
;
815 if !file_type
.is_dir() {
816 bail
!("got unexpected file type (expected directory)");
818 upload_list
.push((BackupType
::PXAR
, filename
.to_owned(), format
!("{}.didx", target
), 0));
819 upload_catalog
= true;
823 if !(file_type
.is_file() || file_type
.is_block_device()) {
824 bail
!("got unexpected file type (expected file or block device)");
827 let size
= image_size(&PathBuf
::from(filename
))?
;
829 if size
== 0 { bail!("got zero-sized file '{}'
", filename); }
831 upload_list.push((BackupType::IMAGE, filename.to_owned(), format!("{}
.fidx
", target), size));
834 if !file_type.is_file() {
835 bail!("got unexpected file
type (expected regular file
)");
837 upload_list.push((BackupType::CONFIG, filename.to_owned(), format!("{}
.blob
", target), metadata.len()));
840 if !file_type.is_file() {
841 bail!("got unexpected file
type (expected regular file
)");
843 upload_list.push((BackupType::LOGFILE, filename.to_owned(), format!("{}
.blob
", target), metadata.len()));
846 bail!("got unknown archive extension '{}'
", extension);
851 let backup_time = Utc.timestamp(backup_time_opt.unwrap_or_else(|| Utc::now().timestamp()), 0);
853 let client = HttpClient::new(repo.host(), repo.user(), None)?;
854 record_repository(&repo);
856 println!("Starting backup
: {}
/{}
/{}
", backup_type, backup_id, BackupDir::backup_time_to_string(backup_time));
858 println!("Client name
: {}
", proxmox::tools::nodename());
860 let start_time = Local::now();
862 println!("Starting protocol
: {}
", start_time.to_rfc3339_opts(chrono::SecondsFormat::Secs, false));
864 let (crypt_config, rsa_encrypted_key) = match keyfile {
865 None => (None, None),
867 let (key, created) = load_and_decrtypt_key(&path, &get_encryption_key_password)?;
869 let crypt_config = CryptConfig::new(key)?;
871 let path = master_pubkey_path()?;
873 let pem_data = file_get_contents(&path)?;
874 let rsa = openssl::rsa::Rsa::public_key_from_pem(&pem_data)?;
875 let enc_key = crypt_config.generate_rsa_encoded_key(rsa, created)?;
876 (Some(Arc::new(crypt_config)), Some(enc_key))
878 (Some(Arc::new(crypt_config)), None)
883 let client = BackupWriter::start(
892 let snapshot = BackupDir::new(backup_type, backup_id, backup_time.timestamp());
893 let mut manifest = BackupManifest::new(snapshot);
895 let (catalog, catalog_result_rx) = spawn_catalog_upload(client.clone(), crypt_config.clone())?;
897 for (backup_type, filename, target, size) in upload_list {
899 BackupType::CONFIG => {
900 println!("Upload config file '{}' to '{:?}'
as {}
", filename, repo, target);
902 .upload_blob_from_file(&filename, &target, crypt_config.clone(), true)
904 manifest.add_file(target, stats.size, stats.csum)?;
906 BackupType::LOGFILE => { // fixme: remove - not needed anymore ?
907 println!("Upload log file '{}' to '{:?}'
as {}
", filename, repo, target);
909 .upload_blob_from_file(&filename, &target, crypt_config.clone(), true)
911 manifest.add_file(target, stats.size, stats.csum)?;
913 BackupType::PXAR => {
914 println!("Upload directory '{}' to '{:?}'
as {}
", filename, repo, target);
915 catalog.lock().unwrap().start_directory(std::ffi::CString::new(target.as_str())?.as_c_str())?;
916 let stats = backup_directory(
924 crypt_config.clone(),
927 manifest.add_file(target, stats.size, stats.csum)?;
928 catalog.lock().unwrap().end_directory()?;
930 BackupType::IMAGE => {
931 println!("Upload image '{}' to '{:?}'
as {}
", filename, repo, target);
932 let stats = backup_image(
939 crypt_config.clone(),
941 manifest.add_file(target, stats.size, stats.csum)?;
946 // finalize and upload catalog
948 let mutex = Arc::try_unwrap(catalog)
949 .map_err(|_| format_err!("unable to get
catalog (still used
)"))?;
950 let mut catalog = mutex.into_inner().unwrap();
954 drop(catalog); // close upload stream
956 let stats = catalog_result_rx.await??;
958 manifest.add_file(CATALOG_NAME.to_owned(), stats.size, stats.csum)?;
961 if let Some(rsa_encrypted_key) = rsa_encrypted_key {
962 let target = "rsa
-encrypted
.key
";
963 println!("Upload RSA encoded key to '{:?}'
as {}
", repo, target);
965 .upload_blob_from_data(rsa_encrypted_key, target, None, false, false)
967 manifest.add_file(format!("{}
.blob
", target), stats.size, stats.csum)?;
969 // openssl rsautl -decrypt -inkey master-private.pem -in rsa-encrypted.key -out t
971 let mut buffer2 = vec![0u8; rsa.size() as usize];
972 let pem_data = file_get_contents("master
-private
.pem
")?;
973 let rsa = openssl::rsa::Rsa::private_key_from_pem(&pem_data)?;
974 let len = rsa.private_decrypt(&buffer, &mut buffer2, openssl::rsa::Padding::PKCS1)?;
975 println!("TEST {} {:?}
", len, buffer2);
979 // create manifest (index.json)
980 let manifest = manifest.into_json();
982 println!("Upload index
.json to '{:?}'
", repo);
983 let manifest = serde_json::to_string_pretty(&manifest)?.into();
985 .upload_blob_from_data(manifest, MANIFEST_BLOB_NAME, crypt_config.clone(), true, true)
988 client.finish().await?;
990 let end_time = Local::now();
991 let elapsed = end_time.signed_duration_since(start_time);
992 println!("Duration
: {}
", elapsed);
994 println!("End Time
: {}
", end_time.to_rfc3339_opts(chrono::SecondsFormat::Secs, false));
999 fn complete_backup_source(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1001 let mut result = vec![];
1003 let data: Vec<&str> = arg.splitn(2, ':').collect();
1005 if data.len() != 2 {
1006 result.push(String::from("root
.pxar
:/"));
1007 result.push(String::from("etc
.pxar
:/etc
"));
1011 let files = tools::complete_file_name(data[1], param);
1014 result.push(format!("{}
:{}
", data[0], file));
1020 fn dump_image<W: Write>(
1021 client: Arc<BackupReader>,
1022 crypt_config: Option<Arc<CryptConfig>>,
1023 index: FixedIndexReader,
1026 ) -> Result<(), Error> {
1028 let most_used = index.find_most_used_chunks(8);
1030 let mut chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, most_used);
1032 // Note: we avoid using BufferedFixedReader, because that add an additional buffer/copy
1033 // and thus slows down reading. Instead, directly use RemoteChunkReader
1036 let start_time = std::time::Instant::now();
1038 for pos in 0..index.index_count() {
1039 let digest = index.index_digest(pos).unwrap();
1040 let raw_data = chunk_reader.read_chunk(&digest)?;
1041 writer.write_all(&raw_data)?;
1042 bytes += raw_data.len();
1044 let next_per = ((pos+1)*100)/index.index_count();
1045 if per != next_per {
1046 eprintln!("progress {}
% (read {} bytes
, duration {} sec
)",
1047 next_per, bytes, start_time.elapsed().as_secs());
1053 let end_time = std::time::Instant::now();
1054 let elapsed = end_time.duration_since(start_time);
1055 eprintln!("restore image
complete (bytes
={}
, duration
={:.2}s
, speed
={:.2}MB
/s
)",
1057 elapsed.as_secs_f64(),
1058 bytes as f64/(1024.0*1024.0*elapsed.as_secs_f64())
1069 schema: REPO_URL_SCHEMA,
1074 description: "Group
/Snapshot path
.",
1077 description: "Backup archive name
.",
1082 description: r###"Target directory path
. Use '
-' to write to stdandard output
.
1084 We
do not extraxt '
.pxar' archives when writing to stdandard output
.
1088 "allow
-existing
-dirs
": {
1090 description: "Do not fail
if directories already exists
.",
1094 schema: KEYFILE_SCHEMA,
1100 /// Restore backup repository.
1101 async fn restore(param: Value) -> Result<Value, Error> {
1102 let repo = extract_repository_from_value(¶m)?;
1104 let verbose = param["verbose
"].as_bool().unwrap_or(false);
1106 let allow_existing_dirs = param["allow
-existing
-dirs
"].as_bool().unwrap_or(false);
1108 let archive_name = tools::required_string_param(¶m, "archive
-name
")?;
1110 let client = HttpClient::new(repo.host(), repo.user(), None)?;
1112 record_repository(&repo);
1114 let path = tools::required_string_param(¶m, "snapshot
")?;
1116 let (backup_type, backup_id, backup_time) = if path.matches('/').count() == 1 {
1117 let group = BackupGroup::parse(path)?;
1119 let path = format!("api2
/json
/admin
/datastore
/{}
/snapshots
", repo.store());
1120 let mut result = client.get(&path, Some(json!({
1121 "backup
-type": group.backup_type(),
1122 "backup
-id
": group.backup_id(),
1125 let mut list: Vec<SnapshotListItem> = serde_json::from_value(result["data
"].take())?;
1126 if list.is_empty() {
1127 bail!("backup group '{}' does not contain any snapshots
:", path);
1129 list.sort_unstable_by(|a, b| b.backup_time.cmp(&a.backup_time));
1131 let backup_time = Utc.timestamp(list[0].backup_time, 0);
1133 (group.backup_type().to_owned(), group.backup_id().to_owned(), backup_time)
1135 let snapshot = BackupDir::parse(path)?;
1136 (snapshot.group().backup_type().to_owned(), snapshot.group().backup_id().to_owned(), snapshot.backup_time())
1139 let target = tools::required_string_param(¶m, "target
")?;
1140 let target = if target == "-" { None } else { Some(target) };
1142 let keyfile = param["keyfile
"].as_str().map(PathBuf::from);
1144 let crypt_config = match keyfile {
1147 let (key, _) = load_and_decrtypt_key(&path, &get_encryption_key_password)?;
1148 Some(Arc::new(CryptConfig::new(key)?))
1152 let server_archive_name = if archive_name.ends_with(".pxar
") {
1153 format!("{}
.didx
", archive_name)
1154 } else if archive_name.ends_with(".img
") {
1155 format!("{}
.fidx
", archive_name)
1157 format!("{}
.blob
", archive_name)
1160 let client = BackupReader::start(
1162 crypt_config.clone(),
1170 let manifest = client.download_manifest().await?;
1172 if server_archive_name == MANIFEST_BLOB_NAME {
1173 let backup_index_data = manifest.into_json().to_string();
1174 if let Some(target) = target {
1175 replace_file(target, backup_index_data.as_bytes(), CreateOptions::new())?;
1177 let stdout = std::io::stdout();
1178 let mut writer = stdout.lock();
1179 writer.write_all(backup_index_data.as_bytes())
1180 .map_err(|err| format_err!("unable to pipe data
- {}
", err))?;
1183 } else if server_archive_name.ends_with(".blob
") {
1185 let mut reader = client.download_blob(&manifest, &server_archive_name).await?;
1187 if let Some(target) = target {
1188 let mut writer = std::fs::OpenOptions::new()
1193 .map_err(|err| format_err!("unable to create target file {:?}
- {}
", target, err))?;
1194 std::io::copy(&mut reader, &mut writer)?;
1196 let stdout = std::io::stdout();
1197 let mut writer = stdout.lock();
1198 std::io::copy(&mut reader, &mut writer)
1199 .map_err(|err| format_err!("unable to pipe data
- {}
", err))?;
1202 } else if server_archive_name.ends_with(".didx
") {
1204 let index = client.download_dynamic_index(&manifest, &server_archive_name).await?;
1206 let most_used = index.find_most_used_chunks(8);
1208 let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, most_used);
1210 let mut reader = BufferedDynamicReader::new(index, chunk_reader);
1212 if let Some(target) = target {
1214 let feature_flags = pxar::flags::DEFAULT;
1215 let mut decoder = pxar::SequentialDecoder::new(&mut reader, feature_flags);
1216 decoder.set_callback(move |path| {
1218 eprintln!("{:?}
", path);
1222 decoder.set_allow_existing_dirs(allow_existing_dirs);
1224 decoder.restore(Path::new(target), &Vec::new())?;
1226 let mut writer = std::fs::OpenOptions::new()
1228 .open("/dev
/stdout
")
1229 .map_err(|err| format_err!("unable to open
/dev
/stdout
- {}
", err))?;
1231 std::io::copy(&mut reader, &mut writer)
1232 .map_err(|err| format_err!("unable to pipe data
- {}
", err))?;
1234 } else if server_archive_name.ends_with(".fidx
") {
1236 let index = client.download_fixed_index(&manifest, &server_archive_name).await?;
1238 let mut writer = if let Some(target) = target {
1239 std::fs::OpenOptions::new()
1244 .map_err(|err| format_err!("unable to create target file {:?}
- {}
", target, err))?
1246 std::fs::OpenOptions::new()
1248 .open("/dev
/stdout
")
1249 .map_err(|err| format_err!("unable to open
/dev
/stdout
- {}
", err))?
1252 dump_image(client.clone(), crypt_config.clone(), index, &mut writer, verbose)?;
1255 bail!("unknown archive file
extension (expected
.pxar of
.img
)");
1265 schema: REPO_URL_SCHEMA,
1270 description: "Group
/Snapshot path
.",
1274 description: "The path to the log file you want to upload
.",
1277 schema: KEYFILE_SCHEMA,
1283 /// Upload backup log file.
1284 async fn upload_log(param: Value) -> Result<Value, Error> {
1286 let logfile = tools::required_string_param(¶m, "logfile
")?;
1287 let repo = extract_repository_from_value(¶m)?;
1289 let snapshot = tools::required_string_param(¶m, "snapshot
")?;
1290 let snapshot = BackupDir::parse(snapshot)?;
1292 let mut client = HttpClient::new(repo.host(), repo.user(), None)?;
1294 let keyfile = param["keyfile
"].as_str().map(PathBuf::from);
1296 let crypt_config = match keyfile {
1299 let (key, _created) = load_and_decrtypt_key(&path, &get_encryption_key_password)?;
1300 let crypt_config = CryptConfig::new(key)?;
1301 Some(Arc::new(crypt_config))
1305 let data = file_get_contents(logfile)?;
1307 let blob = DataBlob::encode(&data, crypt_config.as_ref().map(Arc::as_ref), true)?;
1309 let raw_data = blob.into_inner();
1311 let path = format!("api2
/json
/admin
/datastore
/{}
/upload
-backup
-log
", repo.store());
1314 "backup
-type": snapshot.group().backup_type(),
1315 "backup
-id
": snapshot.group().backup_id(),
1316 "backup
-time
": snapshot.backup_time().timestamp(),
1319 let body = hyper::Body::from(raw_data);
1321 client.upload("application
/octet
-stream
", body, &path, Some(args)).await
1328 schema: REPO_URL_SCHEMA,
1333 description: "Backup group
.",
1336 schema: OUTPUT_FORMAT,
1341 description: "Just show what prune would
do, but
do not delete anything
.",
1347 /// Prune a backup repository.
1348 async fn prune(mut param: Value) -> Result<Value, Error> {
1350 let repo = extract_repository_from_value(¶m)?;
1352 let mut client = HttpClient::new(repo.host(), repo.user(), None)?;
1354 let path = format!("api2
/json
/admin
/datastore
/{}
/prune
", repo.store());
1356 let group = tools::required_string_param(¶m, "group
")?;
1357 let group = BackupGroup::parse(group)?;
1358 let output_format = param["output
-format
"].as_str().unwrap_or("text
").to_owned();
1360 param.as_object_mut().unwrap().remove("repository
");
1361 param.as_object_mut().unwrap().remove("group
");
1362 param.as_object_mut().unwrap().remove("output
-format
");
1364 param["backup
-type"] = group.backup_type().into();
1365 param["backup
-id
"] = group.backup_id().into();
1367 let result = client.post(&path, Some(param)).await?;
1369 record_repository(&repo);
1371 view_task_result(client, result, &output_format).await?;
1380 schema: REPO_URL_SCHEMA,
1384 schema: OUTPUT_FORMAT,
1390 /// Get repository status.
1391 async fn status(param: Value) -> Result<Value, Error> {
1393 let repo = extract_repository_from_value(¶m)?;
1395 let output_format = param["output
-format
"].as_str().unwrap_or("text
").to_owned();
1397 let client = HttpClient::new(repo.host(), repo.user(), None)?;
1399 let path = format!("api2
/json
/admin
/datastore
/{}
/status
", repo.store());
1401 let result = client.get(&path, None).await?;
1402 let data = &result["data
"];
1404 record_repository(&repo);
1406 if output_format == "text
" {
1407 let total = data["total
"].as_u64().unwrap();
1408 let used = data["used
"].as_u64().unwrap();
1409 let avail = data["avail
"].as_u64().unwrap();
1410 let roundup = total/200;
1413 "total
: {} used
: {}
({}
%) available
: {}
",
1416 ((used+roundup)*100)/total,
1420 format_and_print_result(data, &output_format);
1426 // like get, but simply ignore errors and return Null instead
1427 async fn try_get(repo: &BackupRepository, url: &str) -> Value {
1429 let client = match HttpClient::new(repo.host(), repo.user(), None) {
1431 _ => return Value::Null,
1434 let mut resp = match client.get(url, None).await {
1436 _ => return Value::Null,
1439 if let Some(map) = resp.as_object_mut() {
1440 if let Some(data) = map.remove("data
") {
1447 fn complete_backup_group(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1448 async_main(async { complete_backup_group_do(param).await })
1451 async fn complete_backup_group_do(param: &HashMap<String, String>) -> Vec<String> {
1453 let mut result = vec![];
1455 let repo = match extract_repository_from_map(param) {
1460 let path = format!("api2
/json
/admin
/datastore
/{}
/groups
", repo.store());
1462 let data = try_get(&repo, &path).await;
1464 if let Some(list) = data.as_array() {
1466 if let (Some(backup_id), Some(backup_type)) =
1467 (item["backup
-id
"].as_str(), item["backup
-type"].as_str())
1469 result.push(format!("{}
/{}
", backup_type, backup_id));
1477 fn complete_group_or_snapshot(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1478 async_main(async { complete_group_or_snapshot_do(arg, param).await })
1481 async fn complete_group_or_snapshot_do(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1483 if arg.matches('/').count() < 2 {
1484 let groups = complete_backup_group_do(param).await;
1485 let mut result = vec![];
1486 for group in groups {
1487 result.push(group.to_string());
1488 result.push(format!("{}
/", group));
1493 complete_backup_snapshot_do(param).await
1496 fn complete_backup_snapshot(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1497 async_main(async { complete_backup_snapshot_do(param).await })
1500 async fn complete_backup_snapshot_do(param: &HashMap<String, String>) -> Vec<String> {
1502 let mut result = vec![];
1504 let repo = match extract_repository_from_map(param) {
1509 let path = format!("api2
/json
/admin
/datastore
/{}
/snapshots
", repo.store());
1511 let data = try_get(&repo, &path).await;
1513 if let Some(list) = data.as_array() {
1515 if let (Some(backup_id), Some(backup_type), Some(backup_time)) =
1516 (item["backup
-id
"].as_str(), item["backup
-type"].as_str(), item["backup
-time
"].as_i64())
1518 let snapshot = BackupDir::new(backup_type, backup_id, backup_time);
1519 result.push(snapshot.relative_path().to_str().unwrap().to_owned());
1527 fn complete_server_file_name(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1528 async_main(async { complete_server_file_name_do(param).await })
1531 async fn complete_server_file_name_do(param: &HashMap<String, String>) -> Vec<String> {
1533 let mut result = vec![];
1535 let repo = match extract_repository_from_map(param) {
1540 let snapshot = match param.get("snapshot
") {
1542 match BackupDir::parse(path) {
1550 let query = tools::json_object_to_query(json!({
1551 "backup
-type": snapshot.group().backup_type(),
1552 "backup
-id
": snapshot.group().backup_id(),
1553 "backup
-time
": snapshot.backup_time().timestamp(),
1556 let path = format!("api2
/json
/admin
/datastore
/{}
/files?{}
", repo.store(), query);
1558 let data = try_get(&repo, &path).await;
1560 if let Some(list) = data.as_array() {
1562 if let Some(filename) = item["filename
"].as_str() {
1563 result.push(filename.to_owned());
1571 fn complete_archive_name(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1572 complete_server_file_name(arg, param)
1574 .map(|v| strip_server_file_expenstion(&v))
1578 fn complete_pxar_archive_name(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1579 complete_server_file_name(arg, param)
1582 let name = strip_server_file_expenstion(&v);
1583 if name.ends_with(".pxar
") {
1592 fn complete_chunk_size(_arg: &str, _param: &HashMap<String, String>) -> Vec<String> {
1594 let mut result = vec![];
1598 result.push(size.to_string());
1600 if size > 4096 { break; }
1606 fn get_encryption_key_password() -> Result<Vec<u8>, Error> {
1608 // fixme: implement other input methods
1610 use std::env::VarError::*;
1611 match std::env::var("PBS_ENCRYPTION_PASSWORD
") {
1612 Ok(p) => return Ok(p.as_bytes().to_vec()),
1613 Err(NotUnicode(_)) => bail!("PBS_ENCRYPTION_PASSWORD contains bad characters
"),
1614 Err(NotPresent) => {
1615 // Try another method
1619 // If we're on a TTY, query the user for a password
1620 if crate::tools::tty::stdin_isatty() {
1621 return Ok(crate::tools::tty::read_password("Encryption Key Password
: ")?);
1624 bail!("no password input mechanism available
");
1630 _rpcenv: &mut dyn RpcEnvironment,
1631 ) -> Result<Value, Error> {
1633 let path = tools::required_string_param(¶m, "path
")?;
1634 let path = PathBuf::from(path);
1636 let kdf = param["kdf
"].as_str().unwrap_or("scrypt
");
1638 let key = proxmox::sys::linux::random_data(32)?;
1640 if kdf == "scrypt
" {
1641 // always read passphrase from tty
1642 if !crate::tools::tty::stdin_isatty() {
1643 bail!("unable to read passphrase
- no tty
");
1646 let password = crate::tools::tty::read_password("Encryption Key Password
: ")?;
1648 let key_config = encrypt_key_with_passphrase(&key, &password)?;
1650 store_key_config(&path, false, key_config)?;
1653 } else if kdf == "none
" {
1654 let created = Local.timestamp(Local::now().timestamp(), 0);
1656 store_key_config(&path, false, KeyConfig {
1669 fn master_pubkey_path() -> Result<PathBuf, Error> {
1670 let base = BaseDirectories::with_prefix("proxmox
-backup
")?;
1672 // usually $HOME/.config/proxmox-backup/master-public.pem
1673 let path = base.place_config_file("master
-public
.pem
")?;
1678 fn key_import_master_pubkey(
1681 _rpcenv: &mut dyn RpcEnvironment,
1682 ) -> Result<Value, Error> {
1684 let path = tools::required_string_param(¶m, "path
")?;
1685 let path = PathBuf::from(path);
1687 let pem_data = file_get_contents(&path)?;
1689 if let Err(err) = openssl::pkey::PKey::public_key_from_pem(&pem_data) {
1690 bail!("Unable to decode PEM data
- {}
", err);
1693 let target_path = master_pubkey_path()?;
1695 replace_file(&target_path, &pem_data, CreateOptions::new())?;
1697 println!("Imported public master key to {:?}
", target_path);
1702 fn key_create_master_key(
1705 _rpcenv: &mut dyn RpcEnvironment,
1706 ) -> Result<Value, Error> {
1708 // we need a TTY to query the new password
1709 if !crate::tools::tty::stdin_isatty() {
1710 bail!("unable to create master key
- no tty
");
1713 let rsa = openssl::rsa::Rsa::generate(4096)?;
1714 let pkey = openssl::pkey::PKey::from_rsa(rsa)?;
1716 let new_pw = String::from_utf8(crate::tools::tty::read_password("Master Key Password
: ")?)?;
1717 let verify_pw = String::from_utf8(crate::tools::tty::read_password("Verify Password
: ")?)?;
1719 if new_pw != verify_pw {
1720 bail!("Password verification fail
!");
1723 if new_pw.len() < 5 {
1724 bail!("Password is too short
!");
1727 let pub_key: Vec<u8> = pkey.public_key_to_pem()?;
1728 let filename_pub = "master
-public
.pem
";
1729 println!("Writing public master key to {}
", filename_pub);
1730 replace_file(filename_pub, pub_key.as_slice(), CreateOptions::new())?;
1732 let cipher = openssl::symm::Cipher::aes_256_cbc();
1733 let priv_key: Vec<u8> = pkey.private_key_to_pem_pkcs8_passphrase(cipher, new_pw.as_bytes())?;
1735 let filename_priv = "master
-private
.pem
";
1736 println!("Writing private master key to {}
", filename_priv);
1737 replace_file(filename_priv, priv_key.as_slice(), CreateOptions::new())?;
1742 fn key_change_passphrase(
1745 _rpcenv: &mut dyn RpcEnvironment,
1746 ) -> Result<Value, Error> {
1748 let path = tools::required_string_param(¶m, "path
")?;
1749 let path = PathBuf::from(path);
1751 let kdf = param["kdf
"].as_str().unwrap_or("scrypt
");
1753 // we need a TTY to query the new password
1754 if !crate::tools::tty::stdin_isatty() {
1755 bail!("unable to change passphrase
- no tty
");
1758 let (key, created) = load_and_decrtypt_key(&path, &get_encryption_key_password)?;
1760 if kdf == "scrypt
" {
1762 let new_pw = String::from_utf8(crate::tools::tty::read_password("New Password
: ")?)?;
1763 let verify_pw = String::from_utf8(crate::tools::tty::read_password("Verify Password
: ")?)?;
1765 if new_pw != verify_pw {
1766 bail!("Password verification fail
!");
1769 if new_pw.len() < 5 {
1770 bail!("Password is too short
!");
1773 let mut new_key_config = encrypt_key_with_passphrase(&key, new_pw.as_bytes())?;
1774 new_key_config.created = created; // keep original value
1776 store_key_config(&path, true, new_key_config)?;
1779 } else if kdf == "none
" {
1780 let modified = Local.timestamp(Local::now().timestamp(), 0);
1782 store_key_config(&path, true, KeyConfig {
1784 created, // keep original value
1795 fn key_mgmt_cli() -> CliCommandMap {
1797 const KDF_SCHEMA: Schema =
1798 StringSchema::new("Key derivation function
. Choose 'none' to store the key unecrypted
.")
1799 .format(&ApiStringFormat::Enum(&["scrypt
", "none
"]))
1804 const API_METHOD_KEY_CREATE: ApiMethod = ApiMethod::new(
1805 &ApiHandler::Sync(&key_create),
1807 "Create a new encryption key
.",
1809 ("path
", false, &StringSchema::new("File system path
.").schema()),
1810 ("kdf
", true, &KDF_SCHEMA),
1815 let key_create_cmd_def = CliCommand::new(&API_METHOD_KEY_CREATE)
1816 .arg_param(&["path
"])
1817 .completion_cb("path
", tools::complete_file_name);
1820 const API_METHOD_KEY_CHANGE_PASSPHRASE: ApiMethod = ApiMethod::new(
1821 &ApiHandler::Sync(&key_change_passphrase),
1823 "Change the passphrase required to decrypt the key
.",
1825 ("path
", false, &StringSchema::new("File system path
.").schema()),
1826 ("kdf
", true, &KDF_SCHEMA),
1831 let key_change_passphrase_cmd_def = CliCommand::new(&API_METHOD_KEY_CHANGE_PASSPHRASE)
1832 .arg_param(&["path
"])
1833 .completion_cb("path
", tools::complete_file_name);
1835 const API_METHOD_KEY_CREATE_MASTER_KEY: ApiMethod = ApiMethod::new(
1836 &ApiHandler::Sync(&key_create_master_key),
1837 &ObjectSchema::new("Create a new
4096 bit RSA master
pub/priv key pair
.", &[])
1840 let key_create_master_key_cmd_def = CliCommand::new(&API_METHOD_KEY_CREATE_MASTER_KEY);
1843 const API_METHOD_KEY_IMPORT_MASTER_PUBKEY: ApiMethod = ApiMethod::new(
1844 &ApiHandler::Sync(&key_import_master_pubkey),
1846 "Import a new RSA public key and
use it
as master key
. The key is expected to be
in '
.pem' format
.",
1847 &sorted!([ ("path
", false, &StringSchema::new("File system path
.").schema()) ]),
1851 let key_import_master_pubkey_cmd_def = CliCommand::new(&API_METHOD_KEY_IMPORT_MASTER_PUBKEY)
1852 .arg_param(&["path
"])
1853 .completion_cb("path
", tools::complete_file_name);
1855 CliCommandMap::new()
1856 .insert("create
", key_create_cmd_def)
1857 .insert("create
-master
-key
", key_create_master_key_cmd_def)
1858 .insert("import
-master
-pubkey
", key_import_master_pubkey_cmd_def)
1859 .insert("change
-passphrase
", key_change_passphrase_cmd_def)
1865 _rpcenv: &mut dyn RpcEnvironment,
1866 ) -> Result<Value, Error> {
1867 let verbose = param["verbose
"].as_bool().unwrap_or(false);
1869 // This will stay in foreground with debug output enabled as None is
1870 // passed for the RawFd.
1871 return async_main(mount_do(param, None));
1874 // Process should be deamonized.
1875 // Make sure to fork before the async runtime is instantiated to avoid troubles.
1878 Ok(ForkResult::Parent { .. }) => {
1879 nix::unistd::close(pipe.1).unwrap();
1880 // Blocks the parent process until we are ready to go in the child
1881 let _res = nix::unistd::read(pipe.0, &mut [0]).unwrap();
1884 Ok(ForkResult::Child) => {
1885 nix::unistd::close(pipe.0).unwrap();
1886 nix::unistd::setsid().unwrap();
1887 async_main(mount_do(param, Some(pipe.1)))
1889 Err(_) => bail!("failed to daemonize process
"),
1893 async fn mount_do(param: Value, pipe: Option<RawFd>) -> Result<Value, Error> {
1894 let repo = extract_repository_from_value(¶m)?;
1895 let archive_name = tools::required_string_param(¶m, "archive
-name
")?;
1896 let target = tools::required_string_param(¶m, "target
")?;
1897 let client = HttpClient::new(repo.host(), repo.user(), None)?;
1899 record_repository(&repo);
1901 let path = tools::required_string_param(¶m, "snapshot
")?;
1902 let (backup_type, backup_id, backup_time) = if path.matches('/').count() == 1 {
1903 let group = BackupGroup::parse(path)?;
1905 let path = format!("api2
/json
/admin
/datastore
/{}
/snapshots
", repo.store());
1906 let result = client.get(&path, Some(json!({
1907 "backup
-type": group.backup_type(),
1908 "backup
-id
": group.backup_id(),
1911 let list = result["data
"].as_array().unwrap();
1912 if list.is_empty() {
1913 bail!("backup group '{}' does not contain any snapshots
:", path);
1916 let epoch = list[0]["backup
-time
"].as_i64().unwrap();
1917 let backup_time = Utc.timestamp(epoch, 0);
1918 (group.backup_type().to_owned(), group.backup_id().to_owned(), backup_time)
1920 let snapshot = BackupDir::parse(path)?;
1921 (snapshot.group().backup_type().to_owned(), snapshot.group().backup_id().to_owned(), snapshot.backup_time())
1924 let keyfile = param["keyfile
"].as_str().map(PathBuf::from);
1925 let crypt_config = match keyfile {
1928 let (key, _) = load_and_decrtypt_key(&path, &get_encryption_key_password)?;
1929 Some(Arc::new(CryptConfig::new(key)?))
1933 let server_archive_name = if archive_name.ends_with(".pxar
") {
1934 format!("{}
.didx
", archive_name)
1936 bail!("Can only mount pxar archives
.");
1939 let client = BackupReader::start(
1941 crypt_config.clone(),
1949 let manifest = client.download_manifest().await?;
1951 if server_archive_name.ends_with(".didx
") {
1952 let index = client.download_dynamic_index(&manifest, &server_archive_name).await?;
1953 let most_used = index.find_most_used_chunks(8);
1954 let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, most_used);
1955 let reader = BufferedDynamicReader::new(index, chunk_reader);
1956 let decoder = pxar::Decoder::new(reader)?;
1957 let options = OsStr::new("ro
,default_permissions
");
1958 let mut session = pxar::fuse::Session::new(decoder, &options, pipe.is_none())
1959 .map_err(|err| format_err!("pxar mount failed
: {}
", err))?;
1961 // Mount the session but not call fuse deamonize as this will cause
1962 // issues with the runtime after the fork
1963 let deamonize = false;
1964 session.mount(&Path::new(target), deamonize)?;
1966 if let Some(pipe) = pipe {
1967 nix::unistd::chdir(Path::new("/")).unwrap();
1968 // Finish creation of deamon by redirecting filedescriptors.
1969 let nullfd = nix::fcntl::open(
1971 nix::fcntl::OFlag::O_RDWR,
1972 nix::sys::stat::Mode::empty(),
1974 nix::unistd::dup2(nullfd, 0).unwrap();
1975 nix::unistd::dup2(nullfd, 1).unwrap();
1976 nix::unistd::dup2(nullfd, 2).unwrap();
1978 nix::unistd::close(nullfd).unwrap();
1980 // Signal the parent process that we are done with the setup and it can
1982 nix::unistd::write(pipe, &[0u8])?;
1983 nix::unistd::close(pipe).unwrap();
1986 let multithreaded = true;
1987 session.run_loop(multithreaded)?;
1989 bail!("unknown archive file
extension (expected
.pxar
)");
2000 description: "Group
/Snapshot path
.",
2004 description: "Backup archive name
.",
2008 schema: REPO_URL_SCHEMA,
2013 description: "Path to encryption key
.",
2018 /// Shell to interactively inspect and restore snapshots.
2019 async fn catalog_shell(param: Value) -> Result<(), Error> {
2020 let repo = extract_repository_from_value(¶m)?;
2021 let client = HttpClient::new(repo.host(), repo.user(), None)?;
2022 let path = tools::required_string_param(¶m, "snapshot
")?;
2023 let archive_name = tools::required_string_param(¶m, "archive
-name
")?;
2025 let (backup_type, backup_id, backup_time) = if path.matches('/').count() == 1 {
2026 let group = BackupGroup::parse(path)?;
2028 let path = format!("api2
/json
/admin
/datastore
/{}
/snapshots
", repo.store());
2029 let mut result = client.get(&path, Some(json!({
2030 "backup
-type": group.backup_type(),
2031 "backup
-id
": group.backup_id(),
2034 let mut list: Vec<SnapshotListItem> = serde_json::from_value(result["data
"].take())?;
2035 if list.is_empty() {
2036 bail!("backup group '{}' does not contain any snapshots
:", path);
2039 list.sort_unstable_by(|a, b| b.backup_time.cmp(&a.backup_time));
2041 let backup_time = Utc.timestamp(list[0].backup_time, 0);
2043 (group.backup_type().to_owned(), group.backup_id().to_owned(), backup_time)
2045 let snapshot = BackupDir::parse(path)?;
2046 (snapshot.group().backup_type().to_owned(), snapshot.group().backup_id().to_owned(), snapshot.backup_time())
2049 let keyfile = param["keyfile
"].as_str().map(|p| PathBuf::from(p));
2050 let crypt_config = match keyfile {
2053 let (key, _) = load_and_decrtypt_key(&path, &get_encryption_key_password)?;
2054 Some(Arc::new(CryptConfig::new(key)?))
2058 let server_archive_name = if archive_name.ends_with(".pxar
") {
2059 format!("{}
.didx
", archive_name)
2061 bail!("Can only mount pxar archives
.");
2064 let client = BackupReader::start(
2066 crypt_config.clone(),
2074 let tmpfile = std::fs::OpenOptions::new()
2077 .custom_flags(libc::O_TMPFILE)
2080 let manifest = client.download_manifest().await?;
2082 let index = client.download_dynamic_index(&manifest, &server_archive_name).await?;
2083 let most_used = index.find_most_used_chunks(8);
2084 let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config.clone(), most_used);
2085 let reader = BufferedDynamicReader::new(index, chunk_reader);
2086 let mut decoder = pxar::Decoder::new(reader)?;
2087 decoder.set_callback(|path| {
2088 println!("{:?}
", path);
2092 let tmpfile = client.download(CATALOG_NAME, tmpfile).await?;
2093 let index = DynamicIndexReader::new(tmpfile)
2094 .map_err(|err| format_err!("unable to read catalog index
- {}
", err))?;
2096 // Note: do not use values stored in index (not trusted) - instead, computed them again
2097 let (csum, size) = index.compute_csum();
2098 manifest.verify_file(CATALOG_NAME, &csum, size)?;
2100 let most_used = index.find_most_used_chunks(8);
2101 let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, most_used);
2102 let mut reader = BufferedDynamicReader::new(index, chunk_reader);
2103 let mut catalogfile = std::fs::OpenOptions::new()
2106 .custom_flags(libc::O_TMPFILE)
2109 std::io::copy(&mut reader, &mut catalogfile)
2110 .map_err(|err| format_err!("unable to download catalog
- {}
", err))?;
2112 catalogfile.seek(SeekFrom::Start(0))?;
2113 let catalog_reader = CatalogReader::new(catalogfile);
2114 let state = Shell::new(
2116 &server_archive_name,
2120 println!("Starting interactive shell
");
2123 record_repository(&repo);
2128 fn catalog_mgmt_cli() -> CliCommandMap {
2129 let catalog_shell_cmd_def = CliCommand::new(&API_METHOD_CATALOG_SHELL)
2130 .arg_param(&["snapshot
", "archive
-name
"])
2131 .completion_cb("repository
", complete_repository)
2132 .completion_cb("archive
-name
", complete_pxar_archive_name)
2133 .completion_cb("snapshot
", complete_group_or_snapshot);
2135 let catalog_dump_cmd_def = CliCommand::new(&API_METHOD_DUMP_CATALOG)
2136 .arg_param(&["snapshot
"])
2137 .completion_cb("repository
", complete_repository)
2138 .completion_cb("snapshot
", complete_backup_snapshot);
2140 CliCommandMap::new()
2141 .insert("dump
", catalog_dump_cmd_def)
2142 .insert("shell
", catalog_shell_cmd_def)
2149 schema: REPO_URL_SCHEMA,
2153 description: "The maximal number of tasks to list
.",
2161 schema: OUTPUT_FORMAT,
2167 /// List running server tasks for this repo user
2168 async fn task_list(param: Value) -> Result<Value, Error> {
2170 let output_format = param["output
-format
"].as_str().unwrap_or("text
").to_owned();
2171 let repo = extract_repository_from_value(¶m)?;
2172 let client = HttpClient::new(repo.host(), repo.user(), None)?;
2174 let limit = param["limit
"].as_u64().unwrap_or(50) as usize;
2180 "userfilter
": repo.user(),
2181 "store
": repo.store(),
2183 let result = client.get("api2
/json
/nodes
/localhost
/tasks
", Some(args)).await?;
2185 let data = &result["data
"];
2187 if output_format == "text
" {
2188 for item in data.as_array().unwrap() {
2191 item["upid
"].as_str().unwrap(),
2192 item["status
"].as_str().unwrap_or("running
"),
2196 format_and_print_result(data, &output_format);
2206 schema: REPO_URL_SCHEMA,
2210 schema: UPID_SCHEMA,
2215 /// Display the task log.
2216 async fn task_log(param: Value) -> Result<Value, Error> {
2218 let repo = extract_repository_from_value(¶m)?;
2219 let upid = tools::required_string_param(¶m, "upid
")?;
2221 let client = HttpClient::new(repo.host(), repo.user(), None)?;
2223 display_task_log(client, upid, true).await?;
2232 schema: REPO_URL_SCHEMA,
2236 schema: UPID_SCHEMA,
2241 /// Try to stop a specific task.
2242 async fn task_stop(param: Value) -> Result<Value, Error> {
2244 let repo = extract_repository_from_value(¶m)?;
2245 let upid_str = tools::required_string_param(¶m, "upid
")?;
2247 let mut client = HttpClient::new(repo.host(), repo.user(), None)?;
2249 let path = format!("api2
/json
/nodes
/localhost
/tasks
/{}
", upid_str);
2250 let _ = client.delete(&path, None).await?;
2255 fn task_mgmt_cli() -> CliCommandMap {
2257 let task_list_cmd_def = CliCommand::new(&API_METHOD_TASK_LIST)
2258 .completion_cb("repository
", complete_repository);
2260 let task_log_cmd_def = CliCommand::new(&API_METHOD_TASK_LOG)
2261 .arg_param(&["upid
"]);
2263 let task_stop_cmd_def = CliCommand::new(&API_METHOD_TASK_STOP)
2264 .arg_param(&["upid
"]);
2266 CliCommandMap::new()
2267 .insert("log
", task_log_cmd_def)
2268 .insert("list
", task_list_cmd_def)
2269 .insert("stop
", task_stop_cmd_def)
2274 let backup_cmd_def = CliCommand::new(&API_METHOD_CREATE_BACKUP)
2275 .arg_param(&["backupspec
"])
2276 .completion_cb("repository
", complete_repository)
2277 .completion_cb("backupspec
", complete_backup_source)
2278 .completion_cb("keyfile
", tools::complete_file_name)
2279 .completion_cb("chunk
-size
", complete_chunk_size);
2281 let upload_log_cmd_def = CliCommand::new(&API_METHOD_UPLOAD_LOG)
2282 .arg_param(&["snapshot
", "logfile
"])
2283 .completion_cb("snapshot
", complete_backup_snapshot)
2284 .completion_cb("logfile
", tools::complete_file_name)
2285 .completion_cb("keyfile
", tools::complete_file_name)
2286 .completion_cb("repository
", complete_repository);
2288 let list_cmd_def = CliCommand::new(&API_METHOD_LIST_BACKUP_GROUPS)
2289 .completion_cb("repository
", complete_repository);
2291 let snapshots_cmd_def = CliCommand::new(&API_METHOD_LIST_SNAPSHOTS)
2292 .arg_param(&["group
"])
2293 .completion_cb("group
", complete_backup_group)
2294 .completion_cb("repository
", complete_repository);
2296 let forget_cmd_def = CliCommand::new(&API_METHOD_FORGET_SNAPSHOTS)
2297 .arg_param(&["snapshot
"])
2298 .completion_cb("repository
", complete_repository)
2299 .completion_cb("snapshot
", complete_backup_snapshot);
2301 let garbage_collect_cmd_def = CliCommand::new(&API_METHOD_START_GARBAGE_COLLECTION)
2302 .completion_cb("repository
", complete_repository);
2304 let restore_cmd_def = CliCommand::new(&API_METHOD_RESTORE)
2305 .arg_param(&["snapshot
", "archive
-name
", "target
"])
2306 .completion_cb("repository
", complete_repository)
2307 .completion_cb("snapshot
", complete_group_or_snapshot)
2308 .completion_cb("archive
-name
", complete_archive_name)
2309 .completion_cb("target
", tools::complete_file_name);
2311 let files_cmd_def = CliCommand::new(&API_METHOD_LIST_SNAPSHOT_FILES)
2312 .arg_param(&["snapshot
"])
2313 .completion_cb("repository
", complete_repository)
2314 .completion_cb("snapshot
", complete_backup_snapshot);
2316 let prune_cmd_def = CliCommand::new(&API_METHOD_PRUNE)
2317 .arg_param(&["group
"])
2318 .completion_cb("group
", complete_backup_group)
2319 .completion_cb("repository
", complete_repository);
2321 let status_cmd_def = CliCommand::new(&API_METHOD_STATUS)
2322 .completion_cb("repository
", complete_repository);
2324 let login_cmd_def = CliCommand::new(&API_METHOD_API_LOGIN)
2325 .completion_cb("repository
", complete_repository);
2327 let logout_cmd_def = CliCommand::new(&API_METHOD_API_LOGOUT)
2328 .completion_cb("repository
", complete_repository);
2331 const API_METHOD_MOUNT: ApiMethod = ApiMethod::new(
2332 &ApiHandler::Sync(&mount),
2334 "Mount pxar archive
.",
2336 ("snapshot
", false, &StringSchema::new("Group
/Snapshot path
.").schema()),
2337 ("archive
-name
", false, &StringSchema::new("Backup archive name
.").schema()),
2338 ("target
", false, &StringSchema::new("Target directory path
.").schema()),
2339 ("repository
", true, &REPO_URL_SCHEMA),
2340 ("keyfile
", true, &StringSchema::new("Path to encryption key
.").schema()),
2341 ("verbose
", true, &BooleanSchema::new("Verbose output
.").default(false).schema()),
2346 let mount_cmd_def = CliCommand::new(&API_METHOD_MOUNT)
2347 .arg_param(&["snapshot
", "archive
-name
", "target
"])
2348 .completion_cb("repository
", complete_repository)
2349 .completion_cb("snapshot
", complete_group_or_snapshot)
2350 .completion_cb("archive
-name
", complete_pxar_archive_name)
2351 .completion_cb("target
", tools::complete_file_name);
2354 let cmd_def = CliCommandMap::new()
2355 .insert("backup
", backup_cmd_def)
2356 .insert("upload
-log
", upload_log_cmd_def)
2357 .insert("forget
", forget_cmd_def)
2358 .insert("garbage
-collect
", garbage_collect_cmd_def)
2359 .insert("list
", list_cmd_def)
2360 .insert("login
", login_cmd_def)
2361 .insert("logout
", logout_cmd_def)
2362 .insert("prune
", prune_cmd_def)
2363 .insert("restore
", restore_cmd_def)
2364 .insert("snapshots
", snapshots_cmd_def)
2365 .insert("files
", files_cmd_def)
2366 .insert("status
", status_cmd_def)
2367 .insert("key
", key_mgmt_cli())
2368 .insert("mount
", mount_cmd_def)
2369 .insert("catalog
", catalog_mgmt_cli())
2370 .insert("task
", task_mgmt_cli());
2372 run_cli_command(cmd_def);
2375 fn async_main<F: Future>(fut: F) -> <F as Future>::Output {
2376 let mut rt = tokio::runtime::Runtime::new().unwrap();
2377 let ret = rt.block_on(fut);
2378 // This does not exist anymore. We need to actually stop our runaways instead...
2379 // rt.shutdown_now();