/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: teddy at recompile
  • Date: 2020-07-04 13:00:37 UTC
  • mto: This revision was merged to the branch mainline in revision 1219.
  • Revision ID: teddy@recompile.se-20200704130037-fluvf7ftqbjgfu9g
Tags: version-1.8.12-1
Version 1.8.12-1

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

Show diffs side-by-side

added added

removed removed

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