/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 at recompile
  • Date: 2020-04-08 19:15:13 UTC
  • mfrom: (237.4.130 release)
  • Revision ID: teddy@recompile.se-20200408191513-n0ke303478rw1g0b
Merge from release branch

Show diffs side-by-side

added added

removed removed

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