/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: 2017-08-20 16:20:54 UTC
  • Revision ID: teddy@recompile.se-20170820162054-jwig602syxx2k4l0
Alter copyright notices slightly.  Actual license is unchanged!

This alters all copyright notices to use the Free Software
Foundation's recommendations for license notices; from
<https://www.gnu.org/licenses/gpl-howto.html>:

  For programs that are more than one file, it is better to replace
  “this program” with the name of the program, and begin the statement
  with a line saying “This file is part of NAME”.

* DBUS-API: Use program name "Mandos" explicitly in license notice.
* debian/copyright: - '' -
* initramfs-unpack: - '' -
* legalnotice.xml: - '' -
* mandos: - '' -
* mandos-ctl: - '' -
* mandos-keygen: - '' -
* mandos-monitor: - '' -
* plugin-helpers/mandos-client-iprouteadddel.c: - '' -
* plugin-runner.c: - '' -
* plugins.d/askpass-fifo.c: - '' -
* plugins.d/mandos-client.c: - '' -
* plugins.d/password-prompt.c: - '' -
* plugins.d/plymouth.c: - '' -
* plugins.d/splashy.c: - '' -
* plugins.d/usplash.c: - '' -

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