/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: teddy at recompile
  • Date: 2019-12-05 03:38:07 UTC
  • Revision ID: teddy@recompile.se-20191205033807-6awt45zpgp194vl1
From: Frans Spiesschaert <Frans.Spiesschaert@yucom.be>

Add Dutch debconf translation

* debian/po/nl.po: New.

Acked-by: Teddy Hogeborn <teddy@recompile.se>

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