/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 Hogeborn
  • Date: 2022-04-23 23:58:39 UTC
  • Revision ID: teddy@recompile.se-20220423235839-cnt9aq1kjveqaydc
Bug fix in mandos-ctl: handle backslashes in password

* mandos-ctl (mode=password): When sending the password to gpg, use
  "printf" instead of "echo -n".  This avoids the behavior of the
  "echo" builtin in "dash", which always interprets backslash escape
  codes.

Reported-By: Jesse Norell <jesse@kci.net>

Show diffs side-by-side

added added

removed removed

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