/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-11-30 16:19:48 UTC
  • Revision ID: teddy@recompile.se-20201130161948-jozzftghviuvk7kb
Fix debconf template syntax
  
* debian/mandos-client.templates: Rename "_description" header to
  "_Description".

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