/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-02-07 20:53:34 UTC
  • Revision ID: teddy@recompile.se-20200207205334-dp41p8c8vw0ytik5
Allow users to more easily alter mandos.service

The sysvinit script uses /etc/default/mandos as an environment file,
and supports adding additional server options to a DAEMON_ARGS
environment variable.  This should be supported by the systemd
service, too.

* mandos.service ([Service]/EnvironmentFile): New; set to
  "/etc/default/mandos ".
  ([Service]/ExecStart): Append "$DAEMON_ARGS".

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