/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2016-06-03 17:27:03 UTC
  • Revision ID: teddy@recompile.se-20160603172703-mc6tjor6rhq4xy74
mandos: Bug fix: Do multiprocessing cleanup correctly on exit

* mandos (main): Save module "multiprocessing" and open file "wnull"
                 as scope variables accessible by function cleanup(),
                 since the module and global variable may not be
                 accessible when the cleanup() function is run as
                 scheduled by atexit().

Show diffs side-by-side

added added

removed removed

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