/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-02-21 21:42:08 UTC
  • Revision ID: teddy@recompile.se-20170221214208-09wu1p4l2hjhqfoj
Use "read -r" in shell scripts to avoid backslash escapes

* initramfs-tools-hook: Use "read -r" to read filenames from network
  hook given the "files" argument.
* initramfs-tools-script: Use "read -e" when parsing
  "/conf/conf.d/cryptroot".
* mandos-keygen (keygen): Use "read -r" when reading passphrase.

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