]> git.proxmox.com Git - pve-common.git/blame - src/PVE/PBSClient.pm
PBSClient: add file_restore_extract function
[pve-common.git] / src / PVE / PBSClient.pm
CommitLineData
0904f388 1package PVE::PBSClient;
243568ca 2# utility functions for interaction with Proxmox Backup client CLI executable
0904f388
SI
3
4use strict;
5use warnings;
243568ca 6
0904f388 7use Fcntl qw(F_GETFD F_SETFD FD_CLOEXEC);
77e402f0 8use File::Temp qw(tempdir);
0904f388
SI
9use IO::File;
10use JSON;
77e402f0 11use POSIX qw(mkfifo strftime ENOENT);
0904f388 12
0904f388 13use PVE::JSONSchema qw(get_standard_option);
5640c3db
DC
14use PVE::Tools qw(run_command file_set_contents file_get_contents file_read_firstline $IPV6RE);
15
16# returns a repository string suitable for proxmox-backup-client, pbs-restore, etc.
17# $scfg must have the following structure:
18# {
19# datastore
20# server
21# port (optional defaults to 8007)
22# username (optional defaults to 'root@pam')
23# }
24sub get_repository {
25 my ($scfg) = @_;
26
27 my $server = $scfg->{server};
28 die "no server given\n" if !defined($server);
29
30 $server = "[$server]" if $server =~ /^$IPV6RE$/;
31
32 if (my $port = $scfg->{port}) {
33 $server .= ":$port" if $port != 8007;
34 }
35
36 my $datastore = $scfg->{datastore};
37 die "no datastore given\n" if !defined($datastore);
38
39 my $username = $scfg->{username} // 'root@pam';
40
41 return "$username\@$server:$datastore";
42}
0904f388
SI
43
44sub new {
45 my ($class, $scfg, $storeid, $sdir) = @_;
46
47 die "no section config provided\n" if ref($scfg) eq '';
48 die "undefined store id\n" if !defined($storeid);
49
50 my $secret_dir = $sdir // '/etc/pve/priv/storage';
51
243568ca
TL
52 my $self = bless {
53 scfg => $scfg,
54 storeid => $storeid,
55 secret_dir => $secret_dir
56 }, $class;
57 return $self;
0904f388
SI
58}
59
60my sub password_file_name {
61 my ($self) = @_;
62
63 return "$self->{secret_dir}/$self->{storeid}.pw";
64}
65
66sub set_password {
67 my ($self, $password) = @_;
68
69a3a585 69 my $pwfile = password_file_name($self);
0904f388
SI
70 mkdir $self->{secret_dir};
71
72 PVE::Tools::file_set_contents($pwfile, "$password\n", 0600);
73};
74
75sub delete_password {
76 my ($self) = @_;
77
69a3a585 78 my $pwfile = password_file_name($self);
0904f388 79
69a3a585 80 unlink $pwfile or die "deleting password file failed - $!\n";
0904f388
SI
81};
82
83sub get_password {
84 my ($self) = @_;
85
69a3a585 86 my $pwfile = password_file_name($self);
0904f388
SI
87
88 return PVE::Tools::file_read_firstline($pwfile);
89}
90
91sub encryption_key_file_name {
92 my ($self) = @_;
93
94 return "$self->{secret_dir}/$self->{storeid}.enc";
95};
96
97sub set_encryption_key {
98 my ($self, $key) = @_;
99
243568ca 100 my $encfile = $self->encryption_key_file_name();
0904f388
SI
101 mkdir $self->{secret_dir};
102
103 PVE::Tools::file_set_contents($encfile, "$key\n", 0600);
104};
105
106sub delete_encryption_key {
107 my ($self) = @_;
108
243568ca 109 my $encfile = $self->encryption_key_file_name();
0904f388
SI
110
111 if (!unlink $encfile) {
112 return if $! == ENOENT;
113 die "failed to delete encryption key! $!\n";
114 }
115};
116
117# Returns a file handle if there is an encryption key, or `undef` if there is not. Dies on error.
118my sub open_encryption_key {
119 my ($self) = @_;
120
243568ca 121 my $encryption_key_file = $self->encryption_key_file_name();
0904f388
SI
122
123 my $keyfd;
124 if (!open($keyfd, '<', $encryption_key_file)) {
125 return undef if $! == ENOENT;
126 die "failed to open encryption key: $encryption_key_file: $!\n";
127 }
128
129 return $keyfd;
130}
131
132my $USE_CRYPT_PARAMS = {
133 backup => 1,
134 restore => 1,
135 'upload-log' => 1,
136};
137
138my sub do_raw_client_cmd {
139 my ($self, $client_cmd, $param, %opts) = @_;
140
141 my $use_crypto = $USE_CRYPT_PARAMS->{$client_cmd};
142
b15abdfe
SR
143 my $client_exe = (delete $opts{binary}) || 'proxmox-backup-client';
144 $client_exe = "/usr/bin/$client_exe";
9f727e55 145 die "executable not found '$client_exe'! proxmox-backup-client or proxmox-backup-file-restore not installed?\n"
0904f388
SI
146 if ! -x $client_exe;
147
148 my $scfg = $self->{scfg};
5640c3db 149 my $repo = get_repository($scfg);
0904f388
SI
150
151 my $userns_cmd = delete $opts{userns_cmd};
152
153 my $cmd = [];
154
155 push @$cmd, @$userns_cmd if defined($userns_cmd);
156
157 push @$cmd, $client_exe, $client_cmd;
158
159 # This must live in the top scope to not get closed before the `run_command`
160 my $keyfd;
161 if ($use_crypto) {
69a3a585 162 if (defined($keyfd = open_encryption_key($self))) {
0904f388
SI
163 my $flags = fcntl($keyfd, F_GETFD, 0)
164 // die "failed to get file descriptor flags: $!\n";
165 fcntl($keyfd, F_SETFD, $flags & ~FD_CLOEXEC)
166 or die "failed to remove FD_CLOEXEC from encryption key file descriptor\n";
167 push @$cmd, '--crypt-mode=encrypt', '--keyfd='.fileno($keyfd);
168 } else {
169 push @$cmd, '--crypt-mode=none';
170 }
171 }
172
173 push @$cmd, @$param if defined($param);
174
5640c3db 175 push @$cmd, "--repository", $repo;
0904f388 176
243568ca 177 local $ENV{PBS_PASSWORD} = $self->get_password();
0904f388
SI
178
179 local $ENV{PBS_FINGERPRINT} = $scfg->{fingerprint};
180
181 # no ascii-art on task logs
182 local $ENV{PROXMOX_OUTPUT_NO_BORDER} = 1;
183 local $ENV{PROXMOX_OUTPUT_NO_HEADER} = 1;
184
185 if (my $logfunc = $opts{logfunc}) {
186 $logfunc->("run: " . join(' ', @$cmd));
187 }
188
189 run_command($cmd, %opts);
190}
191
192my sub run_raw_client_cmd {
193 my ($self, $client_cmd, $param, %opts) = @_;
69a3a585 194 return do_raw_client_cmd($self, $client_cmd, $param, %opts);
0904f388
SI
195}
196
197my sub run_client_cmd {
b15abdfe 198 my ($self, $client_cmd, $param, $no_output, $binary) = @_;
0904f388
SI
199
200 my $json_str = '';
201 my $outfunc = sub { $json_str .= "$_[0]\n" };
202
b15abdfe
SR
203 $binary //= 'proxmox-backup-client';
204
0904f388
SI
205 $param = [] if !defined($param);
206 $param = [ $param ] if !ref($param);
207
208 $param = [@$param, '--output-format=json'] if !$no_output;
209
69a3a585 210 do_raw_client_cmd(
b15abdfe
SR
211 $self,
212 $client_cmd,
213 $param,
214 outfunc => $outfunc,
215 errmsg => "$binary failed",
216 binary => $binary,
243568ca 217 );
0904f388
SI
218
219 return undef if $no_output;
220
221 my $res = decode_json($json_str);
222
223 return $res;
224}
225
226sub autogen_encryption_key {
227 my ($self) = @_;
243568ca 228 my $encfile = $self->encryption_key_file_name();
0cc6c7e0
TL
229 run_command(
230 ['proxmox-backup-client', 'key', 'create', '--kdf', 'none', $encfile],
231 errmsg => 'failed to create encryption key'
232 );
233 return file_get_contents($encfile);
0904f388
SI
234};
235
2113c7e8 236# lists all snapshots, optionally limited to a specific group
0904f388 237sub get_snapshots {
2113c7e8 238 my ($self, $group) = @_;
0904f388
SI
239
240 my $param = [];
2113c7e8 241 push @$param, $group if defined($group);
0904f388 242
69a3a585 243 return run_client_cmd($self, "snapshots", $param);
0904f388
SI
244};
245
6674eb1e
TL
246# create a new PXAR backup of a FS directory tree - doesn't cross FS boundary
247# by default.
248sub backup_fs_tree {
249 my ($self, $root, $id, $pxarname, $cmd_opts) = @_;
0904f388 250
0904f388 251 die "backup-id not provided\n" if !defined($id);
6674eb1e 252 die "backup root dir not provided\n" if !defined($root);
0904f388 253 die "archive name not provided\n" if !defined($pxarname);
0904f388 254
ad6b3237
TL
255 my $param = [
256 "$pxarname.pxar:$root",
6674eb1e 257 '--backup-type', 'host',
ad6b3237
TL
258 '--backup-id', $id,
259 ];
0904f388 260
6674eb1e
TL
261 $cmd_opts //= {};
262
263 return run_raw_client_cmd($self, 'backup', $param, %$cmd_opts);
0904f388
SI
264};
265
266sub restore_pxar {
8b88b2f6 267 my ($self, $snapshot, $pxarname, $target, $cmd_opts) = @_;
0904f388 268
0904f388 269 die "snapshot not provided\n" if !defined($snapshot);
0904f388 270 die "archive name not provided\n" if !defined($pxarname);
0904f388 271 die "restore-target not provided\n" if !defined($target);
0904f388 272
ad6b3237
TL
273 my $param = [
274 "$snapshot",
275 "$pxarname.pxar",
276 "$target",
277 "--allow-existing-dirs", 0,
278 ];
8b88b2f6 279 $cmd_opts //= {};
0904f388 280
69a3a585 281 return run_raw_client_cmd($self, 'restore', $param, %$cmd_opts);
0904f388
SI
282};
283
284sub forget_snapshot {
285 my ($self, $snapshot) = @_;
286
287 die "snapshot not provided\n" if !defined($snapshot);
288
69a3a585 289 return run_raw_client_cmd($self, 'forget', ["$snapshot"]);
0904f388
SI
290};
291
292sub prune_group {
293 my ($self, $opts, $prune_opts, $group) = @_;
294
295 die "group not provided\n" if !defined($group);
296
297 # do nothing if no keep options specified for remote
298 return [] if scalar(keys %$prune_opts) == 0;
299
300 my $param = [];
301
302 push @$param, "--quiet";
303
304 if (defined($opts->{'dry-run'}) && $opts->{'dry-run'}) {
305 push @$param, "--dry-run", $opts->{'dry-run'};
306 }
307
308 foreach my $keep_opt (keys %$prune_opts) {
309 push @$param, "--$keep_opt", $prune_opts->{$keep_opt};
310 }
311 push @$param, "$group";
312
69a3a585 313 return run_client_cmd($self, 'prune', $param);
0904f388
SI
314};
315
316sub status {
317 my ($self) = @_;
318
319 my $total = 0;
320 my $free = 0;
321 my $used = 0;
322 my $active = 0;
323
324 eval {
69a3a585 325 my $res = run_client_cmd($self, "status");
0904f388
SI
326
327 $active = 1;
328 $total = $res->{total};
329 $used = $res->{used};
330 $free = $res->{avail};
331 };
332 if (my $err = $@) {
333 warn $err;
334 }
335
336 return ($total, $free, $used, $active);
337};
338
67252649
SR
339sub file_restore_list {
340 my ($self, $snapshot, $filepath, $base64) = @_;
341 return run_client_cmd(
342 $self,
343 "list",
344 [ $snapshot, $filepath, "--base64", $base64 ? 1 : 0 ],
345 0,
346 "proxmox-file-restore",
347 );
348}
349
77e402f0
SR
350# call sync from API, returns a fifo path for streaming data to clients,
351# pass it to file_restore_extract to start transfering data
352sub file_restore_extract_prepare {
353 my ($self) = @_;
354
355 my $tmpdir = tempdir();
356 mkfifo("$tmpdir/fifo", 0600)
357 or die "creating file download fifo '$tmpdir/fifo' failed: $!\n";
358
359 # allow reading data for proxy user
360 my $wwwid = getpwnam('www-data') ||
361 die "getpwnam failed";
362 chown $wwwid, -1, "$tmpdir"
363 or die "changing permission on fifo dir '$tmpdir' failed: $!\n";
364 chown $wwwid, -1, "$tmpdir/fifo"
365 or die "changing permission on fifo '$tmpdir/fifo' failed: $!\n";
366
367 return "$tmpdir/fifo";
368}
369
370# this blocks while data is transfered, call this from a background worker
371sub file_restore_extract {
372 my ($self, $output_file, $snapshot, $filepath, $base64) = @_;
373
374 my $ret = eval {
375 local $SIG{ALRM} = sub { die "got timeout\n" };
376 alarm(30);
377 sysopen(my $fh, "$output_file", O_WRONLY)
378 or die "open target '$output_file' for writing failed: $!\n";
379 alarm(0);
380
381 my $fn = fileno($fh);
382 my $errfunc = sub { print $_[0], "\n"; };
383
384 return run_raw_client_cmd(
385 $self,
386 "extract",
387 [ $snapshot, $filepath, "-", "--base64", $base64 ? 1 : 0 ],
388 binary => "proxmox-file-restore",
389 errfunc => $errfunc,
390 output => ">&$fn",
391 );
392 };
393 my $err = $@;
394
395 unlink($output_file);
396 $output_file =~ s/fifo$//;
397 rmdir($output_file) if -d $output_file;
398
399 die "file restore task failed: $err" if $err;
400 return $ret;
401}
402
0904f388 4031;