/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2016-06-23 19:19:33 UTC
  • Revision ID: teddy@recompile.se-20160623191933-ex460e9wi5w34ejy
Fix typo in mandos-clients.conf(5).

* mandos-clients.conf.xml (OPTIONS/--fingerprint): Spell "hexadecimal"
                                                   correctly.

Show diffs side-by-side

added added

removed removed

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