fuxino/simple_backup
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity

Allow removing remote old backups with sudo if possible

Browse Source 
If allowed by the remote server, try using sudo to remove
old backups (rm needs to be allowed in sudoers to run
without password)
This commit is contained in:
daniele 2023-10-15 15:39:06 +02:00
parent 77661c0964
commit 9390cd2de8
Signed by: fuxino
GPG Key ID: 981A2B2A3BBF5514
3 changed files with 18 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -68,4 +68,4 @@ sudo --preserve-env=SSH_AUTH_SOCK -s simple_backup [options]
or by editing the sudoers file. or by editing the sudoers file.
If SSH key authentication is not available, password authentication will be used instead. If SSH key authentication is not available, password authentication will be used instead.
Check the man page for more details.

23
man/simple_backup.1
View File

@ -93,19 +93,19 @@ Don't use systemd journal for logging.
.B \-\-rsync\-options OPTIONS [OPTION...] .B \-\-rsync\-options OPTIONS [OPTION...]
By default, the following rsync options are used: By default, the following rsync options are used:
.RS .RS
.PP .P
\-a \-r \-v \-h \-s \-H \-X \-a \-r \-v \-h \-s \-H \-X
.PP .P
Using \-\-rsync\-options it is possible to manually select which options to use. Supported values are the following: Using \-\-rsync\-options it is possible to manually select which options to use. Supported values are the following:
.PP .P
\-a, \-l, \-p, \-t, \-g, \-o, \-c, \-h, \-D, \-H, \-X, \-s \-a, \-l, \-p, \-t, \-g, \-o, \-c, \-h, \-D, \-H, \-X, \-s
.PP .P
Options \-r and \-v are used in any case. Not that options must be specified without dash (\-), for example: Options \-r and \-v are used in any case. Not that options must be specified without dash (\-), for example:
.PP .P
.EX .EX
simple_backup \-\-rsync\-options a l p simple_backup \-\-rsync\-options a l p
.EE .EE
.TP .P
Check Check
.BR rsync (1) .BR rsync (1)
for details about the options. for details about the options.
@ -114,8 +114,12 @@ for details about the options.
.B \-\-remote\-sudo .B \-\-remote\-sudo
Run rsync on the remote server with sudo. This is needed if you want to preserve the owner of the files/folders to be copied (rsync \-\-owner option). For this to work the user used to login to the server obviously need to be allowed to use sudo. In addition, the user need to be able to run rsync with sudo without a password. To do this, /etc/sudoers on the server need to be edited adding a line like this one: Run rsync on the remote server with sudo. This is needed if you want to preserve the owner of the files/folders to be copied (rsync \-\-owner option). For this to work the user used to login to the server obviously need to be allowed to use sudo. In addition, the user need to be able to run rsync with sudo without a password. To do this, /etc/sudoers on the server need to be edited adding a line like this one:
.RS .RS
.PP .P
<username> ALL=NOPASSWD:<path/to/rsync> <username> ALL=NOPASSWD:<path/to/rsync>
.P
To be able to remove old backups generated with \-\-remote\-sudo (see \-\-keep option), also
.BR rm (1)
needs to be allowed to run without password in the same way.
.RE .RE
.TP .TP
.B \-\-numeric\-ids .B \-\-numeric\-ids
@ -139,7 +143,7 @@ When running
.B simple_backup .B simple_backup
with with
.B sudo, .B sudo,
in order to connect to the user\(aq s SSH agent it is necessary to preserve the \(aq SSH_AUTH_SOCK\(aq environment variable, for example: in order to connect to the user\(aqs SSH agent it is necessary to preserve the \(aqSSH_AUTH_SOCK\(aq environment variable, for example:
.P .P
.EX .EX
sudo --preserve-env=SSH_AUTH_SOCK -s simple_backup [options] sudo --preserve-env=SSH_AUTH_SOCK -s simple_backup [options]
@ -148,8 +152,7 @@ in order to connect to the user\(aq s SSH agent it is necessary to preserve the
It is also possible to make this permanent by editing the It is also possible to make this permanent by editing the
.B sudoers .B sudoers
file (see file (see
.BR sudoers (5) .BR sudoers (5))
)
.P .P
If SSH key authentication is not available, password authentication will be used instead. If SSH key authentication is not available, password authentication will be used instead.
Note that in this case Note that in this case

5
simple_backup/simple_backup.py
View File

@ -229,7 +229,10 @@ class Backup:
dirs.sort() dirs.sort()
for i in range(n_backup - self.keep): for i in range(n_backup - self.keep):
_, _, stderr = self._ssh.exec_command(f'rm -r "{self.output}/simple_backup/{dirs[i]}"') if self.remote_sudo:
_, _, stderr = self._ssh.exec_command(f'sudo rm -r "{self.output}/simple_backup/{dirs[i]}"')
else:
_, _, stderr = self._ssh.exec_command(f'rm -r "{self.output}/simple_backup/{dirs[i]}"')
err = stderr.read().decode('utf-8').strip().split('\n')[0] err = stderr.read().decode('utf-8').strip().split('\n')[0]