2 use nix
::unistd
::{fork, ForkResult, pipe}
;
3 use std
::os
::unix
::io
::RawFd
;
4 use chrono
::{Local, DateTime, 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
::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 fn connect(server
: &str, userid
: &str) -> Result
<HttpClient
, Error
> {
168 let options
= HttpClientOptions
::new()
170 .fingerprint_cache(true)
173 HttpClient
::new(server
, userid
, options
)
176 async
fn view_task_result(
180 ) -> Result
<(), Error
> {
181 let data
= &result
["data"];
182 if output_format
== "text" {
183 if let Some(upid
) = data
.as_str() {
184 display_task_log(client
, upid
, true).await?
;
187 format_and_print_result(&data
, &output_format
);
193 async
fn api_datastore_list_snapshots(
196 group
: Option
<BackupGroup
>,
197 ) -> Result
<Vec
<SnapshotListItem
>, Error
> {
199 let path
= format
!("api2/json/admin/datastore/{}/snapshots", store
);
201 let mut args
= json
!({}
);
202 if let Some(group
) = group
{
203 args
["backup-type"] = group
.backup_type().into();
204 args
["backup-id"] = group
.backup_id().into();
207 let mut result
= client
.get(&path
, Some(args
)).await?
;
209 let list
: Vec
<SnapshotListItem
> = serde_json
::from_value(result
["data"].take())?
;
214 async
fn api_datastore_latest_snapshot(
218 ) -> Result
<(String
, String
, DateTime
<Utc
>), Error
> {
220 let mut list
= api_datastore_list_snapshots(client
, store
, Some(group
.clone())).await?
;
223 bail
!("backup group {:?} does not contain any snapshots.", group
.group_path());
226 list
.sort_unstable_by(|a
, b
| b
.backup_time
.cmp(&a
.backup_time
));
228 let backup_time
= Utc
.timestamp(list
[0].backup_time
, 0);
230 Ok((group
.backup_type().to_owned(), group
.backup_id().to_owned(), backup_time
))
234 async
fn backup_directory
<P
: AsRef
<Path
>>(
235 client
: &BackupWriter
,
238 chunk_size
: Option
<usize>,
239 device_set
: Option
<HashSet
<u64>>,
241 skip_lost_and_found
: bool
,
242 crypt_config
: Option
<Arc
<CryptConfig
>>,
243 catalog
: Arc
<Mutex
<CatalogWriter
<crate::tools
::StdChannelWriter
>>>,
245 ) -> Result
<BackupStats
, Error
> {
247 let pxar_stream
= PxarBackupStream
::open(
255 let mut chunk_stream
= ChunkStream
::new(pxar_stream
, chunk_size
);
257 let (mut tx
, rx
) = mpsc
::channel(10); // allow to buffer 10 chunks
260 .map_err(Error
::from
);
262 // spawn chunker inside a separate task so that it can run parallel
263 tokio
::spawn(async
move {
264 while let Some(v
) = chunk_stream
.next().await
{
265 let _
= tx
.send(v
).await
;
270 .upload_stream(archive_name
, stream
, "dynamic", None
, crypt_config
)
276 async
fn backup_image
<P
: AsRef
<Path
>>(
277 client
: &BackupWriter
,
281 chunk_size
: Option
<usize>,
283 crypt_config
: Option
<Arc
<CryptConfig
>>,
284 ) -> Result
<BackupStats
, Error
> {
286 let path
= image_path
.as_ref().to_owned();
288 let file
= tokio
::fs
::File
::open(path
).await?
;
290 let stream
= tokio_util
::codec
::FramedRead
::new(file
, tokio_util
::codec
::BytesCodec
::new())
291 .map_err(Error
::from
);
293 let stream
= FixedChunkStream
::new(stream
, chunk_size
.unwrap_or(4*1024*1024));
296 .upload_stream(archive_name
, stream
, "fixed", Some(image_size
), crypt_config
)
302 fn strip_server_file_expenstion(name
: &str) -> String
{
304 if name
.ends_with(".didx") || name
.ends_with(".fidx") || name
.ends_with(".blob") {
305 name
[..name
.len()-5].to_owned()
307 name
.to_owned() // should not happen
315 schema
: REPO_URL_SCHEMA
,
319 schema
: OUTPUT_FORMAT
,
325 /// List backup groups.
326 async
fn list_backup_groups(param
: Value
) -> Result
<Value
, Error
> {
328 let repo
= extract_repository_from_value(¶m
)?
;
330 let client
= connect(repo
.host(), repo
.user())?
;
332 let path
= format
!("api2/json/admin/datastore/{}/groups", repo
.store());
334 let mut result
= client
.get(&path
, None
).await?
;
336 record_repository(&repo
);
338 // fixme: implement and use output formatter instead ..
339 let list
= result
["data"].as_array_mut().unwrap();
341 list
.sort_unstable_by(|a
, b
| {
342 let a_id
= a
["backup-id"].as_str().unwrap();
343 let a_backup_type
= a
["backup-type"].as_str().unwrap();
344 let b_id
= b
["backup-id"].as_str().unwrap();
345 let b_backup_type
= b
["backup-type"].as_str().unwrap();
347 let type_order
= a_backup_type
.cmp(b_backup_type
);
348 if type_order
== std
::cmp
::Ordering
::Equal
{
355 let output_format
= param
["output-format"].as_str().unwrap_or("text").to_owned();
357 let mut result
= vec
![];
361 let id
= item
["backup-id"].as_str().unwrap();
362 let btype
= item
["backup-type"].as_str().unwrap();
363 let epoch
= item
["last-backup"].as_i64().unwrap();
364 let last_backup
= Utc
.timestamp(epoch
, 0);
365 let backup_count
= item
["backup-count"].as_u64().unwrap();
367 let group
= BackupGroup
::new(btype
, id
);
369 let path
= group
.group_path().to_str().unwrap().to_owned();
371 let files
= item
["files"].as_array().unwrap().iter()
372 .map(|v
| strip_server_file_expenstion(v
.as_str().unwrap())).collect();
374 if output_format
== "text" {
376 "{:20} | {} | {:5} | {}",
378 BackupDir
::backup_time_to_string(last_backup
),
380 tools
::join(&files
, ' '
),
384 "backup-type": btype
,
386 "last-backup": epoch
,
387 "backup-count": backup_count
,
393 if output_format
!= "text" { format_and_print_result(&result.into(), &output_format); }
402 schema
: REPO_URL_SCHEMA
,
407 description
: "Backup group.",
411 schema
: OUTPUT_FORMAT
,
417 /// List backup snapshots.
418 async
fn list_snapshots(param
: Value
) -> Result
<Value
, Error
> {
420 let repo
= extract_repository_from_value(¶m
)?
;
422 let output_format
= param
["output-format"].as_str().unwrap_or("text").to_owned();
424 let client
= connect(repo
.host(), repo
.user())?
;
426 let group
= if let Some(path
) = param
["group"].as_str() {
427 Some(BackupGroup
::parse(path
)?
)
432 let mut list
= api_datastore_list_snapshots(&client
, repo
.store(), group
).await?
;
434 list
.sort_unstable_by(|a
, b
| a
.backup_time
.cmp(&b
.backup_time
));
436 record_repository(&repo
);
438 if output_format
!= "text" {
439 format_and_print_result(&serde_json
::to_value(list
)?
, &output_format
);
440 return Ok(Value
::Null
);
445 let snapshot
= BackupDir
::new(item
.backup_type
, item
.backup_id
, item
.backup_time
);
447 let path
= snapshot
.relative_path().to_str().unwrap().to_owned();
449 let files
= item
.files
.iter()
450 .map(|v
| strip_server_file_expenstion(&v
))
453 let size_str
= if let Some(size
) = item
.size
{
458 println
!("{} | {} | {}", path
, size_str
, tools
::join(&files
, ' '
));
468 schema
: REPO_URL_SCHEMA
,
473 description
: "Snapshot path.",
478 /// Forget (remove) backup snapshots.
479 async
fn forget_snapshots(param
: Value
) -> Result
<Value
, Error
> {
481 let repo
= extract_repository_from_value(¶m
)?
;
483 let path
= tools
::required_string_param(¶m
, "snapshot")?
;
484 let snapshot
= BackupDir
::parse(path
)?
;
486 let mut client
= connect(repo
.host(), repo
.user())?
;
488 let path
= format
!("api2/json/admin/datastore/{}/snapshots", repo
.store());
490 let result
= client
.delete(&path
, Some(json
!({
491 "backup-type": snapshot
.group().backup_type(),
492 "backup-id": snapshot
.group().backup_id(),
493 "backup-time": snapshot
.backup_time().timestamp(),
496 record_repository(&repo
);
505 schema
: REPO_URL_SCHEMA
,
511 /// Try to login. If successful, store ticket.
512 async
fn api_login(param
: Value
) -> Result
<Value
, Error
> {
514 let repo
= extract_repository_from_value(¶m
)?
;
516 let client
= connect(repo
.host(), repo
.user())?
;
517 client
.login().await?
;
519 record_repository(&repo
);
528 schema
: REPO_URL_SCHEMA
,
534 /// Logout (delete stored ticket).
535 fn api_logout(param
: Value
) -> Result
<Value
, Error
> {
537 let repo
= extract_repository_from_value(¶m
)?
;
539 delete_ticket_info(repo
.host(), repo
.user())?
;
548 schema
: REPO_URL_SCHEMA
,
553 description
: "Snapshot path.",
559 async
fn dump_catalog(param
: Value
) -> Result
<Value
, Error
> {
561 let repo
= extract_repository_from_value(¶m
)?
;
563 let path
= tools
::required_string_param(¶m
, "snapshot")?
;
564 let snapshot
= BackupDir
::parse(path
)?
;
566 let keyfile
= param
["keyfile"].as_str().map(PathBuf
::from
);
568 let crypt_config
= match keyfile
{
571 let (key
, _
) = load_and_decrypt_key(&path
, &get_encryption_key_password
)?
;
572 Some(Arc
::new(CryptConfig
::new(key
)?
))
576 let client
= connect(repo
.host(), repo
.user())?
;
578 let client
= BackupReader
::start(
580 crypt_config
.clone(),
582 &snapshot
.group().backup_type(),
583 &snapshot
.group().backup_id(),
584 snapshot
.backup_time(),
588 let manifest
= client
.download_manifest().await?
;
590 let index
= client
.download_dynamic_index(&manifest
, CATALOG_NAME
).await?
;
592 let most_used
= index
.find_most_used_chunks(8);
594 let chunk_reader
= RemoteChunkReader
::new(client
.clone(), crypt_config
, most_used
);
596 let mut reader
= BufferedDynamicReader
::new(index
, chunk_reader
);
598 let mut catalogfile
= std
::fs
::OpenOptions
::new()
601 .custom_flags(libc
::O_TMPFILE
)
604 std
::io
::copy(&mut reader
, &mut catalogfile
)
605 .map_err(|err
| format_err
!("unable to download catalog - {}", err
))?
;
607 catalogfile
.seek(SeekFrom
::Start(0))?
;
609 let mut catalog_reader
= CatalogReader
::new(catalogfile
);
611 catalog_reader
.dump()?
;
613 record_repository(&repo
);
622 schema
: REPO_URL_SCHEMA
,
627 description
: "Snapshot path.",
630 schema
: OUTPUT_FORMAT
,
636 /// List snapshot files.
637 async
fn list_snapshot_files(param
: Value
) -> Result
<Value
, Error
> {
639 let repo
= extract_repository_from_value(¶m
)?
;
641 let path
= tools
::required_string_param(¶m
, "snapshot")?
;
642 let snapshot
= BackupDir
::parse(path
)?
;
644 let output_format
= param
["output-format"].as_str().unwrap_or("text").to_owned();
646 let client
= connect(repo
.host(), repo
.user())?
;
648 let path
= format
!("api2/json/admin/datastore/{}/files", repo
.store());
650 let mut result
= client
.get(&path
, Some(json
!({
651 "backup-type": snapshot
.group().backup_type(),
652 "backup-id": snapshot
.group().backup_id(),
653 "backup-time": snapshot
.backup_time().timestamp(),
656 record_repository(&repo
);
658 let list
: Value
= result
["data"].take();
660 if output_format
== "text" {
661 for item
in list
.as_array().unwrap().iter() {
664 strip_server_file_expenstion(item
["filename"].as_str().unwrap()),
665 item
["size"].as_u64().unwrap_or(0),
669 format_and_print_result(&list
, &output_format
);
679 schema
: REPO_URL_SCHEMA
,
683 schema
: OUTPUT_FORMAT
,
689 /// Start garbage collection for a specific repository.
690 async
fn start_garbage_collection(param
: Value
) -> Result
<Value
, Error
> {
692 let repo
= extract_repository_from_value(¶m
)?
;
693 let output_format
= param
["output-format"].as_str().unwrap_or("text").to_owned();
695 let mut client
= connect(repo
.host(), repo
.user())?
;
697 let path
= format
!("api2/json/admin/datastore/{}/gc", repo
.store());
699 let result
= client
.post(&path
, None
).await?
;
701 record_repository(&repo
);
703 view_task_result(client
, result
, &output_format
).await?
;
708 fn parse_backupspec(value
: &str) -> Result
<(&str, &str), Error
> {
710 if let Some(caps
) = (BACKUPSPEC_REGEX
.regex_obj
)().captures(value
) {
711 return Ok((caps
.get(1).unwrap().as_str(), caps
.get(2).unwrap().as_str()));
713 bail
!("unable to parse directory specification '{}'", value
);
716 fn spawn_catalog_upload(
717 client
: Arc
<BackupWriter
>,
718 crypt_config
: Option
<Arc
<CryptConfig
>>,
721 Arc
<Mutex
<CatalogWriter
<crate::tools
::StdChannelWriter
>>>,
722 tokio
::sync
::oneshot
::Receiver
<Result
<BackupStats
, Error
>>
725 let (catalog_tx
, catalog_rx
) = std
::sync
::mpsc
::sync_channel(10); // allow to buffer 10 writes
726 let catalog_stream
= crate::tools
::StdChannelStream(catalog_rx
);
727 let catalog_chunk_size
= 512*1024;
728 let catalog_chunk_stream
= ChunkStream
::new(catalog_stream
, Some(catalog_chunk_size
));
730 let catalog
= Arc
::new(Mutex
::new(CatalogWriter
::new(crate::tools
::StdChannelWriter
::new(catalog_tx
))?
));
732 let (catalog_result_tx
, catalog_result_rx
) = tokio
::sync
::oneshot
::channel();
734 tokio
::spawn(async
move {
735 let catalog_upload_result
= client
736 .upload_stream(CATALOG_NAME
, catalog_chunk_stream
, "dynamic", None
, crypt_config
)
739 if let Err(ref err
) = catalog_upload_result
{
740 eprintln
!("catalog upload error - {}", err
);
744 let _
= catalog_result_tx
.send(catalog_upload_result
);
747 Ok((catalog
, catalog_result_rx
))
755 description
: "List of backup source specifications ([<label.ext>:<path>] ...)",
757 schema
: BACKUP_SOURCE_SCHEMA
,
761 schema
: REPO_URL_SCHEMA
,
765 description
: "Include mountpoints with same st_dev number (see ``man fstat``) as specified files.",
769 description
: "Path to file.",
773 schema
: KEYFILE_SCHEMA
,
776 "skip-lost-and-found": {
778 description
: "Skip lost+found directory.",
782 schema
: BACKUP_TYPE_SCHEMA
,
786 schema
: BACKUP_ID_SCHEMA
,
790 schema
: BACKUP_TIME_SCHEMA
,
794 schema
: CHUNK_SIZE_SCHEMA
,
799 description
: "Max number of entries to hold in memory.",
801 default: pxar
::ENCODER_MAX_ENTRIES
as isize,
806 /// Create (host) backup.
807 async
fn create_backup(
810 _rpcenv
: &mut dyn RpcEnvironment
,
811 ) -> Result
<Value
, Error
> {
813 let repo
= extract_repository_from_value(¶m
)?
;
815 let backupspec_list
= tools
::required_array_param(¶m
, "backupspec")?
;
817 let all_file_systems
= param
["all-file-systems"].as_bool().unwrap_or(false);
819 let skip_lost_and_found
= param
["skip-lost-and-found"].as_bool().unwrap_or(false);
821 let verbose
= param
["verbose"].as_bool().unwrap_or(false);
823 let backup_time_opt
= param
["backup-time"].as_i64();
825 let chunk_size_opt
= param
["chunk-size"].as_u64().map(|v
| (v
*1024) as usize);
827 if let Some(size
) = chunk_size_opt
{
828 verify_chunk_size(size
)?
;
831 let keyfile
= param
["keyfile"].as_str().map(PathBuf
::from
);
833 let backup_id
= param
["backup-id"].as_str().unwrap_or(&proxmox
::tools
::nodename());
835 let backup_type
= param
["backup-type"].as_str().unwrap_or("host");
837 let include_dev
= param
["include-dev"].as_array();
839 let entries_max
= param
["entries-max"].as_u64().unwrap_or(pxar
::ENCODER_MAX_ENTRIES
as u64);
841 let mut devices
= if all_file_systems { None }
else { Some(HashSet::new()) }
;
843 if let Some(include_dev
) = include_dev
{
844 if all_file_systems
{
845 bail
!("option 'all-file-systems' conflicts with option 'include-dev'");
848 let mut set
= HashSet
::new();
849 for path
in include_dev
{
850 let path
= path
.as_str().unwrap();
851 let stat
= nix
::sys
::stat
::stat(path
)
852 .map_err(|err
| format_err
!("fstat {:?} failed - {}", path
, err
))?
;
853 set
.insert(stat
.st_dev
);
858 let mut upload_list
= vec
![];
860 enum BackupType { PXAR, IMAGE, CONFIG, LOGFILE }
;
862 let mut upload_catalog
= false;
864 for backupspec
in backupspec_list
{
865 let (target
, filename
) = parse_backupspec(backupspec
.as_str().unwrap())?
;
867 use std
::os
::unix
::fs
::FileTypeExt
;
869 let metadata
= std
::fs
::metadata(filename
)
870 .map_err(|err
| format_err
!("unable to access '{}' - {}", filename
, err
))?
;
871 let file_type
= metadata
.file_type();
873 let extension
= target
.rsplit('
.'
).next()
874 .ok_or_else(|| format_err
!("missing target file extenion '{}'", target
))?
;
878 if !file_type
.is_dir() {
879 bail
!("got unexpected file type (expected directory)");
881 upload_list
.push((BackupType
::PXAR
, filename
.to_owned(), format
!("{}.didx", target
), 0));
882 upload_catalog
= true;
886 if !(file_type
.is_file() || file_type
.is_block_device()) {
887 bail
!("got unexpected file type (expected file or block device)");
890 let size
= image_size(&PathBuf
::from(filename
))?
;
892 if size
== 0 { bail!("got zero-sized file '{}'
", filename); }
894 upload_list.push((BackupType::IMAGE, filename.to_owned(), format!("{}
.fidx
", target), size));
897 if !file_type.is_file() {
898 bail!("got unexpected file
type (expected regular file
)");
900 upload_list.push((BackupType::CONFIG, filename.to_owned(), format!("{}
.blob
", target), metadata.len()));
903 if !file_type.is_file() {
904 bail!("got unexpected file
type (expected regular file
)");
906 upload_list.push((BackupType::LOGFILE, filename.to_owned(), format!("{}
.blob
", target), metadata.len()));
909 bail!("got unknown archive extension '{}'
", extension);
914 let backup_time = Utc.timestamp(backup_time_opt.unwrap_or_else(|| Utc::now().timestamp()), 0);
916 let client = connect(repo.host(), repo.user())?;
917 record_repository(&repo);
919 println!("Starting backup
: {}
/{}
/{}
", backup_type, backup_id, BackupDir::backup_time_to_string(backup_time));
921 println!("Client name
: {}
", proxmox::tools::nodename());
923 let start_time = Local::now();
925 println!("Starting protocol
: {}
", start_time.to_rfc3339_opts(chrono::SecondsFormat::Secs, false));
927 let (crypt_config, rsa_encrypted_key) = match keyfile {
928 None => (None, None),
930 let (key, created) = load_and_decrypt_key(&path, &get_encryption_key_password)?;
932 let crypt_config = CryptConfig::new(key)?;
934 let path = master_pubkey_path()?;
936 let pem_data = file_get_contents(&path)?;
937 let rsa = openssl::rsa::Rsa::public_key_from_pem(&pem_data)?;
938 let enc_key = crypt_config.generate_rsa_encoded_key(rsa, created)?;
939 (Some(Arc::new(crypt_config)), Some(enc_key))
941 (Some(Arc::new(crypt_config)), None)
946 let client = BackupWriter::start(
955 let snapshot = BackupDir::new(backup_type, backup_id, backup_time.timestamp());
956 let mut manifest = BackupManifest::new(snapshot);
958 let (catalog, catalog_result_rx) = spawn_catalog_upload(client.clone(), crypt_config.clone())?;
960 for (backup_type, filename, target, size) in upload_list {
962 BackupType::CONFIG => {
963 println!("Upload config file '{}' to '{:?}'
as {}
", filename, repo, target);
965 .upload_blob_from_file(&filename, &target, crypt_config.clone(), true)
967 manifest.add_file(target, stats.size, stats.csum)?;
969 BackupType::LOGFILE => { // fixme: remove - not needed anymore ?
970 println!("Upload log file '{}' to '{:?}'
as {}
", filename, repo, target);
972 .upload_blob_from_file(&filename, &target, crypt_config.clone(), true)
974 manifest.add_file(target, stats.size, stats.csum)?;
976 BackupType::PXAR => {
977 println!("Upload directory '{}' to '{:?}'
as {}
", filename, repo, target);
978 catalog.lock().unwrap().start_directory(std::ffi::CString::new(target.as_str())?.as_c_str())?;
979 let stats = backup_directory(
987 crypt_config.clone(),
989 entries_max as usize,
991 manifest.add_file(target, stats.size, stats.csum)?;
992 catalog.lock().unwrap().end_directory()?;
994 BackupType::IMAGE => {
995 println!("Upload image '{}' to '{:?}'
as {}
", filename, repo, target);
996 let stats = backup_image(
1003 crypt_config.clone(),
1005 manifest.add_file(target, stats.size, stats.csum)?;
1010 // finalize and upload catalog
1012 let mutex = Arc::try_unwrap(catalog)
1013 .map_err(|_| format_err!("unable to get
catalog (still used
)"))?;
1014 let mut catalog = mutex.into_inner().unwrap();
1018 drop(catalog); // close upload stream
1020 let stats = catalog_result_rx.await??;
1022 manifest.add_file(CATALOG_NAME.to_owned(), stats.size, stats.csum)?;
1025 if let Some(rsa_encrypted_key) = rsa_encrypted_key {
1026 let target = "rsa
-encrypted
.key
";
1027 println!("Upload RSA encoded key to '{:?}'
as {}
", repo, target);
1029 .upload_blob_from_data(rsa_encrypted_key, target, None, false, false)
1031 manifest.add_file(format!("{}
.blob
", target), stats.size, stats.csum)?;
1033 // openssl rsautl -decrypt -inkey master-private.pem -in rsa-encrypted.key -out t
1035 let mut buffer2 = vec![0u8; rsa.size() as usize];
1036 let pem_data = file_get_contents("master
-private
.pem
")?;
1037 let rsa = openssl::rsa::Rsa::private_key_from_pem(&pem_data)?;
1038 let len = rsa.private_decrypt(&buffer, &mut buffer2, openssl::rsa::Padding::PKCS1)?;
1039 println!("TEST {} {:?}
", len, buffer2);
1043 // create manifest (index.json)
1044 let manifest = manifest.into_json();
1046 println!("Upload index
.json to '{:?}'
", repo);
1047 let manifest = serde_json::to_string_pretty(&manifest)?.into();
1049 .upload_blob_from_data(manifest, MANIFEST_BLOB_NAME, crypt_config.clone(), true, true)
1052 client.finish().await?;
1054 let end_time = Local::now();
1055 let elapsed = end_time.signed_duration_since(start_time);
1056 println!("Duration
: {}
", elapsed);
1058 println!("End Time
: {}
", end_time.to_rfc3339_opts(chrono::SecondsFormat::Secs, false));
1063 fn complete_backup_source(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1065 let mut result = vec![];
1067 let data: Vec<&str> = arg.splitn(2, ':').collect();
1069 if data.len() != 2 {
1070 result.push(String::from("root
.pxar
:/"));
1071 result.push(String::from("etc
.pxar
:/etc
"));
1075 let files = tools::complete_file_name(data[1], param);
1078 result.push(format!("{}
:{}
", data[0], file));
1084 fn dump_image<W: Write>(
1085 client: Arc<BackupReader>,
1086 crypt_config: Option<Arc<CryptConfig>>,
1087 index: FixedIndexReader,
1090 ) -> Result<(), Error> {
1092 let most_used = index.find_most_used_chunks(8);
1094 let mut chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, most_used);
1096 // Note: we avoid using BufferedFixedReader, because that add an additional buffer/copy
1097 // and thus slows down reading. Instead, directly use RemoteChunkReader
1100 let start_time = std::time::Instant::now();
1102 for pos in 0..index.index_count() {
1103 let digest = index.index_digest(pos).unwrap();
1104 let raw_data = chunk_reader.read_chunk(&digest)?;
1105 writer.write_all(&raw_data)?;
1106 bytes += raw_data.len();
1108 let next_per = ((pos+1)*100)/index.index_count();
1109 if per != next_per {
1110 eprintln!("progress {}
% (read {} bytes
, duration {} sec
)",
1111 next_per, bytes, start_time.elapsed().as_secs());
1117 let end_time = std::time::Instant::now();
1118 let elapsed = end_time.duration_since(start_time);
1119 eprintln!("restore image
complete (bytes
={}
, duration
={:.2}s
, speed
={:.2}MB
/s
)",
1121 elapsed.as_secs_f64(),
1122 bytes as f64/(1024.0*1024.0*elapsed.as_secs_f64())
1133 schema: REPO_URL_SCHEMA,
1138 description: "Group
/Snapshot path
.",
1141 description: "Backup archive name
.",
1146 description: r###"Target directory path
. Use '
-' to write to standard output
.
1148 We
do not extraxt '
.pxar' archives when writing to standard output
.
1152 "allow
-existing
-dirs
": {
1154 description: "Do not fail
if directories already exists
.",
1158 schema: KEYFILE_SCHEMA,
1164 /// Restore backup repository.
1165 async fn restore(param: Value) -> Result<Value, Error> {
1166 let repo = extract_repository_from_value(¶m)?;
1168 let verbose = param["verbose
"].as_bool().unwrap_or(false);
1170 let allow_existing_dirs = param["allow
-existing
-dirs
"].as_bool().unwrap_or(false);
1172 let archive_name = tools::required_string_param(¶m, "archive
-name
")?;
1174 let client = connect(repo.host(), repo.user())?;
1176 record_repository(&repo);
1178 let path = tools::required_string_param(¶m, "snapshot
")?;
1180 let (backup_type, backup_id, backup_time) = if path.matches('/').count() == 1 {
1181 let group = BackupGroup::parse(path)?;
1182 api_datastore_latest_snapshot(&client, repo.store(), group).await?
1184 let snapshot = BackupDir::parse(path)?;
1185 (snapshot.group().backup_type().to_owned(), snapshot.group().backup_id().to_owned(), snapshot.backup_time())
1188 let target = tools::required_string_param(¶m, "target
")?;
1189 let target = if target == "-" { None } else { Some(target) };
1191 let keyfile = param["keyfile
"].as_str().map(PathBuf::from);
1193 let crypt_config = match keyfile {
1196 let (key, _) = load_and_decrypt_key(&path, &get_encryption_key_password)?;
1197 Some(Arc::new(CryptConfig::new(key)?))
1201 let server_archive_name = if archive_name.ends_with(".pxar
") {
1202 format!("{}
.didx
", archive_name)
1203 } else if archive_name.ends_with(".img
") {
1204 format!("{}
.fidx
", archive_name)
1206 format!("{}
.blob
", archive_name)
1209 let client = BackupReader::start(
1211 crypt_config.clone(),
1219 let manifest = client.download_manifest().await?;
1221 if server_archive_name == MANIFEST_BLOB_NAME {
1222 let backup_index_data = manifest.into_json().to_string();
1223 if let Some(target) = target {
1224 replace_file(target, backup_index_data.as_bytes(), CreateOptions::new())?;
1226 let stdout = std::io::stdout();
1227 let mut writer = stdout.lock();
1228 writer.write_all(backup_index_data.as_bytes())
1229 .map_err(|err| format_err!("unable to pipe data
- {}
", err))?;
1232 } else if server_archive_name.ends_with(".blob
") {
1234 let mut reader = client.download_blob(&manifest, &server_archive_name).await?;
1236 if let Some(target) = target {
1237 let mut writer = std::fs::OpenOptions::new()
1242 .map_err(|err| format_err!("unable to create target file {:?}
- {}
", target, err))?;
1243 std::io::copy(&mut reader, &mut writer)?;
1245 let stdout = std::io::stdout();
1246 let mut writer = stdout.lock();
1247 std::io::copy(&mut reader, &mut writer)
1248 .map_err(|err| format_err!("unable to pipe data
- {}
", err))?;
1251 } else if server_archive_name.ends_with(".didx
") {
1253 let index = client.download_dynamic_index(&manifest, &server_archive_name).await?;
1255 let most_used = index.find_most_used_chunks(8);
1257 let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, most_used);
1259 let mut reader = BufferedDynamicReader::new(index, chunk_reader);
1261 if let Some(target) = target {
1263 let feature_flags = pxar::flags::DEFAULT;
1264 let mut decoder = pxar::SequentialDecoder::new(&mut reader, feature_flags);
1265 decoder.set_callback(move |path| {
1267 eprintln!("{:?}
", path);
1271 decoder.set_allow_existing_dirs(allow_existing_dirs);
1273 decoder.restore(Path::new(target), &Vec::new())?;
1275 let mut writer = std::fs::OpenOptions::new()
1277 .open("/dev
/stdout
")
1278 .map_err(|err| format_err!("unable to open
/dev
/stdout
- {}
", err))?;
1280 std::io::copy(&mut reader, &mut writer)
1281 .map_err(|err| format_err!("unable to pipe data
- {}
", err))?;
1283 } else if server_archive_name.ends_with(".fidx
") {
1285 let index = client.download_fixed_index(&manifest, &server_archive_name).await?;
1287 let mut writer = if let Some(target) = target {
1288 std::fs::OpenOptions::new()
1293 .map_err(|err| format_err!("unable to create target file {:?}
- {}
", target, err))?
1295 std::fs::OpenOptions::new()
1297 .open("/dev
/stdout
")
1298 .map_err(|err| format_err!("unable to open
/dev
/stdout
- {}
", err))?
1301 dump_image(client.clone(), crypt_config.clone(), index, &mut writer, verbose)?;
1304 bail!("unknown archive file
extension (expected
.pxar of
.img
)");
1314 schema: REPO_URL_SCHEMA,
1319 description: "Group
/Snapshot path
.",
1323 description: "The path to the log file you want to upload
.",
1326 schema: KEYFILE_SCHEMA,
1332 /// Upload backup log file.
1333 async fn upload_log(param: Value) -> Result<Value, Error> {
1335 let logfile = tools::required_string_param(¶m, "logfile
")?;
1336 let repo = extract_repository_from_value(¶m)?;
1338 let snapshot = tools::required_string_param(¶m, "snapshot
")?;
1339 let snapshot = BackupDir::parse(snapshot)?;
1341 let mut client = connect(repo.host(), repo.user())?;
1343 let keyfile = param["keyfile
"].as_str().map(PathBuf::from);
1345 let crypt_config = match keyfile {
1348 let (key, _created) = load_and_decrypt_key(&path, &get_encryption_key_password)?;
1349 let crypt_config = CryptConfig::new(key)?;
1350 Some(Arc::new(crypt_config))
1354 let data = file_get_contents(logfile)?;
1356 let blob = DataBlob::encode(&data, crypt_config.as_ref().map(Arc::as_ref), true)?;
1358 let raw_data = blob.into_inner();
1360 let path = format!("api2
/json
/admin
/datastore
/{}
/upload
-backup
-log
", repo.store());
1363 "backup
-type": snapshot.group().backup_type(),
1364 "backup
-id
": snapshot.group().backup_id(),
1365 "backup
-time
": snapshot.backup_time().timestamp(),
1368 let body = hyper::Body::from(raw_data);
1370 client.upload("application
/octet
-stream
", body, &path, Some(args)).await
1377 schema: REPO_URL_SCHEMA,
1382 description: "Backup group
.",
1385 schema: OUTPUT_FORMAT,
1390 description: "Just show what prune would
do, but
do not delete anything
.",
1396 /// Prune a backup repository.
1397 async fn prune(mut param: Value) -> Result<Value, Error> {
1399 let repo = extract_repository_from_value(¶m)?;
1401 let mut client = connect(repo.host(), repo.user())?;
1403 let path = format!("api2
/json
/admin
/datastore
/{}
/prune
", repo.store());
1405 let group = tools::required_string_param(¶m, "group
")?;
1406 let group = BackupGroup::parse(group)?;
1407 let output_format = param["output
-format
"].as_str().unwrap_or("text
").to_owned();
1409 param.as_object_mut().unwrap().remove("repository
");
1410 param.as_object_mut().unwrap().remove("group
");
1411 param.as_object_mut().unwrap().remove("output
-format
");
1413 param["backup
-type"] = group.backup_type().into();
1414 param["backup
-id
"] = group.backup_id().into();
1416 let result = client.post(&path, Some(param)).await?;
1418 record_repository(&repo);
1420 view_task_result(client, result, &output_format).await?;
1429 schema: REPO_URL_SCHEMA,
1433 schema: OUTPUT_FORMAT,
1439 /// Get repository status.
1440 async fn status(param: Value) -> Result<Value, Error> {
1442 let repo = extract_repository_from_value(¶m)?;
1444 let output_format = param["output
-format
"].as_str().unwrap_or("text
").to_owned();
1446 let client = connect(repo.host(), repo.user())?;
1448 let path = format!("api2
/json
/admin
/datastore
/{}
/status
", repo.store());
1450 let mut result = client.get(&path, None).await?;
1452 record_repository(&repo);
1454 if output_format == "text
" {
1455 let result: StorageStatus = serde_json::from_value(result["data
"].take())?;
1457 let roundup = result.total/200;
1460 "total
: {} used
: {}
({}
%) available
: {}
",
1463 ((result.used+roundup)*100)/result.total,
1467 format_and_print_result(&result["data
"], &output_format);
1473 // like get, but simply ignore errors and return Null instead
1474 async fn try_get(repo: &BackupRepository, url: &str) -> Value {
1476 let options = HttpClientOptions::new()
1478 .fingerprint_cache(true)
1479 .ticket_cache(true);
1481 let client = match HttpClient::new(repo.host(), repo.user(), options) {
1483 _ => return Value::Null,
1486 let mut resp = match client.get(url, None).await {
1488 _ => return Value::Null,
1491 if let Some(map) = resp.as_object_mut() {
1492 if let Some(data) = map.remove("data
") {
1499 fn complete_backup_group(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1500 proxmox_backup::tools::runtime::main(async { complete_backup_group_do(param).await })
1503 async fn complete_backup_group_do(param: &HashMap<String, String>) -> Vec<String> {
1505 let mut result = vec![];
1507 let repo = match extract_repository_from_map(param) {
1512 let path = format!("api2
/json
/admin
/datastore
/{}
/groups
", repo.store());
1514 let data = try_get(&repo, &path).await;
1516 if let Some(list) = data.as_array() {
1518 if let (Some(backup_id), Some(backup_type)) =
1519 (item["backup
-id
"].as_str(), item["backup
-type"].as_str())
1521 result.push(format!("{}
/{}
", backup_type, backup_id));
1529 fn complete_group_or_snapshot(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1530 proxmox_backup::tools::runtime::main(async { complete_group_or_snapshot_do(arg, param).await })
1533 async fn complete_group_or_snapshot_do(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1535 if arg.matches('/').count() < 2 {
1536 let groups = complete_backup_group_do(param).await;
1537 let mut result = vec![];
1538 for group in groups {
1539 result.push(group.to_string());
1540 result.push(format!("{}
/", group));
1545 complete_backup_snapshot_do(param).await
1548 fn complete_backup_snapshot(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1549 proxmox_backup::tools::runtime::main(async { complete_backup_snapshot_do(param).await })
1552 async fn complete_backup_snapshot_do(param: &HashMap<String, String>) -> Vec<String> {
1554 let mut result = vec![];
1556 let repo = match extract_repository_from_map(param) {
1561 let path = format!("api2
/json
/admin
/datastore
/{}
/snapshots
", repo.store());
1563 let data = try_get(&repo, &path).await;
1565 if let Some(list) = data.as_array() {
1567 if let (Some(backup_id), Some(backup_type), Some(backup_time)) =
1568 (item["backup
-id
"].as_str(), item["backup
-type"].as_str(), item["backup
-time
"].as_i64())
1570 let snapshot = BackupDir::new(backup_type, backup_id, backup_time);
1571 result.push(snapshot.relative_path().to_str().unwrap().to_owned());
1579 fn complete_server_file_name(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1580 proxmox_backup::tools::runtime::main(async { complete_server_file_name_do(param).await })
1583 async fn complete_server_file_name_do(param: &HashMap<String, String>) -> Vec<String> {
1585 let mut result = vec![];
1587 let repo = match extract_repository_from_map(param) {
1592 let snapshot = match param.get("snapshot
") {
1594 match BackupDir::parse(path) {
1602 let query = tools::json_object_to_query(json!({
1603 "backup
-type": snapshot.group().backup_type(),
1604 "backup
-id
": snapshot.group().backup_id(),
1605 "backup
-time
": snapshot.backup_time().timestamp(),
1608 let path = format!("api2
/json
/admin
/datastore
/{}
/files?{}
", repo.store(), query);
1610 let data = try_get(&repo, &path).await;
1612 if let Some(list) = data.as_array() {
1614 if let Some(filename) = item["filename
"].as_str() {
1615 result.push(filename.to_owned());
1623 fn complete_archive_name(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1624 complete_server_file_name(arg, param)
1626 .map(|v| strip_server_file_expenstion(&v))
1630 fn complete_pxar_archive_name(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1631 complete_server_file_name(arg, param)
1634 let name = strip_server_file_expenstion(&v);
1635 if name.ends_with(".pxar
") {
1644 fn complete_chunk_size(_arg: &str, _param: &HashMap<String, String>) -> Vec<String> {
1646 let mut result = vec![];
1650 result.push(size.to_string());
1652 if size > 4096 { break; }
1658 fn get_encryption_key_password() -> Result<Vec<u8>, Error> {
1660 // fixme: implement other input methods
1662 use std::env::VarError::*;
1663 match std::env::var("PBS_ENCRYPTION_PASSWORD
") {
1664 Ok(p) => return Ok(p.as_bytes().to_vec()),
1665 Err(NotUnicode(_)) => bail!("PBS_ENCRYPTION_PASSWORD contains bad characters
"),
1666 Err(NotPresent) => {
1667 // Try another method
1671 // If we're on a TTY, query the user for a password
1672 if crate::tools::tty::stdin_isatty() {
1673 return Ok(crate::tools::tty::read_password("Encryption Key Password
: ")?);
1676 bail!("no password input mechanism available
");
1682 _rpcenv: &mut dyn RpcEnvironment,
1683 ) -> Result<Value, Error> {
1685 let path = tools::required_string_param(¶m, "path
")?;
1686 let path = PathBuf::from(path);
1688 let kdf = param["kdf
"].as_str().unwrap_or("scrypt
");
1690 let key = proxmox::sys::linux::random_data(32)?;
1692 if kdf == "scrypt
" {
1693 // always read passphrase from tty
1694 if !crate::tools::tty::stdin_isatty() {
1695 bail!("unable to read passphrase
- no tty
");
1698 let password = crate::tools::tty::read_and_verify_password("Encryption Key Password
: ")?;
1700 let key_config = encrypt_key_with_passphrase(&key, &password)?;
1702 store_key_config(&path, false, key_config)?;
1705 } else if kdf == "none
" {
1706 let created = Local.timestamp(Local::now().timestamp(), 0);
1708 store_key_config(&path, false, KeyConfig {
1721 fn master_pubkey_path() -> Result<PathBuf, Error> {
1722 let base = BaseDirectories::with_prefix("proxmox
-backup
")?;
1724 // usually $HOME/.config/proxmox-backup/master-public.pem
1725 let path = base.place_config_file("master
-public
.pem
")?;
1730 fn key_import_master_pubkey(
1733 _rpcenv: &mut dyn RpcEnvironment,
1734 ) -> Result<Value, Error> {
1736 let path = tools::required_string_param(¶m, "path
")?;
1737 let path = PathBuf::from(path);
1739 let pem_data = file_get_contents(&path)?;
1741 if let Err(err) = openssl::pkey::PKey::public_key_from_pem(&pem_data) {
1742 bail!("Unable to decode PEM data
- {}
", err);
1745 let target_path = master_pubkey_path()?;
1747 replace_file(&target_path, &pem_data, CreateOptions::new())?;
1749 println!("Imported public master key to {:?}
", target_path);
1754 fn key_create_master_key(
1757 _rpcenv: &mut dyn RpcEnvironment,
1758 ) -> Result<Value, Error> {
1760 // we need a TTY to query the new password
1761 if !crate::tools::tty::stdin_isatty() {
1762 bail!("unable to create master key
- no tty
");
1765 let rsa = openssl::rsa::Rsa::generate(4096)?;
1766 let pkey = openssl::pkey::PKey::from_rsa(rsa)?;
1769 let password = String::from_utf8(crate::tools::tty::read_and_verify_password("Master Key Password
: ")?)?;
1771 let pub_key: Vec<u8> = pkey.public_key_to_pem()?;
1772 let filename_pub = "master
-public
.pem
";
1773 println!("Writing public master key to {}
", filename_pub);
1774 replace_file(filename_pub, pub_key.as_slice(), CreateOptions::new())?;
1776 let cipher = openssl::symm::Cipher::aes_256_cbc();
1777 let priv_key: Vec<u8> = pkey.private_key_to_pem_pkcs8_passphrase(cipher, password.as_bytes())?;
1779 let filename_priv = "master
-private
.pem
";
1780 println!("Writing private master key to {}
", filename_priv);
1781 replace_file(filename_priv, priv_key.as_slice(), CreateOptions::new())?;
1786 fn key_change_passphrase(
1789 _rpcenv: &mut dyn RpcEnvironment,
1790 ) -> Result<Value, Error> {
1792 let path = tools::required_string_param(¶m, "path
")?;
1793 let path = PathBuf::from(path);
1795 let kdf = param["kdf
"].as_str().unwrap_or("scrypt
");
1797 // we need a TTY to query the new password
1798 if !crate::tools::tty::stdin_isatty() {
1799 bail!("unable to change passphrase
- no tty
");
1802 let (key, created) = load_and_decrypt_key(&path, &get_encryption_key_password)?;
1804 if kdf == "scrypt
" {
1806 let password = crate::tools::tty::read_and_verify_password("New Password
: ")?;
1808 let mut new_key_config = encrypt_key_with_passphrase(&key, &password)?;
1809 new_key_config.created = created; // keep original value
1811 store_key_config(&path, true, new_key_config)?;
1814 } else if kdf == "none
" {
1815 let modified = Local.timestamp(Local::now().timestamp(), 0);
1817 store_key_config(&path, true, KeyConfig {
1819 created, // keep original value
1830 fn key_mgmt_cli() -> CliCommandMap {
1832 const KDF_SCHEMA: Schema =
1833 StringSchema::new("Key derivation function
. Choose 'none' to store the key unecrypted
.")
1834 .format(&ApiStringFormat::Enum(&["scrypt
", "none
"]))
1839 const API_METHOD_KEY_CREATE: ApiMethod = ApiMethod::new(
1840 &ApiHandler::Sync(&key_create),
1842 "Create a new encryption key
.",
1844 ("path
", false, &StringSchema::new("File system path
.").schema()),
1845 ("kdf
", true, &KDF_SCHEMA),
1850 let key_create_cmd_def = CliCommand::new(&API_METHOD_KEY_CREATE)
1851 .arg_param(&["path
"])
1852 .completion_cb("path
", tools::complete_file_name);
1855 const API_METHOD_KEY_CHANGE_PASSPHRASE: ApiMethod = ApiMethod::new(
1856 &ApiHandler::Sync(&key_change_passphrase),
1858 "Change the passphrase required to decrypt the key
.",
1860 ("path
", false, &StringSchema::new("File system path
.").schema()),
1861 ("kdf
", true, &KDF_SCHEMA),
1866 let key_change_passphrase_cmd_def = CliCommand::new(&API_METHOD_KEY_CHANGE_PASSPHRASE)
1867 .arg_param(&["path
"])
1868 .completion_cb("path
", tools::complete_file_name);
1870 const API_METHOD_KEY_CREATE_MASTER_KEY: ApiMethod = ApiMethod::new(
1871 &ApiHandler::Sync(&key_create_master_key),
1872 &ObjectSchema::new("Create a new
4096 bit RSA master
pub/priv key pair
.", &[])
1875 let key_create_master_key_cmd_def = CliCommand::new(&API_METHOD_KEY_CREATE_MASTER_KEY);
1878 const API_METHOD_KEY_IMPORT_MASTER_PUBKEY: ApiMethod = ApiMethod::new(
1879 &ApiHandler::Sync(&key_import_master_pubkey),
1881 "Import a new RSA public key and
use it
as master key
. The key is expected to be
in '
.pem' format
.",
1882 &sorted!([ ("path
", false, &StringSchema::new("File system path
.").schema()) ]),
1886 let key_import_master_pubkey_cmd_def = CliCommand::new(&API_METHOD_KEY_IMPORT_MASTER_PUBKEY)
1887 .arg_param(&["path
"])
1888 .completion_cb("path
", tools::complete_file_name);
1890 CliCommandMap::new()
1891 .insert("create
", key_create_cmd_def)
1892 .insert("create
-master
-key
", key_create_master_key_cmd_def)
1893 .insert("import
-master
-pubkey
", key_import_master_pubkey_cmd_def)
1894 .insert("change
-passphrase
", key_change_passphrase_cmd_def)
1900 _rpcenv: &mut dyn RpcEnvironment,
1901 ) -> Result<Value, Error> {
1902 let verbose = param["verbose
"].as_bool().unwrap_or(false);
1904 // This will stay in foreground with debug output enabled as None is
1905 // passed for the RawFd.
1906 return proxmox_backup::tools::runtime::main(mount_do(param, None));
1909 // Process should be deamonized.
1910 // Make sure to fork before the async runtime is instantiated to avoid troubles.
1913 Ok(ForkResult::Parent { .. }) => {
1914 nix::unistd::close(pipe.1).unwrap();
1915 // Blocks the parent process until we are ready to go in the child
1916 let _res = nix::unistd::read(pipe.0, &mut [0]).unwrap();
1919 Ok(ForkResult::Child) => {
1920 nix::unistd::close(pipe.0).unwrap();
1921 nix::unistd::setsid().unwrap();
1922 proxmox_backup::tools::runtime::main(mount_do(param, Some(pipe.1)))
1924 Err(_) => bail!("failed to daemonize process
"),
1928 async fn mount_do(param: Value, pipe: Option<RawFd>) -> Result<Value, Error> {
1929 let repo = extract_repository_from_value(¶m)?;
1930 let archive_name = tools::required_string_param(¶m, "archive
-name
")?;
1931 let target = tools::required_string_param(¶m, "target
")?;
1932 let client = connect(repo.host(), repo.user())?;
1934 record_repository(&repo);
1936 let path = tools::required_string_param(¶m, "snapshot
")?;
1937 let (backup_type, backup_id, backup_time) = if path.matches('/').count() == 1 {
1938 let group = BackupGroup::parse(path)?;
1939 api_datastore_latest_snapshot(&client, repo.store(), group).await?
1941 let snapshot = BackupDir::parse(path)?;
1942 (snapshot.group().backup_type().to_owned(), snapshot.group().backup_id().to_owned(), snapshot.backup_time())
1945 let keyfile = param["keyfile
"].as_str().map(PathBuf::from);
1946 let crypt_config = match keyfile {
1949 let (key, _) = load_and_decrypt_key(&path, &get_encryption_key_password)?;
1950 Some(Arc::new(CryptConfig::new(key)?))
1954 let server_archive_name = if archive_name.ends_with(".pxar
") {
1955 format!("{}
.didx
", archive_name)
1957 bail!("Can only mount pxar archives
.");
1960 let client = BackupReader::start(
1962 crypt_config.clone(),
1970 let manifest = client.download_manifest().await?;
1972 if server_archive_name.ends_with(".didx
") {
1973 let index = client.download_dynamic_index(&manifest, &server_archive_name).await?;
1974 let most_used = index.find_most_used_chunks(8);
1975 let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, most_used);
1976 let reader = BufferedDynamicReader::new(index, chunk_reader);
1977 let decoder = pxar::Decoder::new(reader)?;
1978 let options = OsStr::new("ro
,default_permissions
");
1979 let mut session = pxar::fuse::Session::new(decoder, &options, pipe.is_none())
1980 .map_err(|err| format_err!("pxar mount failed
: {}
", err))?;
1982 // Mount the session but not call fuse deamonize as this will cause
1983 // issues with the runtime after the fork
1984 let deamonize = false;
1985 session.mount(&Path::new(target), deamonize)?;
1987 if let Some(pipe) = pipe {
1988 nix::unistd::chdir(Path::new("/")).unwrap();
1989 // Finish creation of deamon by redirecting filedescriptors.
1990 let nullfd = nix::fcntl::open(
1992 nix::fcntl::OFlag::O_RDWR,
1993 nix::sys::stat::Mode::empty(),
1995 nix::unistd::dup2(nullfd, 0).unwrap();
1996 nix::unistd::dup2(nullfd, 1).unwrap();
1997 nix::unistd::dup2(nullfd, 2).unwrap();
1999 nix::unistd::close(nullfd).unwrap();
2001 // Signal the parent process that we are done with the setup and it can
2003 nix::unistd::write(pipe, &[0u8])?;
2004 nix::unistd::close(pipe).unwrap();
2007 let multithreaded = true;
2008 session.run_loop(multithreaded)?;
2010 bail!("unknown archive file
extension (expected
.pxar
)");
2021 description: "Group
/Snapshot path
.",
2025 description: "Backup archive name
.",
2029 schema: REPO_URL_SCHEMA,
2034 description: "Path to encryption key
.",
2039 /// Shell to interactively inspect and restore snapshots.
2040 async fn catalog_shell(param: Value) -> Result<(), Error> {
2041 let repo = extract_repository_from_value(¶m)?;
2042 let client = connect(repo.host(), repo.user())?;
2043 let path = tools::required_string_param(¶m, "snapshot
")?;
2044 let archive_name = tools::required_string_param(¶m, "archive
-name
")?;
2046 let (backup_type, backup_id, backup_time) = if path.matches('/').count() == 1 {
2047 let group = BackupGroup::parse(path)?;
2048 api_datastore_latest_snapshot(&client, repo.store(), group).await?
2050 let snapshot = BackupDir::parse(path)?;
2051 (snapshot.group().backup_type().to_owned(), snapshot.group().backup_id().to_owned(), snapshot.backup_time())
2054 let keyfile = param["keyfile
"].as_str().map(|p| PathBuf::from(p));
2055 let crypt_config = match keyfile {
2058 let (key, _) = load_and_decrypt_key(&path, &get_encryption_key_password)?;
2059 Some(Arc::new(CryptConfig::new(key)?))
2063 let server_archive_name = if archive_name.ends_with(".pxar
") {
2064 format!("{}
.didx
", archive_name)
2066 bail!("Can only mount pxar archives
.");
2069 let client = BackupReader::start(
2071 crypt_config.clone(),
2079 let tmpfile = std::fs::OpenOptions::new()
2082 .custom_flags(libc::O_TMPFILE)
2085 let manifest = client.download_manifest().await?;
2087 let index = client.download_dynamic_index(&manifest, &server_archive_name).await?;
2088 let most_used = index.find_most_used_chunks(8);
2089 let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config.clone(), most_used);
2090 let reader = BufferedDynamicReader::new(index, chunk_reader);
2091 let mut decoder = pxar::Decoder::new(reader)?;
2092 decoder.set_callback(|path| {
2093 println!("{:?}
", path);
2097 let tmpfile = client.download(CATALOG_NAME, tmpfile).await?;
2098 let index = DynamicIndexReader::new(tmpfile)
2099 .map_err(|err| format_err!("unable to read catalog index
- {}
", err))?;
2101 // Note: do not use values stored in index (not trusted) - instead, computed them again
2102 let (csum, size) = index.compute_csum();
2103 manifest.verify_file(CATALOG_NAME, &csum, size)?;
2105 let most_used = index.find_most_used_chunks(8);
2106 let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, most_used);
2107 let mut reader = BufferedDynamicReader::new(index, chunk_reader);
2108 let mut catalogfile = std::fs::OpenOptions::new()
2111 .custom_flags(libc::O_TMPFILE)
2114 std::io::copy(&mut reader, &mut catalogfile)
2115 .map_err(|err| format_err!("unable to download catalog
- {}
", err))?;
2117 catalogfile.seek(SeekFrom::Start(0))?;
2118 let catalog_reader = CatalogReader::new(catalogfile);
2119 let state = Shell::new(
2121 &server_archive_name,
2125 println!("Starting interactive shell
");
2128 record_repository(&repo);
2133 fn catalog_mgmt_cli() -> CliCommandMap {
2134 let catalog_shell_cmd_def = CliCommand::new(&API_METHOD_CATALOG_SHELL)
2135 .arg_param(&["snapshot
", "archive
-name
"])
2136 .completion_cb("repository
", complete_repository)
2137 .completion_cb("archive
-name
", complete_pxar_archive_name)
2138 .completion_cb("snapshot
", complete_group_or_snapshot);
2140 let catalog_dump_cmd_def = CliCommand::new(&API_METHOD_DUMP_CATALOG)
2141 .arg_param(&["snapshot
"])
2142 .completion_cb("repository
", complete_repository)
2143 .completion_cb("snapshot
", complete_backup_snapshot);
2145 CliCommandMap::new()
2146 .insert("dump
", catalog_dump_cmd_def)
2147 .insert("shell
", catalog_shell_cmd_def)
2154 schema: REPO_URL_SCHEMA,
2158 description: "The maximal number of tasks to list
.",
2166 schema: OUTPUT_FORMAT,
2172 /// List running server tasks for this repo user
2173 async fn task_list(param: Value) -> Result<Value, Error> {
2175 let output_format = param["output
-format
"].as_str().unwrap_or("text
").to_owned();
2176 let repo = extract_repository_from_value(¶m)?;
2177 let client = connect(repo.host(), repo.user())?;
2179 let limit = param["limit
"].as_u64().unwrap_or(50) as usize;
2185 "userfilter
": repo.user(),
2186 "store
": repo.store(),
2188 let result = client.get("api2
/json
/nodes
/localhost
/tasks
", Some(args)).await?;
2190 let data = &result["data
"];
2192 if output_format == "text
" {
2193 for item in data.as_array().unwrap() {
2196 item["upid
"].as_str().unwrap(),
2197 item["status
"].as_str().unwrap_or("running
"),
2201 format_and_print_result(data, &output_format);
2211 schema: REPO_URL_SCHEMA,
2215 schema: UPID_SCHEMA,
2220 /// Display the task log.
2221 async fn task_log(param: Value) -> Result<Value, Error> {
2223 let repo = extract_repository_from_value(¶m)?;
2224 let upid = tools::required_string_param(¶m, "upid
")?;
2226 let client = connect(repo.host(), repo.user())?;
2228 display_task_log(client, upid, true).await?;
2237 schema: REPO_URL_SCHEMA,
2241 schema: UPID_SCHEMA,
2246 /// Try to stop a specific task.
2247 async fn task_stop(param: Value) -> Result<Value, Error> {
2249 let repo = extract_repository_from_value(¶m)?;
2250 let upid_str = tools::required_string_param(¶m, "upid
")?;
2252 let mut client = connect(repo.host(), repo.user())?;
2254 let path = format!("api2
/json
/nodes
/localhost
/tasks
/{}
", upid_str);
2255 let _ = client.delete(&path, None).await?;
2260 fn task_mgmt_cli() -> CliCommandMap {
2262 let task_list_cmd_def = CliCommand::new(&API_METHOD_TASK_LIST)
2263 .completion_cb("repository
", complete_repository);
2265 let task_log_cmd_def = CliCommand::new(&API_METHOD_TASK_LOG)
2266 .arg_param(&["upid
"]);
2268 let task_stop_cmd_def = CliCommand::new(&API_METHOD_TASK_STOP)
2269 .arg_param(&["upid
"]);
2271 CliCommandMap::new()
2272 .insert("log
", task_log_cmd_def)
2273 .insert("list
", task_list_cmd_def)
2274 .insert("stop
", task_stop_cmd_def)
2279 let backup_cmd_def = CliCommand::new(&API_METHOD_CREATE_BACKUP)
2280 .arg_param(&["backupspec
"])
2281 .completion_cb("repository
", complete_repository)
2282 .completion_cb("backupspec
", complete_backup_source)
2283 .completion_cb("keyfile
", tools::complete_file_name)
2284 .completion_cb("chunk
-size
", complete_chunk_size);
2286 let upload_log_cmd_def = CliCommand::new(&API_METHOD_UPLOAD_LOG)
2287 .arg_param(&["snapshot
", "logfile
"])
2288 .completion_cb("snapshot
", complete_backup_snapshot)
2289 .completion_cb("logfile
", tools::complete_file_name)
2290 .completion_cb("keyfile
", tools::complete_file_name)
2291 .completion_cb("repository
", complete_repository);
2293 let list_cmd_def = CliCommand::new(&API_METHOD_LIST_BACKUP_GROUPS)
2294 .completion_cb("repository
", complete_repository);
2296 let snapshots_cmd_def = CliCommand::new(&API_METHOD_LIST_SNAPSHOTS)
2297 .arg_param(&["group
"])
2298 .completion_cb("group
", complete_backup_group)
2299 .completion_cb("repository
", complete_repository);
2301 let forget_cmd_def = CliCommand::new(&API_METHOD_FORGET_SNAPSHOTS)
2302 .arg_param(&["snapshot
"])
2303 .completion_cb("repository
", complete_repository)
2304 .completion_cb("snapshot
", complete_backup_snapshot);
2306 let garbage_collect_cmd_def = CliCommand::new(&API_METHOD_START_GARBAGE_COLLECTION)
2307 .completion_cb("repository
", complete_repository);
2309 let restore_cmd_def = CliCommand::new(&API_METHOD_RESTORE)
2310 .arg_param(&["snapshot
", "archive
-name
", "target
"])
2311 .completion_cb("repository
", complete_repository)
2312 .completion_cb("snapshot
", complete_group_or_snapshot)
2313 .completion_cb("archive
-name
", complete_archive_name)
2314 .completion_cb("target
", tools::complete_file_name);
2316 let files_cmd_def = CliCommand::new(&API_METHOD_LIST_SNAPSHOT_FILES)
2317 .arg_param(&["snapshot
"])
2318 .completion_cb("repository
", complete_repository)
2319 .completion_cb("snapshot
", complete_backup_snapshot);
2321 let prune_cmd_def = CliCommand::new(&API_METHOD_PRUNE)
2322 .arg_param(&["group
"])
2323 .completion_cb("group
", complete_backup_group)
2324 .completion_cb("repository
", complete_repository);
2326 let status_cmd_def = CliCommand::new(&API_METHOD_STATUS)
2327 .completion_cb("repository
", complete_repository);
2329 let login_cmd_def = CliCommand::new(&API_METHOD_API_LOGIN)
2330 .completion_cb("repository
", complete_repository);
2332 let logout_cmd_def = CliCommand::new(&API_METHOD_API_LOGOUT)
2333 .completion_cb("repository
", complete_repository);
2336 const API_METHOD_MOUNT: ApiMethod = ApiMethod::new(
2337 &ApiHandler::Sync(&mount),
2339 "Mount pxar archive
.",
2341 ("snapshot
", false, &StringSchema::new("Group
/Snapshot path
.").schema()),
2342 ("archive
-name
", false, &StringSchema::new("Backup archive name
.").schema()),
2343 ("target
", false, &StringSchema::new("Target directory path
.").schema()),
2344 ("repository
", true, &REPO_URL_SCHEMA),
2345 ("keyfile
", true, &StringSchema::new("Path to encryption key
.").schema()),
2346 ("verbose
", true, &BooleanSchema::new("Verbose output
.").default(false).schema()),
2351 let mount_cmd_def = CliCommand::new(&API_METHOD_MOUNT)
2352 .arg_param(&["snapshot
", "archive
-name
", "target
"])
2353 .completion_cb("repository
", complete_repository)
2354 .completion_cb("snapshot
", complete_group_or_snapshot)
2355 .completion_cb("archive
-name
", complete_pxar_archive_name)
2356 .completion_cb("target
", tools::complete_file_name);
2359 let cmd_def = CliCommandMap::new()
2360 .insert("backup
", backup_cmd_def)
2361 .insert("upload
-log
", upload_log_cmd_def)
2362 .insert("forget
", forget_cmd_def)
2363 .insert("garbage
-collect
", garbage_collect_cmd_def)
2364 .insert("list
", list_cmd_def)
2365 .insert("login
", login_cmd_def)
2366 .insert("logout
", logout_cmd_def)
2367 .insert("prune
", prune_cmd_def)
2368 .insert("restore
", restore_cmd_def)
2369 .insert("snapshots
", snapshots_cmd_def)
2370 .insert("files
", files_cmd_def)
2371 .insert("status
", status_cmd_def)
2372 .insert("key
", key_mgmt_cli())
2373 .insert("mount
", mount_cmd_def)
2374 .insert("catalog
", catalog_mgmt_cli())
2375 .insert("task
", task_mgmt_cli());
2377 proxmox_backup::tools::runtime::main(run_cli_command(cmd_def));