/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: 2022-04-23 23:25:49 UTC
  • mto: This revision was merged to the branch mainline in revision 406.
  • Revision ID: teddy@recompile.se-20220423232549-1uul4i3jwhums0ek
Minor text adjustment in mandos(8) manual page

* mandos.xml (DESCRIPTION): Break long line.
  (SEE ALSO/RFC 4291): Fix grammatical mistake.

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