/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 Hogeborn
  • Date: 2021-02-03 08:57:27 UTC
  • Revision ID: teddy@recompile.se-20210203085727-r2nseei71wb0clpf
Tags: version-1.8.14-1
Version 1.8.14-1

* Makefile (version): Change to "1.8.14".
* NEWS (Version 1.8.14): Add new entry.
* debian/changelog (1.8.14-1): - '' -

Show diffs side-by-side

added added

removed removed

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