/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2019-03-03 16:20:02 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 382.
  • Revision ID: teddy@recompile.se-20190303162002-y0ezr98f71d0jfro
mandos-ctl: Refactor; test PrintTableCmd instead of TableOfClients

* mandos-ctl (Test_TableOfClients): Removed.
  (TestCmd): New abstract class for tests for command classes.
  (TestPrintTableCmd): New.

Show diffs side-by-side

added added

removed removed

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