-
Notifications
You must be signed in to change notification settings - Fork 2
/
pve_backup_usb.sh
executable file
·1349 lines (1202 loc) · 50 KB
/
pve_backup_usb.sh
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env bash
################################################################################
# Script to mirror local Proxmox PVE dump backups to encrypted external USB
# drives, including proper logging and optional email notifications.
#
# Repository:
# https://github.com/foundata/proxmox-pve-backup-usb
#
# Further information:
# https://github.com/foundata/proxmox-pve-backup-usb/blob/main/README.md
#
# SPDX-License-Identifier: Apache-2.0
# SPDX-FileCopyrightText: foundata GmbH <https://foundata.com>
################################################################################
################################################################################
# Miscellaneous constants and global values
################################################################################
# version of the script
readonly version='1.4.0'
################################################################################
# Environment
################################################################################
PATH='/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin'
LANG=en_US.UTF-8
LC_ALL="en_US.UTF-8"
set -u
################################################################################
# Command line arguments
################################################################################
# init
opt_backupcfg_list='' # -b
opt_checksums='0' # -c
opt_luks_targets_list='' # -d
opt_email_to='' # -e
opt_email_from='' # -f
opt_email_cc='' # -g
opt_continue_on_backuperror='0' # -j
opt_cryptsetup_keyfile_path='' # -k
opt_target_mappername='' # -l
opt_quiet='0' # -q
opt_source_paths_pvedumps_list='' # -s
opt_backup_user='' # -u
opt_show_version='0' # -v
# parse options
opt=''
OPTIND='1'
while getopts ':b:cd:e:f:g:hjk:l:qs:u:v' opt
do
case "${opt}" in
# backup config
'b')
opt_backupcfg_list="${OPTARG}"
if ! printf '%s' "${opt_backupcfg_list}" | grep -E -q -e "^[0-9][0-9:,]*$"
then
opt_backupcfg_list=''
printf '%s: Invalid value for "%s", ignoring it.\n' "$(basename "${0}")" "${opt}" 1>&2
exit 2
fi
;;
# checksums flag
'c')
opt_checksums='1'
;;
# list of disk labels or UUIDs
'd')
opt_luks_targets_list="${OPTARG}"
if [ -z "${opt_luks_targets_list}" ]
then
opt_luks_targets_list=''
printf '%s: Invalid value for "%s", ignoring it.\n' "$(basename "${0}")" "${opt}" 1>&2
exit 2
fi
;;
# email to
'e')
opt_email_to="${OPTARG}"
if ! printf '%s' "${opt_email_to}" | grep -E -q -e "^.+@.+$"
then
opt_email_to=''
printf '%s: Invalid value for "%s", ignoring it.\n' "$(basename "${0}")" "${opt}" 1>&2
exit 2
fi
;;
# email from
'f')
opt_email_from="${OPTARG}"
if ! printf '%s' "${opt_email_from}" | grep -E -q -e "^.+@.+$"
then
opt_email_from=''
printf '%s: Invalid value for "%s", ignoring it.\n' "$(basename "${0}")" "${opt}" 1>&2
exit 2
fi
;;
# email cc (CSV list)
'g')
opt_email_cc="${OPTARG}"
if ! printf '%s' "${opt_email_cc}" | grep -E -q -e "^.+@.+$" # works for CSV, too
then
opt_email_cc=''
printf '%s: Invalid value for "%s", ignoring it.\n' "$(basename "${0}")" "${opt}" 1>&2
exit 2
fi
;;
# "Continue on backup error" flag
'j')
opt_continue_on_backuperror='1'
;;
# key file
'k')
opt_cryptsetup_keyfile_path="${OPTARG}"
if [ -z "${opt_cryptsetup_keyfile_path}" ]
then
opt_cryptsetup_keyfile_path=''
printf '%s: Invalid value for "%s", ignoring it.\n' "$(basename "${0}")" "${opt}" 1>&2
exit 2
fi
;;
# name used for handling LUKS via /dev/mapper/ and creating a mountpoint at /media/
'l')
opt_target_mappername="${OPTARG}"
if [ -z "${opt_target_mappername}" ] ||
! printf '%s' "${opt_target_mappername}" | grep -E -q -e "^[[:alnum:]_\-]{1,16}$"
then
opt_target_mappername=''
printf '%s: Invalid value for "%s", ignoring it.\n' "$(basename "${0}")" "${opt}" 1>&2
exit 2
fi
;;
# quiet mode
'q')
opt_quiet='1'
;;
# source dirs
's')
opt_source_paths_pvedumps_list="${OPTARG}"
if [ -z "${opt_source_paths_pvedumps_list}" ]
then
opt_source_paths_pvedumps_list=''
printf '%s: Invalid value for "%s", ignoring it.\n' "$(basename "${0}")" "${opt}" 1>&2
exit 2
fi
;;
# user
'u')
opt_backup_user="${OPTARG}"
if [ -z "${opt_backup_user}" ]
then
opt_backup_user=''
printf '%s: Invalid value for "%s", ignoring it.\n' "$(basename "${0}")" "${opt}" 1>&2
exit 2
fi
;;
# show version flag
'v')
opt_show_version='1' # flag currently not being used, but still setting the value for code consistency
printf '%s\n' "${version}"
exit 0
;;
# show help
'h')
filename="$(basename "${0}")"
mantext="$(cat <<-DELIM
.TH ${filename} 1
.SH NAME
${filename} - Script to mirror local Proxmox PVE dump backups to encrypted
USB drives, including proper logging and optional email notifications.
.SH SYNOPSIS
.B ${filename}
.PP
.BI "-b " "PveID[:maxCount[,PveID:maxCount[,...]]]" ""
.B [-c]
.BI "[-d " "pve_backup_disk_label[,UUID[,...]]"
.BI "[-e " "email@example.com" "]"
.BI "[-f " "email@example.org" "]"
.BI "[-g " "email@example.com[,email@example.net[,...]]" "]"
.B [-j]
.BI "[-k " "/path/to/keyfile" "]"
.BI "[-l " "mapper and mount point name" "]"
.B [-q]
.BI "[-s " "/pve1/dumps[:/pve2/dumps:...]" "]"
.BI "[-u " "username" "]"
.B [-v]
.SH DESCRIPTION
See https://github.com/foundata/proxmox-pve-backup-usb/ for a detailed
description.
.SH OPTIONS
.TP
.B -b
Defines which PVE dumps that will be copied. The format is a CSV list of
"PveID:maxCount" value tuples where ":maxCount" is optional. All backups
for "PveId" will be copied if ":maxCount" is not given. Example: The value
"123:2,456:4,789" will copy
a) the last two backups of machine "123"
b) the last four backups machine "456"
c) all backups of machine "789"
.TP
.B -c
Enable checksum creation and verification of the copies (recommended for
safety but probably doubles the time needed for completing the backup task).
.TP
.B -d
List of partition labels or UUIDs to search before the default locations are
checked for the backup target partion. By default, the script searches the
following locations for a partition to use as the backup target for decryption
and mounting:
1. The first partition labeled "pve_backup_usb" listed under /dev/disk/by-label/.
2. The first partition on the first USB disk found via /dev/disk/by-path/.
If this automated behavior does not match your environment, you can provide a
custom list of partition labels or UUIDs to search before using this parameter.
Separate multiple targets with commas (CSV format). Any given UUID will be
searched under /dev/disk/by-uuid/ (you might use "blkid /dev/sdX1" to determine
a UUID), while any other string matching the pattern "^[0-9a-zA-Z_ \-]{1,16}$"
will be searched under /dev/disk/by-label/. The search will be performed in the
exact order the items appear in the list. No need to worry: existing partitions
or drives not intended for backups will not be destroyed, as decryption will
simply fail, and the script will stop.
.TP
.B -e
Email address to send notifications to. Format: 'email@example.com'.
Has to be set for sending mails. This script is using the system's "mail"
command, so please make sure a proper relay is configured.
.TP
.B -f
Email address to send notifications from. Format: 'email@example.com'.
Has to be set for sending mails. Defaults to "do-not-reply@$(hostname -d)".
.TP
.B -g
Email address(es) to send notifications to (CC). Format: 'email@example.com'.
Separate multiple addresses via comma (CSV list).
.TP
.B -j
Flag to enable the continuation of the backup process in case of an error
during the copying and/or verification of files. If this flag is not set, the
script will immediately halt the entire backup process and display an error
if any file to be backed up cannot be copied (or verified, cf. -c).
If the flag is set, the backup will continue with the remaining files to be
backed up (if any). Activating this feature requires careful review of the
backup logs and emails/messages, as a quick inspection of the backup media
might incorrectly suggest that all PVE sources were successfully backed up,
even though some files may be missing or damaged. However, this allows for the
possibility that at least some partially useful backup data will be available.
.TP
.B -k
Path to a keyfile containing a passphrase to unlock the target device. Defaults
to "/etc/credentials/luks/pve_backup_usb". There must be no other chars beside
the passphrase, including no trailing new line or EOF. You might use
"perl -pi -e 'chomp if eof' /etc/credentials/luks/pve_backup_usb" to get rid of
an invisible, unwanted EOF.
.TP
.B -l
Name used for handling LUKS via /dev/mapper/ and creating a mountpoint
subdirectory at /media/. Defaults to "pve_backup_usb".
16 alphanumeric chars at max.
.TP
.B -q
Flag to enable quiet mode. Emails will be sent only on "error" or "warning"
then (but not on "info" or "success").
.TP
.B -s
List of one or more directories to search for PVE dumps, without trailing
slash, separated by ":"; Example: "/pve1/dumps:/pve2/dumps".
.TP
.B -u
Username of the account used to run the backups. Defaults to "root". This
script checks if the correct user is calling it and permissions of e.g. the
keyfile are fitting or are too permissive. The user also needs permissions
to mount devices. Running the script as "root" is probably a good choice
for most environments.
.TP
.B -h
Print this help.
.TP
.B -v
Print the script's version number, then exit.
.SH EXIT STATUS
This program returns an exit status of zero if it succeeds. Non zero
is returned in case of failure. 2 will be returned for command line
syntax errors (e.g. usage of an unknown option).
.SH AUTHOR
Andreas Haerter <ah@foundata.com>
DELIM
)"
if command -v 'mandoc' > /dev/null 2>&1
then
printf '%s' "${mantext}" | mandoc -Tascii -man | more
elif command -v 'groff' > /dev/null 2>&1
then
printf '%s' "${mantext}" | groff -Tascii -man | more
else
printf '%s: Neither "mandoc" nor "groff" is available, cannot display help.\n' "$(basename "${0}")" 1>&2
exit 1
fi
unset filename mantext
exit 0
;;
# unknown/not supported -> kill script and inform user
*)
printf '%s: unknown option "-%c" (or missing option value). Use "-h" to get usage instructions.\n' "$(basename "${0}")" "${OPTARG}" 1>&2
exit 2
;;
esac
done
unset opt OPTARG
shift $((${OPTIND} - 1)) && OPTIND='1' # delete processed options, reset index
################################################################################
# Config
################################################################################
if [ -z "${opt_backupcfg_list}" ]
then
printf '%s: Option "-b" is mandatory. Use "-h" to get usage instructions.\n' "$(basename "${0}")" 1>&2
exit 2
fi
IFS=',' read -r -a backupcfg_array <<< "${opt_backupcfg_list}"
readonly backupcfg_array
if [ -z "${opt_luks_targets_list}" ]
then
readonly luks_targets_list=""
else
readonly luks_targets_list="${opt_luks_targets_list}"
fi
IFS=',' read -r -a luks_targets_array <<< "${luks_targets_list}"
readonly luks_targets_array
if [ -z "${opt_backup_user}" ]
then
readonly backup_user="root"
else
readonly backup_user="${opt_backup_user}"
fi
if [ -z "${opt_source_paths_pvedumps_list}" ]
then
printf '%s: Option "-s" is mandatory. Use "-h" to get usage instructions.\n' "$(basename "${0}")" 1>&2
exit 2
fi
readonly source_paths_pvedumps_list="${opt_source_paths_pvedumps_list}"
IFS=':' read -r -a source_paths_pvedumps_array <<< "${source_paths_pvedumps_list}"
readonly source_paths_pvedumps_array
if [ -z "${opt_target_mappername}" ] # used for handling LUKS via /dev/mapper/ and creating a mountpoint at /media/
then
readonly target_mappername="pve_backup_usb"
else
readonly target_mappername="${opt_target_mappername}"
fi
readonly target_mountpoint_path="/media/${target_mappername}" # without trailing slash
if [ -z "${opt_cryptsetup_keyfile_path}" ]
then
readonly cryptsetup_keyfile_path="/etc/credentials/luks/pve_backup_usb"
else
readonly cryptsetup_keyfile_path="${opt_cryptsetup_keyfile_path}"
fi
readonly target_subdir="dump" # name of subdir on $target_mountpoint_path to copy the files into
readonly target_subdir_old="dump_old" # name of subdir on $target_mountpoint_path to copy to temporarily move old copies to
readonly hostname="$(hostname -f)"
if [ -z "${opt_email_to}" ]
then
readonly email_to=""
else
readonly email_to="${opt_email_to}"
fi
if [ -z "${opt_email_from}" ]
then
domain="$(hostname -d)"
if [ -z "${domain}" ]
then
domain="example.com"
fi
readonly email_from="do-not-reply@${domain}"
else
readonly email_from="${opt_email_from}"
fi
if [ -z "${opt_email_cc}" ]
then
readonly email_cc=""
else
readonly email_cc="${opt_email_cc}"
fi
################################################################################
# Functions
################################################################################
###
# Helper to end the script, cleanup and inform/log/mail.
#
# @param string the message
# @param string optional, type to handle the message / environment during
# exit ("error", "warning", "info", "success"). Unknown type will be
# handled as "info". Defaults to "info".
# @return integer Zero if execution succeeds, non-zero in case of failure.
endScript() {
local message="${1}"
local type=""
if [ -z "${2:-}" ]
then
type="info"
else
type="${2}"
fi
if [ "${type}" != "error" ] &&
[ "${type}" != "warning" ] &&
[ "${type}" != "info" ] &&
[ "${type}" != "success" ]
then
message "Unknown message type "${type}". Using 'info'." "error"
type="info"
fi
# write message on STDOUT or STDERR as well as the logfile
message "${message}" "${type}"
# create syslog entry
syslog "${message}" "${type}"
# copy logfile beside the other files
if [ -f "${logfile_path}" ]
then
if [ -d "${target_mountpoint_path}/${target_subdir}" ]
then
cp -f "${logfile_path}" "${target_mountpoint_path}/${target_subdir}/$(basename "${0}").log" > /dev/null 2>&1
fi
fi
# clean up
syncUmountAndClose
# send email
local mailmessage="${message}"
if [ -r "${logfile_path}" ]
then
mailmessage=$(printf '%s\n\nContent of logfile follows:\n\n%s' "${mailmessage}" "$(cat "${logfile_path}")")
fi
sendEmail "${mailmessage}" "${type}"
unset mailmessage
# clean up logfile
if [ -f "${logfile_path}" ]
then
rm -f "${logfile_path}" > /dev/null 2>&1
fi
if [ "${type}" = "error" ]
then
exit 1
fi
exit 0
}
###
# Helper to create syslog entries
#
# @param string the message
# @param string optional, type / priority to syslog entry to handle
# ("error" (maps to priority "err"), "warning" (maps to "warning"),
# "info" (maps to "info")), "success" (maps to "info")).
# Unknown type will be handled as "info". Defaults to "info".
# @return integer Zero if execution succeeds, non-zero in case of failure.
syslog() {
local message="${1}"
local type=""
if [ -z "${2:-}" ]
then
type="info"
else
type="${2}"
fi
if [ "${type}" != "error" ] &&
[ "${type}" != "warning" ] &&
[ "${type}" != "info" ] &&
[ "${type}" != "success" ]
then
message "Unknown message type "${type}". Using 'info'." "error"
type="info"
fi
if ! command -v "logger" > /dev/null 2>&1
then
message "'logger' could not be found (no syslogs will be written)." "error"
return 1
else
if [ "${type}" = "success" ] ||
[ "${type}" = "info" ]
then
logger_priority="info"
elif [ "${type}" = "warning" ]
then
logger_priority="warning"
else
logger_priority="err"
fi
logger --tag "$(basename "${0}")" --priority "${logger_priority}" "${message}"
exitcode_logger=$?
if [ $exitcode_logger -ne 0 ]
then
message "'logger' exited with code "${exitcode_logger}"" "error"
return 1
else
message "Syslog entry was created (priority: "${logger_priority}")."
fi
fi
return 0
}
###
# Small handler to print messages to STDOUT, STDERR and write them into the
# logfile (created automatically when this script started, cf. $logfile_path)
# in parallel.
#
# @param string the message to print and write to logfile.
# @param string optional, type of the message ("error", "warning", "info",
# "success"). Unknown type will be handled as "info". Defaults to
# "info". "error" will be written to STDERR, everything else to STDOUT.
# @return no return, exit will be called with exit code 1 if type or result
# was set to "error" and 0 when "success".
message() {
local message="${1}"
local type=""
if [ -z "${2:-}" ]
then
type="info"
else
type="${2}"
fi
if [ "${type}" != "error" ] &&
[ "${type}" != "warning" ] &&
[ "${type}" != "info" ] &&
[ "${type}" != "success" ]
then
message "Unknown message type "${type}". Using 'info'." "error"
type="info"
fi
# print to STDOUT or STDERR
if [ "${type}" = "success" ] ||
[ "${type}" = "info" ]
then
printf '%s: %s\n' "$(basename "${0}")" "${message}"
else
printf '%s: %s\n' "$(basename "${0}")" "${message}" 1>&2
fi
# write into logfile
if [ -w "${logfile_path}" ]
then
printf '%s\n' "${message}" >> "${logfile_path}"
fi
return 0
}
###
# Helper to send emails
#
# @param string the message
# @param string type / priority to syslog entry to handle ("error", "warning",
# "info", "success"). Unknown type will be handled as "info". Defaults
# to "info".
# @return integer Zero if execution succeeds, non-zero in case of failure.
sendEmail() {
local message="${1}"
local type=""
if [ -z "${2:-}" ]
then
type="info"
else
type="${2}"
fi
if [ "${type}" != "error" ] &&
[ "${type}" != "warning" ] &&
[ "${type}" != "info" ] &&
[ "${type}" != "success" ]
then
message "Unknown message type "${type}". Using 'info'." "error"
type="info"
fi
# email
if [ "${type}" = "error" ] ||
[ "${type}" = "warning" ] ||
[ "${opt_quiet}" != "1" ]
then
if ! command -v "mail" > /dev/null 2>&1
then
message "'mail' could not be found (email was not sent)." "error"
return 1
elif [ -z "${email_from}" ] ||
[ -z "${email_to}" ]
then
message "Email receiver and/or sender is not defined (no email will be sent). Please set the parameters -e and/or -f." "error"
return 1
else
local subject="[$(basename "${0}")] ${type} on ${hostname}"
if [ -z "${email_cc}" ]
then
printf '%s' "${message}" | mail -s "${subject}" -r "${email_from}" "${email_to}"
exitcode_mail=$?
else
printf '%s' "${message}" | mail -s "${subject}" -r "${email_from}" -c "${email_cc}" "${email_to}"
exitcode_mail=$?
fi
unset subject
if [ $exitcode_mail -ne 0 ]
then
message "'mail' command exited with code ${exitcode_mail}" "error"
return 1
else
if [ -z "${email_cc}" ]
then
message "Email to '${email_to}' was sent."
else
message "Email to '${email_to}' (CC: ${email_cc}) was sent."
fi
fi
unset exitcode_mail
fi
fi
return 0
}
###
# Unmounts und closes the backup target device if needed (best effort)
#
# @return integer Zero if execution succeeds, non-zero in case of failure.
function syncUmountAndClose() {
sync > /dev/null 2>&1
if umount "${target_mountpoint_path}" > /dev/null 2>&1
then
message "Successfully unmounted '${target_mountpoint_path}'"
if [ -d "${target_mountpoint_path}" ] &&
[ -n "$(find "${target_mountpoint_path}" -maxdepth 0 -empty -exec echo {} is empty. \; 2>/dev/null)" ]
rmdir "${target_mountpoint_path}" > /dev/null 2>&1
then
message "Successfully deleted mountpoint '${target_mountpoint_path}'."
fi
fi
if cryptsetup luksClose "${target_mappername}" > /dev/null 2>&1
then
message "Successfully closed LUKS device '${target_mappername}'"
fi
sync > /dev/null 2>&1
return 0
}
###
# Prints the elapsed time since script start in human readable format
#
# @return integer Zero if execution succeeds, non-zero in case of failure.
function timeElapsed() {
local time_elapsed=""
if ! [ -z "${SECONDS:-}" ] # $SECONDS is a bash internal var
then
time_elapsed=$SECONDS
time_elapsed="$(printf '%02dh:%02dm:%02ds\n' $((time_elapsed/3600)) $((time_elapsed%3600/60)) $((time_elapsed%60)))"
fi
printf "%s" "${time_elapsed}"
return 0
}
################################################################################
# Process
################################################################################
# add a trap as fallback cleanup action to prevent leftovers when the script
# gets interrupted in an unexpected way
trap 'syncUmountAndClose' EXIT SIGINT SIGTERM
# create a temporary file and use it as logfile
logfile_path=''
: "${TMPDIR:=/tmp}" # if env var ${TMPDIR} is empty, set its value to /tmp
mask_save="$(umask)"; umask 077 # temporarily change mask
logfile_path="$(mktemp "${TMPDIR}/pve_backup_usb_XXXXXXXXXXXXXX")" || logfile_path='';
umask "${mask_save}"; unset mask_save # restore mask
if [ -z "${logfile_path}" ] || ! [ -f "${logfile_path}" ]
then
endScript "Creation of temporary file failed:\n${logfile_path}"
exit 1 # endScript should exit, this is just a fallback
fi
# check if there is another instance of this script
if [ $(lsof -t "${0}" | wc -l) -gt 1 ]; then
endScript "'losof' check failed, another instance of ${0} seems to be running (this might be a false positive if another process is accessing the script). Exiting." "error"
exit 1 # endScript should exit, this is just a fallback
fi
# make sure the script is executed by the correct user
if [ "$(id -u -n)" != "${backup_user}" ]
then
endScript "Wrong user '$(id -u -n)'. Script has to be executed as user '${backup_user}'." "error"
exit 1 # endScript should exit, this is just a fallback
fi
# check if needed commands and tools are available
for cmd in "cut" "cryptsetup" "date" "df" "du" "fold" "hostname" "hdparm" "logger" "lsblk" "lsof" "mail" "mktemp" "mountpoint" "numfmt" "rmdir" "stat" "sum"
do
if ! command -v "${cmd}" > /dev/null 2>&1
then
endScript "'${cmd}' could not be found but is needed for execution." "error"
exit 1 # endScript should exit, this is just a fallback
fi
done
unset cmd
# check if key file is available and its permissions are restrictive
if ! [ -f "${cryptsetup_keyfile_path}" ]
then
endScript "Key file to unlock targets is not accessible or no file: '${cryptsetup_keyfile_path}'." "error"
exit 1 # endScript should exit, this is just a fallback
fi
if [ "$(stat --printf '%U' "${cryptsetup_keyfile_path}")" != "${backup_user}" ]
then
endScript "Key file '${cryptsetup_keyfile_path}' is not owned by '${backup_user}'." "error"
exit 1 # endScript should exit, this is just a fallback
fi
filepermission="$(stat --printf '%a' "${cryptsetup_keyfile_path}")"
filepermission_owner="${filepermission:0:1}"
filepermission_group="${filepermission:1:1}"
filepermission_world="${filepermission:2:1}"
if [ $(($filepermission_world+0)) -gt 0 ] ||
[ -x "${cryptsetup_keyfile_path}" ]
then
endScript "Access rights for '${cryptsetup_keyfile_path}' are too permissive. Please make sure the file is owned by '${backup_user}', not executable and not world-readable." "error"
exit 1 # endScript should exit, this is just a fallback
fi
unset filepermission filepermission_owner filepermission_group filepermission_world
# check if source dir(s) are available
for path_pvedumps_source in "${source_paths_pvedumps_array[@]}"
do
if ! [ -d "${path_pvedumps_source}" ]
then
endScript "Backup source is not accessible or no dir: '${path_pvedumps_source}'." "error"
exit 1 # endScript should exit, this is just a fallback
fi
done
unset path_pvedumps_source
# take care about stale or previously interrupted execs
message "#### $(basename "${0}") ####"
message "Current time: $(date -u)."
message "CSV list of 'PveMachineID[:MaxBackupCount]' entries (defines what to copy): '${opt_backupcfg_list}'"
message "Sync, unmount, and close of backup target device (upfront safeguard against stale or previously interrupted backup script runs)."
syncUmountAndClose
# create target mountpoint if needed
if ! [ -d "${target_mountpoint_path}" ] &&
! [ -f "${target_mountpoint_path}" ]
then
message "Creating mountpoint at '${target_mountpoint_path}'"
mkdir -p "${target_mountpoint_path}"
fi
# check if target mountpoint is accessible and empty
if ! [ -d "${target_mountpoint_path}" ] ||
! [ -n "$(find "${target_mountpoint_path}" -maxdepth 0 -empty -exec echo {} is empty. \; 2>/dev/null)" ]
then
endScript "Mount point for target disk is no directory or not empty: '${target_mountpoint_path}'." "error"
exit 1 # endScript should exit, this is just a fallback
fi
# determine target device partition
luks_target=""
message="Searching for target partition at"
for luks_target in "${luks_targets_array[@]}"
do
# UUID of a partition
if [ -n "${luks_target}" ] &&
printf '%s' "${luks_target}" | grep -E -q -e "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
then
luks_target="/dev/disk/by-uuid/${luks_target}"
if [ -L "${luks_target}" ]
then
message "${message} '${luks_target}'... found."
break 1
else
message "${message} '${luks_target}'... not found, continuing."
luks_target="" # nothing was found (yet)
fi
# label of a partition
elif [ -n "${luks_target}" ] &&
printf '%s' "${luks_target}" | grep -E -q -e "^[0-9a-zA-Z_ \-]{1,16}$"
then
luks_target="/dev/disk/by-label/${luks_target}"
if [ -L "${luks_target}" ]
then
message "${message} '${luks_target}'... found."
break 1
else
message "${message} '${luks_target}'... not found, continuing."
luks_target="" # nothing was found (yet)
fi
# invalid value
elif [ -n "${luks_target}" ]
then
message "Invalid value '${luks_target}' (has to be a valid partition label or UUID, check '-d' parameter), continuing." "warning"
fi
done
# use the first partition with a "pve_backup_usb" label if no (useable) target was specified or found
if [ -z "${luks_target}" ]
then
luks_target="/dev/disk/by-label/pve_backup_usb"
if [ -L "${luks_target}" ]
then
message "${message} '${luks_target}'... found."
else
message "${message} '${luks_target}'... not found, continuing."
luks_target="" # nothing was found (yet)
fi
fi
# use the first partition of the first usb storage device if no (useable) target was specified or found
if [ -z "${luks_target}" ]
then
luks_target="/dev/$(ls -l /dev/disk/by-path/*usb*part1 | cut -f 7 -d "/" | head -n 1)"
if [ -b "${luks_target}" ]
then
message "${message} '${luks_target}'... found."
else
message "${message} '${luks_target}'... not found."
luks_target="" # nothing was found (yet)
endScript "Could not determine any target partition for decryption (backup storage device available?)." "error"
exit 1 # endScript should exit, this is just a fallback
fi
fi
unset message
# unlock target device
message "Going to unlock '${luks_target}', using using keyfile '${cryptsetup_keyfile_path}'"
if ! cryptsetup open --key-file "${cryptsetup_keyfile_path}" "${luks_target}" "${target_mappername}"
then
endScript "Could not unlock device '${luks_target}' (wrong device?), using keyfile "${cryptsetup_keyfile_path}" (wrong key?)." "error"
exit 1 # endScript should exit, this is just a fallback
else
message "Successfully unlocked '${luks_target}', should be available at '/dev/mapper/${target_mappername}' now."
fi
unset luks_target
# mount
if ! mount "/dev/mapper/${target_mappername}" "${target_mountpoint_path}"
then
endScript "Could not mount '/dev/mapper/${target_mappername}' at '${target_mountpoint_path}'." "error"
exit 1 # endScript should exit, this is just a fallback
fi
# inform about time
message "Current time: $(date -u)."
message "Elapsed time: $(timeElapsed)."
# disk info (best effort)
readonly target_devicename="$(lsblk -l -i -s "/dev/mapper/${target_mappername}" | tail -1 | cut -f1 -d' ' 2>/dev/null)"
if [ -n "${target_devicename}" ]
then
output_hdparm="$(hdparm -I "/dev/${target_devicename}" 2>/dev/null)"
exitcode_hdparm=$?
if [ $exitcode_hdparm -eq 0 ] &&
[ -n "${output_hdparm}" ]
then
output_hdparm="$(printf '%s' "${output_hdparm}" | grep -i "number" | sed -e 's/^[[:space:]]*//' -e 's/[[:space:]]*$//')"
if [ -n "${output_hdparm}" ]
then
message ""
message "#### Info about physical disk (mounted at ${target_mountpoint_path}) ####"
ifs_save="${IFS}"; IFS="$(printf '\n+')"; IFS="${IFS%?}" # temporarily change IFS to "\n" (LF)
for line in ${output_hdparm}
do
message "${line}"
done
IFS="${ifs_save}"; unset ifs_save # restore IFS
unset line output_hdparm
fi
fi
unset exitcode_hdparm output_hdparm
fi
# init bash array to store backup sources for the cp and find commands
unset backup_sources_cp
backup_sources_cp=()
for cfgvalues in "${backupcfg_array[@]}"
do
# parse config data for the PVE item
unset tuple
IFS=':' read -r -a tuple <<< "${cfgvalues}"
cfg_pve_id="${tuple[0]}"
if [ -v "tuple[1]" ]
then
cfg_maxLastCopies="${tuple[1]}"
else
cfg_maxLastCopies="unlimited"
fi
unset tuple
# Detect filename prefixes (easy search for all files belonging to a
# certain backup (dump, log, notes ...) of the defined VMs). Example
# filenames of a backup (many parts are non-static, e.g. extension
# depend on backup type):
# - vzdump-qemu-120-2023_08_04-21_00_04.vma.zst
# - vzdump-qemu-120-2023_08_04-21_00_04.vma.zst.notes
# - vzdump-qemu-120-2023_08_09-21_00_05.log
backuplist=() # init bash array to store these backup filename prefixes
message ""
message "#### Checking for existing backups to copy for PVE ID ${cfg_pve_id} ####"
for path_pvedumps_source in "${source_paths_pvedumps_array[@]}"
do
last_found_backup_prefix=""
ifs_save="${IFS}"; IFS="$(printf '\n+')"; IFS="${IFS%?}" # temporarily change IFS to "\n" (LF)
for resource in $(find "${path_pvedumps_source}" -not -iname "*\.log" -not -iname "*\.notes" -iname "vzdump-*-${cfg_pve_id}-*" -type f | sort -r)
do
resource_dir="$(dirname "${resource}"; printf '+')"; resource_dir="${resource_dir%??}"
resource_filename="$(basename "${resource}"; printf '+')"; resource_filename="${resource_filename%??}"
backup_date=$(printf "%s" "${resource_filename}" | awk -F- '{print $(NF-1)}')
backup_time=$(printf "%s" "${resource_filename}" | awk -F- '{print $(NF)}' | awk -F. '{print $1}')
backup_prefix=$(printf "%s" "${resource_filename}" | awk -F"${cfg_pve_id}-${backup_date}-${backup_time}" '{print $1}')
backup_prefix="${backup_prefix}${cfg_pve_id}-${backup_date}-${backup_time}"
if [ "${backup_prefix}" != "${last_found_backup_prefix}" ]
then
message "Found backup '${backup_prefix}' in '${resource_dir}'"
backuplist[${#backuplist[@]}]="${backup_prefix}:${resource_dir}"
last_found_backup_prefix="${backup_prefix}"
fi
done
IFS="${ifs_save}"; unset ifs_save # restore IFS
unset last_found_backup_prefix resource resource_dir resource_filename backup_date backup_time backup_prefix
done
unset path_pvedumps_source
# sort and keep only the newest cfg_maxLastCopies
IFS=$'\n' backuplist_sorted=($(sort -r <<<"${backuplist[*]}"))