python-bareos 22.1.2__tar.gz → 23.0.0__tar.gz

{python-bareos-22.1.2 → python-bareos-23.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-bareos
-Version: 22.1.2
+Version: 23.0.0
 Summary: Client library and tools for Bareos console access.
 Home-page: https://github.com/bareos/bareos/
 Author: Bareos Team

python-bareos-23.0.0/bareos/VERSION.txt

@@ -0,0 +1 @@
+23.0.0

{python-bareos-22.1.2 → python-bareos-23.0.0}/bareos/bsock/directorconsole.py

@@ -1,6 +1,6 @@
 #   BAREOS - Backup Archiving REcovery Open Sourced
 #
-#   Copyright (C) 2016-2021 Bareos GmbH & Co. KG
+#   Copyright (C) 2016-2023 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
@@ -93,11 +93,18 @@ class DirectorConsole(LowLevel):
             dest="BAREOS_address",
         )
 
+        argparser.add_argument(
+            "--timeout",
+            type=int,
+            help="Timeout (in seconds) for the connection to the Bareos Director.",
+            dest="BAREOS_timeout",
+        )
+
         argparser.add_argument(
             "--protocolversion",
             default=ProtocolVersions.last,
             type=int,
-            help=u"Specify the Bareos console protocol version. Default: {0} (current).".format(
+            help="Specify the Bareos console protocol version. Default: {0} (current).".format(
                 ProtocolVersions.last
             ),
             dest="BAREOS_protocolversion",
@@ -128,6 +135,7 @@ class DirectorConsole(LowLevel):
         self,
         address="localhost",
         port=9101,
+        timeout=None,
         dirname=None,
         name="*UserAgent*",
         password=None,
@@ -145,6 +153,9 @@ class DirectorConsole(LowLevel):
 
            port (int): Port number of the Bareos Director.
 
+           timeout (int, optional):
+              Timeout for the connection to the director. Default: OS dependent
+
            dirname (str, optional):
               Name of the Bareos Director. Deprecated, normally not required.
 
@@ -177,20 +188,23 @@ class DirectorConsole(LowLevel):
         self.pam_password = pam_password
         self.tls_psk_enable = tls_psk_enable
         self.tls_psk_require = tls_psk_require
+        self.timeout = timeout
         if tls_version is not None:
             self.tls_version = tls_version
-        self.identity_prefix = u"R_CONSOLE"
+        self.identity_prefix = "R_CONSOLE"
         if protocolversion is not None:
             self.requested_protocol_version = int(protocolversion)
             self.protocol_messages.set_version(self.requested_protocol_version)
-        self.connect(address, port, dirname, ConnectionType.DIRECTOR, name, password)
+        self.connect(
+            address, port, dirname, ConnectionType.DIRECTOR, name, password, timeout
+        )
         self._init_connection()
         self.max_reconnects = 1
 
     def _finalize_authentication(self):
         code, text = self.receive_and_evaluate_response_message()
 
-        self.logger.debug(u"code: {0}".format(code))
+        self.logger.debug("code: {0}".format(code))
 
         #
         # Test if PAM is requested.
@@ -201,7 +215,7 @@ class DirectorConsole(LowLevel):
         # it will be evaluated with all protocol versions.
         #
         if code == ProtocolMessageIds.PamRequired:
-            self.logger.debug(u"PAM request: {0}".format(text))
+            self.logger.debug("PAM request: {0}".format(text))
             if (not self.pam_username) or (not self.pam_password):
                 raise bareos.exceptions.PamAuthenticationError(
                     "PAM authentication is requested, but no PAM credentials given. Giving up.\n"
@@ -215,7 +229,7 @@ class DirectorConsole(LowLevel):
                 code, text = self.receive_and_evaluate_response_message()
             except bareos.exceptions.ConnectionLostError as e:
                 raise bareos.exceptions.PamAuthenticationError(
-                    u"PAM authentication failed."
+                    "PAM authentication failed."
                 )
         else:
             if (self.pam_username) or (self.pam_password):
@@ -227,7 +241,7 @@ class DirectorConsole(LowLevel):
         # Test if authentication has been accepted.
         #
         if code == ProtocolMessageIds.Ok:
-            self.logger.info(u"Authentication: {0}".format(text))
+            self.logger.info("Authentication: {0}".format(text))
             self.auth_credentials_valid = True
         else:
             raise bareos.exceptions.AuthenticationError(
@@ -242,7 +256,7 @@ class DirectorConsole(LowLevel):
             #
             code, text = self.receive_and_evaluate_response_message()
             if code == ProtocolMessageIds.InfoMessage:
-                self.logger.debug(u"Info: {0}".format(text))
+                self.logger.debug("Info: {0}".format(text))
             else:
                 raise bareos.exceptions.AuthenticationError(
                     "Received unexcepted message: {0} {1} (expecting info message)".format(

{python-bareos-22.1.2 → python-bareos-23.0.0}/bareos/bsock/filedaemon.py

@@ -1,6 +1,6 @@
 #   BAREOS - Backup Archiving REcovery Open Sourced
 #
-#   Copyright (C) 2016-2021 Bareos GmbH & Co. KG
+#   Copyright (C) 2016-2023 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
@@ -100,6 +100,7 @@ class FileDaemon(LowLevel):
         self,
         address="localhost",
         port=9102,
+        dirname=None,
         name=None,
         password=None,
         tls_psk_enable=True,
@@ -136,20 +137,20 @@ class FileDaemon(LowLevel):
             self.tls_version = tls_version
         # Well, we are not really a Director,
         # but using the interface provided for Directors.
-        self.identity_prefix = u"R_DIRECTOR"
+        self.identity_prefix = "R_DIRECTOR"
         self.connect(address, port, dirname, ConnectionType.FILEDAEMON, name, password)
         self._init_connection()
 
     def _finalize_authentication(self):
         code, text = self.receive_and_evaluate_response_message()
 
-        self.logger.debug(u"code: {0}".format(code))
+        self.logger.debug("code: {0}".format(code))
 
         #
         # Test if authentication has been accepted.
         #
         if code == ProtocolMessageIds.FdOk:
-            self.logger.info(u"Authentication: {0}".format(text))
+            self.logger.info("Authentication: {0}".format(text))
             self.auth_credentials_valid = True
         else:
             raise bareos.exceptions.AuthenticationError(

{python-bareos-22.1.2 → python-bareos-23.0.0}/bareos/bsock/lowlevel.py

@@ -1,6 +1,6 @@
 #   BAREOS - Backup Archiving REcovery Open Sourced
 #
-#   Copyright (C) 2015-2021 Bareos GmbH & Co. KG
+#   Copyright (C) 2015-2023 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
@@ -55,7 +55,7 @@ try:
     import sslpsk
 except ImportError:
     warnings.warn(
-        u"Connection encryption via TLS-PSK is not available, as the module sslpsk is not installed."
+        "Connection encryption via TLS-PSK is not available, as the module sslpsk is not installed."
     )
 
 
@@ -92,6 +92,7 @@ class LowLevel(object):
         self.logger.debug("init")
         self.status = None
         self.address = None
+        self.timeout = None
         self.password = None
         self.pam_username = None
         self.pam_password = None
@@ -110,14 +111,21 @@ class LowLevel(object):
         self.requested_protocol_version = None
         self.protocol_messages = ProtocolMessages()
         # identity_prefix have to be set in each class
-        self.identity_prefix = u"R_NONE"
+        self.identity_prefix = "R_NONE"
         self.receive_buffer = b""
 
     def __del__(self):
         self.close()
 
     def connect(
-        self, address, port, dirname, connection_type, name=None, password=None
+        self,
+        address,
+        port,
+        dirname,
+        connection_type,
+        name=None,
+        password=None,
+        timeout=None,
     ):
         """Establish a network connection and authenticate.
 
@@ -137,6 +145,9 @@ class LowLevel(object):
            password  (str, bareos.util.Password):
               Credential password, in cleartext or as Password object.
 
+           timeout (int, optional):
+              Connection timeout in seconds. Default OS specific.
+
         Returns:
            bool: True, if the authentication succeeds. In earlier versions, authentication failures returned False. However, now an authentication failure raises an exception.
 
@@ -151,12 +162,11 @@ class LowLevel(object):
             self.dirname = dirname
         else:
             self.dirname = address
+        self.timeout = timeout
         self.connection_type = connection_type
         self.name = name
         if password is None:
-            raise bareos.exceptions.ConnectionError(
-                u"Parameter 'password' is required."
-            )
+            raise bareos.exceptions.ConnectionError("Parameter 'password' is required.")
         if isinstance(password, Password):
             self.password = password
         else:
@@ -171,11 +181,11 @@ class LowLevel(object):
         if self.tls_psk_require:
             if not self.is_tls_psk_available():
                 raise bareos.exceptions.ConnectionError(
-                    u"TLS-PSK is required, but sslpsk module not loaded/available."
+                    "TLS-PSK is required, but sslpsk module not loaded/available."
                 )
             if not self.tls_psk_enable:
                 raise bareos.exceptions.ConnectionError(
-                    u"TLS-PSK is required, but not enabled."
+                    "TLS-PSK is required, but not enabled."
                 )
 
         if self.tls_psk_enable and self.is_tls_psk_available():
@@ -187,7 +197,7 @@ class LowLevel(object):
                     raise
                 else:
                     self.logger.warning(
-                        u"Failed to connect via TLS-PSK. Trying plain connection."
+                        "Failed to connect via TLS-PSK. Trying plain connection."
                     )
             else:
                 connected = True
@@ -229,6 +239,8 @@ class LowLevel(object):
         self.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
         # initialize
         try:
+            if self.timeout:
+                self.socket.settimeout(self.timeout)
             self.socket.connect((self.address, self.port))
         except (socket.error, socket.gaierror) as e:
             self._handleSocketError(e)
@@ -253,7 +265,7 @@ class LowLevel(object):
         if isinstance(self.password, Password):
             password = self.password.md5()
         else:
-            raise bareos.exceptions.ConnectionError(u"No password provided.")
+            raise bareos.exceptions.ConnectionError("No password provided.")
         self.logger.debug("identity = {0}, password = {1}".format(identity, password))
         try:
             self.socket = sslpsk.wrap_socket(
@@ -275,7 +287,7 @@ class LowLevel(object):
         name = str(self.name)
         if isinstance(self.name, bytes):
             name = self.name.decode("utf-8")
-        result = u"{0}{1}{2}".format(
+        result = "{0}{1}{2}".format(
             self.identity_prefix, Constants.record_separator, name
         )
         return bytes(bytearray(result, "utf-8"))
@@ -478,7 +490,7 @@ class LowLevel(object):
             self.logger.debug("expecting {0} bytes.".format(length))
             submsg = self.socket.recv(length)
             if len(submsg) == 0:
-                errormsg = u"Failed to retrieve data. Assuming the connection is lost."
+                errormsg = "Failed to retrieve data. Assuming the connection is lost."
                 self._handleSocketError(errormsg)
                 raise bareos.exceptions.ConnectionLostError(errormsg)
             length -= len(submsg)
@@ -600,7 +612,7 @@ class LowLevel(object):
         """
         msg = self.recv_bytes(length)
         if type(msg) is str:
-            msg = bytearray(msg.decode("utf-8", 'replace'), "utf-8")
+            msg = bytearray(msg.decode("utf-8", "replace"), "utf-8")
         if type(msg) is bytes:
             msg = bytearray(msg)
         self.logger.debug(str(msg))
@@ -642,7 +654,7 @@ class LowLevel(object):
 
     def _show_result(self, msg):
         # print(msg.decode('utf-8'))
-        sys.stdout.write(msg.decode("utf-8", 'replace'))
+        sys.stdout.write(msg.decode("utf-8", "replace"))
         # add a linefeed, if there isn't one already
         if len(msg) >= 2:
             if msg[-2] != ord(b"\n"):

{python-bareos-22.1.2 → python-bareos-23.0.0}/bareos/util/__init__.py

@@ -1,6 +1,6 @@
 #   BAREOS - Backup Archiving REcovery Open Sourced
 #
-#   Copyright (C) 2015-2021 Bareos GmbH & Co. KG
+#   Copyright (C) 2015-2023 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
@@ -24,5 +24,6 @@ Bareos utility classes.
 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"]
+__all__ = ["BareosBase64", "Password", "Path", "Version"]

python-bareos-23.0.0/bareos/util/version.py

@@ -0,0 +1,35 @@
+#   BAREOS - Backup Archiving REcovery Open Sourced
+#
+#   Copyright (C) 2023-2023 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.
+
+import re
+
+
+class Version(object):
+    def __init__(self, version):
+        self.version = version
+
+    def __str__(self):
+        return self.version
+
+    def as_python_version(self):
+        """
+        Translate a Bareos version number
+        into a version compatible with PEP 440.
+        """
+        return re.sub(r"~pre([0-9]+\.)", r".dev+\1", self.version)

{python-bareos-22.1.2 → python-bareos-23.0.0}/python_bareos.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-bareos
-Version: 22.1.2
+Version: 23.0.0
 Summary: Client library and tools for Bareos console access.
 Home-page: https://github.com/bareos/bareos/
 Author: Bareos Team

{python-bareos-22.1.2 → python-bareos-23.0.0}/python_bareos.egg-info/SOURCES.txt

@@ -21,6 +21,7 @@ bareos/util/__init__.py
 bareos/util/bareosbase64.py
 bareos/util/password.py
 bareos/util/path.py
+bareos/util/version.py
 bin/bareos-fd-connect.py
 bin/bconsole-json.py
 bin/bconsole.py

python-bareos-22.1.2/bareos/VERSION.txt

@@ -1 +0,0 @@
-22.1.2