1 use std
::collections
::{HashSet, HashMap}
;
3 use std
::io
::{self, Write, Seek, SeekFrom}
;
4 use std
::os
::unix
::fs
::OpenOptionsExt
;
5 use std
::os
::unix
::io
::RawFd
;
6 use std
::path
::{Path, PathBuf}
;
8 use std
::sync
::{Arc, Mutex}
;
9 use std
::task
::{Context, Poll}
;
11 use anyhow
::{bail, format_err, Error}
;
12 use chrono
::{Local, DateTime, Utc, TimeZone}
;
13 use futures
::future
::FutureExt
;
15 use futures
::stream
::{StreamExt, TryStreamExt}
;
16 use nix
::unistd
::{fork, ForkResult, pipe}
;
17 use serde_json
::{json, Value}
;
18 use tokio
::signal
::unix
::{signal, SignalKind}
;
19 use tokio
::sync
::mpsc
;
20 use xdg
::BaseDirectories
;
22 use pathpatterns
::{MatchEntry, MatchType, PatternFlag}
;
23 use proxmox
::{sortable, identity}
;
24 use proxmox
::tools
::fs
::{file_get_contents, file_get_json, replace_file, CreateOptions, image_size}
;
25 use proxmox
::sys
::linux
::tty
;
26 use proxmox
::api
::{ApiHandler, ApiMethod, RpcEnvironment}
;
27 use proxmox
::api
::schema
::*;
28 use proxmox
::api
::cli
::*;
29 use proxmox
::api
::api
;
31 use proxmox_backup
::tools
;
32 use proxmox_backup
::api2
::types
::*;
33 use proxmox_backup
::client
::*;
34 use proxmox_backup
::backup
::*;
35 use proxmox_backup
::pxar
::catalog
::*;
37 const ENV_VAR_PBS_FINGERPRINT
: &str = "PBS_FINGERPRINT";
38 const ENV_VAR_PBS_PASSWORD
: &str = "PBS_PASSWORD";
41 const REPO_URL_SCHEMA
: Schema
= StringSchema
::new("Repository URL.")
42 .format(&BACKUP_REPO_URL
)
46 const KEYFILE_SCHEMA
: Schema
= StringSchema
::new(
47 "Path to encryption key. All data will be encrypted using this key.")
50 const CHUNK_SIZE_SCHEMA
: Schema
= IntegerSchema
::new(
51 "Chunk size in KB. Must be a power of 2.")
57 fn get_default_repository() -> Option
<String
> {
58 std
::env
::var("PBS_REPOSITORY").ok()
61 fn extract_repository_from_value(
63 ) -> Result
<BackupRepository
, Error
> {
65 let repo_url
= param
["repository"]
68 .or_else(get_default_repository
)
69 .ok_or_else(|| format_err
!("unable to get (default) repository"))?
;
71 let repo
: BackupRepository
= repo_url
.parse()?
;
76 fn extract_repository_from_map(
77 param
: &HashMap
<String
, String
>,
78 ) -> Option
<BackupRepository
> {
80 param
.get("repository")
82 .or_else(get_default_repository
)
83 .and_then(|repo_url
| repo_url
.parse
::<BackupRepository
>().ok())
86 fn record_repository(repo
: &BackupRepository
) {
88 let base
= match BaseDirectories
::with_prefix("proxmox-backup") {
93 // usually $HOME/.cache/proxmox-backup/repo-list
94 let path
= match base
.place_cache_file("repo-list") {
99 let mut data
= file_get_json(&path
, None
).unwrap_or_else(|_
| json
!({}
));
101 let repo
= repo
.to_string();
103 data
[&repo
] = json
!{ data[&repo].as_i64().unwrap_or(0) + 1 }
;
105 let mut map
= serde_json
::map
::Map
::new();
108 let mut max_used
= 0;
109 let mut max_repo
= None
;
110 for (repo
, count
) in data
.as_object().unwrap() {
111 if map
.contains_key(repo
) { continue; }
112 if let Some(count
) = count
.as_i64() {
113 if count
> max_used
{
115 max_repo
= Some(repo
);
119 if let Some(repo
) = max_repo
{
120 map
.insert(repo
.to_owned(), json
!(max_used
));
124 if map
.len() > 10 { // store max. 10 repos
129 let new_data
= json
!(map
);
131 let _
= replace_file(path
, new_data
.to_string().as_bytes(), CreateOptions
::new());
134 fn complete_repository(_arg
: &str, _param
: &HashMap
<String
, String
>) -> Vec
<String
> {
136 let mut result
= vec
![];
138 let base
= match BaseDirectories
::with_prefix("proxmox-backup") {
143 // usually $HOME/.cache/proxmox-backup/repo-list
144 let path
= match base
.place_cache_file("repo-list") {
149 let data
= file_get_json(&path
, None
).unwrap_or_else(|_
| json
!({}
));
151 if let Some(map
) = data
.as_object() {
152 for (repo
, _count
) in map
{
153 result
.push(repo
.to_owned());
160 fn connect(server
: &str, userid
: &str) -> Result
<HttpClient
, Error
> {
162 let fingerprint
= std
::env
::var(ENV_VAR_PBS_FINGERPRINT
).ok();
164 use std
::env
::VarError
::*;
165 let password
= match std
::env
::var(ENV_VAR_PBS_PASSWORD
) {
167 Err(NotUnicode(_
)) => bail
!(format
!("{} contains bad characters", ENV_VAR_PBS_PASSWORD
)),
168 Err(NotPresent
) => None
,
171 let options
= HttpClientOptions
::new()
172 .prefix(Some("proxmox-backup".to_string()))
175 .fingerprint(fingerprint
)
176 .fingerprint_cache(true)
179 HttpClient
::new(server
, userid
, options
)
182 async
fn view_task_result(
186 ) -> Result
<(), Error
> {
187 let data
= &result
["data"];
188 if output_format
== "text" {
189 if let Some(upid
) = data
.as_str() {
190 display_task_log(client
, upid
, true).await?
;
193 format_and_print_result(&data
, &output_format
);
199 async
fn api_datastore_list_snapshots(
202 group
: Option
<BackupGroup
>,
203 ) -> Result
<Value
, Error
> {
205 let path
= format
!("api2/json/admin/datastore/{}/snapshots", store
);
207 let mut args
= json
!({}
);
208 if let Some(group
) = group
{
209 args
["backup-type"] = group
.backup_type().into();
210 args
["backup-id"] = group
.backup_id().into();
213 let mut result
= client
.get(&path
, Some(args
)).await?
;
215 Ok(result
["data"].take())
218 async
fn api_datastore_latest_snapshot(
222 ) -> Result
<(String
, String
, DateTime
<Utc
>), Error
> {
224 let list
= api_datastore_list_snapshots(client
, store
, Some(group
.clone())).await?
;
225 let mut list
: Vec
<SnapshotListItem
> = serde_json
::from_value(list
)?
;
228 bail
!("backup group {:?} does not contain any snapshots.", group
.group_path());
231 list
.sort_unstable_by(|a
, b
| b
.backup_time
.cmp(&a
.backup_time
));
233 let backup_time
= Utc
.timestamp(list
[0].backup_time
, 0);
235 Ok((group
.backup_type().to_owned(), group
.backup_id().to_owned(), backup_time
))
239 async
fn backup_directory
<P
: AsRef
<Path
>>(
240 client
: &BackupWriter
,
243 chunk_size
: Option
<usize>,
244 device_set
: Option
<HashSet
<u64>>,
246 skip_lost_and_found
: bool
,
247 crypt_config
: Option
<Arc
<CryptConfig
>>,
248 catalog
: Arc
<Mutex
<CatalogWriter
<crate::tools
::StdChannelWriter
>>>,
249 exclude_pattern
: Vec
<MatchEntry
>,
251 ) -> Result
<BackupStats
, Error
> {
253 let pxar_stream
= PxarBackupStream
::open(
262 let mut chunk_stream
= ChunkStream
::new(pxar_stream
, chunk_size
);
264 let (mut tx
, rx
) = mpsc
::channel(10); // allow to buffer 10 chunks
267 .map_err(Error
::from
);
269 // spawn chunker inside a separate task so that it can run parallel
270 tokio
::spawn(async
move {
271 while let Some(v
) = chunk_stream
.next().await
{
272 let _
= tx
.send(v
).await
;
277 .upload_stream(archive_name
, stream
, "dynamic", None
, crypt_config
)
283 async
fn backup_image
<P
: AsRef
<Path
>>(
284 client
: &BackupWriter
,
288 chunk_size
: Option
<usize>,
290 crypt_config
: Option
<Arc
<CryptConfig
>>,
291 ) -> Result
<BackupStats
, Error
> {
293 let path
= image_path
.as_ref().to_owned();
295 let file
= tokio
::fs
::File
::open(path
).await?
;
297 let stream
= tokio_util
::codec
::FramedRead
::new(file
, tokio_util
::codec
::BytesCodec
::new())
298 .map_err(Error
::from
);
300 let stream
= FixedChunkStream
::new(stream
, chunk_size
.unwrap_or(4*1024*1024));
303 .upload_stream(archive_name
, stream
, "fixed", Some(image_size
), crypt_config
)
313 schema
: REPO_URL_SCHEMA
,
317 schema
: OUTPUT_FORMAT
,
323 /// List backup groups.
324 async
fn list_backup_groups(param
: Value
) -> Result
<Value
, Error
> {
326 let output_format
= get_output_format(¶m
);
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 let render_group_path
= |_v
: &Value
, record
: &Value
| -> Result
<String
, Error
> {
339 let item
: GroupListItem
= serde_json
::from_value(record
.to_owned())?
;
340 let group
= BackupGroup
::new(item
.backup_type
, item
.backup_id
);
341 Ok(group
.group_path().to_str().unwrap().to_owned())
344 let render_last_backup
= |_v
: &Value
, record
: &Value
| -> Result
<String
, Error
> {
345 let item
: GroupListItem
= serde_json
::from_value(record
.to_owned())?
;
346 let snapshot
= BackupDir
::new(item
.backup_type
, item
.backup_id
, item
.last_backup
);
347 Ok(snapshot
.relative_path().to_str().unwrap().to_owned())
350 let render_files
= |_v
: &Value
, record
: &Value
| -> Result
<String
, Error
> {
351 let item
: GroupListItem
= serde_json
::from_value(record
.to_owned())?
;
352 Ok(tools
::format
::render_backup_file_list(&item
.files
))
355 let options
= default_table_format_options()
356 .sortby("backup-type", false)
357 .sortby("backup-id", false)
358 .column(ColumnConfig
::new("backup-id").renderer(render_group_path
).header("group"))
360 ColumnConfig
::new("last-backup")
361 .renderer(render_last_backup
)
362 .header("last snapshot")
365 .column(ColumnConfig
::new("backup-count"))
366 .column(ColumnConfig
::new("files").renderer(render_files
));
368 let mut data
: Value
= result
["data"].take();
370 let info
= &proxmox_backup
::api2
::admin
::datastore
::API_RETURN_SCHEMA_LIST_GROUPS
;
372 format_and_print_result_full(&mut data
, info
, &output_format
, &options
);
381 schema
: REPO_URL_SCHEMA
,
386 description
: "Backup group.",
390 schema
: OUTPUT_FORMAT
,
396 /// List backup snapshots.
397 async
fn list_snapshots(param
: Value
) -> Result
<Value
, Error
> {
399 let repo
= extract_repository_from_value(¶m
)?
;
401 let output_format
= get_output_format(¶m
);
403 let client
= connect(repo
.host(), repo
.user())?
;
405 let group
= if let Some(path
) = param
["group"].as_str() {
406 Some(BackupGroup
::parse(path
)?
)
411 let mut data
= api_datastore_list_snapshots(&client
, repo
.store(), group
).await?
;
413 record_repository(&repo
);
415 let render_snapshot_path
= |_v
: &Value
, record
: &Value
| -> Result
<String
, Error
> {
416 let item
: SnapshotListItem
= serde_json
::from_value(record
.to_owned())?
;
417 let snapshot
= BackupDir
::new(item
.backup_type
, item
.backup_id
, item
.backup_time
);
418 Ok(snapshot
.relative_path().to_str().unwrap().to_owned())
421 let render_files
= |_v
: &Value
, record
: &Value
| -> Result
<String
, Error
> {
422 let item
: SnapshotListItem
= serde_json
::from_value(record
.to_owned())?
;
423 Ok(tools
::format
::render_backup_file_list(&item
.files
))
426 let options
= default_table_format_options()
427 .sortby("backup-type", false)
428 .sortby("backup-id", false)
429 .sortby("backup-time", false)
430 .column(ColumnConfig
::new("backup-id").renderer(render_snapshot_path
).header("snapshot"))
431 .column(ColumnConfig
::new("size"))
432 .column(ColumnConfig
::new("files").renderer(render_files
))
435 let info
= &proxmox_backup
::api2
::admin
::datastore
::API_RETURN_SCHEMA_LIST_SNAPSHOTS
;
437 format_and_print_result_full(&mut data
, info
, &output_format
, &options
);
446 schema
: REPO_URL_SCHEMA
,
451 description
: "Snapshot path.",
456 /// Forget (remove) backup snapshots.
457 async
fn forget_snapshots(param
: Value
) -> Result
<Value
, Error
> {
459 let repo
= extract_repository_from_value(¶m
)?
;
461 let path
= tools
::required_string_param(¶m
, "snapshot")?
;
462 let snapshot
= BackupDir
::parse(path
)?
;
464 let mut client
= connect(repo
.host(), repo
.user())?
;
466 let path
= format
!("api2/json/admin/datastore/{}/snapshots", repo
.store());
468 let result
= client
.delete(&path
, Some(json
!({
469 "backup-type": snapshot
.group().backup_type(),
470 "backup-id": snapshot
.group().backup_id(),
471 "backup-time": snapshot
.backup_time().timestamp(),
474 record_repository(&repo
);
483 schema
: REPO_URL_SCHEMA
,
489 /// Try to login. If successful, store ticket.
490 async
fn api_login(param
: Value
) -> Result
<Value
, Error
> {
492 let repo
= extract_repository_from_value(¶m
)?
;
494 let client
= connect(repo
.host(), repo
.user())?
;
495 client
.login().await?
;
497 record_repository(&repo
);
506 schema
: REPO_URL_SCHEMA
,
512 /// Logout (delete stored ticket).
513 fn api_logout(param
: Value
) -> Result
<Value
, Error
> {
515 let repo
= extract_repository_from_value(¶m
)?
;
517 delete_ticket_info("proxmox-backup", repo
.host(), repo
.user())?
;
526 schema
: REPO_URL_SCHEMA
,
531 description
: "Snapshot path.",
537 async
fn dump_catalog(param
: Value
) -> Result
<Value
, Error
> {
539 let repo
= extract_repository_from_value(¶m
)?
;
541 let path
= tools
::required_string_param(¶m
, "snapshot")?
;
542 let snapshot
= BackupDir
::parse(path
)?
;
544 let keyfile
= param
["keyfile"].as_str().map(PathBuf
::from
);
546 let crypt_config
= match keyfile
{
549 let (key
, _
) = load_and_decrypt_key(&path
, &get_encryption_key_password
)?
;
550 Some(Arc
::new(CryptConfig
::new(key
)?
))
554 let client
= connect(repo
.host(), repo
.user())?
;
556 let client
= BackupReader
::start(
558 crypt_config
.clone(),
560 &snapshot
.group().backup_type(),
561 &snapshot
.group().backup_id(),
562 snapshot
.backup_time(),
566 let manifest
= client
.download_manifest().await?
;
568 let index
= client
.download_dynamic_index(&manifest
, CATALOG_NAME
).await?
;
570 let most_used
= index
.find_most_used_chunks(8);
572 let chunk_reader
= RemoteChunkReader
::new(client
.clone(), crypt_config
, most_used
);
574 let mut reader
= BufferedDynamicReader
::new(index
, chunk_reader
);
576 let mut catalogfile
= std
::fs
::OpenOptions
::new()
579 .custom_flags(libc
::O_TMPFILE
)
582 std
::io
::copy(&mut reader
, &mut catalogfile
)
583 .map_err(|err
| format_err
!("unable to download catalog - {}", err
))?
;
585 catalogfile
.seek(SeekFrom
::Start(0))?
;
587 let mut catalog_reader
= CatalogReader
::new(catalogfile
);
589 catalog_reader
.dump()?
;
591 record_repository(&repo
);
600 schema
: REPO_URL_SCHEMA
,
605 description
: "Snapshot path.",
608 schema
: OUTPUT_FORMAT
,
614 /// List snapshot files.
615 async
fn list_snapshot_files(param
: Value
) -> Result
<Value
, Error
> {
617 let repo
= extract_repository_from_value(¶m
)?
;
619 let path
= tools
::required_string_param(¶m
, "snapshot")?
;
620 let snapshot
= BackupDir
::parse(path
)?
;
622 let output_format
= get_output_format(¶m
);
624 let client
= connect(repo
.host(), repo
.user())?
;
626 let path
= format
!("api2/json/admin/datastore/{}/files", repo
.store());
628 let mut result
= client
.get(&path
, Some(json
!({
629 "backup-type": snapshot
.group().backup_type(),
630 "backup-id": snapshot
.group().backup_id(),
631 "backup-time": snapshot
.backup_time().timestamp(),
634 record_repository(&repo
);
636 let info
= &proxmox_backup
::api2
::admin
::datastore
::API_RETURN_SCHEMA_LIST_SNAPSHOT_FILES
;
638 let mut data
: Value
= result
["data"].take();
640 let options
= default_table_format_options();
642 format_and_print_result_full(&mut data
, info
, &output_format
, &options
);
651 schema
: REPO_URL_SCHEMA
,
655 schema
: OUTPUT_FORMAT
,
661 /// Start garbage collection for a specific repository.
662 async
fn start_garbage_collection(param
: Value
) -> Result
<Value
, Error
> {
664 let repo
= extract_repository_from_value(¶m
)?
;
666 let output_format
= get_output_format(¶m
);
668 let mut client
= connect(repo
.host(), repo
.user())?
;
670 let path
= format
!("api2/json/admin/datastore/{}/gc", repo
.store());
672 let result
= client
.post(&path
, None
).await?
;
674 record_repository(&repo
);
676 view_task_result(client
, result
, &output_format
).await?
;
681 fn spawn_catalog_upload(
682 client
: Arc
<BackupWriter
>,
683 crypt_config
: Option
<Arc
<CryptConfig
>>,
686 Arc
<Mutex
<CatalogWriter
<crate::tools
::StdChannelWriter
>>>,
687 tokio
::sync
::oneshot
::Receiver
<Result
<BackupStats
, Error
>>
690 let (catalog_tx
, catalog_rx
) = std
::sync
::mpsc
::sync_channel(10); // allow to buffer 10 writes
691 let catalog_stream
= crate::tools
::StdChannelStream(catalog_rx
);
692 let catalog_chunk_size
= 512*1024;
693 let catalog_chunk_stream
= ChunkStream
::new(catalog_stream
, Some(catalog_chunk_size
));
695 let catalog
= Arc
::new(Mutex
::new(CatalogWriter
::new(crate::tools
::StdChannelWriter
::new(catalog_tx
))?
));
697 let (catalog_result_tx
, catalog_result_rx
) = tokio
::sync
::oneshot
::channel();
699 tokio
::spawn(async
move {
700 let catalog_upload_result
= client
701 .upload_stream(CATALOG_NAME
, catalog_chunk_stream
, "dynamic", None
, crypt_config
)
704 if let Err(ref err
) = catalog_upload_result
{
705 eprintln
!("catalog upload error - {}", err
);
709 let _
= catalog_result_tx
.send(catalog_upload_result
);
712 Ok((catalog
, catalog_result_rx
))
720 description
: "List of backup source specifications ([<label.ext>:<path>] ...)",
722 schema
: BACKUP_SOURCE_SCHEMA
,
726 schema
: REPO_URL_SCHEMA
,
730 description
: "Include mountpoints with same st_dev number (see ``man fstat``) as specified files.",
734 description
: "Path to file.",
738 schema
: KEYFILE_SCHEMA
,
741 "skip-lost-and-found": {
743 description
: "Skip lost+found directory.",
747 schema
: BACKUP_TYPE_SCHEMA
,
751 schema
: BACKUP_ID_SCHEMA
,
755 schema
: BACKUP_TIME_SCHEMA
,
759 schema
: CHUNK_SIZE_SCHEMA
,
764 description
: "List of paths or patterns for matching files to exclude.",
768 description
: "Path or match pattern.",
773 description
: "Max number of entries to hold in memory.",
775 default: proxmox_backup
::pxar
::ENCODER_MAX_ENTRIES
as isize,
779 description
: "Verbose output.",
785 /// Create (host) backup.
786 async
fn create_backup(
789 _rpcenv
: &mut dyn RpcEnvironment
,
790 ) -> Result
<Value
, Error
> {
792 let repo
= extract_repository_from_value(¶m
)?
;
794 let backupspec_list
= tools
::required_array_param(¶m
, "backupspec")?
;
796 let all_file_systems
= param
["all-file-systems"].as_bool().unwrap_or(false);
798 let skip_lost_and_found
= param
["skip-lost-and-found"].as_bool().unwrap_or(false);
800 let verbose
= param
["verbose"].as_bool().unwrap_or(false);
802 let backup_time_opt
= param
["backup-time"].as_i64();
804 let chunk_size_opt
= param
["chunk-size"].as_u64().map(|v
| (v
*1024) as usize);
806 if let Some(size
) = chunk_size_opt
{
807 verify_chunk_size(size
)?
;
810 let keyfile
= param
["keyfile"].as_str().map(PathBuf
::from
);
812 let backup_id
= param
["backup-id"].as_str().unwrap_or(&proxmox
::tools
::nodename());
814 let backup_type
= param
["backup-type"].as_str().unwrap_or("host");
816 let include_dev
= param
["include-dev"].as_array();
818 let entries_max
= param
["entries-max"].as_u64()
819 .unwrap_or(proxmox_backup
::pxar
::ENCODER_MAX_ENTRIES
as u64);
821 let empty
= Vec
::new();
822 let exclude_args
= param
["exclude"].as_array().unwrap_or(&empty
);
824 let mut exclude_list
= Vec
::with_capacity(exclude_args
.len());
825 for entry
in exclude_args
{
826 let entry
= entry
.as_str().ok_or_else(|| format_err
!("Invalid pattern string slice"))?
;
828 MatchEntry
::parse_pattern(entry
, PatternFlag
::PATH_NAME
, MatchType
::Exclude
)
829 .map_err(|err
| format_err
!("invalid exclude pattern entry: {}", err
))?
833 let mut devices
= if all_file_systems { None }
else { Some(HashSet::new()) }
;
835 if let Some(include_dev
) = include_dev
{
836 if all_file_systems
{
837 bail
!("option 'all-file-systems' conflicts with option 'include-dev'");
840 let mut set
= HashSet
::new();
841 for path
in include_dev
{
842 let path
= path
.as_str().unwrap();
843 let stat
= nix
::sys
::stat
::stat(path
)
844 .map_err(|err
| format_err
!("fstat {:?} failed - {}", path
, err
))?
;
845 set
.insert(stat
.st_dev
);
850 let mut upload_list
= vec
![];
852 let mut upload_catalog
= false;
854 for backupspec
in backupspec_list
{
855 let spec
= parse_backup_specification(backupspec
.as_str().unwrap())?
;
856 let filename
= &spec
.config_string
;
857 let target
= &spec
.archive_name
;
859 use std
::os
::unix
::fs
::FileTypeExt
;
861 let metadata
= std
::fs
::metadata(filename
)
862 .map_err(|err
| format_err
!("unable to access '{}' - {}", filename
, err
))?
;
863 let file_type
= metadata
.file_type();
865 match spec
.spec_type
{
866 BackupSpecificationType
::PXAR
=> {
867 if !file_type
.is_dir() {
868 bail
!("got unexpected file type (expected directory)");
870 upload_list
.push((BackupSpecificationType
::PXAR
, filename
.to_owned(), format
!("{}.didx", target
), 0));
871 upload_catalog
= true;
873 BackupSpecificationType
::IMAGE
=> {
874 if !(file_type
.is_file() || file_type
.is_block_device()) {
875 bail
!("got unexpected file type (expected file or block device)");
878 let size
= image_size(&PathBuf
::from(filename
))?
;
880 if size
== 0 { bail!("got zero-sized file '{}'
", filename); }
882 upload_list.push((BackupSpecificationType::IMAGE, filename.to_owned(), format!("{}
.fidx
", target), size));
884 BackupSpecificationType::CONFIG => {
885 if !file_type.is_file() {
886 bail!("got unexpected file
type (expected regular file
)");
888 upload_list.push((BackupSpecificationType::CONFIG, filename.to_owned(), format!("{}
.blob
", target), metadata.len()));
890 BackupSpecificationType::LOGFILE => {
891 if !file_type.is_file() {
892 bail!("got unexpected file
type (expected regular file
)");
894 upload_list.push((BackupSpecificationType::LOGFILE, filename.to_owned(), format!("{}
.blob
", target), metadata.len()));
899 let backup_time = Utc.timestamp(backup_time_opt.unwrap_or_else(|| Utc::now().timestamp()), 0);
901 let client = connect(repo.host(), repo.user())?;
902 record_repository(&repo);
904 println!("Starting backup
: {}
/{}
/{}
", backup_type, backup_id, BackupDir::backup_time_to_string(backup_time));
906 println!("Client name
: {}
", proxmox::tools::nodename());
908 let start_time = Local::now();
910 println!("Starting protocol
: {}
", start_time.to_rfc3339_opts(chrono::SecondsFormat::Secs, false));
912 let (crypt_config, rsa_encrypted_key) = match keyfile {
913 None => (None, None),
915 let (key, created) = load_and_decrypt_key(&path, &get_encryption_key_password)?;
917 let crypt_config = CryptConfig::new(key)?;
919 let path = master_pubkey_path()?;
921 let pem_data = file_get_contents(&path)?;
922 let rsa = openssl::rsa::Rsa::public_key_from_pem(&pem_data)?;
923 let enc_key = crypt_config.generate_rsa_encoded_key(rsa, created)?;
924 (Some(Arc::new(crypt_config)), Some(enc_key))
926 (Some(Arc::new(crypt_config)), None)
931 let client = BackupWriter::start(
940 let snapshot = BackupDir::new(backup_type, backup_id, backup_time.timestamp());
941 let mut manifest = BackupManifest::new(snapshot);
943 let (catalog, catalog_result_rx) = spawn_catalog_upload(client.clone(), crypt_config.clone())?;
945 for (backup_type, filename, target, size) in upload_list {
947 BackupSpecificationType::CONFIG => {
948 println!("Upload config file '{}' to '{:?}'
as {}
", filename, repo, target);
950 .upload_blob_from_file(&filename, &target, crypt_config.clone(), true)
952 manifest.add_file(target, stats.size, stats.csum)?;
954 BackupSpecificationType::LOGFILE => { // fixme: remove - not needed anymore ?
955 println!("Upload log file '{}' to '{:?}'
as {}
", filename, repo, target);
957 .upload_blob_from_file(&filename, &target, crypt_config.clone(), true)
959 manifest.add_file(target, stats.size, stats.csum)?;
961 BackupSpecificationType::PXAR => {
962 println!("Upload directory '{}' to '{:?}'
as {}
", filename, repo, target);
963 catalog.lock().unwrap().start_directory(std::ffi::CString::new(target.as_str())?.as_c_str())?;
964 let stats = backup_directory(
972 crypt_config.clone(),
974 exclude_list.clone(),
975 entries_max as usize,
977 manifest.add_file(target, stats.size, stats.csum)?;
978 catalog.lock().unwrap().end_directory()?;
980 BackupSpecificationType::IMAGE => {
981 println!("Upload image '{}' to '{:?}'
as {}
", filename, repo, target);
982 let stats = backup_image(
989 crypt_config.clone(),
991 manifest.add_file(target, stats.size, stats.csum)?;
996 // finalize and upload catalog
998 let mutex = Arc::try_unwrap(catalog)
999 .map_err(|_| format_err!("unable to get
catalog (still used
)"))?;
1000 let mut catalog = mutex.into_inner().unwrap();
1004 drop(catalog); // close upload stream
1006 let stats = catalog_result_rx.await??;
1008 manifest.add_file(CATALOG_NAME.to_owned(), stats.size, stats.csum)?;
1011 if let Some(rsa_encrypted_key) = rsa_encrypted_key {
1012 let target = "rsa
-encrypted
.key
";
1013 println!("Upload RSA encoded key to '{:?}'
as {}
", repo, target);
1015 .upload_blob_from_data(rsa_encrypted_key, target, None, false, false)
1017 manifest.add_file(format!("{}
.blob
", target), stats.size, stats.csum)?;
1019 // openssl rsautl -decrypt -inkey master-private.pem -in rsa-encrypted.key -out t
1021 let mut buffer2 = vec![0u8; rsa.size() as usize];
1022 let pem_data = file_get_contents("master
-private
.pem
")?;
1023 let rsa = openssl::rsa::Rsa::private_key_from_pem(&pem_data)?;
1024 let len = rsa.private_decrypt(&buffer, &mut buffer2, openssl::rsa::Padding::PKCS1)?;
1025 println!("TEST {} {:?}
", len, buffer2);
1029 // create manifest (index.json)
1030 let manifest = manifest.into_json();
1032 println!("Upload index
.json to '{:?}'
", repo);
1033 let manifest = serde_json::to_string_pretty(&manifest)?.into();
1035 .upload_blob_from_data(manifest, MANIFEST_BLOB_NAME, crypt_config.clone(), true, true)
1038 client.finish().await?;
1040 let end_time = Local::now();
1041 let elapsed = end_time.signed_duration_since(start_time);
1042 println!("Duration
: {}
", elapsed);
1044 println!("End Time
: {}
", end_time.to_rfc3339_opts(chrono::SecondsFormat::Secs, false));
1049 fn complete_backup_source(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1051 let mut result = vec![];
1053 let data: Vec<&str> = arg.splitn(2, ':').collect();
1055 if data.len() != 2 {
1056 result.push(String::from("root
.pxar
:/"));
1057 result.push(String::from("etc
.pxar
:/etc
"));
1061 let files = tools::complete_file_name(data[1], param);
1064 result.push(format!("{}
:{}
", data[0], file));
1070 fn dump_image<W: Write>(
1071 client: Arc<BackupReader>,
1072 crypt_config: Option<Arc<CryptConfig>>,
1073 index: FixedIndexReader,
1076 ) -> Result<(), Error> {
1078 let most_used = index.find_most_used_chunks(8);
1080 let mut chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, most_used);
1082 // Note: we avoid using BufferedFixedReader, because that add an additional buffer/copy
1083 // and thus slows down reading. Instead, directly use RemoteChunkReader
1086 let start_time = std::time::Instant::now();
1088 for pos in 0..index.index_count() {
1089 let digest = index.index_digest(pos).unwrap();
1090 let raw_data = chunk_reader.read_chunk(&digest)?;
1091 writer.write_all(&raw_data)?;
1092 bytes += raw_data.len();
1094 let next_per = ((pos+1)*100)/index.index_count();
1095 if per != next_per {
1096 eprintln!("progress {}
% (read {} bytes
, duration {} sec
)",
1097 next_per, bytes, start_time.elapsed().as_secs());
1103 let end_time = std::time::Instant::now();
1104 let elapsed = end_time.duration_since(start_time);
1105 eprintln!("restore image
complete (bytes
={}
, duration
={:.2}s
, speed
={:.2}MB
/s
)",
1107 elapsed.as_secs_f64(),
1108 bytes as f64/(1024.0*1024.0*elapsed.as_secs_f64())
1115 fn parse_archive_type(name: &str) -> (String, ArchiveType) {
1116 if name.ends_with(".didx
") || name.ends_with(".fidx
") || name.ends_with(".blob
") {
1117 (name.into(), archive_type(name).unwrap())
1118 } else if name.ends_with(".pxar
") {
1119 (format!("{}
.didx
", name), ArchiveType::DynamicIndex)
1120 } else if name.ends_with(".img
") {
1121 (format!("{}
.fidx
", name), ArchiveType::FixedIndex)
1123 (format!("{}
.blob
", name), ArchiveType::Blob)
1131 schema: REPO_URL_SCHEMA,
1136 description: "Group
/Snapshot path
.",
1139 description: "Backup archive name
.",
1144 description: r###"Target directory path
. Use '
-' to write to standard output
.
1146 We
do not extraxt '
.pxar' archives when writing to standard output
.
1150 "allow
-existing
-dirs
": {
1152 description: "Do not fail
if directories already exists
.",
1156 schema: KEYFILE_SCHEMA,
1162 /// Restore backup repository.
1163 async fn restore(param: Value) -> Result<Value, Error> {
1164 let repo = extract_repository_from_value(¶m)?;
1166 let verbose = param["verbose
"].as_bool().unwrap_or(false);
1168 let allow_existing_dirs = param["allow
-existing
-dirs
"].as_bool().unwrap_or(false);
1170 let archive_name = tools::required_string_param(¶m, "archive
-name
")?;
1172 let client = connect(repo.host(), repo.user())?;
1174 record_repository(&repo);
1176 let path = tools::required_string_param(¶m, "snapshot
")?;
1178 let (backup_type, backup_id, backup_time) = if path.matches('/').count() == 1 {
1179 let group = BackupGroup::parse(path)?;
1180 api_datastore_latest_snapshot(&client, repo.store(), group).await?
1182 let snapshot = BackupDir::parse(path)?;
1183 (snapshot.group().backup_type().to_owned(), snapshot.group().backup_id().to_owned(), snapshot.backup_time())
1186 let target = tools::required_string_param(¶m, "target
")?;
1187 let target = if target == "-" { None } else { Some(target) };
1189 let keyfile = param["keyfile
"].as_str().map(PathBuf::from);
1191 let crypt_config = match keyfile {
1194 let (key, _) = load_and_decrypt_key(&path, &get_encryption_key_password)?;
1195 Some(Arc::new(CryptConfig::new(key)?))
1199 let client = BackupReader::start(
1201 crypt_config.clone(),
1209 let manifest = client.download_manifest().await?;
1211 let (archive_name, archive_type) = parse_archive_type(archive_name);
1213 if archive_name == MANIFEST_BLOB_NAME {
1214 let backup_index_data = manifest.into_json().to_string();
1215 if let Some(target) = target {
1216 replace_file(target, backup_index_data.as_bytes(), CreateOptions::new())?;
1218 let stdout = std::io::stdout();
1219 let mut writer = stdout.lock();
1220 writer.write_all(backup_index_data.as_bytes())
1221 .map_err(|err| format_err!("unable to pipe data
- {}
", err))?;
1224 } else if archive_type == ArchiveType::Blob {
1226 let mut reader = client.download_blob(&manifest, &archive_name).await?;
1228 if let Some(target) = target {
1229 let mut writer = std::fs::OpenOptions::new()
1234 .map_err(|err| format_err!("unable to create target file {:?}
- {}
", target, err))?;
1235 std::io::copy(&mut reader, &mut writer)?;
1237 let stdout = std::io::stdout();
1238 let mut writer = stdout.lock();
1239 std::io::copy(&mut reader, &mut writer)
1240 .map_err(|err| format_err!("unable to pipe data
- {}
", err))?;
1243 } else if archive_type == ArchiveType::DynamicIndex {
1245 let index = client.download_dynamic_index(&manifest, &archive_name).await?;
1247 let most_used = index.find_most_used_chunks(8);
1249 let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, most_used);
1251 let mut reader = BufferedDynamicReader::new(index, chunk_reader);
1253 if let Some(target) = target {
1254 proxmox_backup::pxar::extract_archive(
1255 pxar::decoder::Decoder::from_std(reader)?,
1258 proxmox_backup::pxar::flags::DEFAULT,
1259 allow_existing_dirs,
1262 println!("{:?}
", path);
1266 .map_err(|err| format_err!("error extracting archive
- {}
", err))?;
1268 let mut writer = std::fs::OpenOptions::new()
1270 .open("/dev
/stdout
")
1271 .map_err(|err| format_err!("unable to open
/dev
/stdout
- {}
", err))?;
1273 std::io::copy(&mut reader, &mut writer)
1274 .map_err(|err| format_err!("unable to pipe data
- {}
", err))?;
1276 } else if archive_type == ArchiveType::FixedIndex {
1278 let index = client.download_fixed_index(&manifest, &archive_name).await?;
1280 let mut writer = if let Some(target) = target {
1281 std::fs::OpenOptions::new()
1286 .map_err(|err| format_err!("unable to create target file {:?}
- {}
", target, err))?
1288 std::fs::OpenOptions::new()
1290 .open("/dev
/stdout
")
1291 .map_err(|err| format_err!("unable to open
/dev
/stdout
- {}
", err))?
1294 dump_image(client.clone(), crypt_config.clone(), index, &mut writer, verbose)?;
1304 schema: REPO_URL_SCHEMA,
1309 description: "Group
/Snapshot path
.",
1313 description: "The path to the log file you want to upload
.",
1316 schema: KEYFILE_SCHEMA,
1322 /// Upload backup log file.
1323 async fn upload_log(param: Value) -> Result<Value, Error> {
1325 let logfile = tools::required_string_param(¶m, "logfile
")?;
1326 let repo = extract_repository_from_value(¶m)?;
1328 let snapshot = tools::required_string_param(¶m, "snapshot
")?;
1329 let snapshot = BackupDir::parse(snapshot)?;
1331 let mut client = connect(repo.host(), repo.user())?;
1333 let keyfile = param["keyfile
"].as_str().map(PathBuf::from);
1335 let crypt_config = match keyfile {
1338 let (key, _created) = load_and_decrypt_key(&path, &get_encryption_key_password)?;
1339 let crypt_config = CryptConfig::new(key)?;
1340 Some(Arc::new(crypt_config))
1344 let data = file_get_contents(logfile)?;
1346 let blob = DataBlob::encode(&data, crypt_config.as_ref().map(Arc::as_ref), true)?;
1348 let raw_data = blob.into_inner();
1350 let path = format!("api2
/json
/admin
/datastore
/{}
/upload
-backup
-log
", repo.store());
1353 "backup
-type": snapshot.group().backup_type(),
1354 "backup
-id
": snapshot.group().backup_id(),
1355 "backup
-time
": snapshot.backup_time().timestamp(),
1358 let body = hyper::Body::from(raw_data);
1360 client.upload("application
/octet
-stream
", body, &path, Some(args)).await
1363 const API_METHOD_PRUNE: ApiMethod = ApiMethod::new(
1364 &ApiHandler::Async(&prune),
1366 "Prune a backup repository
.",
1367 &proxmox_backup::add_common_prune_prameters!([
1368 ("dry
-run
", true, &BooleanSchema::new(
1369 "Just show what prune would
do, but
do not delete anything
.")
1371 ("group
", false, &StringSchema::new("Backup group
.").schema()),
1373 ("output
-format
", true, &OUTPUT_FORMAT),
1377 &BooleanSchema::new("Minimal output
- only show removals
.")
1380 ("repository
", true, &REPO_URL_SCHEMA),
1388 _rpcenv: &'a mut dyn RpcEnvironment,
1389 ) -> proxmox::api::ApiFuture<'a> {
1391 prune_async(param).await
1395 async fn prune_async(mut param: Value) -> Result<Value, Error> {
1396 let repo = extract_repository_from_value(¶m)?;
1398 let mut client = connect(repo.host(), repo.user())?;
1400 let path = format!("api2
/json
/admin
/datastore
/{}
/prune
", repo.store());
1402 let group = tools::required_string_param(¶m, "group
")?;
1403 let group = BackupGroup::parse(group)?;
1405 let output_format = get_output_format(¶m);
1407 let quiet = param["quiet
"].as_bool().unwrap_or(false);
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
");
1412 param.as_object_mut().unwrap().remove("quiet
");
1414 param["backup
-type"] = group.backup_type().into();
1415 param["backup
-id
"] = group.backup_id().into();
1417 let mut result = client.post(&path, Some(param)).await?;
1419 record_repository(&repo);
1421 let render_snapshot_path = |_v: &Value, record: &Value| -> Result<String, Error> {
1422 let item: PruneListItem = serde_json::from_value(record.to_owned())?;
1423 let snapshot = BackupDir::new(item.backup_type, item.backup_id, item.backup_time);
1424 Ok(snapshot.relative_path().to_str().unwrap().to_owned())
1427 let render_prune_action = |v: &Value, _record: &Value| -> Result<String, Error> {
1428 Ok(match v.as_bool() {
1429 Some(true) => "keep
",
1430 Some(false) => "remove
",
1435 let options = default_table_format_options()
1436 .sortby("backup
-type", false)
1437 .sortby("backup
-id
", false)
1438 .sortby("backup
-time
", false)
1439 .column(ColumnConfig::new("backup
-id
").renderer(render_snapshot_path).header("snapshot
"))
1440 .column(ColumnConfig::new("backup
-time
").renderer(tools::format::render_epoch).header("date
"))
1441 .column(ColumnConfig::new("keep
").renderer(render_prune_action).header("action
"))
1444 let info = &proxmox_backup::api2::admin::datastore::API_RETURN_SCHEMA_PRUNE;
1446 let mut data = result["data
"].take();
1449 let list: Vec<Value> = data.as_array().unwrap().iter().filter(|item| {
1450 item["keep
"].as_bool() == Some(false)
1451 }).map(|v| v.clone()).collect();
1455 format_and_print_result_full(&mut data, info, &output_format, &options);
1464 schema: REPO_URL_SCHEMA,
1468 schema: OUTPUT_FORMAT,
1474 /// Get repository status.
1475 async fn status(param: Value) -> Result<Value, Error> {
1477 let repo = extract_repository_from_value(¶m)?;
1479 let output_format = get_output_format(¶m);
1481 let client = connect(repo.host(), repo.user())?;
1483 let path = format!("api2
/json
/admin
/datastore
/{}
/status
", repo.store());
1485 let mut result = client.get(&path, None).await?;
1486 let mut data = result["data
"].take();
1488 record_repository(&repo);
1490 let render_total_percentage = |v: &Value, record: &Value| -> Result<String, Error> {
1491 let v = v.as_u64().unwrap();
1492 let total = record["total
"].as_u64().unwrap();
1493 let roundup = total/200;
1494 let per = ((v+roundup)*100)/total;
1495 let info = format!(" ({}
%)", per);
1496 Ok(format!("{} {:>8}
", v, info))
1499 let options = default_table_format_options()
1501 .column(ColumnConfig::new("total
").renderer(render_total_percentage))
1502 .column(ColumnConfig::new("used
").renderer(render_total_percentage))
1503 .column(ColumnConfig::new("avail
").renderer(render_total_percentage));
1505 let schema = &proxmox_backup::api2::admin::datastore::API_RETURN_SCHEMA_STATUS;
1507 format_and_print_result_full(&mut data, schema, &output_format, &options);
1512 // like get, but simply ignore errors and return Null instead
1513 async fn try_get(repo: &BackupRepository, url: &str) -> Value {
1515 let fingerprint = std::env::var(ENV_VAR_PBS_FINGERPRINT).ok();
1516 let password = std::env::var(ENV_VAR_PBS_PASSWORD).ok();
1518 let options = HttpClientOptions::new()
1519 .prefix(Some("proxmox
-backup
".to_string()))
1522 .fingerprint(fingerprint)
1523 .fingerprint_cache(true)
1524 .ticket_cache(true);
1526 let client = match HttpClient::new(repo.host(), repo.user(), options) {
1528 _ => return Value::Null,
1531 let mut resp = match client.get(url, None).await {
1533 _ => return Value::Null,
1536 if let Some(map) = resp.as_object_mut() {
1537 if let Some(data) = map.remove("data
") {
1544 fn complete_backup_group(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1545 proxmox_backup::tools::runtime::main(async { complete_backup_group_do(param).await })
1548 async fn complete_backup_group_do(param: &HashMap<String, String>) -> Vec<String> {
1550 let mut result = vec![];
1552 let repo = match extract_repository_from_map(param) {
1557 let path = format!("api2
/json
/admin
/datastore
/{}
/groups
", repo.store());
1559 let data = try_get(&repo, &path).await;
1561 if let Some(list) = data.as_array() {
1563 if let (Some(backup_id), Some(backup_type)) =
1564 (item["backup
-id
"].as_str(), item["backup
-type"].as_str())
1566 result.push(format!("{}
/{}
", backup_type, backup_id));
1574 fn complete_group_or_snapshot(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1575 proxmox_backup::tools::runtime::main(async { complete_group_or_snapshot_do(arg, param).await })
1578 async fn complete_group_or_snapshot_do(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1580 if arg.matches('/').count() < 2 {
1581 let groups = complete_backup_group_do(param).await;
1582 let mut result = vec![];
1583 for group in groups {
1584 result.push(group.to_string());
1585 result.push(format!("{}
/", group));
1590 complete_backup_snapshot_do(param).await
1593 fn complete_backup_snapshot(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1594 proxmox_backup::tools::runtime::main(async { complete_backup_snapshot_do(param).await })
1597 async fn complete_backup_snapshot_do(param: &HashMap<String, String>) -> Vec<String> {
1599 let mut result = vec![];
1601 let repo = match extract_repository_from_map(param) {
1606 let path = format!("api2
/json
/admin
/datastore
/{}
/snapshots
", repo.store());
1608 let data = try_get(&repo, &path).await;
1610 if let Some(list) = data.as_array() {
1612 if let (Some(backup_id), Some(backup_type), Some(backup_time)) =
1613 (item["backup
-id
"].as_str(), item["backup
-type"].as_str(), item["backup
-time
"].as_i64())
1615 let snapshot = BackupDir::new(backup_type, backup_id, backup_time);
1616 result.push(snapshot.relative_path().to_str().unwrap().to_owned());
1624 fn complete_server_file_name(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1625 proxmox_backup::tools::runtime::main(async { complete_server_file_name_do(param).await })
1628 async fn complete_server_file_name_do(param: &HashMap<String, String>) -> Vec<String> {
1630 let mut result = vec![];
1632 let repo = match extract_repository_from_map(param) {
1637 let snapshot = match param.get("snapshot
") {
1639 match BackupDir::parse(path) {
1647 let query = tools::json_object_to_query(json!({
1648 "backup
-type": snapshot.group().backup_type(),
1649 "backup
-id
": snapshot.group().backup_id(),
1650 "backup
-time
": snapshot.backup_time().timestamp(),
1653 let path = format!("api2
/json
/admin
/datastore
/{}
/files?{}
", repo.store(), query);
1655 let data = try_get(&repo, &path).await;
1657 if let Some(list) = data.as_array() {
1659 if let Some(filename) = item["filename
"].as_str() {
1660 result.push(filename.to_owned());
1668 fn complete_archive_name(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1669 complete_server_file_name(arg, param)
1671 .map(|v| tools::format::strip_server_file_expenstion(&v))
1675 fn complete_pxar_archive_name(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1676 complete_server_file_name(arg, param)
1679 let name = tools::format::strip_server_file_expenstion(&v);
1680 if name.ends_with(".pxar
") {
1689 fn complete_chunk_size(_arg: &str, _param: &HashMap<String, String>) -> Vec<String> {
1691 let mut result = vec![];
1695 result.push(size.to_string());
1697 if size > 4096 { break; }
1703 fn get_encryption_key_password() -> Result<Vec<u8>, Error> {
1705 // fixme: implement other input methods
1707 use std::env::VarError::*;
1708 match std::env::var("PBS_ENCRYPTION_PASSWORD
") {
1709 Ok(p) => return Ok(p.as_bytes().to_vec()),
1710 Err(NotUnicode(_)) => bail!("PBS_ENCRYPTION_PASSWORD contains bad characters
"),
1711 Err(NotPresent) => {
1712 // Try another method
1716 // If we're on a TTY, query the user for a password
1717 if tty::stdin_isatty() {
1718 return Ok(tty::read_password("Encryption Key Password
: ")?);
1721 bail!("no password input mechanism available
");
1727 _rpcenv: &mut dyn RpcEnvironment,
1728 ) -> Result<Value, Error> {
1730 let path = tools::required_string_param(¶m, "path
")?;
1731 let path = PathBuf::from(path);
1733 let kdf = param["kdf
"].as_str().unwrap_or("scrypt
");
1735 let key = proxmox::sys::linux::random_data(32)?;
1737 if kdf == "scrypt
" {
1738 // always read passphrase from tty
1739 if !tty::stdin_isatty() {
1740 bail!("unable to read passphrase
- no tty
");
1743 let password = tty::read_and_verify_password("Encryption Key Password
: ")?;
1745 let key_config = encrypt_key_with_passphrase(&key, &password)?;
1747 store_key_config(&path, false, key_config)?;
1750 } else if kdf == "none
" {
1751 let created = Local.timestamp(Local::now().timestamp(), 0);
1753 store_key_config(&path, false, KeyConfig {
1766 fn master_pubkey_path() -> Result<PathBuf, Error> {
1767 let base = BaseDirectories::with_prefix("proxmox
-backup
")?;
1769 // usually $HOME/.config/proxmox-backup/master-public.pem
1770 let path = base.place_config_file("master
-public
.pem
")?;
1775 fn key_import_master_pubkey(
1778 _rpcenv: &mut dyn RpcEnvironment,
1779 ) -> Result<Value, Error> {
1781 let path = tools::required_string_param(¶m, "path
")?;
1782 let path = PathBuf::from(path);
1784 let pem_data = file_get_contents(&path)?;
1786 if let Err(err) = openssl::pkey::PKey::public_key_from_pem(&pem_data) {
1787 bail!("Unable to decode PEM data
- {}
", err);
1790 let target_path = master_pubkey_path()?;
1792 replace_file(&target_path, &pem_data, CreateOptions::new())?;
1794 println!("Imported public master key to {:?}
", target_path);
1799 fn key_create_master_key(
1802 _rpcenv: &mut dyn RpcEnvironment,
1803 ) -> Result<Value, Error> {
1805 // we need a TTY to query the new password
1806 if !tty::stdin_isatty() {
1807 bail!("unable to create master key
- no tty
");
1810 let rsa = openssl::rsa::Rsa::generate(4096)?;
1811 let pkey = openssl::pkey::PKey::from_rsa(rsa)?;
1814 let password = String::from_utf8(tty::read_and_verify_password("Master Key Password
: ")?)?;
1816 let pub_key: Vec<u8> = pkey.public_key_to_pem()?;
1817 let filename_pub = "master
-public
.pem
";
1818 println!("Writing public master key to {}
", filename_pub);
1819 replace_file(filename_pub, pub_key.as_slice(), CreateOptions::new())?;
1821 let cipher = openssl::symm::Cipher::aes_256_cbc();
1822 let priv_key: Vec<u8> = pkey.private_key_to_pem_pkcs8_passphrase(cipher, password.as_bytes())?;
1824 let filename_priv = "master
-private
.pem
";
1825 println!("Writing private master key to {}
", filename_priv);
1826 replace_file(filename_priv, priv_key.as_slice(), CreateOptions::new())?;
1831 fn key_change_passphrase(
1834 _rpcenv: &mut dyn RpcEnvironment,
1835 ) -> Result<Value, Error> {
1837 let path = tools::required_string_param(¶m, "path
")?;
1838 let path = PathBuf::from(path);
1840 let kdf = param["kdf
"].as_str().unwrap_or("scrypt
");
1842 // we need a TTY to query the new password
1843 if !tty::stdin_isatty() {
1844 bail!("unable to change passphrase
- no tty
");
1847 let (key, created) = load_and_decrypt_key(&path, &get_encryption_key_password)?;
1849 if kdf == "scrypt
" {
1851 let password = tty::read_and_verify_password("New Password
: ")?;
1853 let mut new_key_config = encrypt_key_with_passphrase(&key, &password)?;
1854 new_key_config.created = created; // keep original value
1856 store_key_config(&path, true, new_key_config)?;
1859 } else if kdf == "none
" {
1860 let modified = Local.timestamp(Local::now().timestamp(), 0);
1862 store_key_config(&path, true, KeyConfig {
1864 created, // keep original value
1875 fn key_mgmt_cli() -> CliCommandMap {
1877 const KDF_SCHEMA: Schema =
1878 StringSchema::new("Key derivation function
. Choose 'none' to store the key unecrypted
.")
1879 .format(&ApiStringFormat::Enum(&[
1880 EnumEntry::new("scrypt
", "SCrypt
"),
1881 EnumEntry::new("none
", "Do not encrypt the key
")]))
1886 const API_METHOD_KEY_CREATE: ApiMethod = ApiMethod::new(
1887 &ApiHandler::Sync(&key_create),
1889 "Create a new encryption key
.",
1891 ("path
", false, &StringSchema::new("File system path
.").schema()),
1892 ("kdf
", true, &KDF_SCHEMA),
1897 let key_create_cmd_def = CliCommand::new(&API_METHOD_KEY_CREATE)
1898 .arg_param(&["path
"])
1899 .completion_cb("path
", tools::complete_file_name);
1902 const API_METHOD_KEY_CHANGE_PASSPHRASE: ApiMethod = ApiMethod::new(
1903 &ApiHandler::Sync(&key_change_passphrase),
1905 "Change the passphrase required to decrypt the key
.",
1907 ("path
", false, &StringSchema::new("File system path
.").schema()),
1908 ("kdf
", true, &KDF_SCHEMA),
1913 let key_change_passphrase_cmd_def = CliCommand::new(&API_METHOD_KEY_CHANGE_PASSPHRASE)
1914 .arg_param(&["path
"])
1915 .completion_cb("path
", tools::complete_file_name);
1917 const API_METHOD_KEY_CREATE_MASTER_KEY: ApiMethod = ApiMethod::new(
1918 &ApiHandler::Sync(&key_create_master_key),
1919 &ObjectSchema::new("Create a new
4096 bit RSA master
pub/priv key pair
.", &[])
1922 let key_create_master_key_cmd_def = CliCommand::new(&API_METHOD_KEY_CREATE_MASTER_KEY);
1925 const API_METHOD_KEY_IMPORT_MASTER_PUBKEY: ApiMethod = ApiMethod::new(
1926 &ApiHandler::Sync(&key_import_master_pubkey),
1928 "Import a new RSA public key and
use it
as master key
. The key is expected to be
in '
.pem' format
.",
1929 &sorted!([ ("path
", false, &StringSchema::new("File system path
.").schema()) ]),
1933 let key_import_master_pubkey_cmd_def = CliCommand::new(&API_METHOD_KEY_IMPORT_MASTER_PUBKEY)
1934 .arg_param(&["path
"])
1935 .completion_cb("path
", tools::complete_file_name);
1937 CliCommandMap::new()
1938 .insert("create
", key_create_cmd_def)
1939 .insert("create
-master
-key
", key_create_master_key_cmd_def)
1940 .insert("import
-master
-pubkey
", key_import_master_pubkey_cmd_def)
1941 .insert("change
-passphrase
", key_change_passphrase_cmd_def)
1947 _rpcenv: &mut dyn RpcEnvironment,
1948 ) -> Result<Value, Error> {
1949 let verbose = param["verbose
"].as_bool().unwrap_or(false);
1951 // This will stay in foreground with debug output enabled as None is
1952 // passed for the RawFd.
1953 return proxmox_backup::tools::runtime::main(mount_do(param, None));
1956 // Process should be deamonized.
1957 // Make sure to fork before the async runtime is instantiated to avoid troubles.
1960 Ok(ForkResult::Parent { .. }) => {
1961 nix::unistd::close(pipe.1).unwrap();
1962 // Blocks the parent process until we are ready to go in the child
1963 let _res = nix::unistd::read(pipe.0, &mut [0]).unwrap();
1966 Ok(ForkResult::Child) => {
1967 nix::unistd::close(pipe.0).unwrap();
1968 nix::unistd::setsid().unwrap();
1969 proxmox_backup::tools::runtime::main(mount_do(param, Some(pipe.1)))
1971 Err(_) => bail!("failed to daemonize process
"),
1975 use proxmox_backup::client::RemoteChunkReader;
1976 /// This is a workaround until we have cleaned up the chunk/reader/... infrastructure for better
1979 /// Ideally BufferedDynamicReader gets replaced so the LruCache maps to `BroadcastFuture<Chunk>`,
1980 /// so that we can properly access it from multiple threads simultaneously while not issuing
1981 /// duplicate simultaneous reads over http.
1982 struct BufferedDynamicReadAt {
1983 inner: Mutex<BufferedDynamicReader<RemoteChunkReader>>,
1986 impl BufferedDynamicReadAt {
1987 fn new(inner: BufferedDynamicReader<RemoteChunkReader>) -> Self {
1989 inner: Mutex::new(inner),
1994 impl pxar::accessor::ReadAt for BufferedDynamicReadAt {
2000 ) -> Poll<io::Result<usize>> {
2002 tokio::task::block_in_place(move || {
2003 let mut reader = self.inner.lock().unwrap();
2004 reader.seek(SeekFrom::Start(offset))?;
2005 Poll::Ready(Ok(reader.read(buf)?))
2010 async fn mount_do(param: Value, pipe: Option<RawFd>) -> Result<Value, Error> {
2011 let repo = extract_repository_from_value(¶m)?;
2012 let archive_name = tools::required_string_param(¶m, "archive
-name
")?;
2013 let target = tools::required_string_param(¶m, "target
")?;
2014 let client = connect(repo.host(), repo.user())?;
2016 record_repository(&repo);
2018 let path = tools::required_string_param(¶m, "snapshot
")?;
2019 let (backup_type, backup_id, backup_time) = if path.matches('/').count() == 1 {
2020 let group = BackupGroup::parse(path)?;
2021 api_datastore_latest_snapshot(&client, repo.store(), group).await?
2023 let snapshot = BackupDir::parse(path)?;
2024 (snapshot.group().backup_type().to_owned(), snapshot.group().backup_id().to_owned(), snapshot.backup_time())
2027 let keyfile = param["keyfile
"].as_str().map(PathBuf::from);
2028 let crypt_config = match keyfile {
2031 let (key, _) = load_and_decrypt_key(&path, &get_encryption_key_password)?;
2032 Some(Arc::new(CryptConfig::new(key)?))
2036 let server_archive_name = if archive_name.ends_with(".pxar
") {
2037 format!("{}
.didx
", archive_name)
2039 bail!("Can only mount pxar archives
.");
2042 let client = BackupReader::start(
2044 crypt_config.clone(),
2052 let manifest = client.download_manifest().await?;
2054 if server_archive_name.ends_with(".didx
") {
2055 let index = client.download_dynamic_index(&manifest, &server_archive_name).await?;
2056 let most_used = index.find_most_used_chunks(8);
2057 let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, most_used);
2058 let reader = BufferedDynamicReader::new(index, chunk_reader);
2059 let archive_size = reader.archive_size();
2060 let reader: proxmox_backup::pxar::fuse::Reader =
2061 Arc::new(BufferedDynamicReadAt::new(reader));
2062 let decoder = proxmox_backup::pxar::fuse::Accessor::new(reader, archive_size).await?;
2063 let options = OsStr::new("ro
,default_permissions
");
2065 let session = proxmox_backup::pxar::fuse::Session::mount(
2071 .map_err(|err| format_err!("pxar mount failed
: {}
", err))?;
2073 if let Some(pipe) = pipe {
2074 nix::unistd::chdir(Path::new("/")).unwrap();
2075 // Finish creation of daemon by redirecting filedescriptors.
2076 let nullfd = nix::fcntl::open(
2078 nix::fcntl::OFlag::O_RDWR,
2079 nix::sys::stat::Mode::empty(),
2081 nix::unistd::dup2(nullfd, 0).unwrap();
2082 nix::unistd::dup2(nullfd, 1).unwrap();
2083 nix::unistd::dup2(nullfd, 2).unwrap();
2085 nix::unistd::close(nullfd).unwrap();
2087 // Signal the parent process that we are done with the setup and it can
2089 nix::unistd::write(pipe, &[0u8])?;
2090 nix::unistd::close(pipe).unwrap();
2093 let mut interrupt = signal(SignalKind::interrupt())?;
2095 res = session.fuse() => res?,
2096 _ = interrupt.recv().fuse() => {
2097 // exit on interrupted
2101 bail!("unknown archive file
extension (expected
.pxar
)");
2112 description: "Group
/Snapshot path
.",
2116 description: "Backup archive name
.",
2120 schema: REPO_URL_SCHEMA,
2125 description: "Path to encryption key
.",
2130 /// Shell to interactively inspect and restore snapshots.
2131 async fn catalog_shell(param: Value) -> Result<(), Error> {
2132 let repo = extract_repository_from_value(¶m)?;
2133 let client = connect(repo.host(), repo.user())?;
2134 let path = tools::required_string_param(¶m, "snapshot
")?;
2135 let archive_name = tools::required_string_param(¶m, "archive
-name
")?;
2137 let (backup_type, backup_id, backup_time) = if path.matches('/').count() == 1 {
2138 let group = BackupGroup::parse(path)?;
2139 api_datastore_latest_snapshot(&client, repo.store(), group).await?
2141 let snapshot = BackupDir::parse(path)?;
2142 (snapshot.group().backup_type().to_owned(), snapshot.group().backup_id().to_owned(), snapshot.backup_time())
2145 let keyfile = param["keyfile
"].as_str().map(|p| PathBuf::from(p));
2146 let crypt_config = match keyfile {
2149 let (key, _) = load_and_decrypt_key(&path, &get_encryption_key_password)?;
2150 Some(Arc::new(CryptConfig::new(key)?))
2154 let server_archive_name = if archive_name.ends_with(".pxar
") {
2155 format!("{}
.didx
", archive_name)
2157 bail!("Can only mount pxar archives
.");
2160 let client = BackupReader::start(
2162 crypt_config.clone(),
2170 let tmpfile = std::fs::OpenOptions::new()
2173 .custom_flags(libc::O_TMPFILE)
2176 let manifest = client.download_manifest().await?;
2178 let index = client.download_dynamic_index(&manifest, &server_archive_name).await?;
2179 let most_used = index.find_most_used_chunks(8);
2180 let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config.clone(), most_used);
2181 let reader = BufferedDynamicReader::new(index, chunk_reader);
2182 let archive_size = reader.archive_size();
2183 let reader: proxmox_backup::pxar::fuse::Reader =
2184 Arc::new(BufferedDynamicReadAt::new(reader));
2185 let decoder = proxmox_backup::pxar::fuse::Accessor::new(reader, archive_size).await?;
2187 let tmpfile = client.download(CATALOG_NAME, tmpfile).await?;
2188 let index = DynamicIndexReader::new(tmpfile)
2189 .map_err(|err| format_err!("unable to read catalog index
- {}
", err))?;
2191 // Note: do not use values stored in index (not trusted) - instead, computed them again
2192 let (csum, size) = index.compute_csum();
2193 manifest.verify_file(CATALOG_NAME, &csum, size)?;
2195 let most_used = index.find_most_used_chunks(8);
2196 let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, most_used);
2197 let mut reader = BufferedDynamicReader::new(index, chunk_reader);
2198 let mut catalogfile = std::fs::OpenOptions::new()
2201 .custom_flags(libc::O_TMPFILE)
2204 std::io::copy(&mut reader, &mut catalogfile)
2205 .map_err(|err| format_err!("unable to download catalog
- {}
", err))?;
2207 catalogfile.seek(SeekFrom::Start(0))?;
2208 let catalog_reader = CatalogReader::new(catalogfile);
2209 let state = Shell::new(
2211 &server_archive_name,
2215 println!("Starting interactive shell
");
2216 state.shell().await?;
2218 record_repository(&repo);
2223 fn catalog_mgmt_cli() -> CliCommandMap {
2224 let catalog_shell_cmd_def = CliCommand::new(&API_METHOD_CATALOG_SHELL)
2225 .arg_param(&["snapshot
", "archive
-name
"])
2226 .completion_cb("repository
", complete_repository)
2227 .completion_cb("archive
-name
", complete_pxar_archive_name)
2228 .completion_cb("snapshot
", complete_group_or_snapshot);
2230 let catalog_dump_cmd_def = CliCommand::new(&API_METHOD_DUMP_CATALOG)
2231 .arg_param(&["snapshot
"])
2232 .completion_cb("repository
", complete_repository)
2233 .completion_cb("snapshot
", complete_backup_snapshot);
2235 CliCommandMap::new()
2236 .insert("dump
", catalog_dump_cmd_def)
2237 .insert("shell
", catalog_shell_cmd_def)
2244 schema: REPO_URL_SCHEMA,
2248 description: "The maximal number of tasks to list
.",
2256 schema: OUTPUT_FORMAT,
2261 description: "Also list stopped tasks
.",
2267 /// List running server tasks for this repo user
2268 async fn task_list(param: Value) -> Result<Value, Error> {
2270 let output_format = get_output_format(¶m);
2272 let repo = extract_repository_from_value(¶m)?;
2273 let client = connect(repo.host(), repo.user())?;
2275 let limit = param["limit
"].as_u64().unwrap_or(50) as usize;
2276 let running = !param["all
"].as_bool().unwrap_or(false);
2282 "userfilter
": repo.user(),
2283 "store
": repo.store(),
2286 let mut result = client.get("api2
/json
/nodes
/localhost
/tasks
", Some(args)).await?;
2287 let mut data = result["data
"].take();
2289 let schema = &proxmox_backup::api2::node::tasks::API_RETURN_SCHEMA_LIST_TASKS;
2291 let options = default_table_format_options()
2292 .column(ColumnConfig::new("starttime
").right_align(false).renderer(tools::format::render_epoch))
2293 .column(ColumnConfig::new("endtime
").right_align(false).renderer(tools::format::render_epoch))
2294 .column(ColumnConfig::new("upid
"))
2295 .column(ColumnConfig::new("status
").renderer(tools::format::render_task_status));
2297 format_and_print_result_full(&mut data, schema, &output_format, &options);
2306 schema: REPO_URL_SCHEMA,
2310 schema: UPID_SCHEMA,
2315 /// Display the task log.
2316 async fn task_log(param: Value) -> Result<Value, Error> {
2318 let repo = extract_repository_from_value(¶m)?;
2319 let upid = tools::required_string_param(¶m, "upid
")?;
2321 let client = connect(repo.host(), repo.user())?;
2323 display_task_log(client, upid, true).await?;
2332 schema: REPO_URL_SCHEMA,
2336 schema: UPID_SCHEMA,
2341 /// Try to stop a specific task.
2342 async fn task_stop(param: Value) -> Result<Value, Error> {
2344 let repo = extract_repository_from_value(¶m)?;
2345 let upid_str = tools::required_string_param(¶m, "upid
")?;
2347 let mut client = connect(repo.host(), repo.user())?;
2349 let path = format!("api2
/json
/nodes
/localhost
/tasks
/{}
", upid_str);
2350 let _ = client.delete(&path, None).await?;
2355 fn task_mgmt_cli() -> CliCommandMap {
2357 let task_list_cmd_def = CliCommand::new(&API_METHOD_TASK_LIST)
2358 .completion_cb("repository
", complete_repository);
2360 let task_log_cmd_def = CliCommand::new(&API_METHOD_TASK_LOG)
2361 .arg_param(&["upid
"]);
2363 let task_stop_cmd_def = CliCommand::new(&API_METHOD_TASK_STOP)
2364 .arg_param(&["upid
"]);
2366 CliCommandMap::new()
2367 .insert("log
", task_log_cmd_def)
2368 .insert("list
", task_list_cmd_def)
2369 .insert("stop
", task_stop_cmd_def)
2374 let backup_cmd_def = CliCommand::new(&API_METHOD_CREATE_BACKUP)
2375 .arg_param(&["backupspec
"])
2376 .completion_cb("repository
", complete_repository)
2377 .completion_cb("backupspec
", complete_backup_source)
2378 .completion_cb("keyfile
", tools::complete_file_name)
2379 .completion_cb("chunk
-size
", complete_chunk_size);
2381 let upload_log_cmd_def = CliCommand::new(&API_METHOD_UPLOAD_LOG)
2382 .arg_param(&["snapshot
", "logfile
"])
2383 .completion_cb("snapshot
", complete_backup_snapshot)
2384 .completion_cb("logfile
", tools::complete_file_name)
2385 .completion_cb("keyfile
", tools::complete_file_name)
2386 .completion_cb("repository
", complete_repository);
2388 let list_cmd_def = CliCommand::new(&API_METHOD_LIST_BACKUP_GROUPS)
2389 .completion_cb("repository
", complete_repository);
2391 let snapshots_cmd_def = CliCommand::new(&API_METHOD_LIST_SNAPSHOTS)
2392 .arg_param(&["group
"])
2393 .completion_cb("group
", complete_backup_group)
2394 .completion_cb("repository
", complete_repository);
2396 let forget_cmd_def = CliCommand::new(&API_METHOD_FORGET_SNAPSHOTS)
2397 .arg_param(&["snapshot
"])
2398 .completion_cb("repository
", complete_repository)
2399 .completion_cb("snapshot
", complete_backup_snapshot);
2401 let garbage_collect_cmd_def = CliCommand::new(&API_METHOD_START_GARBAGE_COLLECTION)
2402 .completion_cb("repository
", complete_repository);
2404 let restore_cmd_def = CliCommand::new(&API_METHOD_RESTORE)
2405 .arg_param(&["snapshot
", "archive
-name
", "target
"])
2406 .completion_cb("repository
", complete_repository)
2407 .completion_cb("snapshot
", complete_group_or_snapshot)
2408 .completion_cb("archive
-name
", complete_archive_name)
2409 .completion_cb("target
", tools::complete_file_name);
2411 let files_cmd_def = CliCommand::new(&API_METHOD_LIST_SNAPSHOT_FILES)
2412 .arg_param(&["snapshot
"])
2413 .completion_cb("repository
", complete_repository)
2414 .completion_cb("snapshot
", complete_backup_snapshot);
2416 let prune_cmd_def = CliCommand::new(&API_METHOD_PRUNE)
2417 .arg_param(&["group
"])
2418 .completion_cb("group
", complete_backup_group)
2419 .completion_cb("repository
", complete_repository);
2421 let status_cmd_def = CliCommand::new(&API_METHOD_STATUS)
2422 .completion_cb("repository
", complete_repository);
2424 let login_cmd_def = CliCommand::new(&API_METHOD_API_LOGIN)
2425 .completion_cb("repository
", complete_repository);
2427 let logout_cmd_def = CliCommand::new(&API_METHOD_API_LOGOUT)
2428 .completion_cb("repository
", complete_repository);
2431 const API_METHOD_MOUNT: ApiMethod = ApiMethod::new(
2432 &ApiHandler::Sync(&mount),
2434 "Mount pxar archive
.",
2436 ("snapshot
", false, &StringSchema::new("Group
/Snapshot path
.").schema()),
2437 ("archive
-name
", false, &StringSchema::new("Backup archive name
.").schema()),
2438 ("target
", false, &StringSchema::new("Target directory path
.").schema()),
2439 ("repository
", true, &REPO_URL_SCHEMA),
2440 ("keyfile
", true, &StringSchema::new("Path to encryption key
.").schema()),
2441 ("verbose
", true, &BooleanSchema::new("Verbose output
.").default(false).schema()),
2446 let mount_cmd_def = CliCommand::new(&API_METHOD_MOUNT)
2447 .arg_param(&["snapshot
", "archive
-name
", "target
"])
2448 .completion_cb("repository
", complete_repository)
2449 .completion_cb("snapshot
", complete_group_or_snapshot)
2450 .completion_cb("archive
-name
", complete_pxar_archive_name)
2451 .completion_cb("target
", tools::complete_file_name);
2454 let cmd_def = CliCommandMap::new()
2455 .insert("backup
", backup_cmd_def)
2456 .insert("upload
-log
", upload_log_cmd_def)
2457 .insert("forget
", forget_cmd_def)
2458 .insert("garbage
-collect
", garbage_collect_cmd_def)
2459 .insert("list
", list_cmd_def)
2460 .insert("login
", login_cmd_def)
2461 .insert("logout
", logout_cmd_def)
2462 .insert("prune
", prune_cmd_def)
2463 .insert("restore
", restore_cmd_def)
2464 .insert("snapshots
", snapshots_cmd_def)
2465 .insert("files
", files_cmd_def)
2466 .insert("status
", status_cmd_def)
2467 .insert("key
", key_mgmt_cli())
2468 .insert("mount
", mount_cmd_def)
2469 .insert("catalog
", catalog_mgmt_cli())
2470 .insert("task
", task_mgmt_cli());
2472 let rpcenv = CliEnvironment::new();
2473 run_cli_command(cmd_def, rpcenv, Some(|future| {
2474 proxmox_backup::tools::runtime::main(future)