/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-07-03 03:32:28 UTC
  • Revision ID: teddy@recompile.se-20160703033228-cafpnnfs53kdg52g
Change all http:// URLs to https:// wherever possible.

* INSTALL (Prerequisites/Libraries/Mandos Server): Change "http://" to
  "https://" wherever possible.
* Makefile (FORTIFY): - '' -
* mandos.xml (SEE ALSO): - '' -
* plugin-runner.c (main): - '' -
* plugins.d/mandos-client.c (start_mandos_communication): - '' -
* plugins.d/mandos-client.xml (SEE ALSO): - '' -

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