/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2020-02-06 15:56:51 UTC
  • mto: This revision was merged to the branch mainline in revision 396.
  • Revision ID: teddy@recompile.se-20200206155651-kx7r39zj8hpv8udl
Use collections.abc.Callable instead of collections.Callable

In Python 3.7, collections.Callable (among others) was moved to
collections.abc.Callable, and its old location deprecated.

* mandos: Create "collections.abc.Callable" if it does not exist, and
  only use the new name.

Show diffs side-by-side

added added

removed removed

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