/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2016-03-19 03:51:23 UTC
  • Revision ID: teddy@recompile.se-20160319035123-53w4dbzdyjef29m1
Server: New tmpfiles.d file for persistent state directory

Provide a tmpfiles.d(5) file for systemd to create persistent state
directory on so-called "volatile" systems.

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