/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2018-02-06 20:03:50 UTC
  • Revision ID: teddy@recompile.se-20180206200350-jzvorueb731xkph3
Update Debian Debhelper compatibility version.

* (debian/compat): Change to "10".

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#!/usr/bin/python2.7
 
1
#!/usr/bin/python
2
2
# -*- mode: python; coding: utf-8 -*-
3
 
 
3
#
4
4
# Mandos server - give out binary blobs to connecting clients.
5
 
 
5
#
6
6
# This program is partly derived from an example program for an Avahi
7
7
# service publisher, downloaded from
8
8
# <http://avahi.org/wiki/PythonPublishExample>.  This includes the
9
9
# methods "add", "remove", "server_state_changed",
10
10
# "entry_group_state_changed", "cleanup", and "activate" in the
11
11
# "AvahiService" class, and some lines in "main".
12
 
 
12
#
13
13
# Everything else is
14
 
# Copyright © 2008-2015 Teddy Hogeborn
15
 
# Copyright © 2008-2015 Björn Påhlsson
16
 
17
 
# This program is free software: you can redistribute it and/or modify
18
 
# it under the terms of the GNU General Public License as published by
 
14
# Copyright © 2008-2017 Teddy Hogeborn
 
15
# Copyright © 2008-2017 Björn Påhlsson
 
16
#
 
17
# This file is part of Mandos.
 
18
#
 
19
# Mandos is free software: you can redistribute it and/or modify it
 
20
# under the terms of the GNU General Public License as published by
19
21
# the Free Software Foundation, either version 3 of the License, or
20
22
# (at your option) any later version.
21
23
#
22
 
#     This program is distributed in the hope that it will be useful,
23
 
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
 
24
#     Mandos is distributed in the hope that it will be useful, but
 
25
#     WITHOUT ANY WARRANTY; without even the implied warranty of
24
26
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25
27
#     GNU General Public License for more details.
26
 
 
28
#
27
29
# You should have received a copy of the GNU General Public License
28
 
# along with this program.  If not, see
29
 
# <http://www.gnu.org/licenses/>.
30
 
 
30
# along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
 
31
#
31
32
# Contact the authors at <mandos@recompile.se>.
32
 
 
33
#
33
34
 
34
35
from __future__ import (division, absolute_import, print_function,
35
36
                        unicode_literals)
36
37
 
37
 
from future_builtins import *
 
38
try:
 
39
    from future_builtins import *
 
40
except ImportError:
 
41
    pass
38
42
 
39
43
try:
40
44
    import SocketServer as socketserver
44
48
import argparse
45
49
import datetime
46
50
import errno
47
 
import gnutls.crypto
48
 
import gnutls.connection
49
 
import gnutls.errors
50
 
import gnutls.library.functions
51
 
import gnutls.library.constants
52
 
import gnutls.library.types
53
51
try:
54
52
    import ConfigParser as configparser
55
53
except ImportError:
82
80
 
83
81
import dbus
84
82
import dbus.service
85
 
try:
86
 
    import gobject
87
 
except ImportError:
88
 
    from gi.repository import GObject as gobject
89
 
import avahi
 
83
from gi.repository import GLib
90
84
from dbus.mainloop.glib import DBusGMainLoop
91
85
import ctypes
92
86
import ctypes.util
93
87
import xml.dom.minidom
94
88
import inspect
95
89
 
 
90
# Try to find the value of SO_BINDTODEVICE:
96
91
try:
 
92
    # This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
 
93
    # newer, and it is also the most natural place for it:
97
94
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
98
95
except AttributeError:
99
96
    try:
 
97
        # This is where SO_BINDTODEVICE was up to and including Python
 
98
        # 2.6, and also 3.2:
100
99
        from IN import SO_BINDTODEVICE
101
100
    except ImportError:
102
 
        SO_BINDTODEVICE = None
 
101
        # In Python 2.7 it seems to have been removed entirely.
 
102
        # Try running the C preprocessor:
 
103
        try:
 
104
            cc = subprocess.Popen(["cc", "--language=c", "-E",
 
105
                                   "/dev/stdin"],
 
106
                                  stdin=subprocess.PIPE,
 
107
                                  stdout=subprocess.PIPE)
 
108
            stdout = cc.communicate(
 
109
                "#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
 
110
            SO_BINDTODEVICE = int(stdout.splitlines()[-1])
 
111
        except (OSError, ValueError, IndexError):
 
112
            # No value found
 
113
            SO_BINDTODEVICE = None
103
114
 
104
115
if sys.version_info.major == 2:
105
116
    str = unicode
106
117
 
107
 
version = "1.6.9"
 
118
version = "1.7.16"
108
119
stored_state_file = "clients.pickle"
109
120
 
110
121
logger = logging.getLogger()
114
125
    if_nametoindex = ctypes.cdll.LoadLibrary(
115
126
        ctypes.util.find_library("c")).if_nametoindex
116
127
except (OSError, AttributeError):
117
 
    
 
128
 
118
129
    def if_nametoindex(interface):
119
130
        "Get an interface index the hard way, i.e. using fcntl()"
120
131
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
125
136
        return interface_index
126
137
 
127
138
 
 
139
def copy_function(func):
 
140
    """Make a copy of a function"""
 
141
    if sys.version_info.major == 2:
 
142
        return types.FunctionType(func.func_code,
 
143
                                  func.func_globals,
 
144
                                  func.func_name,
 
145
                                  func.func_defaults,
 
146
                                  func.func_closure)
 
147
    else:
 
148
        return types.FunctionType(func.__code__,
 
149
                                  func.__globals__,
 
150
                                  func.__name__,
 
151
                                  func.__defaults__,
 
152
                                  func.__closure__)
 
153
 
 
154
 
128
155
def initlogger(debug, level=logging.WARNING):
129
156
    """init logger and add loglevel"""
130
 
    
 
157
 
131
158
    global syslogger
132
159
    syslogger = (logging.handlers.SysLogHandler(
133
 
        facility = logging.handlers.SysLogHandler.LOG_DAEMON,
134
 
        address = "/dev/log"))
 
160
        facility=logging.handlers.SysLogHandler.LOG_DAEMON,
 
161
        address="/dev/log"))
135
162
    syslogger.setFormatter(logging.Formatter
136
163
                           ('Mandos [%(process)d]: %(levelname)s:'
137
164
                            ' %(message)s'))
138
165
    logger.addHandler(syslogger)
139
 
    
 
166
 
140
167
    if debug:
141
168
        console = logging.StreamHandler()
142
169
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
154
181
 
155
182
class PGPEngine(object):
156
183
    """A simple class for OpenPGP symmetric encryption & decryption"""
157
 
    
 
184
 
158
185
    def __init__(self):
159
186
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
 
187
        self.gpg = "gpg"
 
188
        try:
 
189
            output = subprocess.check_output(["gpgconf"])
 
190
            for line in output.splitlines():
 
191
                name, text, path = line.split(b":")
 
192
                if name == "gpg":
 
193
                    self.gpg = path
 
194
                    break
 
195
        except OSError as e:
 
196
            if e.errno != errno.ENOENT:
 
197
                raise
160
198
        self.gnupgargs = ['--batch',
161
 
                          '--home', self.tempdir,
 
199
                          '--homedir', self.tempdir,
162
200
                          '--force-mdc',
163
 
                          '--quiet',
164
 
                          '--no-use-agent']
165
 
    
 
201
                          '--quiet']
 
202
        # Only GPG version 1 has the --no-use-agent option.
 
203
        if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
 
204
            self.gnupgargs.append("--no-use-agent")
 
205
 
166
206
    def __enter__(self):
167
207
        return self
168
 
    
 
208
 
169
209
    def __exit__(self, exc_type, exc_value, traceback):
170
210
        self._cleanup()
171
211
        return False
172
 
    
 
212
 
173
213
    def __del__(self):
174
214
        self._cleanup()
175
 
    
 
215
 
176
216
    def _cleanup(self):
177
217
        if self.tempdir is not None:
178
218
            # Delete contents of tempdir
179
219
            for root, dirs, files in os.walk(self.tempdir,
180
 
                                             topdown = False):
 
220
                                             topdown=False):
181
221
                for filename in files:
182
222
                    os.remove(os.path.join(root, filename))
183
223
                for dirname in dirs:
185
225
            # Remove tempdir
186
226
            os.rmdir(self.tempdir)
187
227
            self.tempdir = None
188
 
    
 
228
 
189
229
    def password_encode(self, password):
190
230
        # Passphrase can not be empty and can not contain newlines or
191
231
        # NUL bytes.  So we prefix it and hex encode it.
196
236
                       .replace(b"\n", b"\\n")
197
237
                       .replace(b"\0", b"\\x00"))
198
238
        return encoded
199
 
    
 
239
 
200
240
    def encrypt(self, data, password):
201
241
        passphrase = self.password_encode(password)
202
242
        with tempfile.NamedTemporaryFile(
203
243
                dir=self.tempdir) as passfile:
204
244
            passfile.write(passphrase)
205
245
            passfile.flush()
206
 
            proc = subprocess.Popen(['gpg', '--symmetric',
 
246
            proc = subprocess.Popen([self.gpg, '--symmetric',
207
247
                                     '--passphrase-file',
208
248
                                     passfile.name]
209
249
                                    + self.gnupgargs,
210
 
                                    stdin = subprocess.PIPE,
211
 
                                    stdout = subprocess.PIPE,
212
 
                                    stderr = subprocess.PIPE)
213
 
            ciphertext, err = proc.communicate(input = data)
 
250
                                    stdin=subprocess.PIPE,
 
251
                                    stdout=subprocess.PIPE,
 
252
                                    stderr=subprocess.PIPE)
 
253
            ciphertext, err = proc.communicate(input=data)
214
254
        if proc.returncode != 0:
215
255
            raise PGPError(err)
216
256
        return ciphertext
217
 
    
 
257
 
218
258
    def decrypt(self, data, password):
219
259
        passphrase = self.password_encode(password)
220
260
        with tempfile.NamedTemporaryFile(
221
 
                dir = self.tempdir) as passfile:
 
261
                dir=self.tempdir) as passfile:
222
262
            passfile.write(passphrase)
223
263
            passfile.flush()
224
 
            proc = subprocess.Popen(['gpg', '--decrypt',
 
264
            proc = subprocess.Popen([self.gpg, '--decrypt',
225
265
                                     '--passphrase-file',
226
266
                                     passfile.name]
227
267
                                    + self.gnupgargs,
228
 
                                    stdin = subprocess.PIPE,
229
 
                                    stdout = subprocess.PIPE,
230
 
                                    stderr = subprocess.PIPE)
231
 
            decrypted_plaintext, err = proc.communicate(input = data)
 
268
                                    stdin=subprocess.PIPE,
 
269
                                    stdout=subprocess.PIPE,
 
270
                                    stderr=subprocess.PIPE)
 
271
            decrypted_plaintext, err = proc.communicate(input=data)
232
272
        if proc.returncode != 0:
233
273
            raise PGPError(err)
234
274
        return decrypted_plaintext
235
275
 
236
276
 
 
277
# Pretend that we have an Avahi module
 
278
class Avahi(object):
 
279
    """This isn't so much a class as it is a module-like namespace.
 
280
    It is instantiated once, and simulates having an Avahi module."""
 
281
    IF_UNSPEC = -1               # avahi-common/address.h
 
282
    PROTO_UNSPEC = -1            # avahi-common/address.h
 
283
    PROTO_INET = 0               # avahi-common/address.h
 
284
    PROTO_INET6 = 1              # avahi-common/address.h
 
285
    DBUS_NAME = "org.freedesktop.Avahi"
 
286
    DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
 
287
    DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
 
288
    DBUS_PATH_SERVER = "/"
 
289
 
 
290
    def string_array_to_txt_array(self, t):
 
291
        return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
 
292
                           for s in t), signature="ay")
 
293
    ENTRY_GROUP_ESTABLISHED = 2  # avahi-common/defs.h
 
294
    ENTRY_GROUP_COLLISION = 3    # avahi-common/defs.h
 
295
    ENTRY_GROUP_FAILURE = 4      # avahi-common/defs.h
 
296
    SERVER_INVALID = 0           # avahi-common/defs.h
 
297
    SERVER_REGISTERING = 1       # avahi-common/defs.h
 
298
    SERVER_RUNNING = 2           # avahi-common/defs.h
 
299
    SERVER_COLLISION = 3         # avahi-common/defs.h
 
300
    SERVER_FAILURE = 4           # avahi-common/defs.h
 
301
avahi = Avahi()
 
302
 
 
303
 
237
304
class AvahiError(Exception):
238
305
    def __init__(self, value, *args, **kwargs):
239
306
        self.value = value
251
318
 
252
319
class AvahiService(object):
253
320
    """An Avahi (Zeroconf) service.
254
 
    
 
321
 
255
322
    Attributes:
256
323
    interface: integer; avahi.IF_UNSPEC or an interface index.
257
324
               Used to optionally bind to the specified interface.
269
336
    server: D-Bus Server
270
337
    bus: dbus.SystemBus()
271
338
    """
272
 
    
 
339
 
273
340
    def __init__(self,
274
 
                 interface = avahi.IF_UNSPEC,
275
 
                 name = None,
276
 
                 servicetype = None,
277
 
                 port = None,
278
 
                 TXT = None,
279
 
                 domain = "",
280
 
                 host = "",
281
 
                 max_renames = 32768,
282
 
                 protocol = avahi.PROTO_UNSPEC,
283
 
                 bus = None):
 
341
                 interface=avahi.IF_UNSPEC,
 
342
                 name=None,
 
343
                 servicetype=None,
 
344
                 port=None,
 
345
                 TXT=None,
 
346
                 domain="",
 
347
                 host="",
 
348
                 max_renames=32768,
 
349
                 protocol=avahi.PROTO_UNSPEC,
 
350
                 bus=None):
284
351
        self.interface = interface
285
352
        self.name = name
286
353
        self.type = servicetype
295
362
        self.server = None
296
363
        self.bus = bus
297
364
        self.entry_group_state_changed_match = None
298
 
    
 
365
 
299
366
    def rename(self, remove=True):
300
367
        """Derived from the Avahi example code"""
301
368
        if self.rename_count >= self.max_renames:
321
388
                logger.critical("D-Bus Exception", exc_info=error)
322
389
                self.cleanup()
323
390
                os._exit(1)
324
 
    
 
391
 
325
392
    def remove(self):
326
393
        """Derived from the Avahi example code"""
327
394
        if self.entry_group_state_changed_match is not None:
329
396
            self.entry_group_state_changed_match = None
330
397
        if self.group is not None:
331
398
            self.group.Reset()
332
 
    
 
399
 
333
400
    def add(self):
334
401
        """Derived from the Avahi example code"""
335
402
        self.remove()
352
419
            dbus.UInt16(self.port),
353
420
            avahi.string_array_to_txt_array(self.TXT))
354
421
        self.group.Commit()
355
 
    
 
422
 
356
423
    def entry_group_state_changed(self, state, error):
357
424
        """Derived from the Avahi example code"""
358
425
        logger.debug("Avahi entry group state change: %i", state)
359
 
        
 
426
 
360
427
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
361
428
            logger.debug("Zeroconf service established.")
362
429
        elif state == avahi.ENTRY_GROUP_COLLISION:
366
433
            logger.critical("Avahi: Error in group state changed %s",
367
434
                            str(error))
368
435
            raise AvahiGroupError("State changed: {!s}".format(error))
369
 
    
 
436
 
370
437
    def cleanup(self):
371
438
        """Derived from the Avahi example code"""
372
439
        if self.group is not None:
377
444
                pass
378
445
            self.group = None
379
446
        self.remove()
380
 
    
 
447
 
381
448
    def server_state_changed(self, state, error=None):
382
449
        """Derived from the Avahi example code"""
383
450
        logger.debug("Avahi server state change: %i", state)
395
462
                    logger.error(bad_states[state] + ": %r", error)
396
463
            self.cleanup()
397
464
        elif state == avahi.SERVER_RUNNING:
398
 
            self.add()
 
465
            try:
 
466
                self.add()
 
467
            except dbus.exceptions.DBusException as error:
 
468
                if (error.get_dbus_name()
 
469
                    == "org.freedesktop.Avahi.CollisionError"):
 
470
                    logger.info("Local Zeroconf service name"
 
471
                                " collision.")
 
472
                    return self.rename(remove=False)
 
473
                else:
 
474
                    logger.critical("D-Bus Exception", exc_info=error)
 
475
                    self.cleanup()
 
476
                    os._exit(1)
399
477
        else:
400
478
            if error is None:
401
479
                logger.debug("Unknown state: %r", state)
402
480
            else:
403
481
                logger.debug("Unknown state: %r: %r", state, error)
404
 
    
 
482
 
405
483
    def activate(self):
406
484
        """Derived from the Avahi example code"""
407
485
        if self.server is None:
418
496
class AvahiServiceToSyslog(AvahiService):
419
497
    def rename(self, *args, **kwargs):
420
498
        """Add the new name to the syslog messages"""
421
 
        ret = AvahiService.rename(self, *args, **kwargs)
 
499
        ret = super(AvahiServiceToSyslog, self).rename(self, *args,
 
500
                                                       **kwargs)
422
501
        syslogger.setFormatter(logging.Formatter(
423
502
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
424
503
            .format(self.name)))
425
504
        return ret
426
505
 
427
506
 
 
507
# Pretend that we have a GnuTLS module
 
508
class GnuTLS(object):
 
509
    """This isn't so much a class as it is a module-like namespace.
 
510
    It is instantiated once, and simulates having a GnuTLS module."""
 
511
 
 
512
    library = ctypes.util.find_library("gnutls")
 
513
    if library is None:
 
514
        library = ctypes.util.find_library("gnutls-deb0")
 
515
    _library = ctypes.cdll.LoadLibrary(library)
 
516
    del library
 
517
    _need_version = b"3.3.0"
 
518
 
 
519
    def __init__(self):
 
520
        # Need to use "self" here, since this method is called before
 
521
        # the assignment to the "gnutls" global variable happens.
 
522
        if self.check_version(self._need_version) is None:
 
523
            raise self.Error("Needs GnuTLS {} or later"
 
524
                             .format(self._need_version))
 
525
 
 
526
    # Unless otherwise indicated, the constants and types below are
 
527
    # all from the gnutls/gnutls.h C header file.
 
528
 
 
529
    # Constants
 
530
    E_SUCCESS = 0
 
531
    E_INTERRUPTED = -52
 
532
    E_AGAIN = -28
 
533
    CRT_OPENPGP = 2
 
534
    CLIENT = 2
 
535
    SHUT_RDWR = 0
 
536
    CRD_CERTIFICATE = 1
 
537
    E_NO_CERTIFICATE_FOUND = -49
 
538
    OPENPGP_FMT_RAW = 0         # gnutls/openpgp.h
 
539
 
 
540
    # Types
 
541
    class session_int(ctypes.Structure):
 
542
        _fields_ = []
 
543
    session_t = ctypes.POINTER(session_int)
 
544
 
 
545
    class certificate_credentials_st(ctypes.Structure):
 
546
        _fields_ = []
 
547
    certificate_credentials_t = ctypes.POINTER(
 
548
        certificate_credentials_st)
 
549
    certificate_type_t = ctypes.c_int
 
550
 
 
551
    class datum_t(ctypes.Structure):
 
552
        _fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
 
553
                    ('size', ctypes.c_uint)]
 
554
 
 
555
    class openpgp_crt_int(ctypes.Structure):
 
556
        _fields_ = []
 
557
    openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
 
558
    openpgp_crt_fmt_t = ctypes.c_int  # gnutls/openpgp.h
 
559
    log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
 
560
    credentials_type_t = ctypes.c_int
 
561
    transport_ptr_t = ctypes.c_void_p
 
562
    close_request_t = ctypes.c_int
 
563
 
 
564
    # Exceptions
 
565
    class Error(Exception):
 
566
        # We need to use the class name "GnuTLS" here, since this
 
567
        # exception might be raised from within GnuTLS.__init__,
 
568
        # which is called before the assignment to the "gnutls"
 
569
        # global variable has happened.
 
570
        def __init__(self, message=None, code=None, args=()):
 
571
            # Default usage is by a message string, but if a return
 
572
            # code is passed, convert it to a string with
 
573
            # gnutls.strerror()
 
574
            self.code = code
 
575
            if message is None and code is not None:
 
576
                message = GnuTLS.strerror(code)
 
577
            return super(GnuTLS.Error, self).__init__(
 
578
                message, *args)
 
579
 
 
580
    class CertificateSecurityError(Error):
 
581
        pass
 
582
 
 
583
    # Classes
 
584
    class Credentials(object):
 
585
        def __init__(self):
 
586
            self._c_object = gnutls.certificate_credentials_t()
 
587
            gnutls.certificate_allocate_credentials(
 
588
                ctypes.byref(self._c_object))
 
589
            self.type = gnutls.CRD_CERTIFICATE
 
590
 
 
591
        def __del__(self):
 
592
            gnutls.certificate_free_credentials(self._c_object)
 
593
 
 
594
    class ClientSession(object):
 
595
        def __init__(self, socket, credentials=None):
 
596
            self._c_object = gnutls.session_t()
 
597
            gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
 
598
            gnutls.set_default_priority(self._c_object)
 
599
            gnutls.transport_set_ptr(self._c_object, socket.fileno())
 
600
            gnutls.handshake_set_private_extensions(self._c_object,
 
601
                                                    True)
 
602
            self.socket = socket
 
603
            if credentials is None:
 
604
                credentials = gnutls.Credentials()
 
605
            gnutls.credentials_set(self._c_object, credentials.type,
 
606
                                   ctypes.cast(credentials._c_object,
 
607
                                               ctypes.c_void_p))
 
608
            self.credentials = credentials
 
609
 
 
610
        def __del__(self):
 
611
            gnutls.deinit(self._c_object)
 
612
 
 
613
        def handshake(self):
 
614
            return gnutls.handshake(self._c_object)
 
615
 
 
616
        def send(self, data):
 
617
            data = bytes(data)
 
618
            data_len = len(data)
 
619
            while data_len > 0:
 
620
                data_len -= gnutls.record_send(self._c_object,
 
621
                                               data[-data_len:],
 
622
                                               data_len)
 
623
 
 
624
        def bye(self):
 
625
            return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
 
626
 
 
627
    # Error handling functions
 
628
    def _error_code(result):
 
629
        """A function to raise exceptions on errors, suitable
 
630
        for the 'restype' attribute on ctypes functions"""
 
631
        if result >= 0:
 
632
            return result
 
633
        if result == gnutls.E_NO_CERTIFICATE_FOUND:
 
634
            raise gnutls.CertificateSecurityError(code=result)
 
635
        raise gnutls.Error(code=result)
 
636
 
 
637
    def _retry_on_error(result, func, arguments):
 
638
        """A function to retry on some errors, suitable
 
639
        for the 'errcheck' attribute on ctypes functions"""
 
640
        while result < 0:
 
641
            if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
 
642
                return _error_code(result)
 
643
            result = func(*arguments)
 
644
        return result
 
645
 
 
646
    # Unless otherwise indicated, the function declarations below are
 
647
    # all from the gnutls/gnutls.h C header file.
 
648
 
 
649
    # Functions
 
650
    priority_set_direct = _library.gnutls_priority_set_direct
 
651
    priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
 
652
                                    ctypes.POINTER(ctypes.c_char_p)]
 
653
    priority_set_direct.restype = _error_code
 
654
 
 
655
    init = _library.gnutls_init
 
656
    init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
 
657
    init.restype = _error_code
 
658
 
 
659
    set_default_priority = _library.gnutls_set_default_priority
 
660
    set_default_priority.argtypes = [session_t]
 
661
    set_default_priority.restype = _error_code
 
662
 
 
663
    record_send = _library.gnutls_record_send
 
664
    record_send.argtypes = [session_t, ctypes.c_void_p,
 
665
                            ctypes.c_size_t]
 
666
    record_send.restype = ctypes.c_ssize_t
 
667
    record_send.errcheck = _retry_on_error
 
668
 
 
669
    certificate_allocate_credentials = (
 
670
        _library.gnutls_certificate_allocate_credentials)
 
671
    certificate_allocate_credentials.argtypes = [
 
672
        ctypes.POINTER(certificate_credentials_t)]
 
673
    certificate_allocate_credentials.restype = _error_code
 
674
 
 
675
    certificate_free_credentials = (
 
676
        _library.gnutls_certificate_free_credentials)
 
677
    certificate_free_credentials.argtypes = [
 
678
        certificate_credentials_t]
 
679
    certificate_free_credentials.restype = None
 
680
 
 
681
    handshake_set_private_extensions = (
 
682
        _library.gnutls_handshake_set_private_extensions)
 
683
    handshake_set_private_extensions.argtypes = [session_t,
 
684
                                                 ctypes.c_int]
 
685
    handshake_set_private_extensions.restype = None
 
686
 
 
687
    credentials_set = _library.gnutls_credentials_set
 
688
    credentials_set.argtypes = [session_t, credentials_type_t,
 
689
                                ctypes.c_void_p]
 
690
    credentials_set.restype = _error_code
 
691
 
 
692
    strerror = _library.gnutls_strerror
 
693
    strerror.argtypes = [ctypes.c_int]
 
694
    strerror.restype = ctypes.c_char_p
 
695
 
 
696
    certificate_type_get = _library.gnutls_certificate_type_get
 
697
    certificate_type_get.argtypes = [session_t]
 
698
    certificate_type_get.restype = _error_code
 
699
 
 
700
    certificate_get_peers = _library.gnutls_certificate_get_peers
 
701
    certificate_get_peers.argtypes = [session_t,
 
702
                                      ctypes.POINTER(ctypes.c_uint)]
 
703
    certificate_get_peers.restype = ctypes.POINTER(datum_t)
 
704
 
 
705
    global_set_log_level = _library.gnutls_global_set_log_level
 
706
    global_set_log_level.argtypes = [ctypes.c_int]
 
707
    global_set_log_level.restype = None
 
708
 
 
709
    global_set_log_function = _library.gnutls_global_set_log_function
 
710
    global_set_log_function.argtypes = [log_func]
 
711
    global_set_log_function.restype = None
 
712
 
 
713
    deinit = _library.gnutls_deinit
 
714
    deinit.argtypes = [session_t]
 
715
    deinit.restype = None
 
716
 
 
717
    handshake = _library.gnutls_handshake
 
718
    handshake.argtypes = [session_t]
 
719
    handshake.restype = _error_code
 
720
    handshake.errcheck = _retry_on_error
 
721
 
 
722
    transport_set_ptr = _library.gnutls_transport_set_ptr
 
723
    transport_set_ptr.argtypes = [session_t, transport_ptr_t]
 
724
    transport_set_ptr.restype = None
 
725
 
 
726
    bye = _library.gnutls_bye
 
727
    bye.argtypes = [session_t, close_request_t]
 
728
    bye.restype = _error_code
 
729
    bye.errcheck = _retry_on_error
 
730
 
 
731
    check_version = _library.gnutls_check_version
 
732
    check_version.argtypes = [ctypes.c_char_p]
 
733
    check_version.restype = ctypes.c_char_p
 
734
 
 
735
    # All the function declarations below are from gnutls/openpgp.h
 
736
 
 
737
    openpgp_crt_init = _library.gnutls_openpgp_crt_init
 
738
    openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
 
739
    openpgp_crt_init.restype = _error_code
 
740
 
 
741
    openpgp_crt_import = _library.gnutls_openpgp_crt_import
 
742
    openpgp_crt_import.argtypes = [openpgp_crt_t,
 
743
                                   ctypes.POINTER(datum_t),
 
744
                                   openpgp_crt_fmt_t]
 
745
    openpgp_crt_import.restype = _error_code
 
746
 
 
747
    openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
 
748
    openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
 
749
                                        ctypes.POINTER(ctypes.c_uint)]
 
750
    openpgp_crt_verify_self.restype = _error_code
 
751
 
 
752
    openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
 
753
    openpgp_crt_deinit.argtypes = [openpgp_crt_t]
 
754
    openpgp_crt_deinit.restype = None
 
755
 
 
756
    openpgp_crt_get_fingerprint = (
 
757
        _library.gnutls_openpgp_crt_get_fingerprint)
 
758
    openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
 
759
                                            ctypes.c_void_p,
 
760
                                            ctypes.POINTER(
 
761
                                                ctypes.c_size_t)]
 
762
    openpgp_crt_get_fingerprint.restype = _error_code
 
763
 
 
764
    # Remove non-public functions
 
765
    del _error_code, _retry_on_error
 
766
# Create the global "gnutls" object, simulating a module
 
767
gnutls = GnuTLS()
 
768
 
 
769
 
 
770
def call_pipe(connection,       # : multiprocessing.Connection
 
771
              func, *args, **kwargs):
 
772
    """This function is meant to be called by multiprocessing.Process
 
773
 
 
774
    This function runs func(*args, **kwargs), and writes the resulting
 
775
    return value on the provided multiprocessing.Connection.
 
776
    """
 
777
    connection.send(func(*args, **kwargs))
 
778
    connection.close()
 
779
 
 
780
 
428
781
class Client(object):
429
782
    """A representation of a client host served by this server.
430
 
    
 
783
 
431
784
    Attributes:
432
785
    approved:   bool(); 'None' if not yet approved/disapproved
433
786
    approval_delay: datetime.timedelta(); Time to wait for approval
435
788
    checker:    subprocess.Popen(); a running checker process used
436
789
                                    to see if the client lives.
437
790
                                    'None' if no process is running.
438
 
    checker_callback_tag: a gobject event source tag, or None
 
791
    checker_callback_tag: a GLib event source tag, or None
439
792
    checker_command: string; External command which is run to check
440
793
                     if client lives.  %() expansions are done at
441
794
                     runtime with vars(self) as dict, so that for
442
795
                     instance %(name)s can be used in the command.
443
 
    checker_initiator_tag: a gobject event source tag, or None
 
796
    checker_initiator_tag: a GLib event source tag, or None
444
797
    created:    datetime.datetime(); (UTC) object creation
445
798
    client_structure: Object describing what attributes a client has
446
799
                      and is used for storing the client at exit
447
800
    current_checker_command: string; current running checker_command
448
 
    disable_initiator_tag: a gobject event source tag, or None
 
801
    disable_initiator_tag: a GLib event source tag, or None
449
802
    enabled:    bool()
450
803
    fingerprint: string (40 or 32 hexadecimal digits); used to
451
804
                 uniquely identify the client
456
809
    last_checker_status: integer between 0 and 255 reflecting exit
457
810
                         status of last checker. -1 reflects crashed
458
811
                         checker, -2 means no checker completed yet.
 
812
    last_checker_signal: The signal which killed the last checker, if
 
813
                         last_checker_status is -1
459
814
    last_enabled: datetime.datetime(); (UTC) or None
460
815
    name:       string; from the config file, used in log messages and
461
816
                        D-Bus identifiers
468
823
                disabled, or None
469
824
    server_settings: The server_settings dict from main()
470
825
    """
471
 
    
 
826
 
472
827
    runtime_expansions = ("approval_delay", "approval_duration",
473
828
                          "created", "enabled", "expires",
474
829
                          "fingerprint", "host", "interval",
485
840
        "approved_by_default": "True",
486
841
        "enabled": "True",
487
842
    }
488
 
    
 
843
 
489
844
    @staticmethod
490
845
    def config_parser(config):
491
846
        """Construct a new dict of client settings of this form:
498
853
        for client_name in config.sections():
499
854
            section = dict(config.items(client_name))
500
855
            client = settings[client_name] = {}
501
 
            
 
856
 
502
857
            client["host"] = section["host"]
503
858
            # Reformat values from string types to Python types
504
859
            client["approved_by_default"] = config.getboolean(
505
860
                client_name, "approved_by_default")
506
861
            client["enabled"] = config.getboolean(client_name,
507
862
                                                  "enabled")
508
 
            
 
863
 
509
864
            # Uppercase and remove spaces from fingerprint for later
510
865
            # comparison purposes with return value from the
511
866
            # fingerprint() function
512
867
            client["fingerprint"] = (section["fingerprint"].upper()
513
868
                                     .replace(" ", ""))
514
869
            if "secret" in section:
515
 
                client["secret"] = section["secret"].decode("base64")
 
870
                client["secret"] = codecs.decode(section["secret"]
 
871
                                                 .encode("utf-8"),
 
872
                                                 "base64")
516
873
            elif "secfile" in section:
517
874
                with open(os.path.expanduser(os.path.expandvars
518
875
                                             (section["secfile"])),
533
890
            client["last_approval_request"] = None
534
891
            client["last_checked_ok"] = None
535
892
            client["last_checker_status"] = -2
536
 
        
 
893
 
537
894
        return settings
538
 
    
539
 
    def __init__(self, settings, name = None, server_settings=None):
 
895
 
 
896
    def __init__(self, settings, name=None, server_settings=None):
540
897
        self.name = name
541
898
        if server_settings is None:
542
899
            server_settings = {}
544
901
        # adding all client settings
545
902
        for setting, value in settings.items():
546
903
            setattr(self, setting, value)
547
 
        
 
904
 
548
905
        if self.enabled:
549
906
            if not hasattr(self, "last_enabled"):
550
907
                self.last_enabled = datetime.datetime.utcnow()
554
911
        else:
555
912
            self.last_enabled = None
556
913
            self.expires = None
557
 
        
 
914
 
558
915
        logger.debug("Creating client %r", self.name)
559
916
        logger.debug("  Fingerprint: %s", self.fingerprint)
560
917
        self.created = settings.get("created",
561
918
                                    datetime.datetime.utcnow())
562
 
        
 
919
 
563
920
        # attributes specific for this server instance
564
921
        self.checker = None
565
922
        self.checker_initiator_tag = None
571
928
        self.changedstate = multiprocessing_manager.Condition(
572
929
            multiprocessing_manager.Lock())
573
930
        self.client_structure = [attr
574
 
                                 for attr in self.__dict__.iterkeys()
 
931
                                 for attr in self.__dict__.keys()
575
932
                                 if not attr.startswith("_")]
576
933
        self.client_structure.append("client_structure")
577
 
        
 
934
 
578
935
        for name, t in inspect.getmembers(
579
936
                type(self), lambda obj: isinstance(obj, property)):
580
937
            if not name.startswith("_"):
581
938
                self.client_structure.append(name)
582
 
    
 
939
 
583
940
    # Send notice to process children that client state has changed
584
941
    def send_changedstate(self):
585
942
        with self.changedstate:
586
943
            self.changedstate.notify_all()
587
 
    
 
944
 
588
945
    def enable(self):
589
946
        """Start this client's checker and timeout hooks"""
590
947
        if getattr(self, "enabled", False):
595
952
        self.last_enabled = datetime.datetime.utcnow()
596
953
        self.init_checker()
597
954
        self.send_changedstate()
598
 
    
 
955
 
599
956
    def disable(self, quiet=True):
600
957
        """Disable this client."""
601
958
        if not getattr(self, "enabled", False):
603
960
        if not quiet:
604
961
            logger.info("Disabling client %s", self.name)
605
962
        if getattr(self, "disable_initiator_tag", None) is not None:
606
 
            gobject.source_remove(self.disable_initiator_tag)
 
963
            GLib.source_remove(self.disable_initiator_tag)
607
964
            self.disable_initiator_tag = None
608
965
        self.expires = None
609
966
        if getattr(self, "checker_initiator_tag", None) is not None:
610
 
            gobject.source_remove(self.checker_initiator_tag)
 
967
            GLib.source_remove(self.checker_initiator_tag)
611
968
            self.checker_initiator_tag = None
612
969
        self.stop_checker()
613
970
        self.enabled = False
614
971
        if not quiet:
615
972
            self.send_changedstate()
616
 
        # Do not run this again if called by a gobject.timeout_add
 
973
        # Do not run this again if called by a GLib.timeout_add
617
974
        return False
618
 
    
 
975
 
619
976
    def __del__(self):
620
977
        self.disable()
621
 
    
 
978
 
622
979
    def init_checker(self):
623
980
        # Schedule a new checker to be started an 'interval' from now,
624
981
        # and every interval from then on.
625
982
        if self.checker_initiator_tag is not None:
626
 
            gobject.source_remove(self.checker_initiator_tag)
627
 
        self.checker_initiator_tag = gobject.timeout_add(
 
983
            GLib.source_remove(self.checker_initiator_tag)
 
984
        self.checker_initiator_tag = GLib.timeout_add(
628
985
            int(self.interval.total_seconds() * 1000),
629
986
            self.start_checker)
630
987
        # Schedule a disable() when 'timeout' has passed
631
988
        if self.disable_initiator_tag is not None:
632
 
            gobject.source_remove(self.disable_initiator_tag)
633
 
        self.disable_initiator_tag = gobject.timeout_add(
 
989
            GLib.source_remove(self.disable_initiator_tag)
 
990
        self.disable_initiator_tag = GLib.timeout_add(
634
991
            int(self.timeout.total_seconds() * 1000), self.disable)
635
992
        # Also start a new checker *right now*.
636
993
        self.start_checker()
637
 
    
638
 
    def checker_callback(self, pid, condition, command):
 
994
 
 
995
    def checker_callback(self, source, condition, connection,
 
996
                         command):
639
997
        """The checker has completed, so take appropriate actions."""
640
998
        self.checker_callback_tag = None
641
999
        self.checker = None
642
 
        if os.WIFEXITED(condition):
643
 
            self.last_checker_status = os.WEXITSTATUS(condition)
 
1000
        # Read return code from connection (see call_pipe)
 
1001
        returncode = connection.recv()
 
1002
        connection.close()
 
1003
 
 
1004
        if returncode >= 0:
 
1005
            self.last_checker_status = returncode
 
1006
            self.last_checker_signal = None
644
1007
            if self.last_checker_status == 0:
645
1008
                logger.info("Checker for %(name)s succeeded",
646
1009
                            vars(self))
649
1012
                logger.info("Checker for %(name)s failed", vars(self))
650
1013
        else:
651
1014
            self.last_checker_status = -1
 
1015
            self.last_checker_signal = -returncode
652
1016
            logger.warning("Checker for %(name)s crashed?",
653
1017
                           vars(self))
654
 
    
 
1018
        return False
 
1019
 
655
1020
    def checked_ok(self):
656
1021
        """Assert that the client has been seen, alive and well."""
657
1022
        self.last_checked_ok = datetime.datetime.utcnow()
658
1023
        self.last_checker_status = 0
 
1024
        self.last_checker_signal = None
659
1025
        self.bump_timeout()
660
 
    
 
1026
 
661
1027
    def bump_timeout(self, timeout=None):
662
1028
        """Bump up the timeout for this client."""
663
1029
        if timeout is None:
664
1030
            timeout = self.timeout
665
1031
        if self.disable_initiator_tag is not None:
666
 
            gobject.source_remove(self.disable_initiator_tag)
 
1032
            GLib.source_remove(self.disable_initiator_tag)
667
1033
            self.disable_initiator_tag = None
668
1034
        if getattr(self, "enabled", False):
669
 
            self.disable_initiator_tag = gobject.timeout_add(
 
1035
            self.disable_initiator_tag = GLib.timeout_add(
670
1036
                int(timeout.total_seconds() * 1000), self.disable)
671
1037
            self.expires = datetime.datetime.utcnow() + timeout
672
 
    
 
1038
 
673
1039
    def need_approval(self):
674
1040
        self.last_approval_request = datetime.datetime.utcnow()
675
 
    
 
1041
 
676
1042
    def start_checker(self):
677
1043
        """Start a new checker subprocess if one is not running.
678
 
        
 
1044
 
679
1045
        If a checker already exists, leave it running and do
680
1046
        nothing."""
681
1047
        # The reason for not killing a running checker is that if we
686
1052
        # checkers alone, the checker would have to take more time
687
1053
        # than 'timeout' for the client to be disabled, which is as it
688
1054
        # should be.
689
 
        
690
 
        # If a checker exists, make sure it is not a zombie
691
 
        try:
692
 
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
693
 
        except AttributeError:
694
 
            pass
695
 
        except OSError as error:
696
 
            if error.errno != errno.ECHILD:
697
 
                raise
698
 
        else:
699
 
            if pid:
700
 
                logger.warning("Checker was a zombie")
701
 
                gobject.source_remove(self.checker_callback_tag)
702
 
                self.checker_callback(pid, status,
703
 
                                      self.current_checker_command)
 
1055
 
 
1056
        if self.checker is not None and not self.checker.is_alive():
 
1057
            logger.warning("Checker was not alive; joining")
 
1058
            self.checker.join()
 
1059
            self.checker = None
704
1060
        # Start a new checker if needed
705
1061
        if self.checker is None:
706
1062
            # Escape attributes for the shell
707
1063
            escaped_attrs = {
708
1064
                attr: re.escape(str(getattr(self, attr)))
709
 
                for attr in self.runtime_expansions }
 
1065
                for attr in self.runtime_expansions}
710
1066
            try:
711
1067
                command = self.checker_command % escaped_attrs
712
1068
            except TypeError as error:
715
1071
                             exc_info=error)
716
1072
                return True     # Try again later
717
1073
            self.current_checker_command = command
718
 
            try:
719
 
                logger.info("Starting checker %r for %s", command,
720
 
                            self.name)
721
 
                # We don't need to redirect stdout and stderr, since
722
 
                # in normal mode, that is already done by daemon(),
723
 
                # and in debug mode we don't want to.  (Stdin is
724
 
                # always replaced by /dev/null.)
725
 
                # The exception is when not debugging but nevertheless
726
 
                # running in the foreground; use the previously
727
 
                # created wnull.
728
 
                popen_args = {}
729
 
                if (not self.server_settings["debug"]
730
 
                    and self.server_settings["foreground"]):
731
 
                    popen_args.update({"stdout": wnull,
732
 
                                       "stderr": wnull })
733
 
                self.checker = subprocess.Popen(command,
734
 
                                                close_fds=True,
735
 
                                                shell=True,
736
 
                                                cwd="/",
737
 
                                                **popen_args)
738
 
            except OSError as error:
739
 
                logger.error("Failed to start subprocess",
740
 
                             exc_info=error)
741
 
                return True
742
 
            self.checker_callback_tag = gobject.child_watch_add(
743
 
                self.checker.pid, self.checker_callback, data=command)
744
 
            # The checker may have completed before the gobject
745
 
            # watch was added.  Check for this.
746
 
            try:
747
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
748
 
            except OSError as error:
749
 
                if error.errno == errno.ECHILD:
750
 
                    # This should never happen
751
 
                    logger.error("Child process vanished",
752
 
                                 exc_info=error)
753
 
                    return True
754
 
                raise
755
 
            if pid:
756
 
                gobject.source_remove(self.checker_callback_tag)
757
 
                self.checker_callback(pid, status, command)
758
 
        # Re-run this periodically if run by gobject.timeout_add
 
1074
            logger.info("Starting checker %r for %s", command,
 
1075
                        self.name)
 
1076
            # We don't need to redirect stdout and stderr, since
 
1077
            # in normal mode, that is already done by daemon(),
 
1078
            # and in debug mode we don't want to.  (Stdin is
 
1079
            # always replaced by /dev/null.)
 
1080
            # The exception is when not debugging but nevertheless
 
1081
            # running in the foreground; use the previously
 
1082
            # created wnull.
 
1083
            popen_args = {"close_fds": True,
 
1084
                          "shell": True,
 
1085
                          "cwd": "/"}
 
1086
            if (not self.server_settings["debug"]
 
1087
                and self.server_settings["foreground"]):
 
1088
                popen_args.update({"stdout": wnull,
 
1089
                                   "stderr": wnull})
 
1090
            pipe = multiprocessing.Pipe(duplex=False)
 
1091
            self.checker = multiprocessing.Process(
 
1092
                target=call_pipe,
 
1093
                args=(pipe[1], subprocess.call, command),
 
1094
                kwargs=popen_args)
 
1095
            self.checker.start()
 
1096
            self.checker_callback_tag = GLib.io_add_watch(
 
1097
                pipe[0].fileno(), GLib.IO_IN,
 
1098
                self.checker_callback, pipe[0], command)
 
1099
        # Re-run this periodically if run by GLib.timeout_add
759
1100
        return True
760
 
    
 
1101
 
761
1102
    def stop_checker(self):
762
1103
        """Force the checker process, if any, to stop."""
763
1104
        if self.checker_callback_tag:
764
 
            gobject.source_remove(self.checker_callback_tag)
 
1105
            GLib.source_remove(self.checker_callback_tag)
765
1106
            self.checker_callback_tag = None
766
1107
        if getattr(self, "checker", None) is None:
767
1108
            return
768
1109
        logger.debug("Stopping checker for %(name)s", vars(self))
769
 
        try:
770
 
            self.checker.terminate()
771
 
            #time.sleep(0.5)
772
 
            #if self.checker.poll() is None:
773
 
            #    self.checker.kill()
774
 
        except OSError as error:
775
 
            if error.errno != errno.ESRCH: # No such process
776
 
                raise
 
1110
        self.checker.terminate()
777
1111
        self.checker = None
778
1112
 
779
1113
 
783
1117
                          byte_arrays=False):
784
1118
    """Decorators for marking methods of a DBusObjectWithProperties to
785
1119
    become properties on the D-Bus.
786
 
    
 
1120
 
787
1121
    The decorated method will be called with no arguments by "Get"
788
1122
    and with one argument by "Set".
789
 
    
 
1123
 
790
1124
    The parameters, where they are supported, are the same as
791
1125
    dbus.service.method, except there is only "signature", since the
792
1126
    type from Get() and the type sent to Set() is the same.
796
1130
    if byte_arrays and signature != "ay":
797
1131
        raise ValueError("Byte arrays not supported for non-'ay'"
798
1132
                         " signature {!r}".format(signature))
799
 
    
 
1133
 
800
1134
    def decorator(func):
801
1135
        func._dbus_is_property = True
802
1136
        func._dbus_interface = dbus_interface
805
1139
        func._dbus_name = func.__name__
806
1140
        if func._dbus_name.endswith("_dbus_property"):
807
1141
            func._dbus_name = func._dbus_name[:-14]
808
 
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
 
1142
        func._dbus_get_args_options = {'byte_arrays': byte_arrays}
809
1143
        return func
810
 
    
 
1144
 
811
1145
    return decorator
812
1146
 
813
1147
 
814
1148
def dbus_interface_annotations(dbus_interface):
815
1149
    """Decorator for marking functions returning interface annotations
816
 
    
 
1150
 
817
1151
    Usage:
818
 
    
 
1152
 
819
1153
    @dbus_interface_annotations("org.example.Interface")
820
1154
    def _foo(self):  # Function name does not matter
821
1155
        return {"org.freedesktop.DBus.Deprecated": "true",
822
1156
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
823
1157
                    "false"}
824
1158
    """
825
 
    
 
1159
 
826
1160
    def decorator(func):
827
1161
        func._dbus_is_interface = True
828
1162
        func._dbus_interface = dbus_interface
829
1163
        func._dbus_name = dbus_interface
830
1164
        return func
831
 
    
 
1165
 
832
1166
    return decorator
833
1167
 
834
1168
 
835
1169
def dbus_annotations(annotations):
836
1170
    """Decorator to annotate D-Bus methods, signals or properties
837
1171
    Usage:
838
 
    
 
1172
 
839
1173
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
840
1174
                       "org.freedesktop.DBus.Property."
841
1175
                       "EmitsChangedSignal": "false"})
843
1177
                           access="r")
844
1178
    def Property_dbus_property(self):
845
1179
        return dbus.Boolean(False)
 
1180
 
 
1181
    See also the DBusObjectWithAnnotations class.
846
1182
    """
847
 
    
 
1183
 
848
1184
    def decorator(func):
849
1185
        func._dbus_annotations = annotations
850
1186
        return func
851
 
    
 
1187
 
852
1188
    return decorator
853
1189
 
854
1190
 
870
1206
    pass
871
1207
 
872
1208
 
873
 
class DBusObjectWithProperties(dbus.service.Object):
874
 
    """A D-Bus object with properties.
875
 
    
876
 
    Classes inheriting from this can use the dbus_service_property
877
 
    decorator to expose methods as D-Bus properties.  It exposes the
878
 
    standard Get(), Set(), and GetAll() methods on the D-Bus.
 
1209
class DBusObjectWithAnnotations(dbus.service.Object):
 
1210
    """A D-Bus object with annotations.
 
1211
 
 
1212
    Classes inheriting from this can use the dbus_annotations
 
1213
    decorator to add annotations to methods or signals.
879
1214
    """
880
 
    
 
1215
 
881
1216
    @staticmethod
882
1217
    def _is_dbus_thing(thing):
883
1218
        """Returns a function testing if an attribute is a D-Bus thing
884
 
        
 
1219
 
885
1220
        If called like _is_dbus_thing("method") it returns a function
886
1221
        suitable for use as predicate to inspect.getmembers().
887
1222
        """
888
1223
        return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
889
1224
                                   False)
890
 
    
 
1225
 
891
1226
    def _get_all_dbus_things(self, thing):
892
1227
        """Returns a generator of (name, attribute) pairs
893
1228
        """
896
1231
                for cls in self.__class__.__mro__
897
1232
                for name, athing in
898
1233
                inspect.getmembers(cls, self._is_dbus_thing(thing)))
899
 
    
 
1234
 
 
1235
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
1236
                         out_signature="s",
 
1237
                         path_keyword='object_path',
 
1238
                         connection_keyword='connection')
 
1239
    def Introspect(self, object_path, connection):
 
1240
        """Overloading of standard D-Bus method.
 
1241
 
 
1242
        Inserts annotation tags on methods and signals.
 
1243
        """
 
1244
        xmlstring = dbus.service.Object.Introspect(self, object_path,
 
1245
                                                   connection)
 
1246
        try:
 
1247
            document = xml.dom.minidom.parseString(xmlstring)
 
1248
 
 
1249
            for if_tag in document.getElementsByTagName("interface"):
 
1250
                # Add annotation tags
 
1251
                for typ in ("method", "signal"):
 
1252
                    for tag in if_tag.getElementsByTagName(typ):
 
1253
                        annots = dict()
 
1254
                        for name, prop in (self.
 
1255
                                           _get_all_dbus_things(typ)):
 
1256
                            if (name == tag.getAttribute("name")
 
1257
                                and prop._dbus_interface
 
1258
                                == if_tag.getAttribute("name")):
 
1259
                                annots.update(getattr(
 
1260
                                    prop, "_dbus_annotations", {}))
 
1261
                        for name, value in annots.items():
 
1262
                            ann_tag = document.createElement(
 
1263
                                "annotation")
 
1264
                            ann_tag.setAttribute("name", name)
 
1265
                            ann_tag.setAttribute("value", value)
 
1266
                            tag.appendChild(ann_tag)
 
1267
                # Add interface annotation tags
 
1268
                for annotation, value in dict(
 
1269
                    itertools.chain.from_iterable(
 
1270
                        annotations().items()
 
1271
                        for name, annotations
 
1272
                        in self._get_all_dbus_things("interface")
 
1273
                        if name == if_tag.getAttribute("name")
 
1274
                        )).items():
 
1275
                    ann_tag = document.createElement("annotation")
 
1276
                    ann_tag.setAttribute("name", annotation)
 
1277
                    ann_tag.setAttribute("value", value)
 
1278
                    if_tag.appendChild(ann_tag)
 
1279
                # Fix argument name for the Introspect method itself
 
1280
                if (if_tag.getAttribute("name")
 
1281
                    == dbus.INTROSPECTABLE_IFACE):
 
1282
                    for cn in if_tag.getElementsByTagName("method"):
 
1283
                        if cn.getAttribute("name") == "Introspect":
 
1284
                            for arg in cn.getElementsByTagName("arg"):
 
1285
                                if (arg.getAttribute("direction")
 
1286
                                    == "out"):
 
1287
                                    arg.setAttribute("name",
 
1288
                                                     "xml_data")
 
1289
            xmlstring = document.toxml("utf-8")
 
1290
            document.unlink()
 
1291
        except (AttributeError, xml.dom.DOMException,
 
1292
                xml.parsers.expat.ExpatError) as error:
 
1293
            logger.error("Failed to override Introspection method",
 
1294
                         exc_info=error)
 
1295
        return xmlstring
 
1296
 
 
1297
 
 
1298
class DBusObjectWithProperties(DBusObjectWithAnnotations):
 
1299
    """A D-Bus object with properties.
 
1300
 
 
1301
    Classes inheriting from this can use the dbus_service_property
 
1302
    decorator to expose methods as D-Bus properties.  It exposes the
 
1303
    standard Get(), Set(), and GetAll() methods on the D-Bus.
 
1304
    """
 
1305
 
900
1306
    def _get_dbus_property(self, interface_name, property_name):
901
1307
        """Returns a bound method if one exists which is a D-Bus
902
1308
        property with the specified name and interface.
907
1313
                if (value._dbus_name == property_name
908
1314
                    and value._dbus_interface == interface_name):
909
1315
                    return value.__get__(self)
910
 
        
 
1316
 
911
1317
        # No such property
912
1318
        raise DBusPropertyNotFound("{}:{}.{}".format(
913
1319
            self.dbus_object_path, interface_name, property_name))
914
 
    
 
1320
 
 
1321
    @classmethod
 
1322
    def _get_all_interface_names(cls):
 
1323
        """Get a sequence of all interfaces supported by an object"""
 
1324
        return (name for name in set(getattr(getattr(x, attr),
 
1325
                                             "_dbus_interface", None)
 
1326
                                     for x in (inspect.getmro(cls))
 
1327
                                     for attr in dir(x))
 
1328
                if name is not None)
 
1329
 
915
1330
    @dbus.service.method(dbus.PROPERTIES_IFACE,
916
1331
                         in_signature="ss",
917
1332
                         out_signature="v")
925
1340
        if not hasattr(value, "variant_level"):
926
1341
            return value
927
1342
        return type(value)(value, variant_level=value.variant_level+1)
928
 
    
 
1343
 
929
1344
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
930
1345
    def Set(self, interface_name, property_name, value):
931
1346
        """Standard D-Bus property Set() method, see D-Bus standard.
943
1358
            value = dbus.ByteArray(b''.join(chr(byte)
944
1359
                                            for byte in value))
945
1360
        prop(value)
946
 
    
 
1361
 
947
1362
    @dbus.service.method(dbus.PROPERTIES_IFACE,
948
1363
                         in_signature="s",
949
1364
                         out_signature="a{sv}")
950
1365
    def GetAll(self, interface_name):
951
1366
        """Standard D-Bus property GetAll() method, see D-Bus
952
1367
        standard.
953
 
        
 
1368
 
954
1369
        Note: Will not include properties with access="write".
955
1370
        """
956
1371
        properties = {}
967
1382
                properties[name] = value
968
1383
                continue
969
1384
            properties[name] = type(value)(
970
 
                value, variant_level = value.variant_level + 1)
 
1385
                value, variant_level=value.variant_level + 1)
971
1386
        return dbus.Dictionary(properties, signature="sv")
972
 
    
 
1387
 
973
1388
    @dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
974
1389
    def PropertiesChanged(self, interface_name, changed_properties,
975
1390
                          invalidated_properties):
977
1392
        standard.
978
1393
        """
979
1394
        pass
980
 
    
 
1395
 
981
1396
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
982
1397
                         out_signature="s",
983
1398
                         path_keyword='object_path',
984
1399
                         connection_keyword='connection')
985
1400
    def Introspect(self, object_path, connection):
986
1401
        """Overloading of standard D-Bus method.
987
 
        
 
1402
 
988
1403
        Inserts property tags and interface annotation tags.
989
1404
        """
990
 
        xmlstring = dbus.service.Object.Introspect(self, object_path,
991
 
                                                   connection)
 
1405
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
1406
                                                         object_path,
 
1407
                                                         connection)
992
1408
        try:
993
1409
            document = xml.dom.minidom.parseString(xmlstring)
994
 
            
 
1410
 
995
1411
            def make_tag(document, name, prop):
996
1412
                e = document.createElement("property")
997
1413
                e.setAttribute("name", name)
998
1414
                e.setAttribute("type", prop._dbus_signature)
999
1415
                e.setAttribute("access", prop._dbus_access)
1000
1416
                return e
1001
 
            
 
1417
 
1002
1418
            for if_tag in document.getElementsByTagName("interface"):
1003
1419
                # Add property tags
1004
1420
                for tag in (make_tag(document, name, prop)
1007
1423
                            if prop._dbus_interface
1008
1424
                            == if_tag.getAttribute("name")):
1009
1425
                    if_tag.appendChild(tag)
1010
 
                # Add annotation tags
1011
 
                for typ in ("method", "signal", "property"):
1012
 
                    for tag in if_tag.getElementsByTagName(typ):
1013
 
                        annots = dict()
1014
 
                        for name, prop in (self.
1015
 
                                           _get_all_dbus_things(typ)):
1016
 
                            if (name == tag.getAttribute("name")
1017
 
                                and prop._dbus_interface
1018
 
                                == if_tag.getAttribute("name")):
1019
 
                                annots.update(getattr(
1020
 
                                    prop, "_dbus_annotations", {}))
1021
 
                        for name, value in annots.items():
1022
 
                            ann_tag = document.createElement(
1023
 
                                "annotation")
1024
 
                            ann_tag.setAttribute("name", name)
1025
 
                            ann_tag.setAttribute("value", value)
1026
 
                            tag.appendChild(ann_tag)
1027
 
                # Add interface annotation tags
1028
 
                for annotation, value in dict(
1029
 
                    itertools.chain.from_iterable(
1030
 
                        annotations().items()
1031
 
                        for name, annotations
1032
 
                        in self._get_all_dbus_things("interface")
1033
 
                        if name == if_tag.getAttribute("name")
1034
 
                        )).items():
1035
 
                    ann_tag = document.createElement("annotation")
1036
 
                    ann_tag.setAttribute("name", annotation)
1037
 
                    ann_tag.setAttribute("value", value)
1038
 
                    if_tag.appendChild(ann_tag)
 
1426
                # Add annotation tags for properties
 
1427
                for tag in if_tag.getElementsByTagName("property"):
 
1428
                    annots = dict()
 
1429
                    for name, prop in self._get_all_dbus_things(
 
1430
                            "property"):
 
1431
                        if (name == tag.getAttribute("name")
 
1432
                            and prop._dbus_interface
 
1433
                            == if_tag.getAttribute("name")):
 
1434
                            annots.update(getattr(
 
1435
                                prop, "_dbus_annotations", {}))
 
1436
                    for name, value in annots.items():
 
1437
                        ann_tag = document.createElement(
 
1438
                            "annotation")
 
1439
                        ann_tag.setAttribute("name", name)
 
1440
                        ann_tag.setAttribute("value", value)
 
1441
                        tag.appendChild(ann_tag)
1039
1442
                # Add the names to the return values for the
1040
1443
                # "org.freedesktop.DBus.Properties" methods
1041
1444
                if (if_tag.getAttribute("name")
1060
1463
        return xmlstring
1061
1464
 
1062
1465
 
 
1466
try:
 
1467
    dbus.OBJECT_MANAGER_IFACE
 
1468
except AttributeError:
 
1469
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
 
1470
 
 
1471
 
 
1472
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
 
1473
    """A D-Bus object with an ObjectManager.
 
1474
 
 
1475
    Classes inheriting from this exposes the standard
 
1476
    GetManagedObjects call and the InterfacesAdded and
 
1477
    InterfacesRemoved signals on the standard
 
1478
    "org.freedesktop.DBus.ObjectManager" interface.
 
1479
 
 
1480
    Note: No signals are sent automatically; they must be sent
 
1481
    manually.
 
1482
    """
 
1483
    @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
 
1484
                         out_signature="a{oa{sa{sv}}}")
 
1485
    def GetManagedObjects(self):
 
1486
        """This function must be overridden"""
 
1487
        raise NotImplementedError()
 
1488
 
 
1489
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
 
1490
                         signature="oa{sa{sv}}")
 
1491
    def InterfacesAdded(self, object_path, interfaces_and_properties):
 
1492
        pass
 
1493
 
 
1494
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
 
1495
    def InterfacesRemoved(self, object_path, interfaces):
 
1496
        pass
 
1497
 
 
1498
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
1499
                         out_signature="s",
 
1500
                         path_keyword='object_path',
 
1501
                         connection_keyword='connection')
 
1502
    def Introspect(self, object_path, connection):
 
1503
        """Overloading of standard D-Bus method.
 
1504
 
 
1505
        Override return argument name of GetManagedObjects to be
 
1506
        "objpath_interfaces_and_properties"
 
1507
        """
 
1508
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
1509
                                                         object_path,
 
1510
                                                         connection)
 
1511
        try:
 
1512
            document = xml.dom.minidom.parseString(xmlstring)
 
1513
 
 
1514
            for if_tag in document.getElementsByTagName("interface"):
 
1515
                # Fix argument name for the GetManagedObjects method
 
1516
                if (if_tag.getAttribute("name")
 
1517
                    == dbus.OBJECT_MANAGER_IFACE):
 
1518
                    for cn in if_tag.getElementsByTagName("method"):
 
1519
                        if (cn.getAttribute("name")
 
1520
                            == "GetManagedObjects"):
 
1521
                            for arg in cn.getElementsByTagName("arg"):
 
1522
                                if (arg.getAttribute("direction")
 
1523
                                    == "out"):
 
1524
                                    arg.setAttribute(
 
1525
                                        "name",
 
1526
                                        "objpath_interfaces"
 
1527
                                        "_and_properties")
 
1528
            xmlstring = document.toxml("utf-8")
 
1529
            document.unlink()
 
1530
        except (AttributeError, xml.dom.DOMException,
 
1531
                xml.parsers.expat.ExpatError) as error:
 
1532
            logger.error("Failed to override Introspection method",
 
1533
                         exc_info=error)
 
1534
        return xmlstring
 
1535
 
 
1536
 
1063
1537
def datetime_to_dbus(dt, variant_level=0):
1064
1538
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1065
1539
    if dt is None:
1066
 
        return dbus.String("", variant_level = variant_level)
 
1540
        return dbus.String("", variant_level=variant_level)
1067
1541
    return dbus.String(dt.isoformat(), variant_level=variant_level)
1068
1542
 
1069
1543
 
1072
1546
    dbus.service.Object, it will add alternate D-Bus attributes with
1073
1547
    interface names according to the "alt_interface_names" mapping.
1074
1548
    Usage:
1075
 
    
 
1549
 
1076
1550
    @alternate_dbus_interfaces({"org.example.Interface":
1077
1551
                                    "net.example.AlternateInterface"})
1078
1552
    class SampleDBusObject(dbus.service.Object):
1079
1553
        @dbus.service.method("org.example.Interface")
1080
1554
        def SampleDBusMethod():
1081
1555
            pass
1082
 
    
 
1556
 
1083
1557
    The above "SampleDBusMethod" on "SampleDBusObject" will be
1084
1558
    reachable via two interfaces: "org.example.Interface" and
1085
1559
    "net.example.AlternateInterface", the latter of which will have
1086
1560
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1087
1561
    "true", unless "deprecate" is passed with a False value.
1088
 
    
 
1562
 
1089
1563
    This works for methods and signals, and also for D-Bus properties
1090
1564
    (from DBusObjectWithProperties) and interfaces (from the
1091
1565
    dbus_interface_annotations decorator).
1092
1566
    """
1093
 
    
 
1567
 
1094
1568
    def wrapper(cls):
1095
1569
        for orig_interface_name, alt_interface_name in (
1096
1570
                alt_interface_names.items()):
1113
1587
                if getattr(attribute, "_dbus_is_signal", False):
1114
1588
                    # Extract the original non-method undecorated
1115
1589
                    # function by black magic
1116
 
                    nonmethod_func = (dict(
1117
 
                        zip(attribute.func_code.co_freevars,
1118
 
                            attribute.__closure__))
1119
 
                                      ["func"].cell_contents)
 
1590
                    if sys.version_info.major == 2:
 
1591
                        nonmethod_func = (dict(
 
1592
                            zip(attribute.func_code.co_freevars,
 
1593
                                attribute.__closure__))
 
1594
                                          ["func"].cell_contents)
 
1595
                    else:
 
1596
                        nonmethod_func = (dict(
 
1597
                            zip(attribute.__code__.co_freevars,
 
1598
                                attribute.__closure__))
 
1599
                                          ["func"].cell_contents)
1120
1600
                    # Create a new, but exactly alike, function
1121
1601
                    # object, and decorate it to be a new D-Bus signal
1122
1602
                    # with the alternate D-Bus interface name
 
1603
                    new_function = copy_function(nonmethod_func)
1123
1604
                    new_function = (dbus.service.signal(
1124
 
                        alt_interface, attribute._dbus_signature)
1125
 
                                    (types.FunctionType(
1126
 
                                        nonmethod_func.func_code,
1127
 
                                        nonmethod_func.func_globals,
1128
 
                                        nonmethod_func.func_name,
1129
 
                                        nonmethod_func.func_defaults,
1130
 
                                        nonmethod_func.func_closure)))
 
1605
                        alt_interface,
 
1606
                        attribute._dbus_signature)(new_function))
1131
1607
                    # Copy annotations, if any
1132
1608
                    try:
1133
1609
                        new_function._dbus_annotations = dict(
1134
1610
                            attribute._dbus_annotations)
1135
1611
                    except AttributeError:
1136
1612
                        pass
 
1613
 
1137
1614
                    # Define a creator of a function to call both the
1138
1615
                    # original and alternate functions, so both the
1139
1616
                    # original and alternate signals gets sent when
1142
1619
                        """This function is a scope container to pass
1143
1620
                        func1 and func2 to the "call_both" function
1144
1621
                        outside of its arguments"""
1145
 
                        
 
1622
 
 
1623
                        @functools.wraps(func2)
1146
1624
                        def call_both(*args, **kwargs):
1147
1625
                            """This function will emit two D-Bus
1148
1626
                            signals by calling func1 and func2"""
1149
1627
                            func1(*args, **kwargs)
1150
1628
                            func2(*args, **kwargs)
1151
 
                        
 
1629
                        # Make wrapper function look like a D-Bus
 
1630
                        # signal
 
1631
                        for name, attr in inspect.getmembers(func2):
 
1632
                            if name.startswith("_dbus_"):
 
1633
                                setattr(call_both, name, attr)
 
1634
 
1152
1635
                        return call_both
1153
1636
                    # Create the "call_both" function and add it to
1154
1637
                    # the class
1164
1647
                            alt_interface,
1165
1648
                            attribute._dbus_in_signature,
1166
1649
                            attribute._dbus_out_signature)
1167
 
                        (types.FunctionType(attribute.func_code,
1168
 
                                            attribute.func_globals,
1169
 
                                            attribute.func_name,
1170
 
                                            attribute.func_defaults,
1171
 
                                            attribute.func_closure)))
 
1650
                        (copy_function(attribute)))
1172
1651
                    # Copy annotations, if any
1173
1652
                    try:
1174
1653
                        attr[attrname]._dbus_annotations = dict(
1186
1665
                        attribute._dbus_access,
1187
1666
                        attribute._dbus_get_args_options
1188
1667
                        ["byte_arrays"])
1189
 
                                      (types.FunctionType(
1190
 
                                          attribute.func_code,
1191
 
                                          attribute.func_globals,
1192
 
                                          attribute.func_name,
1193
 
                                          attribute.func_defaults,
1194
 
                                          attribute.func_closure)))
 
1668
                                      (copy_function(attribute)))
1195
1669
                    # Copy annotations, if any
1196
1670
                    try:
1197
1671
                        attr[attrname]._dbus_annotations = dict(
1206
1680
                    # to the class.
1207
1681
                    attr[attrname] = (
1208
1682
                        dbus_interface_annotations(alt_interface)
1209
 
                        (types.FunctionType(attribute.func_code,
1210
 
                                            attribute.func_globals,
1211
 
                                            attribute.func_name,
1212
 
                                            attribute.func_defaults,
1213
 
                                            attribute.func_closure)))
 
1683
                        (copy_function(attribute)))
1214
1684
            if deprecate:
1215
1685
                # Deprecate all alternate interfaces
1216
 
                iname="_AlternateDBusNames_interface_annotation{}"
 
1686
                iname = "_AlternateDBusNames_interface_annotation{}"
1217
1687
                for interface_name in interface_names:
1218
 
                    
 
1688
 
1219
1689
                    @dbus_interface_annotations(interface_name)
1220
1690
                    def func(self):
1221
 
                        return { "org.freedesktop.DBus.Deprecated":
1222
 
                                 "true" }
 
1691
                        return {"org.freedesktop.DBus.Deprecated":
 
1692
                                "true"}
1223
1693
                    # Find an unused name
1224
1694
                    for aname in (iname.format(i)
1225
1695
                                  for i in itertools.count()):
1229
1699
            if interface_names:
1230
1700
                # Replace the class with a new subclass of it with
1231
1701
                # methods, signals, etc. as created above.
1232
 
                cls = type(b"{}Alternate".format(cls.__name__),
1233
 
                           (cls, ), attr)
 
1702
                if sys.version_info.major == 2:
 
1703
                    cls = type(b"{}Alternate".format(cls.__name__),
 
1704
                               (cls, ), attr)
 
1705
                else:
 
1706
                    cls = type("{}Alternate".format(cls.__name__),
 
1707
                               (cls, ), attr)
1234
1708
        return cls
1235
 
    
 
1709
 
1236
1710
    return wrapper
1237
1711
 
1238
1712
 
1240
1714
                            "se.bsnet.fukt.Mandos"})
1241
1715
class ClientDBus(Client, DBusObjectWithProperties):
1242
1716
    """A Client class using D-Bus
1243
 
    
 
1717
 
1244
1718
    Attributes:
1245
1719
    dbus_object_path: dbus.ObjectPath
1246
1720
    bus: dbus.SystemBus()
1247
1721
    """
1248
 
    
 
1722
 
1249
1723
    runtime_expansions = (Client.runtime_expansions
1250
1724
                          + ("dbus_object_path", ))
1251
 
    
 
1725
 
1252
1726
    _interface = "se.recompile.Mandos.Client"
1253
 
    
 
1727
 
1254
1728
    # dbus.service.Object doesn't use super(), so we can't either.
1255
 
    
1256
 
    def __init__(self, bus = None, *args, **kwargs):
 
1729
 
 
1730
    def __init__(self, bus=None, *args, **kwargs):
1257
1731
        self.bus = bus
1258
1732
        Client.__init__(self, *args, **kwargs)
1259
1733
        # Only now, when this client is initialized, can it show up on
1265
1739
            "/clients/" + client_object_name)
1266
1740
        DBusObjectWithProperties.__init__(self, self.bus,
1267
1741
                                          self.dbus_object_path)
1268
 
    
 
1742
 
1269
1743
    def notifychangeproperty(transform_func, dbus_name,
1270
1744
                             type_func=lambda x: x,
1271
1745
                             variant_level=1,
1273
1747
                             _interface=_interface):
1274
1748
        """ Modify a variable so that it's a property which announces
1275
1749
        its changes to DBus.
1276
 
        
 
1750
 
1277
1751
        transform_fun: Function that takes a value and a variant_level
1278
1752
                       and transforms it to a D-Bus type.
1279
1753
        dbus_name: D-Bus name of the variable
1282
1756
        variant_level: D-Bus variant level.  Default: 1
1283
1757
        """
1284
1758
        attrname = "_{}".format(dbus_name)
1285
 
        
 
1759
 
1286
1760
        def setter(self, value):
1287
1761
            if hasattr(self, "dbus_object_path"):
1288
1762
                if (not hasattr(self, attrname) or
1295
1769
                    else:
1296
1770
                        dbus_value = transform_func(
1297
1771
                            type_func(value),
1298
 
                            variant_level = variant_level)
 
1772
                            variant_level=variant_level)
1299
1773
                        self.PropertyChanged(dbus.String(dbus_name),
1300
1774
                                             dbus_value)
1301
1775
                        self.PropertiesChanged(
1302
1776
                            _interface,
1303
 
                            dbus.Dictionary({ dbus.String(dbus_name):
1304
 
                                              dbus_value }),
 
1777
                            dbus.Dictionary({dbus.String(dbus_name):
 
1778
                                             dbus_value}),
1305
1779
                            dbus.Array())
1306
1780
            setattr(self, attrname, value)
1307
 
        
 
1781
 
1308
1782
        return property(lambda self: getattr(self, attrname), setter)
1309
 
    
 
1783
 
1310
1784
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1311
1785
    approvals_pending = notifychangeproperty(dbus.Boolean,
1312
1786
                                             "ApprovalPending",
1313
 
                                             type_func = bool)
 
1787
                                             type_func=bool)
1314
1788
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1315
1789
    last_enabled = notifychangeproperty(datetime_to_dbus,
1316
1790
                                        "LastEnabled")
1317
1791
    checker = notifychangeproperty(
1318
1792
        dbus.Boolean, "CheckerRunning",
1319
 
        type_func = lambda checker: checker is not None)
 
1793
        type_func=lambda checker: checker is not None)
1320
1794
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1321
1795
                                           "LastCheckedOK")
1322
1796
    last_checker_status = notifychangeproperty(dbus.Int16,
1327
1801
                                               "ApprovedByDefault")
1328
1802
    approval_delay = notifychangeproperty(
1329
1803
        dbus.UInt64, "ApprovalDelay",
1330
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1804
        type_func=lambda td: td.total_seconds() * 1000)
1331
1805
    approval_duration = notifychangeproperty(
1332
1806
        dbus.UInt64, "ApprovalDuration",
1333
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1807
        type_func=lambda td: td.total_seconds() * 1000)
1334
1808
    host = notifychangeproperty(dbus.String, "Host")
1335
1809
    timeout = notifychangeproperty(
1336
1810
        dbus.UInt64, "Timeout",
1337
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1811
        type_func=lambda td: td.total_seconds() * 1000)
1338
1812
    extended_timeout = notifychangeproperty(
1339
1813
        dbus.UInt64, "ExtendedTimeout",
1340
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1814
        type_func=lambda td: td.total_seconds() * 1000)
1341
1815
    interval = notifychangeproperty(
1342
1816
        dbus.UInt64, "Interval",
1343
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1817
        type_func=lambda td: td.total_seconds() * 1000)
1344
1818
    checker_command = notifychangeproperty(dbus.String, "Checker")
1345
1819
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
1346
1820
                                  invalidate_only=True)
1347
 
    
 
1821
 
1348
1822
    del notifychangeproperty
1349
 
    
 
1823
 
1350
1824
    def __del__(self, *args, **kwargs):
1351
1825
        try:
1352
1826
            self.remove_from_connection()
1355
1829
        if hasattr(DBusObjectWithProperties, "__del__"):
1356
1830
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
1357
1831
        Client.__del__(self, *args, **kwargs)
1358
 
    
1359
 
    def checker_callback(self, pid, condition, command,
1360
 
                         *args, **kwargs):
1361
 
        self.checker_callback_tag = None
1362
 
        self.checker = None
1363
 
        if os.WIFEXITED(condition):
1364
 
            exitstatus = os.WEXITSTATUS(condition)
 
1832
 
 
1833
    def checker_callback(self, source, condition,
 
1834
                         connection, command, *args, **kwargs):
 
1835
        ret = Client.checker_callback(self, source, condition,
 
1836
                                      connection, command, *args,
 
1837
                                      **kwargs)
 
1838
        exitstatus = self.last_checker_status
 
1839
        if exitstatus >= 0:
1365
1840
            # Emit D-Bus signal
1366
1841
            self.CheckerCompleted(dbus.Int16(exitstatus),
1367
 
                                  dbus.Int64(condition),
 
1842
                                  # This is specific to GNU libC
 
1843
                                  dbus.Int64(exitstatus << 8),
1368
1844
                                  dbus.String(command))
1369
1845
        else:
1370
1846
            # Emit D-Bus signal
1371
1847
            self.CheckerCompleted(dbus.Int16(-1),
1372
 
                                  dbus.Int64(condition),
 
1848
                                  dbus.Int64(
 
1849
                                      # This is specific to GNU libC
 
1850
                                      (exitstatus << 8)
 
1851
                                      | self.last_checker_signal),
1373
1852
                                  dbus.String(command))
1374
 
        
1375
 
        return Client.checker_callback(self, pid, condition, command,
1376
 
                                       *args, **kwargs)
1377
 
    
 
1853
        return ret
 
1854
 
1378
1855
    def start_checker(self, *args, **kwargs):
1379
1856
        old_checker_pid = getattr(self.checker, "pid", None)
1380
1857
        r = Client.start_checker(self, *args, **kwargs)
1384
1861
            # Emit D-Bus signal
1385
1862
            self.CheckerStarted(self.current_checker_command)
1386
1863
        return r
1387
 
    
 
1864
 
1388
1865
    def _reset_approved(self):
1389
1866
        self.approved = None
1390
1867
        return False
1391
 
    
 
1868
 
1392
1869
    def approve(self, value=True):
1393
1870
        self.approved = value
1394
 
        gobject.timeout_add(int(self.approval_duration.total_seconds()
1395
 
                                * 1000), self._reset_approved)
 
1871
        GLib.timeout_add(int(self.approval_duration.total_seconds()
 
1872
                             * 1000), self._reset_approved)
1396
1873
        self.send_changedstate()
1397
 
    
1398
 
    ## D-Bus methods, signals & properties
1399
 
    
1400
 
    ## Interfaces
1401
 
    
1402
 
    ## Signals
1403
 
    
 
1874
 
 
1875
    #  D-Bus methods, signals & properties
 
1876
 
 
1877
    #  Interfaces
 
1878
 
 
1879
    #  Signals
 
1880
 
1404
1881
    # CheckerCompleted - signal
1405
1882
    @dbus.service.signal(_interface, signature="nxs")
1406
1883
    def CheckerCompleted(self, exitcode, waitstatus, command):
1407
1884
        "D-Bus signal"
1408
1885
        pass
1409
 
    
 
1886
 
1410
1887
    # CheckerStarted - signal
1411
1888
    @dbus.service.signal(_interface, signature="s")
1412
1889
    def CheckerStarted(self, command):
1413
1890
        "D-Bus signal"
1414
1891
        pass
1415
 
    
 
1892
 
1416
1893
    # PropertyChanged - signal
1417
1894
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1418
1895
    @dbus.service.signal(_interface, signature="sv")
1419
1896
    def PropertyChanged(self, property, value):
1420
1897
        "D-Bus signal"
1421
1898
        pass
1422
 
    
 
1899
 
1423
1900
    # GotSecret - signal
1424
1901
    @dbus.service.signal(_interface)
1425
1902
    def GotSecret(self):
1428
1905
        server to mandos-client
1429
1906
        """
1430
1907
        pass
1431
 
    
 
1908
 
1432
1909
    # Rejected - signal
1433
1910
    @dbus.service.signal(_interface, signature="s")
1434
1911
    def Rejected(self, reason):
1435
1912
        "D-Bus signal"
1436
1913
        pass
1437
 
    
 
1914
 
1438
1915
    # NeedApproval - signal
1439
1916
    @dbus.service.signal(_interface, signature="tb")
1440
1917
    def NeedApproval(self, timeout, default):
1441
1918
        "D-Bus signal"
1442
1919
        return self.need_approval()
1443
 
    
1444
 
    ## Methods
1445
 
    
 
1920
 
 
1921
    #  Methods
 
1922
 
1446
1923
    # Approve - method
1447
1924
    @dbus.service.method(_interface, in_signature="b")
1448
1925
    def Approve(self, value):
1449
1926
        self.approve(value)
1450
 
    
 
1927
 
1451
1928
    # CheckedOK - method
1452
1929
    @dbus.service.method(_interface)
1453
1930
    def CheckedOK(self):
1454
1931
        self.checked_ok()
1455
 
    
 
1932
 
1456
1933
    # Enable - method
 
1934
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1457
1935
    @dbus.service.method(_interface)
1458
1936
    def Enable(self):
1459
1937
        "D-Bus method"
1460
1938
        self.enable()
1461
 
    
 
1939
 
1462
1940
    # StartChecker - method
 
1941
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1463
1942
    @dbus.service.method(_interface)
1464
1943
    def StartChecker(self):
1465
1944
        "D-Bus method"
1466
1945
        self.start_checker()
1467
 
    
 
1946
 
1468
1947
    # Disable - method
 
1948
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1469
1949
    @dbus.service.method(_interface)
1470
1950
    def Disable(self):
1471
1951
        "D-Bus method"
1472
1952
        self.disable()
1473
 
    
 
1953
 
1474
1954
    # StopChecker - method
 
1955
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1475
1956
    @dbus.service.method(_interface)
1476
1957
    def StopChecker(self):
1477
1958
        self.stop_checker()
1478
 
    
1479
 
    ## Properties
1480
 
    
 
1959
 
 
1960
    #  Properties
 
1961
 
1481
1962
    # ApprovalPending - property
1482
1963
    @dbus_service_property(_interface, signature="b", access="read")
1483
1964
    def ApprovalPending_dbus_property(self):
1484
1965
        return dbus.Boolean(bool(self.approvals_pending))
1485
 
    
 
1966
 
1486
1967
    # ApprovedByDefault - property
1487
1968
    @dbus_service_property(_interface,
1488
1969
                           signature="b",
1491
1972
        if value is None:       # get
1492
1973
            return dbus.Boolean(self.approved_by_default)
1493
1974
        self.approved_by_default = bool(value)
1494
 
    
 
1975
 
1495
1976
    # ApprovalDelay - property
1496
1977
    @dbus_service_property(_interface,
1497
1978
                           signature="t",
1501
1982
            return dbus.UInt64(self.approval_delay.total_seconds()
1502
1983
                               * 1000)
1503
1984
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1504
 
    
 
1985
 
1505
1986
    # ApprovalDuration - property
1506
1987
    @dbus_service_property(_interface,
1507
1988
                           signature="t",
1511
1992
            return dbus.UInt64(self.approval_duration.total_seconds()
1512
1993
                               * 1000)
1513
1994
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1514
 
    
 
1995
 
1515
1996
    # Name - property
 
1997
    @dbus_annotations(
 
1998
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1516
1999
    @dbus_service_property(_interface, signature="s", access="read")
1517
2000
    def Name_dbus_property(self):
1518
2001
        return dbus.String(self.name)
1519
 
    
 
2002
 
1520
2003
    # Fingerprint - property
 
2004
    @dbus_annotations(
 
2005
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1521
2006
    @dbus_service_property(_interface, signature="s", access="read")
1522
2007
    def Fingerprint_dbus_property(self):
1523
2008
        return dbus.String(self.fingerprint)
1524
 
    
 
2009
 
1525
2010
    # Host - property
1526
2011
    @dbus_service_property(_interface,
1527
2012
                           signature="s",
1530
2015
        if value is None:       # get
1531
2016
            return dbus.String(self.host)
1532
2017
        self.host = str(value)
1533
 
    
 
2018
 
1534
2019
    # Created - property
 
2020
    @dbus_annotations(
 
2021
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1535
2022
    @dbus_service_property(_interface, signature="s", access="read")
1536
2023
    def Created_dbus_property(self):
1537
2024
        return datetime_to_dbus(self.created)
1538
 
    
 
2025
 
1539
2026
    # LastEnabled - property
1540
2027
    @dbus_service_property(_interface, signature="s", access="read")
1541
2028
    def LastEnabled_dbus_property(self):
1542
2029
        return datetime_to_dbus(self.last_enabled)
1543
 
    
 
2030
 
1544
2031
    # Enabled - property
1545
2032
    @dbus_service_property(_interface,
1546
2033
                           signature="b",
1552
2039
            self.enable()
1553
2040
        else:
1554
2041
            self.disable()
1555
 
    
 
2042
 
1556
2043
    # LastCheckedOK - property
1557
2044
    @dbus_service_property(_interface,
1558
2045
                           signature="s",
1562
2049
            self.checked_ok()
1563
2050
            return
1564
2051
        return datetime_to_dbus(self.last_checked_ok)
1565
 
    
 
2052
 
1566
2053
    # LastCheckerStatus - property
1567
2054
    @dbus_service_property(_interface, signature="n", access="read")
1568
2055
    def LastCheckerStatus_dbus_property(self):
1569
2056
        return dbus.Int16(self.last_checker_status)
1570
 
    
 
2057
 
1571
2058
    # Expires - property
1572
2059
    @dbus_service_property(_interface, signature="s", access="read")
1573
2060
    def Expires_dbus_property(self):
1574
2061
        return datetime_to_dbus(self.expires)
1575
 
    
 
2062
 
1576
2063
    # LastApprovalRequest - property
1577
2064
    @dbus_service_property(_interface, signature="s", access="read")
1578
2065
    def LastApprovalRequest_dbus_property(self):
1579
2066
        return datetime_to_dbus(self.last_approval_request)
1580
 
    
 
2067
 
1581
2068
    # Timeout - property
1582
2069
    @dbus_service_property(_interface,
1583
2070
                           signature="t",
1598
2085
                if (getattr(self, "disable_initiator_tag", None)
1599
2086
                    is None):
1600
2087
                    return
1601
 
                gobject.source_remove(self.disable_initiator_tag)
1602
 
                self.disable_initiator_tag = gobject.timeout_add(
 
2088
                GLib.source_remove(self.disable_initiator_tag)
 
2089
                self.disable_initiator_tag = GLib.timeout_add(
1603
2090
                    int((self.expires - now).total_seconds() * 1000),
1604
2091
                    self.disable)
1605
 
    
 
2092
 
1606
2093
    # ExtendedTimeout - property
1607
2094
    @dbus_service_property(_interface,
1608
2095
                           signature="t",
1612
2099
            return dbus.UInt64(self.extended_timeout.total_seconds()
1613
2100
                               * 1000)
1614
2101
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1615
 
    
 
2102
 
1616
2103
    # Interval - property
1617
2104
    @dbus_service_property(_interface,
1618
2105
                           signature="t",
1625
2112
            return
1626
2113
        if self.enabled:
1627
2114
            # Reschedule checker run
1628
 
            gobject.source_remove(self.checker_initiator_tag)
1629
 
            self.checker_initiator_tag = gobject.timeout_add(
 
2115
            GLib.source_remove(self.checker_initiator_tag)
 
2116
            self.checker_initiator_tag = GLib.timeout_add(
1630
2117
                value, self.start_checker)
1631
 
            self.start_checker() # Start one now, too
1632
 
    
 
2118
            self.start_checker()  # Start one now, too
 
2119
 
1633
2120
    # Checker - property
1634
2121
    @dbus_service_property(_interface,
1635
2122
                           signature="s",
1638
2125
        if value is None:       # get
1639
2126
            return dbus.String(self.checker_command)
1640
2127
        self.checker_command = str(value)
1641
 
    
 
2128
 
1642
2129
    # CheckerRunning - property
1643
2130
    @dbus_service_property(_interface,
1644
2131
                           signature="b",
1650
2137
            self.start_checker()
1651
2138
        else:
1652
2139
            self.stop_checker()
1653
 
    
 
2140
 
1654
2141
    # ObjectPath - property
 
2142
    @dbus_annotations(
 
2143
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
 
2144
         "org.freedesktop.DBus.Deprecated": "true"})
1655
2145
    @dbus_service_property(_interface, signature="o", access="read")
1656
2146
    def ObjectPath_dbus_property(self):
1657
 
        return self.dbus_object_path # is already a dbus.ObjectPath
1658
 
    
 
2147
        return self.dbus_object_path  # is already a dbus.ObjectPath
 
2148
 
1659
2149
    # Secret = property
 
2150
    @dbus_annotations(
 
2151
        {"org.freedesktop.DBus.Property.EmitsChangedSignal":
 
2152
         "invalidates"})
1660
2153
    @dbus_service_property(_interface,
1661
2154
                           signature="ay",
1662
2155
                           access="write",
1663
2156
                           byte_arrays=True)
1664
2157
    def Secret_dbus_property(self, value):
1665
2158
        self.secret = bytes(value)
1666
 
    
 
2159
 
1667
2160
    del _interface
1668
2161
 
1669
2162
 
1672
2165
        self._pipe = child_pipe
1673
2166
        self._pipe.send(('init', fpr, address))
1674
2167
        if not self._pipe.recv():
1675
 
            raise KeyError()
1676
 
    
 
2168
            raise KeyError(fpr)
 
2169
 
1677
2170
    def __getattribute__(self, name):
1678
2171
        if name == '_pipe':
1679
2172
            return super(ProxyClient, self).__getattribute__(name)
1682
2175
        if data[0] == 'data':
1683
2176
            return data[1]
1684
2177
        if data[0] == 'function':
1685
 
            
 
2178
 
1686
2179
            def func(*args, **kwargs):
1687
2180
                self._pipe.send(('funcall', name, args, kwargs))
1688
2181
                return self._pipe.recv()[1]
1689
 
            
 
2182
 
1690
2183
            return func
1691
 
    
 
2184
 
1692
2185
    def __setattr__(self, name, value):
1693
2186
        if name == '_pipe':
1694
2187
            return super(ProxyClient, self).__setattr__(name, value)
1697
2190
 
1698
2191
class ClientHandler(socketserver.BaseRequestHandler, object):
1699
2192
    """A class to handle client connections.
1700
 
    
 
2193
 
1701
2194
    Instantiated once for each connection to handle it.
1702
2195
    Note: This will run in its own forked process."""
1703
 
    
 
2196
 
1704
2197
    def handle(self):
1705
2198
        with contextlib.closing(self.server.child_pipe) as child_pipe:
1706
2199
            logger.info("TCP connection from: %s",
1707
2200
                        str(self.client_address))
1708
2201
            logger.debug("Pipe FD: %d",
1709
2202
                         self.server.child_pipe.fileno())
1710
 
            
1711
 
            session = gnutls.connection.ClientSession(
1712
 
                self.request, gnutls.connection .X509Credentials())
1713
 
            
1714
 
            # Note: gnutls.connection.X509Credentials is really a
1715
 
            # generic GnuTLS certificate credentials object so long as
1716
 
            # no X.509 keys are added to it.  Therefore, we can use it
1717
 
            # here despite using OpenPGP certificates.
1718
 
            
1719
 
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
1720
 
            #                      "+AES-256-CBC", "+SHA1",
1721
 
            #                      "+COMP-NULL", "+CTYPE-OPENPGP",
1722
 
            #                      "+DHE-DSS"))
 
2203
 
 
2204
            session = gnutls.ClientSession(self.request)
 
2205
 
 
2206
            # priority = ':'.join(("NONE", "+VERS-TLS1.1",
 
2207
            #                       "+AES-256-CBC", "+SHA1",
 
2208
            #                       "+COMP-NULL", "+CTYPE-OPENPGP",
 
2209
            #                       "+DHE-DSS"))
1723
2210
            # Use a fallback default, since this MUST be set.
1724
2211
            priority = self.server.gnutls_priority
1725
2212
            if priority is None:
1726
2213
                priority = "NORMAL"
1727
 
            gnutls.library.functions.gnutls_priority_set_direct(
1728
 
                session._c_object, priority, None)
1729
 
            
 
2214
            gnutls.priority_set_direct(session._c_object,
 
2215
                                       priority.encode("utf-8"),
 
2216
                                       None)
 
2217
 
1730
2218
            # Start communication using the Mandos protocol
1731
2219
            # Get protocol number
1732
2220
            line = self.request.makefile().readline()
1737
2225
            except (ValueError, IndexError, RuntimeError) as error:
1738
2226
                logger.error("Unknown protocol version: %s", error)
1739
2227
                return
1740
 
            
 
2228
 
1741
2229
            # Start GnuTLS connection
1742
2230
            try:
1743
2231
                session.handshake()
1744
 
            except gnutls.errors.GNUTLSError as error:
 
2232
            except gnutls.Error as error:
1745
2233
                logger.warning("Handshake failed: %s", error)
1746
2234
                # Do not run session.bye() here: the session is not
1747
2235
                # established.  Just abandon the request.
1748
2236
                return
1749
2237
            logger.debug("Handshake succeeded")
1750
 
            
 
2238
 
1751
2239
            approval_required = False
1752
2240
            try:
1753
2241
                try:
1754
2242
                    fpr = self.fingerprint(
1755
2243
                        self.peer_certificate(session))
1756
 
                except (TypeError,
1757
 
                        gnutls.errors.GNUTLSError) as error:
 
2244
                except (TypeError, gnutls.Error) as error:
1758
2245
                    logger.warning("Bad certificate: %s", error)
1759
2246
                    return
1760
2247
                logger.debug("Fingerprint: %s", fpr)
1761
 
                
 
2248
 
1762
2249
                try:
1763
2250
                    client = ProxyClient(child_pipe, fpr,
1764
2251
                                         self.client_address)
1765
2252
                except KeyError:
1766
2253
                    return
1767
 
                
 
2254
 
1768
2255
                if client.approval_delay:
1769
2256
                    delay = client.approval_delay
1770
2257
                    client.approvals_pending += 1
1771
2258
                    approval_required = True
1772
 
                
 
2259
 
1773
2260
                while True:
1774
2261
                    if not client.enabled:
1775
2262
                        logger.info("Client %s is disabled",
1778
2265
                            # Emit D-Bus signal
1779
2266
                            client.Rejected("Disabled")
1780
2267
                        return
1781
 
                    
 
2268
 
1782
2269
                    if client.approved or not client.approval_delay:
1783
 
                        #We are approved or approval is disabled
 
2270
                        # We are approved or approval is disabled
1784
2271
                        break
1785
2272
                    elif client.approved is None:
1786
2273
                        logger.info("Client %s needs approval",
1797
2284
                            # Emit D-Bus signal
1798
2285
                            client.Rejected("Denied")
1799
2286
                        return
1800
 
                    
1801
 
                    #wait until timeout or approved
 
2287
 
 
2288
                    # wait until timeout or approved
1802
2289
                    time = datetime.datetime.now()
1803
2290
                    client.changedstate.acquire()
1804
2291
                    client.changedstate.wait(delay.total_seconds())
1817
2304
                            break
1818
2305
                    else:
1819
2306
                        delay -= time2 - time
1820
 
                
1821
 
                sent_size = 0
1822
 
                while sent_size < len(client.secret):
1823
 
                    try:
1824
 
                        sent = session.send(client.secret[sent_size:])
1825
 
                    except gnutls.errors.GNUTLSError as error:
1826
 
                        logger.warning("gnutls send failed",
1827
 
                                       exc_info=error)
1828
 
                        return
1829
 
                    logger.debug("Sent: %d, remaining: %d", sent,
1830
 
                                 len(client.secret) - (sent_size
1831
 
                                                       + sent))
1832
 
                    sent_size += sent
1833
 
                
 
2307
 
 
2308
                try:
 
2309
                    session.send(client.secret)
 
2310
                except gnutls.Error as error:
 
2311
                    logger.warning("gnutls send failed",
 
2312
                                   exc_info=error)
 
2313
                    return
 
2314
 
1834
2315
                logger.info("Sending secret to %s", client.name)
1835
2316
                # bump the timeout using extended_timeout
1836
2317
                client.bump_timeout(client.extended_timeout)
1837
2318
                if self.server.use_dbus:
1838
2319
                    # Emit D-Bus signal
1839
2320
                    client.GotSecret()
1840
 
            
 
2321
 
1841
2322
            finally:
1842
2323
                if approval_required:
1843
2324
                    client.approvals_pending -= 1
1844
2325
                try:
1845
2326
                    session.bye()
1846
 
                except gnutls.errors.GNUTLSError as error:
 
2327
                except gnutls.Error as error:
1847
2328
                    logger.warning("GnuTLS bye failed",
1848
2329
                                   exc_info=error)
1849
 
    
 
2330
 
1850
2331
    @staticmethod
1851
2332
    def peer_certificate(session):
1852
2333
        "Return the peer's OpenPGP certificate as a bytestring"
1853
2334
        # If not an OpenPGP certificate...
1854
 
        if (gnutls.library.functions.gnutls_certificate_type_get(
1855
 
                session._c_object)
1856
 
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1857
 
            # ...do the normal thing
1858
 
            return session.peer_certificate
 
2335
        if (gnutls.certificate_type_get(session._c_object)
 
2336
            != gnutls.CRT_OPENPGP):
 
2337
            # ...return invalid data
 
2338
            return b""
1859
2339
        list_size = ctypes.c_uint(1)
1860
 
        cert_list = (gnutls.library.functions
1861
 
                     .gnutls_certificate_get_peers
 
2340
        cert_list = (gnutls.certificate_get_peers
1862
2341
                     (session._c_object, ctypes.byref(list_size)))
1863
2342
        if not bool(cert_list) and list_size.value != 0:
1864
 
            raise gnutls.errors.GNUTLSError("error getting peer"
1865
 
                                            " certificate")
 
2343
            raise gnutls.Error("error getting peer certificate")
1866
2344
        if list_size.value == 0:
1867
2345
            return None
1868
2346
        cert = cert_list[0]
1869
2347
        return ctypes.string_at(cert.data, cert.size)
1870
 
    
 
2348
 
1871
2349
    @staticmethod
1872
2350
    def fingerprint(openpgp):
1873
2351
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
1874
2352
        # New GnuTLS "datum" with the OpenPGP public key
1875
 
        datum = gnutls.library.types.gnutls_datum_t(
 
2353
        datum = gnutls.datum_t(
1876
2354
            ctypes.cast(ctypes.c_char_p(openpgp),
1877
2355
                        ctypes.POINTER(ctypes.c_ubyte)),
1878
2356
            ctypes.c_uint(len(openpgp)))
1879
2357
        # New empty GnuTLS certificate
1880
 
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
1881
 
        gnutls.library.functions.gnutls_openpgp_crt_init(
1882
 
            ctypes.byref(crt))
 
2358
        crt = gnutls.openpgp_crt_t()
 
2359
        gnutls.openpgp_crt_init(ctypes.byref(crt))
1883
2360
        # Import the OpenPGP public key into the certificate
1884
 
        gnutls.library.functions.gnutls_openpgp_crt_import(
1885
 
            crt, ctypes.byref(datum),
1886
 
            gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
 
2361
        gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
 
2362
                                  gnutls.OPENPGP_FMT_RAW)
1887
2363
        # Verify the self signature in the key
1888
2364
        crtverify = ctypes.c_uint()
1889
 
        gnutls.library.functions.gnutls_openpgp_crt_verify_self(
1890
 
            crt, 0, ctypes.byref(crtverify))
 
2365
        gnutls.openpgp_crt_verify_self(crt, 0,
 
2366
                                       ctypes.byref(crtverify))
1891
2367
        if crtverify.value != 0:
1892
 
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1893
 
            raise gnutls.errors.CertificateSecurityError(
1894
 
                "Verify failed")
 
2368
            gnutls.openpgp_crt_deinit(crt)
 
2369
            raise gnutls.CertificateSecurityError("Verify failed")
1895
2370
        # New buffer for the fingerprint
1896
2371
        buf = ctypes.create_string_buffer(20)
1897
2372
        buf_len = ctypes.c_size_t()
1898
2373
        # Get the fingerprint from the certificate into the buffer
1899
 
        gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
1900
 
            crt, ctypes.byref(buf), ctypes.byref(buf_len))
 
2374
        gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
2375
                                           ctypes.byref(buf_len))
1901
2376
        # Deinit the certificate
1902
 
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
2377
        gnutls.openpgp_crt_deinit(crt)
1903
2378
        # Convert the buffer to a Python bytestring
1904
2379
        fpr = ctypes.string_at(buf, buf_len.value)
1905
2380
        # Convert the bytestring to hexadecimal notation
1909
2384
 
1910
2385
class MultiprocessingMixIn(object):
1911
2386
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
1912
 
    
 
2387
 
1913
2388
    def sub_process_main(self, request, address):
1914
2389
        try:
1915
2390
            self.finish_request(request, address)
1916
2391
        except Exception:
1917
2392
            self.handle_error(request, address)
1918
2393
        self.close_request(request)
1919
 
    
 
2394
 
1920
2395
    def process_request(self, request, address):
1921
2396
        """Start a new process to process the request."""
1922
 
        proc = multiprocessing.Process(target = self.sub_process_main,
1923
 
                                       args = (request, address))
 
2397
        proc = multiprocessing.Process(target=self.sub_process_main,
 
2398
                                       args=(request, address))
1924
2399
        proc.start()
1925
2400
        return proc
1926
2401
 
1927
2402
 
1928
2403
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1929
2404
    """ adds a pipe to the MixIn """
1930
 
    
 
2405
 
1931
2406
    def process_request(self, request, client_address):
1932
2407
        """Overrides and wraps the original process_request().
1933
 
        
 
2408
 
1934
2409
        This function creates a new pipe in self.pipe
1935
2410
        """
1936
2411
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
1937
 
        
 
2412
 
1938
2413
        proc = MultiprocessingMixIn.process_request(self, request,
1939
2414
                                                    client_address)
1940
2415
        self.child_pipe.close()
1941
2416
        self.add_pipe(parent_pipe, proc)
1942
 
    
 
2417
 
1943
2418
    def add_pipe(self, parent_pipe, proc):
1944
2419
        """Dummy function; override as necessary"""
1945
2420
        raise NotImplementedError()
1948
2423
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1949
2424
                     socketserver.TCPServer, object):
1950
2425
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
1951
 
    
 
2426
 
1952
2427
    Attributes:
1953
2428
        enabled:        Boolean; whether this server is activated yet
1954
2429
        interface:      None or a network interface name (string)
1955
2430
        use_ipv6:       Boolean; to use IPv6 or not
1956
2431
    """
1957
 
    
 
2432
 
1958
2433
    def __init__(self, server_address, RequestHandlerClass,
1959
2434
                 interface=None,
1960
2435
                 use_ipv6=True,
1970
2445
            self.socketfd = socketfd
1971
2446
            # Save the original socket.socket() function
1972
2447
            self.socket_socket = socket.socket
 
2448
 
1973
2449
            # To implement --socket, we monkey patch socket.socket.
1974
 
            # 
 
2450
            #
1975
2451
            # (When socketserver.TCPServer is a new-style class, we
1976
2452
            # could make self.socket into a property instead of monkey
1977
2453
            # patching socket.socket.)
1978
 
            # 
 
2454
            #
1979
2455
            # Create a one-time-only replacement for socket.socket()
1980
2456
            @functools.wraps(socket.socket)
1981
2457
            def socket_wrapper(*args, **kwargs):
1993
2469
        # socket_wrapper(), if socketfd was set.
1994
2470
        socketserver.TCPServer.__init__(self, server_address,
1995
2471
                                        RequestHandlerClass)
1996
 
    
 
2472
 
1997
2473
    def server_bind(self):
1998
2474
        """This overrides the normal server_bind() function
1999
2475
        to bind to an interface if one was specified, and also NOT to
2000
2476
        bind to an address or port if they were not specified."""
 
2477
        global SO_BINDTODEVICE
2001
2478
        if self.interface is not None:
2002
2479
            if SO_BINDTODEVICE is None:
2003
 
                logger.error("SO_BINDTODEVICE does not exist;"
2004
 
                             " cannot bind to interface %s",
2005
 
                             self.interface)
2006
 
            else:
2007
 
                try:
2008
 
                    self.socket.setsockopt(
2009
 
                        socket.SOL_SOCKET, SO_BINDTODEVICE,
2010
 
                        (self.interface + "\0").encode("utf-8"))
2011
 
                except socket.error as error:
2012
 
                    if error.errno == errno.EPERM:
2013
 
                        logger.error("No permission to bind to"
2014
 
                                     " interface %s", self.interface)
2015
 
                    elif error.errno == errno.ENOPROTOOPT:
2016
 
                        logger.error("SO_BINDTODEVICE not available;"
2017
 
                                     " cannot bind to interface %s",
2018
 
                                     self.interface)
2019
 
                    elif error.errno == errno.ENODEV:
2020
 
                        logger.error("Interface %s does not exist,"
2021
 
                                     " cannot bind", self.interface)
2022
 
                    else:
2023
 
                        raise
 
2480
                # Fall back to a hard-coded value which seems to be
 
2481
                # common enough.
 
2482
                logger.warning("SO_BINDTODEVICE not found, trying 25")
 
2483
                SO_BINDTODEVICE = 25
 
2484
            try:
 
2485
                self.socket.setsockopt(
 
2486
                    socket.SOL_SOCKET, SO_BINDTODEVICE,
 
2487
                    (self.interface + "\0").encode("utf-8"))
 
2488
            except socket.error as error:
 
2489
                if error.errno == errno.EPERM:
 
2490
                    logger.error("No permission to bind to"
 
2491
                                 " interface %s", self.interface)
 
2492
                elif error.errno == errno.ENOPROTOOPT:
 
2493
                    logger.error("SO_BINDTODEVICE not available;"
 
2494
                                 " cannot bind to interface %s",
 
2495
                                 self.interface)
 
2496
                elif error.errno == errno.ENODEV:
 
2497
                    logger.error("Interface %s does not exist,"
 
2498
                                 " cannot bind", self.interface)
 
2499
                else:
 
2500
                    raise
2024
2501
        # Only bind(2) the socket if we really need to.
2025
2502
        if self.server_address[0] or self.server_address[1]:
2026
2503
            if not self.server_address[0]:
2027
2504
                if self.address_family == socket.AF_INET6:
2028
 
                    any_address = "::" # in6addr_any
 
2505
                    any_address = "::"  # in6addr_any
2029
2506
                else:
2030
 
                    any_address = "0.0.0.0" # INADDR_ANY
 
2507
                    any_address = "0.0.0.0"  # INADDR_ANY
2031
2508
                self.server_address = (any_address,
2032
2509
                                       self.server_address[1])
2033
2510
            elif not self.server_address[1]:
2043
2520
 
2044
2521
class MandosServer(IPv6_TCPServer):
2045
2522
    """Mandos server.
2046
 
    
 
2523
 
2047
2524
    Attributes:
2048
2525
        clients:        set of Client objects
2049
2526
        gnutls_priority GnuTLS priority string
2050
2527
        use_dbus:       Boolean; to emit D-Bus signals or not
2051
 
    
2052
 
    Assumes a gobject.MainLoop event loop.
 
2528
 
 
2529
    Assumes a GLib.MainLoop event loop.
2053
2530
    """
2054
 
    
 
2531
 
2055
2532
    def __init__(self, server_address, RequestHandlerClass,
2056
2533
                 interface=None,
2057
2534
                 use_ipv6=True,
2067
2544
        self.gnutls_priority = gnutls_priority
2068
2545
        IPv6_TCPServer.__init__(self, server_address,
2069
2546
                                RequestHandlerClass,
2070
 
                                interface = interface,
2071
 
                                use_ipv6 = use_ipv6,
2072
 
                                socketfd = socketfd)
2073
 
    
 
2547
                                interface=interface,
 
2548
                                use_ipv6=use_ipv6,
 
2549
                                socketfd=socketfd)
 
2550
 
2074
2551
    def server_activate(self):
2075
2552
        if self.enabled:
2076
2553
            return socketserver.TCPServer.server_activate(self)
2077
 
    
 
2554
 
2078
2555
    def enable(self):
2079
2556
        self.enabled = True
2080
 
    
 
2557
 
2081
2558
    def add_pipe(self, parent_pipe, proc):
2082
2559
        # Call "handle_ipc" for both data and EOF events
2083
 
        gobject.io_add_watch(
 
2560
        GLib.io_add_watch(
2084
2561
            parent_pipe.fileno(),
2085
 
            gobject.IO_IN | gobject.IO_HUP,
 
2562
            GLib.IO_IN | GLib.IO_HUP,
2086
2563
            functools.partial(self.handle_ipc,
2087
 
                              parent_pipe = parent_pipe,
2088
 
                              proc = proc))
2089
 
    
 
2564
                              parent_pipe=parent_pipe,
 
2565
                              proc=proc))
 
2566
 
2090
2567
    def handle_ipc(self, source, condition,
2091
2568
                   parent_pipe=None,
2092
 
                   proc = None,
 
2569
                   proc=None,
2093
2570
                   client_object=None):
2094
2571
        # error, or the other end of multiprocessing.Pipe has closed
2095
 
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
 
2572
        if condition & (GLib.IO_ERR | GLib.IO_HUP):
2096
2573
            # Wait for other process to exit
2097
2574
            proc.join()
2098
2575
            return False
2099
 
        
 
2576
 
2100
2577
        # Read a request from the child
2101
2578
        request = parent_pipe.recv()
2102
2579
        command = request[0]
2103
 
        
 
2580
 
2104
2581
        if command == 'init':
2105
 
            fpr = request[1]
 
2582
            fpr = request[1].decode("ascii")
2106
2583
            address = request[2]
2107
 
            
2108
 
            for c in self.clients.itervalues():
 
2584
 
 
2585
            for c in self.clients.values():
2109
2586
                if c.fingerprint == fpr:
2110
2587
                    client = c
2111
2588
                    break
2118
2595
                                                       address[0])
2119
2596
                parent_pipe.send(False)
2120
2597
                return False
2121
 
            
2122
 
            gobject.io_add_watch(
 
2598
 
 
2599
            GLib.io_add_watch(
2123
2600
                parent_pipe.fileno(),
2124
 
                gobject.IO_IN | gobject.IO_HUP,
 
2601
                GLib.IO_IN | GLib.IO_HUP,
2125
2602
                functools.partial(self.handle_ipc,
2126
 
                                  parent_pipe = parent_pipe,
2127
 
                                  proc = proc,
2128
 
                                  client_object = client))
 
2603
                                  parent_pipe=parent_pipe,
 
2604
                                  proc=proc,
 
2605
                                  client_object=client))
2129
2606
            parent_pipe.send(True)
2130
2607
            # remove the old hook in favor of the new above hook on
2131
2608
            # same fileno
2134
2611
            funcname = request[1]
2135
2612
            args = request[2]
2136
2613
            kwargs = request[3]
2137
 
            
 
2614
 
2138
2615
            parent_pipe.send(('data', getattr(client_object,
2139
2616
                                              funcname)(*args,
2140
2617
                                                        **kwargs)))
2141
 
        
 
2618
 
2142
2619
        if command == 'getattr':
2143
2620
            attrname = request[1]
2144
 
            if callable(client_object.__getattribute__(attrname)):
 
2621
            if isinstance(client_object.__getattribute__(attrname),
 
2622
                          collections.Callable):
2145
2623
                parent_pipe.send(('function', ))
2146
2624
            else:
2147
2625
                parent_pipe.send((
2148
2626
                    'data', client_object.__getattribute__(attrname)))
2149
 
        
 
2627
 
2150
2628
        if command == 'setattr':
2151
2629
            attrname = request[1]
2152
2630
            value = request[2]
2153
2631
            setattr(client_object, attrname, value)
2154
 
        
 
2632
 
2155
2633
        return True
2156
2634
 
2157
2635
 
2158
2636
def rfc3339_duration_to_delta(duration):
2159
2637
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2160
 
    
 
2638
 
2161
2639
    >>> rfc3339_duration_to_delta("P7D")
2162
2640
    datetime.timedelta(7)
2163
2641
    >>> rfc3339_duration_to_delta("PT60S")
2173
2651
    >>> rfc3339_duration_to_delta("P1DT3M20S")
2174
2652
    datetime.timedelta(1, 200)
2175
2653
    """
2176
 
    
 
2654
 
2177
2655
    # Parsing an RFC 3339 duration with regular expressions is not
2178
2656
    # possible - there would have to be multiple places for the same
2179
2657
    # values, like seconds.  The current code, while more esoteric, is
2180
2658
    # cleaner without depending on a parsing library.  If Python had a
2181
2659
    # built-in library for parsing we would use it, but we'd like to
2182
2660
    # avoid excessive use of external libraries.
2183
 
    
 
2661
 
2184
2662
    # New type for defining tokens, syntax, and semantics all-in-one
2185
 
    Token = collections.namedtuple("Token",
2186
 
                                   ("regexp", # To match token; if
2187
 
                                              # "value" is not None,
2188
 
                                              # must have a "group"
2189
 
                                              # containing digits
2190
 
                                    "value",  # datetime.timedelta or
2191
 
                                              # None
2192
 
                                    "followers")) # Tokens valid after
2193
 
                                                  # this token
2194
2663
    Token = collections.namedtuple("Token", (
2195
2664
        "regexp",  # To match token; if "value" is not None, must have
2196
2665
                   # a "group" containing digits
2228
2697
                           frozenset((token_year, token_month,
2229
2698
                                      token_day, token_time,
2230
2699
                                      token_week)))
2231
 
    # Define starting values
2232
 
    value = datetime.timedelta() # Value so far
 
2700
    # Define starting values:
 
2701
    # Value so far
 
2702
    value = datetime.timedelta()
2233
2703
    found_token = None
2234
 
    followers = frozenset((token_duration,)) # Following valid tokens
2235
 
    s = duration                # String left to parse
 
2704
    # Following valid tokens
 
2705
    followers = frozenset((token_duration, ))
 
2706
    # String left to parse
 
2707
    s = duration
2236
2708
    # Loop until end token is found
2237
2709
    while found_token is not token_end:
2238
2710
        # Search for any currently valid tokens
2254
2726
                break
2255
2727
        else:
2256
2728
            # No currently valid tokens were found
2257
 
            raise ValueError("Invalid RFC 3339 duration")
 
2729
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
2730
                             .format(duration))
2258
2731
    # End token found
2259
2732
    return value
2260
2733
 
2261
2734
 
2262
2735
def string_to_delta(interval):
2263
2736
    """Parse a string and return a datetime.timedelta
2264
 
    
 
2737
 
2265
2738
    >>> string_to_delta('7d')
2266
2739
    datetime.timedelta(7)
2267
2740
    >>> string_to_delta('60s')
2275
2748
    >>> string_to_delta('5m 30s')
2276
2749
    datetime.timedelta(0, 330)
2277
2750
    """
2278
 
    
 
2751
 
2279
2752
    try:
2280
2753
        return rfc3339_duration_to_delta(interval)
2281
2754
    except ValueError:
2282
2755
        pass
2283
 
    
 
2756
 
2284
2757
    timevalue = datetime.timedelta(0)
2285
2758
    for s in interval.split():
2286
2759
        try:
2304
2777
    return timevalue
2305
2778
 
2306
2779
 
2307
 
def daemon(nochdir = False, noclose = False):
 
2780
def daemon(nochdir=False, noclose=False):
2308
2781
    """See daemon(3).  Standard BSD Unix function.
2309
 
    
 
2782
 
2310
2783
    This should really exist as os.daemon, but it doesn't (yet)."""
2311
2784
    if os.fork():
2312
2785
        sys.exit()
2330
2803
 
2331
2804
 
2332
2805
def main():
2333
 
    
 
2806
 
2334
2807
    ##################################################################
2335
2808
    # Parsing of options, both command line and config file
2336
 
    
 
2809
 
2337
2810
    parser = argparse.ArgumentParser()
2338
2811
    parser.add_argument("-v", "--version", action="version",
2339
 
                        version = "%(prog)s {}".format(version),
 
2812
                        version="%(prog)s {}".format(version),
2340
2813
                        help="show version number and exit")
2341
2814
    parser.add_argument("-i", "--interface", metavar="IF",
2342
2815
                        help="Bind to interface IF")
2378
2851
    parser.add_argument("--no-zeroconf", action="store_false",
2379
2852
                        dest="zeroconf", help="Do not use Zeroconf",
2380
2853
                        default=None)
2381
 
    
 
2854
 
2382
2855
    options = parser.parse_args()
2383
 
    
 
2856
 
2384
2857
    if options.check:
2385
2858
        import doctest
2386
2859
        fail_count, test_count = doctest.testmod()
2387
2860
        sys.exit(os.EX_OK if fail_count == 0 else 1)
2388
 
    
 
2861
 
2389
2862
    # Default values for config file for server-global settings
2390
 
    server_defaults = { "interface": "",
2391
 
                        "address": "",
2392
 
                        "port": "",
2393
 
                        "debug": "False",
2394
 
                        "priority":
2395
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2396
 
                        ":+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
2397
 
                        "servicename": "Mandos",
2398
 
                        "use_dbus": "True",
2399
 
                        "use_ipv6": "True",
2400
 
                        "debuglevel": "",
2401
 
                        "restore": "True",
2402
 
                        "socket": "",
2403
 
                        "statedir": "/var/lib/mandos",
2404
 
                        "foreground": "False",
2405
 
                        "zeroconf": "True",
2406
 
                    }
2407
 
    
 
2863
    server_defaults = {"interface": "",
 
2864
                       "address": "",
 
2865
                       "port": "",
 
2866
                       "debug": "False",
 
2867
                       "priority":
 
2868
                       "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
 
2869
                       ":+SIGN-DSA-SHA256",
 
2870
                       "servicename": "Mandos",
 
2871
                       "use_dbus": "True",
 
2872
                       "use_ipv6": "True",
 
2873
                       "debuglevel": "",
 
2874
                       "restore": "True",
 
2875
                       "socket": "",
 
2876
                       "statedir": "/var/lib/mandos",
 
2877
                       "foreground": "False",
 
2878
                       "zeroconf": "True",
 
2879
                       }
 
2880
 
2408
2881
    # Parse config file for server-global settings
2409
2882
    server_config = configparser.SafeConfigParser(server_defaults)
2410
2883
    del server_defaults
2412
2885
    # Convert the SafeConfigParser object to a dict
2413
2886
    server_settings = server_config.defaults()
2414
2887
    # Use the appropriate methods on the non-string config options
2415
 
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
 
2888
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
2889
                   "foreground", "zeroconf"):
2416
2890
        server_settings[option] = server_config.getboolean("DEFAULT",
2417
2891
                                                           option)
2418
2892
    if server_settings["port"]:
2428
2902
            server_settings["socket"] = os.dup(server_settings
2429
2903
                                               ["socket"])
2430
2904
    del server_config
2431
 
    
 
2905
 
2432
2906
    # Override the settings from the config file with command line
2433
2907
    # options, if set.
2434
2908
    for option in ("interface", "address", "port", "debug",
2452
2926
    if server_settings["debug"]:
2453
2927
        server_settings["foreground"] = True
2454
2928
    # Now we have our good server settings in "server_settings"
2455
 
    
 
2929
 
2456
2930
    ##################################################################
2457
 
    
 
2931
 
2458
2932
    if (not server_settings["zeroconf"]
2459
2933
        and not (server_settings["port"]
2460
2934
                 or server_settings["socket"] != "")):
2461
2935
        parser.error("Needs port or socket to work without Zeroconf")
2462
 
    
 
2936
 
2463
2937
    # For convenience
2464
2938
    debug = server_settings["debug"]
2465
2939
    debuglevel = server_settings["debuglevel"]
2469
2943
                                     stored_state_file)
2470
2944
    foreground = server_settings["foreground"]
2471
2945
    zeroconf = server_settings["zeroconf"]
2472
 
    
 
2946
 
2473
2947
    if debug:
2474
2948
        initlogger(debug, logging.DEBUG)
2475
2949
    else:
2478
2952
        else:
2479
2953
            level = getattr(logging, debuglevel.upper())
2480
2954
            initlogger(debug, level)
2481
 
    
 
2955
 
2482
2956
    if server_settings["servicename"] != "Mandos":
2483
2957
        syslogger.setFormatter(
2484
2958
            logging.Formatter('Mandos ({}) [%(process)d]:'
2485
2959
                              ' %(levelname)s: %(message)s'.format(
2486
2960
                                  server_settings["servicename"])))
2487
 
    
 
2961
 
2488
2962
    # Parse config file with clients
2489
2963
    client_config = configparser.SafeConfigParser(Client
2490
2964
                                                  .client_defaults)
2491
2965
    client_config.read(os.path.join(server_settings["configdir"],
2492
2966
                                    "clients.conf"))
2493
 
    
 
2967
 
2494
2968
    global mandos_dbus_service
2495
2969
    mandos_dbus_service = None
2496
 
    
 
2970
 
2497
2971
    socketfd = None
2498
2972
    if server_settings["socket"] != "":
2499
2973
        socketfd = server_settings["socket"]
2515
2989
        except IOError as e:
2516
2990
            logger.error("Could not open file %r", pidfilename,
2517
2991
                         exc_info=e)
2518
 
    
2519
 
    for name in ("_mandos", "mandos", "nobody"):
 
2992
 
 
2993
    for name, group in (("_mandos", "_mandos"),
 
2994
                        ("mandos", "mandos"),
 
2995
                        ("nobody", "nogroup")):
2520
2996
        try:
2521
2997
            uid = pwd.getpwnam(name).pw_uid
2522
 
            gid = pwd.getpwnam(name).pw_gid
 
2998
            gid = pwd.getpwnam(group).pw_gid
2523
2999
            break
2524
3000
        except KeyError:
2525
3001
            continue
2529
3005
    try:
2530
3006
        os.setgid(gid)
2531
3007
        os.setuid(uid)
 
3008
        if debug:
 
3009
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
 
3010
                                                             gid))
2532
3011
    except OSError as error:
 
3012
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
 
3013
                       .format(uid, gid, os.strerror(error.errno)))
2533
3014
        if error.errno != errno.EPERM:
2534
3015
            raise
2535
 
    
 
3016
 
2536
3017
    if debug:
2537
3018
        # Enable all possible GnuTLS debugging
2538
 
        
 
3019
 
2539
3020
        # "Use a log level over 10 to enable all debugging options."
2540
3021
        # - GnuTLS manual
2541
 
        gnutls.library.functions.gnutls_global_set_log_level(11)
2542
 
        
2543
 
        @gnutls.library.types.gnutls_log_func
 
3022
        gnutls.global_set_log_level(11)
 
3023
 
 
3024
        @gnutls.log_func
2544
3025
        def debug_gnutls(level, string):
2545
3026
            logger.debug("GnuTLS: %s", string[:-1])
2546
 
        
2547
 
        gnutls.library.functions.gnutls_global_set_log_function(
2548
 
            debug_gnutls)
2549
 
        
 
3027
 
 
3028
        gnutls.global_set_log_function(debug_gnutls)
 
3029
 
2550
3030
        # Redirect stdin so all checkers get /dev/null
2551
3031
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2552
3032
        os.dup2(null, sys.stdin.fileno())
2553
3033
        if null > 2:
2554
3034
            os.close(null)
2555
 
    
 
3035
 
2556
3036
    # Need to fork before connecting to D-Bus
2557
3037
    if not foreground:
2558
3038
        # Close all input and output, do double fork, etc.
2559
3039
        daemon()
2560
 
    
2561
 
    # multiprocessing will use threads, so before we use gobject we
2562
 
    # need to inform gobject that threads will be used.
2563
 
    gobject.threads_init()
2564
 
    
 
3040
 
 
3041
    # multiprocessing will use threads, so before we use GLib we need
 
3042
    # to inform GLib that threads will be used.
 
3043
    GLib.threads_init()
 
3044
 
2565
3045
    global main_loop
2566
3046
    # From the Avahi example code
2567
3047
    DBusGMainLoop(set_as_default=True)
2568
 
    main_loop = gobject.MainLoop()
 
3048
    main_loop = GLib.MainLoop()
2569
3049
    bus = dbus.SystemBus()
2570
3050
    # End of Avahi example code
2571
3051
    if use_dbus:
2584
3064
    if zeroconf:
2585
3065
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2586
3066
        service = AvahiServiceToSyslog(
2587
 
            name = server_settings["servicename"],
2588
 
            servicetype = "_mandos._tcp",
2589
 
            protocol = protocol,
2590
 
            bus = bus)
 
3067
            name=server_settings["servicename"],
 
3068
            servicetype="_mandos._tcp",
 
3069
            protocol=protocol,
 
3070
            bus=bus)
2591
3071
        if server_settings["interface"]:
2592
3072
            service.interface = if_nametoindex(
2593
3073
                server_settings["interface"].encode("utf-8"))
2594
 
    
 
3074
 
2595
3075
    global multiprocessing_manager
2596
3076
    multiprocessing_manager = multiprocessing.Manager()
2597
 
    
 
3077
 
2598
3078
    client_class = Client
2599
3079
    if use_dbus:
2600
 
        client_class = functools.partial(ClientDBus, bus = bus)
2601
 
    
 
3080
        client_class = functools.partial(ClientDBus, bus=bus)
 
3081
 
2602
3082
    client_settings = Client.config_parser(client_config)
2603
3083
    old_client_settings = {}
2604
3084
    clients_data = {}
2605
 
    
 
3085
 
2606
3086
    # This is used to redirect stdout and stderr for checker processes
2607
3087
    global wnull
2608
 
    wnull = open(os.devnull, "w") # A writable /dev/null
 
3088
    wnull = open(os.devnull, "w")  # A writable /dev/null
2609
3089
    # Only used if server is running in foreground but not in debug
2610
3090
    # mode
2611
3091
    if debug or not foreground:
2612
3092
        wnull.close()
2613
 
    
 
3093
 
2614
3094
    # Get client data and settings from last running state.
2615
3095
    if server_settings["restore"]:
2616
3096
        try:
2617
3097
            with open(stored_state_path, "rb") as stored_state:
2618
 
                clients_data, old_client_settings = pickle.load(
2619
 
                    stored_state)
 
3098
                if sys.version_info.major == 2:
 
3099
                    clients_data, old_client_settings = pickle.load(
 
3100
                        stored_state)
 
3101
                else:
 
3102
                    bytes_clients_data, bytes_old_client_settings = (
 
3103
                        pickle.load(stored_state, encoding="bytes"))
 
3104
                    #   Fix bytes to strings
 
3105
                    #  clients_data
 
3106
                    # .keys()
 
3107
                    clients_data = {(key.decode("utf-8")
 
3108
                                     if isinstance(key, bytes)
 
3109
                                     else key): value
 
3110
                                    for key, value in
 
3111
                                    bytes_clients_data.items()}
 
3112
                    del bytes_clients_data
 
3113
                    for key in clients_data:
 
3114
                        value = {(k.decode("utf-8")
 
3115
                                  if isinstance(k, bytes) else k): v
 
3116
                                 for k, v in
 
3117
                                 clients_data[key].items()}
 
3118
                        clients_data[key] = value
 
3119
                        # .client_structure
 
3120
                        value["client_structure"] = [
 
3121
                            (s.decode("utf-8")
 
3122
                             if isinstance(s, bytes)
 
3123
                             else s) for s in
 
3124
                            value["client_structure"]]
 
3125
                        # .name & .host
 
3126
                        for k in ("name", "host"):
 
3127
                            if isinstance(value[k], bytes):
 
3128
                                value[k] = value[k].decode("utf-8")
 
3129
                    #  old_client_settings
 
3130
                    # .keys()
 
3131
                    old_client_settings = {
 
3132
                        (key.decode("utf-8")
 
3133
                         if isinstance(key, bytes)
 
3134
                         else key): value
 
3135
                        for key, value in
 
3136
                        bytes_old_client_settings.items()}
 
3137
                    del bytes_old_client_settings
 
3138
                    # .host
 
3139
                    for value in old_client_settings.values():
 
3140
                        if isinstance(value["host"], bytes):
 
3141
                            value["host"] = (value["host"]
 
3142
                                             .decode("utf-8"))
2620
3143
            os.remove(stored_state_path)
2621
3144
        except IOError as e:
2622
3145
            if e.errno == errno.ENOENT:
2630
3153
            logger.warning("Could not load persistent state: "
2631
3154
                           "EOFError:",
2632
3155
                           exc_info=e)
2633
 
    
 
3156
 
2634
3157
    with PGPEngine() as pgp:
2635
3158
        for client_name, client in clients_data.items():
2636
3159
            # Skip removed clients
2637
3160
            if client_name not in client_settings:
2638
3161
                continue
2639
 
            
 
3162
 
2640
3163
            # Decide which value to use after restoring saved state.
2641
3164
            # We have three different values: Old config file,
2642
3165
            # new config file, and saved state.
2653
3176
                        client[name] = value
2654
3177
                except KeyError:
2655
3178
                    pass
2656
 
            
 
3179
 
2657
3180
            # Clients who has passed its expire date can still be
2658
 
            # enabled if its last checker was successful.  Clients
 
3181
            # enabled if its last checker was successful.  A Client
2659
3182
            # whose checker succeeded before we stored its state is
2660
3183
            # assumed to have successfully run all checkers during
2661
3184
            # downtime.
2692
3215
                    client_name))
2693
3216
                client["secret"] = (client_settings[client_name]
2694
3217
                                    ["secret"])
2695
 
    
 
3218
 
2696
3219
    # Add/remove clients based on new changes made to config
2697
3220
    for client_name in (set(old_client_settings)
2698
3221
                        - set(client_settings)):
2700
3223
    for client_name in (set(client_settings)
2701
3224
                        - set(old_client_settings)):
2702
3225
        clients_data[client_name] = client_settings[client_name]
2703
 
    
 
3226
 
2704
3227
    # Create all client objects
2705
3228
    for client_name, client in clients_data.items():
2706
3229
        tcp_server.clients[client_name] = client_class(
2707
 
            name = client_name,
2708
 
            settings = client,
2709
 
            server_settings = server_settings)
2710
 
    
 
3230
            name=client_name,
 
3231
            settings=client,
 
3232
            server_settings=server_settings)
 
3233
 
2711
3234
    if not tcp_server.clients:
2712
3235
        logger.warning("No clients defined")
2713
 
    
 
3236
 
2714
3237
    if not foreground:
2715
3238
        if pidfile is not None:
2716
3239
            pid = os.getpid()
2722
3245
                             pidfilename, pid)
2723
3246
        del pidfile
2724
3247
        del pidfilename
2725
 
    
2726
 
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2727
 
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2728
 
    
 
3248
 
 
3249
    for termsig in (signal.SIGHUP, signal.SIGTERM):
 
3250
        GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
 
3251
                             lambda: main_loop.quit() and False)
 
3252
 
2729
3253
    if use_dbus:
2730
 
        
 
3254
 
2731
3255
        @alternate_dbus_interfaces(
2732
 
            { "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
2733
 
        class MandosDBusService(DBusObjectWithProperties):
 
3256
            {"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
 
3257
        class MandosDBusService(DBusObjectWithObjectManager):
2734
3258
            """A D-Bus proxy object"""
2735
 
            
 
3259
 
2736
3260
            def __init__(self):
2737
3261
                dbus.service.Object.__init__(self, bus, "/")
2738
 
            
 
3262
 
2739
3263
            _interface = "se.recompile.Mandos"
2740
 
            
2741
 
            @dbus_interface_annotations(_interface)
2742
 
            def _foo(self):
2743
 
                return {
2744
 
                    "org.freedesktop.DBus.Property.EmitsChangedSignal":
2745
 
                    "false" }
2746
 
            
 
3264
 
2747
3265
            @dbus.service.signal(_interface, signature="o")
2748
3266
            def ClientAdded(self, objpath):
2749
3267
                "D-Bus signal"
2750
3268
                pass
2751
 
            
 
3269
 
2752
3270
            @dbus.service.signal(_interface, signature="ss")
2753
3271
            def ClientNotFound(self, fingerprint, address):
2754
3272
                "D-Bus signal"
2755
3273
                pass
2756
 
            
 
3274
 
 
3275
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3276
                               "true"})
2757
3277
            @dbus.service.signal(_interface, signature="os")
2758
3278
            def ClientRemoved(self, objpath, name):
2759
3279
                "D-Bus signal"
2760
3280
                pass
2761
 
            
 
3281
 
 
3282
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3283
                               "true"})
2762
3284
            @dbus.service.method(_interface, out_signature="ao")
2763
3285
            def GetAllClients(self):
2764
3286
                "D-Bus method"
2765
3287
                return dbus.Array(c.dbus_object_path for c in
2766
 
                                  tcp_server.clients.itervalues())
2767
 
            
 
3288
                                  tcp_server.clients.values())
 
3289
 
 
3290
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3291
                               "true"})
2768
3292
            @dbus.service.method(_interface,
2769
3293
                                 out_signature="a{oa{sv}}")
2770
3294
            def GetAllClientsWithProperties(self):
2771
3295
                "D-Bus method"
2772
3296
                return dbus.Dictionary(
2773
 
                    { c.dbus_object_path: c.GetAll("")
2774
 
                      for c in tcp_server.clients.itervalues() },
 
3297
                    {c.dbus_object_path: c.GetAll(
 
3298
                        "se.recompile.Mandos.Client")
 
3299
                     for c in tcp_server.clients.values()},
2775
3300
                    signature="oa{sv}")
2776
 
            
 
3301
 
2777
3302
            @dbus.service.method(_interface, in_signature="o")
2778
3303
            def RemoveClient(self, object_path):
2779
3304
                "D-Bus method"
2780
 
                for c in tcp_server.clients.itervalues():
 
3305
                for c in tcp_server.clients.values():
2781
3306
                    if c.dbus_object_path == object_path:
2782
3307
                        del tcp_server.clients[c.name]
2783
3308
                        c.remove_from_connection()
2784
 
                        # Don't signal anything except ClientRemoved
 
3309
                        # Don't signal the disabling
2785
3310
                        c.disable(quiet=True)
2786
 
                        # Emit D-Bus signal
2787
 
                        self.ClientRemoved(object_path, c.name)
 
3311
                        # Emit D-Bus signal for removal
 
3312
                        self.client_removed_signal(c)
2788
3313
                        return
2789
3314
                raise KeyError(object_path)
2790
 
            
 
3315
 
2791
3316
            del _interface
2792
 
        
 
3317
 
 
3318
            @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
 
3319
                                 out_signature="a{oa{sa{sv}}}")
 
3320
            def GetManagedObjects(self):
 
3321
                """D-Bus method"""
 
3322
                return dbus.Dictionary(
 
3323
                    {client.dbus_object_path:
 
3324
                     dbus.Dictionary(
 
3325
                         {interface: client.GetAll(interface)
 
3326
                          for interface in
 
3327
                          client._get_all_interface_names()})
 
3328
                     for client in tcp_server.clients.values()})
 
3329
 
 
3330
            def client_added_signal(self, client):
 
3331
                """Send the new standard signal and the old signal"""
 
3332
                if use_dbus:
 
3333
                    # New standard signal
 
3334
                    self.InterfacesAdded(
 
3335
                        client.dbus_object_path,
 
3336
                        dbus.Dictionary(
 
3337
                            {interface: client.GetAll(interface)
 
3338
                             for interface in
 
3339
                             client._get_all_interface_names()}))
 
3340
                    # Old signal
 
3341
                    self.ClientAdded(client.dbus_object_path)
 
3342
 
 
3343
            def client_removed_signal(self, client):
 
3344
                """Send the new standard signal and the old signal"""
 
3345
                if use_dbus:
 
3346
                    # New standard signal
 
3347
                    self.InterfacesRemoved(
 
3348
                        client.dbus_object_path,
 
3349
                        client._get_all_interface_names())
 
3350
                    # Old signal
 
3351
                    self.ClientRemoved(client.dbus_object_path,
 
3352
                                       client.name)
 
3353
 
2793
3354
        mandos_dbus_service = MandosDBusService()
2794
 
    
 
3355
 
 
3356
    # Save modules to variables to exempt the modules from being
 
3357
    # unloaded before the function registered with atexit() is run.
 
3358
    mp = multiprocessing
 
3359
    wn = wnull
 
3360
 
2795
3361
    def cleanup():
2796
3362
        "Cleanup function; run on exit"
2797
3363
        if zeroconf:
2798
3364
            service.cleanup()
2799
 
        
2800
 
        multiprocessing.active_children()
2801
 
        wnull.close()
 
3365
 
 
3366
        mp.active_children()
 
3367
        wn.close()
2802
3368
        if not (tcp_server.clients or client_settings):
2803
3369
            return
2804
 
        
 
3370
 
2805
3371
        # Store client before exiting. Secrets are encrypted with key
2806
3372
        # based on what config file has. If config file is
2807
3373
        # removed/edited, old secret will thus be unrecovable.
2808
3374
        clients = {}
2809
3375
        with PGPEngine() as pgp:
2810
 
            for client in tcp_server.clients.itervalues():
 
3376
            for client in tcp_server.clients.values():
2811
3377
                key = client_settings[client.name]["secret"]
2812
3378
                client.encrypted_secret = pgp.encrypt(client.secret,
2813
3379
                                                      key)
2814
3380
                client_dict = {}
2815
 
                
 
3381
 
2816
3382
                # A list of attributes that can not be pickled
2817
3383
                # + secret.
2818
 
                exclude = { "bus", "changedstate", "secret",
2819
 
                            "checker", "server_settings" }
 
3384
                exclude = {"bus", "changedstate", "secret",
 
3385
                           "checker", "server_settings"}
2820
3386
                for name, typ in inspect.getmembers(dbus.service
2821
3387
                                                    .Object):
2822
3388
                    exclude.add(name)
2823
 
                
 
3389
 
2824
3390
                client_dict["encrypted_secret"] = (client
2825
3391
                                                   .encrypted_secret)
2826
3392
                for attr in client.client_structure:
2827
3393
                    if attr not in exclude:
2828
3394
                        client_dict[attr] = getattr(client, attr)
2829
 
                
 
3395
 
2830
3396
                clients[client.name] = client_dict
2831
3397
                del client_settings[client.name]["secret"]
2832
 
        
 
3398
 
2833
3399
        try:
2834
3400
            with tempfile.NamedTemporaryFile(
2835
3401
                    mode='wb',
2837
3403
                    prefix='clients-',
2838
3404
                    dir=os.path.dirname(stored_state_path),
2839
3405
                    delete=False) as stored_state:
2840
 
                pickle.dump((clients, client_settings), stored_state)
 
3406
                pickle.dump((clients, client_settings), stored_state,
 
3407
                            protocol=2)
2841
3408
                tempname = stored_state.name
2842
3409
            os.rename(tempname, stored_state_path)
2843
3410
        except (IOError, OSError) as e:
2853
3420
                logger.warning("Could not save persistent state:",
2854
3421
                               exc_info=e)
2855
3422
                raise
2856
 
        
 
3423
 
2857
3424
        # Delete all clients, and settings from config
2858
3425
        while tcp_server.clients:
2859
3426
            name, client = tcp_server.clients.popitem()
2860
3427
            if use_dbus:
2861
3428
                client.remove_from_connection()
2862
 
            # Don't signal anything except ClientRemoved
 
3429
            # Don't signal the disabling
2863
3430
            client.disable(quiet=True)
 
3431
            # Emit D-Bus signal for removal
2864
3432
            if use_dbus:
2865
 
                # Emit D-Bus signal
2866
 
                mandos_dbus_service.ClientRemoved(
2867
 
                    client.dbus_object_path, client.name)
 
3433
                mandos_dbus_service.client_removed_signal(client)
2868
3434
        client_settings.clear()
2869
 
    
 
3435
 
2870
3436
    atexit.register(cleanup)
2871
 
    
2872
 
    for client in tcp_server.clients.itervalues():
 
3437
 
 
3438
    for client in tcp_server.clients.values():
2873
3439
        if use_dbus:
2874
 
            # Emit D-Bus signal
2875
 
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
 
3440
            # Emit D-Bus signal for adding
 
3441
            mandos_dbus_service.client_added_signal(client)
2876
3442
        # Need to initiate checking of clients
2877
3443
        if client.enabled:
2878
3444
            client.init_checker()
2879
 
    
 
3445
 
2880
3446
    tcp_server.enable()
2881
3447
    tcp_server.server_activate()
2882
 
    
 
3448
 
2883
3449
    # Find out what port we got
2884
3450
    if zeroconf:
2885
3451
        service.port = tcp_server.socket.getsockname()[1]
2890
3456
    else:                       # IPv4
2891
3457
        logger.info("Now listening on address %r, port %d",
2892
3458
                    *tcp_server.socket.getsockname())
2893
 
    
2894
 
    #service.interface = tcp_server.socket.getsockname()[3]
2895
 
    
 
3459
 
 
3460
    # service.interface = tcp_server.socket.getsockname()[3]
 
3461
 
2896
3462
    try:
2897
3463
        if zeroconf:
2898
3464
            # From the Avahi example code
2903
3469
                cleanup()
2904
3470
                sys.exit(1)
2905
3471
            # End of Avahi example code
2906
 
        
2907
 
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2908
 
                             lambda *args, **kwargs:
2909
 
                             (tcp_server.handle_request
2910
 
                              (*args[2:], **kwargs) or True))
2911
 
        
 
3472
 
 
3473
        GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
 
3474
                          lambda *args, **kwargs:
 
3475
                          (tcp_server.handle_request
 
3476
                           (*args[2:], **kwargs) or True))
 
3477
 
2912
3478
        logger.debug("Starting main loop")
2913
3479
        main_loop.run()
2914
3480
    except AvahiError as error: