/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: teddy at recompile
  • Date: 2020-07-04 11:58:52 UTC
  • Revision ID: teddy@recompile.se-20200704115852-oquhnmng3zom4ldl
Update copyright year

* DBUS-API: Update copyright year to 2020
* debian/copyright: - '' -
* dracut-module/ask-password-mandos.service: - '' -
* dracut-module/password-agent.c: - '' -
* mandos: - '' -
* mandos-ctl: - '' -
* plugin-runner.c: - '' -
* plugins.d/mandos-client.c: - '' -
* plugins.d/plymouth.c: - '' -
* mandos-to-cryptroot-unlock: Update copyright year to 2019.

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