/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-07-03 03:32:28 UTC
  • Revision ID: teddy@recompile.se-20160703033228-cafpnnfs53kdg52g
Change all http:// URLs to https:// wherever possible.

* INSTALL (Prerequisites/Libraries/Mandos Server): Change "http://" to
  "https://" wherever possible.
* Makefile (FORTIFY): - '' -
* mandos.xml (SEE ALSO): - '' -
* plugin-runner.c (main): - '' -
* plugins.d/mandos-client.c (start_mandos_communication): - '' -
* plugins.d/mandos-client.xml (SEE ALSO): - '' -

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