1 use anyhow
::{bail, format_err, Error}
;
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
::sys
::linux
::tty
;
14 use proxmox
::api
::{ApiHandler, ApiMethod, RpcEnvironment}
;
15 use proxmox
::api
::schema
::*;
16 use proxmox
::api
::cli
::*;
17 use proxmox
::api
::api
;
19 use proxmox_backup
::tools
;
20 use proxmox_backup
::api2
::types
::*;
21 use proxmox_backup
::client
::*;
22 use proxmox_backup
::backup
::*;
23 use proxmox_backup
::pxar
::{ self, catalog::* }
;
25 use serde_json
::{json, Value}
;
27 use std
::sync
::{Arc, Mutex}
;
29 use xdg
::BaseDirectories
;
32 use tokio
::sync
::mpsc
;
34 const ENV_VAR_PBS_FINGERPRINT
: &str = "PBS_FINGERPRINT";
35 const ENV_VAR_PBS_PASSWORD
: &str = "PBS_PASSWORD";
38 const REPO_URL_SCHEMA
: Schema
= StringSchema
::new("Repository URL.")
39 .format(&BACKUP_REPO_URL
)
43 const KEYFILE_SCHEMA
: Schema
= StringSchema
::new(
44 "Path to encryption key. All data will be encrypted using this key.")
47 const CHUNK_SIZE_SCHEMA
: Schema
= IntegerSchema
::new(
48 "Chunk size in KB. Must be a power of 2.")
54 fn get_default_repository() -> Option
<String
> {
55 std
::env
::var("PBS_REPOSITORY").ok()
58 fn extract_repository_from_value(
60 ) -> Result
<BackupRepository
, Error
> {
62 let repo_url
= param
["repository"]
65 .or_else(get_default_repository
)
66 .ok_or_else(|| format_err
!("unable to get (default) repository"))?
;
68 let repo
: BackupRepository
= repo_url
.parse()?
;
73 fn extract_repository_from_map(
74 param
: &HashMap
<String
, String
>,
75 ) -> Option
<BackupRepository
> {
77 param
.get("repository")
79 .or_else(get_default_repository
)
80 .and_then(|repo_url
| repo_url
.parse
::<BackupRepository
>().ok())
83 fn record_repository(repo
: &BackupRepository
) {
85 let base
= match BaseDirectories
::with_prefix("proxmox-backup") {
90 // usually $HOME/.cache/proxmox-backup/repo-list
91 let path
= match base
.place_cache_file("repo-list") {
96 let mut data
= file_get_json(&path
, None
).unwrap_or_else(|_
| json
!({}
));
98 let repo
= repo
.to_string();
100 data
[&repo
] = json
!{ data[&repo].as_i64().unwrap_or(0) + 1 }
;
102 let mut map
= serde_json
::map
::Map
::new();
105 let mut max_used
= 0;
106 let mut max_repo
= None
;
107 for (repo
, count
) in data
.as_object().unwrap() {
108 if map
.contains_key(repo
) { continue; }
109 if let Some(count
) = count
.as_i64() {
110 if count
> max_used
{
112 max_repo
= Some(repo
);
116 if let Some(repo
) = max_repo
{
117 map
.insert(repo
.to_owned(), json
!(max_used
));
121 if map
.len() > 10 { // store max. 10 repos
126 let new_data
= json
!(map
);
128 let _
= replace_file(path
, new_data
.to_string().as_bytes(), CreateOptions
::new());
131 fn complete_repository(_arg
: &str, _param
: &HashMap
<String
, String
>) -> Vec
<String
> {
133 let mut result
= vec
![];
135 let base
= match BaseDirectories
::with_prefix("proxmox-backup") {
140 // usually $HOME/.cache/proxmox-backup/repo-list
141 let path
= match base
.place_cache_file("repo-list") {
146 let data
= file_get_json(&path
, None
).unwrap_or_else(|_
| json
!({}
));
148 if let Some(map
) = data
.as_object() {
149 for (repo
, _count
) in map
{
150 result
.push(repo
.to_owned());
157 fn connect(server
: &str, userid
: &str) -> Result
<HttpClient
, Error
> {
159 let fingerprint
= std
::env
::var(ENV_VAR_PBS_FINGERPRINT
).ok();
161 use std
::env
::VarError
::*;
162 let password
= match std
::env
::var(ENV_VAR_PBS_PASSWORD
) {
164 Err(NotUnicode(_
)) => bail
!(format
!("{} contains bad characters", ENV_VAR_PBS_PASSWORD
)),
165 Err(NotPresent
) => None
,
168 let options
= HttpClientOptions
::new()
169 .prefix(Some("proxmox-backup".to_string()))
172 .fingerprint(fingerprint
)
173 .fingerprint_cache(true)
176 HttpClient
::new(server
, userid
, options
)
179 async
fn view_task_result(
183 ) -> Result
<(), Error
> {
184 let data
= &result
["data"];
185 if output_format
== "text" {
186 if let Some(upid
) = data
.as_str() {
187 display_task_log(client
, upid
, true).await?
;
190 format_and_print_result(&data
, &output_format
);
196 async
fn api_datastore_list_snapshots(
199 group
: Option
<BackupGroup
>,
200 ) -> Result
<Value
, Error
> {
202 let path
= format
!("api2/json/admin/datastore/{}/snapshots", store
);
204 let mut args
= json
!({}
);
205 if let Some(group
) = group
{
206 args
["backup-type"] = group
.backup_type().into();
207 args
["backup-id"] = group
.backup_id().into();
210 let mut result
= client
.get(&path
, Some(args
)).await?
;
212 Ok(result
["data"].take())
215 async
fn api_datastore_latest_snapshot(
219 ) -> Result
<(String
, String
, DateTime
<Utc
>), Error
> {
221 let list
= api_datastore_list_snapshots(client
, store
, Some(group
.clone())).await?
;
222 let mut list
: Vec
<SnapshotListItem
> = serde_json
::from_value(list
)?
;
225 bail
!("backup group {:?} does not contain any snapshots.", group
.group_path());
228 list
.sort_unstable_by(|a
, b
| b
.backup_time
.cmp(&a
.backup_time
));
230 let backup_time
= Utc
.timestamp(list
[0].backup_time
, 0);
232 Ok((group
.backup_type().to_owned(), group
.backup_id().to_owned(), backup_time
))
236 async
fn backup_directory
<P
: AsRef
<Path
>>(
237 client
: &BackupWriter
,
240 chunk_size
: Option
<usize>,
241 device_set
: Option
<HashSet
<u64>>,
243 skip_lost_and_found
: bool
,
244 crypt_config
: Option
<Arc
<CryptConfig
>>,
245 catalog
: Arc
<Mutex
<CatalogWriter
<crate::tools
::StdChannelWriter
>>>,
246 exclude_pattern
: Vec
<pxar
::MatchPattern
>,
248 ) -> Result
<BackupStats
, Error
> {
250 let pxar_stream
= PxarBackupStream
::open(
259 let mut chunk_stream
= ChunkStream
::new(pxar_stream
, chunk_size
);
261 let (mut tx
, rx
) = mpsc
::channel(10); // allow to buffer 10 chunks
264 .map_err(Error
::from
);
266 // spawn chunker inside a separate task so that it can run parallel
267 tokio
::spawn(async
move {
268 while let Some(v
) = chunk_stream
.next().await
{
269 let _
= tx
.send(v
).await
;
274 .upload_stream(archive_name
, stream
, "dynamic", None
, crypt_config
)
280 async
fn backup_image
<P
: AsRef
<Path
>>(
281 client
: &BackupWriter
,
285 chunk_size
: Option
<usize>,
287 crypt_config
: Option
<Arc
<CryptConfig
>>,
288 ) -> Result
<BackupStats
, Error
> {
290 let path
= image_path
.as_ref().to_owned();
292 let file
= tokio
::fs
::File
::open(path
).await?
;
294 let stream
= tokio_util
::codec
::FramedRead
::new(file
, tokio_util
::codec
::BytesCodec
::new())
295 .map_err(Error
::from
);
297 let stream
= FixedChunkStream
::new(stream
, chunk_size
.unwrap_or(4*1024*1024));
300 .upload_stream(archive_name
, stream
, "fixed", Some(image_size
), crypt_config
)
310 schema
: REPO_URL_SCHEMA
,
314 schema
: OUTPUT_FORMAT
,
320 /// List backup groups.
321 async
fn list_backup_groups(param
: Value
) -> Result
<Value
, Error
> {
323 let output_format
= get_output_format(¶m
);
325 let repo
= extract_repository_from_value(¶m
)?
;
327 let client
= connect(repo
.host(), repo
.user())?
;
329 let path
= format
!("api2/json/admin/datastore/{}/groups", repo
.store());
331 let mut result
= client
.get(&path
, None
).await?
;
333 record_repository(&repo
);
335 let render_group_path
= |_v
: &Value
, record
: &Value
| -> Result
<String
, Error
> {
336 let item
: GroupListItem
= serde_json
::from_value(record
.to_owned())?
;
337 let group
= BackupGroup
::new(item
.backup_type
, item
.backup_id
);
338 Ok(group
.group_path().to_str().unwrap().to_owned())
341 let render_last_backup
= |_v
: &Value
, record
: &Value
| -> Result
<String
, Error
> {
342 let item
: GroupListItem
= serde_json
::from_value(record
.to_owned())?
;
343 let snapshot
= BackupDir
::new(item
.backup_type
, item
.backup_id
, item
.last_backup
);
344 Ok(snapshot
.relative_path().to_str().unwrap().to_owned())
347 let render_files
= |_v
: &Value
, record
: &Value
| -> Result
<String
, Error
> {
348 let item
: GroupListItem
= serde_json
::from_value(record
.to_owned())?
;
349 Ok(tools
::format
::render_backup_file_list(&item
.files
))
352 let options
= default_table_format_options()
353 .sortby("backup-type", false)
354 .sortby("backup-id", false)
355 .column(ColumnConfig
::new("backup-id").renderer(render_group_path
).header("group"))
357 ColumnConfig
::new("last-backup")
358 .renderer(render_last_backup
)
359 .header("last snapshot")
362 .column(ColumnConfig
::new("backup-count"))
363 .column(ColumnConfig
::new("files").renderer(render_files
));
365 let mut data
: Value
= result
["data"].take();
367 let info
= &proxmox_backup
::api2
::admin
::datastore
::API_RETURN_SCHEMA_LIST_GROUPS
;
369 format_and_print_result_full(&mut data
, info
, &output_format
, &options
);
378 schema
: REPO_URL_SCHEMA
,
383 description
: "Backup group.",
387 schema
: OUTPUT_FORMAT
,
393 /// List backup snapshots.
394 async
fn list_snapshots(param
: Value
) -> Result
<Value
, Error
> {
396 let repo
= extract_repository_from_value(¶m
)?
;
398 let output_format
= get_output_format(¶m
);
400 let client
= connect(repo
.host(), repo
.user())?
;
402 let group
= if let Some(path
) = param
["group"].as_str() {
403 Some(BackupGroup
::parse(path
)?
)
408 let mut data
= api_datastore_list_snapshots(&client
, repo
.store(), group
).await?
;
410 record_repository(&repo
);
412 let render_snapshot_path
= |_v
: &Value
, record
: &Value
| -> Result
<String
, Error
> {
413 let item
: SnapshotListItem
= serde_json
::from_value(record
.to_owned())?
;
414 let snapshot
= BackupDir
::new(item
.backup_type
, item
.backup_id
, item
.backup_time
);
415 Ok(snapshot
.relative_path().to_str().unwrap().to_owned())
418 let render_files
= |_v
: &Value
, record
: &Value
| -> Result
<String
, Error
> {
419 let item
: SnapshotListItem
= serde_json
::from_value(record
.to_owned())?
;
420 Ok(tools
::format
::render_backup_file_list(&item
.files
))
423 let options
= default_table_format_options()
424 .sortby("backup-type", false)
425 .sortby("backup-id", false)
426 .sortby("backup-time", false)
427 .column(ColumnConfig
::new("backup-id").renderer(render_snapshot_path
).header("snapshot"))
428 .column(ColumnConfig
::new("size"))
429 .column(ColumnConfig
::new("files").renderer(render_files
))
432 let info
= &proxmox_backup
::api2
::admin
::datastore
::API_RETURN_SCHEMA_LIST_SNAPSHOTS
;
434 format_and_print_result_full(&mut data
, info
, &output_format
, &options
);
443 schema
: REPO_URL_SCHEMA
,
448 description
: "Snapshot path.",
453 /// Forget (remove) backup snapshots.
454 async
fn forget_snapshots(param
: Value
) -> Result
<Value
, Error
> {
456 let repo
= extract_repository_from_value(¶m
)?
;
458 let path
= tools
::required_string_param(¶m
, "snapshot")?
;
459 let snapshot
= BackupDir
::parse(path
)?
;
461 let mut client
= connect(repo
.host(), repo
.user())?
;
463 let path
= format
!("api2/json/admin/datastore/{}/snapshots", repo
.store());
465 let result
= client
.delete(&path
, Some(json
!({
466 "backup-type": snapshot
.group().backup_type(),
467 "backup-id": snapshot
.group().backup_id(),
468 "backup-time": snapshot
.backup_time().timestamp(),
471 record_repository(&repo
);
480 schema
: REPO_URL_SCHEMA
,
486 /// Try to login. If successful, store ticket.
487 async
fn api_login(param
: Value
) -> Result
<Value
, Error
> {
489 let repo
= extract_repository_from_value(¶m
)?
;
491 let client
= connect(repo
.host(), repo
.user())?
;
492 client
.login().await?
;
494 record_repository(&repo
);
503 schema
: REPO_URL_SCHEMA
,
509 /// Logout (delete stored ticket).
510 fn api_logout(param
: Value
) -> Result
<Value
, Error
> {
512 let repo
= extract_repository_from_value(¶m
)?
;
514 delete_ticket_info("proxmox-backup", repo
.host(), repo
.user())?
;
523 schema
: REPO_URL_SCHEMA
,
528 description
: "Snapshot path.",
534 async
fn dump_catalog(param
: Value
) -> Result
<Value
, Error
> {
536 let repo
= extract_repository_from_value(¶m
)?
;
538 let path
= tools
::required_string_param(¶m
, "snapshot")?
;
539 let snapshot
= BackupDir
::parse(path
)?
;
541 let keyfile
= param
["keyfile"].as_str().map(PathBuf
::from
);
543 let crypt_config
= match keyfile
{
546 let (key
, _
) = load_and_decrypt_key(&path
, &get_encryption_key_password
)?
;
547 Some(Arc
::new(CryptConfig
::new(key
)?
))
551 let client
= connect(repo
.host(), repo
.user())?
;
553 let client
= BackupReader
::start(
555 crypt_config
.clone(),
557 &snapshot
.group().backup_type(),
558 &snapshot
.group().backup_id(),
559 snapshot
.backup_time(),
563 let manifest
= client
.download_manifest().await?
;
565 let index
= client
.download_dynamic_index(&manifest
, CATALOG_NAME
).await?
;
567 let most_used
= index
.find_most_used_chunks(8);
569 let chunk_reader
= RemoteChunkReader
::new(client
.clone(), crypt_config
, most_used
);
571 let mut reader
= BufferedDynamicReader
::new(index
, chunk_reader
);
573 let mut catalogfile
= std
::fs
::OpenOptions
::new()
576 .custom_flags(libc
::O_TMPFILE
)
579 std
::io
::copy(&mut reader
, &mut catalogfile
)
580 .map_err(|err
| format_err
!("unable to download catalog - {}", err
))?
;
582 catalogfile
.seek(SeekFrom
::Start(0))?
;
584 let mut catalog_reader
= CatalogReader
::new(catalogfile
);
586 catalog_reader
.dump()?
;
588 record_repository(&repo
);
597 schema
: REPO_URL_SCHEMA
,
602 description
: "Snapshot path.",
605 schema
: OUTPUT_FORMAT
,
611 /// List snapshot files.
612 async
fn list_snapshot_files(param
: Value
) -> Result
<Value
, Error
> {
614 let repo
= extract_repository_from_value(¶m
)?
;
616 let path
= tools
::required_string_param(¶m
, "snapshot")?
;
617 let snapshot
= BackupDir
::parse(path
)?
;
619 let output_format
= get_output_format(¶m
);
621 let client
= connect(repo
.host(), repo
.user())?
;
623 let path
= format
!("api2/json/admin/datastore/{}/files", repo
.store());
625 let mut result
= client
.get(&path
, Some(json
!({
626 "backup-type": snapshot
.group().backup_type(),
627 "backup-id": snapshot
.group().backup_id(),
628 "backup-time": snapshot
.backup_time().timestamp(),
631 record_repository(&repo
);
633 let info
= &proxmox_backup
::api2
::admin
::datastore
::API_RETURN_SCHEMA_LIST_SNAPSHOT_FILES
;
635 let mut data
: Value
= result
["data"].take();
637 let options
= default_table_format_options();
639 format_and_print_result_full(&mut data
, info
, &output_format
, &options
);
648 schema
: REPO_URL_SCHEMA
,
652 schema
: OUTPUT_FORMAT
,
658 /// Start garbage collection for a specific repository.
659 async
fn start_garbage_collection(param
: Value
) -> Result
<Value
, Error
> {
661 let repo
= extract_repository_from_value(¶m
)?
;
663 let output_format
= get_output_format(¶m
);
665 let mut client
= connect(repo
.host(), repo
.user())?
;
667 let path
= format
!("api2/json/admin/datastore/{}/gc", repo
.store());
669 let result
= client
.post(&path
, None
).await?
;
671 record_repository(&repo
);
673 view_task_result(client
, result
, &output_format
).await?
;
678 fn spawn_catalog_upload(
679 client
: Arc
<BackupWriter
>,
680 crypt_config
: Option
<Arc
<CryptConfig
>>,
683 Arc
<Mutex
<CatalogWriter
<crate::tools
::StdChannelWriter
>>>,
684 tokio
::sync
::oneshot
::Receiver
<Result
<BackupStats
, Error
>>
687 let (catalog_tx
, catalog_rx
) = std
::sync
::mpsc
::sync_channel(10); // allow to buffer 10 writes
688 let catalog_stream
= crate::tools
::StdChannelStream(catalog_rx
);
689 let catalog_chunk_size
= 512*1024;
690 let catalog_chunk_stream
= ChunkStream
::new(catalog_stream
, Some(catalog_chunk_size
));
692 let catalog
= Arc
::new(Mutex
::new(CatalogWriter
::new(crate::tools
::StdChannelWriter
::new(catalog_tx
))?
));
694 let (catalog_result_tx
, catalog_result_rx
) = tokio
::sync
::oneshot
::channel();
696 tokio
::spawn(async
move {
697 let catalog_upload_result
= client
698 .upload_stream(CATALOG_NAME
, catalog_chunk_stream
, "dynamic", None
, crypt_config
)
701 if let Err(ref err
) = catalog_upload_result
{
702 eprintln
!("catalog upload error - {}", err
);
706 let _
= catalog_result_tx
.send(catalog_upload_result
);
709 Ok((catalog
, catalog_result_rx
))
717 description
: "List of backup source specifications ([<label.ext>:<path>] ...)",
719 schema
: BACKUP_SOURCE_SCHEMA
,
723 schema
: REPO_URL_SCHEMA
,
727 description
: "Include mountpoints with same st_dev number (see ``man fstat``) as specified files.",
731 description
: "Path to file.",
735 schema
: KEYFILE_SCHEMA
,
738 "skip-lost-and-found": {
740 description
: "Skip lost+found directory.",
744 schema
: BACKUP_TYPE_SCHEMA
,
748 schema
: BACKUP_ID_SCHEMA
,
752 schema
: BACKUP_TIME_SCHEMA
,
756 schema
: CHUNK_SIZE_SCHEMA
,
761 description
: "List of paths or patterns for matching files to exclude.",
765 description
: "Path or match pattern.",
770 description
: "Max number of entries to hold in memory.",
772 default: pxar
::ENCODER_MAX_ENTRIES
as isize,
776 description
: "Verbose output.",
782 /// Create (host) backup.
783 async
fn create_backup(
786 _rpcenv
: &mut dyn RpcEnvironment
,
787 ) -> Result
<Value
, Error
> {
789 let repo
= extract_repository_from_value(¶m
)?
;
791 let backupspec_list
= tools
::required_array_param(¶m
, "backupspec")?
;
793 let all_file_systems
= param
["all-file-systems"].as_bool().unwrap_or(false);
795 let skip_lost_and_found
= param
["skip-lost-and-found"].as_bool().unwrap_or(false);
797 let verbose
= param
["verbose"].as_bool().unwrap_or(false);
799 let backup_time_opt
= param
["backup-time"].as_i64();
801 let chunk_size_opt
= param
["chunk-size"].as_u64().map(|v
| (v
*1024) as usize);
803 if let Some(size
) = chunk_size_opt
{
804 verify_chunk_size(size
)?
;
807 let keyfile
= param
["keyfile"].as_str().map(PathBuf
::from
);
809 let backup_id
= param
["backup-id"].as_str().unwrap_or(&proxmox
::tools
::nodename());
811 let backup_type
= param
["backup-type"].as_str().unwrap_or("host");
813 let include_dev
= param
["include-dev"].as_array();
815 let entries_max
= param
["entries-max"].as_u64().unwrap_or(pxar
::ENCODER_MAX_ENTRIES
as u64);
817 let empty
= Vec
::new();
818 let arg_pattern
= param
["exclude"].as_array().unwrap_or(&empty
);
820 let mut pattern_list
= Vec
::with_capacity(arg_pattern
.len());
821 for s
in arg_pattern
{
822 let l
= s
.as_str().ok_or_else(|| format_err
!("Invalid pattern string slice"))?
;
823 let p
= pxar
::MatchPattern
::from_line(l
.as_bytes())?
824 .ok_or_else(|| format_err
!("Invalid match pattern in arguments"))?
;
825 pattern_list
.push(p
);
828 let mut devices
= if all_file_systems { None }
else { Some(HashSet::new()) }
;
830 if let Some(include_dev
) = include_dev
{
831 if all_file_systems
{
832 bail
!("option 'all-file-systems' conflicts with option 'include-dev'");
835 let mut set
= HashSet
::new();
836 for path
in include_dev
{
837 let path
= path
.as_str().unwrap();
838 let stat
= nix
::sys
::stat
::stat(path
)
839 .map_err(|err
| format_err
!("fstat {:?} failed - {}", path
, err
))?
;
840 set
.insert(stat
.st_dev
);
845 let mut upload_list
= vec
![];
847 let mut upload_catalog
= false;
849 for backupspec
in backupspec_list
{
850 let spec
= parse_backup_specification(backupspec
.as_str().unwrap())?
;
851 let filename
= &spec
.config_string
;
852 let target
= &spec
.archive_name
;
854 use std
::os
::unix
::fs
::FileTypeExt
;
856 let metadata
= std
::fs
::metadata(filename
)
857 .map_err(|err
| format_err
!("unable to access '{}' - {}", filename
, err
))?
;
858 let file_type
= metadata
.file_type();
860 match spec
.spec_type
{
861 BackupSpecificationType
::PXAR
=> {
862 if !file_type
.is_dir() {
863 bail
!("got unexpected file type (expected directory)");
865 upload_list
.push((BackupSpecificationType
::PXAR
, filename
.to_owned(), format
!("{}.didx", target
), 0));
866 upload_catalog
= true;
868 BackupSpecificationType
::IMAGE
=> {
869 if !(file_type
.is_file() || file_type
.is_block_device()) {
870 bail
!("got unexpected file type (expected file or block device)");
873 let size
= image_size(&PathBuf
::from(filename
))?
;
875 if size
== 0 { bail!("got zero-sized file '{}'
", filename); }
877 upload_list.push((BackupSpecificationType::IMAGE, filename.to_owned(), format!("{}
.fidx
", target), size));
879 BackupSpecificationType::CONFIG => {
880 if !file_type.is_file() {
881 bail!("got unexpected file
type (expected regular file
)");
883 upload_list.push((BackupSpecificationType::CONFIG, filename.to_owned(), format!("{}
.blob
", target), metadata.len()));
885 BackupSpecificationType::LOGFILE => {
886 if !file_type.is_file() {
887 bail!("got unexpected file
type (expected regular file
)");
889 upload_list.push((BackupSpecificationType::LOGFILE, filename.to_owned(), format!("{}
.blob
", target), metadata.len()));
894 let backup_time = Utc.timestamp(backup_time_opt.unwrap_or_else(|| Utc::now().timestamp()), 0);
896 let client = connect(repo.host(), repo.user())?;
897 record_repository(&repo);
899 println!("Starting backup
: {}
/{}
/{}
", backup_type, backup_id, BackupDir::backup_time_to_string(backup_time));
901 println!("Client name
: {}
", proxmox::tools::nodename());
903 let start_time = Local::now();
905 println!("Starting protocol
: {}
", start_time.to_rfc3339_opts(chrono::SecondsFormat::Secs, false));
907 let (crypt_config, rsa_encrypted_key) = match keyfile {
908 None => (None, None),
910 let (key, created) = load_and_decrypt_key(&path, &get_encryption_key_password)?;
912 let crypt_config = CryptConfig::new(key)?;
914 let path = master_pubkey_path()?;
916 let pem_data = file_get_contents(&path)?;
917 let rsa = openssl::rsa::Rsa::public_key_from_pem(&pem_data)?;
918 let enc_key = crypt_config.generate_rsa_encoded_key(rsa, created)?;
919 (Some(Arc::new(crypt_config)), Some(enc_key))
921 (Some(Arc::new(crypt_config)), None)
926 let client = BackupWriter::start(
935 let snapshot = BackupDir::new(backup_type, backup_id, backup_time.timestamp());
936 let mut manifest = BackupManifest::new(snapshot);
938 let (catalog, catalog_result_rx) = spawn_catalog_upload(client.clone(), crypt_config.clone())?;
940 for (backup_type, filename, target, size) in upload_list {
942 BackupSpecificationType::CONFIG => {
943 println!("Upload config file '{}' to '{:?}'
as {}
", filename, repo, target);
945 .upload_blob_from_file(&filename, &target, crypt_config.clone(), true)
947 manifest.add_file(target, stats.size, stats.csum)?;
949 BackupSpecificationType::LOGFILE => { // fixme: remove - not needed anymore ?
950 println!("Upload log file '{}' to '{:?}'
as {}
", filename, repo, target);
952 .upload_blob_from_file(&filename, &target, crypt_config.clone(), true)
954 manifest.add_file(target, stats.size, stats.csum)?;
956 BackupSpecificationType::PXAR => {
957 println!("Upload directory '{}' to '{:?}'
as {}
", filename, repo, target);
958 catalog.lock().unwrap().start_directory(std::ffi::CString::new(target.as_str())?.as_c_str())?;
959 let stats = backup_directory(
967 crypt_config.clone(),
969 pattern_list.clone(),
970 entries_max as usize,
972 manifest.add_file(target, stats.size, stats.csum)?;
973 catalog.lock().unwrap().end_directory()?;
975 BackupSpecificationType::IMAGE => {
976 println!("Upload image '{}' to '{:?}'
as {}
", filename, repo, target);
977 let stats = backup_image(
984 crypt_config.clone(),
986 manifest.add_file(target, stats.size, stats.csum)?;
991 // finalize and upload catalog
993 let mutex = Arc::try_unwrap(catalog)
994 .map_err(|_| format_err!("unable to get
catalog (still used
)"))?;
995 let mut catalog = mutex.into_inner().unwrap();
999 drop(catalog); // close upload stream
1001 let stats = catalog_result_rx.await??;
1003 manifest.add_file(CATALOG_NAME.to_owned(), stats.size, stats.csum)?;
1006 if let Some(rsa_encrypted_key) = rsa_encrypted_key {
1007 let target = "rsa
-encrypted
.key
";
1008 println!("Upload RSA encoded key to '{:?}'
as {}
", repo, target);
1010 .upload_blob_from_data(rsa_encrypted_key, target, None, false, false)
1012 manifest.add_file(format!("{}
.blob
", target), stats.size, stats.csum)?;
1014 // openssl rsautl -decrypt -inkey master-private.pem -in rsa-encrypted.key -out t
1016 let mut buffer2 = vec![0u8; rsa.size() as usize];
1017 let pem_data = file_get_contents("master
-private
.pem
")?;
1018 let rsa = openssl::rsa::Rsa::private_key_from_pem(&pem_data)?;
1019 let len = rsa.private_decrypt(&buffer, &mut buffer2, openssl::rsa::Padding::PKCS1)?;
1020 println!("TEST {} {:?}
", len, buffer2);
1024 // create manifest (index.json)
1025 let manifest = manifest.into_json();
1027 println!("Upload index
.json to '{:?}'
", repo);
1028 let manifest = serde_json::to_string_pretty(&manifest)?.into();
1030 .upload_blob_from_data(manifest, MANIFEST_BLOB_NAME, crypt_config.clone(), true, true)
1033 client.finish().await?;
1035 let end_time = Local::now();
1036 let elapsed = end_time.signed_duration_since(start_time);
1037 println!("Duration
: {}
", elapsed);
1039 println!("End Time
: {}
", end_time.to_rfc3339_opts(chrono::SecondsFormat::Secs, false));
1044 fn complete_backup_source(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1046 let mut result = vec![];
1048 let data: Vec<&str> = arg.splitn(2, ':').collect();
1050 if data.len() != 2 {
1051 result.push(String::from("root
.pxar
:/"));
1052 result.push(String::from("etc
.pxar
:/etc
"));
1056 let files = tools::complete_file_name(data[1], param);
1059 result.push(format!("{}
:{}
", data[0], file));
1065 fn dump_image<W: Write>(
1066 client: Arc<BackupReader>,
1067 crypt_config: Option<Arc<CryptConfig>>,
1068 index: FixedIndexReader,
1071 ) -> Result<(), Error> {
1073 let most_used = index.find_most_used_chunks(8);
1075 let mut chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, most_used);
1077 // Note: we avoid using BufferedFixedReader, because that add an additional buffer/copy
1078 // and thus slows down reading. Instead, directly use RemoteChunkReader
1081 let start_time = std::time::Instant::now();
1083 for pos in 0..index.index_count() {
1084 let digest = index.index_digest(pos).unwrap();
1085 let raw_data = chunk_reader.read_chunk(&digest)?;
1086 writer.write_all(&raw_data)?;
1087 bytes += raw_data.len();
1089 let next_per = ((pos+1)*100)/index.index_count();
1090 if per != next_per {
1091 eprintln!("progress {}
% (read {} bytes
, duration {} sec
)",
1092 next_per, bytes, start_time.elapsed().as_secs());
1098 let end_time = std::time::Instant::now();
1099 let elapsed = end_time.duration_since(start_time);
1100 eprintln!("restore image
complete (bytes
={}
, duration
={:.2}s
, speed
={:.2}MB
/s
)",
1102 elapsed.as_secs_f64(),
1103 bytes as f64/(1024.0*1024.0*elapsed.as_secs_f64())
1110 fn parse_archive_type(name: &str) -> (String, ArchiveType) {
1111 if name.ends_with(".didx
") || name.ends_with(".fidx
") || name.ends_with(".blob
") {
1112 (name.into(), archive_type(name).unwrap())
1113 } else if name.ends_with(".pxar
") {
1114 (format!("{}
.didx
", name), ArchiveType::DynamicIndex)
1115 } else if name.ends_with(".img
") {
1116 (format!("{}
.fidx
", name), ArchiveType::FixedIndex)
1118 (format!("{}
.blob
", name), ArchiveType::Blob)
1126 schema: REPO_URL_SCHEMA,
1131 description: "Group
/Snapshot path
.",
1134 description: "Backup archive name
.",
1139 description: r###"Target directory path
. Use '
-' to write to standard output
.
1141 We
do not extraxt '
.pxar' archives when writing to standard output
.
1145 "allow
-existing
-dirs
": {
1147 description: "Do not fail
if directories already exists
.",
1151 schema: KEYFILE_SCHEMA,
1157 /// Restore backup repository.
1158 async fn restore(param: Value) -> Result<Value, Error> {
1159 let repo = extract_repository_from_value(¶m)?;
1161 let verbose = param["verbose
"].as_bool().unwrap_or(false);
1163 let allow_existing_dirs = param["allow
-existing
-dirs
"].as_bool().unwrap_or(false);
1165 let archive_name = tools::required_string_param(¶m, "archive
-name
")?;
1167 let client = connect(repo.host(), repo.user())?;
1169 record_repository(&repo);
1171 let path = tools::required_string_param(¶m, "snapshot
")?;
1173 let (backup_type, backup_id, backup_time) = if path.matches('/').count() == 1 {
1174 let group = BackupGroup::parse(path)?;
1175 api_datastore_latest_snapshot(&client, repo.store(), group).await?
1177 let snapshot = BackupDir::parse(path)?;
1178 (snapshot.group().backup_type().to_owned(), snapshot.group().backup_id().to_owned(), snapshot.backup_time())
1181 let target = tools::required_string_param(¶m, "target
")?;
1182 let target = if target == "-" { None } else { Some(target) };
1184 let keyfile = param["keyfile
"].as_str().map(PathBuf::from);
1186 let crypt_config = match keyfile {
1189 let (key, _) = load_and_decrypt_key(&path, &get_encryption_key_password)?;
1190 Some(Arc::new(CryptConfig::new(key)?))
1194 let client = BackupReader::start(
1196 crypt_config.clone(),
1204 let manifest = client.download_manifest().await?;
1206 let (archive_name, archive_type) = parse_archive_type(archive_name);
1208 if archive_name == MANIFEST_BLOB_NAME {
1209 let backup_index_data = manifest.into_json().to_string();
1210 if let Some(target) = target {
1211 replace_file(target, backup_index_data.as_bytes(), CreateOptions::new())?;
1213 let stdout = std::io::stdout();
1214 let mut writer = stdout.lock();
1215 writer.write_all(backup_index_data.as_bytes())
1216 .map_err(|err| format_err!("unable to pipe data
- {}
", err))?;
1219 } else if archive_type == ArchiveType::Blob {
1221 let mut reader = client.download_blob(&manifest, &archive_name).await?;
1223 if let Some(target) = target {
1224 let mut writer = std::fs::OpenOptions::new()
1229 .map_err(|err| format_err!("unable to create target file {:?}
- {}
", target, err))?;
1230 std::io::copy(&mut reader, &mut writer)?;
1232 let stdout = std::io::stdout();
1233 let mut writer = stdout.lock();
1234 std::io::copy(&mut reader, &mut writer)
1235 .map_err(|err| format_err!("unable to pipe data
- {}
", err))?;
1238 } else if archive_type == ArchiveType::DynamicIndex {
1240 let index = client.download_dynamic_index(&manifest, &archive_name).await?;
1242 let most_used = index.find_most_used_chunks(8);
1244 let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, most_used);
1246 let mut reader = BufferedDynamicReader::new(index, chunk_reader);
1248 if let Some(target) = target {
1250 let feature_flags = pxar::flags::DEFAULT;
1251 let mut decoder = pxar::SequentialDecoder::new(&mut reader, feature_flags);
1252 decoder.set_callback(move |path| {
1254 eprintln!("{:?}
", path);
1258 decoder.set_allow_existing_dirs(allow_existing_dirs);
1260 decoder.restore(Path::new(target), &Vec::new())?;
1262 let mut writer = std::fs::OpenOptions::new()
1264 .open("/dev
/stdout
")
1265 .map_err(|err| format_err!("unable to open
/dev
/stdout
- {}
", err))?;
1267 std::io::copy(&mut reader, &mut writer)
1268 .map_err(|err| format_err!("unable to pipe data
- {}
", err))?;
1270 } else if archive_type == ArchiveType::FixedIndex {
1272 let index = client.download_fixed_index(&manifest, &archive_name).await?;
1274 let mut writer = if let Some(target) = target {
1275 std::fs::OpenOptions::new()
1280 .map_err(|err| format_err!("unable to create target file {:?}
- {}
", target, err))?
1282 std::fs::OpenOptions::new()
1284 .open("/dev
/stdout
")
1285 .map_err(|err| format_err!("unable to open
/dev
/stdout
- {}
", err))?
1288 dump_image(client.clone(), crypt_config.clone(), index, &mut writer, verbose)?;
1298 schema: REPO_URL_SCHEMA,
1303 description: "Group
/Snapshot path
.",
1307 description: "The path to the log file you want to upload
.",
1310 schema: KEYFILE_SCHEMA,
1316 /// Upload backup log file.
1317 async fn upload_log(param: Value) -> Result<Value, Error> {
1319 let logfile = tools::required_string_param(¶m, "logfile
")?;
1320 let repo = extract_repository_from_value(¶m)?;
1322 let snapshot = tools::required_string_param(¶m, "snapshot
")?;
1323 let snapshot = BackupDir::parse(snapshot)?;
1325 let mut client = connect(repo.host(), repo.user())?;
1327 let keyfile = param["keyfile
"].as_str().map(PathBuf::from);
1329 let crypt_config = match keyfile {
1332 let (key, _created) = load_and_decrypt_key(&path, &get_encryption_key_password)?;
1333 let crypt_config = CryptConfig::new(key)?;
1334 Some(Arc::new(crypt_config))
1338 let data = file_get_contents(logfile)?;
1340 let blob = DataBlob::encode(&data, crypt_config.as_ref().map(Arc::as_ref), true)?;
1342 let raw_data = blob.into_inner();
1344 let path = format!("api2
/json
/admin
/datastore
/{}
/upload
-backup
-log
", repo.store());
1347 "backup
-type": snapshot.group().backup_type(),
1348 "backup
-id
": snapshot.group().backup_id(),
1349 "backup
-time
": snapshot.backup_time().timestamp(),
1352 let body = hyper::Body::from(raw_data);
1354 client.upload("application
/octet
-stream
", body, &path, Some(args)).await
1357 const API_METHOD_PRUNE: ApiMethod = ApiMethod::new(
1358 &ApiHandler::Async(&prune),
1360 "Prune a backup repository
.",
1361 &proxmox_backup::add_common_prune_prameters!([
1362 ("dry
-run
", true, &BooleanSchema::new(
1363 "Just show what prune would
do, but
do not delete anything
.")
1365 ("group
", false, &StringSchema::new("Backup group
.").schema()),
1367 ("output
-format
", true, &OUTPUT_FORMAT),
1368 ("repository
", true, &REPO_URL_SCHEMA),
1376 _rpcenv: &'a mut dyn RpcEnvironment,
1377 ) -> proxmox::api::ApiFuture<'a> {
1379 prune_async(param).await
1383 async fn prune_async(mut param: Value) -> Result<Value, Error> {
1384 let repo = extract_repository_from_value(¶m)?;
1386 let mut client = connect(repo.host(), repo.user())?;
1388 let path = format!("api2
/json
/admin
/datastore
/{}
/prune
", repo.store());
1390 let group = tools::required_string_param(¶m, "group
")?;
1391 let group = BackupGroup::parse(group)?;
1393 let output_format = get_output_format(¶m);
1395 param.as_object_mut().unwrap().remove("repository
");
1396 param.as_object_mut().unwrap().remove("group
");
1397 param.as_object_mut().unwrap().remove("output
-format
");
1399 param["backup
-type"] = group.backup_type().into();
1400 param["backup
-id
"] = group.backup_id().into();
1402 let mut result = client.post(&path, Some(param)).await?;
1404 record_repository(&repo);
1406 let render_snapshot_path = |_v: &Value, record: &Value| -> Result<String, Error> {
1407 let item: PruneListItem = serde_json::from_value(record.to_owned())?;
1408 let snapshot = BackupDir::new(item.backup_type, item.backup_id, item.backup_time);
1409 Ok(snapshot.relative_path().to_str().unwrap().to_owned())
1412 let options = default_table_format_options()
1413 .sortby("backup
-type", false)
1414 .sortby("backup
-id
", false)
1415 .sortby("backup
-time
", false)
1416 .column(ColumnConfig::new("backup
-id
").renderer(render_snapshot_path).header("snapshot
"))
1417 .column(ColumnConfig::new("backup
-time
").renderer(tools::format::render_epoch).header("date
"))
1418 .column(ColumnConfig::new("keep
"))
1421 let info = &proxmox_backup::api2::admin::datastore::API_RETURN_SCHEMA_PRUNE;
1423 let mut data = result["data
"].take();
1425 format_and_print_result_full(&mut data, info, &output_format, &options);
1434 schema: REPO_URL_SCHEMA,
1438 schema: OUTPUT_FORMAT,
1444 /// Get repository status.
1445 async fn status(param: Value) -> Result<Value, Error> {
1447 let repo = extract_repository_from_value(¶m)?;
1449 let output_format = get_output_format(¶m);
1451 let client = connect(repo.host(), repo.user())?;
1453 let path = format!("api2
/json
/admin
/datastore
/{}
/status
", repo.store());
1455 let mut result = client.get(&path, None).await?;
1456 let mut data = result["data
"].take();
1458 record_repository(&repo);
1460 let render_total_percentage = |v: &Value, record: &Value| -> Result<String, Error> {
1461 let v = v.as_u64().unwrap();
1462 let total = record["total
"].as_u64().unwrap();
1463 let roundup = total/200;
1464 let per = ((v+roundup)*100)/total;
1465 let info = format!(" ({}
%)", per);
1466 Ok(format!("{} {:>8}
", v, info))
1469 let options = default_table_format_options()
1471 .column(ColumnConfig::new("total
").renderer(render_total_percentage))
1472 .column(ColumnConfig::new("used
").renderer(render_total_percentage))
1473 .column(ColumnConfig::new("avail
").renderer(render_total_percentage));
1475 let schema = &proxmox_backup::api2::admin::datastore::API_RETURN_SCHEMA_STATUS;
1477 format_and_print_result_full(&mut data, schema, &output_format, &options);
1482 // like get, but simply ignore errors and return Null instead
1483 async fn try_get(repo: &BackupRepository, url: &str) -> Value {
1485 let fingerprint = std::env::var(ENV_VAR_PBS_FINGERPRINT).ok();
1486 let password = std::env::var(ENV_VAR_PBS_PASSWORD).ok();
1488 let options = HttpClientOptions::new()
1489 .prefix(Some("proxmox
-backup
".to_string()))
1492 .fingerprint(fingerprint)
1493 .fingerprint_cache(true)
1494 .ticket_cache(true);
1496 let client = match HttpClient::new(repo.host(), repo.user(), options) {
1498 _ => return Value::Null,
1501 let mut resp = match client.get(url, None).await {
1503 _ => return Value::Null,
1506 if let Some(map) = resp.as_object_mut() {
1507 if let Some(data) = map.remove("data
") {
1514 fn complete_backup_group(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1515 proxmox_backup::tools::runtime::main(async { complete_backup_group_do(param).await })
1518 async fn complete_backup_group_do(param: &HashMap<String, String>) -> Vec<String> {
1520 let mut result = vec![];
1522 let repo = match extract_repository_from_map(param) {
1527 let path = format!("api2
/json
/admin
/datastore
/{}
/groups
", repo.store());
1529 let data = try_get(&repo, &path).await;
1531 if let Some(list) = data.as_array() {
1533 if let (Some(backup_id), Some(backup_type)) =
1534 (item["backup
-id
"].as_str(), item["backup
-type"].as_str())
1536 result.push(format!("{}
/{}
", backup_type, backup_id));
1544 fn complete_group_or_snapshot(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1545 proxmox_backup::tools::runtime::main(async { complete_group_or_snapshot_do(arg, param).await })
1548 async fn complete_group_or_snapshot_do(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1550 if arg.matches('/').count() < 2 {
1551 let groups = complete_backup_group_do(param).await;
1552 let mut result = vec![];
1553 for group in groups {
1554 result.push(group.to_string());
1555 result.push(format!("{}
/", group));
1560 complete_backup_snapshot_do(param).await
1563 fn complete_backup_snapshot(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1564 proxmox_backup::tools::runtime::main(async { complete_backup_snapshot_do(param).await })
1567 async fn complete_backup_snapshot_do(param: &HashMap<String, String>) -> Vec<String> {
1569 let mut result = vec![];
1571 let repo = match extract_repository_from_map(param) {
1576 let path = format!("api2
/json
/admin
/datastore
/{}
/snapshots
", repo.store());
1578 let data = try_get(&repo, &path).await;
1580 if let Some(list) = data.as_array() {
1582 if let (Some(backup_id), Some(backup_type), Some(backup_time)) =
1583 (item["backup
-id
"].as_str(), item["backup
-type"].as_str(), item["backup
-time
"].as_i64())
1585 let snapshot = BackupDir::new(backup_type, backup_id, backup_time);
1586 result.push(snapshot.relative_path().to_str().unwrap().to_owned());
1594 fn complete_server_file_name(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1595 proxmox_backup::tools::runtime::main(async { complete_server_file_name_do(param).await })
1598 async fn complete_server_file_name_do(param: &HashMap<String, String>) -> Vec<String> {
1600 let mut result = vec![];
1602 let repo = match extract_repository_from_map(param) {
1607 let snapshot = match param.get("snapshot
") {
1609 match BackupDir::parse(path) {
1617 let query = tools::json_object_to_query(json!({
1618 "backup
-type": snapshot.group().backup_type(),
1619 "backup
-id
": snapshot.group().backup_id(),
1620 "backup
-time
": snapshot.backup_time().timestamp(),
1623 let path = format!("api2
/json
/admin
/datastore
/{}
/files?{}
", repo.store(), query);
1625 let data = try_get(&repo, &path).await;
1627 if let Some(list) = data.as_array() {
1629 if let Some(filename) = item["filename
"].as_str() {
1630 result.push(filename.to_owned());
1638 fn complete_archive_name(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1639 complete_server_file_name(arg, param)
1641 .map(|v| tools::format::strip_server_file_expenstion(&v))
1645 fn complete_pxar_archive_name(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1646 complete_server_file_name(arg, param)
1649 let name = tools::format::strip_server_file_expenstion(&v);
1650 if name.ends_with(".pxar
") {
1659 fn complete_chunk_size(_arg: &str, _param: &HashMap<String, String>) -> Vec<String> {
1661 let mut result = vec![];
1665 result.push(size.to_string());
1667 if size > 4096 { break; }
1673 fn get_encryption_key_password() -> Result<Vec<u8>, Error> {
1675 // fixme: implement other input methods
1677 use std::env::VarError::*;
1678 match std::env::var("PBS_ENCRYPTION_PASSWORD
") {
1679 Ok(p) => return Ok(p.as_bytes().to_vec()),
1680 Err(NotUnicode(_)) => bail!("PBS_ENCRYPTION_PASSWORD contains bad characters
"),
1681 Err(NotPresent) => {
1682 // Try another method
1686 // If we're on a TTY, query the user for a password
1687 if tty::stdin_isatty() {
1688 return Ok(tty::read_password("Encryption Key Password
: ")?);
1691 bail!("no password input mechanism available
");
1697 _rpcenv: &mut dyn RpcEnvironment,
1698 ) -> Result<Value, Error> {
1700 let path = tools::required_string_param(¶m, "path
")?;
1701 let path = PathBuf::from(path);
1703 let kdf = param["kdf
"].as_str().unwrap_or("scrypt
");
1705 let key = proxmox::sys::linux::random_data(32)?;
1707 if kdf == "scrypt
" {
1708 // always read passphrase from tty
1709 if !tty::stdin_isatty() {
1710 bail!("unable to read passphrase
- no tty
");
1713 let password = tty::read_and_verify_password("Encryption Key Password
: ")?;
1715 let key_config = encrypt_key_with_passphrase(&key, &password)?;
1717 store_key_config(&path, false, key_config)?;
1720 } else if kdf == "none
" {
1721 let created = Local.timestamp(Local::now().timestamp(), 0);
1723 store_key_config(&path, false, KeyConfig {
1736 fn master_pubkey_path() -> Result<PathBuf, Error> {
1737 let base = BaseDirectories::with_prefix("proxmox
-backup
")?;
1739 // usually $HOME/.config/proxmox-backup/master-public.pem
1740 let path = base.place_config_file("master
-public
.pem
")?;
1745 fn key_import_master_pubkey(
1748 _rpcenv: &mut dyn RpcEnvironment,
1749 ) -> Result<Value, Error> {
1751 let path = tools::required_string_param(¶m, "path
")?;
1752 let path = PathBuf::from(path);
1754 let pem_data = file_get_contents(&path)?;
1756 if let Err(err) = openssl::pkey::PKey::public_key_from_pem(&pem_data) {
1757 bail!("Unable to decode PEM data
- {}
", err);
1760 let target_path = master_pubkey_path()?;
1762 replace_file(&target_path, &pem_data, CreateOptions::new())?;
1764 println!("Imported public master key to {:?}
", target_path);
1769 fn key_create_master_key(
1772 _rpcenv: &mut dyn RpcEnvironment,
1773 ) -> Result<Value, Error> {
1775 // we need a TTY to query the new password
1776 if !tty::stdin_isatty() {
1777 bail!("unable to create master key
- no tty
");
1780 let rsa = openssl::rsa::Rsa::generate(4096)?;
1781 let pkey = openssl::pkey::PKey::from_rsa(rsa)?;
1784 let password = String::from_utf8(tty::read_and_verify_password("Master Key Password
: ")?)?;
1786 let pub_key: Vec<u8> = pkey.public_key_to_pem()?;
1787 let filename_pub = "master
-public
.pem
";
1788 println!("Writing public master key to {}
", filename_pub);
1789 replace_file(filename_pub, pub_key.as_slice(), CreateOptions::new())?;
1791 let cipher = openssl::symm::Cipher::aes_256_cbc();
1792 let priv_key: Vec<u8> = pkey.private_key_to_pem_pkcs8_passphrase(cipher, password.as_bytes())?;
1794 let filename_priv = "master
-private
.pem
";
1795 println!("Writing private master key to {}
", filename_priv);
1796 replace_file(filename_priv, priv_key.as_slice(), CreateOptions::new())?;
1801 fn key_change_passphrase(
1804 _rpcenv: &mut dyn RpcEnvironment,
1805 ) -> Result<Value, Error> {
1807 let path = tools::required_string_param(¶m, "path
")?;
1808 let path = PathBuf::from(path);
1810 let kdf = param["kdf
"].as_str().unwrap_or("scrypt
");
1812 // we need a TTY to query the new password
1813 if !tty::stdin_isatty() {
1814 bail!("unable to change passphrase
- no tty
");
1817 let (key, created) = load_and_decrypt_key(&path, &get_encryption_key_password)?;
1819 if kdf == "scrypt
" {
1821 let password = tty::read_and_verify_password("New Password
: ")?;
1823 let mut new_key_config = encrypt_key_with_passphrase(&key, &password)?;
1824 new_key_config.created = created; // keep original value
1826 store_key_config(&path, true, new_key_config)?;
1829 } else if kdf == "none
" {
1830 let modified = Local.timestamp(Local::now().timestamp(), 0);
1832 store_key_config(&path, true, KeyConfig {
1834 created, // keep original value
1845 fn key_mgmt_cli() -> CliCommandMap {
1847 const KDF_SCHEMA: Schema =
1848 StringSchema::new("Key derivation function
. Choose 'none' to store the key unecrypted
.")
1849 .format(&ApiStringFormat::Enum(&[
1850 EnumEntry::new("scrypt
", "SCrypt
"),
1851 EnumEntry::new("none
", "Do not encrypt the key
")]))
1856 const API_METHOD_KEY_CREATE: ApiMethod = ApiMethod::new(
1857 &ApiHandler::Sync(&key_create),
1859 "Create a new encryption key
.",
1861 ("path
", false, &StringSchema::new("File system path
.").schema()),
1862 ("kdf
", true, &KDF_SCHEMA),
1867 let key_create_cmd_def = CliCommand::new(&API_METHOD_KEY_CREATE)
1868 .arg_param(&["path
"])
1869 .completion_cb("path
", tools::complete_file_name);
1872 const API_METHOD_KEY_CHANGE_PASSPHRASE: ApiMethod = ApiMethod::new(
1873 &ApiHandler::Sync(&key_change_passphrase),
1875 "Change the passphrase required to decrypt the key
.",
1877 ("path
", false, &StringSchema::new("File system path
.").schema()),
1878 ("kdf
", true, &KDF_SCHEMA),
1883 let key_change_passphrase_cmd_def = CliCommand::new(&API_METHOD_KEY_CHANGE_PASSPHRASE)
1884 .arg_param(&["path
"])
1885 .completion_cb("path
", tools::complete_file_name);
1887 const API_METHOD_KEY_CREATE_MASTER_KEY: ApiMethod = ApiMethod::new(
1888 &ApiHandler::Sync(&key_create_master_key),
1889 &ObjectSchema::new("Create a new
4096 bit RSA master
pub/priv key pair
.", &[])
1892 let key_create_master_key_cmd_def = CliCommand::new(&API_METHOD_KEY_CREATE_MASTER_KEY);
1895 const API_METHOD_KEY_IMPORT_MASTER_PUBKEY: ApiMethod = ApiMethod::new(
1896 &ApiHandler::Sync(&key_import_master_pubkey),
1898 "Import a new RSA public key and
use it
as master key
. The key is expected to be
in '
.pem' format
.",
1899 &sorted!([ ("path
", false, &StringSchema::new("File system path
.").schema()) ]),
1903 let key_import_master_pubkey_cmd_def = CliCommand::new(&API_METHOD_KEY_IMPORT_MASTER_PUBKEY)
1904 .arg_param(&["path
"])
1905 .completion_cb("path
", tools::complete_file_name);
1907 CliCommandMap::new()
1908 .insert("create
", key_create_cmd_def)
1909 .insert("create
-master
-key
", key_create_master_key_cmd_def)
1910 .insert("import
-master
-pubkey
", key_import_master_pubkey_cmd_def)
1911 .insert("change
-passphrase
", key_change_passphrase_cmd_def)
1917 _rpcenv: &mut dyn RpcEnvironment,
1918 ) -> Result<Value, Error> {
1919 let verbose = param["verbose
"].as_bool().unwrap_or(false);
1921 // This will stay in foreground with debug output enabled as None is
1922 // passed for the RawFd.
1923 return proxmox_backup::tools::runtime::main(mount_do(param, None));
1926 // Process should be deamonized.
1927 // Make sure to fork before the async runtime is instantiated to avoid troubles.
1930 Ok(ForkResult::Parent { .. }) => {
1931 nix::unistd::close(pipe.1).unwrap();
1932 // Blocks the parent process until we are ready to go in the child
1933 let _res = nix::unistd::read(pipe.0, &mut [0]).unwrap();
1936 Ok(ForkResult::Child) => {
1937 nix::unistd::close(pipe.0).unwrap();
1938 nix::unistd::setsid().unwrap();
1939 proxmox_backup::tools::runtime::main(mount_do(param, Some(pipe.1)))
1941 Err(_) => bail!("failed to daemonize process
"),
1945 async fn mount_do(param: Value, pipe: Option<RawFd>) -> Result<Value, Error> {
1946 let repo = extract_repository_from_value(¶m)?;
1947 let archive_name = tools::required_string_param(¶m, "archive
-name
")?;
1948 let target = tools::required_string_param(¶m, "target
")?;
1949 let client = connect(repo.host(), repo.user())?;
1951 record_repository(&repo);
1953 let path = tools::required_string_param(¶m, "snapshot
")?;
1954 let (backup_type, backup_id, backup_time) = if path.matches('/').count() == 1 {
1955 let group = BackupGroup::parse(path)?;
1956 api_datastore_latest_snapshot(&client, repo.store(), group).await?
1958 let snapshot = BackupDir::parse(path)?;
1959 (snapshot.group().backup_type().to_owned(), snapshot.group().backup_id().to_owned(), snapshot.backup_time())
1962 let keyfile = param["keyfile
"].as_str().map(PathBuf::from);
1963 let crypt_config = match keyfile {
1966 let (key, _) = load_and_decrypt_key(&path, &get_encryption_key_password)?;
1967 Some(Arc::new(CryptConfig::new(key)?))
1971 let server_archive_name = if archive_name.ends_with(".pxar
") {
1972 format!("{}
.didx
", archive_name)
1974 bail!("Can only mount pxar archives
.");
1977 let client = BackupReader::start(
1979 crypt_config.clone(),
1987 let manifest = client.download_manifest().await?;
1989 if server_archive_name.ends_with(".didx
") {
1990 let index = client.download_dynamic_index(&manifest, &server_archive_name).await?;
1991 let most_used = index.find_most_used_chunks(8);
1992 let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, most_used);
1993 let reader = BufferedDynamicReader::new(index, chunk_reader);
1994 let decoder = pxar::Decoder::new(reader)?;
1995 let options = OsStr::new("ro
,default_permissions
");
1996 let mut session = pxar::fuse::Session::new(decoder, &options, pipe.is_none())
1997 .map_err(|err| format_err!("pxar mount failed
: {}
", err))?;
1999 // Mount the session but not call fuse deamonize as this will cause
2000 // issues with the runtime after the fork
2001 let deamonize = false;
2002 session.mount(&Path::new(target), deamonize)?;
2004 if let Some(pipe) = pipe {
2005 nix::unistd::chdir(Path::new("/")).unwrap();
2006 // Finish creation of daemon by redirecting filedescriptors.
2007 let nullfd = nix::fcntl::open(
2009 nix::fcntl::OFlag::O_RDWR,
2010 nix::sys::stat::Mode::empty(),
2012 nix::unistd::dup2(nullfd, 0).unwrap();
2013 nix::unistd::dup2(nullfd, 1).unwrap();
2014 nix::unistd::dup2(nullfd, 2).unwrap();
2016 nix::unistd::close(nullfd).unwrap();
2018 // Signal the parent process that we are done with the setup and it can
2020 nix::unistd::write(pipe, &[0u8])?;
2021 nix::unistd::close(pipe).unwrap();
2024 let multithreaded = true;
2025 session.run_loop(multithreaded)?;
2027 bail!("unknown archive file
extension (expected
.pxar
)");
2038 description: "Group
/Snapshot path
.",
2042 description: "Backup archive name
.",
2046 schema: REPO_URL_SCHEMA,
2051 description: "Path to encryption key
.",
2056 /// Shell to interactively inspect and restore snapshots.
2057 async fn catalog_shell(param: Value) -> Result<(), Error> {
2058 let repo = extract_repository_from_value(¶m)?;
2059 let client = connect(repo.host(), repo.user())?;
2060 let path = tools::required_string_param(¶m, "snapshot
")?;
2061 let archive_name = tools::required_string_param(¶m, "archive
-name
")?;
2063 let (backup_type, backup_id, backup_time) = if path.matches('/').count() == 1 {
2064 let group = BackupGroup::parse(path)?;
2065 api_datastore_latest_snapshot(&client, repo.store(), group).await?
2067 let snapshot = BackupDir::parse(path)?;
2068 (snapshot.group().backup_type().to_owned(), snapshot.group().backup_id().to_owned(), snapshot.backup_time())
2071 let keyfile = param["keyfile
"].as_str().map(|p| PathBuf::from(p));
2072 let crypt_config = match keyfile {
2075 let (key, _) = load_and_decrypt_key(&path, &get_encryption_key_password)?;
2076 Some(Arc::new(CryptConfig::new(key)?))
2080 let server_archive_name = if archive_name.ends_with(".pxar
") {
2081 format!("{}
.didx
", archive_name)
2083 bail!("Can only mount pxar archives
.");
2086 let client = BackupReader::start(
2088 crypt_config.clone(),
2096 let tmpfile = std::fs::OpenOptions::new()
2099 .custom_flags(libc::O_TMPFILE)
2102 let manifest = client.download_manifest().await?;
2104 let index = client.download_dynamic_index(&manifest, &server_archive_name).await?;
2105 let most_used = index.find_most_used_chunks(8);
2106 let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config.clone(), most_used);
2107 let reader = BufferedDynamicReader::new(index, chunk_reader);
2108 let mut decoder = pxar::Decoder::new(reader)?;
2109 decoder.set_callback(|path| {
2110 println!("{:?}
", path);
2114 let tmpfile = client.download(CATALOG_NAME, tmpfile).await?;
2115 let index = DynamicIndexReader::new(tmpfile)
2116 .map_err(|err| format_err!("unable to read catalog index
- {}
", err))?;
2118 // Note: do not use values stored in index (not trusted) - instead, computed them again
2119 let (csum, size) = index.compute_csum();
2120 manifest.verify_file(CATALOG_NAME, &csum, size)?;
2122 let most_used = index.find_most_used_chunks(8);
2123 let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, most_used);
2124 let mut reader = BufferedDynamicReader::new(index, chunk_reader);
2125 let mut catalogfile = std::fs::OpenOptions::new()
2128 .custom_flags(libc::O_TMPFILE)
2131 std::io::copy(&mut reader, &mut catalogfile)
2132 .map_err(|err| format_err!("unable to download catalog
- {}
", err))?;
2134 catalogfile.seek(SeekFrom::Start(0))?;
2135 let catalog_reader = CatalogReader::new(catalogfile);
2136 let state = Shell::new(
2138 &server_archive_name,
2142 println!("Starting interactive shell
");
2145 record_repository(&repo);
2150 fn catalog_mgmt_cli() -> CliCommandMap {
2151 let catalog_shell_cmd_def = CliCommand::new(&API_METHOD_CATALOG_SHELL)
2152 .arg_param(&["snapshot
", "archive
-name
"])
2153 .completion_cb("repository
", complete_repository)
2154 .completion_cb("archive
-name
", complete_pxar_archive_name)
2155 .completion_cb("snapshot
", complete_group_or_snapshot);
2157 let catalog_dump_cmd_def = CliCommand::new(&API_METHOD_DUMP_CATALOG)
2158 .arg_param(&["snapshot
"])
2159 .completion_cb("repository
", complete_repository)
2160 .completion_cb("snapshot
", complete_backup_snapshot);
2162 CliCommandMap::new()
2163 .insert("dump
", catalog_dump_cmd_def)
2164 .insert("shell
", catalog_shell_cmd_def)
2171 schema: REPO_URL_SCHEMA,
2175 description: "The maximal number of tasks to list
.",
2183 schema: OUTPUT_FORMAT,
2188 description: "Also list stopped tasks
.",
2194 /// List running server tasks for this repo user
2195 async fn task_list(param: Value) -> Result<Value, Error> {
2197 let output_format = get_output_format(¶m);
2199 let repo = extract_repository_from_value(¶m)?;
2200 let client = connect(repo.host(), repo.user())?;
2202 let limit = param["limit
"].as_u64().unwrap_or(50) as usize;
2203 let running = !param["all
"].as_bool().unwrap_or(false);
2209 "userfilter
": repo.user(),
2210 "store
": repo.store(),
2213 let mut result = client.get("api2
/json
/nodes
/localhost
/tasks
", Some(args)).await?;
2214 let mut data = result["data
"].take();
2216 let schema = &proxmox_backup::api2::node::tasks::API_RETURN_SCHEMA_LIST_TASKS;
2218 let options = default_table_format_options()
2219 .column(ColumnConfig::new("starttime
").right_align(false).renderer(tools::format::render_epoch))
2220 .column(ColumnConfig::new("endtime
").right_align(false).renderer(tools::format::render_epoch))
2221 .column(ColumnConfig::new("upid
"))
2222 .column(ColumnConfig::new("status
").renderer(tools::format::render_task_status));
2224 format_and_print_result_full(&mut data, schema, &output_format, &options);
2233 schema: REPO_URL_SCHEMA,
2237 schema: UPID_SCHEMA,
2242 /// Display the task log.
2243 async fn task_log(param: Value) -> Result<Value, Error> {
2245 let repo = extract_repository_from_value(¶m)?;
2246 let upid = tools::required_string_param(¶m, "upid
")?;
2248 let client = connect(repo.host(), repo.user())?;
2250 display_task_log(client, upid, true).await?;
2259 schema: REPO_URL_SCHEMA,
2263 schema: UPID_SCHEMA,
2268 /// Try to stop a specific task.
2269 async fn task_stop(param: Value) -> Result<Value, Error> {
2271 let repo = extract_repository_from_value(¶m)?;
2272 let upid_str = tools::required_string_param(¶m, "upid
")?;
2274 let mut client = connect(repo.host(), repo.user())?;
2276 let path = format!("api2
/json
/nodes
/localhost
/tasks
/{}
", upid_str);
2277 let _ = client.delete(&path, None).await?;
2282 fn task_mgmt_cli() -> CliCommandMap {
2284 let task_list_cmd_def = CliCommand::new(&API_METHOD_TASK_LIST)
2285 .completion_cb("repository
", complete_repository);
2287 let task_log_cmd_def = CliCommand::new(&API_METHOD_TASK_LOG)
2288 .arg_param(&["upid
"]);
2290 let task_stop_cmd_def = CliCommand::new(&API_METHOD_TASK_STOP)
2291 .arg_param(&["upid
"]);
2293 CliCommandMap::new()
2294 .insert("log
", task_log_cmd_def)
2295 .insert("list
", task_list_cmd_def)
2296 .insert("stop
", task_stop_cmd_def)
2301 let backup_cmd_def = CliCommand::new(&API_METHOD_CREATE_BACKUP)
2302 .arg_param(&["backupspec
"])
2303 .completion_cb("repository
", complete_repository)
2304 .completion_cb("backupspec
", complete_backup_source)
2305 .completion_cb("keyfile
", tools::complete_file_name)
2306 .completion_cb("chunk
-size
", complete_chunk_size);
2308 let upload_log_cmd_def = CliCommand::new(&API_METHOD_UPLOAD_LOG)
2309 .arg_param(&["snapshot
", "logfile
"])
2310 .completion_cb("snapshot
", complete_backup_snapshot)
2311 .completion_cb("logfile
", tools::complete_file_name)
2312 .completion_cb("keyfile
", tools::complete_file_name)
2313 .completion_cb("repository
", complete_repository);
2315 let list_cmd_def = CliCommand::new(&API_METHOD_LIST_BACKUP_GROUPS)
2316 .completion_cb("repository
", complete_repository);
2318 let snapshots_cmd_def = CliCommand::new(&API_METHOD_LIST_SNAPSHOTS)
2319 .arg_param(&["group
"])
2320 .completion_cb("group
", complete_backup_group)
2321 .completion_cb("repository
", complete_repository);
2323 let forget_cmd_def = CliCommand::new(&API_METHOD_FORGET_SNAPSHOTS)
2324 .arg_param(&["snapshot
"])
2325 .completion_cb("repository
", complete_repository)
2326 .completion_cb("snapshot
", complete_backup_snapshot);
2328 let garbage_collect_cmd_def = CliCommand::new(&API_METHOD_START_GARBAGE_COLLECTION)
2329 .completion_cb("repository
", complete_repository);
2331 let restore_cmd_def = CliCommand::new(&API_METHOD_RESTORE)
2332 .arg_param(&["snapshot
", "archive
-name
", "target
"])
2333 .completion_cb("repository
", complete_repository)
2334 .completion_cb("snapshot
", complete_group_or_snapshot)
2335 .completion_cb("archive
-name
", complete_archive_name)
2336 .completion_cb("target
", tools::complete_file_name);
2338 let files_cmd_def = CliCommand::new(&API_METHOD_LIST_SNAPSHOT_FILES)
2339 .arg_param(&["snapshot
"])
2340 .completion_cb("repository
", complete_repository)
2341 .completion_cb("snapshot
", complete_backup_snapshot);
2343 let prune_cmd_def = CliCommand::new(&API_METHOD_PRUNE)
2344 .arg_param(&["group
"])
2345 .completion_cb("group
", complete_backup_group)
2346 .completion_cb("repository
", complete_repository);
2348 let status_cmd_def = CliCommand::new(&API_METHOD_STATUS)
2349 .completion_cb("repository
", complete_repository);
2351 let login_cmd_def = CliCommand::new(&API_METHOD_API_LOGIN)
2352 .completion_cb("repository
", complete_repository);
2354 let logout_cmd_def = CliCommand::new(&API_METHOD_API_LOGOUT)
2355 .completion_cb("repository
", complete_repository);
2358 const API_METHOD_MOUNT: ApiMethod = ApiMethod::new(
2359 &ApiHandler::Sync(&mount),
2361 "Mount pxar archive
.",
2363 ("snapshot
", false, &StringSchema::new("Group
/Snapshot path
.").schema()),
2364 ("archive
-name
", false, &StringSchema::new("Backup archive name
.").schema()),
2365 ("target
", false, &StringSchema::new("Target directory path
.").schema()),
2366 ("repository
", true, &REPO_URL_SCHEMA),
2367 ("keyfile
", true, &StringSchema::new("Path to encryption key
.").schema()),
2368 ("verbose
", true, &BooleanSchema::new("Verbose output
.").default(false).schema()),
2373 let mount_cmd_def = CliCommand::new(&API_METHOD_MOUNT)
2374 .arg_param(&["snapshot
", "archive
-name
", "target
"])
2375 .completion_cb("repository
", complete_repository)
2376 .completion_cb("snapshot
", complete_group_or_snapshot)
2377 .completion_cb("archive
-name
", complete_pxar_archive_name)
2378 .completion_cb("target
", tools::complete_file_name);
2381 let cmd_def = CliCommandMap::new()
2382 .insert("backup
", backup_cmd_def)
2383 .insert("upload
-log
", upload_log_cmd_def)
2384 .insert("forget
", forget_cmd_def)
2385 .insert("garbage
-collect
", garbage_collect_cmd_def)
2386 .insert("list
", list_cmd_def)
2387 .insert("login
", login_cmd_def)
2388 .insert("logout
", logout_cmd_def)
2389 .insert("prune
", prune_cmd_def)
2390 .insert("restore
", restore_cmd_def)
2391 .insert("snapshots
", snapshots_cmd_def)
2392 .insert("files
", files_cmd_def)
2393 .insert("status
", status_cmd_def)
2394 .insert("key
", key_mgmt_cli())
2395 .insert("mount
", mount_cmd_def)
2396 .insert("catalog
", catalog_mgmt_cli())
2397 .insert("task
", task_mgmt_cli());
2399 let rpcenv = CliEnvironment::new();
2400 run_cli_command(cmd_def, rpcenv, Some(|future| {
2401 proxmox_backup::tools::runtime::main(future)