/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: 2019-11-03 19:17:57 UTC
  • Revision ID: teddy@recompile.se-20191103191757-1hdpp0u5fxa8iumo
INSTALL: Add "-" argument to "su" invocations.

Show diffs side-by-side

added added

removed removed

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