/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2016-03-19 03:51:23 UTC
  • Revision ID: teddy@recompile.se-20160319035123-53w4dbzdyjef29m1
Server: New tmpfiles.d file for persistent state directory

Provide a tmpfiles.d(5) file for systemd to create persistent state
directory on so-called "volatile" systems.

* Makefile (TMPFILES): New.
  (install-server): Also install "tmpfiles.d-mandos.conf" file as
                    "/usr/lib/tmpfiles.d/mandos.conf".
* tmpfiles.d-mandos.conf: New.

Show diffs side-by-side

added added

removed removed

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