/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 20:39:28 UTC
  • mto: This revision was merged to the branch mainline in revision 406.
  • Revision ID: teddy@recompile.se-20220423203928-q2ngppp3pt7cfv4x
Makefile: Add comment about phase out of -lpthread

* Makefile (dracut-module/password-agent): Add comment about -lpthread
  being unnecessary in GNU C library 2.34 and later.

Show diffs side-by-side

added added

removed removed

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