/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: teddy at recompile
  • Date: 2020-04-08 19:15:13 UTC
  • mfrom: (237.4.130 release)
  • Revision ID: teddy@recompile.se-20200408191513-n0ke303478rw1g0b
Merge from release branch

Show diffs side-by-side

added added

removed removed

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