/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-10 03:43:48 UTC
  • Revision ID: teddy@recompile.se-20160710034348-5qc50yeyyn7peirm
Update RFC references to their modern equivalents.

* plugins.d/mandos-client.xml (SEE ALSO): Replace RFC 4346 (TLS 1.1)
  with RFC 5246 (TLS 1.2), and replace RFC 5081 (TLS OpenPGP) with its
  replacement RFC 6091.

Show diffs side-by-side

added added

removed removed

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