/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: teddy at recompile
  • Date: 2020-02-07 20:53:34 UTC
  • mto: This revision was merged to the branch mainline in revision 396.
  • Revision ID: teddy@recompile.se-20200207205334-dp41p8c8vw0ytik5
Allow users to more easily alter mandos.service

The sysvinit script uses /etc/default/mandos as an environment file,
and supports adding additional server options to a DAEMON_ARGS
environment variable.  This should be supported by the systemd
service, too.

* mandos.service ([Service]/EnvironmentFile): New; set to
  "/etc/default/mandos ".
  ([Service]/ExecStart): Append "$DAEMON_ARGS".

Show diffs side-by-side

added added

removed removed

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