/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: teddy at recompile
  • Date: 2020-02-05 20:32:33 UTC
  • mto: This revision was merged to the branch mainline in revision 396.
  • Revision ID: teddy@recompile.se-20200205203233-450ojm36jseglq4m
Server: Stagger checker runs when creating clients

To avoid checkers for all clients all running at the same time
periodically, schedule every initially scheduled future checker to run
at a time in the future a random amount of the interval, from the
current time.

* mandos (Client.init_checker): Schedule the first scheduled future
  run of a checker to be a randomly chosen amount of this client's
  "interval" (instead of a full interval).

Show diffs side-by-side

added added

removed removed

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