/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: 2016-08-25 17:06:42 UTC
  • Revision ID: teddy@recompile.se-20160825170642-n4ough8ql1145zak
PEP8 compliance: mandos-monitor

* mandos-monitor: Add PEP8 compliance (as per the "pycodestyle" tool).

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
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-2019 Teddy Hogeborn
15
 
# Copyright © 2008-2019 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
 
14
# Copyright © 2008-2016 Teddy Hogeborn
 
15
# Copyright © 2008-2016 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
21
19
# the Free Software Foundation, either version 3 of the License, or
22
20
# (at your option) any later version.
23
21
#
24
 
#     Mandos is distributed in the hope that it will be useful, but
25
 
#     WITHOUT ANY WARRANTY; without even the implied warranty of
 
22
#     This program is distributed in the hope that it will be useful,
 
23
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
26
24
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
27
25
#     GNU General Public License for more details.
28
 
#
 
26
29
27
# You should have received a copy of the GNU General Public License
30
 
# along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
31
 
#
 
28
# along with this program.  If not, see
 
29
# <http://www.gnu.org/licenses/>.
 
30
32
31
# Contact the authors at <mandos@recompile.se>.
33
 
#
 
32
34
33
 
35
34
from __future__ import (division, absolute_import, print_function,
36
35
                        unicode_literals)
115
114
if sys.version_info.major == 2:
116
115
    str = unicode
117
116
 
118
 
version = "1.8.4"
 
117
version = "1.7.10"
119
118
stored_state_file = "clients.pickle"
120
119
 
121
120
logger = logging.getLogger()
125
124
    if_nametoindex = ctypes.cdll.LoadLibrary(
126
125
        ctypes.util.find_library("c")).if_nametoindex
127
126
except (OSError, AttributeError):
128
 
 
 
127
    
129
128
    def if_nametoindex(interface):
130
129
        "Get an interface index the hard way, i.e. using fcntl()"
131
130
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
154
153
 
155
154
def initlogger(debug, level=logging.WARNING):
156
155
    """init logger and add loglevel"""
157
 
 
 
156
    
158
157
    global syslogger
159
158
    syslogger = (logging.handlers.SysLogHandler(
160
 
        facility=logging.handlers.SysLogHandler.LOG_DAEMON,
161
 
        address="/dev/log"))
 
159
        facility = logging.handlers.SysLogHandler.LOG_DAEMON,
 
160
        address = "/dev/log"))
162
161
    syslogger.setFormatter(logging.Formatter
163
162
                           ('Mandos [%(process)d]: %(levelname)s:'
164
163
                            ' %(message)s'))
165
164
    logger.addHandler(syslogger)
166
 
 
 
165
    
167
166
    if debug:
168
167
        console = logging.StreamHandler()
169
168
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
181
180
 
182
181
class PGPEngine(object):
183
182
    """A simple class for OpenPGP symmetric encryption & decryption"""
184
 
 
 
183
    
185
184
    def __init__(self):
186
185
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
187
186
        self.gpg = "gpg"
202
201
        # Only GPG version 1 has the --no-use-agent option.
203
202
        if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
204
203
            self.gnupgargs.append("--no-use-agent")
205
 
 
 
204
    
206
205
    def __enter__(self):
207
206
        return self
208
 
 
 
207
    
209
208
    def __exit__(self, exc_type, exc_value, traceback):
210
209
        self._cleanup()
211
210
        return False
212
 
 
 
211
    
213
212
    def __del__(self):
214
213
        self._cleanup()
215
 
 
 
214
    
216
215
    def _cleanup(self):
217
216
        if self.tempdir is not None:
218
217
            # Delete contents of tempdir
219
218
            for root, dirs, files in os.walk(self.tempdir,
220
 
                                             topdown=False):
 
219
                                             topdown = False):
221
220
                for filename in files:
222
221
                    os.remove(os.path.join(root, filename))
223
222
                for dirname in dirs:
225
224
            # Remove tempdir
226
225
            os.rmdir(self.tempdir)
227
226
            self.tempdir = None
228
 
 
 
227
    
229
228
    def password_encode(self, password):
230
229
        # Passphrase can not be empty and can not contain newlines or
231
230
        # NUL bytes.  So we prefix it and hex encode it.
236
235
                       .replace(b"\n", b"\\n")
237
236
                       .replace(b"\0", b"\\x00"))
238
237
        return encoded
239
 
 
 
238
    
240
239
    def encrypt(self, data, password):
241
240
        passphrase = self.password_encode(password)
242
241
        with tempfile.NamedTemporaryFile(
247
246
                                     '--passphrase-file',
248
247
                                     passfile.name]
249
248
                                    + self.gnupgargs,
250
 
                                    stdin=subprocess.PIPE,
251
 
                                    stdout=subprocess.PIPE,
252
 
                                    stderr=subprocess.PIPE)
253
 
            ciphertext, err = proc.communicate(input=data)
 
249
                                    stdin = subprocess.PIPE,
 
250
                                    stdout = subprocess.PIPE,
 
251
                                    stderr = subprocess.PIPE)
 
252
            ciphertext, err = proc.communicate(input = data)
254
253
        if proc.returncode != 0:
255
254
            raise PGPError(err)
256
255
        return ciphertext
257
 
 
 
256
    
258
257
    def decrypt(self, data, password):
259
258
        passphrase = self.password_encode(password)
260
259
        with tempfile.NamedTemporaryFile(
261
 
                dir=self.tempdir) as passfile:
 
260
                dir = self.tempdir) as passfile:
262
261
            passfile.write(passphrase)
263
262
            passfile.flush()
264
263
            proc = subprocess.Popen([self.gpg, '--decrypt',
265
264
                                     '--passphrase-file',
266
265
                                     passfile.name]
267
266
                                    + self.gnupgargs,
268
 
                                    stdin=subprocess.PIPE,
269
 
                                    stdout=subprocess.PIPE,
270
 
                                    stderr=subprocess.PIPE)
271
 
            decrypted_plaintext, err = proc.communicate(input=data)
 
267
                                    stdin = subprocess.PIPE,
 
268
                                    stdout = subprocess.PIPE,
 
269
                                    stderr = subprocess.PIPE)
 
270
            decrypted_plaintext, err = proc.communicate(input = data)
272
271
        if proc.returncode != 0:
273
272
            raise PGPError(err)
274
273
        return decrypted_plaintext
275
274
 
276
 
 
277
275
# 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
 
    IF_UNSPEC = -1               # avahi-common/address.h
281
 
    PROTO_UNSPEC = -1            # avahi-common/address.h
282
 
    PROTO_INET = 0               # avahi-common/address.h
283
 
    PROTO_INET6 = 1              # avahi-common/address.h
 
276
class Avahi(object):
 
277
    """This isn't so much a class as it is a module-like namespace.
 
278
    It is instantiated once, and simulates having an Avahi module."""
 
279
    IF_UNSPEC = -1              # avahi-common/address.h
 
280
    PROTO_UNSPEC = -1           # avahi-common/address.h
 
281
    PROTO_INET = 0              # avahi-common/address.h
 
282
    PROTO_INET6 = 1             # avahi-common/address.h
284
283
    DBUS_NAME = "org.freedesktop.Avahi"
285
284
    DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
286
285
    DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
287
286
    DBUS_PATH_SERVER = "/"
288
 
 
289
 
    @staticmethod
290
 
    def string_array_to_txt_array(t):
 
287
    def string_array_to_txt_array(self, t):
291
288
        return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
292
289
                           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
 
 
 
290
    ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
 
291
    ENTRY_GROUP_COLLISION = 3   # avahi-common/defs.h
 
292
    ENTRY_GROUP_FAILURE = 4     # avahi-common/defs.h
 
293
    SERVER_INVALID = 0          # avahi-common/defs.h
 
294
    SERVER_REGISTERING = 1      # avahi-common/defs.h
 
295
    SERVER_RUNNING = 2          # avahi-common/defs.h
 
296
    SERVER_COLLISION = 3        # avahi-common/defs.h
 
297
    SERVER_FAILURE = 4          # avahi-common/defs.h
 
298
avahi = Avahi()
302
299
 
303
300
class AvahiError(Exception):
304
301
    def __init__(self, value, *args, **kwargs):
317
314
 
318
315
class AvahiService(object):
319
316
    """An Avahi (Zeroconf) service.
320
 
 
 
317
    
321
318
    Attributes:
322
319
    interface: integer; avahi.IF_UNSPEC or an interface index.
323
320
               Used to optionally bind to the specified interface.
335
332
    server: D-Bus Server
336
333
    bus: dbus.SystemBus()
337
334
    """
338
 
 
 
335
    
339
336
    def __init__(self,
340
 
                 interface=avahi.IF_UNSPEC,
341
 
                 name=None,
342
 
                 servicetype=None,
343
 
                 port=None,
344
 
                 TXT=None,
345
 
                 domain="",
346
 
                 host="",
347
 
                 max_renames=32768,
348
 
                 protocol=avahi.PROTO_UNSPEC,
349
 
                 bus=None):
 
337
                 interface = avahi.IF_UNSPEC,
 
338
                 name = None,
 
339
                 servicetype = None,
 
340
                 port = None,
 
341
                 TXT = None,
 
342
                 domain = "",
 
343
                 host = "",
 
344
                 max_renames = 32768,
 
345
                 protocol = avahi.PROTO_UNSPEC,
 
346
                 bus = None):
350
347
        self.interface = interface
351
348
        self.name = name
352
349
        self.type = servicetype
361
358
        self.server = None
362
359
        self.bus = bus
363
360
        self.entry_group_state_changed_match = None
364
 
 
 
361
    
365
362
    def rename(self, remove=True):
366
363
        """Derived from the Avahi example code"""
367
364
        if self.rename_count >= self.max_renames:
387
384
                logger.critical("D-Bus Exception", exc_info=error)
388
385
                self.cleanup()
389
386
                os._exit(1)
390
 
 
 
387
    
391
388
    def remove(self):
392
389
        """Derived from the Avahi example code"""
393
390
        if self.entry_group_state_changed_match is not None:
395
392
            self.entry_group_state_changed_match = None
396
393
        if self.group is not None:
397
394
            self.group.Reset()
398
 
 
 
395
    
399
396
    def add(self):
400
397
        """Derived from the Avahi example code"""
401
398
        self.remove()
418
415
            dbus.UInt16(self.port),
419
416
            avahi.string_array_to_txt_array(self.TXT))
420
417
        self.group.Commit()
421
 
 
 
418
    
422
419
    def entry_group_state_changed(self, state, error):
423
420
        """Derived from the Avahi example code"""
424
421
        logger.debug("Avahi entry group state change: %i", state)
425
 
 
 
422
        
426
423
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
427
424
            logger.debug("Zeroconf service established.")
428
425
        elif state == avahi.ENTRY_GROUP_COLLISION:
432
429
            logger.critical("Avahi: Error in group state changed %s",
433
430
                            str(error))
434
431
            raise AvahiGroupError("State changed: {!s}".format(error))
435
 
 
 
432
    
436
433
    def cleanup(self):
437
434
        """Derived from the Avahi example code"""
438
435
        if self.group is not None:
443
440
                pass
444
441
            self.group = None
445
442
        self.remove()
446
 
 
 
443
    
447
444
    def server_state_changed(self, state, error=None):
448
445
        """Derived from the Avahi example code"""
449
446
        logger.debug("Avahi server state change: %i", state)
478
475
                logger.debug("Unknown state: %r", state)
479
476
            else:
480
477
                logger.debug("Unknown state: %r: %r", state, error)
481
 
 
 
478
    
482
479
    def activate(self):
483
480
        """Derived from the Avahi example code"""
484
481
        if self.server is None:
495
492
class AvahiServiceToSyslog(AvahiService):
496
493
    def rename(self, *args, **kwargs):
497
494
        """Add the new name to the syslog messages"""
498
 
        ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
 
495
        ret = AvahiService.rename(self, *args, **kwargs)
499
496
        syslogger.setFormatter(logging.Formatter(
500
497
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
501
498
            .format(self.name)))
502
499
        return ret
503
500
 
504
 
 
505
501
# Pretend that we have a GnuTLS module
506
 
class gnutls(object):
507
 
    """This isn't so much a class as it is a module-like namespace."""
508
 
 
509
 
    library = ctypes.util.find_library("gnutls")
510
 
    if library is None:
511
 
        library = ctypes.util.find_library("gnutls-deb0")
512
 
    _library = ctypes.cdll.LoadLibrary(library)
513
 
    del library
514
 
 
 
502
class GnuTLS(object):
 
503
    """This isn't so much a class as it is a module-like namespace.
 
504
    It is instantiated once, and simulates having a GnuTLS module."""
 
505
    
 
506
    _library = ctypes.cdll.LoadLibrary(
 
507
        ctypes.util.find_library("gnutls"))
 
508
    _need_version = b"3.3.0"
 
509
    def __init__(self):
 
510
        # Need to use class name "GnuTLS" here, since this method is
 
511
        # called before the assignment to the "gnutls" global variable
 
512
        # happens.
 
513
        if GnuTLS.check_version(self._need_version) is None:
 
514
            raise GnuTLS.Error("Needs GnuTLS {} or later"
 
515
                               .format(self._need_version))
 
516
    
515
517
    # Unless otherwise indicated, the constants and types below are
516
518
    # all from the gnutls/gnutls.h C header file.
517
 
 
 
519
    
518
520
    # Constants
519
521
    E_SUCCESS = 0
520
522
    E_INTERRUPTED = -52
521
523
    E_AGAIN = -28
522
524
    CRT_OPENPGP = 2
523
 
    CRT_RAWPK = 3
524
525
    CLIENT = 2
525
526
    SHUT_RDWR = 0
526
527
    CRD_CERTIFICATE = 1
527
528
    E_NO_CERTIFICATE_FOUND = -49
528
 
    X509_FMT_DER = 0
529
 
    NO_TICKETS = 1<<10
530
 
    ENABLE_RAWPK = 1<<18
531
 
    CTYPE_PEERS = 3
532
 
    KEYID_USE_SHA256 = 1        # gnutls/x509.h
533
529
    OPENPGP_FMT_RAW = 0         # gnutls/openpgp.h
534
 
 
 
530
    
535
531
    # Types
536
532
    class session_int(ctypes.Structure):
537
533
        _fields_ = []
538
534
    session_t = ctypes.POINTER(session_int)
539
 
 
540
535
    class certificate_credentials_st(ctypes.Structure):
541
536
        _fields_ = []
542
537
    certificate_credentials_t = ctypes.POINTER(
543
538
        certificate_credentials_st)
544
539
    certificate_type_t = ctypes.c_int
545
 
 
546
540
    class datum_t(ctypes.Structure):
547
541
        _fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
548
542
                    ('size', ctypes.c_uint)]
549
 
 
550
543
    class openpgp_crt_int(ctypes.Structure):
551
544
        _fields_ = []
552
545
    openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
553
 
    openpgp_crt_fmt_t = ctypes.c_int  # gnutls/openpgp.h
 
546
    openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
554
547
    log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
555
548
    credentials_type_t = ctypes.c_int
556
549
    transport_ptr_t = ctypes.c_void_p
557
550
    close_request_t = ctypes.c_int
558
 
 
 
551
    
559
552
    # Exceptions
560
553
    class Error(Exception):
561
 
        def __init__(self, message=None, code=None, args=()):
 
554
        # We need to use the class name "GnuTLS" here, since this
 
555
        # exception might be raised from within GnuTLS.__init__,
 
556
        # which is called before the assignment to the "gnutls"
 
557
        # global variable has happened.
 
558
        def __init__(self, message = None, code = None, args=()):
562
559
            # Default usage is by a message string, but if a return
563
560
            # code is passed, convert it to a string with
564
561
            # gnutls.strerror()
565
562
            self.code = code
566
563
            if message is None and code is not None:
567
 
                message = gnutls.strerror(code)
568
 
            return super(gnutls.Error, self).__init__(
 
564
                message = GnuTLS.strerror(code)
 
565
            return super(GnuTLS.Error, self).__init__(
569
566
                message, *args)
570
 
 
 
567
    
571
568
    class CertificateSecurityError(Error):
572
569
        pass
573
 
 
 
570
    
574
571
    # Classes
575
572
    class Credentials(object):
576
573
        def __init__(self):
578
575
            gnutls.certificate_allocate_credentials(
579
576
                ctypes.byref(self._c_object))
580
577
            self.type = gnutls.CRD_CERTIFICATE
581
 
 
 
578
        
582
579
        def __del__(self):
583
580
            gnutls.certificate_free_credentials(self._c_object)
584
 
 
 
581
    
585
582
    class ClientSession(object):
586
 
        def __init__(self, socket, credentials=None):
 
583
        def __init__(self, socket, credentials = None):
587
584
            self._c_object = gnutls.session_t()
588
 
            gnutls_flags = gnutls.CLIENT
589
 
            if gnutls.check_version("3.5.6"):
590
 
                gnutls_flags |= gnutls.NO_TICKETS
591
 
            if gnutls.has_rawpk:
592
 
                gnutls_flags |= gnutls.ENABLE_RAWPK
593
 
            gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
594
 
            del gnutls_flags
 
585
            gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
595
586
            gnutls.set_default_priority(self._c_object)
596
587
            gnutls.transport_set_ptr(self._c_object, socket.fileno())
597
588
            gnutls.handshake_set_private_extensions(self._c_object,
603
594
                                   ctypes.cast(credentials._c_object,
604
595
                                               ctypes.c_void_p))
605
596
            self.credentials = credentials
606
 
 
 
597
        
607
598
        def __del__(self):
608
599
            gnutls.deinit(self._c_object)
609
 
 
 
600
        
610
601
        def handshake(self):
611
602
            return gnutls.handshake(self._c_object)
612
 
 
 
603
        
613
604
        def send(self, data):
614
605
            data = bytes(data)
615
606
            data_len = len(data)
617
608
                data_len -= gnutls.record_send(self._c_object,
618
609
                                               data[-data_len:],
619
610
                                               data_len)
620
 
 
 
611
        
621
612
        def bye(self):
622
613
            return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
623
 
 
 
614
    
624
615
    # Error handling functions
625
616
    def _error_code(result):
626
617
        """A function to raise exceptions on errors, suitable
628
619
        if result >= 0:
629
620
            return result
630
621
        if result == gnutls.E_NO_CERTIFICATE_FOUND:
631
 
            raise gnutls.CertificateSecurityError(code=result)
632
 
        raise gnutls.Error(code=result)
633
 
 
 
622
            raise gnutls.CertificateSecurityError(code = result)
 
623
        raise gnutls.Error(code = result)
 
624
    
634
625
    def _retry_on_error(result, func, arguments):
635
626
        """A function to retry on some errors, suitable
636
627
        for the 'errcheck' attribute on ctypes functions"""
639
630
                return _error_code(result)
640
631
            result = func(*arguments)
641
632
        return result
642
 
 
 
633
    
643
634
    # Unless otherwise indicated, the function declarations below are
644
635
    # all from the gnutls/gnutls.h C header file.
645
 
 
 
636
    
646
637
    # Functions
647
638
    priority_set_direct = _library.gnutls_priority_set_direct
648
639
    priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
649
640
                                    ctypes.POINTER(ctypes.c_char_p)]
650
641
    priority_set_direct.restype = _error_code
651
 
 
 
642
    
652
643
    init = _library.gnutls_init
653
644
    init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
654
645
    init.restype = _error_code
655
 
 
 
646
    
656
647
    set_default_priority = _library.gnutls_set_default_priority
657
648
    set_default_priority.argtypes = [session_t]
658
649
    set_default_priority.restype = _error_code
659
 
 
 
650
    
660
651
    record_send = _library.gnutls_record_send
661
652
    record_send.argtypes = [session_t, ctypes.c_void_p,
662
653
                            ctypes.c_size_t]
663
654
    record_send.restype = ctypes.c_ssize_t
664
655
    record_send.errcheck = _retry_on_error
665
 
 
 
656
    
666
657
    certificate_allocate_credentials = (
667
658
        _library.gnutls_certificate_allocate_credentials)
668
659
    certificate_allocate_credentials.argtypes = [
669
660
        ctypes.POINTER(certificate_credentials_t)]
670
661
    certificate_allocate_credentials.restype = _error_code
671
 
 
 
662
    
672
663
    certificate_free_credentials = (
673
664
        _library.gnutls_certificate_free_credentials)
674
 
    certificate_free_credentials.argtypes = [
675
 
        certificate_credentials_t]
 
665
    certificate_free_credentials.argtypes = [certificate_credentials_t]
676
666
    certificate_free_credentials.restype = None
677
 
 
 
667
    
678
668
    handshake_set_private_extensions = (
679
669
        _library.gnutls_handshake_set_private_extensions)
680
670
    handshake_set_private_extensions.argtypes = [session_t,
681
671
                                                 ctypes.c_int]
682
672
    handshake_set_private_extensions.restype = None
683
 
 
 
673
    
684
674
    credentials_set = _library.gnutls_credentials_set
685
675
    credentials_set.argtypes = [session_t, credentials_type_t,
686
676
                                ctypes.c_void_p]
687
677
    credentials_set.restype = _error_code
688
 
 
 
678
    
689
679
    strerror = _library.gnutls_strerror
690
680
    strerror.argtypes = [ctypes.c_int]
691
681
    strerror.restype = ctypes.c_char_p
692
 
 
 
682
    
693
683
    certificate_type_get = _library.gnutls_certificate_type_get
694
684
    certificate_type_get.argtypes = [session_t]
695
685
    certificate_type_get.restype = _error_code
696
 
 
 
686
    
697
687
    certificate_get_peers = _library.gnutls_certificate_get_peers
698
688
    certificate_get_peers.argtypes = [session_t,
699
689
                                      ctypes.POINTER(ctypes.c_uint)]
700
690
    certificate_get_peers.restype = ctypes.POINTER(datum_t)
701
 
 
 
691
    
702
692
    global_set_log_level = _library.gnutls_global_set_log_level
703
693
    global_set_log_level.argtypes = [ctypes.c_int]
704
694
    global_set_log_level.restype = None
705
 
 
 
695
    
706
696
    global_set_log_function = _library.gnutls_global_set_log_function
707
697
    global_set_log_function.argtypes = [log_func]
708
698
    global_set_log_function.restype = None
709
 
 
 
699
    
710
700
    deinit = _library.gnutls_deinit
711
701
    deinit.argtypes = [session_t]
712
702
    deinit.restype = None
713
 
 
 
703
    
714
704
    handshake = _library.gnutls_handshake
715
705
    handshake.argtypes = [session_t]
716
706
    handshake.restype = _error_code
717
707
    handshake.errcheck = _retry_on_error
718
 
 
 
708
    
719
709
    transport_set_ptr = _library.gnutls_transport_set_ptr
720
710
    transport_set_ptr.argtypes = [session_t, transport_ptr_t]
721
711
    transport_set_ptr.restype = None
722
 
 
 
712
    
723
713
    bye = _library.gnutls_bye
724
714
    bye.argtypes = [session_t, close_request_t]
725
715
    bye.restype = _error_code
726
716
    bye.errcheck = _retry_on_error
727
 
 
 
717
    
728
718
    check_version = _library.gnutls_check_version
729
719
    check_version.argtypes = [ctypes.c_char_p]
730
720
    check_version.restype = ctypes.c_char_p
731
 
 
732
 
    _need_version = b"3.3.0"
733
 
    if check_version(_need_version) is None:
734
 
        raise self.Error("Needs GnuTLS {} or later"
735
 
                         .format(_need_version))
736
 
 
737
 
    _tls_rawpk_version = b"3.6.6"
738
 
    has_rawpk = bool(check_version(_tls_rawpk_version))
739
 
 
740
 
    if has_rawpk:
741
 
        # Types
742
 
        class pubkey_st(ctypes.Structure):
743
 
            _fields = []
744
 
        pubkey_t = ctypes.POINTER(pubkey_st)
745
 
 
746
 
        x509_crt_fmt_t = ctypes.c_int
747
 
 
748
 
        # All the function declarations below are from gnutls/abstract.h
749
 
        pubkey_init = _library.gnutls_pubkey_init
750
 
        pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
751
 
        pubkey_init.restype = _error_code
752
 
 
753
 
        pubkey_import = _library.gnutls_pubkey_import
754
 
        pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
755
 
                                  x509_crt_fmt_t]
756
 
        pubkey_import.restype = _error_code
757
 
 
758
 
        pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
759
 
        pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
760
 
                                      ctypes.POINTER(ctypes.c_ubyte),
761
 
                                      ctypes.POINTER(ctypes.c_size_t)]
762
 
        pubkey_get_key_id.restype = _error_code
763
 
 
764
 
        pubkey_deinit = _library.gnutls_pubkey_deinit
765
 
        pubkey_deinit.argtypes = [pubkey_t]
766
 
        pubkey_deinit.restype = None
767
 
    else:
768
 
        # All the function declarations below are from gnutls/openpgp.h
769
 
 
770
 
        openpgp_crt_init = _library.gnutls_openpgp_crt_init
771
 
        openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
772
 
        openpgp_crt_init.restype = _error_code
773
 
 
774
 
        openpgp_crt_import = _library.gnutls_openpgp_crt_import
775
 
        openpgp_crt_import.argtypes = [openpgp_crt_t,
776
 
                                       ctypes.POINTER(datum_t),
777
 
                                       openpgp_crt_fmt_t]
778
 
        openpgp_crt_import.restype = _error_code
779
 
 
780
 
        openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
781
 
        openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
782
 
                                            ctypes.POINTER(ctypes.c_uint)]
783
 
        openpgp_crt_verify_self.restype = _error_code
784
 
 
785
 
        openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
786
 
        openpgp_crt_deinit.argtypes = [openpgp_crt_t]
787
 
        openpgp_crt_deinit.restype = None
788
 
 
789
 
        openpgp_crt_get_fingerprint = (
790
 
            _library.gnutls_openpgp_crt_get_fingerprint)
791
 
        openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
792
 
                                                ctypes.c_void_p,
793
 
                                                ctypes.POINTER(
794
 
                                                    ctypes.c_size_t)]
795
 
        openpgp_crt_get_fingerprint.restype = _error_code
796
 
 
797
 
    if check_version("3.6.4"):
798
 
        certificate_type_get2 = _library.gnutls_certificate_type_get2
799
 
        certificate_type_get2.argtypes = [session_t, ctypes.c_int]
800
 
        certificate_type_get2.restype = _error_code
801
 
 
 
721
    
 
722
    # All the function declarations below are from gnutls/openpgp.h
 
723
    
 
724
    openpgp_crt_init = _library.gnutls_openpgp_crt_init
 
725
    openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
 
726
    openpgp_crt_init.restype = _error_code
 
727
    
 
728
    openpgp_crt_import = _library.gnutls_openpgp_crt_import
 
729
    openpgp_crt_import.argtypes = [openpgp_crt_t,
 
730
                                   ctypes.POINTER(datum_t),
 
731
                                   openpgp_crt_fmt_t]
 
732
    openpgp_crt_import.restype = _error_code
 
733
    
 
734
    openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
 
735
    openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
 
736
                                        ctypes.POINTER(ctypes.c_uint)]
 
737
    openpgp_crt_verify_self.restype = _error_code
 
738
    
 
739
    openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
 
740
    openpgp_crt_deinit.argtypes = [openpgp_crt_t]
 
741
    openpgp_crt_deinit.restype = None
 
742
    
 
743
    openpgp_crt_get_fingerprint = (
 
744
        _library.gnutls_openpgp_crt_get_fingerprint)
 
745
    openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
 
746
                                            ctypes.c_void_p,
 
747
                                            ctypes.POINTER(
 
748
                                                ctypes.c_size_t)]
 
749
    openpgp_crt_get_fingerprint.restype = _error_code
 
750
    
802
751
    # Remove non-public functions
803
752
    del _error_code, _retry_on_error
804
 
 
 
753
# Create the global "gnutls" object, simulating a module
 
754
gnutls = GnuTLS()
805
755
 
806
756
def call_pipe(connection,       # : multiprocessing.Connection
807
757
              func, *args, **kwargs):
808
758
    """This function is meant to be called by multiprocessing.Process
809
 
 
 
759
    
810
760
    This function runs func(*args, **kwargs), and writes the resulting
811
761
    return value on the provided multiprocessing.Connection.
812
762
    """
813
763
    connection.send(func(*args, **kwargs))
814
764
    connection.close()
815
765
 
816
 
 
817
766
class Client(object):
818
767
    """A representation of a client host served by this server.
819
 
 
 
768
    
820
769
    Attributes:
821
770
    approved:   bool(); 'None' if not yet approved/disapproved
822
771
    approval_delay: datetime.timedelta(); Time to wait for approval
837
786
    disable_initiator_tag: a GLib event source tag, or None
838
787
    enabled:    bool()
839
788
    fingerprint: string (40 or 32 hexadecimal digits); used to
840
 
                 uniquely identify an OpenPGP client
841
 
    key_id: string (64 hexadecimal digits); used to uniquely identify
842
 
            a client using raw public keys
 
789
                 uniquely identify the client
843
790
    host:       string; available for use by the checker command
844
791
    interval:   datetime.timedelta(); How often to start a new checker
845
792
    last_approval_request: datetime.datetime(); (UTC) or None
861
808
                disabled, or None
862
809
    server_settings: The server_settings dict from main()
863
810
    """
864
 
 
 
811
    
865
812
    runtime_expansions = ("approval_delay", "approval_duration",
866
 
                          "created", "enabled", "expires", "key_id",
 
813
                          "created", "enabled", "expires",
867
814
                          "fingerprint", "host", "interval",
868
815
                          "last_approval_request", "last_checked_ok",
869
816
                          "last_enabled", "name", "timeout")
878
825
        "approved_by_default": "True",
879
826
        "enabled": "True",
880
827
    }
881
 
 
 
828
    
882
829
    @staticmethod
883
830
    def config_parser(config):
884
831
        """Construct a new dict of client settings of this form:
891
838
        for client_name in config.sections():
892
839
            section = dict(config.items(client_name))
893
840
            client = settings[client_name] = {}
894
 
 
 
841
            
895
842
            client["host"] = section["host"]
896
843
            # Reformat values from string types to Python types
897
844
            client["approved_by_default"] = config.getboolean(
898
845
                client_name, "approved_by_default")
899
846
            client["enabled"] = config.getboolean(client_name,
900
847
                                                  "enabled")
901
 
 
902
 
            # Uppercase and remove spaces from key_id and fingerprint
903
 
            # for later comparison purposes with return value from the
904
 
            # key_id() and fingerprint() functions
905
 
            client["key_id"] = (section.get("key_id", "").upper()
906
 
                                .replace(" ", ""))
 
848
            
 
849
            # Uppercase and remove spaces from fingerprint for later
 
850
            # comparison purposes with return value from the
 
851
            # fingerprint() function
907
852
            client["fingerprint"] = (section["fingerprint"].upper()
908
853
                                     .replace(" ", ""))
909
854
            if "secret" in section:
930
875
            client["last_approval_request"] = None
931
876
            client["last_checked_ok"] = None
932
877
            client["last_checker_status"] = -2
933
 
 
 
878
        
934
879
        return settings
935
 
 
936
 
    def __init__(self, settings, name=None, server_settings=None):
 
880
    
 
881
    def __init__(self, settings, name = None, server_settings=None):
937
882
        self.name = name
938
883
        if server_settings is None:
939
884
            server_settings = {}
941
886
        # adding all client settings
942
887
        for setting, value in settings.items():
943
888
            setattr(self, setting, value)
944
 
 
 
889
        
945
890
        if self.enabled:
946
891
            if not hasattr(self, "last_enabled"):
947
892
                self.last_enabled = datetime.datetime.utcnow()
951
896
        else:
952
897
            self.last_enabled = None
953
898
            self.expires = None
954
 
 
 
899
        
955
900
        logger.debug("Creating client %r", self.name)
956
 
        logger.debug("  Key ID: %s", self.key_id)
957
901
        logger.debug("  Fingerprint: %s", self.fingerprint)
958
902
        self.created = settings.get("created",
959
903
                                    datetime.datetime.utcnow())
960
 
 
 
904
        
961
905
        # attributes specific for this server instance
962
906
        self.checker = None
963
907
        self.checker_initiator_tag = None
972
916
                                 for attr in self.__dict__.keys()
973
917
                                 if not attr.startswith("_")]
974
918
        self.client_structure.append("client_structure")
975
 
 
 
919
        
976
920
        for name, t in inspect.getmembers(
977
921
                type(self), lambda obj: isinstance(obj, property)):
978
922
            if not name.startswith("_"):
979
923
                self.client_structure.append(name)
980
 
 
 
924
    
981
925
    # Send notice to process children that client state has changed
982
926
    def send_changedstate(self):
983
927
        with self.changedstate:
984
928
            self.changedstate.notify_all()
985
 
 
 
929
    
986
930
    def enable(self):
987
931
        """Start this client's checker and timeout hooks"""
988
932
        if getattr(self, "enabled", False):
993
937
        self.last_enabled = datetime.datetime.utcnow()
994
938
        self.init_checker()
995
939
        self.send_changedstate()
996
 
 
 
940
    
997
941
    def disable(self, quiet=True):
998
942
        """Disable this client."""
999
943
        if not getattr(self, "enabled", False):
1013
957
            self.send_changedstate()
1014
958
        # Do not run this again if called by a GLib.timeout_add
1015
959
        return False
1016
 
 
 
960
    
1017
961
    def __del__(self):
1018
962
        self.disable()
1019
 
 
 
963
    
1020
964
    def init_checker(self):
1021
965
        # Schedule a new checker to be started an 'interval' from now,
1022
966
        # and every interval from then on.
1032
976
            int(self.timeout.total_seconds() * 1000), self.disable)
1033
977
        # Also start a new checker *right now*.
1034
978
        self.start_checker()
1035
 
 
 
979
    
1036
980
    def checker_callback(self, source, condition, connection,
1037
981
                         command):
1038
982
        """The checker has completed, so take appropriate actions."""
1041
985
        # Read return code from connection (see call_pipe)
1042
986
        returncode = connection.recv()
1043
987
        connection.close()
1044
 
 
 
988
        
1045
989
        if returncode >= 0:
1046
990
            self.last_checker_status = returncode
1047
991
            self.last_checker_signal = None
1057
1001
            logger.warning("Checker for %(name)s crashed?",
1058
1002
                           vars(self))
1059
1003
        return False
1060
 
 
 
1004
    
1061
1005
    def checked_ok(self):
1062
1006
        """Assert that the client has been seen, alive and well."""
1063
1007
        self.last_checked_ok = datetime.datetime.utcnow()
1064
1008
        self.last_checker_status = 0
1065
1009
        self.last_checker_signal = None
1066
1010
        self.bump_timeout()
1067
 
 
 
1011
    
1068
1012
    def bump_timeout(self, timeout=None):
1069
1013
        """Bump up the timeout for this client."""
1070
1014
        if timeout is None:
1076
1020
            self.disable_initiator_tag = GLib.timeout_add(
1077
1021
                int(timeout.total_seconds() * 1000), self.disable)
1078
1022
            self.expires = datetime.datetime.utcnow() + timeout
1079
 
 
 
1023
    
1080
1024
    def need_approval(self):
1081
1025
        self.last_approval_request = datetime.datetime.utcnow()
1082
 
 
 
1026
    
1083
1027
    def start_checker(self):
1084
1028
        """Start a new checker subprocess if one is not running.
1085
 
 
 
1029
        
1086
1030
        If a checker already exists, leave it running and do
1087
1031
        nothing."""
1088
1032
        # The reason for not killing a running checker is that if we
1093
1037
        # checkers alone, the checker would have to take more time
1094
1038
        # than 'timeout' for the client to be disabled, which is as it
1095
1039
        # should be.
1096
 
 
 
1040
        
1097
1041
        if self.checker is not None and not self.checker.is_alive():
1098
1042
            logger.warning("Checker was not alive; joining")
1099
1043
            self.checker.join()
1103
1047
            # Escape attributes for the shell
1104
1048
            escaped_attrs = {
1105
1049
                attr: re.escape(str(getattr(self, attr)))
1106
 
                for attr in self.runtime_expansions}
 
1050
                for attr in self.runtime_expansions }
1107
1051
            try:
1108
1052
                command = self.checker_command % escaped_attrs
1109
1053
            except TypeError as error:
1121
1065
            # The exception is when not debugging but nevertheless
1122
1066
            # running in the foreground; use the previously
1123
1067
            # created wnull.
1124
 
            popen_args = {"close_fds": True,
1125
 
                          "shell": True,
1126
 
                          "cwd": "/"}
 
1068
            popen_args = { "close_fds": True,
 
1069
                           "shell": True,
 
1070
                           "cwd": "/" }
1127
1071
            if (not self.server_settings["debug"]
1128
1072
                and self.server_settings["foreground"]):
1129
1073
                popen_args.update({"stdout": wnull,
1130
 
                                   "stderr": wnull})
1131
 
            pipe = multiprocessing.Pipe(duplex=False)
 
1074
                                   "stderr": wnull })
 
1075
            pipe = multiprocessing.Pipe(duplex = False)
1132
1076
            self.checker = multiprocessing.Process(
1133
 
                target=call_pipe,
1134
 
                args=(pipe[1], subprocess.call, command),
1135
 
                kwargs=popen_args)
 
1077
                target = call_pipe,
 
1078
                args = (pipe[1], subprocess.call, command),
 
1079
                kwargs = popen_args)
1136
1080
            self.checker.start()
1137
1081
            self.checker_callback_tag = GLib.io_add_watch(
1138
1082
                pipe[0].fileno(), GLib.IO_IN,
1139
1083
                self.checker_callback, pipe[0], command)
1140
1084
        # Re-run this periodically if run by GLib.timeout_add
1141
1085
        return True
1142
 
 
 
1086
    
1143
1087
    def stop_checker(self):
1144
1088
        """Force the checker process, if any, to stop."""
1145
1089
        if self.checker_callback_tag:
1158
1102
                          byte_arrays=False):
1159
1103
    """Decorators for marking methods of a DBusObjectWithProperties to
1160
1104
    become properties on the D-Bus.
1161
 
 
 
1105
    
1162
1106
    The decorated method will be called with no arguments by "Get"
1163
1107
    and with one argument by "Set".
1164
 
 
 
1108
    
1165
1109
    The parameters, where they are supported, are the same as
1166
1110
    dbus.service.method, except there is only "signature", since the
1167
1111
    type from Get() and the type sent to Set() is the same.
1171
1115
    if byte_arrays and signature != "ay":
1172
1116
        raise ValueError("Byte arrays not supported for non-'ay'"
1173
1117
                         " signature {!r}".format(signature))
1174
 
 
 
1118
    
1175
1119
    def decorator(func):
1176
1120
        func._dbus_is_property = True
1177
1121
        func._dbus_interface = dbus_interface
1180
1124
        func._dbus_name = func.__name__
1181
1125
        if func._dbus_name.endswith("_dbus_property"):
1182
1126
            func._dbus_name = func._dbus_name[:-14]
1183
 
        func._dbus_get_args_options = {'byte_arrays': byte_arrays}
 
1127
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
1184
1128
        return func
1185
 
 
 
1129
    
1186
1130
    return decorator
1187
1131
 
1188
1132
 
1189
1133
def dbus_interface_annotations(dbus_interface):
1190
1134
    """Decorator for marking functions returning interface annotations
1191
 
 
 
1135
    
1192
1136
    Usage:
1193
 
 
 
1137
    
1194
1138
    @dbus_interface_annotations("org.example.Interface")
1195
1139
    def _foo(self):  # Function name does not matter
1196
1140
        return {"org.freedesktop.DBus.Deprecated": "true",
1197
1141
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
1198
1142
                    "false"}
1199
1143
    """
1200
 
 
 
1144
    
1201
1145
    def decorator(func):
1202
1146
        func._dbus_is_interface = True
1203
1147
        func._dbus_interface = dbus_interface
1204
1148
        func._dbus_name = dbus_interface
1205
1149
        return func
1206
 
 
 
1150
    
1207
1151
    return decorator
1208
1152
 
1209
1153
 
1210
1154
def dbus_annotations(annotations):
1211
1155
    """Decorator to annotate D-Bus methods, signals or properties
1212
1156
    Usage:
1213
 
 
 
1157
    
1214
1158
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1215
1159
                       "org.freedesktop.DBus.Property."
1216
1160
                       "EmitsChangedSignal": "false"})
1218
1162
                           access="r")
1219
1163
    def Property_dbus_property(self):
1220
1164
        return dbus.Boolean(False)
1221
 
 
 
1165
    
1222
1166
    See also the DBusObjectWithAnnotations class.
1223
1167
    """
1224
 
 
 
1168
    
1225
1169
    def decorator(func):
1226
1170
        func._dbus_annotations = annotations
1227
1171
        return func
1228
 
 
 
1172
    
1229
1173
    return decorator
1230
1174
 
1231
1175
 
1249
1193
 
1250
1194
class DBusObjectWithAnnotations(dbus.service.Object):
1251
1195
    """A D-Bus object with annotations.
1252
 
 
 
1196
    
1253
1197
    Classes inheriting from this can use the dbus_annotations
1254
1198
    decorator to add annotations to methods or signals.
1255
1199
    """
1256
 
 
 
1200
    
1257
1201
    @staticmethod
1258
1202
    def _is_dbus_thing(thing):
1259
1203
        """Returns a function testing if an attribute is a D-Bus thing
1260
 
 
 
1204
        
1261
1205
        If called like _is_dbus_thing("method") it returns a function
1262
1206
        suitable for use as predicate to inspect.getmembers().
1263
1207
        """
1264
1208
        return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1265
1209
                                   False)
1266
 
 
 
1210
    
1267
1211
    def _get_all_dbus_things(self, thing):
1268
1212
        """Returns a generator of (name, attribute) pairs
1269
1213
        """
1272
1216
                for cls in self.__class__.__mro__
1273
1217
                for name, athing in
1274
1218
                inspect.getmembers(cls, self._is_dbus_thing(thing)))
1275
 
 
 
1219
    
1276
1220
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1277
 
                         out_signature="s",
1278
 
                         path_keyword='object_path',
1279
 
                         connection_keyword='connection')
 
1221
                         out_signature = "s",
 
1222
                         path_keyword = 'object_path',
 
1223
                         connection_keyword = 'connection')
1280
1224
    def Introspect(self, object_path, connection):
1281
1225
        """Overloading of standard D-Bus method.
1282
 
 
 
1226
        
1283
1227
        Inserts annotation tags on methods and signals.
1284
1228
        """
1285
1229
        xmlstring = dbus.service.Object.Introspect(self, object_path,
1286
1230
                                                   connection)
1287
1231
        try:
1288
1232
            document = xml.dom.minidom.parseString(xmlstring)
1289
 
 
 
1233
            
1290
1234
            for if_tag in document.getElementsByTagName("interface"):
1291
1235
                # Add annotation tags
1292
1236
                for typ in ("method", "signal"):
1319
1263
                    if_tag.appendChild(ann_tag)
1320
1264
                # Fix argument name for the Introspect method itself
1321
1265
                if (if_tag.getAttribute("name")
1322
 
                    == dbus.INTROSPECTABLE_IFACE):
 
1266
                                == dbus.INTROSPECTABLE_IFACE):
1323
1267
                    for cn in if_tag.getElementsByTagName("method"):
1324
1268
                        if cn.getAttribute("name") == "Introspect":
1325
1269
                            for arg in cn.getElementsByTagName("arg"):
1338
1282
 
1339
1283
class DBusObjectWithProperties(DBusObjectWithAnnotations):
1340
1284
    """A D-Bus object with properties.
1341
 
 
 
1285
    
1342
1286
    Classes inheriting from this can use the dbus_service_property
1343
1287
    decorator to expose methods as D-Bus properties.  It exposes the
1344
1288
    standard Get(), Set(), and GetAll() methods on the D-Bus.
1345
1289
    """
1346
 
 
 
1290
    
1347
1291
    def _get_dbus_property(self, interface_name, property_name):
1348
1292
        """Returns a bound method if one exists which is a D-Bus
1349
1293
        property with the specified name and interface.
1354
1298
                if (value._dbus_name == property_name
1355
1299
                    and value._dbus_interface == interface_name):
1356
1300
                    return value.__get__(self)
1357
 
 
 
1301
        
1358
1302
        # No such property
1359
1303
        raise DBusPropertyNotFound("{}:{}.{}".format(
1360
1304
            self.dbus_object_path, interface_name, property_name))
1361
 
 
 
1305
    
1362
1306
    @classmethod
1363
1307
    def _get_all_interface_names(cls):
1364
1308
        """Get a sequence of all interfaces supported by an object"""
1367
1311
                                     for x in (inspect.getmro(cls))
1368
1312
                                     for attr in dir(x))
1369
1313
                if name is not None)
1370
 
 
 
1314
    
1371
1315
    @dbus.service.method(dbus.PROPERTIES_IFACE,
1372
1316
                         in_signature="ss",
1373
1317
                         out_signature="v")
1381
1325
        if not hasattr(value, "variant_level"):
1382
1326
            return value
1383
1327
        return type(value)(value, variant_level=value.variant_level+1)
1384
 
 
 
1328
    
1385
1329
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
1386
1330
    def Set(self, interface_name, property_name, value):
1387
1331
        """Standard D-Bus property Set() method, see D-Bus standard.
1399
1343
            value = dbus.ByteArray(b''.join(chr(byte)
1400
1344
                                            for byte in value))
1401
1345
        prop(value)
1402
 
 
 
1346
    
1403
1347
    @dbus.service.method(dbus.PROPERTIES_IFACE,
1404
1348
                         in_signature="s",
1405
1349
                         out_signature="a{sv}")
1406
1350
    def GetAll(self, interface_name):
1407
1351
        """Standard D-Bus property GetAll() method, see D-Bus
1408
1352
        standard.
1409
 
 
 
1353
        
1410
1354
        Note: Will not include properties with access="write".
1411
1355
        """
1412
1356
        properties = {}
1423
1367
                properties[name] = value
1424
1368
                continue
1425
1369
            properties[name] = type(value)(
1426
 
                value, variant_level=value.variant_level + 1)
 
1370
                value, variant_level = value.variant_level + 1)
1427
1371
        return dbus.Dictionary(properties, signature="sv")
1428
 
 
 
1372
    
1429
1373
    @dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1430
1374
    def PropertiesChanged(self, interface_name, changed_properties,
1431
1375
                          invalidated_properties):
1433
1377
        standard.
1434
1378
        """
1435
1379
        pass
1436
 
 
 
1380
    
1437
1381
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1438
1382
                         out_signature="s",
1439
1383
                         path_keyword='object_path',
1440
1384
                         connection_keyword='connection')
1441
1385
    def Introspect(self, object_path, connection):
1442
1386
        """Overloading of standard D-Bus method.
1443
 
 
 
1387
        
1444
1388
        Inserts property tags and interface annotation tags.
1445
1389
        """
1446
1390
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
1448
1392
                                                         connection)
1449
1393
        try:
1450
1394
            document = xml.dom.minidom.parseString(xmlstring)
1451
 
 
 
1395
            
1452
1396
            def make_tag(document, name, prop):
1453
1397
                e = document.createElement("property")
1454
1398
                e.setAttribute("name", name)
1455
1399
                e.setAttribute("type", prop._dbus_signature)
1456
1400
                e.setAttribute("access", prop._dbus_access)
1457
1401
                return e
1458
 
 
 
1402
            
1459
1403
            for if_tag in document.getElementsByTagName("interface"):
1460
1404
                # Add property tags
1461
1405
                for tag in (make_tag(document, name, prop)
1503
1447
                         exc_info=error)
1504
1448
        return xmlstring
1505
1449
 
1506
 
 
1507
1450
try:
1508
1451
    dbus.OBJECT_MANAGER_IFACE
1509
1452
except AttributeError:
1510
1453
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1511
1454
 
1512
 
 
1513
1455
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1514
1456
    """A D-Bus object with an ObjectManager.
1515
 
 
 
1457
    
1516
1458
    Classes inheriting from this exposes the standard
1517
1459
    GetManagedObjects call and the InterfacesAdded and
1518
1460
    InterfacesRemoved signals on the standard
1519
1461
    "org.freedesktop.DBus.ObjectManager" interface.
1520
 
 
 
1462
    
1521
1463
    Note: No signals are sent automatically; they must be sent
1522
1464
    manually.
1523
1465
    """
1524
1466
    @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1525
 
                         out_signature="a{oa{sa{sv}}}")
 
1467
                         out_signature = "a{oa{sa{sv}}}")
1526
1468
    def GetManagedObjects(self):
1527
1469
        """This function must be overridden"""
1528
1470
        raise NotImplementedError()
1529
 
 
 
1471
    
1530
1472
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1531
 
                         signature="oa{sa{sv}}")
 
1473
                         signature = "oa{sa{sv}}")
1532
1474
    def InterfacesAdded(self, object_path, interfaces_and_properties):
1533
1475
        pass
1534
 
 
1535
 
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
 
1476
    
 
1477
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature = "oas")
1536
1478
    def InterfacesRemoved(self, object_path, interfaces):
1537
1479
        pass
1538
 
 
 
1480
    
1539
1481
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1540
 
                         out_signature="s",
1541
 
                         path_keyword='object_path',
1542
 
                         connection_keyword='connection')
 
1482
                         out_signature = "s",
 
1483
                         path_keyword = 'object_path',
 
1484
                         connection_keyword = 'connection')
1543
1485
    def Introspect(self, object_path, connection):
1544
1486
        """Overloading of standard D-Bus method.
1545
 
 
 
1487
        
1546
1488
        Override return argument name of GetManagedObjects to be
1547
1489
        "objpath_interfaces_and_properties"
1548
1490
        """
1551
1493
                                                         connection)
1552
1494
        try:
1553
1495
            document = xml.dom.minidom.parseString(xmlstring)
1554
 
 
 
1496
            
1555
1497
            for if_tag in document.getElementsByTagName("interface"):
1556
1498
                # Fix argument name for the GetManagedObjects method
1557
1499
                if (if_tag.getAttribute("name")
1558
 
                    == dbus.OBJECT_MANAGER_IFACE):
 
1500
                                == dbus.OBJECT_MANAGER_IFACE):
1559
1501
                    for cn in if_tag.getElementsByTagName("method"):
1560
1502
                        if (cn.getAttribute("name")
1561
1503
                            == "GetManagedObjects"):
1571
1513
        except (AttributeError, xml.dom.DOMException,
1572
1514
                xml.parsers.expat.ExpatError) as error:
1573
1515
            logger.error("Failed to override Introspection method",
1574
 
                         exc_info=error)
 
1516
                         exc_info = error)
1575
1517
        return xmlstring
1576
1518
 
1577
 
 
1578
1519
def datetime_to_dbus(dt, variant_level=0):
1579
1520
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1580
1521
    if dt is None:
1581
 
        return dbus.String("", variant_level=variant_level)
 
1522
        return dbus.String("", variant_level = variant_level)
1582
1523
    return dbus.String(dt.isoformat(), variant_level=variant_level)
1583
1524
 
1584
1525
 
1587
1528
    dbus.service.Object, it will add alternate D-Bus attributes with
1588
1529
    interface names according to the "alt_interface_names" mapping.
1589
1530
    Usage:
1590
 
 
 
1531
    
1591
1532
    @alternate_dbus_interfaces({"org.example.Interface":
1592
1533
                                    "net.example.AlternateInterface"})
1593
1534
    class SampleDBusObject(dbus.service.Object):
1594
1535
        @dbus.service.method("org.example.Interface")
1595
1536
        def SampleDBusMethod():
1596
1537
            pass
1597
 
 
 
1538
    
1598
1539
    The above "SampleDBusMethod" on "SampleDBusObject" will be
1599
1540
    reachable via two interfaces: "org.example.Interface" and
1600
1541
    "net.example.AlternateInterface", the latter of which will have
1601
1542
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1602
1543
    "true", unless "deprecate" is passed with a False value.
1603
 
 
 
1544
    
1604
1545
    This works for methods and signals, and also for D-Bus properties
1605
1546
    (from DBusObjectWithProperties) and interfaces (from the
1606
1547
    dbus_interface_annotations decorator).
1607
1548
    """
1608
 
 
 
1549
    
1609
1550
    def wrapper(cls):
1610
1551
        for orig_interface_name, alt_interface_name in (
1611
1552
                alt_interface_names.items()):
1651
1592
                            attribute._dbus_annotations)
1652
1593
                    except AttributeError:
1653
1594
                        pass
1654
 
 
1655
1595
                    # Define a creator of a function to call both the
1656
1596
                    # original and alternate functions, so both the
1657
1597
                    # original and alternate signals gets sent when
1660
1600
                        """This function is a scope container to pass
1661
1601
                        func1 and func2 to the "call_both" function
1662
1602
                        outside of its arguments"""
1663
 
 
 
1603
                        
1664
1604
                        @functools.wraps(func2)
1665
1605
                        def call_both(*args, **kwargs):
1666
1606
                            """This function will emit two D-Bus
1667
1607
                            signals by calling func1 and func2"""
1668
1608
                            func1(*args, **kwargs)
1669
1609
                            func2(*args, **kwargs)
1670
 
                        # Make wrapper function look like a D-Bus
1671
 
                        # signal
 
1610
                        # Make wrapper function look like a D-Bus signal
1672
1611
                        for name, attr in inspect.getmembers(func2):
1673
1612
                            if name.startswith("_dbus_"):
1674
1613
                                setattr(call_both, name, attr)
1675
 
 
 
1614
                        
1676
1615
                        return call_both
1677
1616
                    # Create the "call_both" function and add it to
1678
1617
                    # the class
1724
1663
                        (copy_function(attribute)))
1725
1664
            if deprecate:
1726
1665
                # Deprecate all alternate interfaces
1727
 
                iname = "_AlternateDBusNames_interface_annotation{}"
 
1666
                iname="_AlternateDBusNames_interface_annotation{}"
1728
1667
                for interface_name in interface_names:
1729
 
 
 
1668
                    
1730
1669
                    @dbus_interface_annotations(interface_name)
1731
1670
                    def func(self):
1732
 
                        return {"org.freedesktop.DBus.Deprecated":
1733
 
                                "true"}
 
1671
                        return { "org.freedesktop.DBus.Deprecated":
 
1672
                                 "true" }
1734
1673
                    # Find an unused name
1735
1674
                    for aname in (iname.format(i)
1736
1675
                                  for i in itertools.count()):
1747
1686
                    cls = type("{}Alternate".format(cls.__name__),
1748
1687
                               (cls, ), attr)
1749
1688
        return cls
1750
 
 
 
1689
    
1751
1690
    return wrapper
1752
1691
 
1753
1692
 
1755
1694
                            "se.bsnet.fukt.Mandos"})
1756
1695
class ClientDBus(Client, DBusObjectWithProperties):
1757
1696
    """A Client class using D-Bus
1758
 
 
 
1697
    
1759
1698
    Attributes:
1760
1699
    dbus_object_path: dbus.ObjectPath
1761
1700
    bus: dbus.SystemBus()
1762
1701
    """
1763
 
 
 
1702
    
1764
1703
    runtime_expansions = (Client.runtime_expansions
1765
1704
                          + ("dbus_object_path", ))
1766
 
 
 
1705
    
1767
1706
    _interface = "se.recompile.Mandos.Client"
1768
 
 
 
1707
    
1769
1708
    # dbus.service.Object doesn't use super(), so we can't either.
1770
 
 
1771
 
    def __init__(self, bus=None, *args, **kwargs):
 
1709
    
 
1710
    def __init__(self, bus = None, *args, **kwargs):
1772
1711
        self.bus = bus
1773
1712
        Client.__init__(self, *args, **kwargs)
1774
1713
        # Only now, when this client is initialized, can it show up on
1780
1719
            "/clients/" + client_object_name)
1781
1720
        DBusObjectWithProperties.__init__(self, self.bus,
1782
1721
                                          self.dbus_object_path)
1783
 
 
 
1722
    
1784
1723
    def notifychangeproperty(transform_func, dbus_name,
1785
1724
                             type_func=lambda x: x,
1786
1725
                             variant_level=1,
1788
1727
                             _interface=_interface):
1789
1728
        """ Modify a variable so that it's a property which announces
1790
1729
        its changes to DBus.
1791
 
 
 
1730
        
1792
1731
        transform_fun: Function that takes a value and a variant_level
1793
1732
                       and transforms it to a D-Bus type.
1794
1733
        dbus_name: D-Bus name of the variable
1797
1736
        variant_level: D-Bus variant level.  Default: 1
1798
1737
        """
1799
1738
        attrname = "_{}".format(dbus_name)
1800
 
 
 
1739
        
1801
1740
        def setter(self, value):
1802
1741
            if hasattr(self, "dbus_object_path"):
1803
1742
                if (not hasattr(self, attrname) or
1810
1749
                    else:
1811
1750
                        dbus_value = transform_func(
1812
1751
                            type_func(value),
1813
 
                            variant_level=variant_level)
 
1752
                            variant_level = variant_level)
1814
1753
                        self.PropertyChanged(dbus.String(dbus_name),
1815
1754
                                             dbus_value)
1816
1755
                        self.PropertiesChanged(
1817
1756
                            _interface,
1818
 
                            dbus.Dictionary({dbus.String(dbus_name):
1819
 
                                             dbus_value}),
 
1757
                            dbus.Dictionary({ dbus.String(dbus_name):
 
1758
                                              dbus_value }),
1820
1759
                            dbus.Array())
1821
1760
            setattr(self, attrname, value)
1822
 
 
 
1761
        
1823
1762
        return property(lambda self: getattr(self, attrname), setter)
1824
 
 
 
1763
    
1825
1764
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1826
1765
    approvals_pending = notifychangeproperty(dbus.Boolean,
1827
1766
                                             "ApprovalPending",
1828
 
                                             type_func=bool)
 
1767
                                             type_func = bool)
1829
1768
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1830
1769
    last_enabled = notifychangeproperty(datetime_to_dbus,
1831
1770
                                        "LastEnabled")
1832
1771
    checker = notifychangeproperty(
1833
1772
        dbus.Boolean, "CheckerRunning",
1834
 
        type_func=lambda checker: checker is not None)
 
1773
        type_func = lambda checker: checker is not None)
1835
1774
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1836
1775
                                           "LastCheckedOK")
1837
1776
    last_checker_status = notifychangeproperty(dbus.Int16,
1842
1781
                                               "ApprovedByDefault")
1843
1782
    approval_delay = notifychangeproperty(
1844
1783
        dbus.UInt64, "ApprovalDelay",
1845
 
        type_func=lambda td: td.total_seconds() * 1000)
 
1784
        type_func = lambda td: td.total_seconds() * 1000)
1846
1785
    approval_duration = notifychangeproperty(
1847
1786
        dbus.UInt64, "ApprovalDuration",
1848
 
        type_func=lambda td: td.total_seconds() * 1000)
 
1787
        type_func = lambda td: td.total_seconds() * 1000)
1849
1788
    host = notifychangeproperty(dbus.String, "Host")
1850
1789
    timeout = notifychangeproperty(
1851
1790
        dbus.UInt64, "Timeout",
1852
 
        type_func=lambda td: td.total_seconds() * 1000)
 
1791
        type_func = lambda td: td.total_seconds() * 1000)
1853
1792
    extended_timeout = notifychangeproperty(
1854
1793
        dbus.UInt64, "ExtendedTimeout",
1855
 
        type_func=lambda td: td.total_seconds() * 1000)
 
1794
        type_func = lambda td: td.total_seconds() * 1000)
1856
1795
    interval = notifychangeproperty(
1857
1796
        dbus.UInt64, "Interval",
1858
 
        type_func=lambda td: td.total_seconds() * 1000)
 
1797
        type_func = lambda td: td.total_seconds() * 1000)
1859
1798
    checker_command = notifychangeproperty(dbus.String, "Checker")
1860
1799
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
1861
1800
                                  invalidate_only=True)
1862
 
 
 
1801
    
1863
1802
    del notifychangeproperty
1864
 
 
 
1803
    
1865
1804
    def __del__(self, *args, **kwargs):
1866
1805
        try:
1867
1806
            self.remove_from_connection()
1870
1809
        if hasattr(DBusObjectWithProperties, "__del__"):
1871
1810
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
1872
1811
        Client.__del__(self, *args, **kwargs)
1873
 
 
 
1812
    
1874
1813
    def checker_callback(self, source, condition,
1875
1814
                         connection, command, *args, **kwargs):
1876
1815
        ret = Client.checker_callback(self, source, condition,
1892
1831
                                      | self.last_checker_signal),
1893
1832
                                  dbus.String(command))
1894
1833
        return ret
1895
 
 
 
1834
    
1896
1835
    def start_checker(self, *args, **kwargs):
1897
1836
        old_checker_pid = getattr(self.checker, "pid", None)
1898
1837
        r = Client.start_checker(self, *args, **kwargs)
1902
1841
            # Emit D-Bus signal
1903
1842
            self.CheckerStarted(self.current_checker_command)
1904
1843
        return r
1905
 
 
 
1844
    
1906
1845
    def _reset_approved(self):
1907
1846
        self.approved = None
1908
1847
        return False
1909
 
 
 
1848
    
1910
1849
    def approve(self, value=True):
1911
1850
        self.approved = value
1912
1851
        GLib.timeout_add(int(self.approval_duration.total_seconds()
1913
1852
                             * 1000), self._reset_approved)
1914
1853
        self.send_changedstate()
1915
 
 
1916
 
    #  D-Bus methods, signals & properties
1917
 
 
1918
 
    #  Interfaces
1919
 
 
1920
 
    #  Signals
1921
 
 
 
1854
    
 
1855
    ## D-Bus methods, signals & properties
 
1856
    
 
1857
    ## Interfaces
 
1858
    
 
1859
    ## Signals
 
1860
    
1922
1861
    # CheckerCompleted - signal
1923
1862
    @dbus.service.signal(_interface, signature="nxs")
1924
1863
    def CheckerCompleted(self, exitcode, waitstatus, command):
1925
1864
        "D-Bus signal"
1926
1865
        pass
1927
 
 
 
1866
    
1928
1867
    # CheckerStarted - signal
1929
1868
    @dbus.service.signal(_interface, signature="s")
1930
1869
    def CheckerStarted(self, command):
1931
1870
        "D-Bus signal"
1932
1871
        pass
1933
 
 
 
1872
    
1934
1873
    # PropertyChanged - signal
1935
1874
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1936
1875
    @dbus.service.signal(_interface, signature="sv")
1937
1876
    def PropertyChanged(self, property, value):
1938
1877
        "D-Bus signal"
1939
1878
        pass
1940
 
 
 
1879
    
1941
1880
    # GotSecret - signal
1942
1881
    @dbus.service.signal(_interface)
1943
1882
    def GotSecret(self):
1946
1885
        server to mandos-client
1947
1886
        """
1948
1887
        pass
1949
 
 
 
1888
    
1950
1889
    # Rejected - signal
1951
1890
    @dbus.service.signal(_interface, signature="s")
1952
1891
    def Rejected(self, reason):
1953
1892
        "D-Bus signal"
1954
1893
        pass
1955
 
 
 
1894
    
1956
1895
    # NeedApproval - signal
1957
1896
    @dbus.service.signal(_interface, signature="tb")
1958
1897
    def NeedApproval(self, timeout, default):
1959
1898
        "D-Bus signal"
1960
1899
        return self.need_approval()
1961
 
 
1962
 
    #  Methods
1963
 
 
 
1900
    
 
1901
    ## Methods
 
1902
    
1964
1903
    # Approve - method
1965
1904
    @dbus.service.method(_interface, in_signature="b")
1966
1905
    def Approve(self, value):
1967
1906
        self.approve(value)
1968
 
 
 
1907
    
1969
1908
    # CheckedOK - method
1970
1909
    @dbus.service.method(_interface)
1971
1910
    def CheckedOK(self):
1972
1911
        self.checked_ok()
1973
 
 
 
1912
    
1974
1913
    # Enable - method
1975
1914
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1976
1915
    @dbus.service.method(_interface)
1977
1916
    def Enable(self):
1978
1917
        "D-Bus method"
1979
1918
        self.enable()
1980
 
 
 
1919
    
1981
1920
    # StartChecker - method
1982
1921
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1983
1922
    @dbus.service.method(_interface)
1984
1923
    def StartChecker(self):
1985
1924
        "D-Bus method"
1986
1925
        self.start_checker()
1987
 
 
 
1926
    
1988
1927
    # Disable - method
1989
1928
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1990
1929
    @dbus.service.method(_interface)
1991
1930
    def Disable(self):
1992
1931
        "D-Bus method"
1993
1932
        self.disable()
1994
 
 
 
1933
    
1995
1934
    # StopChecker - method
1996
1935
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1997
1936
    @dbus.service.method(_interface)
1998
1937
    def StopChecker(self):
1999
1938
        self.stop_checker()
2000
 
 
2001
 
    #  Properties
2002
 
 
 
1939
    
 
1940
    ## Properties
 
1941
    
2003
1942
    # ApprovalPending - property
2004
1943
    @dbus_service_property(_interface, signature="b", access="read")
2005
1944
    def ApprovalPending_dbus_property(self):
2006
1945
        return dbus.Boolean(bool(self.approvals_pending))
2007
 
 
 
1946
    
2008
1947
    # ApprovedByDefault - property
2009
1948
    @dbus_service_property(_interface,
2010
1949
                           signature="b",
2013
1952
        if value is None:       # get
2014
1953
            return dbus.Boolean(self.approved_by_default)
2015
1954
        self.approved_by_default = bool(value)
2016
 
 
 
1955
    
2017
1956
    # ApprovalDelay - property
2018
1957
    @dbus_service_property(_interface,
2019
1958
                           signature="t",
2023
1962
            return dbus.UInt64(self.approval_delay.total_seconds()
2024
1963
                               * 1000)
2025
1964
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
2026
 
 
 
1965
    
2027
1966
    # ApprovalDuration - property
2028
1967
    @dbus_service_property(_interface,
2029
1968
                           signature="t",
2033
1972
            return dbus.UInt64(self.approval_duration.total_seconds()
2034
1973
                               * 1000)
2035
1974
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
2036
 
 
 
1975
    
2037
1976
    # Name - property
2038
1977
    @dbus_annotations(
2039
1978
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2040
1979
    @dbus_service_property(_interface, signature="s", access="read")
2041
1980
    def Name_dbus_property(self):
2042
1981
        return dbus.String(self.name)
2043
 
 
2044
 
    # KeyID - property
2045
 
    @dbus_annotations(
2046
 
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2047
 
    @dbus_service_property(_interface, signature="s", access="read")
2048
 
    def KeyID_dbus_property(self):
2049
 
        return dbus.String(self.key_id)
2050
 
 
 
1982
    
2051
1983
    # Fingerprint - property
2052
1984
    @dbus_annotations(
2053
1985
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2054
1986
    @dbus_service_property(_interface, signature="s", access="read")
2055
1987
    def Fingerprint_dbus_property(self):
2056
1988
        return dbus.String(self.fingerprint)
2057
 
 
 
1989
    
2058
1990
    # Host - property
2059
1991
    @dbus_service_property(_interface,
2060
1992
                           signature="s",
2063
1995
        if value is None:       # get
2064
1996
            return dbus.String(self.host)
2065
1997
        self.host = str(value)
2066
 
 
 
1998
    
2067
1999
    # Created - property
2068
2000
    @dbus_annotations(
2069
2001
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2070
2002
    @dbus_service_property(_interface, signature="s", access="read")
2071
2003
    def Created_dbus_property(self):
2072
2004
        return datetime_to_dbus(self.created)
2073
 
 
 
2005
    
2074
2006
    # LastEnabled - property
2075
2007
    @dbus_service_property(_interface, signature="s", access="read")
2076
2008
    def LastEnabled_dbus_property(self):
2077
2009
        return datetime_to_dbus(self.last_enabled)
2078
 
 
 
2010
    
2079
2011
    # Enabled - property
2080
2012
    @dbus_service_property(_interface,
2081
2013
                           signature="b",
2087
2019
            self.enable()
2088
2020
        else:
2089
2021
            self.disable()
2090
 
 
 
2022
    
2091
2023
    # LastCheckedOK - property
2092
2024
    @dbus_service_property(_interface,
2093
2025
                           signature="s",
2097
2029
            self.checked_ok()
2098
2030
            return
2099
2031
        return datetime_to_dbus(self.last_checked_ok)
2100
 
 
 
2032
    
2101
2033
    # LastCheckerStatus - property
2102
2034
    @dbus_service_property(_interface, signature="n", access="read")
2103
2035
    def LastCheckerStatus_dbus_property(self):
2104
2036
        return dbus.Int16(self.last_checker_status)
2105
 
 
 
2037
    
2106
2038
    # Expires - property
2107
2039
    @dbus_service_property(_interface, signature="s", access="read")
2108
2040
    def Expires_dbus_property(self):
2109
2041
        return datetime_to_dbus(self.expires)
2110
 
 
 
2042
    
2111
2043
    # LastApprovalRequest - property
2112
2044
    @dbus_service_property(_interface, signature="s", access="read")
2113
2045
    def LastApprovalRequest_dbus_property(self):
2114
2046
        return datetime_to_dbus(self.last_approval_request)
2115
 
 
 
2047
    
2116
2048
    # Timeout - property
2117
2049
    @dbus_service_property(_interface,
2118
2050
                           signature="t",
2137
2069
                self.disable_initiator_tag = GLib.timeout_add(
2138
2070
                    int((self.expires - now).total_seconds() * 1000),
2139
2071
                    self.disable)
2140
 
 
 
2072
    
2141
2073
    # ExtendedTimeout - property
2142
2074
    @dbus_service_property(_interface,
2143
2075
                           signature="t",
2147
2079
            return dbus.UInt64(self.extended_timeout.total_seconds()
2148
2080
                               * 1000)
2149
2081
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2150
 
 
 
2082
    
2151
2083
    # Interval - property
2152
2084
    @dbus_service_property(_interface,
2153
2085
                           signature="t",
2163
2095
            GLib.source_remove(self.checker_initiator_tag)
2164
2096
            self.checker_initiator_tag = GLib.timeout_add(
2165
2097
                value, self.start_checker)
2166
 
            self.start_checker()  # Start one now, too
2167
 
 
 
2098
            self.start_checker() # Start one now, too
 
2099
    
2168
2100
    # Checker - property
2169
2101
    @dbus_service_property(_interface,
2170
2102
                           signature="s",
2173
2105
        if value is None:       # get
2174
2106
            return dbus.String(self.checker_command)
2175
2107
        self.checker_command = str(value)
2176
 
 
 
2108
    
2177
2109
    # CheckerRunning - property
2178
2110
    @dbus_service_property(_interface,
2179
2111
                           signature="b",
2185
2117
            self.start_checker()
2186
2118
        else:
2187
2119
            self.stop_checker()
2188
 
 
 
2120
    
2189
2121
    # ObjectPath - property
2190
2122
    @dbus_annotations(
2191
2123
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2192
2124
         "org.freedesktop.DBus.Deprecated": "true"})
2193
2125
    @dbus_service_property(_interface, signature="o", access="read")
2194
2126
    def ObjectPath_dbus_property(self):
2195
 
        return self.dbus_object_path  # is already a dbus.ObjectPath
2196
 
 
 
2127
        return self.dbus_object_path # is already a dbus.ObjectPath
 
2128
    
2197
2129
    # Secret = property
2198
2130
    @dbus_annotations(
2199
2131
        {"org.freedesktop.DBus.Property.EmitsChangedSignal":
2204
2136
                           byte_arrays=True)
2205
2137
    def Secret_dbus_property(self, value):
2206
2138
        self.secret = bytes(value)
2207
 
 
 
2139
    
2208
2140
    del _interface
2209
2141
 
2210
2142
 
2211
2143
class ProxyClient(object):
2212
 
    def __init__(self, child_pipe, key_id, fpr, address):
 
2144
    def __init__(self, child_pipe, fpr, address):
2213
2145
        self._pipe = child_pipe
2214
 
        self._pipe.send(('init', key_id, fpr, address))
 
2146
        self._pipe.send(('init', fpr, address))
2215
2147
        if not self._pipe.recv():
2216
 
            raise KeyError(key_id or fpr)
2217
 
 
 
2148
            raise KeyError(fpr)
 
2149
    
2218
2150
    def __getattribute__(self, name):
2219
2151
        if name == '_pipe':
2220
2152
            return super(ProxyClient, self).__getattribute__(name)
2223
2155
        if data[0] == 'data':
2224
2156
            return data[1]
2225
2157
        if data[0] == 'function':
2226
 
 
 
2158
            
2227
2159
            def func(*args, **kwargs):
2228
2160
                self._pipe.send(('funcall', name, args, kwargs))
2229
2161
                return self._pipe.recv()[1]
2230
 
 
 
2162
            
2231
2163
            return func
2232
 
 
 
2164
    
2233
2165
    def __setattr__(self, name, value):
2234
2166
        if name == '_pipe':
2235
2167
            return super(ProxyClient, self).__setattr__(name, value)
2238
2170
 
2239
2171
class ClientHandler(socketserver.BaseRequestHandler, object):
2240
2172
    """A class to handle client connections.
2241
 
 
 
2173
    
2242
2174
    Instantiated once for each connection to handle it.
2243
2175
    Note: This will run in its own forked process."""
2244
 
 
 
2176
    
2245
2177
    def handle(self):
2246
2178
        with contextlib.closing(self.server.child_pipe) as child_pipe:
2247
2179
            logger.info("TCP connection from: %s",
2248
2180
                        str(self.client_address))
2249
2181
            logger.debug("Pipe FD: %d",
2250
2182
                         self.server.child_pipe.fileno())
2251
 
 
 
2183
            
2252
2184
            session = gnutls.ClientSession(self.request)
2253
 
 
2254
 
            # priority = ':'.join(("NONE", "+VERS-TLS1.1",
2255
 
            #                       "+AES-256-CBC", "+SHA1",
2256
 
            #                       "+COMP-NULL", "+CTYPE-OPENPGP",
2257
 
            #                       "+DHE-DSS"))
 
2185
            
 
2186
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
 
2187
            #                      "+AES-256-CBC", "+SHA1",
 
2188
            #                      "+COMP-NULL", "+CTYPE-OPENPGP",
 
2189
            #                      "+DHE-DSS"))
2258
2190
            # Use a fallback default, since this MUST be set.
2259
2191
            priority = self.server.gnutls_priority
2260
2192
            if priority is None:
2262
2194
            gnutls.priority_set_direct(session._c_object,
2263
2195
                                       priority.encode("utf-8"),
2264
2196
                                       None)
2265
 
 
 
2197
            
2266
2198
            # Start communication using the Mandos protocol
2267
2199
            # Get protocol number
2268
2200
            line = self.request.makefile().readline()
2273
2205
            except (ValueError, IndexError, RuntimeError) as error:
2274
2206
                logger.error("Unknown protocol version: %s", error)
2275
2207
                return
2276
 
 
 
2208
            
2277
2209
            # Start GnuTLS connection
2278
2210
            try:
2279
2211
                session.handshake()
2283
2215
                # established.  Just abandon the request.
2284
2216
                return
2285
2217
            logger.debug("Handshake succeeded")
2286
 
 
 
2218
            
2287
2219
            approval_required = False
2288
2220
            try:
2289
 
                if gnutls.has_rawpk:
2290
 
                    fpr = ""
2291
 
                    try:
2292
 
                        key_id = self.key_id(
2293
 
                            self.peer_certificate(session))
2294
 
                    except (TypeError, gnutls.Error) as error:
2295
 
                        logger.warning("Bad certificate: %s", error)
2296
 
                        return
2297
 
                    logger.debug("Key ID: %s", key_id)
2298
 
 
2299
 
                else:
2300
 
                    key_id = ""
2301
 
                    try:
2302
 
                        fpr = self.fingerprint(
2303
 
                            self.peer_certificate(session))
2304
 
                    except (TypeError, gnutls.Error) as error:
2305
 
                        logger.warning("Bad certificate: %s", error)
2306
 
                        return
2307
 
                    logger.debug("Fingerprint: %s", fpr)
2308
 
 
2309
 
                try:
2310
 
                    client = ProxyClient(child_pipe, key_id, fpr,
 
2221
                try:
 
2222
                    fpr = self.fingerprint(
 
2223
                        self.peer_certificate(session))
 
2224
                except (TypeError, gnutls.Error) as error:
 
2225
                    logger.warning("Bad certificate: %s", error)
 
2226
                    return
 
2227
                logger.debug("Fingerprint: %s", fpr)
 
2228
                
 
2229
                try:
 
2230
                    client = ProxyClient(child_pipe, fpr,
2311
2231
                                         self.client_address)
2312
2232
                except KeyError:
2313
2233
                    return
2314
 
 
 
2234
                
2315
2235
                if client.approval_delay:
2316
2236
                    delay = client.approval_delay
2317
2237
                    client.approvals_pending += 1
2318
2238
                    approval_required = True
2319
 
 
 
2239
                
2320
2240
                while True:
2321
2241
                    if not client.enabled:
2322
2242
                        logger.info("Client %s is disabled",
2325
2245
                            # Emit D-Bus signal
2326
2246
                            client.Rejected("Disabled")
2327
2247
                        return
2328
 
 
 
2248
                    
2329
2249
                    if client.approved or not client.approval_delay:
2330
 
                        # We are approved or approval is disabled
 
2250
                        #We are approved or approval is disabled
2331
2251
                        break
2332
2252
                    elif client.approved is None:
2333
2253
                        logger.info("Client %s needs approval",
2344
2264
                            # Emit D-Bus signal
2345
2265
                            client.Rejected("Denied")
2346
2266
                        return
2347
 
 
2348
 
                    # wait until timeout or approved
 
2267
                    
 
2268
                    #wait until timeout or approved
2349
2269
                    time = datetime.datetime.now()
2350
2270
                    client.changedstate.acquire()
2351
2271
                    client.changedstate.wait(delay.total_seconds())
2364
2284
                            break
2365
2285
                    else:
2366
2286
                        delay -= time2 - time
2367
 
 
 
2287
                
2368
2288
                try:
2369
2289
                    session.send(client.secret)
2370
2290
                except gnutls.Error as error:
2371
2291
                    logger.warning("gnutls send failed",
2372
 
                                   exc_info=error)
 
2292
                                   exc_info = error)
2373
2293
                    return
2374
 
 
 
2294
                
2375
2295
                logger.info("Sending secret to %s", client.name)
2376
2296
                # bump the timeout using extended_timeout
2377
2297
                client.bump_timeout(client.extended_timeout)
2378
2298
                if self.server.use_dbus:
2379
2299
                    # Emit D-Bus signal
2380
2300
                    client.GotSecret()
2381
 
 
 
2301
            
2382
2302
            finally:
2383
2303
                if approval_required:
2384
2304
                    client.approvals_pending -= 1
2387
2307
                except gnutls.Error as error:
2388
2308
                    logger.warning("GnuTLS bye failed",
2389
2309
                                   exc_info=error)
2390
 
 
 
2310
    
2391
2311
    @staticmethod
2392
2312
    def peer_certificate(session):
2393
 
        "Return the peer's certificate as a bytestring"
2394
 
        try:
2395
 
            cert_type = gnutls.certificate_type_get2(session._c_object,
2396
 
                                                     gnutls.CTYPE_PEERS)
2397
 
        except AttributeError:
2398
 
            cert_type = gnutls.certificate_type_get(session._c_object)
2399
 
        if gnutls.has_rawpk:
2400
 
            valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2401
 
        else:
2402
 
            valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2403
 
        # If not a valid certificate type...
2404
 
        if cert_type not in valid_cert_types:
2405
 
            logger.info("Cert type %r not in %r", cert_type,
2406
 
                        valid_cert_types)
 
2313
        "Return the peer's OpenPGP certificate as a bytestring"
 
2314
        # If not an OpenPGP certificate...
 
2315
        if (gnutls.certificate_type_get(session._c_object)
 
2316
            != gnutls.CRT_OPENPGP):
2407
2317
            # ...return invalid data
2408
2318
            return b""
2409
2319
        list_size = ctypes.c_uint(1)
2415
2325
            return None
2416
2326
        cert = cert_list[0]
2417
2327
        return ctypes.string_at(cert.data, cert.size)
2418
 
 
2419
 
    @staticmethod
2420
 
    def key_id(certificate):
2421
 
        "Convert a certificate bytestring to a hexdigit key ID"
2422
 
        # New GnuTLS "datum" with the public key
2423
 
        datum = gnutls.datum_t(
2424
 
            ctypes.cast(ctypes.c_char_p(certificate),
2425
 
                        ctypes.POINTER(ctypes.c_ubyte)),
2426
 
            ctypes.c_uint(len(certificate)))
2427
 
        # XXX all these need to be created in the gnutls "module"
2428
 
        # New empty GnuTLS certificate
2429
 
        pubkey = gnutls.pubkey_t()
2430
 
        gnutls.pubkey_init(ctypes.byref(pubkey))
2431
 
        # Import the raw public key into the certificate
2432
 
        gnutls.pubkey_import(pubkey,
2433
 
                             ctypes.byref(datum),
2434
 
                             gnutls.X509_FMT_DER)
2435
 
        # New buffer for the key ID
2436
 
        buf = ctypes.create_string_buffer(32)
2437
 
        buf_len = ctypes.c_size_t(len(buf))
2438
 
        # Get the key ID from the raw public key into the buffer
2439
 
        gnutls.pubkey_get_key_id(pubkey,
2440
 
                                 gnutls.KEYID_USE_SHA256,
2441
 
                                 ctypes.cast(ctypes.byref(buf),
2442
 
                                             ctypes.POINTER(ctypes.c_ubyte)),
2443
 
                                 ctypes.byref(buf_len))
2444
 
        # Deinit the certificate
2445
 
        gnutls.pubkey_deinit(pubkey)
2446
 
 
2447
 
        # Convert the buffer to a Python bytestring
2448
 
        key_id = ctypes.string_at(buf, buf_len.value)
2449
 
        # Convert the bytestring to hexadecimal notation
2450
 
        hex_key_id = binascii.hexlify(key_id).upper()
2451
 
        return hex_key_id
2452
 
 
 
2328
    
2453
2329
    @staticmethod
2454
2330
    def fingerprint(openpgp):
2455
2331
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
2470
2346
                                       ctypes.byref(crtverify))
2471
2347
        if crtverify.value != 0:
2472
2348
            gnutls.openpgp_crt_deinit(crt)
2473
 
            raise gnutls.CertificateSecurityError(code
2474
 
                                                  =crtverify.value)
 
2349
            raise gnutls.CertificateSecurityError("Verify failed")
2475
2350
        # New buffer for the fingerprint
2476
2351
        buf = ctypes.create_string_buffer(20)
2477
2352
        buf_len = ctypes.c_size_t()
2489
2364
 
2490
2365
class MultiprocessingMixIn(object):
2491
2366
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
2492
 
 
 
2367
    
2493
2368
    def sub_process_main(self, request, address):
2494
2369
        try:
2495
2370
            self.finish_request(request, address)
2496
2371
        except Exception:
2497
2372
            self.handle_error(request, address)
2498
2373
        self.close_request(request)
2499
 
 
 
2374
    
2500
2375
    def process_request(self, request, address):
2501
2376
        """Start a new process to process the request."""
2502
 
        proc = multiprocessing.Process(target=self.sub_process_main,
2503
 
                                       args=(request, address))
 
2377
        proc = multiprocessing.Process(target = self.sub_process_main,
 
2378
                                       args = (request, address))
2504
2379
        proc.start()
2505
2380
        return proc
2506
2381
 
2507
2382
 
2508
2383
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2509
2384
    """ adds a pipe to the MixIn """
2510
 
 
 
2385
    
2511
2386
    def process_request(self, request, client_address):
2512
2387
        """Overrides and wraps the original process_request().
2513
 
 
 
2388
        
2514
2389
        This function creates a new pipe in self.pipe
2515
2390
        """
2516
2391
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
2517
 
 
 
2392
        
2518
2393
        proc = MultiprocessingMixIn.process_request(self, request,
2519
2394
                                                    client_address)
2520
2395
        self.child_pipe.close()
2521
2396
        self.add_pipe(parent_pipe, proc)
2522
 
 
 
2397
    
2523
2398
    def add_pipe(self, parent_pipe, proc):
2524
2399
        """Dummy function; override as necessary"""
2525
2400
        raise NotImplementedError()
2528
2403
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2529
2404
                     socketserver.TCPServer, object):
2530
2405
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
2531
 
 
 
2406
    
2532
2407
    Attributes:
2533
2408
        enabled:        Boolean; whether this server is activated yet
2534
2409
        interface:      None or a network interface name (string)
2535
2410
        use_ipv6:       Boolean; to use IPv6 or not
2536
2411
    """
2537
 
 
 
2412
    
2538
2413
    def __init__(self, server_address, RequestHandlerClass,
2539
2414
                 interface=None,
2540
2415
                 use_ipv6=True,
2550
2425
            self.socketfd = socketfd
2551
2426
            # Save the original socket.socket() function
2552
2427
            self.socket_socket = socket.socket
2553
 
 
2554
2428
            # To implement --socket, we monkey patch socket.socket.
2555
 
            #
 
2429
            # 
2556
2430
            # (When socketserver.TCPServer is a new-style class, we
2557
2431
            # could make self.socket into a property instead of monkey
2558
2432
            # patching socket.socket.)
2559
 
            #
 
2433
            # 
2560
2434
            # Create a one-time-only replacement for socket.socket()
2561
2435
            @functools.wraps(socket.socket)
2562
2436
            def socket_wrapper(*args, **kwargs):
2574
2448
        # socket_wrapper(), if socketfd was set.
2575
2449
        socketserver.TCPServer.__init__(self, server_address,
2576
2450
                                        RequestHandlerClass)
2577
 
 
 
2451
    
2578
2452
    def server_bind(self):
2579
2453
        """This overrides the normal server_bind() function
2580
2454
        to bind to an interface if one was specified, and also NOT to
2607
2481
        if self.server_address[0] or self.server_address[1]:
2608
2482
            if not self.server_address[0]:
2609
2483
                if self.address_family == socket.AF_INET6:
2610
 
                    any_address = "::"  # in6addr_any
 
2484
                    any_address = "::" # in6addr_any
2611
2485
                else:
2612
 
                    any_address = "0.0.0.0"  # INADDR_ANY
 
2486
                    any_address = "0.0.0.0" # INADDR_ANY
2613
2487
                self.server_address = (any_address,
2614
2488
                                       self.server_address[1])
2615
2489
            elif not self.server_address[1]:
2625
2499
 
2626
2500
class MandosServer(IPv6_TCPServer):
2627
2501
    """Mandos server.
2628
 
 
 
2502
    
2629
2503
    Attributes:
2630
2504
        clients:        set of Client objects
2631
2505
        gnutls_priority GnuTLS priority string
2632
2506
        use_dbus:       Boolean; to emit D-Bus signals or not
2633
 
 
 
2507
    
2634
2508
    Assumes a GLib.MainLoop event loop.
2635
2509
    """
2636
 
 
 
2510
    
2637
2511
    def __init__(self, server_address, RequestHandlerClass,
2638
2512
                 interface=None,
2639
2513
                 use_ipv6=True,
2649
2523
        self.gnutls_priority = gnutls_priority
2650
2524
        IPv6_TCPServer.__init__(self, server_address,
2651
2525
                                RequestHandlerClass,
2652
 
                                interface=interface,
2653
 
                                use_ipv6=use_ipv6,
2654
 
                                socketfd=socketfd)
2655
 
 
 
2526
                                interface = interface,
 
2527
                                use_ipv6 = use_ipv6,
 
2528
                                socketfd = socketfd)
 
2529
    
2656
2530
    def server_activate(self):
2657
2531
        if self.enabled:
2658
2532
            return socketserver.TCPServer.server_activate(self)
2659
 
 
 
2533
    
2660
2534
    def enable(self):
2661
2535
        self.enabled = True
2662
 
 
 
2536
    
2663
2537
    def add_pipe(self, parent_pipe, proc):
2664
2538
        # Call "handle_ipc" for both data and EOF events
2665
2539
        GLib.io_add_watch(
2666
2540
            parent_pipe.fileno(),
2667
2541
            GLib.IO_IN | GLib.IO_HUP,
2668
2542
            functools.partial(self.handle_ipc,
2669
 
                              parent_pipe=parent_pipe,
2670
 
                              proc=proc))
2671
 
 
 
2543
                              parent_pipe = parent_pipe,
 
2544
                              proc = proc))
 
2545
    
2672
2546
    def handle_ipc(self, source, condition,
2673
2547
                   parent_pipe=None,
2674
 
                   proc=None,
 
2548
                   proc = None,
2675
2549
                   client_object=None):
2676
2550
        # error, or the other end of multiprocessing.Pipe has closed
2677
2551
        if condition & (GLib.IO_ERR | GLib.IO_HUP):
2678
2552
            # Wait for other process to exit
2679
2553
            proc.join()
2680
2554
            return False
2681
 
 
 
2555
        
2682
2556
        # Read a request from the child
2683
2557
        request = parent_pipe.recv()
2684
2558
        command = request[0]
2685
 
 
 
2559
        
2686
2560
        if command == 'init':
2687
 
            key_id = request[1].decode("ascii")
2688
 
            fpr = request[2].decode("ascii")
2689
 
            address = request[3]
2690
 
 
 
2561
            fpr = request[1]
 
2562
            address = request[2]
 
2563
            
2691
2564
            for c in self.clients.values():
2692
 
                if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":
2693
 
                    continue
2694
 
                if key_id and c.key_id == key_id:
2695
 
                    client = c
2696
 
                    break
2697
 
                if fpr and c.fingerprint == fpr:
 
2565
                if c.fingerprint == fpr:
2698
2566
                    client = c
2699
2567
                    break
2700
2568
            else:
2701
 
                logger.info("Client not found for key ID: %s, address"
2702
 
                            ": %s", key_id or fpr, address)
 
2569
                logger.info("Client not found for fingerprint: %s, ad"
 
2570
                            "dress: %s", fpr, address)
2703
2571
                if self.use_dbus:
2704
2572
                    # Emit D-Bus signal
2705
 
                    mandos_dbus_service.ClientNotFound(key_id or fpr,
 
2573
                    mandos_dbus_service.ClientNotFound(fpr,
2706
2574
                                                       address[0])
2707
2575
                parent_pipe.send(False)
2708
2576
                return False
2709
 
 
 
2577
            
2710
2578
            GLib.io_add_watch(
2711
2579
                parent_pipe.fileno(),
2712
2580
                GLib.IO_IN | GLib.IO_HUP,
2713
2581
                functools.partial(self.handle_ipc,
2714
 
                                  parent_pipe=parent_pipe,
2715
 
                                  proc=proc,
2716
 
                                  client_object=client))
 
2582
                                  parent_pipe = parent_pipe,
 
2583
                                  proc = proc,
 
2584
                                  client_object = client))
2717
2585
            parent_pipe.send(True)
2718
2586
            # remove the old hook in favor of the new above hook on
2719
2587
            # same fileno
2722
2590
            funcname = request[1]
2723
2591
            args = request[2]
2724
2592
            kwargs = request[3]
2725
 
 
 
2593
            
2726
2594
            parent_pipe.send(('data', getattr(client_object,
2727
2595
                                              funcname)(*args,
2728
2596
                                                        **kwargs)))
2729
 
 
 
2597
        
2730
2598
        if command == 'getattr':
2731
2599
            attrname = request[1]
2732
2600
            if isinstance(client_object.__getattribute__(attrname),
2735
2603
            else:
2736
2604
                parent_pipe.send((
2737
2605
                    'data', client_object.__getattribute__(attrname)))
2738
 
 
 
2606
        
2739
2607
        if command == 'setattr':
2740
2608
            attrname = request[1]
2741
2609
            value = request[2]
2742
2610
            setattr(client_object, attrname, value)
2743
 
 
 
2611
        
2744
2612
        return True
2745
2613
 
2746
2614
 
2747
2615
def rfc3339_duration_to_delta(duration):
2748
2616
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2749
 
 
 
2617
    
2750
2618
    >>> rfc3339_duration_to_delta("P7D")
2751
2619
    datetime.timedelta(7)
2752
2620
    >>> rfc3339_duration_to_delta("PT60S")
2762
2630
    >>> rfc3339_duration_to_delta("P1DT3M20S")
2763
2631
    datetime.timedelta(1, 200)
2764
2632
    """
2765
 
 
 
2633
    
2766
2634
    # Parsing an RFC 3339 duration with regular expressions is not
2767
2635
    # possible - there would have to be multiple places for the same
2768
2636
    # values, like seconds.  The current code, while more esoteric, is
2769
2637
    # cleaner without depending on a parsing library.  If Python had a
2770
2638
    # built-in library for parsing we would use it, but we'd like to
2771
2639
    # avoid excessive use of external libraries.
2772
 
 
 
2640
    
2773
2641
    # New type for defining tokens, syntax, and semantics all-in-one
2774
2642
    Token = collections.namedtuple("Token", (
2775
2643
        "regexp",  # To match token; if "value" is not None, must have
2808
2676
                           frozenset((token_year, token_month,
2809
2677
                                      token_day, token_time,
2810
2678
                                      token_week)))
2811
 
    # Define starting values:
2812
 
    # Value so far
2813
 
    value = datetime.timedelta()
 
2679
    # Define starting values
 
2680
    value = datetime.timedelta() # Value so far
2814
2681
    found_token = None
2815
 
    # Following valid tokens
2816
 
    followers = frozenset((token_duration, ))
2817
 
    # String left to parse
2818
 
    s = duration
 
2682
    followers = frozenset((token_duration, )) # Following valid tokens
 
2683
    s = duration                # String left to parse
2819
2684
    # Loop until end token is found
2820
2685
    while found_token is not token_end:
2821
2686
        # Search for any currently valid tokens
2845
2710
 
2846
2711
def string_to_delta(interval):
2847
2712
    """Parse a string and return a datetime.timedelta
2848
 
 
 
2713
    
2849
2714
    >>> string_to_delta('7d')
2850
2715
    datetime.timedelta(7)
2851
2716
    >>> string_to_delta('60s')
2859
2724
    >>> string_to_delta('5m 30s')
2860
2725
    datetime.timedelta(0, 330)
2861
2726
    """
2862
 
 
 
2727
    
2863
2728
    try:
2864
2729
        return rfc3339_duration_to_delta(interval)
2865
2730
    except ValueError:
2866
2731
        pass
2867
 
 
 
2732
    
2868
2733
    timevalue = datetime.timedelta(0)
2869
2734
    for s in interval.split():
2870
2735
        try:
2888
2753
    return timevalue
2889
2754
 
2890
2755
 
2891
 
def daemon(nochdir=False, noclose=False):
 
2756
def daemon(nochdir = False, noclose = False):
2892
2757
    """See daemon(3).  Standard BSD Unix function.
2893
 
 
 
2758
    
2894
2759
    This should really exist as os.daemon, but it doesn't (yet)."""
2895
2760
    if os.fork():
2896
2761
        sys.exit()
2914
2779
 
2915
2780
 
2916
2781
def main():
2917
 
 
 
2782
    
2918
2783
    ##################################################################
2919
2784
    # Parsing of options, both command line and config file
2920
 
 
 
2785
    
2921
2786
    parser = argparse.ArgumentParser()
2922
2787
    parser.add_argument("-v", "--version", action="version",
2923
 
                        version="%(prog)s {}".format(version),
 
2788
                        version = "%(prog)s {}".format(version),
2924
2789
                        help="show version number and exit")
2925
2790
    parser.add_argument("-i", "--interface", metavar="IF",
2926
2791
                        help="Bind to interface IF")
2962
2827
    parser.add_argument("--no-zeroconf", action="store_false",
2963
2828
                        dest="zeroconf", help="Do not use Zeroconf",
2964
2829
                        default=None)
2965
 
 
 
2830
    
2966
2831
    options = parser.parse_args()
2967
 
 
 
2832
    
2968
2833
    if options.check:
2969
2834
        import doctest
2970
2835
        fail_count, test_count = doctest.testmod()
2971
2836
        sys.exit(os.EX_OK if fail_count == 0 else 1)
2972
 
 
 
2837
    
2973
2838
    # Default values for config file for server-global settings
2974
 
    if gnutls.has_rawpk:
2975
 
        priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
2976
 
                    ":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
2977
 
    else:
2978
 
        priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2979
 
                    ":+SIGN-DSA-SHA256")
2980
 
    server_defaults = {"interface": "",
2981
 
                       "address": "",
2982
 
                       "port": "",
2983
 
                       "debug": "False",
2984
 
                       "priority": priority,
2985
 
                       "servicename": "Mandos",
2986
 
                       "use_dbus": "True",
2987
 
                       "use_ipv6": "True",
2988
 
                       "debuglevel": "",
2989
 
                       "restore": "True",
2990
 
                       "socket": "",
2991
 
                       "statedir": "/var/lib/mandos",
2992
 
                       "foreground": "False",
2993
 
                       "zeroconf": "True",
2994
 
                       }
2995
 
    del priority
2996
 
 
 
2839
    server_defaults = { "interface": "",
 
2840
                        "address": "",
 
2841
                        "port": "",
 
2842
                        "debug": "False",
 
2843
                        "priority":
 
2844
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
 
2845
                        ":+SIGN-DSA-SHA256",
 
2846
                        "servicename": "Mandos",
 
2847
                        "use_dbus": "True",
 
2848
                        "use_ipv6": "True",
 
2849
                        "debuglevel": "",
 
2850
                        "restore": "True",
 
2851
                        "socket": "",
 
2852
                        "statedir": "/var/lib/mandos",
 
2853
                        "foreground": "False",
 
2854
                        "zeroconf": "True",
 
2855
                    }
 
2856
    
2997
2857
    # Parse config file for server-global settings
2998
2858
    server_config = configparser.SafeConfigParser(server_defaults)
2999
2859
    del server_defaults
3001
2861
    # Convert the SafeConfigParser object to a dict
3002
2862
    server_settings = server_config.defaults()
3003
2863
    # Use the appropriate methods on the non-string config options
3004
 
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
3005
 
                   "foreground", "zeroconf"):
 
2864
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
3006
2865
        server_settings[option] = server_config.getboolean("DEFAULT",
3007
2866
                                                           option)
3008
2867
    if server_settings["port"]:
3018
2877
            server_settings["socket"] = os.dup(server_settings
3019
2878
                                               ["socket"])
3020
2879
    del server_config
3021
 
 
 
2880
    
3022
2881
    # Override the settings from the config file with command line
3023
2882
    # options, if set.
3024
2883
    for option in ("interface", "address", "port", "debug",
3042
2901
    if server_settings["debug"]:
3043
2902
        server_settings["foreground"] = True
3044
2903
    # Now we have our good server settings in "server_settings"
3045
 
 
 
2904
    
3046
2905
    ##################################################################
3047
 
 
 
2906
    
3048
2907
    if (not server_settings["zeroconf"]
3049
2908
        and not (server_settings["port"]
3050
2909
                 or server_settings["socket"] != "")):
3051
2910
        parser.error("Needs port or socket to work without Zeroconf")
3052
 
 
 
2911
    
3053
2912
    # For convenience
3054
2913
    debug = server_settings["debug"]
3055
2914
    debuglevel = server_settings["debuglevel"]
3059
2918
                                     stored_state_file)
3060
2919
    foreground = server_settings["foreground"]
3061
2920
    zeroconf = server_settings["zeroconf"]
3062
 
 
 
2921
    
3063
2922
    if debug:
3064
2923
        initlogger(debug, logging.DEBUG)
3065
2924
    else:
3068
2927
        else:
3069
2928
            level = getattr(logging, debuglevel.upper())
3070
2929
            initlogger(debug, level)
3071
 
 
 
2930
    
3072
2931
    if server_settings["servicename"] != "Mandos":
3073
2932
        syslogger.setFormatter(
3074
2933
            logging.Formatter('Mandos ({}) [%(process)d]:'
3075
2934
                              ' %(levelname)s: %(message)s'.format(
3076
2935
                                  server_settings["servicename"])))
3077
 
 
 
2936
    
3078
2937
    # Parse config file with clients
3079
2938
    client_config = configparser.SafeConfigParser(Client
3080
2939
                                                  .client_defaults)
3081
2940
    client_config.read(os.path.join(server_settings["configdir"],
3082
2941
                                    "clients.conf"))
3083
 
 
 
2942
    
3084
2943
    global mandos_dbus_service
3085
2944
    mandos_dbus_service = None
3086
 
 
 
2945
    
3087
2946
    socketfd = None
3088
2947
    if server_settings["socket"] != "":
3089
2948
        socketfd = server_settings["socket"]
3105
2964
        except IOError as e:
3106
2965
            logger.error("Could not open file %r", pidfilename,
3107
2966
                         exc_info=e)
3108
 
 
 
2967
    
3109
2968
    for name, group in (("_mandos", "_mandos"),
3110
2969
                        ("mandos", "mandos"),
3111
2970
                        ("nobody", "nogroup")):
3129
2988
                       .format(uid, gid, os.strerror(error.errno)))
3130
2989
        if error.errno != errno.EPERM:
3131
2990
            raise
3132
 
 
 
2991
    
3133
2992
    if debug:
3134
2993
        # Enable all possible GnuTLS debugging
3135
 
 
 
2994
        
3136
2995
        # "Use a log level over 10 to enable all debugging options."
3137
2996
        # - GnuTLS manual
3138
2997
        gnutls.global_set_log_level(11)
3139
 
 
 
2998
        
3140
2999
        @gnutls.log_func
3141
3000
        def debug_gnutls(level, string):
3142
3001
            logger.debug("GnuTLS: %s", string[:-1])
3143
 
 
 
3002
        
3144
3003
        gnutls.global_set_log_function(debug_gnutls)
3145
 
 
 
3004
        
3146
3005
        # Redirect stdin so all checkers get /dev/null
3147
3006
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
3148
3007
        os.dup2(null, sys.stdin.fileno())
3149
3008
        if null > 2:
3150
3009
            os.close(null)
3151
 
 
 
3010
    
3152
3011
    # Need to fork before connecting to D-Bus
3153
3012
    if not foreground:
3154
3013
        # Close all input and output, do double fork, etc.
3155
3014
        daemon()
3156
 
 
 
3015
    
3157
3016
    # multiprocessing will use threads, so before we use GLib we need
3158
3017
    # to inform GLib that threads will be used.
3159
3018
    GLib.threads_init()
3160
 
 
 
3019
    
3161
3020
    global main_loop
3162
3021
    # From the Avahi example code
3163
3022
    DBusGMainLoop(set_as_default=True)
3180
3039
    if zeroconf:
3181
3040
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3182
3041
        service = AvahiServiceToSyslog(
3183
 
            name=server_settings["servicename"],
3184
 
            servicetype="_mandos._tcp",
3185
 
            protocol=protocol,
3186
 
            bus=bus)
 
3042
            name = server_settings["servicename"],
 
3043
            servicetype = "_mandos._tcp",
 
3044
            protocol = protocol,
 
3045
            bus = bus)
3187
3046
        if server_settings["interface"]:
3188
3047
            service.interface = if_nametoindex(
3189
3048
                server_settings["interface"].encode("utf-8"))
3190
 
 
 
3049
    
3191
3050
    global multiprocessing_manager
3192
3051
    multiprocessing_manager = multiprocessing.Manager()
3193
 
 
 
3052
    
3194
3053
    client_class = Client
3195
3054
    if use_dbus:
3196
 
        client_class = functools.partial(ClientDBus, bus=bus)
3197
 
 
 
3055
        client_class = functools.partial(ClientDBus, bus = bus)
 
3056
    
3198
3057
    client_settings = Client.config_parser(client_config)
3199
3058
    old_client_settings = {}
3200
3059
    clients_data = {}
3201
 
 
 
3060
    
3202
3061
    # This is used to redirect stdout and stderr for checker processes
3203
3062
    global wnull
3204
 
    wnull = open(os.devnull, "w")  # A writable /dev/null
 
3063
    wnull = open(os.devnull, "w") # A writable /dev/null
3205
3064
    # Only used if server is running in foreground but not in debug
3206
3065
    # mode
3207
3066
    if debug or not foreground:
3208
3067
        wnull.close()
3209
 
 
 
3068
    
3210
3069
    # Get client data and settings from last running state.
3211
3070
    if server_settings["restore"]:
3212
3071
        try:
3213
3072
            with open(stored_state_path, "rb") as stored_state:
3214
 
                if sys.version_info.major == 2:
 
3073
                if sys.version_info.major == 2:                
3215
3074
                    clients_data, old_client_settings = pickle.load(
3216
3075
                        stored_state)
3217
3076
                else:
3218
3077
                    bytes_clients_data, bytes_old_client_settings = (
3219
 
                        pickle.load(stored_state, encoding="bytes"))
3220
 
                    #   Fix bytes to strings
3221
 
                    #  clients_data
 
3078
                        pickle.load(stored_state, encoding = "bytes"))
 
3079
                    ### Fix bytes to strings
 
3080
                    ## clients_data
3222
3081
                    # .keys()
3223
 
                    clients_data = {(key.decode("utf-8")
3224
 
                                     if isinstance(key, bytes)
3225
 
                                     else key): value
3226
 
                                    for key, value in
3227
 
                                    bytes_clients_data.items()}
 
3082
                    clients_data = { (key.decode("utf-8")
 
3083
                                      if isinstance(key, bytes)
 
3084
                                      else key): value
 
3085
                                     for key, value in
 
3086
                                     bytes_clients_data.items() }
3228
3087
                    del bytes_clients_data
3229
3088
                    for key in clients_data:
3230
 
                        value = {(k.decode("utf-8")
3231
 
                                  if isinstance(k, bytes) else k): v
3232
 
                                 for k, v in
3233
 
                                 clients_data[key].items()}
 
3089
                        value = { (k.decode("utf-8")
 
3090
                                   if isinstance(k, bytes) else k): v
 
3091
                                  for k, v in
 
3092
                                  clients_data[key].items() }
3234
3093
                        clients_data[key] = value
3235
3094
                        # .client_structure
3236
3095
                        value["client_structure"] = [
3237
3096
                            (s.decode("utf-8")
3238
3097
                             if isinstance(s, bytes)
3239
3098
                             else s) for s in
3240
 
                            value["client_structure"]]
 
3099
                            value["client_structure"] ]
3241
3100
                        # .name & .host
3242
3101
                        for k in ("name", "host"):
3243
3102
                            if isinstance(value[k], bytes):
3244
3103
                                value[k] = value[k].decode("utf-8")
3245
 
                        if not value.has_key("key_id"):
3246
 
                            value["key_id"] = ""
3247
 
                        elif not value.has_key("fingerprint"):
3248
 
                            value["fingerprint"] = ""
3249
 
                    #  old_client_settings
 
3104
                    ## old_client_settings
3250
3105
                    # .keys()
3251
3106
                    old_client_settings = {
3252
3107
                        (key.decode("utf-8")
3253
3108
                         if isinstance(key, bytes)
3254
3109
                         else key): value
3255
3110
                        for key, value in
3256
 
                        bytes_old_client_settings.items()}
 
3111
                        bytes_old_client_settings.items() }
3257
3112
                    del bytes_old_client_settings
3258
3113
                    # .host
3259
3114
                    for value in old_client_settings.values():
3273
3128
            logger.warning("Could not load persistent state: "
3274
3129
                           "EOFError:",
3275
3130
                           exc_info=e)
3276
 
 
 
3131
    
3277
3132
    with PGPEngine() as pgp:
3278
3133
        for client_name, client in clients_data.items():
3279
3134
            # Skip removed clients
3280
3135
            if client_name not in client_settings:
3281
3136
                continue
3282
 
 
 
3137
            
3283
3138
            # Decide which value to use after restoring saved state.
3284
3139
            # We have three different values: Old config file,
3285
3140
            # new config file, and saved state.
3296
3151
                        client[name] = value
3297
3152
                except KeyError:
3298
3153
                    pass
3299
 
 
 
3154
            
3300
3155
            # Clients who has passed its expire date can still be
3301
3156
            # enabled if its last checker was successful.  A Client
3302
3157
            # whose checker succeeded before we stored its state is
3335
3190
                    client_name))
3336
3191
                client["secret"] = (client_settings[client_name]
3337
3192
                                    ["secret"])
3338
 
 
 
3193
    
3339
3194
    # Add/remove clients based on new changes made to config
3340
3195
    for client_name in (set(old_client_settings)
3341
3196
                        - set(client_settings)):
3343
3198
    for client_name in (set(client_settings)
3344
3199
                        - set(old_client_settings)):
3345
3200
        clients_data[client_name] = client_settings[client_name]
3346
 
 
 
3201
    
3347
3202
    # Create all client objects
3348
3203
    for client_name, client in clients_data.items():
3349
3204
        tcp_server.clients[client_name] = client_class(
3350
 
            name=client_name,
3351
 
            settings=client,
3352
 
            server_settings=server_settings)
3353
 
 
 
3205
            name = client_name,
 
3206
            settings = client,
 
3207
            server_settings = server_settings)
 
3208
    
3354
3209
    if not tcp_server.clients:
3355
3210
        logger.warning("No clients defined")
3356
 
 
 
3211
    
3357
3212
    if not foreground:
3358
3213
        if pidfile is not None:
3359
3214
            pid = os.getpid()
3365
3220
                             pidfilename, pid)
3366
3221
        del pidfile
3367
3222
        del pidfilename
3368
 
 
 
3223
    
3369
3224
    for termsig in (signal.SIGHUP, signal.SIGTERM):
3370
3225
        GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3371
3226
                             lambda: main_loop.quit() and False)
3372
 
 
 
3227
    
3373
3228
    if use_dbus:
3374
 
 
 
3229
        
3375
3230
        @alternate_dbus_interfaces(
3376
 
            {"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
 
3231
            { "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
3377
3232
        class MandosDBusService(DBusObjectWithObjectManager):
3378
3233
            """A D-Bus proxy object"""
3379
 
 
 
3234
            
3380
3235
            def __init__(self):
3381
3236
                dbus.service.Object.__init__(self, bus, "/")
3382
 
 
 
3237
            
3383
3238
            _interface = "se.recompile.Mandos"
3384
 
 
 
3239
            
3385
3240
            @dbus.service.signal(_interface, signature="o")
3386
3241
            def ClientAdded(self, objpath):
3387
3242
                "D-Bus signal"
3388
3243
                pass
3389
 
 
 
3244
            
3390
3245
            @dbus.service.signal(_interface, signature="ss")
3391
 
            def ClientNotFound(self, key_id, address):
 
3246
            def ClientNotFound(self, fingerprint, address):
3392
3247
                "D-Bus signal"
3393
3248
                pass
3394
 
 
 
3249
            
3395
3250
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
3396
3251
                               "true"})
3397
3252
            @dbus.service.signal(_interface, signature="os")
3398
3253
            def ClientRemoved(self, objpath, name):
3399
3254
                "D-Bus signal"
3400
3255
                pass
3401
 
 
 
3256
            
3402
3257
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
3403
3258
                               "true"})
3404
3259
            @dbus.service.method(_interface, out_signature="ao")
3406
3261
                "D-Bus method"
3407
3262
                return dbus.Array(c.dbus_object_path for c in
3408
3263
                                  tcp_server.clients.values())
3409
 
 
 
3264
            
3410
3265
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
3411
3266
                               "true"})
3412
3267
            @dbus.service.method(_interface,
3414
3269
            def GetAllClientsWithProperties(self):
3415
3270
                "D-Bus method"
3416
3271
                return dbus.Dictionary(
3417
 
                    {c.dbus_object_path: c.GetAll(
 
3272
                    { c.dbus_object_path: c.GetAll(
3418
3273
                        "se.recompile.Mandos.Client")
3419
 
                     for c in tcp_server.clients.values()},
 
3274
                      for c in tcp_server.clients.values() },
3420
3275
                    signature="oa{sv}")
3421
 
 
 
3276
            
3422
3277
            @dbus.service.method(_interface, in_signature="o")
3423
3278
            def RemoveClient(self, object_path):
3424
3279
                "D-Bus method"
3432
3287
                        self.client_removed_signal(c)
3433
3288
                        return
3434
3289
                raise KeyError(object_path)
3435
 
 
 
3290
            
3436
3291
            del _interface
3437
 
 
 
3292
            
3438
3293
            @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3439
 
                                 out_signature="a{oa{sa{sv}}}")
 
3294
                                 out_signature = "a{oa{sa{sv}}}")
3440
3295
            def GetManagedObjects(self):
3441
3296
                """D-Bus method"""
3442
3297
                return dbus.Dictionary(
3443
 
                    {client.dbus_object_path:
3444
 
                     dbus.Dictionary(
3445
 
                         {interface: client.GetAll(interface)
3446
 
                          for interface in
3447
 
                          client._get_all_interface_names()})
3448
 
                     for client in tcp_server.clients.values()})
3449
 
 
 
3298
                    { client.dbus_object_path:
 
3299
                      dbus.Dictionary(
 
3300
                          { interface: client.GetAll(interface)
 
3301
                            for interface in
 
3302
                                 client._get_all_interface_names()})
 
3303
                      for client in tcp_server.clients.values()})
 
3304
            
3450
3305
            def client_added_signal(self, client):
3451
3306
                """Send the new standard signal and the old signal"""
3452
3307
                if use_dbus:
3454
3309
                    self.InterfacesAdded(
3455
3310
                        client.dbus_object_path,
3456
3311
                        dbus.Dictionary(
3457
 
                            {interface: client.GetAll(interface)
3458
 
                             for interface in
3459
 
                             client._get_all_interface_names()}))
 
3312
                            { interface: client.GetAll(interface)
 
3313
                              for interface in
 
3314
                              client._get_all_interface_names()}))
3460
3315
                    # Old signal
3461
3316
                    self.ClientAdded(client.dbus_object_path)
3462
 
 
 
3317
            
3463
3318
            def client_removed_signal(self, client):
3464
3319
                """Send the new standard signal and the old signal"""
3465
3320
                if use_dbus:
3470
3325
                    # Old signal
3471
3326
                    self.ClientRemoved(client.dbus_object_path,
3472
3327
                                       client.name)
3473
 
 
 
3328
        
3474
3329
        mandos_dbus_service = MandosDBusService()
3475
 
 
 
3330
    
3476
3331
    # Save modules to variables to exempt the modules from being
3477
3332
    # unloaded before the function registered with atexit() is run.
3478
3333
    mp = multiprocessing
3479
3334
    wn = wnull
3480
 
 
3481
3335
    def cleanup():
3482
3336
        "Cleanup function; run on exit"
3483
3337
        if zeroconf:
3484
3338
            service.cleanup()
3485
 
 
 
3339
        
3486
3340
        mp.active_children()
3487
3341
        wn.close()
3488
3342
        if not (tcp_server.clients or client_settings):
3489
3343
            return
3490
 
 
 
3344
        
3491
3345
        # Store client before exiting. Secrets are encrypted with key
3492
3346
        # based on what config file has. If config file is
3493
3347
        # removed/edited, old secret will thus be unrecovable.
3498
3352
                client.encrypted_secret = pgp.encrypt(client.secret,
3499
3353
                                                      key)
3500
3354
                client_dict = {}
3501
 
 
 
3355
                
3502
3356
                # A list of attributes that can not be pickled
3503
3357
                # + secret.
3504
 
                exclude = {"bus", "changedstate", "secret",
3505
 
                           "checker", "server_settings"}
 
3358
                exclude = { "bus", "changedstate", "secret",
 
3359
                            "checker", "server_settings" }
3506
3360
                for name, typ in inspect.getmembers(dbus.service
3507
3361
                                                    .Object):
3508
3362
                    exclude.add(name)
3509
 
 
 
3363
                
3510
3364
                client_dict["encrypted_secret"] = (client
3511
3365
                                                   .encrypted_secret)
3512
3366
                for attr in client.client_structure:
3513
3367
                    if attr not in exclude:
3514
3368
                        client_dict[attr] = getattr(client, attr)
3515
 
 
 
3369
                
3516
3370
                clients[client.name] = client_dict
3517
3371
                del client_settings[client.name]["secret"]
3518
 
 
 
3372
        
3519
3373
        try:
3520
3374
            with tempfile.NamedTemporaryFile(
3521
3375
                    mode='wb',
3524
3378
                    dir=os.path.dirname(stored_state_path),
3525
3379
                    delete=False) as stored_state:
3526
3380
                pickle.dump((clients, client_settings), stored_state,
3527
 
                            protocol=2)
 
3381
                            protocol = 2)
3528
3382
                tempname = stored_state.name
3529
3383
            os.rename(tempname, stored_state_path)
3530
3384
        except (IOError, OSError) as e:
3540
3394
                logger.warning("Could not save persistent state:",
3541
3395
                               exc_info=e)
3542
3396
                raise
3543
 
 
 
3397
        
3544
3398
        # Delete all clients, and settings from config
3545
3399
        while tcp_server.clients:
3546
3400
            name, client = tcp_server.clients.popitem()
3552
3406
            if use_dbus:
3553
3407
                mandos_dbus_service.client_removed_signal(client)
3554
3408
        client_settings.clear()
3555
 
 
 
3409
    
3556
3410
    atexit.register(cleanup)
3557
 
 
 
3411
    
3558
3412
    for client in tcp_server.clients.values():
3559
3413
        if use_dbus:
3560
3414
            # Emit D-Bus signal for adding
3562
3416
        # Need to initiate checking of clients
3563
3417
        if client.enabled:
3564
3418
            client.init_checker()
3565
 
 
 
3419
    
3566
3420
    tcp_server.enable()
3567
3421
    tcp_server.server_activate()
3568
 
 
 
3422
    
3569
3423
    # Find out what port we got
3570
3424
    if zeroconf:
3571
3425
        service.port = tcp_server.socket.getsockname()[1]
3576
3430
    else:                       # IPv4
3577
3431
        logger.info("Now listening on address %r, port %d",
3578
3432
                    *tcp_server.socket.getsockname())
3579
 
 
3580
 
    # service.interface = tcp_server.socket.getsockname()[3]
3581
 
 
 
3433
    
 
3434
    #service.interface = tcp_server.socket.getsockname()[3]
 
3435
    
3582
3436
    try:
3583
3437
        if zeroconf:
3584
3438
            # From the Avahi example code
3589
3443
                cleanup()
3590
3444
                sys.exit(1)
3591
3445
            # End of Avahi example code
3592
 
 
 
3446
        
3593
3447
        GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3594
3448
                          lambda *args, **kwargs:
3595
3449
                          (tcp_server.handle_request
3596
3450
                           (*args[2:], **kwargs) or True))
3597
 
 
 
3451
        
3598
3452
        logger.debug("Starting main loop")
3599
3453
        main_loop.run()
3600
3454
    except AvahiError as error: