python-bareos 23.0.1__py3-none-any.whl → 23.0.4__py3-none-any.whl

bareos/VERSION.txt

@@ -1 +1 @@
-23.0.1
+23.0.4

bareos/bsock/__init__.py

@@ -1,6 +1,6 @@
 #   BAREOS - Backup Archiving REcovery Open Sourced
 #
-#   Copyright (C) 2016-2020 Bareos GmbH & Co. KG
+#   Copyright (C) 2016-2024 Bareos GmbH & Co. KG
 #
 #   This program is Free Software; you can redistribute it and/or
 #   modify it under the terms of version three of the GNU Affero General Public
@@ -17,17 +17,18 @@
 #   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 #   02110-1301, USA.
 
-"""Module to access a http://www.bareos.org backup system.
+"""Module to access a https://www.bareos.com backup system.
 
 .. note::
 
-   By default, the Bareos Director (>= 18.2.4) uses TLS-PSK when communicating through the network.
+   By default, the Bareos Director (>= 18.2.4)
+   uses TLS-PSK when communicating through the network.
 
-   Unfortunately the Python core module ``ssl``
-   does not support TLS-PSK.
-   For testing this module should be used without TLS.
+   The Python (https://github.com/python/cpython) core module ``ssl``
+   does support TLS-PSK only since Python >= 3.13.
    The section `Transport Encryption (TLS-PSK)`_ describes
    how to use TLS-PSK and about the limitations.
+   For testing this module can also be used without TLS.
 
 
 Preparations
@@ -44,7 +45,7 @@ Create some named consoles for testing:
 
 This creates a console user with name `user1` and the profile `operator`.
 The `operator` profile is a default profile that comes with the Bareos Director.
-It does allow most commands. It only deny some dangerous commands (see ``show profile=operator``),
+It does allow most commands, but deny some dangerous commands (see ``show profile=operator``),
 so it is well suited for this purpose.
 Futhermore, TLS enforcement is disabled for this console user.
 
@@ -119,6 +120,7 @@ Example:
    Full
    Differential
 
+
 The results the the `call` method is a ``dict`` object.
 
 In case of an error, an exception, derived from :py:class:`bareos.exceptions.Error` is raised.
@@ -142,22 +144,25 @@ Transport Encryption (TLS-PSK)
 
 Since Bareos >= 18.2.4, Bareos supports TLS-PSK (Transport-Layer-Security Pre-Shared-Key) to secure its network connections and uses this by default.
 
-Unfortenatly, the Python core module `ssl` does not support TLS-PSK.
-There is limited support by the extra module `sslpsk` (see https://github.com/drbild/sslpsk).
+Unfortunately the Python core module ``ssl`` does support TLS-PSK only with Python >= 3.13.
+For some older versions of Python,
+the extra module ``sslpsk`` (see https://github.com/drbild/sslpsk) offers limited support.
 
 Fallback To Unencrypted Connections
 -----------------------------------
 
-In order to work in most cases, even if ``sslpsk`` is not available,
-the `DirectorConsole` uses a fallback.
+Normally `DirectorConsole` tries to connect using the latest known protocol version.
+In order to allow connections in more environments,
+the `DirectorConsole` can fall back to older protocol versions.
+Specify `protocolversion = None` (or 0 as command line argument) to enable automatic fall back.
 If connecting via TLS-PSK fails, it falls back to the old, unencrypted protocol version.
-In this case, a warning is issued, but the connection will work nevertheless:
+Depending on your bareos-director configuration, unencrypted connections will be accepted:
 
 .. code:: python
 
    >>> import bareos.bsock
-   /.../bareos/bsock/lowlevel.py:39: UserWarning: Connection encryption via TLS-PSK is not available, as the module sslpsk is not installed.
-   >>> directorconsole=bareos.bsock.DirectorConsole(address='localhost', port=9101, name='user-tls', password='secret')
+   /.../bareos/bsock/lowlevel.py:39: UserWarning: Connection encryption via TLS-PSK is not available (TLS-PSK is not available in the ssl module and the extra module sslpsk is not installed).
+   >>> directorconsole=bareos.bsock.DirectorConsole(address='localhost', port=9101, name='user-tls', password='secret', protocolversion=None)
    socket error: Conversation terminated (-4)
    Failed to connect using protocol version 2. Trying protocol version 1.
    >>> print(directorconsole.call('help').decode("utf-8"))
@@ -172,7 +177,7 @@ To enforce a encrypted connection, use the ``tls_psk_require=True`` parameter:
    >>> directorconsole=bareos.bsock.DirectorConsole(address='localhost', port=9101, name='user-tls', password='secret', tls_psk_require=True)
    Traceback (most recent call last):
    ...
-   bareos.exceptions.ConnectionError: TLS-PSK is required, but sslpsk module not loaded/available.
+   bareos.exceptions.ConnectionError: TLS-PSK is required, but not available.
 
 
 In this case, an exception is raised, if the connection can not be established via TLS-PSK.
@@ -183,10 +188,18 @@ sslpsk
 The extra module `sslpsk` (see https://github.com/drbild/sslpsk)
 extends the core module `ssl` by TLS-PSK.
 
-At the time of writing, the lasted version installable via pip is 1.0.0 (https://pypi.org/project/sslpsk/), which is not working with Python >= 3.
+At the time of writing, the lasted version installable via pip is 1.0.0 (https://pypi.org/project/sslpsk/),
+which is not working with Python >= 3.
+
+For using `python-bareos` with TLS-PSK with
+Python >= 3 and Python <= 3.9
+the latest version must by installed manually.
+At the time of writing, even the latest version
+(https://github.com/drbild/sslpsk/commit/d88123a75786953f82f5e25d6c43d9d9259acb62)
+does not support Python >= 3.10.
+However, Python >= 3.13 has direct support for TLS-PSK in the core `ssl` module.
 
-If `python-bareos` should use TLS-PSK with Python >= 3,
-the latest version must by installed manually:
+Installing the `sslpsk` module manually:
 
 .. code:: shell
 

bareos/bsock/directorconsole.py

@@ -1,6 +1,6 @@
 #   BAREOS - Backup Archiving REcovery Open Sourced
 #
-#   Copyright (C) 2016-2023 Bareos GmbH & Co. KG
+#   Copyright (C) 2016-2024 Bareos GmbH & Co. KG
 #
 #   This program is Free Software; you can redistribute it and/or
 #   modify it under the terms of version three of the GNU Affero General Public
@@ -22,7 +22,6 @@ Send and receive the response to Bareos Director Daemon Console interface.
 """
 
 from bareos.bsock.connectiontype import ConnectionType
-from bareos.bsock.constants import Constants
 from bareos.bsock.lowlevel import LowLevel
 from bareos.bsock.protocolmessageids import ProtocolMessageIds
 from bareos.bsock.protocolmessages import ProtocolMessages
@@ -61,16 +60,19 @@ class DirectorConsole(LowLevel):
            >>> director = DirectorConsole(**bareos_args)
 
         Args:
-          argparser (ArgParser): ArgParser instance.
+          argparser (ArgParser or ConfigArgParser): (Config)ArgParser instance.
         """
-        argparser.add_argument(
+
+        group = argparser.add_argument_group(title="Bareos Director connection options")
+
+        group.add_argument(
             "--name",
             default="*UserAgent*",
-            help='use this to access a specific Bareos director named console. Otherwise it connects to the default console ("*UserAgent*").',
+            help='use this to access a specific Bareos director named console. Otherwise it connects to the default console ("%(default)s").',
             dest="BAREOS_name",
         )
 
-        argparser.add_argument(
+        group.add_argument(
             "-p",
             "--password",
             help="Password to authenticate to a Bareos Director console.",
@@ -78,58 +80,58 @@ class DirectorConsole(LowLevel):
             dest="BAREOS_password",
         )
 
-        argparser.add_argument(
+        group.add_argument(
             "--port",
             default=9101,
-            help="Bareos Director network port.",
+            help="Bareos Director network port. Default: %(default)s.",
             dest="BAREOS_port",
         )
 
         # argparser.add_argument('--dirname', help="Bareos Director name")
-        argparser.add_argument(
+        group.add_argument(
             "--address",
             default="localhost",
-            help="Bareos Director network address.",
+            help="Bareos Director network address. Default: %(default)s.",
             dest="BAREOS_address",
         )
 
-        argparser.add_argument(
+        group.add_argument(
             "--timeout",
             type=int,
             help="Timeout (in seconds) for the connection to the Bareos Director.",
             dest="BAREOS_timeout",
         )
 
-        argparser.add_argument(
+        group.add_argument(
             "--protocolversion",
-            default=ProtocolVersions.last,
             type=int,
-            help="Specify the Bareos console protocol version. Default: {0} (current).".format(
-                ProtocolVersions.last
-            ),
+            choices=set(protocolversion.value for protocolversion in ProtocolVersions)
+            | set([0]),
+            default=ProtocolVersions.last.value,
+            help="Specify the Bareos console protocol version (0: auto-detect, %(default)s: latest). Default: %(default)s.",
             dest="BAREOS_protocolversion",
         )
 
-        argparser.add_argument(
+        group.add_argument(
             "--pam-username",
             help="Username to authenticate against PAM on top off the normal authentication.",
             dest="BAREOS_pam_username",
         )
 
-        argparser.add_argument(
+        group.add_argument(
             "--pam-password",
             help="Password to authenticate against PAM on top off the normal authentication.",
             dest="BAREOS_pam_password",
         )
 
-        argparser.add_argument(
+        group.add_argument(
             "--tls-psk-require",
-            help="Allow only encrypted connections. Default: False.",
+            help="Allow only encrypted connections. Default: %(default)s.",
             action="store_true",
             dest="BAREOS_tls_psk_require",
         )
 
-        TlsVersionParser().add_argument(argparser)
+        TlsVersionParser().add_argument(group)
 
     def __init__(
         self,
@@ -192,7 +194,7 @@ class DirectorConsole(LowLevel):
         if tls_version is not None:
             self.tls_version = tls_version
         self.identity_prefix = "R_CONSOLE"
-        if protocolversion is not None:
+        if protocolversion is not None and protocolversion > 0:
             self.requested_protocol_version = int(protocolversion)
             self.protocol_messages.set_version(self.requested_protocol_version)
         self.connect(

bareos/bsock/lowlevel.py

@@ -1,6 +1,6 @@
 #   BAREOS - Backup Archiving REcovery Open Sourced
 #
-#   Copyright (C) 2015-2023 Bareos GmbH & Co. KG
+#   Copyright (C) 2015-2024 Bareos GmbH & Co. KG
 #
 #   This program is Free Software; you can redistribute it and/or
 #   modify it under the terms of version three of the GNU Affero General Public
@@ -46,17 +46,26 @@ from bareos.util.bareosbase64 import BareosBase64
 from bareos.util.password import Password
 import bareos.exceptions
 
-# Try to load the sslpsk module,
-# with implement TLS-PSK (Transport Layer Security - Pre-Shared-Key)
-# on top of the ssl module.
-# If it is not available, we continue anyway,
+# The ssl module support TLS-PSK (Transport Layer Security - Pre-Shared-Key)
+# since Python >= 3.13.
+# For some older Python versions, the TLS-PSK functionality
+# can be added by the sslpsk module,
+# with implement TLS-PSK on top of the ssl module.
+# If it is also not available, we continue anyway,
 # but don't use TLS-PSK.
-try:
-    import sslpsk
-except ImportError:
-    warnings.warn(
-        "Connection encryption via TLS-PSK is not available, as the module sslpsk is not installed."
-    )
+if not getattr(ssl, "HAS_PSK", False):
+
+    def format_warning_short(message, category, filename, lineno, line=""):
+        return f"{category.__name__}: {message}\n"
+
+    warnings.formatwarning = format_warning_short
+    try:
+        import sslpsk
+    except ImportError:
+        warnings.warn(
+            "Connection encryption via TLS-PSK is not available "
+            "(not available in 'ssl' and extra module 'sslpsk' is not installed)."
+        )
 
 
 class LowLevel(object):
@@ -71,7 +80,7 @@ class LowLevel(object):
     def argparser_get_bareos_parameter(args):
         """Extract arguments.
 
-        This method is usally used together with the method :py:func:`argparser_add_default_command_line_arguments`.
+        This method is usually used together with the method :py:func:`argparser_add_default_command_line_arguments`.
 
         Args:
            args (ArgParser.Namespace): Arguments retrieved by :py:func:`ArgumentParser.parse_args`.
@@ -182,7 +191,7 @@ class LowLevel(object):
         if self.tls_psk_require:
             if not self.is_tls_psk_available():
                 raise bareos.exceptions.ConnectionError(
-                    "TLS-PSK is required, but sslpsk module not loaded/available."
+                    "TLS-PSK is required, but not available."
                 )
             if not self.tls_psk_enable:
                 raise bareos.exceptions.ConnectionError(
@@ -267,23 +276,32 @@ class LowLevel(object):
         else:
             raise bareos.exceptions.ConnectionError("No password provided.")
         self.logger.debug("identity = {0}, password = {1}".format(identity, password))
-        try:
-            self.socket = sslpsk.wrap_socket(
-                client_socket,
-                ssl_version=self.tls_version,
-                ciphers="ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH",
-                psk=(password, identity),
-                server_side=False,
-            )
-        except ssl.SSLError as e:
-            # raise ConnectionError(
-            #     "failed to connect to host {0}, port {1}: {2}".format(self.address, self.port, str(e)))
-            # Using a general raise keep more information about the type of error.
-            raise
+        ciphers = "ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH"
+
+        if getattr(ssl, "HAS_PSK", False):
+            context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
+            context.check_hostname = False
+            context.set_ciphers(ciphers)
+            context.set_psk_client_callback(lambda hint: (identity, password))
+            self.socket = context.wrap_socket(client_socket, server_side=False)
+        else:
+            try:
+                self.socket = sslpsk.wrap_socket(
+                    client_socket,
+                    ssl_version=self.tls_version,
+                    ciphers=ciphers,
+                    psk=(password, identity),
+                    server_side=False,
+                )
+            except ssl.SSLError as e:
+                # raise ConnectionError(
+                #     "failed to connect to host {0}, port {1}: {2}".format(self.address, self.port, str(e)))
+                # Using a general raise to keep more information about the type of error.
+                raise
         return True
 
     def get_tls_psk_identity(self):
-        """Bareos TLS-PSK excepts the identiy is a specific format."""
+        """Bareos TLS-PSK excepts the identity is a specific format."""
         name = str(self.name)
         if isinstance(self.name, bytes):
             name = self.name.decode("utf-8")
@@ -294,8 +312,8 @@ class LowLevel(object):
 
     @staticmethod
     def is_tls_psk_available():
-        """Checks if we have all required modules for TLS-PSK."""
-        return "sslpsk" in sys.modules
+        """Checks if TLS-PSK is available."""
+        return getattr(ssl, "HAS_PSK", False) or ("sslpsk" in sys.modules)
 
     def get_protocol_version(self):
         """Get the Bareos Console protocol version that is used.
@@ -524,7 +542,7 @@ class LowLevel(object):
         msg = self.recv_submsg(length)
         return msg
 
-    def recv_msg(self, regex=b"^\d\d\d\d OK.*$"):
+    def recv_msg(self, regex=b"^\\d\\d\\d\\d OK.*$"):
         """Receive a full message.
 
         It retrieves messages (header + message text),

bareos/bsock/protocolversions.py

@@ -1,6 +1,6 @@
 #   BAREOS - Backup Archiving REcovery Open Sourced
 #
-#   Copyright (C) 2019-2021 Bareos GmbH & Co. KG
+#   Copyright (C) 2019-2024 Bareos GmbH & Co. KG
 #
 #   This program is Free Software; you can redistribute it and/or
 #   modify it under the terms of version three of the GNU Affero General Public
@@ -21,8 +21,10 @@
 Bareos Protocol Versions.
 """
 
+from enum import IntEnum
 
-class ProtocolVersions(object):
+
+class ProtocolVersions(IntEnum):
     """
     Bareos Protocol Versions.
     """

bareos/bsock/tlsversionparser.py

@@ -1,6 +1,6 @@
 #   BAREOS - Backup Archiving REcovery Open Sourced
 #
-#   Copyright (C) 2020-2021 Bareos GmbH & Co. KG
+#   Copyright (C) 2020-2024 Bareos GmbH & Co. KG
 #
 #   This program is Free Software; you can redistribute it and/or
 #   modify it under the terms of version three of the GNU Affero General Public
@@ -57,7 +57,7 @@ class TlsVersionParser:
     def add_argument(self, argparser):
         argparser.add_argument(
             "--tls-version",
-            help="Use a specific TLS protocol version.",
+            help="Use a specific TLS protocol version (only used with the sslpsk module).",
             action=ArgParserTlsVersionAction,
             choices=OrderedDict(sorted(self.tls_version_options.items())),
             dest="BAREOS_tls_version",

bareos/util/__init__.py

@@ -1,6 +1,6 @@
 #   BAREOS - Backup Archiving REcovery Open Sourced
 #
-#   Copyright (C) 2015-2023 Bareos GmbH & Co. KG
+#   Copyright (C) 2015-2024 Bareos GmbH & Co. KG
 #
 #   This program is Free Software; you can redistribute it and/or
 #   modify it under the terms of version three of the GNU Affero General Public
@@ -21,9 +21,10 @@
 Bareos utility classes.
 """
 
+from bareos.util.argparse import ArgumentParser
 from bareos.util.bareosbase64 import BareosBase64
 from bareos.util.password import Password
 from bareos.util.path import Path
 from bareos.util.version import Version
 
-__all__ = ["BareosBase64", "Password", "Path", "Version"]
+__all__ = ["ArgumentParser", "BareosBase64", "Password", "Path", "Version"]

bareos/util/argparse.py

@@ -0,0 +1,52 @@
+#   BAREOS - Backup Archiving REcovery Open Sourced
+#
+#   Copyright (C) 2024-2024 Bareos GmbH & Co. KG
+#
+#   This program is Free Software; you can redistribute it and/or
+#   modify it under the terms of version three of the GNU Affero General Public
+#   License as published by the Free Software Foundation and included
+#   in the file LICENSE.
+#
+#   This program is distributed in the hope that it will be useful, but
+#   WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+#   Affero General Public License for more details.
+#
+#   You should have received a copy of the GNU Affero General Public License
+#   along with this program; if not, write to the Free Software
+#   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+#   02110-1301, USA.
+
+"""
+ArgumentParser wrapper.
+
+Uses configargparse, if available,
+otherwise, falls back to argparse.
+"""
+
+from pprint import pformat
+
+HAVE_CONFIG_ARG_PARSE_MODULE = False
+try:
+    import configargparse as argparse
+
+    HAVE_CONFIG_ARG_PARSE_MODULE = True
+except ImportError:
+    import argparse
+
+
+class ArgumentParser(argparse.ArgumentParser):
+    """ArgumentParser wrapper"""
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        if HAVE_CONFIG_ARG_PARSE_MODULE:
+            self.add_argument(
+                "-c", "--config", is_config_file=True, help="Config file path."
+            )
+
+    def format_values(self):
+        try:
+            return super().format_values()
+        except AttributeError:
+            return pformat(vars(self.parse_args()))

bareos/util/path.py

@@ -1,6 +1,6 @@
 #   BAREOS - Backup Archiving REcovery Open Sourced
 #
-#   Copyright (C) 2015-2021 Bareos GmbH & Co. KG
+#   Copyright (C) 2015-2024 Bareos GmbH & Co. KG
 #
 #   This program is Free Software; you can redistribute it and/or
 #   modify it under the terms of version three of the GNU Affero General Public
@@ -21,8 +21,6 @@
 Handle file paths.
 """
 
-from copy import copy
-
 
 class Path(object):
     """
@@ -55,7 +53,7 @@ class Path(object):
         self.path = None
 
     def set_path(self, path):
-        if path == None:
+        if path is None:
             self.__set_defaults()
         elif isinstance(path, str):
             self.path_orig = path
@@ -76,10 +74,9 @@ class Path(object):
             pass
 
     def get(self, index=None):
-        if index == None:
+        if index is None:
             return self.path
-        else:
-            return self.path[index]
+        return self.path[index]
 
     def shift(self):
         """

{python_bareos-23.0.1.data → python_bareos-23.0.4.data}/scripts/bareos-fd-connect.py

@@ -1,7 +1,8 @@
 #!python
+#
 #   BAREOS - Backup Archiving REcovery Open Sourced
 #
-#   Copyright (C) 2019-2020 Bareos GmbH & Co. KG
+#   Copyright (C) 2019-2024 Bareos GmbH & Co. KG
 #
 #   This program is Free Software; you can redistribute it and/or
 #   modify it under the terms of version three of the GNU Affero General Public
@@ -18,8 +19,7 @@
 #   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 #   02110-1301, USA.
 
-
-import argparse
+from bareos.util import argparse
 import bareos.bsock
 from bareos.bsock.filedaemon import FileDaemon
 import logging
@@ -53,11 +53,11 @@ if __name__ == "__main__":
     logger.debug("options: %s" % (bareos_args))
     try:
         bsock = FileDaemon(**bareos_args)
-    except (bareos.exceptions.Error) as e:
+    except bareos.exceptions.Error as e:
         print(str(e))
         sys.exit(1)
     logger.debug("authentication successful")
     if args.command:
-        print(bsock.call(args.command))
+        print(bsock.call(args.command).decode("utf-8"))
     else:
         bsock.interactive()

{python_bareos-23.0.1.data → python_bareos-23.0.4.data}/scripts/bconsole-json.py

@@ -1,7 +1,8 @@
 #!python
+#
 #   BAREOS - Backup Archiving REcovery Open Sourced
 #
-#   Copyright (C) 2019-2020 Bareos GmbH & Co. KG
+#   Copyright (C) 2019-2024 Bareos GmbH & Co. KG
 #
 #   This program is Free Software; you can redistribute it and/or
 #   modify it under the terms of version three of the GNU Affero General Public
@@ -19,8 +20,7 @@
 #   02110-1301, USA.
 
 
-from __future__ import print_function
-import argparse
+from bareos.util import argparse
 import bareos.bsock
 import bareos.exceptions
 import logging
@@ -53,7 +53,7 @@ if __name__ == "__main__":
     logger.debug("options: %s" % (bareos_args))
     try:
         director = bareos.bsock.DirectorConsoleJson(**bareos_args)
-    except (bareos.exceptions.Error) as e:
+    except bareos.exceptions.Error as e:
         print(str(e))
         sys.exit(1)
 

{python_bareos-23.0.1.data → python_bareos-23.0.4.data}/scripts/bconsole.py

@@ -1,7 +1,8 @@
 #!python
+#
 #   BAREOS - Backup Archiving REcovery Open Sourced
 #
-#   Copyright (C) 2019-2020 Bareos GmbH & Co. KG
+#   Copyright (C) 2019-2024 Bareos GmbH & Co. KG
 #
 #   This program is Free Software; you can redistribute it and/or
 #   modify it under the terms of version three of the GNU Affero General Public
@@ -18,9 +19,7 @@
 #   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 #   02110-1301, USA.
 
-
-from __future__ import print_function
-import argparse
+from bareos.util import argparse
 import bareos.bsock
 import bareos.exceptions
 import logging
@@ -34,6 +33,8 @@ def getArguments():
     )
     bareos.bsock.DirectorConsole.argparser_add_default_command_line_arguments(argparser)
     args = argparser.parse_args()
+    if args.debug:
+        print(argparser.format_values())
     return args
 
 
@@ -51,7 +52,7 @@ if __name__ == "__main__":
     logger.debug("options: %s" % (bareos_args))
     try:
         director = bareos.bsock.DirectorConsole(**bareos_args)
-    except (bareos.exceptions.Error) as e:
+    except bareos.exceptions.Error as e:
         print(str(e))
         sys.exit(1)
 

{python_bareos-23.0.1.dist-info → python_bareos-23.0.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-bareos
-Version: 23.0.1
+Version: 23.0.4
 Summary: Client library and tools for Bareos console access.
 Home-page: https://github.com/bareos/bareos/
 Author: Bareos Team
@@ -12,31 +12,32 @@ Classifier: License :: OSI Approved :: GNU Affero General Public License v3
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Topic :: System :: Archiving :: Backup
-Requires-Python: >=2.6
+Requires-Python: >=3.6
 Description-Content-Type: text/x-rst
 License-File: LICENSE.txt
-Provides-Extra: tls-psk
-Requires-Dist: sslpsk ; extra == 'tls-psk'
+Provides-Extra: configfile
+Requires-Dist: configargparse; extra == "configfile"
 
 python-bareos
 =============
 
-`python-bareos` is a Python module to access a http://www.bareos.org backup system.
+`python-bareos` is a Python module to access a https://www.bareos.com backup system.
 
 Packages for `python-bareos` are included in the Bareos core distribution and available via https://pypi.org/.
 
 Documentation is available at https://docs.bareos.org/DeveloperGuide/PythonBareos.html
 
+
 .. note::
 
-   By default, the Bareos Director (>= 18.2.4) uses TLS-PSK when communicating through the network.
+   By default, the Bareos Director (>= 18.2.4)
+   uses TLS-PSK when communicating through the network.
 
-   Unfortunately the Python core module ``ssl``
-   does not support TLS-PSK.
-   For testing ``python-bareos`` should be used without TLS.
+   The Python (https://github.com/python/cpython) core module ``ssl``
+   does support TLS-PSK only since Python >= 3.13.
    The section `Transport Encryption (TLS-PSK)`_ describes
-   how to use ``python-bareos`` with TLS-PSK
-   and about the limitations.
+   how to use TLS-PSK and about the limitations.
+   For testing this module can also be used without TLS.
 
 
 Preparations
@@ -53,12 +54,13 @@ Create some named consoles for testing:
 
 This creates a console user with name `user1` and the profile `operator`.
 The `operator` profile is a default profile that comes with the Bareos Director.
-It does allow most commands. It only deny some dangerous commands (see ``show profile=operator``),
+It does allow most commands, but deny some dangerous commands (see ``show profile=operator``),
 so it is well suited for this purpose.
 Futhermore, TLS enforcement is disabled for this console user.
 
 For testing with TLS-PSK, we also create the user `user-tls`.
 
+
 Examples
 ========
 
@@ -94,7 +96,7 @@ Simple version of the bconsole in Python
    >>> directorconsole = bareos.bsock.DirectorConsole(address='localhost', port=9101, password='secret')
    >>> directorconsole.interactive()
 
-Or use the included ``bconsole.py`` script:
+Or use the ``bconsole.py`` script:
 
 .. code-block:: shell-session
 
@@ -127,9 +129,10 @@ Example:
    Full
    Differential
 
+
 The results the the `call` method is a ``dict`` object.
 
-In case of an error, an exception, derived from ``bareos.exceptions.Error`` is raised.
+In case of an error, an exception, derived from `bareos.exceptions.Error` is raised.
 
 Example:
 
@@ -150,26 +153,30 @@ Transport Encryption (TLS-PSK)
 
 Since Bareos >= 18.2.4, Bareos supports TLS-PSK (Transport-Layer-Security Pre-Shared-Key) to secure its network connections and uses this by default.
 
-Unfortenatly, the Python core module `ssl` does not support TLS-PSK.
-There is limited support by the extra module `sslpsk` (see https://github.com/drbild/sslpsk).
+Unfortunately the Python core module ``ssl`` does support TLS-PSK only with Python >= 3.13.
+For some older versions of Python,
+the extra module ``sslpsk`` (see https://github.com/drbild/sslpsk) offers limited support.
 
 Fallback To Unencrypted Connections
 -----------------------------------
 
-In order to work in most cases, even if ``sslpsk`` is not available,
-the `DirectorConsole` uses a fallback.
+Normally `DirectorConsole` tries to connect using the latest known protocol version.
+In order to allow connections in more environments,
+the `DirectorConsole` can fall back to older protocol versions.
+Specify `protocolversion = None` (or 0 as command line argument) to enable automatic fall back.
 If connecting via TLS-PSK fails, it falls back to the old, unencrypted protocol version.
-In this case, a warning is issued, but the connection will work nevertheless:
+Depending on your bareos-director configuration, unencrypted connections will be accepted:
 
 .. code:: python
 
    >>> import bareos.bsock
-   /.../bareos/bsock/lowlevel.py:39: UserWarning: Connection encryption via TLS-PSK is not available, as the module sslpsk is not installed.
-   >>> directorconsole=bareos.bsock.DirectorConsole(address='localhost', port=9101, name='user-tls', password='secret')
+   /.../bareos/bsock/lowlevel.py:39: UserWarning: Connection encryption via TLS-PSK is not available (TLS-PSK is not available in the ssl module and the extra module sslpsk is not installed).
+   >>> directorconsole=bareos.bsock.DirectorConsole(address='localhost', port=9101, name='user-tls', password='secret', protocolversion=None)
    socket error: Conversation terminated (-4)
    Failed to connect using protocol version 2. Trying protocol version 1.
    >>> print(directorconsole.call('help').decode("utf-8"))
 
+
 To enforce a encrypted connection, use the ``tls_psk_require=True`` parameter:
 
 .. code:: python
@@ -178,8 +185,9 @@ To enforce a encrypted connection, use the ``tls_psk_require=True`` parameter:
    /.../bareos/bsock/lowlevel.py:39: UserWarning: Connection encryption via TLS-PSK is not available, as the module sslpsk is not installed.
    >>> directorconsole=bareos.bsock.DirectorConsole(address='localhost', port=9101, name='user-tls', password='secret', tls_psk_require=True)
    Traceback (most recent call last):
-   [...]
-   bareos.exceptions.ConnectionError: TLS-PSK is required, but sslpsk module not loaded/available.
+   ...
+   bareos.exceptions.ConnectionError: TLS-PSK is required, but not available.
+
 
 In this case, an exception is raised, if the connection can not be established via TLS-PSK.
 
@@ -189,10 +197,18 @@ sslpsk
 The extra module `sslpsk` (see https://github.com/drbild/sslpsk)
 extends the core module `ssl` by TLS-PSK.
 
-At the time of writing, the lasted version installable via pip is 1.0.0 (https://pypi.org/project/sslpsk/), which is not working with Python >= 3.
+At the time of writing, the lasted version installable via pip is 1.0.0 (https://pypi.org/project/sslpsk/),
+which is not working with Python >= 3.
+
+For using `python-bareos` with TLS-PSK with
+Python >= 3 and Python <= 3.9
+the latest version must by installed manually.
+At the time of writing, even the latest version
+(https://github.com/drbild/sslpsk/commit/d88123a75786953f82f5e25d6c43d9d9259acb62)
+does not support Python >= 3.10.
+However, Python >= 3.13 has direct support for TLS-PSK in the core `ssl` module.
 
-If `python-bareos` should use TLS-PSK with Python >= 3,
-the latest version must by installed manually:
+Installing the `sslpsk` module manually:
 
 .. code:: shell
 

python_bareos-23.0.4.dist-info/RECORD

@@ -0,0 +1,30 @@
+bareos/VERSION.txt,sha256=_lnDqGzjENucmF8ZJxcWoFMoLZUPuyXKxZv9C9uN2Cg,7
+bareos/__init__.py,sha256=WPq-fXxGDZSIwfkXZkwJAZdGcVSeVBcLsTum5qOmX2I,1423
+bareos/exceptions.py,sha256=3oeC_jXq2imzPxiqJmGTq4TsgFRtDlzwnAwumzYsB5M,4071
+bareos/bsock/__init__.py,sha256=lXn5TYH3-UvwneHfLHWEzQYRSvUmUzRq5c6iSAqcnuo,8658
+bareos/bsock/bsock.py,sha256=SIAPU7ouXOW5ScnnpgtVbcugKmzXlNhSs6lrC0ofspw,1242
+bareos/bsock/bsockjson.py,sha256=pnnX7b83dJH86pOw140CBz5etVJgafcQhXtKhr219TE,1289
+bareos/bsock/connectiontype.py,sha256=PNEHpqZfuAHV310NaOMgMXj6VKiZxAZwXeRIOUfHJWI,1043
+bareos/bsock/constants.py,sha256=U9RlPy8XYNkFCG1j6B89gI5cCiODVHyfQMWNumz7pbY,5127
+bareos/bsock/directorconsole.py,sha256=ou1IYXoMxgv46zws0ERrB28VWvrs0npA3iC1b5pLMz0,10368
+bareos/bsock/directorconsolejson.py,sha256=LdsMIwHZeaK-y9ydwOVl7EndMavqb2_v98ZRqWL0G7o,4457
+bareos/bsock/filedaemon.py,sha256=bl8QD97R3uc5qTFV2wN0mfi2C3ePJsjaN_bKeZAclsk,6067
+bareos/bsock/lowlevel.py,sha256=iDFqyU7XS3psoYnPQuah3lr6vl6hUFpc56wWf16pHzg,29916
+bareos/bsock/protocolmessageids.py,sha256=WKlbo8qbgSL5V48fQnFXtyvjBBgIu_lOYzvQ8vQrGaQ,1228
+bareos/bsock/protocolmessages.py,sha256=GgtstzAwA_gjOJCYQTG_wevsA6zTMn_bbz3E2yr8TCU,3008
+bareos/bsock/protocolversions.py,sha256=7i5AaSnG9F-8WNVds7SJcezVzJU-SyjTNryJTNWikns,1030
+bareos/bsock/tlsversionparser.py,sha256=kvRJ5CkR1scPpQ1f8LWD8h3qa3cBxye6ya-IiXwqF7c,2852
+bareos/util/__init__.py,sha256=6Eml_u5V3eE6luss_ZwZMXlQsCCV50bdt244QC2T-cE,1159
+bareos/util/argparse.py,sha256=ivizAADA9aZEremTfooR9gjqHdLoN51nOO4EOe5cE24,1629
+bareos/util/bareosbase64.py,sha256=5bsv6-sxNJEnO1M3f0LyZP9CV6ZPyQ1axoi9Tfno4U8,3744
+bareos/util/password.py,sha256=w71h7KnVHNik37oRl0ljj8krBVslz6a2tB_1jBJBJfM,2531
+bareos/util/path.py,sha256=nycMxK3V-P9Cx-CMsWo4e-IVlnl6_Im61pFUIPQEbL0,3099
+bareos/util/version.py,sha256=xqNm9vvkaHMKpS0xJozQs11XrQYJR1U4j5oOUCnPiMw,1201
+python_bareos-23.0.4.data/scripts/bareos-fd-connect.py,sha256=y7Jh2A-tkQeBNjyKYo8RsA7POHyDEYuOuy8ozjCEE1o,2127
+python_bareos-23.0.4.data/scripts/bconsole-json.py,sha256=0vFaTeQvJYt_Vk3ldGefMb1rZbPhdO16FaT7dZH0b2k,1960
+python_bareos-23.0.4.data/scripts/bconsole.py,sha256=m7ylVGq-ibYBbi1ZdkDdMC891WLZ3Cf5mg4IIe27i64,1993
+python_bareos-23.0.4.dist-info/LICENSE.txt,sha256=V8j_M8nAz8PvAOZQocyRDX7keai8UJ9skgmnwqETmdY,34520
+python_bareos-23.0.4.dist-info/METADATA,sha256=mizizFC-7dOYXemb5aeSF3kG2yib4ijC_EY_2s3WhtM,8201
+python_bareos-23.0.4.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
+python_bareos-23.0.4.dist-info/top_level.txt,sha256=NlKJmA3FY973VTk-0zlxwwhDtFZHYVjpSNzgeMJsknY,7
+python_bareos-23.0.4.dist-info/RECORD,,

{python_bareos-23.0.1.dist-info → python_bareos-23.0.4.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.42.0)
+Generator: setuptools (75.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

python_bareos-23.0.1.dist-info/RECORD

@@ -1,29 +0,0 @@
-bareos/VERSION.txt,sha256=kwEuJ6S5wBRXqy5Mw2eo3U9PQubbiGvmAw1UJ3Ezi_s,7
-bareos/__init__.py,sha256=WPq-fXxGDZSIwfkXZkwJAZdGcVSeVBcLsTum5qOmX2I,1423
-bareos/exceptions.py,sha256=3oeC_jXq2imzPxiqJmGTq4TsgFRtDlzwnAwumzYsB5M,4071
-bareos/bsock/__init__.py,sha256=wGlk0u6b09If5YWzfUNE_aN0jijZX1A99_Coyy9wJBU,7997
-bareos/bsock/bsock.py,sha256=SIAPU7ouXOW5ScnnpgtVbcugKmzXlNhSs6lrC0ofspw,1242
-bareos/bsock/bsockjson.py,sha256=pnnX7b83dJH86pOw140CBz5etVJgafcQhXtKhr219TE,1289
-bareos/bsock/connectiontype.py,sha256=PNEHpqZfuAHV310NaOMgMXj6VKiZxAZwXeRIOUfHJWI,1043
-bareos/bsock/constants.py,sha256=U9RlPy8XYNkFCG1j6B89gI5cCiODVHyfQMWNumz7pbY,5127
-bareos/bsock/directorconsole.py,sha256=_mLjpvubp-CW3QiWF8GW1DVu6GX8R_y2BfVSzy-FSqg,10168
-bareos/bsock/directorconsolejson.py,sha256=LdsMIwHZeaK-y9ydwOVl7EndMavqb2_v98ZRqWL0G7o,4457
-bareos/bsock/filedaemon.py,sha256=bl8QD97R3uc5qTFV2wN0mfi2C3ePJsjaN_bKeZAclsk,6067
-bareos/bsock/lowlevel.py,sha256=DluKCOwkCtT9Pi1b14NQ3bS3K-1mozwF7K_-ag-PK64,29061
-bareos/bsock/protocolmessageids.py,sha256=WKlbo8qbgSL5V48fQnFXtyvjBBgIu_lOYzvQ8vQrGaQ,1228
-bareos/bsock/protocolmessages.py,sha256=GgtstzAwA_gjOJCYQTG_wevsA6zTMn_bbz3E2yr8TCU,3008
-bareos/bsock/protocolversions.py,sha256=y_kP2iryuOQqZIcn6cUkL4NqwMhN6VNTLBUfvCWy9hQ,1003
-bareos/bsock/tlsversionparser.py,sha256=Iwj-RVs4BmEUohQUJUyiFZcM262X3UGuWECEgbi0vSw,2817
-bareos/util/__init__.py,sha256=pWio3INApoNIsldB1yAA2wZDTSCot_JCbGVQnWLqjSQ,1093
-bareos/util/bareosbase64.py,sha256=5bsv6-sxNJEnO1M3f0LyZP9CV6ZPyQ1axoi9Tfno4U8,3744
-bareos/util/password.py,sha256=w71h7KnVHNik37oRl0ljj8krBVslz6a2tB_1jBJBJfM,2531
-bareos/util/path.py,sha256=NKSI6r-4oaviBKnR66KirguP70K-cxuAKSxNfiIuBO8,3140
-bareos/util/version.py,sha256=xqNm9vvkaHMKpS0xJozQs11XrQYJR1U4j5oOUCnPiMw,1201
-python_bareos-23.0.1.data/scripts/bareos-fd-connect.py,sha256=CKWTt90lUOJ2bwoo1F80GfUdH_eypNIuuBIKcDnegSI,2095
-python_bareos-23.0.1.data/scripts/bconsole-json.py,sha256=R7u6uG6ox-h3piB_CZ18-2Bzx1FY65FhH3ECPmrKrSA,1981
-python_bareos-23.0.1.data/scripts/bconsole.py,sha256=3AdLbKqIV36uviR2AVQTcTaevMRyMJyYIJgs9jjjdn0,1955
-python_bareos-23.0.1.dist-info/LICENSE.txt,sha256=V8j_M8nAz8PvAOZQocyRDX7keai8UJ9skgmnwqETmdY,34520
-python_bareos-23.0.1.dist-info/METADATA,sha256=5KdGHyu6dY8WKBb4WS_qSKnlzFSRsu9yIpH_sHvCRoc,7568
-python_bareos-23.0.1.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-python_bareos-23.0.1.dist-info/top_level.txt,sha256=NlKJmA3FY973VTk-0zlxwwhDtFZHYVjpSNzgeMJsknY,7
-python_bareos-23.0.1.dist-info/RECORD,,