Compare commits

...

10 Commits

Author SHA1 Message Date
2a37eb4172
Add PKGBUILD 2024-11-13 19:38:12 +01:00
45a07205a1
Add type hints plus minor code fixes 2024-09-28 09:47:33 +02:00
9390cd2de8
Allow removing remote old backups with sudo if possible
If allowed by the remote server, try using sudo to remove
old backups (rm needs to be allowed in sudoers to run
without password)
2023-10-15 15:39:06 +02:00
77661c0964
Handle getpass exception 2023-07-16 08:22:51 +02:00
e3a970217f
Improve logging 2023-06-25 11:49:02 +02:00
8968fcd1a8
Fix parsing option bug 2023-06-25 10:12:07 +02:00
35b87c859e
Add --user arg 2023-06-20 19:22:22 +02:00
f3d5ebd276
Merge branch 'development' 2023-06-20 17:36:40 +02:00
fb726a80ab
Fix bug
Remove forgotten test code -.-
2023-06-20 17:36:12 +02:00
4701ee0b05
Fix typo 2023-06-19 16:00:21 +02:00
7 changed files with 271 additions and 141 deletions

40
PKGBUILD Normal file
View File

@ -0,0 +1,40 @@
# PKGBUILD
# Maintainer: Daniele Fucini <dfucini [at] gmail [dot] com>
pkgname=simple_backup
pkgdesc='Simple backup script that uses rsync to copy files'
pkgver=4.1.5
pkgrel=1
url="https://github.com/Fuxino/${pkgname}"
arch=('any')
license=('GPL-3.0-or-later')
makedepends=('git'
'python-setuptools'
'python-build'
'python-installer'
'python-wheel')
depends=('python>=3.10'
'rsync'
'python-dotenv')
optdepends=('python-systemd: use systemd log'
'python-dbus: for desktop notifications'
'python-paramiko: for remote backup through ssh')
conflicts=('simple_backup-git')
source=(git+${url}?signed#tag=${pkgver})
validpgpkeys=('7E12BC1FF3B6EDB2CD8053EB981A2B2A3BBF5514')
sha256sums=('4da838282fff813f82ee0408996c989078a206eabce07112b4e3ee8b057e34cf')
build()
{
cd ${srcdir}/${pkgname}
python -m build --wheel --no-isolation
}
package()
{
cd ${srcdir}/${pkgname}
python -m installer --destdir=${pkgdir} dist/*.whl
install -Dm644 ${pkgname}/${pkgname}.conf ${pkgdir}/usr/share/doc/${pkgname}/${pkgname}.conf
install -Dm644 man/${pkgname}.1 ${pkgdir}/usr/share/man/man1/${pkgname}.1
}

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.

View File

@ -2,12 +2,12 @@
.SH NAME .SH NAME
simple_backup \- Backup files and folders using rsync simple_backup \- Backup files and folders using rsync
.SH SYNOPSIS .SH SYNOPSIS
.BR simple_backup .B simple_backup
\-h, \-\-help \-h, \-\-help
.PD 0 .PD 0
.P .P
.PD .PD
.BR simple_backup .B simple_backup
[\-c, \-\-config FILE] [\-c, \-\-config FILE]
[\-i, \-\-input INPUT [INPUT...]] [\-i, \-\-input INPUT [INPUT...]]
[\-o, \-\-output DIR] [\-o, \-\-output DIR]
@ -16,8 +16,8 @@ simple_backup \- Backup files and folders using rsync
.PD .PD
.RS 14 [\-e, \-\-exclude FILE|DIR|PATTERN [FILE|...]] .RS 14 [\-e, \-\-exclude FILE|DIR|PATTERN [FILE|...]]
[\-k, \-\-keep N] [\-k, \-\-keep N]
[\-\-host HOSTNAME] [\-\-ssh\-host HOSTNAME]
[\-u, \-\-username USERNAME] [\-\-ssh\-user USERNAME]
[\-\-keyfile FILE] [\-\-keyfile FILE]
.PD 0 .PD 0
.P .P
@ -27,7 +27,7 @@ simple_backup \- Backup files and folders using rsync
[\-\-remove\-before\-backup] [\-\-remove\-before\-backup]
.RE .RE
.SH DESCRIPTION .SH DESCRIPTION
.BR simple_backup .B simple_backup
is a python script for performing backup of files and folders. is a python script for performing backup of files and folders.
.P .P
It uses rsync to copy the files to the specified location. Parameters for the backup such as It uses rsync to copy the files to the specified location. Parameters for the backup such as
@ -39,7 +39,7 @@ Parameters specified on the command line will override those in the configuratio
.SH OPTIONS .SH OPTIONS
.TP .TP
.B \-h, \-\-help .B \-h, \-\-help
Print a short help message and exit Print a short help message and exit.
.TP .TP
.B \-c, \-\-config FILE .B \-c, \-\-config FILE
Specify the configuration file, useful to specify a different one from the default. Specify the configuration file, useful to specify a different one from the default.
@ -52,21 +52,24 @@ or to use single or double quotes around them.
.B \-o, \-\-output DIR .B \-o, \-\-output DIR
Specify the directory where the files will be copied. The program will automatically Specify the directory where the files will be copied. The program will automatically
create a subdirectory called \(aqsimple_backup\(aq (if it does not already exist) and create a subdirectory called \(aqsimple_backup\(aq (if it does not already exist) and
inside this directory the actual backup directory (using the current date and time) inside this directory the actual backup directory (using the current date and time).
.TP .TP
.B \-e, \-\-exclude FILE|DIR|PATTERN [FILE|...]] .B \-e, \-\-exclude FILE|DIR|PATTERN [FILE|...]]
Specify files, directories or patterns to exclude from the backup. Matching files and directories Specify files, directories or patterns to exclude from the backup. Matching files and directories
will not be copied. Multiple elements can be specified, in the same way as for the \-\-input option will not be copied. Multiple elements can be specified, in the same way as for the \-\-input option.
.TP .TP
.B \-k, \-\-keep N .B \-k, \-\-keep N
Specify how many old backups (so excluding the current one) will be kept. The default behavior Specify how many old backups (so excluding the current one) will be kept. The default behavior
is to keep them all (same as N=\-1) is to keep them all (same as N=\-1).
.TP .TP
.B \-\-host HOSTNAME .B \-u, \-\-user USERNAME
Hostname of the server where to copy the files in case of remote backup through SSH Explicitly specify the user running the backup (in case it is needed for home directory expansion).
.TP .TP
.B \-u, \-\-username USERNAME .B \-\-ssh\-host HOSTNAME
Username for connecting to the server in case of remote backup Hostname of the server where to copy the files in case of remote backup through SSH.
.TP
.B \-\-ssh\-user USERNAME
Username for connecting to the server in case of remote backup.
.TP .TP
.B \-\-keyfile FILE .B \-\-keyfile FILE
Location of the SSH key for server authentication. Location of the SSH key for server authentication.
@ -85,45 +88,49 @@ before performing the backup.
Default behavior is to remove old backups after successfully completing the backup. Default behavior is to remove old backups after successfully completing the backup.
.TP .TP
.B \-\-no\-syslog .B \-\-no\-syslog
Don't use systemd journal for logging Don't use systemd journal for logging.
.TP .TP
.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
.B rsync (1) .BR rsync (1)
for details about the options. for details about the options.
.RE .RE
.TP .TP
.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
Use rsync \-\-numeric\-ids option. This causes rsync to use numeric uid/gid instead of trying to map uid/gid names from the local machine to the server Use rsync \-\-numeric\-ids option. This causes rsync to use numeric uid/gid instead of trying to map uid/gid names from the local machine to the server.
.SH CONFIGURATION .SH CONFIGURATION
An example configuration file is provided at \(aq/usr/share/doc/simple_backup/simple_backup.conf\(aq. An example configuration file is provided at \(aq/usr/share/doc/simple_backup/simple_backup.conf\(aq.
Copy it to the default location ($HOME/.config/simple_backup) and edit it as needed. Copy it to the default location ($HOME/.config/simple_backup) and edit it as needed.
.SH REMOTE BACKUP .SH REMOTE BACKUP
It is possible to choose a directory on a remote server as destination for the backup. The files It is possible to choose a directory on a remote server as destination for the backup. The files
are copied by rsync through SSH. Server hostname and username must be specified, either in the are copied by rsync through SSH. Server hostname and username must be specified, either in the
configuration file, or on the command line (\(aq\-\-host\(aq and \(aq\-\-username\(aq options). configuration file, or on the command line (\(aq\-\-ssh\-host\(aq and \(aq\-\-ssh\-user\(aq options).
.SS AUTHENTICATION .SS AUTHENTICATION
For authentication, it is possible to use SSH key or password. For authentication, it is possible to use SSH key or password.
.P .P
@ -136,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]
@ -145,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
.B 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
@ -154,30 +160,30 @@ Note that in this case
(if available) will be used to send the password to rsync, to avoid prompting the user for (if available) will be used to send the password to rsync, to avoid prompting the user for
the password multiple the password multiple
times. This can pose some security risks, see times. This can pose some security risks, see
.B sshpass (1) .BR sshpass (1)
for details. For this reason, use SSH key authentication if possible. for details. For this reason, use SSH key authentication if possible.
.SH EXIT STATUS .SH EXIT STATUS
.TP .TP
.B 0 .B 0
The backup was completed without errors The backup was completed without errors.
.TP .TP
.B 1 .B 1
No valid inputs selected for backup No valid inputs selected for backup.
.TP .TP
.B 2 .B 2
Backup failed because output directory for storing the backup does not exist Backup failed because output directory for storing the backup does not exist.
.TP .TP
.B 3 .B 3
Permission denied to access the output directory Permission denied to access the output directory.
.TP .TP
.B 4 .B 4
rsync error (rsync returned a non-zero value) rsync error (rsync returned a non-zero value).
.TP .TP
.B 5 .B 5
SSH connection failed SSH connection failed.
.TP .TP
.B 6 .B 6
Bad configuration file Bad configuration file.
.SH SEE ALSO .SH SEE ALSO
.BR rsync (1) .BR rsync (1)
.SH AUTHORS .SH AUTHORS

View File

@ -13,16 +13,14 @@ classifiers =
License :: OSI Approved :: GNU General Public License v3 (GPLv3) License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Natural Language :: English Natural Language :: English
Operating System :: POSIX :: Linux Operating System :: POSIX :: Linux
Programming Language :: Python :: 3.7
Programming Language :: Python :: 3.8
Programming Language :: Python :: 3.9
Programming Language :: Python :: 3.10 Programming Language :: Python :: 3.10
Programming Language :: Python :: 3.11 Programming Language :: Python :: 3.11
Programming Language :: Python :: 3.12
Topic :: System :: Archiving :: Backup Topic :: System :: Archiving :: Backup
[options] [options]
packages = simple_backup packages = simple_backup
python_requires = >=3.7 python_requires = >=3.10
install_requires = install_requires =
python-dotenv python-dotenv

View File

@ -1,3 +1,3 @@
"""Init.""" """Init."""
__version__ = '4.0.0' __version__ = '4.1.5'

View File

@ -2,7 +2,7 @@
[backup] [backup]
# Files and directories to backup. Multiple items can be separated using a comma (','). It is possible to use wildcards (i.e. '*' to match multiple characters and '~' for the user's home directory). # Files and directories to backup. Multiple items can be separated using a comma (','). It is possible to use wildcards (i.e. '*' to match multiple characters and '~' for the user's home directory).
inputs=/home/my_home,/etc inputs=/home/user
# Output directory. # Output directory.
backup_dir=/media/Backup backup_dir=/media/Backup
@ -15,8 +15,8 @@ keep=-1
# Uncomment the following section to enable backup to remote server through ssh # Uncomment the following section to enable backup to remote server through ssh
# [server] # [server]
# host= # ssh_host=
# username= # ssh_user=
# ssh_keyfile= # ssh_keyfile=
# remote_sudo= # remote_sudo=
# numeric_ids= # numeric_ids=

View File

@ -10,9 +10,11 @@ Classes:
MyFormatter MyFormatter
Backup Backup
""" """
# Import libraries # Import libraries
import sys import sys
import os import os
from typing import Callable, List, Optional, ParamSpec, TypeVar, Union
import warnings import warnings
from functools import wraps from functools import wraps
from shutil import rmtree, which from shutil import rmtree, which
@ -25,7 +27,7 @@ from timeit import default_timer
from subprocess import Popen, PIPE, STDOUT from subprocess import Popen, PIPE, STDOUT
from datetime import datetime from datetime import datetime
from tempfile import mkstemp from tempfile import mkstemp
from getpass import getpass from getpass import GetPassWarning, getpass
from glob import glob from glob import glob
from dotenv import load_dotenv from dotenv import load_dotenv
@ -33,7 +35,6 @@ from dotenv import load_dotenv
warnings.filterwarnings('error') warnings.filterwarnings('error')
try: try:
raise ImportError
import paramiko import paramiko
from paramiko import RSAKey, Ed25519Key, ECDSAKey, DSSKey from paramiko import RSAKey, Ed25519Key, ECDSAKey, DSSKey
except ImportError: except ImportError:
@ -51,15 +52,6 @@ except ImportError:
load_dotenv() load_dotenv()
euid = os.geteuid()
if euid == 0:
user = os.getenv('SUDO_USER')
homedir = os.path.expanduser(f'~{user}')
else:
user = os.getenv('USER')
homedir = os.getenv('HOME')
logging.getLogger().setLevel(logging.DEBUG) logging.getLogger().setLevel(logging.DEBUG)
logger = logging.getLogger(os.path.basename(__file__)) logger = logging.getLogger(os.path.basename(__file__))
c_handler = StreamHandler() c_handler = StreamHandler()
@ -76,29 +68,29 @@ if journal:
j_handler.setFormatter(j_format) j_handler.setFormatter(j_format)
logger.addHandler(j_handler) logger.addHandler(j_handler)
P = ParamSpec('P')
R = TypeVar('R')
def timing(_logger):
def timing(func: Callable[P, R]) -> Callable[P, R]:
"""Decorator to measure execution time of a function """Decorator to measure execution time of a function
Parameters: Parameters:
_logger: Logger object func: Function to decorate
""" """
def decorator_timing(func): @wraps(func)
@wraps(func) def wrapper(*args: P.args, **kwargs: P.kwargs) -> R:
def wrapper_timing(*args, **kwargs): start = default_timer()
start = default_timer()
value = func(*args, **kwargs) value = func(*args, **kwargs)
end = default_timer() end = default_timer()
_logger.info(f'Elapsed time: {end - start:.3f} seconds') logger.info('Elapsed time: %.3f seconds', end - start)
return value return value
return wrapper_timing return wrapper
return decorator_timing
class MyFormatter(argparse.RawTextHelpFormatter, argparse.ArgumentDefaultsHelpFormatter): class MyFormatter(argparse.RawTextHelpFormatter, argparse.ArgumentDefaultsHelpFormatter):
@ -119,9 +111,9 @@ class Backup:
String representing main backup options for rsync String representing main backup options for rsync
keep: int keep: int
Number of old backup to preserve Number of old backup to preserve
host: str ssh_host: str
Hostname of server (for remote backup) Hostname of server (for remote backup)
username: str ssh_user: str
Username for server login (for remote backup) Username for server login (for remote backup)
ssh_keyfile: str ssh_keyfile: str
Location of ssh key Location of ssh key
@ -143,30 +135,31 @@ class Backup:
Perform the backup Perform the backup
""" """
def __init__(self, inputs, output, exclude, keep, options, host=None, username=None, def __init__(self, inputs: List[str], output: str, exclude: List[str], keep: int, options: str,
ssh_keyfile=None, remote_sudo=False, remove_before=False): ssh_host: Optional[str] = None, ssh_user: Optional[str] = None, ssh_keyfile: Optional[str] = None,
remote_sudo: bool = False, remove_before: bool = False, verbose: bool = False) -> None:
self.inputs = inputs self.inputs = inputs
self.output = output self.output = output
self.exclude = exclude self.exclude = exclude
self.options = options self.options = options
self.keep = keep self.keep = keep
self.host = host self.ssh_host = ssh_host
self.username = username self.ssh_user = ssh_user
self.ssh_keyfile = ssh_keyfile self.ssh_keyfile = ssh_keyfile
self.remote_sudo = remote_sudo self.remote_sudo = remote_sudo
self._remove_before = remove_before self._remove_before = remove_before
self._verbose = verbose
self._last_backup = '' self._last_backup = ''
self._server = '' self._server = ''
self._output_dir = '' self._output_dir = ''
self._inputs_path = '' self._inputs_path = ''
self._exclude_path = '' self._exclude_path = ''
self._remote = None self._remote = False
self._err_flag = False
self._ssh = None self._ssh = None
self._password_auth = False self._password_auth = False
self._password = None self._password = None
def check_params(self): def check_params(self, homedir: str = '') -> int:
"""Check if parameters for the backup are valid""" """Check if parameters for the backup are valid"""
if self.inputs is None or len(self.inputs) == 0: if self.inputs is None or len(self.inputs) == 0:
@ -179,14 +172,14 @@ class Backup:
return 2 return 2
if self.host is not None and self.username is not None: if self.ssh_host is not None and self.ssh_user is not None:
self._remote = True self._remote = True
if self._remote: if self._remote:
self._ssh = self._ssh_connect() self._ssh = self._ssh_connect(homedir)
if self._ssh is None: if self._ssh is None:
sys.exit(5) return 5
_, stdout, _ = self._ssh.exec_command(f'if [ -d "{self.output}" ]; then echo "ok"; fi') _, stdout, _ = self._ssh.exec_command(f'if [ -d "{self.output}" ]; then echo "ok"; fi')
@ -210,18 +203,20 @@ class Backup:
return 0 return 0
# Function to create the actual backup directory # Function to create the actual backup directory
def define_backup_dir(self): def define_backup_dir(self) -> None:
"""Define the actual backup dir""" """Define the actual backup dir"""
now = datetime.now().strftime('%Y-%m-%d %H:%M:%S') now = datetime.now().strftime('%Y-%m-%d %H:%M:%S')
self._output_dir = f'{self.output}/simple_backup/{now}' self._output_dir = f'{self.output}/simple_backup/{now}'
if self._remote: if self._remote:
self._server = f'{self.username}@{self.host}:' self._server = f'{self.ssh_user}@{self.ssh_host}:'
def remove_old_backups(self): def remove_old_backups(self) -> None:
"""Remove old backups if there are more than indicated by 'keep'""" """Remove old backups if there are more than indicated by 'keep'"""
if self._remote: if self._remote:
assert self._ssh is not None
_, stdout, _ = self._ssh.exec_command(f'ls {self.output}/simple_backup') _, stdout, _ = self._ssh.exec_command(f'ls {self.output}/simple_backup')
dirs = stdout.read().decode('utf-8').strip().split('\n') dirs = stdout.read().decode('utf-8').strip().split('\n')
@ -238,7 +233,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]
@ -278,7 +276,7 @@ class Backup:
elif count > 1: elif count > 1:
logger.info('Removed %d backups', count) logger.info('Removed %d backups', count)
def find_last_backup(self): def find_last_backup(self) -> None:
"""Get path of last backup (from last_backup symlink) for rsync --link-dest""" """Get path of last backup (from last_backup symlink) for rsync --link-dest"""
if self._remote: if self._remote:
@ -304,7 +302,7 @@ class Backup:
logger.critical('Cannot access the backup directory. Permission denied') logger.critical('Cannot access the backup directory. Permission denied')
try: try:
notify('Backup failed (check log for details)') _notify('Backup failed (check log for details)')
except NameError: except NameError:
pass pass
@ -315,26 +313,27 @@ class Backup:
except IndexError: except IndexError:
logger.info('No previous backups available') logger.info('No previous backups available')
def _ssh_connect(self): def _ssh_connect(self, homedir: str = '') -> paramiko.client.SSHClient:
try: try:
ssh = paramiko.SSHClient() ssh = paramiko.SSHClient()
except NameError: except NameError:
logger.error('Install paramiko for ssh support') logger.error('Install paramiko for ssh support')
return None return None
try: try:
ssh.load_host_keys(filename=f'{homedir}/.ssh/known_hosts') ssh.load_host_keys(filename=f'{homedir}/.ssh/known_hosts')
except FileNotFoundError: except FileNotFoundError:
logger.warning(f'Cannot find file {homedir}/.ssh/known_hosts') logger.warning('Cannot find file %s/.ssh/known_hosts', homedir)
ssh.set_missing_host_key_policy(paramiko.WarningPolicy()) ssh.set_missing_host_key_policy(paramiko.WarningPolicy())
try: try:
ssh.connect(self.host, username=self.username) ssh.connect(self.ssh_host, username=self.ssh_user)
return ssh return ssh
except UserWarning: except UserWarning:
k = input(f'Unknown key for host {self.host}. Continue anyway? (Y/N) ') k = input(f'Unknown key for host {self.ssh_host}. Continue anyway? (Y/N) ')
if k[0].upper() == 'Y': if k[0].upper() == 'Y':
ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy()) ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())
@ -349,7 +348,7 @@ class Backup:
pass pass
try: try:
ssh.connect(self.host, username=self.username) ssh.connect(self.ssh_host, username=self.ssh_user)
return ssh return ssh
except paramiko.SSHException: except paramiko.SSHException:
@ -357,13 +356,18 @@ class Backup:
if self.ssh_keyfile is None: if self.ssh_keyfile is None:
try: try:
password = getpass(f'{self.username}@{self.host}\'s password: ') password = getpass(f'{self.ssh_user}@{self.ssh_host}\'s password: ')
ssh.connect(self.host, username=self.username, password=password) ssh.connect(self.ssh_host, username=self.ssh_user, password=password)
self._password_auth = True self._password_auth = True
os.environ['SSHPASS'] = password os.environ['SSHPASS'] = password
return ssh return ssh
except GetPassWarning as e:
logger.critical('Unable to get password')
logger.critical(e)
return None
except paramiko.SSHException as e: except paramiko.SSHException as e:
logger.critical('Can\'t connect to the server.') logger.critical('Can\'t connect to the server.')
logger.critical(e) logger.critical(e)
@ -410,7 +414,7 @@ class Backup:
pass pass
try: try:
ssh.connect(self.host, username=self.username, pkey=pkey) ssh.connect(self.ssh_host, username=self.ssh_user, pkey=pkey)
except paramiko.SSHException: except paramiko.SSHException:
logger.critical('SSH connection to server failed') logger.critical('SSH connection to server failed')
@ -418,9 +422,38 @@ class Backup:
return ssh return ssh
def _returncode_log(self, returncode: int) -> None:
match returncode:
case 2:
logger.error('Rsync error (return code 2) - Protocol incompatibility')
case 3:
logger.error('Rsync error (return code 3) - Errors selecting input/output files, dirs')
case 4:
logger.error('Rsync error (return code 4) - Requested action not supported')
case 5:
logger.error('Rsync error (return code 5) - Error starting client-server protocol')
case 10:
logger.error('Rsync error (return code 10) - Error in socket I/O')
case 11:
logger.error('Rsync error (return code 11) - Error in file I/O')
case 12:
logger.error('Rsync error (return code 12) - Error in rsync protocol data stream')
case 22:
logger.error('Rsync error (return code 22) - Error allocating core memory buffers')
case 23:
logger.warning('Rsync error (return code 23) - Partial transfer due to error')
case 24:
logger.warning('Rsync error (return code 24) - Partial transfer due to vanished source files')
case 30:
logger.error('Rsync error (return code 30) - Timeout in data send/receive')
case 35:
logger.error('Rsync error (return code 35) - Timeout waiting for daemon connection')
case _:
logger.error('Rsync error (return code %d) - Check rsync(1) for details', returncode)
# Function to read configuration file # Function to read configuration file
@timing(logger) @timing
def run(self): def run(self) -> int:
"""Perform the backup""" """Perform the backup"""
logger.info('Starting backup...') logger.info('Starting backup...')
@ -449,7 +482,7 @@ class Backup:
logger.info('No existing files or directories specified for backup. Nothing to do') logger.info('No existing files or directories specified for backup. Nothing to do')
try: try:
notify('Backup finished. No files copied') _notify('Backup finished. No files copied')
except NameError: except NameError:
pass pass
@ -475,10 +508,12 @@ class Backup:
rsync = f'/usr/bin/rsync {self.options} --link-dest="{self._last_backup}" --exclude-from=' +\ rsync = f'/usr/bin/rsync {self.options} --link-dest="{self._last_backup}" --exclude-from=' +\
f'{self._exclude_path} --files-from={self._inputs_path} / "{self._server}{self._output_dir}"' f'{self._exclude_path} --files-from={self._inputs_path} / "{self._server}{self._output_dir}"'
euid = os.geteuid()
if euid == 0 and self.ssh_keyfile is not None: if euid == 0 and self.ssh_keyfile is not None:
rsync = f'{rsync} -e \'ssh -i {self.ssh_keyfile} -o StrictHostKeyChecking=no\'' rsync = f'{rsync} -e \'ssh -i {self.ssh_keyfile} -o StrictHostKeyChecking=no\''
elif self._password_auth and which('sshpass'): elif self._password_auth and which('sshpass'):
rsync = f'{rsync} -e \'sshpass -e ssh -l {self.username} -o StrictHostKeyChecking=no\'' rsync = f'{rsync} -e \'sshpass -e ssh -l {self.ssh_user} -o StrictHostKeyChecking=no\''
else: else:
rsync = f'{rsync} -e \'ssh -o StrictHostKeyChecking=no\'' rsync = f'{rsync} -e \'ssh -o StrictHostKeyChecking=no\''
@ -488,6 +523,7 @@ class Backup:
args = shlex.split(rsync) args = shlex.split(rsync)
with Popen(args, stdin=PIPE, stdout=PIPE, stderr=STDOUT, shell=False) as p: with Popen(args, stdin=PIPE, stdout=PIPE, stderr=STDOUT, shell=False) as p:
output: Union[bytes, List[str]]
output, _ = p.communicate() output, _ = p.communicate()
try: try:
@ -495,16 +531,24 @@ class Backup:
except KeyError: except KeyError:
pass pass
if p.returncode != 0: returncode = p.returncode
self._err_flag = True
output = output.decode("utf-8").split('\n') output = output.decode("utf-8").split('\n')
if self._err_flag: if returncode == 0:
logger.error('rsync: %s', output) if self._verbose:
logger.info('rsync: %s', output)
else:
logger.info('rsync: %s', output[-3])
logger.info('rsync: %s', output[-2])
else: else:
logger.info('rsync: %s', output[-3]) self._returncode_log(returncode)
logger.info('rsync: %s', output[-2])
if self._verbose:
if returncode in [23, 24]:
logger.warning(output)
else:
logger.error(output)
if self.keep != -1 and not self._remove_before: if self.keep != -1 and not self._remove_before:
self.remove_old_backups() self.remove_old_backups()
@ -513,6 +557,8 @@ class Backup:
os.remove(self._exclude_path) os.remove(self._exclude_path)
if self._remote: if self._remote:
assert self._ssh is not None
_, stdout, _ = self._ssh.exec_command(f'if [ -d "{self._output_dir}" ]; then echo "ok"; fi') _, stdout, _ = self._ssh.exec_command(f'if [ -d "{self._output_dir}" ]; then echo "ok"; fi')
output = stdout.read().decode('utf-8').strip() output = stdout.read().decode('utf-8').strip()
@ -535,7 +581,7 @@ class Backup:
if self._ssh: if self._ssh:
self._ssh.close() self._ssh.close()
else: else:
if self._err_flag: if returncode != 0:
logger.error('Some errors occurred while performing the backup') logger.error('Some errors occurred while performing the backup')
try: try:
@ -544,34 +590,44 @@ class Backup:
pass pass
return 4 return 4
else:
logger.info('Backup completed')
try: logger.info('Backup completed')
_notify('Backup completed')
except NameError: try:
pass _notify('Backup completed')
except NameError:
pass
return 0 return 0
def _parse_arguments(): def _parse_arguments():
euid = os.geteuid()
if euid == 0:
user = os.getenv('SUDO_USER')
else:
user = os.getenv('USER')
homedir = os.path.expanduser(f'~{user}')
parser = argparse.ArgumentParser(prog='simple_backup', parser = argparse.ArgumentParser(prog='simple_backup',
description='Simple backup script written in Python that uses rsync to copy files', description='Simple backup script written in Python that uses rsync to copy files',
epilog='See simple_backup(1) manpage for full documentation', epilog='See simple_backup(1) manpage for full documentation',
formatter_class=MyFormatter) formatter_class=MyFormatter)
parser.add_argument('-v', '--verbose', action='store_true', help='More verbose output')
parser.add_argument('-c', '--config', default=f'{homedir}/.config/simple_backup/simple_backup.conf', parser.add_argument('-c', '--config', default=f'{homedir}/.config/simple_backup/simple_backup.conf',
help='Specify location of configuration file') help='Specify location of configuration file')
parser.add_argument('-i', '--inputs', nargs='+', help='Paths/files to backup') parser.add_argument('-i', '--inputs', nargs='+', help='Paths/files to backup')
parser.add_argument('-o', '--output', help='Output directory for the backup') parser.add_argument('-o', '--output', help='Output directory for the backup')
parser.add_argument('-e', '--exclude', nargs='+', help='Files/directories/patterns to exclude from the backup') parser.add_argument('-e', '--exclude', nargs='+', help='Files/directories/patterns to exclude from the backup')
parser.add_argument('-k', '--keep', type=int, help='Number of old backups to keep') parser.add_argument('-k', '--keep', type=int, help='Number of old backups to keep')
parser.add_argument('--host', help='Server hostname (for remote backup)') parser.add_argument('-u', '--user', help='Explicitly specify the user running the backup')
parser.add_argument('-u', '--username', help='Username to connect to server (for remote backup)') parser.add_argument('-s', '--checksum', action='store_true', help='Use checksum rsync option to compare files')
parser.add_argument('--ssh-host', help='Server hostname (for remote backup)')
parser.add_argument('--ssh-user', help='Username to connect to server (for remote backup)')
parser.add_argument('--keyfile', help='SSH key location') parser.add_argument('--keyfile', help='SSH key location')
parser.add_argument('-s', '--checksum', action='store_true',
help='Use checksum rsync option to compare files')
parser.add_argument('-z', '--compress', action='store_true', help='Compress data during the transfer') parser.add_argument('-z', '--compress', action='store_true', help='Compress data during the transfer')
parser.add_argument('--remove-before-backup', action='store_true', parser.add_argument('--remove-before-backup', action='store_true',
help='Remove old backups before executing the backup, instead of after') help='Remove old backups before executing the backup, instead of after')
@ -581,21 +637,27 @@ def _parse_arguments():
help='Specify options for rsync') help='Specify options for rsync')
parser.add_argument('--remote-sudo', action='store_true', help='Run rsync on remote server with sudo if allowed') parser.add_argument('--remote-sudo', action='store_true', help='Run rsync on remote server with sudo if allowed')
parser.add_argument('--numeric-ids', action='store_true', parser.add_argument('--numeric-ids', action='store_true',
help='Use rsync \'--numeric-ids\' option (don\'t map uid/gid values by name') help='Use rsync \'--numeric-ids\' option (don\'t map uid/gid values by name)')
args = parser.parse_args() args = parser.parse_args()
return args return args
def _expand_inputs(inputs): def _expand_inputs(inputs, user=None):
expanded_inputs = [] expanded_inputs = []
for i in inputs: for i in inputs:
if i == '': if i == '':
continue continue
i_ex = glob(os.path.expanduser(i.replace('~', f'~{user}'))) if user is not None:
i_ex = glob(os.path.expanduser(i.replace('~', f'~{user}')))
else:
i_ex = glob(i)
if '~' in i:
logger.warning('Cannot expand \'~\'. No user specified')
if len(i_ex) == 0: if len(i_ex) == 0:
logger.warning('No file or directory matching input %s. Skipping...', i) logger.warning('No file or directory matching input %s. Skipping...', i)
@ -605,13 +667,13 @@ def _expand_inputs(inputs):
return expanded_inputs return expanded_inputs
def _read_config(config_file): def _read_config(config_file, user=None):
config_args = {'inputs': None, config_args = {'inputs': None,
'output': None, 'output': None,
'exclude': None, 'exclude': None,
'keep': -1, 'keep': -1,
'host': None, 'ssh_host': None,
'username': None, 'ssh_user': None,
'ssh_keyfile': None, 'ssh_keyfile': None,
'remote_sudo': False, 'remote_sudo': False,
'numeric_ids': False} 'numeric_ids': False}
@ -634,13 +696,17 @@ def _read_config(config_file):
inputs = config.get(section, 'inputs') inputs = config.get(section, 'inputs')
inputs = inputs.split(',') inputs = inputs.split(',')
inputs = _expand_inputs(inputs) inputs = _expand_inputs(inputs, user)
inputs = list(set(inputs)) inputs = list(set(inputs))
config_args['inputs'] = inputs config_args['inputs'] = inputs
output = config.get(section, 'backup_dir') output = config.get(section, 'backup_dir')
output = os.path.expanduser(output.replace('~', f'~{user}'))
if user is not None:
output = os.path.expanduser(output.replace('~', f'~{user}'))
elif user is None and '~' in output:
logger.warning('Cannot expand \'~\', no user specified')
config_args['output'] = output config_args['output'] = output
@ -660,14 +726,14 @@ def _read_config(config_file):
config_args['keep'] = keep config_args['keep'] = keep
try: try:
host = config.get('server', 'host') ssh_host = config.get('server', 'ssh_host')
username = config.get('server', 'username') ssh_user = config.get('server', 'ssh_user')
except (configparser.NoSectionError, configparser.NoOptionError): except (configparser.NoSectionError, configparser.NoOptionError):
host = None ssh_host = None
username = None ssh_user = None
config_args['host'] = host config_args['ssh_host'] = ssh_host
config_args['username'] = username config_args['ssh_user'] = ssh_user
try: try:
ssh_keyfile = config.get('server', 'ssh_keyfile') ssh_keyfile = config.get('server', 'ssh_keyfile')
@ -694,12 +760,15 @@ def _read_config(config_file):
def _notify(text): def _notify(text):
_euid = os.geteuid() euid = os.geteuid()
if _euid == 0: if euid == 0:
uid = os.getenv('SUDO_UID') uid = os.getenv('SUDO_UID')
else: else:
uid = os.geteuid() uid = euid
if uid is None:
return
os.seteuid(int(uid)) os.seteuid(int(uid))
os.environ['DBUS_SESSION_BUS_ADDRESS'] = f'unix:path=/run/user/{uid}/bus' os.environ['DBUS_SESSION_BUS_ADDRESS'] = f'unix:path=/run/user/{uid}/bus'
@ -708,7 +777,7 @@ def _notify(text):
obj = dbus.Interface(obj, 'org.freedesktop.Notifications') obj = dbus.Interface(obj, 'org.freedesktop.Notifications')
obj.Notify('', 0, '', 'simple_backup', text, [], {'urgency': 1}, 10000) obj.Notify('', 0, '', 'simple_backup', text, [], {'urgency': 1}, 10000)
os.seteuid(int(_euid)) os.seteuid(int(euid))
def simple_backup(): def simple_backup():
@ -716,6 +785,22 @@ def simple_backup():
args = _parse_arguments() args = _parse_arguments()
if args.user:
user = args.user
homedir = os.path.expanduser(f'~{user}')
else:
euid = os.geteuid()
if euid == 0:
user = os.getenv('SUDO_USER')
homedir = os.path.expanduser(f'~{user}')
else:
user = os.getenv('USER')
homedir = os.getenv('HOME')
if homedir is None:
homedir = ''
if args.no_syslog: if args.no_syslog:
try: try:
logger.removeHandler(j_handler) logger.removeHandler(j_handler)
@ -723,19 +808,20 @@ def simple_backup():
pass pass
try: try:
config_args = _read_config(args.config) config_args = _read_config(args.config, user)
except (configparser.NoSectionError, configparser.NoOptionError): except (configparser.NoSectionError, configparser.NoOptionError):
logger.critical('Bad configuration file') logger.critical('Bad configuration file')
sys.exit(6)
return 6
inputs = args.inputs if args.inputs is not None else config_args['inputs'] inputs = args.inputs if args.inputs is not None else config_args['inputs']
output = args.output if args.output is not None else config_args['output'] output = args.output if args.output is not None else config_args['output']
exclude = args.exclude if args.exclude is not None else config_args['exclude'] exclude = args.exclude if args.exclude is not None else config_args['exclude']
keep = args.keep if args.keep is not None else config_args['keep'] keep = args.keep if args.keep is not None else config_args['keep']
host = args.host if args.host is not None else config_args['host'] ssh_host = args.ssh_host if args.ssh_host is not None else config_args['ssh_host']
username = args.username if args.username is not None else config_args['username'] ssh_user = args.ssh_user if args.ssh_user is not None else config_args['ssh_user']
ssh_keyfile = args.keyfile if args.keyfile is not None else config_args['ssh_keyfile'] ssh_keyfile = args.keyfile if args.keyfile is not None else config_args['ssh_keyfile']
remote_sudo = args.remote_sudo if args.remote_sudo is not None else config_args['remote_sudo'] remote_sudo = args.remote_sudo or config_args['remote_sudo']
if args.rsync_options is None: if args.rsync_options is None:
rsync_options = ['-a', '-r', '-v', '-h', '-H', '-X', '-s', '--ignore-missing-args', '--mkpath'] rsync_options = ['-a', '-r', '-v', '-h', '-H', '-X', '-s', '--ignore-missing-args', '--mkpath']
@ -756,10 +842,10 @@ def simple_backup():
rsync_options = ' '.join(rsync_options) rsync_options = ' '.join(rsync_options)
backup = Backup(inputs, output, exclude, keep, rsync_options, host, username, ssh_keyfile, backup = Backup(inputs, output, exclude, keep, rsync_options, ssh_host, ssh_user, ssh_keyfile,
remote_sudo, remove_before=args.remove_before_backup) remote_sudo, remove_before=args.remove_before_backup, verbose=args.verbose)
return_code = backup.check_params() return_code = backup.check_params(homedir)
if return_code == 0: if return_code == 0:
return backup.run() return backup.run()