/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: 2019-09-04 05:31:20 UTC
  • Revision ID: teddy@recompile.se-20190904053120-b85b56a5kdrnxhbx
Fix server Debian package test

* debian/tests/control (mandos-check/Restrictions): Add
                                                    "allow-stderr".

Show diffs side-by-side

added added

removed removed

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