/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 Hogeborn
  • Date: 2015-08-10 21:23:46 UTC
  • mfrom: (326 release)
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 327.
  • Revision ID: teddy@recompile.se-20150810212346-wvobzmqnnit9q8px
Merge from release branch.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#!/usr/bin/python
 
1
#!/usr/bin/python2.7
2
2
# -*- mode: python; coding: utf-8 -*-
3
3
4
4
# Mandos server - give out binary blobs to connecting clients.
11
11
# "AvahiService" class, and some lines in "main".
12
12
13
13
# Everything else is
14
 
# Copyright © 2008-2012 Teddy Hogeborn
15
 
# Copyright © 2008-2012 Björn Påhlsson
 
14
# Copyright © 2008-2015 Teddy Hogeborn
 
15
# Copyright © 2008-2015 Björn Påhlsson
16
16
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
34
34
from __future__ import (division, absolute_import, print_function,
35
35
                        unicode_literals)
36
36
 
37
 
import SocketServer as socketserver
 
37
from future_builtins import *
 
38
 
 
39
try:
 
40
    import SocketServer as socketserver
 
41
except ImportError:
 
42
    import socketserver
38
43
import socket
39
44
import argparse
40
45
import datetime
45
50
import gnutls.library.functions
46
51
import gnutls.library.constants
47
52
import gnutls.library.types
48
 
import ConfigParser as configparser
 
53
try:
 
54
    import ConfigParser as configparser
 
55
except ImportError:
 
56
    import configparser
49
57
import sys
50
58
import re
51
59
import os
60
68
import struct
61
69
import fcntl
62
70
import functools
63
 
import cPickle as pickle
 
71
try:
 
72
    import cPickle as pickle
 
73
except ImportError:
 
74
    import pickle
64
75
import multiprocessing
65
76
import types
66
77
import binascii
67
78
import tempfile
68
79
import itertools
 
80
import collections
 
81
import codecs
69
82
 
70
83
import dbus
71
84
import dbus.service
72
 
import gobject
 
85
try:
 
86
    import gobject
 
87
except ImportError:
 
88
    from gi.repository import GObject as gobject
73
89
import avahi
74
90
from dbus.mainloop.glib import DBusGMainLoop
75
91
import ctypes
76
92
import ctypes.util
77
93
import xml.dom.minidom
78
94
import inspect
79
 
import GnuPGInterface
80
95
 
81
96
try:
82
97
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
86
101
    except ImportError:
87
102
        SO_BINDTODEVICE = None
88
103
 
89
 
version = "1.5.3"
 
104
if sys.version_info.major == 2:
 
105
    str = unicode
 
106
 
 
107
version = "1.7.0"
90
108
stored_state_file = "clients.pickle"
91
109
 
92
110
logger = logging.getLogger()
93
 
syslogger = (logging.handlers.SysLogHandler
94
 
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
95
 
              address = str("/dev/log")))
 
111
syslogger = None
96
112
 
97
113
try:
98
 
    if_nametoindex = (ctypes.cdll.LoadLibrary
99
 
                      (ctypes.util.find_library("c"))
100
 
                      .if_nametoindex)
 
114
    if_nametoindex = ctypes.cdll.LoadLibrary(
 
115
        ctypes.util.find_library("c")).if_nametoindex
101
116
except (OSError, AttributeError):
 
117
    
102
118
    def if_nametoindex(interface):
103
119
        "Get an interface index the hard way, i.e. using fcntl()"
104
120
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
105
121
        with contextlib.closing(socket.socket()) as s:
106
122
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
107
 
                                struct.pack(str("16s16x"),
108
 
                                            interface))
109
 
        interface_index = struct.unpack(str("I"),
110
 
                                        ifreq[16:20])[0]
 
123
                                struct.pack(b"16s16x", interface))
 
124
        interface_index = struct.unpack("I", ifreq[16:20])[0]
111
125
        return interface_index
112
126
 
113
127
 
114
128
def initlogger(debug, level=logging.WARNING):
115
129
    """init logger and add loglevel"""
116
130
    
 
131
    global syslogger
 
132
    syslogger = (logging.handlers.SysLogHandler(
 
133
        facility = logging.handlers.SysLogHandler.LOG_DAEMON,
 
134
        address = "/dev/log"))
117
135
    syslogger.setFormatter(logging.Formatter
118
136
                           ('Mandos [%(process)d]: %(levelname)s:'
119
137
                            ' %(message)s'))
136
154
 
137
155
class PGPEngine(object):
138
156
    """A simple class for OpenPGP symmetric encryption & decryption"""
 
157
    
139
158
    def __init__(self):
140
 
        self.gnupg = GnuPGInterface.GnuPG()
141
159
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
142
 
        self.gnupg = GnuPGInterface.GnuPG()
143
 
        self.gnupg.options.meta_interactive = False
144
 
        self.gnupg.options.homedir = self.tempdir
145
 
        self.gnupg.options.extra_args.extend(['--force-mdc',
146
 
                                              '--quiet',
147
 
                                              '--no-use-agent'])
 
160
        self.gnupgargs = ['--batch',
 
161
                          '--home', self.tempdir,
 
162
                          '--force-mdc',
 
163
                          '--quiet',
 
164
                          '--no-use-agent']
148
165
    
149
166
    def __enter__(self):
150
167
        return self
151
168
    
152
 
    def __exit__ (self, exc_type, exc_value, traceback):
 
169
    def __exit__(self, exc_type, exc_value, traceback):
153
170
        self._cleanup()
154
171
        return False
155
172
    
172
189
    def password_encode(self, password):
173
190
        # Passphrase can not be empty and can not contain newlines or
174
191
        # NUL bytes.  So we prefix it and hex encode it.
175
 
        return b"mandos" + binascii.hexlify(password)
 
192
        encoded = b"mandos" + binascii.hexlify(password)
 
193
        if len(encoded) > 2048:
 
194
            # GnuPG can't handle long passwords, so encode differently
 
195
            encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
 
196
                       .replace(b"\n", b"\\n")
 
197
                       .replace(b"\0", b"\\x00"))
 
198
        return encoded
176
199
    
177
200
    def encrypt(self, data, password):
178
 
        self.gnupg.passphrase = self.password_encode(password)
179
 
        with open(os.devnull, "w") as devnull:
180
 
            try:
181
 
                proc = self.gnupg.run(['--symmetric'],
182
 
                                      create_fhs=['stdin', 'stdout'],
183
 
                                      attach_fhs={'stderr': devnull})
184
 
                with contextlib.closing(proc.handles['stdin']) as f:
185
 
                    f.write(data)
186
 
                with contextlib.closing(proc.handles['stdout']) as f:
187
 
                    ciphertext = f.read()
188
 
                proc.wait()
189
 
            except IOError as e:
190
 
                raise PGPError(e)
191
 
        self.gnupg.passphrase = None
 
201
        passphrase = self.password_encode(password)
 
202
        with tempfile.NamedTemporaryFile(
 
203
                dir=self.tempdir) as passfile:
 
204
            passfile.write(passphrase)
 
205
            passfile.flush()
 
206
            proc = subprocess.Popen(['gpg', '--symmetric',
 
207
                                     '--passphrase-file',
 
208
                                     passfile.name]
 
209
                                    + self.gnupgargs,
 
210
                                    stdin = subprocess.PIPE,
 
211
                                    stdout = subprocess.PIPE,
 
212
                                    stderr = subprocess.PIPE)
 
213
            ciphertext, err = proc.communicate(input = data)
 
214
        if proc.returncode != 0:
 
215
            raise PGPError(err)
192
216
        return ciphertext
193
217
    
194
218
    def decrypt(self, data, password):
195
 
        self.gnupg.passphrase = self.password_encode(password)
196
 
        with open(os.devnull, "w") as devnull:
197
 
            try:
198
 
                proc = self.gnupg.run(['--decrypt'],
199
 
                                      create_fhs=['stdin', 'stdout'],
200
 
                                      attach_fhs={'stderr': devnull})
201
 
                with contextlib.closing(proc.handles['stdin']) as f:
202
 
                    f.write(data)
203
 
                with contextlib.closing(proc.handles['stdout']) as f:
204
 
                    decrypted_plaintext = f.read()
205
 
                proc.wait()
206
 
            except IOError as e:
207
 
                raise PGPError(e)
208
 
        self.gnupg.passphrase = None
 
219
        passphrase = self.password_encode(password)
 
220
        with tempfile.NamedTemporaryFile(
 
221
                dir = self.tempdir) as passfile:
 
222
            passfile.write(passphrase)
 
223
            passfile.flush()
 
224
            proc = subprocess.Popen(['gpg', '--decrypt',
 
225
                                     '--passphrase-file',
 
226
                                     passfile.name]
 
227
                                    + self.gnupgargs,
 
228
                                    stdin = subprocess.PIPE,
 
229
                                    stdout = subprocess.PIPE,
 
230
                                    stderr = subprocess.PIPE)
 
231
            decrypted_plaintext, err = proc.communicate(input = data)
 
232
        if proc.returncode != 0:
 
233
            raise PGPError(err)
209
234
        return decrypted_plaintext
210
235
 
211
236
 
212
 
 
213
237
class AvahiError(Exception):
214
238
    def __init__(self, value, *args, **kwargs):
215
239
        self.value = value
216
 
        super(AvahiError, self).__init__(value, *args, **kwargs)
217
 
    def __unicode__(self):
218
 
        return unicode(repr(self.value))
 
240
        return super(AvahiError, self).__init__(value, *args,
 
241
                                                **kwargs)
 
242
 
219
243
 
220
244
class AvahiServiceError(AvahiError):
221
245
    pass
222
246
 
 
247
 
223
248
class AvahiGroupError(AvahiError):
224
249
    pass
225
250
 
232
257
               Used to optionally bind to the specified interface.
233
258
    name: string; Example: 'Mandos'
234
259
    type: string; Example: '_mandos._tcp'.
235
 
                  See <http://www.dns-sd.org/ServiceTypes.html>
 
260
     See <https://www.iana.org/assignments/service-names-port-numbers>
236
261
    port: integer; what port to announce
237
262
    TXT: list of strings; TXT record for the service
238
263
    domain: string; Domain to publish on, default to .local if empty.
244
269
    server: D-Bus Server
245
270
    bus: dbus.SystemBus()
246
271
    """
247
 
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
248
 
                 servicetype = None, port = None, TXT = None,
249
 
                 domain = "", host = "", max_renames = 32768,
250
 
                 protocol = avahi.PROTO_UNSPEC, bus = None):
 
272
    
 
273
    def __init__(self,
 
274
                 interface = avahi.IF_UNSPEC,
 
275
                 name = None,
 
276
                 servicetype = None,
 
277
                 port = None,
 
278
                 TXT = None,
 
279
                 domain = "",
 
280
                 host = "",
 
281
                 max_renames = 32768,
 
282
                 protocol = avahi.PROTO_UNSPEC,
 
283
                 bus = None):
251
284
        self.interface = interface
252
285
        self.name = name
253
286
        self.type = servicetype
262
295
        self.server = None
263
296
        self.bus = bus
264
297
        self.entry_group_state_changed_match = None
265
 
    def rename(self):
 
298
    
 
299
    def rename(self, remove=True):
266
300
        """Derived from the Avahi example code"""
267
301
        if self.rename_count >= self.max_renames:
268
302
            logger.critical("No suitable Zeroconf service name found"
269
303
                            " after %i retries, exiting.",
270
304
                            self.rename_count)
271
305
            raise AvahiServiceError("Too many renames")
272
 
        self.name = unicode(self.server
273
 
                            .GetAlternativeServiceName(self.name))
 
306
        self.name = str(
 
307
            self.server.GetAlternativeServiceName(self.name))
 
308
        self.rename_count += 1
274
309
        logger.info("Changing Zeroconf service name to %r ...",
275
310
                    self.name)
276
 
        self.remove()
 
311
        if remove:
 
312
            self.remove()
277
313
        try:
278
314
            self.add()
279
315
        except dbus.exceptions.DBusException as error:
280
 
            logger.critical("DBusException: %s", error)
281
 
            self.cleanup()
282
 
            os._exit(1)
283
 
        self.rename_count += 1
 
316
            if (error.get_dbus_name()
 
317
                == "org.freedesktop.Avahi.CollisionError"):
 
318
                logger.info("Local Zeroconf service name collision.")
 
319
                return self.rename(remove=False)
 
320
            else:
 
321
                logger.critical("D-Bus Exception", exc_info=error)
 
322
                self.cleanup()
 
323
                os._exit(1)
 
324
    
284
325
    def remove(self):
285
326
        """Derived from the Avahi example code"""
286
327
        if self.entry_group_state_changed_match is not None:
288
329
            self.entry_group_state_changed_match = None
289
330
        if self.group is not None:
290
331
            self.group.Reset()
 
332
    
291
333
    def add(self):
292
334
        """Derived from the Avahi example code"""
293
335
        self.remove()
310
352
            dbus.UInt16(self.port),
311
353
            avahi.string_array_to_txt_array(self.TXT))
312
354
        self.group.Commit()
 
355
    
313
356
    def entry_group_state_changed(self, state, error):
314
357
        """Derived from the Avahi example code"""
315
358
        logger.debug("Avahi entry group state change: %i", state)
321
364
            self.rename()
322
365
        elif state == avahi.ENTRY_GROUP_FAILURE:
323
366
            logger.critical("Avahi: Error in group state changed %s",
324
 
                            unicode(error))
325
 
            raise AvahiGroupError("State changed: %s"
326
 
                                  % unicode(error))
 
367
                            str(error))
 
368
            raise AvahiGroupError("State changed: {!s}".format(error))
 
369
    
327
370
    def cleanup(self):
328
371
        """Derived from the Avahi example code"""
329
372
        if self.group is not None:
334
377
                pass
335
378
            self.group = None
336
379
        self.remove()
 
380
    
337
381
    def server_state_changed(self, state, error=None):
338
382
        """Derived from the Avahi example code"""
339
383
        logger.debug("Avahi server state change: %i", state)
340
 
        bad_states = { avahi.SERVER_INVALID:
341
 
                           "Zeroconf server invalid",
342
 
                       avahi.SERVER_REGISTERING: None,
343
 
                       avahi.SERVER_COLLISION:
344
 
                           "Zeroconf server name collision",
345
 
                       avahi.SERVER_FAILURE:
346
 
                           "Zeroconf server failure" }
 
384
        bad_states = {
 
385
            avahi.SERVER_INVALID: "Zeroconf server invalid",
 
386
            avahi.SERVER_REGISTERING: None,
 
387
            avahi.SERVER_COLLISION: "Zeroconf server name collision",
 
388
            avahi.SERVER_FAILURE: "Zeroconf server failure",
 
389
        }
347
390
        if state in bad_states:
348
391
            if bad_states[state] is not None:
349
392
                if error is None:
352
395
                    logger.error(bad_states[state] + ": %r", error)
353
396
            self.cleanup()
354
397
        elif state == avahi.SERVER_RUNNING:
355
 
            self.add()
 
398
            try:
 
399
                self.add()
 
400
            except dbus.exceptions.DBusException as error:
 
401
                if (error.get_dbus_name()
 
402
                    == "org.freedesktop.Avahi.CollisionError"):
 
403
                    logger.info("Local Zeroconf service name"
 
404
                                " collision.")
 
405
                    return self.rename(remove=False)
 
406
                else:
 
407
                    logger.critical("D-Bus Exception", exc_info=error)
 
408
                    self.cleanup()
 
409
                    os._exit(1)
356
410
        else:
357
411
            if error is None:
358
412
                logger.debug("Unknown state: %r", state)
359
413
            else:
360
414
                logger.debug("Unknown state: %r: %r", state, error)
 
415
    
361
416
    def activate(self):
362
417
        """Derived from the Avahi example code"""
363
418
        if self.server is None:
367
422
                                    follow_name_owner_changes=True),
368
423
                avahi.DBUS_INTERFACE_SERVER)
369
424
        self.server.connect_to_signal("StateChanged",
370
 
                                 self.server_state_changed)
 
425
                                      self.server_state_changed)
371
426
        self.server_state_changed(self.server.GetState())
372
427
 
 
428
 
373
429
class AvahiServiceToSyslog(AvahiService):
374
 
    def rename(self):
 
430
    def rename(self, *args, **kwargs):
375
431
        """Add the new name to the syslog messages"""
376
 
        ret = AvahiService.rename(self)
377
 
        syslogger.setFormatter(logging.Formatter
378
 
                               ('Mandos (%s) [%%(process)d]:'
379
 
                                ' %%(levelname)s: %%(message)s'
380
 
                                % self.name))
 
432
        ret = AvahiService.rename(self, *args, **kwargs)
 
433
        syslogger.setFormatter(logging.Formatter(
 
434
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
 
435
            .format(self.name)))
381
436
        return ret
382
437
 
383
 
def timedelta_to_milliseconds(td):
384
 
    "Convert a datetime.timedelta() to milliseconds"
385
 
    return ((td.days * 24 * 60 * 60 * 1000)
386
 
            + (td.seconds * 1000)
387
 
            + (td.microseconds // 1000))
388
 
        
 
438
def call_pipe(connection,       # : multiprocessing.Connection
 
439
              func, *args, **kwargs):
 
440
    """This function is meant to be called by multiprocessing.Process
 
441
    
 
442
    This function runs func(*args, **kwargs), and writes the resulting
 
443
    return value on the provided multiprocessing.Connection.
 
444
    """
 
445
    connection.send(func(*args, **kwargs))
 
446
    connection.close()
 
447
 
389
448
class Client(object):
390
449
    """A representation of a client host served by this server.
391
450
    
417
476
    last_checker_status: integer between 0 and 255 reflecting exit
418
477
                         status of last checker. -1 reflects crashed
419
478
                         checker, -2 means no checker completed yet.
 
479
    last_checker_signal: The signal which killed the last checker, if
 
480
                         last_checker_status is -1
420
481
    last_enabled: datetime.datetime(); (UTC) or None
421
482
    name:       string; from the config file, used in log messages and
422
483
                        D-Bus identifiers
427
488
    runtime_expansions: Allowed attributes for runtime expansion.
428
489
    expires:    datetime.datetime(); time (UTC) when a client will be
429
490
                disabled, or None
 
491
    server_settings: The server_settings dict from main()
430
492
    """
431
493
    
432
494
    runtime_expansions = ("approval_delay", "approval_duration",
433
 
                          "created", "enabled", "fingerprint",
434
 
                          "host", "interval", "last_checked_ok",
 
495
                          "created", "enabled", "expires",
 
496
                          "fingerprint", "host", "interval",
 
497
                          "last_approval_request", "last_checked_ok",
435
498
                          "last_enabled", "name", "timeout")
436
 
    client_defaults = { "timeout": "5m",
437
 
                        "extended_timeout": "15m",
438
 
                        "interval": "2m",
439
 
                        "checker": "fping -q -- %%(host)s",
440
 
                        "host": "",
441
 
                        "approval_delay": "0s",
442
 
                        "approval_duration": "1s",
443
 
                        "approved_by_default": "True",
444
 
                        "enabled": "True",
445
 
                        }
446
 
    
447
 
    def timeout_milliseconds(self):
448
 
        "Return the 'timeout' attribute in milliseconds"
449
 
        return timedelta_to_milliseconds(self.timeout)
450
 
    
451
 
    def extended_timeout_milliseconds(self):
452
 
        "Return the 'extended_timeout' attribute in milliseconds"
453
 
        return timedelta_to_milliseconds(self.extended_timeout)
454
 
    
455
 
    def interval_milliseconds(self):
456
 
        "Return the 'interval' attribute in milliseconds"
457
 
        return timedelta_to_milliseconds(self.interval)
458
 
    
459
 
    def approval_delay_milliseconds(self):
460
 
        return timedelta_to_milliseconds(self.approval_delay)
461
 
 
 
499
    client_defaults = {
 
500
        "timeout": "PT5M",
 
501
        "extended_timeout": "PT15M",
 
502
        "interval": "PT2M",
 
503
        "checker": "fping -q -- %%(host)s",
 
504
        "host": "",
 
505
        "approval_delay": "PT0S",
 
506
        "approval_duration": "PT1S",
 
507
        "approved_by_default": "True",
 
508
        "enabled": "True",
 
509
    }
 
510
    
462
511
    @staticmethod
463
512
    def config_parser(config):
464
513
        """Construct a new dict of client settings of this form:
479
528
            client["enabled"] = config.getboolean(client_name,
480
529
                                                  "enabled")
481
530
            
 
531
            # Uppercase and remove spaces from fingerprint for later
 
532
            # comparison purposes with return value from the
 
533
            # fingerprint() function
482
534
            client["fingerprint"] = (section["fingerprint"].upper()
483
535
                                     .replace(" ", ""))
484
536
            if "secret" in section:
489
541
                          "rb") as secfile:
490
542
                    client["secret"] = secfile.read()
491
543
            else:
492
 
                raise TypeError("No secret or secfile for section %s"
493
 
                                % section)
 
544
                raise TypeError("No secret or secfile for section {}"
 
545
                                .format(section))
494
546
            client["timeout"] = string_to_delta(section["timeout"])
495
547
            client["extended_timeout"] = string_to_delta(
496
548
                section["extended_timeout"])
505
557
            client["last_checker_status"] = -2
506
558
        
507
559
        return settings
508
 
        
509
 
        
510
 
    def __init__(self, settings, name = None):
511
 
        """Note: the 'checker' key in 'config' sets the
512
 
        'checker_command' attribute and *not* the 'checker'
513
 
        attribute."""
 
560
    
 
561
    def __init__(self, settings, name = None, server_settings=None):
514
562
        self.name = name
 
563
        if server_settings is None:
 
564
            server_settings = {}
 
565
        self.server_settings = server_settings
515
566
        # adding all client settings
516
 
        for setting, value in settings.iteritems():
 
567
        for setting, value in settings.items():
517
568
            setattr(self, setting, value)
518
569
        
519
570
        if self.enabled:
525
576
        else:
526
577
            self.last_enabled = None
527
578
            self.expires = None
528
 
       
 
579
        
529
580
        logger.debug("Creating client %r", self.name)
530
 
        # Uppercase and remove spaces from fingerprint for later
531
 
        # comparison purposes with return value from the fingerprint()
532
 
        # function
533
581
        logger.debug("  Fingerprint: %s", self.fingerprint)
534
582
        self.created = settings.get("created",
535
583
                                    datetime.datetime.utcnow())
536
 
 
 
584
        
537
585
        # attributes specific for this server instance
538
586
        self.checker = None
539
587
        self.checker_initiator_tag = None
542
590
        self.current_checker_command = None
543
591
        self.approved = None
544
592
        self.approvals_pending = 0
545
 
        self.changedstate = (multiprocessing_manager
546
 
                             .Condition(multiprocessing_manager
547
 
                                        .Lock()))
548
 
        self.client_structure = [attr for attr in
549
 
                                 self.__dict__.iterkeys()
 
593
        self.changedstate = multiprocessing_manager.Condition(
 
594
            multiprocessing_manager.Lock())
 
595
        self.client_structure = [attr
 
596
                                 for attr in self.__dict__.iterkeys()
550
597
                                 if not attr.startswith("_")]
551
598
        self.client_structure.append("client_structure")
552
599
        
553
 
        for name, t in inspect.getmembers(type(self),
554
 
                                          lambda obj:
555
 
                                              isinstance(obj,
556
 
                                                         property)):
 
600
        for name, t in inspect.getmembers(
 
601
                type(self), lambda obj: isinstance(obj, property)):
557
602
            if not name.startswith("_"):
558
603
                self.client_structure.append(name)
559
604
    
567
612
        if getattr(self, "enabled", False):
568
613
            # Already enabled
569
614
            return
570
 
        self.send_changedstate()
571
615
        self.expires = datetime.datetime.utcnow() + self.timeout
572
616
        self.enabled = True
573
617
        self.last_enabled = datetime.datetime.utcnow()
574
618
        self.init_checker()
 
619
        self.send_changedstate()
575
620
    
576
621
    def disable(self, quiet=True):
577
622
        """Disable this client."""
578
623
        if not getattr(self, "enabled", False):
579
624
            return False
580
625
        if not quiet:
581
 
            self.send_changedstate()
582
 
        if not quiet:
583
626
            logger.info("Disabling client %s", self.name)
584
 
        if getattr(self, "disable_initiator_tag", False):
 
627
        if getattr(self, "disable_initiator_tag", None) is not None:
585
628
            gobject.source_remove(self.disable_initiator_tag)
586
629
            self.disable_initiator_tag = None
587
630
        self.expires = None
588
 
        if getattr(self, "checker_initiator_tag", False):
 
631
        if getattr(self, "checker_initiator_tag", None) is not None:
589
632
            gobject.source_remove(self.checker_initiator_tag)
590
633
            self.checker_initiator_tag = None
591
634
        self.stop_checker()
592
635
        self.enabled = False
 
636
        if not quiet:
 
637
            self.send_changedstate()
593
638
        # Do not run this again if called by a gobject.timeout_add
594
639
        return False
595
640
    
599
644
    def init_checker(self):
600
645
        # Schedule a new checker to be started an 'interval' from now,
601
646
        # and every interval from then on.
602
 
        self.checker_initiator_tag = (gobject.timeout_add
603
 
                                      (self.interval_milliseconds(),
604
 
                                       self.start_checker))
 
647
        if self.checker_initiator_tag is not None:
 
648
            gobject.source_remove(self.checker_initiator_tag)
 
649
        self.checker_initiator_tag = gobject.timeout_add(
 
650
            int(self.interval.total_seconds() * 1000),
 
651
            self.start_checker)
605
652
        # Schedule a disable() when 'timeout' has passed
606
 
        self.disable_initiator_tag = (gobject.timeout_add
607
 
                                   (self.timeout_milliseconds(),
608
 
                                    self.disable))
 
653
        if self.disable_initiator_tag is not None:
 
654
            gobject.source_remove(self.disable_initiator_tag)
 
655
        self.disable_initiator_tag = gobject.timeout_add(
 
656
            int(self.timeout.total_seconds() * 1000), self.disable)
609
657
        # Also start a new checker *right now*.
610
658
        self.start_checker()
611
659
    
612
 
    def checker_callback(self, pid, condition, command):
 
660
    def checker_callback(self, source, condition, connection,
 
661
                         command):
613
662
        """The checker has completed, so take appropriate actions."""
614
663
        self.checker_callback_tag = None
615
664
        self.checker = None
616
 
        if os.WIFEXITED(condition):
617
 
            self.last_checker_status = os.WEXITSTATUS(condition)
 
665
        # Read return code from connection (see call_pipe)
 
666
        returncode = connection.recv()
 
667
        connection.close()
 
668
        
 
669
        if returncode >= 0:
 
670
            self.last_checker_status = returncode
 
671
            self.last_checker_signal = None
618
672
            if self.last_checker_status == 0:
619
673
                logger.info("Checker for %(name)s succeeded",
620
674
                            vars(self))
621
675
                self.checked_ok()
622
676
            else:
623
 
                logger.info("Checker for %(name)s failed",
624
 
                            vars(self))
 
677
                logger.info("Checker for %(name)s failed", vars(self))
625
678
        else:
626
679
            self.last_checker_status = -1
 
680
            self.last_checker_signal = -returncode
627
681
            logger.warning("Checker for %(name)s crashed?",
628
682
                           vars(self))
 
683
        return False
629
684
    
630
685
    def checked_ok(self):
631
686
        """Assert that the client has been seen, alive and well."""
632
687
        self.last_checked_ok = datetime.datetime.utcnow()
633
688
        self.last_checker_status = 0
 
689
        self.last_checker_signal = None
634
690
        self.bump_timeout()
635
691
    
636
692
    def bump_timeout(self, timeout=None):
639
695
            timeout = self.timeout
640
696
        if self.disable_initiator_tag is not None:
641
697
            gobject.source_remove(self.disable_initiator_tag)
 
698
            self.disable_initiator_tag = None
642
699
        if getattr(self, "enabled", False):
643
 
            self.disable_initiator_tag = (gobject.timeout_add
644
 
                                          (timedelta_to_milliseconds
645
 
                                           (timeout), self.disable))
 
700
            self.disable_initiator_tag = gobject.timeout_add(
 
701
                int(timeout.total_seconds() * 1000), self.disable)
646
702
            self.expires = datetime.datetime.utcnow() + timeout
647
703
    
648
704
    def need_approval(self):
654
710
        If a checker already exists, leave it running and do
655
711
        nothing."""
656
712
        # The reason for not killing a running checker is that if we
657
 
        # did that, then if a checker (for some reason) started
658
 
        # running slowly and taking more than 'interval' time, the
659
 
        # client would inevitably timeout, since no checker would get
660
 
        # a chance to run to completion.  If we instead leave running
 
713
        # did that, and if a checker (for some reason) started running
 
714
        # slowly and taking more than 'interval' time, then the client
 
715
        # would inevitably timeout, since no checker would get a
 
716
        # chance to run to completion.  If we instead leave running
661
717
        # checkers alone, the checker would have to take more time
662
718
        # than 'timeout' for the client to be disabled, which is as it
663
719
        # should be.
664
720
        
665
 
        # If a checker exists, make sure it is not a zombie
666
 
        try:
667
 
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
668
 
        except (AttributeError, OSError) as error:
669
 
            if (isinstance(error, OSError)
670
 
                and error.errno != errno.ECHILD):
671
 
                raise error
672
 
        else:
673
 
            if pid:
674
 
                logger.warning("Checker was a zombie")
675
 
                gobject.source_remove(self.checker_callback_tag)
676
 
                self.checker_callback(pid, status,
677
 
                                      self.current_checker_command)
 
721
        if self.checker is not None and not self.checker.is_alive():
 
722
            logger.warning("Checker was not alive; joining")
 
723
            self.checker.join()
 
724
            self.checker = None
678
725
        # Start a new checker if needed
679
726
        if self.checker is None:
 
727
            # Escape attributes for the shell
 
728
            escaped_attrs = {
 
729
                attr: re.escape(str(getattr(self, attr)))
 
730
                for attr in self.runtime_expansions }
680
731
            try:
681
 
                # In case checker_command has exactly one % operator
682
 
                command = self.checker_command % self.host
683
 
            except TypeError:
684
 
                # Escape attributes for the shell
685
 
                escaped_attrs = dict(
686
 
                    (attr,
687
 
                     re.escape(unicode(str(getattr(self, attr, "")),
688
 
                                       errors=
689
 
                                       'replace')))
690
 
                    for attr in
691
 
                    self.runtime_expansions)
692
 
                
693
 
                try:
694
 
                    command = self.checker_command % escaped_attrs
695
 
                except TypeError as error:
696
 
                    logger.error('Could not format string "%s":'
697
 
                                 ' %s', self.checker_command, error)
698
 
                    return True # Try again later
 
732
                command = self.checker_command % escaped_attrs
 
733
            except TypeError as error:
 
734
                logger.error('Could not format string "%s"',
 
735
                             self.checker_command,
 
736
                             exc_info=error)
 
737
                return True     # Try again later
699
738
            self.current_checker_command = command
700
 
            try:
701
 
                logger.info("Starting checker %r for %s",
702
 
                            command, self.name)
703
 
                # We don't need to redirect stdout and stderr, since
704
 
                # in normal mode, that is already done by daemon(),
705
 
                # and in debug mode we don't want to.  (Stdin is
706
 
                # always replaced by /dev/null.)
707
 
                self.checker = subprocess.Popen(command,
708
 
                                                close_fds=True,
709
 
                                                shell=True, cwd="/")
710
 
                self.checker_callback_tag = (gobject.child_watch_add
711
 
                                             (self.checker.pid,
712
 
                                              self.checker_callback,
713
 
                                              data=command))
714
 
                # The checker may have completed before the gobject
715
 
                # watch was added.  Check for this.
716
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
717
 
                if pid:
718
 
                    gobject.source_remove(self.checker_callback_tag)
719
 
                    self.checker_callback(pid, status, command)
720
 
            except OSError as error:
721
 
                logger.error("Failed to start subprocess: %s",
722
 
                             error)
 
739
            logger.info("Starting checker %r for %s", command,
 
740
                        self.name)
 
741
            # We don't need to redirect stdout and stderr, since
 
742
            # in normal mode, that is already done by daemon(),
 
743
            # and in debug mode we don't want to.  (Stdin is
 
744
            # always replaced by /dev/null.)
 
745
            # The exception is when not debugging but nevertheless
 
746
            # running in the foreground; use the previously
 
747
            # created wnull.
 
748
            popen_args = { "close_fds": True,
 
749
                           "shell": True,
 
750
                           "cwd": "/" }
 
751
            if (not self.server_settings["debug"]
 
752
                and self.server_settings["foreground"]):
 
753
                popen_args.update({"stdout": wnull,
 
754
                                   "stderr": wnull })
 
755
            pipe = multiprocessing.Pipe(duplex = False)
 
756
            self.checker = multiprocessing.Process(
 
757
                target = call_pipe,
 
758
                args = (pipe[1], subprocess.call, command),
 
759
                kwargs = popen_args)
 
760
            self.checker.start()
 
761
            self.checker_callback_tag = gobject.io_add_watch(
 
762
                pipe[0].fileno(), gobject.IO_IN,
 
763
                self.checker_callback, pipe[0], command)
723
764
        # Re-run this periodically if run by gobject.timeout_add
724
765
        return True
725
766
    
731
772
        if getattr(self, "checker", None) is None:
732
773
            return
733
774
        logger.debug("Stopping checker for %(name)s", vars(self))
734
 
        try:
735
 
            os.kill(self.checker.pid, signal.SIGTERM)
736
 
            #time.sleep(0.5)
737
 
            #if self.checker.poll() is None:
738
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
739
 
        except OSError as error:
740
 
            if error.errno != errno.ESRCH: # No such process
741
 
                raise
 
775
        self.checker.terminate()
742
776
        self.checker = None
743
777
 
744
778
 
745
 
def dbus_service_property(dbus_interface, signature="v",
746
 
                          access="readwrite", byte_arrays=False):
 
779
def dbus_service_property(dbus_interface,
 
780
                          signature="v",
 
781
                          access="readwrite",
 
782
                          byte_arrays=False):
747
783
    """Decorators for marking methods of a DBusObjectWithProperties to
748
784
    become properties on the D-Bus.
749
785
    
758
794
    # "Set" method, so we fail early here:
759
795
    if byte_arrays and signature != "ay":
760
796
        raise ValueError("Byte arrays not supported for non-'ay'"
761
 
                         " signature %r" % signature)
 
797
                         " signature {!r}".format(signature))
 
798
    
762
799
    def decorator(func):
763
800
        func._dbus_is_property = True
764
801
        func._dbus_interface = dbus_interface
769
806
            func._dbus_name = func._dbus_name[:-14]
770
807
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
771
808
        return func
 
809
    
772
810
    return decorator
773
811
 
774
812
 
775
813
def dbus_interface_annotations(dbus_interface):
776
 
    """Decorator for marking functions returning interface annotations.
 
814
    """Decorator for marking functions returning interface annotations
777
815
    
778
816
    Usage:
779
817
    
783
821
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
784
822
                    "false"}
785
823
    """
 
824
    
786
825
    def decorator(func):
787
826
        func._dbus_is_interface = True
788
827
        func._dbus_interface = dbus_interface
789
828
        func._dbus_name = dbus_interface
790
829
        return func
 
830
    
 
831
    return decorator
 
832
 
 
833
 
 
834
def dbus_annotations(annotations):
 
835
    """Decorator to annotate D-Bus methods, signals or properties
 
836
    Usage:
 
837
    
 
838
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
 
839
                       "org.freedesktop.DBus.Property."
 
840
                       "EmitsChangedSignal": "false"})
 
841
    @dbus_service_property("org.example.Interface", signature="b",
 
842
                           access="r")
 
843
    def Property_dbus_property(self):
 
844
        return dbus.Boolean(False)
 
845
    
 
846
    See also the DBusObjectWithAnnotations class.
 
847
    """
 
848
    
 
849
    def decorator(func):
 
850
        func._dbus_annotations = annotations
 
851
        return func
 
852
    
791
853
    return decorator
792
854
 
793
855
 
794
856
class DBusPropertyException(dbus.exceptions.DBusException):
795
857
    """A base class for D-Bus property-related exceptions
796
858
    """
797
 
    def __unicode__(self):
798
 
        return unicode(str(self))
 
859
    pass
799
860
 
800
861
 
801
862
class DBusPropertyAccessException(DBusPropertyException):
810
871
    pass
811
872
 
812
873
 
813
 
class DBusObjectWithProperties(dbus.service.Object):
814
 
    """A D-Bus object with properties.
 
874
class DBusObjectWithAnnotations(dbus.service.Object):
 
875
    """A D-Bus object with annotations.
815
876
    
816
 
    Classes inheriting from this can use the dbus_service_property
817
 
    decorator to expose methods as D-Bus properties.  It exposes the
818
 
    standard Get(), Set(), and GetAll() methods on the D-Bus.
 
877
    Classes inheriting from this can use the dbus_annotations
 
878
    decorator to add annotations to methods or signals.
819
879
    """
820
880
    
821
881
    @staticmethod
825
885
        If called like _is_dbus_thing("method") it returns a function
826
886
        suitable for use as predicate to inspect.getmembers().
827
887
        """
828
 
        return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
 
888
        return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
829
889
                                   False)
830
890
    
831
891
    def _get_all_dbus_things(self, thing):
832
892
        """Returns a generator of (name, attribute) pairs
833
893
        """
834
 
        return ((athing.__get__(self)._dbus_name,
 
894
        return ((getattr(athing.__get__(self), "_dbus_name", name),
835
895
                 athing.__get__(self))
836
896
                for cls in self.__class__.__mro__
837
897
                for name, athing in
838
 
                inspect.getmembers(cls,
839
 
                                   self._is_dbus_thing(thing)))
 
898
                inspect.getmembers(cls, self._is_dbus_thing(thing)))
 
899
    
 
900
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
901
                         out_signature = "s",
 
902
                         path_keyword = 'object_path',
 
903
                         connection_keyword = 'connection')
 
904
    def Introspect(self, object_path, connection):
 
905
        """Overloading of standard D-Bus method.
 
906
        
 
907
        Inserts annotation tags on methods and signals.
 
908
        """
 
909
        xmlstring = dbus.service.Object.Introspect(self, object_path,
 
910
                                                   connection)
 
911
        try:
 
912
            document = xml.dom.minidom.parseString(xmlstring)
 
913
            
 
914
            for if_tag in document.getElementsByTagName("interface"):
 
915
                # Add annotation tags
 
916
                for typ in ("method", "signal"):
 
917
                    for tag in if_tag.getElementsByTagName(typ):
 
918
                        annots = dict()
 
919
                        for name, prop in (self.
 
920
                                           _get_all_dbus_things(typ)):
 
921
                            if (name == tag.getAttribute("name")
 
922
                                and prop._dbus_interface
 
923
                                == if_tag.getAttribute("name")):
 
924
                                annots.update(getattr(
 
925
                                    prop, "_dbus_annotations", {}))
 
926
                        for name, value in annots.items():
 
927
                            ann_tag = document.createElement(
 
928
                                "annotation")
 
929
                            ann_tag.setAttribute("name", name)
 
930
                            ann_tag.setAttribute("value", value)
 
931
                            tag.appendChild(ann_tag)
 
932
                # Add interface annotation tags
 
933
                for annotation, value in dict(
 
934
                    itertools.chain.from_iterable(
 
935
                        annotations().items()
 
936
                        for name, annotations
 
937
                        in self._get_all_dbus_things("interface")
 
938
                        if name == if_tag.getAttribute("name")
 
939
                        )).items():
 
940
                    ann_tag = document.createElement("annotation")
 
941
                    ann_tag.setAttribute("name", annotation)
 
942
                    ann_tag.setAttribute("value", value)
 
943
                    if_tag.appendChild(ann_tag)
 
944
                # Fix argument name for the Introspect method itself
 
945
                if (if_tag.getAttribute("name")
 
946
                                == dbus.INTROSPECTABLE_IFACE):
 
947
                    for cn in if_tag.getElementsByTagName("method"):
 
948
                        if cn.getAttribute("name") == "Introspect":
 
949
                            for arg in cn.getElementsByTagName("arg"):
 
950
                                if (arg.getAttribute("direction")
 
951
                                    == "out"):
 
952
                                    arg.setAttribute("name",
 
953
                                                     "xml_data")
 
954
            xmlstring = document.toxml("utf-8")
 
955
            document.unlink()
 
956
        except (AttributeError, xml.dom.DOMException,
 
957
                xml.parsers.expat.ExpatError) as error:
 
958
            logger.error("Failed to override Introspection method",
 
959
                         exc_info=error)
 
960
        return xmlstring
 
961
 
 
962
 
 
963
class DBusObjectWithProperties(DBusObjectWithAnnotations):
 
964
    """A D-Bus object with properties.
 
965
    
 
966
    Classes inheriting from this can use the dbus_service_property
 
967
    decorator to expose methods as D-Bus properties.  It exposes the
 
968
    standard Get(), Set(), and GetAll() methods on the D-Bus.
 
969
    """
840
970
    
841
971
    def _get_dbus_property(self, interface_name, property_name):
842
972
        """Returns a bound method if one exists which is a D-Bus
843
973
        property with the specified name and interface.
844
974
        """
845
 
        for cls in  self.__class__.__mro__:
846
 
            for name, value in (inspect.getmembers
847
 
                                (cls,
848
 
                                 self._is_dbus_thing("property"))):
 
975
        for cls in self.__class__.__mro__:
 
976
            for name, value in inspect.getmembers(
 
977
                    cls, self._is_dbus_thing("property")):
849
978
                if (value._dbus_name == property_name
850
979
                    and value._dbus_interface == interface_name):
851
980
                    return value.__get__(self)
852
981
        
853
982
        # No such property
854
 
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
855
 
                                   + interface_name + "."
856
 
                                   + property_name)
857
 
    
858
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
 
983
        raise DBusPropertyNotFound("{}:{}.{}".format(
 
984
            self.dbus_object_path, interface_name, property_name))
 
985
    
 
986
    @classmethod
 
987
    def _get_all_interface_names(cls):
 
988
        """Get a sequence of all interfaces supported by an object"""
 
989
        return (name for name in set(getattr(getattr(x, attr),
 
990
                                             "_dbus_interface", None)
 
991
                                     for x in (inspect.getmro(cls))
 
992
                                     for attr in dir(x))
 
993
                if name is not None)
 
994
    
 
995
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
996
                         in_signature="ss",
859
997
                         out_signature="v")
860
998
    def Get(self, interface_name, property_name):
861
999
        """Standard D-Bus property Get() method, see D-Bus standard.
879
1017
            # The byte_arrays option is not supported yet on
880
1018
            # signatures other than "ay".
881
1019
            if prop._dbus_signature != "ay":
882
 
                raise ValueError
 
1020
                raise ValueError("Byte arrays not supported for non-"
 
1021
                                 "'ay' signature {!r}"
 
1022
                                 .format(prop._dbus_signature))
883
1023
            value = dbus.ByteArray(b''.join(chr(byte)
884
1024
                                            for byte in value))
885
1025
        prop(value)
886
1026
    
887
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
 
1027
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
1028
                         in_signature="s",
888
1029
                         out_signature="a{sv}")
889
1030
    def GetAll(self, interface_name):
890
1031
        """Standard D-Bus property GetAll() method, see D-Bus
905
1046
            if not hasattr(value, "variant_level"):
906
1047
                properties[name] = value
907
1048
                continue
908
 
            properties[name] = type(value)(value, variant_level=
909
 
                                           value.variant_level+1)
 
1049
            properties[name] = type(value)(
 
1050
                value, variant_level = value.variant_level + 1)
910
1051
        return dbus.Dictionary(properties, signature="sv")
911
1052
    
 
1053
    @dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
 
1054
    def PropertiesChanged(self, interface_name, changed_properties,
 
1055
                          invalidated_properties):
 
1056
        """Standard D-Bus PropertiesChanged() signal, see D-Bus
 
1057
        standard.
 
1058
        """
 
1059
        pass
 
1060
    
912
1061
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
913
1062
                         out_signature="s",
914
1063
                         path_keyword='object_path',
918
1067
        
919
1068
        Inserts property tags and interface annotation tags.
920
1069
        """
921
 
        xmlstring = dbus.service.Object.Introspect(self, object_path,
922
 
                                                   connection)
 
1070
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
1071
                                                         object_path,
 
1072
                                                         connection)
923
1073
        try:
924
1074
            document = xml.dom.minidom.parseString(xmlstring)
 
1075
            
925
1076
            def make_tag(document, name, prop):
926
1077
                e = document.createElement("property")
927
1078
                e.setAttribute("name", name)
928
1079
                e.setAttribute("type", prop._dbus_signature)
929
1080
                e.setAttribute("access", prop._dbus_access)
930
1081
                return e
 
1082
            
931
1083
            for if_tag in document.getElementsByTagName("interface"):
932
1084
                # Add property tags
933
1085
                for tag in (make_tag(document, name, prop)
936
1088
                            if prop._dbus_interface
937
1089
                            == if_tag.getAttribute("name")):
938
1090
                    if_tag.appendChild(tag)
939
 
                # Add interface annotation tags
940
 
                for annotation, value in dict(
941
 
                    itertools.chain(
942
 
                        *(annotations().iteritems()
943
 
                          for name, annotations in
944
 
                          self._get_all_dbus_things("interface")
945
 
                          if name == if_tag.getAttribute("name")
946
 
                          ))).iteritems():
947
 
                    attr_tag = document.createElement("annotation")
948
 
                    attr_tag.setAttribute("name", annotation)
949
 
                    attr_tag.setAttribute("value", value)
950
 
                    if_tag.appendChild(attr_tag)
 
1091
                # Add annotation tags for properties
 
1092
                for tag in if_tag.getElementsByTagName("property"):
 
1093
                    annots = dict()
 
1094
                    for name, prop in self._get_all_dbus_things(
 
1095
                            "property"):
 
1096
                        if (name == tag.getAttribute("name")
 
1097
                            and prop._dbus_interface
 
1098
                            == if_tag.getAttribute("name")):
 
1099
                            annots.update(getattr(
 
1100
                                prop, "_dbus_annotations", {}))
 
1101
                    for name, value in annots.items():
 
1102
                        ann_tag = document.createElement(
 
1103
                            "annotation")
 
1104
                        ann_tag.setAttribute("name", name)
 
1105
                        ann_tag.setAttribute("value", value)
 
1106
                        tag.appendChild(ann_tag)
951
1107
                # Add the names to the return values for the
952
1108
                # "org.freedesktop.DBus.Properties" methods
953
1109
                if (if_tag.getAttribute("name")
968
1124
        except (AttributeError, xml.dom.DOMException,
969
1125
                xml.parsers.expat.ExpatError) as error:
970
1126
            logger.error("Failed to override Introspection method",
971
 
                         error)
972
 
        return xmlstring
973
 
 
974
 
 
975
 
def datetime_to_dbus (dt, variant_level=0):
 
1127
                         exc_info=error)
 
1128
        return xmlstring
 
1129
 
 
1130
try:
 
1131
    dbus.OBJECT_MANAGER_IFACE
 
1132
except AttributeError:
 
1133
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
 
1134
 
 
1135
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
 
1136
    """A D-Bus object with an ObjectManager.
 
1137
    
 
1138
    Classes inheriting from this exposes the standard
 
1139
    GetManagedObjects call and the InterfacesAdded and
 
1140
    InterfacesRemoved signals on the standard
 
1141
    "org.freedesktop.DBus.ObjectManager" interface.
 
1142
    
 
1143
    Note: No signals are sent automatically; they must be sent
 
1144
    manually.
 
1145
    """
 
1146
    @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
 
1147
                         out_signature = "a{oa{sa{sv}}}")
 
1148
    def GetManagedObjects(self):
 
1149
        """This function must be overridden"""
 
1150
        raise NotImplementedError()
 
1151
    
 
1152
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
 
1153
                         signature = "oa{sa{sv}}")
 
1154
    def InterfacesAdded(self, object_path, interfaces_and_properties):
 
1155
        pass
 
1156
    
 
1157
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature = "oas")
 
1158
    def InterfacesRemoved(self, object_path, interfaces):
 
1159
        pass
 
1160
    
 
1161
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
1162
                         out_signature = "s",
 
1163
                         path_keyword = 'object_path',
 
1164
                         connection_keyword = 'connection')
 
1165
    def Introspect(self, object_path, connection):
 
1166
        """Overloading of standard D-Bus method.
 
1167
        
 
1168
        Override return argument name of GetManagedObjects to be
 
1169
        "objpath_interfaces_and_properties"
 
1170
        """
 
1171
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
1172
                                                         object_path,
 
1173
                                                         connection)
 
1174
        try:
 
1175
            document = xml.dom.minidom.parseString(xmlstring)
 
1176
            
 
1177
            for if_tag in document.getElementsByTagName("interface"):
 
1178
                # Fix argument name for the GetManagedObjects method
 
1179
                if (if_tag.getAttribute("name")
 
1180
                                == dbus.OBJECT_MANAGER_IFACE):
 
1181
                    for cn in if_tag.getElementsByTagName("method"):
 
1182
                        if (cn.getAttribute("name")
 
1183
                            == "GetManagedObjects"):
 
1184
                            for arg in cn.getElementsByTagName("arg"):
 
1185
                                if (arg.getAttribute("direction")
 
1186
                                    == "out"):
 
1187
                                    arg.setAttribute(
 
1188
                                        "name",
 
1189
                                        "objpath_interfaces"
 
1190
                                        "_and_properties")
 
1191
            xmlstring = document.toxml("utf-8")
 
1192
            document.unlink()
 
1193
        except (AttributeError, xml.dom.DOMException,
 
1194
                xml.parsers.expat.ExpatError) as error:
 
1195
            logger.error("Failed to override Introspection method",
 
1196
                         exc_info = error)
 
1197
        return xmlstring
 
1198
 
 
1199
def datetime_to_dbus(dt, variant_level=0):
976
1200
    """Convert a UTC datetime.datetime() to a D-Bus type."""
977
1201
    if dt is None:
978
1202
        return dbus.String("", variant_level = variant_level)
979
 
    return dbus.String(dt.isoformat(),
980
 
                       variant_level=variant_level)
981
 
 
982
 
 
983
 
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
984
 
                                  .__metaclass__):
985
 
    """Applied to an empty subclass of a D-Bus object, this metaclass
986
 
    will add additional D-Bus attributes matching a certain pattern.
 
1203
    return dbus.String(dt.isoformat(), variant_level=variant_level)
 
1204
 
 
1205
 
 
1206
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
 
1207
    """A class decorator; applied to a subclass of
 
1208
    dbus.service.Object, it will add alternate D-Bus attributes with
 
1209
    interface names according to the "alt_interface_names" mapping.
 
1210
    Usage:
 
1211
    
 
1212
    @alternate_dbus_interfaces({"org.example.Interface":
 
1213
                                    "net.example.AlternateInterface"})
 
1214
    class SampleDBusObject(dbus.service.Object):
 
1215
        @dbus.service.method("org.example.Interface")
 
1216
        def SampleDBusMethod():
 
1217
            pass
 
1218
    
 
1219
    The above "SampleDBusMethod" on "SampleDBusObject" will be
 
1220
    reachable via two interfaces: "org.example.Interface" and
 
1221
    "net.example.AlternateInterface", the latter of which will have
 
1222
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
 
1223
    "true", unless "deprecate" is passed with a False value.
 
1224
    
 
1225
    This works for methods and signals, and also for D-Bus properties
 
1226
    (from DBusObjectWithProperties) and interfaces (from the
 
1227
    dbus_interface_annotations decorator).
987
1228
    """
988
 
    def __new__(mcs, name, bases, attr):
989
 
        # Go through all the base classes which could have D-Bus
990
 
        # methods, signals, or properties in them
991
 
        old_interface_names = []
992
 
        for base in (b for b in bases
993
 
                     if issubclass(b, dbus.service.Object)):
994
 
            # Go though all attributes of the base class
995
 
            for attrname, attribute in inspect.getmembers(base):
 
1229
    
 
1230
    def wrapper(cls):
 
1231
        for orig_interface_name, alt_interface_name in (
 
1232
                alt_interface_names.items()):
 
1233
            attr = {}
 
1234
            interface_names = set()
 
1235
            # Go though all attributes of the class
 
1236
            for attrname, attribute in inspect.getmembers(cls):
996
1237
                # Ignore non-D-Bus attributes, and D-Bus attributes
997
1238
                # with the wrong interface name
998
1239
                if (not hasattr(attribute, "_dbus_interface")
999
 
                    or not attribute._dbus_interface
1000
 
                    .startswith("se.recompile.Mandos")):
 
1240
                    or not attribute._dbus_interface.startswith(
 
1241
                        orig_interface_name)):
1001
1242
                    continue
1002
1243
                # Create an alternate D-Bus interface name based on
1003
1244
                # the current name
1004
 
                alt_interface = (attribute._dbus_interface
1005
 
                                 .replace("se.recompile.Mandos",
1006
 
                                          "se.bsnet.fukt.Mandos"))
1007
 
                if alt_interface != attribute._dbus_interface:
1008
 
                    old_interface_names.append(alt_interface)
 
1245
                alt_interface = attribute._dbus_interface.replace(
 
1246
                    orig_interface_name, alt_interface_name)
 
1247
                interface_names.add(alt_interface)
1009
1248
                # Is this a D-Bus signal?
1010
1249
                if getattr(attribute, "_dbus_is_signal", False):
1011
 
                    # Extract the original non-method function by
1012
 
                    # black magic
1013
 
                    nonmethod_func = (dict(
 
1250
                    if sys.version_info.major == 2:
 
1251
                        # Extract the original non-method undecorated
 
1252
                        # function by black magic
 
1253
                        nonmethod_func = (dict(
1014
1254
                            zip(attribute.func_code.co_freevars,
1015
 
                                attribute.__closure__))["func"]
1016
 
                                      .cell_contents)
 
1255
                                attribute.__closure__))
 
1256
                                          ["func"].cell_contents)
 
1257
                    else:
 
1258
                        nonmethod_func = attribute
1017
1259
                    # Create a new, but exactly alike, function
1018
1260
                    # object, and decorate it to be a new D-Bus signal
1019
1261
                    # with the alternate D-Bus interface name
1020
 
                    new_function = (dbus.service.signal
1021
 
                                    (alt_interface,
1022
 
                                     attribute._dbus_signature)
1023
 
                                    (types.FunctionType(
1024
 
                                nonmethod_func.func_code,
1025
 
                                nonmethod_func.func_globals,
1026
 
                                nonmethod_func.func_name,
1027
 
                                nonmethod_func.func_defaults,
1028
 
                                nonmethod_func.func_closure)))
 
1262
                    if sys.version_info.major == 2:
 
1263
                        new_function = types.FunctionType(
 
1264
                            nonmethod_func.func_code,
 
1265
                            nonmethod_func.func_globals,
 
1266
                            nonmethod_func.func_name,
 
1267
                            nonmethod_func.func_defaults,
 
1268
                            nonmethod_func.func_closure)
 
1269
                    else:
 
1270
                        new_function = types.FunctionType(
 
1271
                            nonmethod_func.__code__,
 
1272
                            nonmethod_func.__globals__,
 
1273
                            nonmethod_func.__name__,
 
1274
                            nonmethod_func.__defaults__,
 
1275
                            nonmethod_func.__closure__)
 
1276
                    new_function = (dbus.service.signal(
 
1277
                        alt_interface,
 
1278
                        attribute._dbus_signature)(new_function))
 
1279
                    # Copy annotations, if any
 
1280
                    try:
 
1281
                        new_function._dbus_annotations = dict(
 
1282
                            attribute._dbus_annotations)
 
1283
                    except AttributeError:
 
1284
                        pass
1029
1285
                    # Define a creator of a function to call both the
1030
 
                    # old and new functions, so both the old and new
1031
 
                    # signals gets sent when the function is called
 
1286
                    # original and alternate functions, so both the
 
1287
                    # original and alternate signals gets sent when
 
1288
                    # the function is called
1032
1289
                    def fixscope(func1, func2):
1033
1290
                        """This function is a scope container to pass
1034
1291
                        func1 and func2 to the "call_both" function
1035
1292
                        outside of its arguments"""
 
1293
                        
 
1294
                        @functools.wraps(func2)
1036
1295
                        def call_both(*args, **kwargs):
1037
1296
                            """This function will emit two D-Bus
1038
1297
                            signals by calling func1 and func2"""
1039
1298
                            func1(*args, **kwargs)
1040
1299
                            func2(*args, **kwargs)
 
1300
                        # Make wrapper function look like a D-Bus signal
 
1301
                        for name, attr in inspect.getmembers(func2):
 
1302
                            if name.startswith("_dbus_"):
 
1303
                                setattr(call_both, name, attr)
 
1304
                        
1041
1305
                        return call_both
1042
1306
                    # Create the "call_both" function and add it to
1043
1307
                    # the class
1044
 
                    attr[attrname] = fixscope(attribute,
1045
 
                                              new_function)
 
1308
                    attr[attrname] = fixscope(attribute, new_function)
1046
1309
                # Is this a D-Bus method?
1047
1310
                elif getattr(attribute, "_dbus_is_method", False):
1048
1311
                    # Create a new, but exactly alike, function
1049
1312
                    # object.  Decorate it to be a new D-Bus method
1050
1313
                    # with the alternate D-Bus interface name.  Add it
1051
1314
                    # to the class.
1052
 
                    attr[attrname] = (dbus.service.method
1053
 
                                      (alt_interface,
1054
 
                                       attribute._dbus_in_signature,
1055
 
                                       attribute._dbus_out_signature)
1056
 
                                      (types.FunctionType
1057
 
                                       (attribute.func_code,
1058
 
                                        attribute.func_globals,
1059
 
                                        attribute.func_name,
1060
 
                                        attribute.func_defaults,
1061
 
                                        attribute.func_closure)))
 
1315
                    attr[attrname] = (
 
1316
                        dbus.service.method(
 
1317
                            alt_interface,
 
1318
                            attribute._dbus_in_signature,
 
1319
                            attribute._dbus_out_signature)
 
1320
                        (types.FunctionType(attribute.func_code,
 
1321
                                            attribute.func_globals,
 
1322
                                            attribute.func_name,
 
1323
                                            attribute.func_defaults,
 
1324
                                            attribute.func_closure)))
 
1325
                    # Copy annotations, if any
 
1326
                    try:
 
1327
                        attr[attrname]._dbus_annotations = dict(
 
1328
                            attribute._dbus_annotations)
 
1329
                    except AttributeError:
 
1330
                        pass
1062
1331
                # Is this a D-Bus property?
1063
1332
                elif getattr(attribute, "_dbus_is_property", False):
1064
1333
                    # Create a new, but exactly alike, function
1065
1334
                    # object, and decorate it to be a new D-Bus
1066
1335
                    # property with the alternate D-Bus interface
1067
1336
                    # name.  Add it to the class.
1068
 
                    attr[attrname] = (dbus_service_property
1069
 
                                      (alt_interface,
1070
 
                                       attribute._dbus_signature,
1071
 
                                       attribute._dbus_access,
1072
 
                                       attribute
1073
 
                                       ._dbus_get_args_options
1074
 
                                       ["byte_arrays"])
1075
 
                                      (types.FunctionType
1076
 
                                       (attribute.func_code,
1077
 
                                        attribute.func_globals,
1078
 
                                        attribute.func_name,
1079
 
                                        attribute.func_defaults,
1080
 
                                        attribute.func_closure)))
 
1337
                    attr[attrname] = (dbus_service_property(
 
1338
                        alt_interface, attribute._dbus_signature,
 
1339
                        attribute._dbus_access,
 
1340
                        attribute._dbus_get_args_options
 
1341
                        ["byte_arrays"])
 
1342
                                      (types.FunctionType(
 
1343
                                          attribute.func_code,
 
1344
                                          attribute.func_globals,
 
1345
                                          attribute.func_name,
 
1346
                                          attribute.func_defaults,
 
1347
                                          attribute.func_closure)))
 
1348
                    # Copy annotations, if any
 
1349
                    try:
 
1350
                        attr[attrname]._dbus_annotations = dict(
 
1351
                            attribute._dbus_annotations)
 
1352
                    except AttributeError:
 
1353
                        pass
1081
1354
                # Is this a D-Bus interface?
1082
1355
                elif getattr(attribute, "_dbus_is_interface", False):
1083
1356
                    # Create a new, but exactly alike, function
1084
1357
                    # object.  Decorate it to be a new D-Bus interface
1085
1358
                    # with the alternate D-Bus interface name.  Add it
1086
1359
                    # to the class.
1087
 
                    attr[attrname] = (dbus_interface_annotations
1088
 
                                      (alt_interface)
1089
 
                                      (types.FunctionType
1090
 
                                       (attribute.func_code,
1091
 
                                        attribute.func_globals,
1092
 
                                        attribute.func_name,
1093
 
                                        attribute.func_defaults,
1094
 
                                        attribute.func_closure)))
1095
 
        # Deprecate all old interfaces
1096
 
        basename="_AlternateDBusNamesMetaclass_interface_annotation{0}"
1097
 
        for old_interface_name in old_interface_names:
1098
 
            @dbus_interface_annotations(old_interface_name)
1099
 
            def func(self):
1100
 
                return { "org.freedesktop.DBus.Deprecated": "true" }
1101
 
            # Find an unused name
1102
 
            for aname in (basename.format(i) for i in
1103
 
                          itertools.count()):
1104
 
                if aname not in attr:
1105
 
                    attr[aname] = func
1106
 
                    break
1107
 
        return type.__new__(mcs, name, bases, attr)
1108
 
 
1109
 
 
 
1360
                    attr[attrname] = (
 
1361
                        dbus_interface_annotations(alt_interface)
 
1362
                        (types.FunctionType(attribute.func_code,
 
1363
                                            attribute.func_globals,
 
1364
                                            attribute.func_name,
 
1365
                                            attribute.func_defaults,
 
1366
                                            attribute.func_closure)))
 
1367
            if deprecate:
 
1368
                # Deprecate all alternate interfaces
 
1369
                iname="_AlternateDBusNames_interface_annotation{}"
 
1370
                for interface_name in interface_names:
 
1371
                    
 
1372
                    @dbus_interface_annotations(interface_name)
 
1373
                    def func(self):
 
1374
                        return { "org.freedesktop.DBus.Deprecated":
 
1375
                                 "true" }
 
1376
                    # Find an unused name
 
1377
                    for aname in (iname.format(i)
 
1378
                                  for i in itertools.count()):
 
1379
                        if aname not in attr:
 
1380
                            attr[aname] = func
 
1381
                            break
 
1382
            if interface_names:
 
1383
                # Replace the class with a new subclass of it with
 
1384
                # methods, signals, etc. as created above.
 
1385
                cls = type(b"{}Alternate".format(cls.__name__),
 
1386
                           (cls, ), attr)
 
1387
        return cls
 
1388
    
 
1389
    return wrapper
 
1390
 
 
1391
 
 
1392
@alternate_dbus_interfaces({"se.recompile.Mandos":
 
1393
                            "se.bsnet.fukt.Mandos"})
1110
1394
class ClientDBus(Client, DBusObjectWithProperties):
1111
1395
    """A Client class using D-Bus
1112
1396
    
1116
1400
    """
1117
1401
    
1118
1402
    runtime_expansions = (Client.runtime_expansions
1119
 
                          + ("dbus_object_path",))
 
1403
                          + ("dbus_object_path", ))
 
1404
    
 
1405
    _interface = "se.recompile.Mandos.Client"
1120
1406
    
1121
1407
    # dbus.service.Object doesn't use super(), so we can't either.
1122
1408
    
1125
1411
        Client.__init__(self, *args, **kwargs)
1126
1412
        # Only now, when this client is initialized, can it show up on
1127
1413
        # the D-Bus
1128
 
        client_object_name = unicode(self.name).translate(
 
1414
        client_object_name = str(self.name).translate(
1129
1415
            {ord("."): ord("_"),
1130
1416
             ord("-"): ord("_")})
1131
 
        self.dbus_object_path = (dbus.ObjectPath
1132
 
                                 ("/clients/" + client_object_name))
 
1417
        self.dbus_object_path = dbus.ObjectPath(
 
1418
            "/clients/" + client_object_name)
1133
1419
        DBusObjectWithProperties.__init__(self, self.bus,
1134
1420
                                          self.dbus_object_path)
1135
 
        
1136
 
    def notifychangeproperty(transform_func,
1137
 
                             dbus_name, type_func=lambda x: x,
1138
 
                             variant_level=1):
 
1421
    
 
1422
    def notifychangeproperty(transform_func, dbus_name,
 
1423
                             type_func=lambda x: x,
 
1424
                             variant_level=1,
 
1425
                             invalidate_only=False,
 
1426
                             _interface=_interface):
1139
1427
        """ Modify a variable so that it's a property which announces
1140
1428
        its changes to DBus.
1141
1429
        
1146
1434
                   to the D-Bus.  Default: no transform
1147
1435
        variant_level: D-Bus variant level.  Default: 1
1148
1436
        """
1149
 
        attrname = "_{0}".format(dbus_name)
 
1437
        attrname = "_{}".format(dbus_name)
 
1438
        
1150
1439
        def setter(self, value):
1151
1440
            if hasattr(self, "dbus_object_path"):
1152
1441
                if (not hasattr(self, attrname) or
1153
1442
                    type_func(getattr(self, attrname, None))
1154
1443
                    != type_func(value)):
1155
 
                    dbus_value = transform_func(type_func(value),
1156
 
                                                variant_level
1157
 
                                                =variant_level)
1158
 
                    self.PropertyChanged(dbus.String(dbus_name),
1159
 
                                         dbus_value)
 
1444
                    if invalidate_only:
 
1445
                        self.PropertiesChanged(
 
1446
                            _interface, dbus.Dictionary(),
 
1447
                            dbus.Array((dbus_name, )))
 
1448
                    else:
 
1449
                        dbus_value = transform_func(
 
1450
                            type_func(value),
 
1451
                            variant_level = variant_level)
 
1452
                        self.PropertyChanged(dbus.String(dbus_name),
 
1453
                                             dbus_value)
 
1454
                        self.PropertiesChanged(
 
1455
                            _interface,
 
1456
                            dbus.Dictionary({ dbus.String(dbus_name):
 
1457
                                              dbus_value }),
 
1458
                            dbus.Array())
1160
1459
            setattr(self, attrname, value)
1161
1460
        
1162
1461
        return property(lambda self: getattr(self, attrname), setter)
1163
1462
    
1164
 
    
1165
1463
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1166
1464
    approvals_pending = notifychangeproperty(dbus.Boolean,
1167
1465
                                             "ApprovalPending",
1169
1467
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1170
1468
    last_enabled = notifychangeproperty(datetime_to_dbus,
1171
1469
                                        "LastEnabled")
1172
 
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1173
 
                                   type_func = lambda checker:
1174
 
                                       checker is not None)
 
1470
    checker = notifychangeproperty(
 
1471
        dbus.Boolean, "CheckerRunning",
 
1472
        type_func = lambda checker: checker is not None)
1175
1473
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1176
1474
                                           "LastCheckedOK")
1177
1475
    last_checker_status = notifychangeproperty(dbus.Int16,
1180
1478
        datetime_to_dbus, "LastApprovalRequest")
1181
1479
    approved_by_default = notifychangeproperty(dbus.Boolean,
1182
1480
                                               "ApprovedByDefault")
1183
 
    approval_delay = notifychangeproperty(dbus.UInt64,
1184
 
                                          "ApprovalDelay",
1185
 
                                          type_func =
1186
 
                                          timedelta_to_milliseconds)
 
1481
    approval_delay = notifychangeproperty(
 
1482
        dbus.UInt64, "ApprovalDelay",
 
1483
        type_func = lambda td: td.total_seconds() * 1000)
1187
1484
    approval_duration = notifychangeproperty(
1188
1485
        dbus.UInt64, "ApprovalDuration",
1189
 
        type_func = timedelta_to_milliseconds)
 
1486
        type_func = lambda td: td.total_seconds() * 1000)
1190
1487
    host = notifychangeproperty(dbus.String, "Host")
1191
 
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1192
 
                                   type_func =
1193
 
                                   timedelta_to_milliseconds)
 
1488
    timeout = notifychangeproperty(
 
1489
        dbus.UInt64, "Timeout",
 
1490
        type_func = lambda td: td.total_seconds() * 1000)
1194
1491
    extended_timeout = notifychangeproperty(
1195
1492
        dbus.UInt64, "ExtendedTimeout",
1196
 
        type_func = timedelta_to_milliseconds)
1197
 
    interval = notifychangeproperty(dbus.UInt64,
1198
 
                                    "Interval",
1199
 
                                    type_func =
1200
 
                                    timedelta_to_milliseconds)
 
1493
        type_func = lambda td: td.total_seconds() * 1000)
 
1494
    interval = notifychangeproperty(
 
1495
        dbus.UInt64, "Interval",
 
1496
        type_func = lambda td: td.total_seconds() * 1000)
1201
1497
    checker_command = notifychangeproperty(dbus.String, "Checker")
 
1498
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
 
1499
                                  invalidate_only=True)
1202
1500
    
1203
1501
    del notifychangeproperty
1204
1502
    
1211
1509
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
1212
1510
        Client.__del__(self, *args, **kwargs)
1213
1511
    
1214
 
    def checker_callback(self, pid, condition, command,
1215
 
                         *args, **kwargs):
1216
 
        self.checker_callback_tag = None
1217
 
        self.checker = None
1218
 
        if os.WIFEXITED(condition):
1219
 
            exitstatus = os.WEXITSTATUS(condition)
 
1512
    def checker_callback(self, source, condition,
 
1513
                         connection, command, *args, **kwargs):
 
1514
        ret = Client.checker_callback(self, source, condition,
 
1515
                                      connection, command, *args,
 
1516
                                      **kwargs)
 
1517
        exitstatus = self.last_checker_status
 
1518
        if exitstatus >= 0:
1220
1519
            # Emit D-Bus signal
1221
1520
            self.CheckerCompleted(dbus.Int16(exitstatus),
1222
 
                                  dbus.Int64(condition),
 
1521
                                  # This is specific to GNU libC
 
1522
                                  dbus.Int64(exitstatus << 8),
1223
1523
                                  dbus.String(command))
1224
1524
        else:
1225
1525
            # Emit D-Bus signal
1226
1526
            self.CheckerCompleted(dbus.Int16(-1),
1227
 
                                  dbus.Int64(condition),
 
1527
                                  dbus.Int64(
 
1528
                                      # This is specific to GNU libC
 
1529
                                      (exitstatus << 8)
 
1530
                                      | self.last_checker_signal),
1228
1531
                                  dbus.String(command))
1229
 
        
1230
 
        return Client.checker_callback(self, pid, condition, command,
1231
 
                                       *args, **kwargs)
 
1532
        return ret
1232
1533
    
1233
1534
    def start_checker(self, *args, **kwargs):
1234
 
        old_checker = self.checker
1235
 
        if self.checker is not None:
1236
 
            old_checker_pid = self.checker.pid
1237
 
        else:
1238
 
            old_checker_pid = None
 
1535
        old_checker_pid = getattr(self.checker, "pid", None)
1239
1536
        r = Client.start_checker(self, *args, **kwargs)
1240
1537
        # Only if new checker process was started
1241
1538
        if (self.checker is not None
1249
1546
        return False
1250
1547
    
1251
1548
    def approve(self, value=True):
1252
 
        self.send_changedstate()
1253
1549
        self.approved = value
1254
 
        gobject.timeout_add(timedelta_to_milliseconds
1255
 
                            (self.approval_duration),
1256
 
                            self._reset_approved)
1257
 
    
 
1550
        gobject.timeout_add(int(self.approval_duration.total_seconds()
 
1551
                                * 1000), self._reset_approved)
 
1552
        self.send_changedstate()
1258
1553
    
1259
1554
    ## D-Bus methods, signals & properties
1260
 
    _interface = "se.recompile.Mandos.Client"
1261
1555
    
1262
1556
    ## Interfaces
1263
1557
    
1264
 
    @dbus_interface_annotations(_interface)
1265
 
    def _foo(self):
1266
 
        return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1267
 
                     "false"}
1268
 
    
1269
1558
    ## Signals
1270
1559
    
1271
1560
    # CheckerCompleted - signal
1281
1570
        pass
1282
1571
    
1283
1572
    # PropertyChanged - signal
 
1573
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1284
1574
    @dbus.service.signal(_interface, signature="sv")
1285
1575
    def PropertyChanged(self, property, value):
1286
1576
        "D-Bus signal"
1320
1610
        self.checked_ok()
1321
1611
    
1322
1612
    # Enable - method
 
1613
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1323
1614
    @dbus.service.method(_interface)
1324
1615
    def Enable(self):
1325
1616
        "D-Bus method"
1326
1617
        self.enable()
1327
1618
    
1328
1619
    # StartChecker - method
 
1620
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1329
1621
    @dbus.service.method(_interface)
1330
1622
    def StartChecker(self):
1331
1623
        "D-Bus method"
1332
1624
        self.start_checker()
1333
1625
    
1334
1626
    # Disable - method
 
1627
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1335
1628
    @dbus.service.method(_interface)
1336
1629
    def Disable(self):
1337
1630
        "D-Bus method"
1338
1631
        self.disable()
1339
1632
    
1340
1633
    # StopChecker - method
 
1634
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1341
1635
    @dbus.service.method(_interface)
1342
1636
    def StopChecker(self):
1343
1637
        self.stop_checker()
1350
1644
        return dbus.Boolean(bool(self.approvals_pending))
1351
1645
    
1352
1646
    # ApprovedByDefault - property
1353
 
    @dbus_service_property(_interface, signature="b",
 
1647
    @dbus_service_property(_interface,
 
1648
                           signature="b",
1354
1649
                           access="readwrite")
1355
1650
    def ApprovedByDefault_dbus_property(self, value=None):
1356
1651
        if value is None:       # get
1358
1653
        self.approved_by_default = bool(value)
1359
1654
    
1360
1655
    # ApprovalDelay - property
1361
 
    @dbus_service_property(_interface, signature="t",
 
1656
    @dbus_service_property(_interface,
 
1657
                           signature="t",
1362
1658
                           access="readwrite")
1363
1659
    def ApprovalDelay_dbus_property(self, value=None):
1364
1660
        if value is None:       # get
1365
 
            return dbus.UInt64(self.approval_delay_milliseconds())
 
1661
            return dbus.UInt64(self.approval_delay.total_seconds()
 
1662
                               * 1000)
1366
1663
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1367
1664
    
1368
1665
    # ApprovalDuration - property
1369
 
    @dbus_service_property(_interface, signature="t",
 
1666
    @dbus_service_property(_interface,
 
1667
                           signature="t",
1370
1668
                           access="readwrite")
1371
1669
    def ApprovalDuration_dbus_property(self, value=None):
1372
1670
        if value is None:       # get
1373
 
            return dbus.UInt64(timedelta_to_milliseconds(
1374
 
                    self.approval_duration))
 
1671
            return dbus.UInt64(self.approval_duration.total_seconds()
 
1672
                               * 1000)
1375
1673
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1376
1674
    
1377
1675
    # Name - property
 
1676
    @dbus_annotations(
 
1677
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1378
1678
    @dbus_service_property(_interface, signature="s", access="read")
1379
1679
    def Name_dbus_property(self):
1380
1680
        return dbus.String(self.name)
1381
1681
    
1382
1682
    # Fingerprint - property
 
1683
    @dbus_annotations(
 
1684
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1383
1685
    @dbus_service_property(_interface, signature="s", access="read")
1384
1686
    def Fingerprint_dbus_property(self):
1385
1687
        return dbus.String(self.fingerprint)
1386
1688
    
1387
1689
    # Host - property
1388
 
    @dbus_service_property(_interface, signature="s",
 
1690
    @dbus_service_property(_interface,
 
1691
                           signature="s",
1389
1692
                           access="readwrite")
1390
1693
    def Host_dbus_property(self, value=None):
1391
1694
        if value is None:       # get
1392
1695
            return dbus.String(self.host)
1393
 
        self.host = unicode(value)
 
1696
        self.host = str(value)
1394
1697
    
1395
1698
    # Created - property
 
1699
    @dbus_annotations(
 
1700
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1396
1701
    @dbus_service_property(_interface, signature="s", access="read")
1397
1702
    def Created_dbus_property(self):
1398
1703
        return datetime_to_dbus(self.created)
1403
1708
        return datetime_to_dbus(self.last_enabled)
1404
1709
    
1405
1710
    # Enabled - property
1406
 
    @dbus_service_property(_interface, signature="b",
 
1711
    @dbus_service_property(_interface,
 
1712
                           signature="b",
1407
1713
                           access="readwrite")
1408
1714
    def Enabled_dbus_property(self, value=None):
1409
1715
        if value is None:       # get
1414
1720
            self.disable()
1415
1721
    
1416
1722
    # LastCheckedOK - property
1417
 
    @dbus_service_property(_interface, signature="s",
 
1723
    @dbus_service_property(_interface,
 
1724
                           signature="s",
1418
1725
                           access="readwrite")
1419
1726
    def LastCheckedOK_dbus_property(self, value=None):
1420
1727
        if value is not None:
1423
1730
        return datetime_to_dbus(self.last_checked_ok)
1424
1731
    
1425
1732
    # LastCheckerStatus - property
1426
 
    @dbus_service_property(_interface, signature="n",
1427
 
                           access="read")
 
1733
    @dbus_service_property(_interface, signature="n", access="read")
1428
1734
    def LastCheckerStatus_dbus_property(self):
1429
1735
        return dbus.Int16(self.last_checker_status)
1430
1736
    
1439
1745
        return datetime_to_dbus(self.last_approval_request)
1440
1746
    
1441
1747
    # Timeout - property
1442
 
    @dbus_service_property(_interface, signature="t",
 
1748
    @dbus_service_property(_interface,
 
1749
                           signature="t",
1443
1750
                           access="readwrite")
1444
1751
    def Timeout_dbus_property(self, value=None):
1445
1752
        if value is None:       # get
1446
 
            return dbus.UInt64(self.timeout_milliseconds())
 
1753
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
 
1754
        old_timeout = self.timeout
1447
1755
        self.timeout = datetime.timedelta(0, 0, 0, value)
1448
 
        # Reschedule timeout
 
1756
        # Reschedule disabling
1449
1757
        if self.enabled:
1450
1758
            now = datetime.datetime.utcnow()
1451
 
            time_to_die = timedelta_to_milliseconds(
1452
 
                (self.last_checked_ok + self.timeout) - now)
1453
 
            if time_to_die <= 0:
 
1759
            self.expires += self.timeout - old_timeout
 
1760
            if self.expires <= now:
1454
1761
                # The timeout has passed
1455
1762
                self.disable()
1456
1763
            else:
1457
 
                self.expires = (now +
1458
 
                                datetime.timedelta(milliseconds =
1459
 
                                                   time_to_die))
1460
1764
                if (getattr(self, "disable_initiator_tag", None)
1461
1765
                    is None):
1462
1766
                    return
1463
1767
                gobject.source_remove(self.disable_initiator_tag)
1464
 
                self.disable_initiator_tag = (gobject.timeout_add
1465
 
                                              (time_to_die,
1466
 
                                               self.disable))
 
1768
                self.disable_initiator_tag = gobject.timeout_add(
 
1769
                    int((self.expires - now).total_seconds() * 1000),
 
1770
                    self.disable)
1467
1771
    
1468
1772
    # ExtendedTimeout - property
1469
 
    @dbus_service_property(_interface, signature="t",
 
1773
    @dbus_service_property(_interface,
 
1774
                           signature="t",
1470
1775
                           access="readwrite")
1471
1776
    def ExtendedTimeout_dbus_property(self, value=None):
1472
1777
        if value is None:       # get
1473
 
            return dbus.UInt64(self.extended_timeout_milliseconds())
 
1778
            return dbus.UInt64(self.extended_timeout.total_seconds()
 
1779
                               * 1000)
1474
1780
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1475
1781
    
1476
1782
    # Interval - property
1477
 
    @dbus_service_property(_interface, signature="t",
 
1783
    @dbus_service_property(_interface,
 
1784
                           signature="t",
1478
1785
                           access="readwrite")
1479
1786
    def Interval_dbus_property(self, value=None):
1480
1787
        if value is None:       # get
1481
 
            return dbus.UInt64(self.interval_milliseconds())
 
1788
            return dbus.UInt64(self.interval.total_seconds() * 1000)
1482
1789
        self.interval = datetime.timedelta(0, 0, 0, value)
1483
1790
        if getattr(self, "checker_initiator_tag", None) is None:
1484
1791
            return
1485
1792
        if self.enabled:
1486
1793
            # Reschedule checker run
1487
1794
            gobject.source_remove(self.checker_initiator_tag)
1488
 
            self.checker_initiator_tag = (gobject.timeout_add
1489
 
                                          (value, self.start_checker))
1490
 
            self.start_checker()    # Start one now, too
 
1795
            self.checker_initiator_tag = gobject.timeout_add(
 
1796
                value, self.start_checker)
 
1797
            self.start_checker() # Start one now, too
1491
1798
    
1492
1799
    # Checker - property
1493
 
    @dbus_service_property(_interface, signature="s",
 
1800
    @dbus_service_property(_interface,
 
1801
                           signature="s",
1494
1802
                           access="readwrite")
1495
1803
    def Checker_dbus_property(self, value=None):
1496
1804
        if value is None:       # get
1497
1805
            return dbus.String(self.checker_command)
1498
 
        self.checker_command = unicode(value)
 
1806
        self.checker_command = str(value)
1499
1807
    
1500
1808
    # CheckerRunning - property
1501
 
    @dbus_service_property(_interface, signature="b",
 
1809
    @dbus_service_property(_interface,
 
1810
                           signature="b",
1502
1811
                           access="readwrite")
1503
1812
    def CheckerRunning_dbus_property(self, value=None):
1504
1813
        if value is None:       # get
1509
1818
            self.stop_checker()
1510
1819
    
1511
1820
    # ObjectPath - property
 
1821
    @dbus_annotations(
 
1822
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
 
1823
         "org.freedesktop.DBus.Deprecated": "true"})
1512
1824
    @dbus_service_property(_interface, signature="o", access="read")
1513
1825
    def ObjectPath_dbus_property(self):
1514
1826
        return self.dbus_object_path # is already a dbus.ObjectPath
1515
1827
    
1516
1828
    # Secret = property
1517
 
    @dbus_service_property(_interface, signature="ay",
1518
 
                           access="write", byte_arrays=True)
 
1829
    @dbus_annotations(
 
1830
        {"org.freedesktop.DBus.Property.EmitsChangedSignal":
 
1831
         "invalidates"})
 
1832
    @dbus_service_property(_interface,
 
1833
                           signature="ay",
 
1834
                           access="write",
 
1835
                           byte_arrays=True)
1519
1836
    def Secret_dbus_property(self, value):
1520
 
        self.secret = str(value)
 
1837
        self.secret = bytes(value)
1521
1838
    
1522
1839
    del _interface
1523
1840
 
1527
1844
        self._pipe = child_pipe
1528
1845
        self._pipe.send(('init', fpr, address))
1529
1846
        if not self._pipe.recv():
1530
 
            raise KeyError()
 
1847
            raise KeyError(fpr)
1531
1848
    
1532
1849
    def __getattribute__(self, name):
1533
1850
        if name == '_pipe':
1537
1854
        if data[0] == 'data':
1538
1855
            return data[1]
1539
1856
        if data[0] == 'function':
 
1857
            
1540
1858
            def func(*args, **kwargs):
1541
1859
                self._pipe.send(('funcall', name, args, kwargs))
1542
1860
                return self._pipe.recv()[1]
 
1861
            
1543
1862
            return func
1544
1863
    
1545
1864
    def __setattr__(self, name, value):
1548
1867
        self._pipe.send(('setattr', name, value))
1549
1868
 
1550
1869
 
1551
 
class ClientDBusTransitional(ClientDBus):
1552
 
    __metaclass__ = AlternateDBusNamesMetaclass
1553
 
 
1554
 
 
1555
1870
class ClientHandler(socketserver.BaseRequestHandler, object):
1556
1871
    """A class to handle client connections.
1557
1872
    
1561
1876
    def handle(self):
1562
1877
        with contextlib.closing(self.server.child_pipe) as child_pipe:
1563
1878
            logger.info("TCP connection from: %s",
1564
 
                        unicode(self.client_address))
 
1879
                        str(self.client_address))
1565
1880
            logger.debug("Pipe FD: %d",
1566
1881
                         self.server.child_pipe.fileno())
1567
1882
            
1568
 
            session = (gnutls.connection
1569
 
                       .ClientSession(self.request,
1570
 
                                      gnutls.connection
1571
 
                                      .X509Credentials()))
 
1883
            session = gnutls.connection.ClientSession(
 
1884
                self.request, gnutls.connection .X509Credentials())
1572
1885
            
1573
1886
            # Note: gnutls.connection.X509Credentials is really a
1574
1887
            # generic GnuTLS certificate credentials object so long as
1583
1896
            priority = self.server.gnutls_priority
1584
1897
            if priority is None:
1585
1898
                priority = "NORMAL"
1586
 
            (gnutls.library.functions
1587
 
             .gnutls_priority_set_direct(session._c_object,
1588
 
                                         priority, None))
 
1899
            gnutls.library.functions.gnutls_priority_set_direct(
 
1900
                session._c_object, priority, None)
1589
1901
            
1590
1902
            # Start communication using the Mandos protocol
1591
1903
            # Get protocol number
1593
1905
            logger.debug("Protocol version: %r", line)
1594
1906
            try:
1595
1907
                if int(line.strip().split()[0]) > 1:
1596
 
                    raise RuntimeError
 
1908
                    raise RuntimeError(line)
1597
1909
            except (ValueError, IndexError, RuntimeError) as error:
1598
1910
                logger.error("Unknown protocol version: %s", error)
1599
1911
                return
1611
1923
            approval_required = False
1612
1924
            try:
1613
1925
                try:
1614
 
                    fpr = self.fingerprint(self.peer_certificate
1615
 
                                           (session))
 
1926
                    fpr = self.fingerprint(
 
1927
                        self.peer_certificate(session))
1616
1928
                except (TypeError,
1617
1929
                        gnutls.errors.GNUTLSError) as error:
1618
1930
                    logger.warning("Bad certificate: %s", error)
1633
1945
                while True:
1634
1946
                    if not client.enabled:
1635
1947
                        logger.info("Client %s is disabled",
1636
 
                                       client.name)
 
1948
                                    client.name)
1637
1949
                        if self.server.use_dbus:
1638
1950
                            # Emit D-Bus signal
1639
1951
                            client.Rejected("Disabled")
1648
1960
                        if self.server.use_dbus:
1649
1961
                            # Emit D-Bus signal
1650
1962
                            client.NeedApproval(
1651
 
                                client.approval_delay_milliseconds(),
1652
 
                                client.approved_by_default)
 
1963
                                client.approval_delay.total_seconds()
 
1964
                                * 1000, client.approved_by_default)
1653
1965
                    else:
1654
1966
                        logger.warning("Client %s was not approved",
1655
1967
                                       client.name)
1661
1973
                    #wait until timeout or approved
1662
1974
                    time = datetime.datetime.now()
1663
1975
                    client.changedstate.acquire()
1664
 
                    (client.changedstate.wait
1665
 
                     (float(client.timedelta_to_milliseconds(delay)
1666
 
                            / 1000)))
 
1976
                    client.changedstate.wait(delay.total_seconds())
1667
1977
                    client.changedstate.release()
1668
1978
                    time2 = datetime.datetime.now()
1669
1979
                    if (time2 - time) >= delay:
1685
1995
                    try:
1686
1996
                        sent = session.send(client.secret[sent_size:])
1687
1997
                    except gnutls.errors.GNUTLSError as error:
1688
 
                        logger.warning("gnutls send failed")
 
1998
                        logger.warning("gnutls send failed",
 
1999
                                       exc_info=error)
1689
2000
                        return
1690
 
                    logger.debug("Sent: %d, remaining: %d",
1691
 
                                 sent, len(client.secret)
1692
 
                                 - (sent_size + sent))
 
2001
                    logger.debug("Sent: %d, remaining: %d", sent,
 
2002
                                 len(client.secret) - (sent_size
 
2003
                                                       + sent))
1693
2004
                    sent_size += sent
1694
2005
                
1695
2006
                logger.info("Sending secret to %s", client.name)
1705
2016
                try:
1706
2017
                    session.bye()
1707
2018
                except gnutls.errors.GNUTLSError as error:
1708
 
                    logger.warning("GnuTLS bye failed")
 
2019
                    logger.warning("GnuTLS bye failed",
 
2020
                                   exc_info=error)
1709
2021
    
1710
2022
    @staticmethod
1711
2023
    def peer_certificate(session):
1712
2024
        "Return the peer's OpenPGP certificate as a bytestring"
1713
2025
        # If not an OpenPGP certificate...
1714
 
        if (gnutls.library.functions
1715
 
            .gnutls_certificate_type_get(session._c_object)
 
2026
        if (gnutls.library.functions.gnutls_certificate_type_get(
 
2027
                session._c_object)
1716
2028
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1717
2029
            # ...do the normal thing
1718
2030
            return session.peer_certificate
1732
2044
    def fingerprint(openpgp):
1733
2045
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
1734
2046
        # New GnuTLS "datum" with the OpenPGP public key
1735
 
        datum = (gnutls.library.types
1736
 
                 .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1737
 
                                             ctypes.POINTER
1738
 
                                             (ctypes.c_ubyte)),
1739
 
                                 ctypes.c_uint(len(openpgp))))
 
2047
        datum = gnutls.library.types.gnutls_datum_t(
 
2048
            ctypes.cast(ctypes.c_char_p(openpgp),
 
2049
                        ctypes.POINTER(ctypes.c_ubyte)),
 
2050
            ctypes.c_uint(len(openpgp)))
1740
2051
        # New empty GnuTLS certificate
1741
2052
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
1742
 
        (gnutls.library.functions
1743
 
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
 
2053
        gnutls.library.functions.gnutls_openpgp_crt_init(
 
2054
            ctypes.byref(crt))
1744
2055
        # Import the OpenPGP public key into the certificate
1745
 
        (gnutls.library.functions
1746
 
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1747
 
                                    gnutls.library.constants
1748
 
                                    .GNUTLS_OPENPGP_FMT_RAW))
 
2056
        gnutls.library.functions.gnutls_openpgp_crt_import(
 
2057
            crt, ctypes.byref(datum),
 
2058
            gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
1749
2059
        # Verify the self signature in the key
1750
2060
        crtverify = ctypes.c_uint()
1751
 
        (gnutls.library.functions
1752
 
         .gnutls_openpgp_crt_verify_self(crt, 0,
1753
 
                                         ctypes.byref(crtverify)))
 
2061
        gnutls.library.functions.gnutls_openpgp_crt_verify_self(
 
2062
            crt, 0, ctypes.byref(crtverify))
1754
2063
        if crtverify.value != 0:
1755
2064
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1756
 
            raise (gnutls.errors.CertificateSecurityError
1757
 
                   ("Verify failed"))
 
2065
            raise gnutls.errors.CertificateSecurityError(
 
2066
                "Verify failed")
1758
2067
        # New buffer for the fingerprint
1759
2068
        buf = ctypes.create_string_buffer(20)
1760
2069
        buf_len = ctypes.c_size_t()
1761
2070
        # Get the fingerprint from the certificate into the buffer
1762
 
        (gnutls.library.functions
1763
 
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1764
 
                                             ctypes.byref(buf_len)))
 
2071
        gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
 
2072
            crt, ctypes.byref(buf), ctypes.byref(buf_len))
1765
2073
        # Deinit the certificate
1766
2074
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1767
2075
        # Convert the buffer to a Python bytestring
1773
2081
 
1774
2082
class MultiprocessingMixIn(object):
1775
2083
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
 
2084
    
1776
2085
    def sub_process_main(self, request, address):
1777
2086
        try:
1778
2087
            self.finish_request(request, address)
1783
2092
    def process_request(self, request, address):
1784
2093
        """Start a new process to process the request."""
1785
2094
        proc = multiprocessing.Process(target = self.sub_process_main,
1786
 
                                       args = (request,
1787
 
                                               address))
 
2095
                                       args = (request, address))
1788
2096
        proc.start()
1789
2097
        return proc
1790
2098
 
1791
2099
 
1792
2100
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1793
2101
    """ adds a pipe to the MixIn """
 
2102
    
1794
2103
    def process_request(self, request, client_address):
1795
2104
        """Overrides and wraps the original process_request().
1796
2105
        
1805
2114
    
1806
2115
    def add_pipe(self, parent_pipe, proc):
1807
2116
        """Dummy function; override as necessary"""
1808
 
        raise NotImplementedError
 
2117
        raise NotImplementedError()
1809
2118
 
1810
2119
 
1811
2120
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1817
2126
        interface:      None or a network interface name (string)
1818
2127
        use_ipv6:       Boolean; to use IPv6 or not
1819
2128
    """
 
2129
    
1820
2130
    def __init__(self, server_address, RequestHandlerClass,
1821
 
                 interface=None, use_ipv6=True):
 
2131
                 interface=None,
 
2132
                 use_ipv6=True,
 
2133
                 socketfd=None):
 
2134
        """If socketfd is set, use that file descriptor instead of
 
2135
        creating a new one with socket.socket().
 
2136
        """
1822
2137
        self.interface = interface
1823
2138
        if use_ipv6:
1824
2139
            self.address_family = socket.AF_INET6
 
2140
        if socketfd is not None:
 
2141
            # Save the file descriptor
 
2142
            self.socketfd = socketfd
 
2143
            # Save the original socket.socket() function
 
2144
            self.socket_socket = socket.socket
 
2145
            # To implement --socket, we monkey patch socket.socket.
 
2146
            # 
 
2147
            # (When socketserver.TCPServer is a new-style class, we
 
2148
            # could make self.socket into a property instead of monkey
 
2149
            # patching socket.socket.)
 
2150
            # 
 
2151
            # Create a one-time-only replacement for socket.socket()
 
2152
            @functools.wraps(socket.socket)
 
2153
            def socket_wrapper(*args, **kwargs):
 
2154
                # Restore original function so subsequent calls are
 
2155
                # not affected.
 
2156
                socket.socket = self.socket_socket
 
2157
                del self.socket_socket
 
2158
                # This time only, return a new socket object from the
 
2159
                # saved file descriptor.
 
2160
                return socket.fromfd(self.socketfd, *args, **kwargs)
 
2161
            # Replace socket.socket() function with wrapper
 
2162
            socket.socket = socket_wrapper
 
2163
        # The socketserver.TCPServer.__init__ will call
 
2164
        # socket.socket(), which might be our replacement,
 
2165
        # socket_wrapper(), if socketfd was set.
1825
2166
        socketserver.TCPServer.__init__(self, server_address,
1826
2167
                                        RequestHandlerClass)
 
2168
    
1827
2169
    def server_bind(self):
1828
2170
        """This overrides the normal server_bind() function
1829
2171
        to bind to an interface if one was specified, and also NOT to
1835
2177
                             self.interface)
1836
2178
            else:
1837
2179
                try:
1838
 
                    self.socket.setsockopt(socket.SOL_SOCKET,
1839
 
                                           SO_BINDTODEVICE,
1840
 
                                           str(self.interface
1841
 
                                               + '\0'))
 
2180
                    self.socket.setsockopt(
 
2181
                        socket.SOL_SOCKET, SO_BINDTODEVICE,
 
2182
                        (self.interface + "\0").encode("utf-8"))
1842
2183
                except socket.error as error:
1843
 
                    if error[0] == errno.EPERM:
1844
 
                        logger.error("No permission to"
1845
 
                                     " bind to interface %s",
1846
 
                                     self.interface)
1847
 
                    elif error[0] == errno.ENOPROTOOPT:
 
2184
                    if error.errno == errno.EPERM:
 
2185
                        logger.error("No permission to bind to"
 
2186
                                     " interface %s", self.interface)
 
2187
                    elif error.errno == errno.ENOPROTOOPT:
1848
2188
                        logger.error("SO_BINDTODEVICE not available;"
1849
2189
                                     " cannot bind to interface %s",
1850
2190
                                     self.interface)
 
2191
                    elif error.errno == errno.ENODEV:
 
2192
                        logger.error("Interface %s does not exist,"
 
2193
                                     " cannot bind", self.interface)
1851
2194
                    else:
1852
2195
                        raise
1853
2196
        # Only bind(2) the socket if we really need to.
1856
2199
                if self.address_family == socket.AF_INET6:
1857
2200
                    any_address = "::" # in6addr_any
1858
2201
                else:
1859
 
                    any_address = socket.INADDR_ANY
 
2202
                    any_address = "0.0.0.0" # INADDR_ANY
1860
2203
                self.server_address = (any_address,
1861
2204
                                       self.server_address[1])
1862
2205
            elif not self.server_address[1]:
1863
 
                self.server_address = (self.server_address[0],
1864
 
                                       0)
 
2206
                self.server_address = (self.server_address[0], 0)
1865
2207
#                 if self.interface:
1866
2208
#                     self.server_address = (self.server_address[0],
1867
2209
#                                            0, # port
1881
2223
    
1882
2224
    Assumes a gobject.MainLoop event loop.
1883
2225
    """
 
2226
    
1884
2227
    def __init__(self, server_address, RequestHandlerClass,
1885
 
                 interface=None, use_ipv6=True, clients=None,
1886
 
                 gnutls_priority=None, use_dbus=True):
 
2228
                 interface=None,
 
2229
                 use_ipv6=True,
 
2230
                 clients=None,
 
2231
                 gnutls_priority=None,
 
2232
                 use_dbus=True,
 
2233
                 socketfd=None):
1887
2234
        self.enabled = False
1888
2235
        self.clients = clients
1889
2236
        if self.clients is None:
1893
2240
        IPv6_TCPServer.__init__(self, server_address,
1894
2241
                                RequestHandlerClass,
1895
2242
                                interface = interface,
1896
 
                                use_ipv6 = use_ipv6)
 
2243
                                use_ipv6 = use_ipv6,
 
2244
                                socketfd = socketfd)
 
2245
    
1897
2246
    def server_activate(self):
1898
2247
        if self.enabled:
1899
2248
            return socketserver.TCPServer.server_activate(self)
1903
2252
    
1904
2253
    def add_pipe(self, parent_pipe, proc):
1905
2254
        # Call "handle_ipc" for both data and EOF events
1906
 
        gobject.io_add_watch(parent_pipe.fileno(),
1907
 
                             gobject.IO_IN | gobject.IO_HUP,
1908
 
                             functools.partial(self.handle_ipc,
1909
 
                                               parent_pipe =
1910
 
                                               parent_pipe,
1911
 
                                               proc = proc))
 
2255
        gobject.io_add_watch(
 
2256
            parent_pipe.fileno(),
 
2257
            gobject.IO_IN | gobject.IO_HUP,
 
2258
            functools.partial(self.handle_ipc,
 
2259
                              parent_pipe = parent_pipe,
 
2260
                              proc = proc))
1912
2261
    
1913
 
    def handle_ipc(self, source, condition, parent_pipe=None,
1914
 
                   proc = None, client_object=None):
1915
 
        condition_names = {
1916
 
            gobject.IO_IN: "IN",   # There is data to read.
1917
 
            gobject.IO_OUT: "OUT", # Data can be written (without
1918
 
                                    # blocking).
1919
 
            gobject.IO_PRI: "PRI", # There is urgent data to read.
1920
 
            gobject.IO_ERR: "ERR", # Error condition.
1921
 
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
1922
 
                                    # broken, usually for pipes and
1923
 
                                    # sockets).
1924
 
            }
1925
 
        conditions_string = ' | '.join(name
1926
 
                                       for cond, name in
1927
 
                                       condition_names.iteritems()
1928
 
                                       if cond & condition)
 
2262
    def handle_ipc(self, source, condition,
 
2263
                   parent_pipe=None,
 
2264
                   proc = None,
 
2265
                   client_object=None):
1929
2266
        # error, or the other end of multiprocessing.Pipe has closed
1930
 
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
 
2267
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
1931
2268
            # Wait for other process to exit
1932
2269
            proc.join()
1933
2270
            return False
1954
2291
                parent_pipe.send(False)
1955
2292
                return False
1956
2293
            
1957
 
            gobject.io_add_watch(parent_pipe.fileno(),
1958
 
                                 gobject.IO_IN | gobject.IO_HUP,
1959
 
                                 functools.partial(self.handle_ipc,
1960
 
                                                   parent_pipe =
1961
 
                                                   parent_pipe,
1962
 
                                                   proc = proc,
1963
 
                                                   client_object =
1964
 
                                                   client))
 
2294
            gobject.io_add_watch(
 
2295
                parent_pipe.fileno(),
 
2296
                gobject.IO_IN | gobject.IO_HUP,
 
2297
                functools.partial(self.handle_ipc,
 
2298
                                  parent_pipe = parent_pipe,
 
2299
                                  proc = proc,
 
2300
                                  client_object = client))
1965
2301
            parent_pipe.send(True)
1966
2302
            # remove the old hook in favor of the new above hook on
1967
2303
            # same fileno
1973
2309
            
1974
2310
            parent_pipe.send(('data', getattr(client_object,
1975
2311
                                              funcname)(*args,
1976
 
                                                         **kwargs)))
 
2312
                                                        **kwargs)))
1977
2313
        
1978
2314
        if command == 'getattr':
1979
2315
            attrname = request[1]
1980
 
            if callable(client_object.__getattribute__(attrname)):
1981
 
                parent_pipe.send(('function',))
 
2316
            if isinstance(client_object.__getattribute__(attrname),
 
2317
                          collections.Callable):
 
2318
                parent_pipe.send(('function', ))
1982
2319
            else:
1983
 
                parent_pipe.send(('data', client_object
1984
 
                                  .__getattribute__(attrname)))
 
2320
                parent_pipe.send((
 
2321
                    'data', client_object.__getattribute__(attrname)))
1985
2322
        
1986
2323
        if command == 'setattr':
1987
2324
            attrname = request[1]
1991
2328
        return True
1992
2329
 
1993
2330
 
 
2331
def rfc3339_duration_to_delta(duration):
 
2332
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
 
2333
    
 
2334
    >>> rfc3339_duration_to_delta("P7D")
 
2335
    datetime.timedelta(7)
 
2336
    >>> rfc3339_duration_to_delta("PT60S")
 
2337
    datetime.timedelta(0, 60)
 
2338
    >>> rfc3339_duration_to_delta("PT60M")
 
2339
    datetime.timedelta(0, 3600)
 
2340
    >>> rfc3339_duration_to_delta("PT24H")
 
2341
    datetime.timedelta(1)
 
2342
    >>> rfc3339_duration_to_delta("P1W")
 
2343
    datetime.timedelta(7)
 
2344
    >>> rfc3339_duration_to_delta("PT5M30S")
 
2345
    datetime.timedelta(0, 330)
 
2346
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
2347
    datetime.timedelta(1, 200)
 
2348
    """
 
2349
    
 
2350
    # Parsing an RFC 3339 duration with regular expressions is not
 
2351
    # possible - there would have to be multiple places for the same
 
2352
    # values, like seconds.  The current code, while more esoteric, is
 
2353
    # cleaner without depending on a parsing library.  If Python had a
 
2354
    # built-in library for parsing we would use it, but we'd like to
 
2355
    # avoid excessive use of external libraries.
 
2356
    
 
2357
    # New type for defining tokens, syntax, and semantics all-in-one
 
2358
    Token = collections.namedtuple("Token", (
 
2359
        "regexp",  # To match token; if "value" is not None, must have
 
2360
                   # a "group" containing digits
 
2361
        "value",   # datetime.timedelta or None
 
2362
        "followers"))           # Tokens valid after this token
 
2363
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
 
2364
    # the "duration" ABNF definition in RFC 3339, Appendix A.
 
2365
    token_end = Token(re.compile(r"$"), None, frozenset())
 
2366
    token_second = Token(re.compile(r"(\d+)S"),
 
2367
                         datetime.timedelta(seconds=1),
 
2368
                         frozenset((token_end, )))
 
2369
    token_minute = Token(re.compile(r"(\d+)M"),
 
2370
                         datetime.timedelta(minutes=1),
 
2371
                         frozenset((token_second, token_end)))
 
2372
    token_hour = Token(re.compile(r"(\d+)H"),
 
2373
                       datetime.timedelta(hours=1),
 
2374
                       frozenset((token_minute, token_end)))
 
2375
    token_time = Token(re.compile(r"T"),
 
2376
                       None,
 
2377
                       frozenset((token_hour, token_minute,
 
2378
                                  token_second)))
 
2379
    token_day = Token(re.compile(r"(\d+)D"),
 
2380
                      datetime.timedelta(days=1),
 
2381
                      frozenset((token_time, token_end)))
 
2382
    token_month = Token(re.compile(r"(\d+)M"),
 
2383
                        datetime.timedelta(weeks=4),
 
2384
                        frozenset((token_day, token_end)))
 
2385
    token_year = Token(re.compile(r"(\d+)Y"),
 
2386
                       datetime.timedelta(weeks=52),
 
2387
                       frozenset((token_month, token_end)))
 
2388
    token_week = Token(re.compile(r"(\d+)W"),
 
2389
                       datetime.timedelta(weeks=1),
 
2390
                       frozenset((token_end, )))
 
2391
    token_duration = Token(re.compile(r"P"), None,
 
2392
                           frozenset((token_year, token_month,
 
2393
                                      token_day, token_time,
 
2394
                                      token_week)))
 
2395
    # Define starting values
 
2396
    value = datetime.timedelta() # Value so far
 
2397
    found_token = None
 
2398
    followers = frozenset((token_duration, )) # Following valid tokens
 
2399
    s = duration                # String left to parse
 
2400
    # Loop until end token is found
 
2401
    while found_token is not token_end:
 
2402
        # Search for any currently valid tokens
 
2403
        for token in followers:
 
2404
            match = token.regexp.match(s)
 
2405
            if match is not None:
 
2406
                # Token found
 
2407
                if token.value is not None:
 
2408
                    # Value found, parse digits
 
2409
                    factor = int(match.group(1), 10)
 
2410
                    # Add to value so far
 
2411
                    value += factor * token.value
 
2412
                # Strip token from string
 
2413
                s = token.regexp.sub("", s, 1)
 
2414
                # Go to found token
 
2415
                found_token = token
 
2416
                # Set valid next tokens
 
2417
                followers = found_token.followers
 
2418
                break
 
2419
        else:
 
2420
            # No currently valid tokens were found
 
2421
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
2422
                             .format(duration))
 
2423
    # End token found
 
2424
    return value
 
2425
 
 
2426
 
1994
2427
def string_to_delta(interval):
1995
2428
    """Parse a string and return a datetime.timedelta
1996
2429
    
2007
2440
    >>> string_to_delta('5m 30s')
2008
2441
    datetime.timedelta(0, 330)
2009
2442
    """
 
2443
    
 
2444
    try:
 
2445
        return rfc3339_duration_to_delta(interval)
 
2446
    except ValueError:
 
2447
        pass
 
2448
    
2010
2449
    timevalue = datetime.timedelta(0)
2011
2450
    for s in interval.split():
2012
2451
        try:
2013
 
            suffix = unicode(s[-1])
 
2452
            suffix = s[-1]
2014
2453
            value = int(s[:-1])
2015
2454
            if suffix == "d":
2016
2455
                delta = datetime.timedelta(value)
2023
2462
            elif suffix == "w":
2024
2463
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2025
2464
            else:
2026
 
                raise ValueError("Unknown suffix %r" % suffix)
2027
 
        except (ValueError, IndexError) as e:
 
2465
                raise ValueError("Unknown suffix {!r}".format(suffix))
 
2466
        except IndexError as e:
2028
2467
            raise ValueError(*(e.args))
2029
2468
        timevalue += delta
2030
2469
    return timevalue
2046
2485
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2047
2486
        if not stat.S_ISCHR(os.fstat(null).st_mode):
2048
2487
            raise OSError(errno.ENODEV,
2049
 
                          "%s not a character device"
2050
 
                          % os.devnull)
 
2488
                          "{} not a character device"
 
2489
                          .format(os.devnull))
2051
2490
        os.dup2(null, sys.stdin.fileno())
2052
2491
        os.dup2(null, sys.stdout.fileno())
2053
2492
        os.dup2(null, sys.stderr.fileno())
2062
2501
    
2063
2502
    parser = argparse.ArgumentParser()
2064
2503
    parser.add_argument("-v", "--version", action="version",
2065
 
                        version = "%%(prog)s %s" % version,
 
2504
                        version = "%(prog)s {}".format(version),
2066
2505
                        help="show version number and exit")
2067
2506
    parser.add_argument("-i", "--interface", metavar="IF",
2068
2507
                        help="Bind to interface IF")
2074
2513
                        help="Run self-test")
2075
2514
    parser.add_argument("--debug", action="store_true",
2076
2515
                        help="Debug mode; run in foreground and log"
2077
 
                        " to terminal")
 
2516
                        " to terminal", default=None)
2078
2517
    parser.add_argument("--debuglevel", metavar="LEVEL",
2079
2518
                        help="Debug level for stdout output")
2080
2519
    parser.add_argument("--priority", help="GnuTLS"
2087
2526
                        " files")
2088
2527
    parser.add_argument("--no-dbus", action="store_false",
2089
2528
                        dest="use_dbus", help="Do not provide D-Bus"
2090
 
                        " system bus interface")
 
2529
                        " system bus interface", default=None)
2091
2530
    parser.add_argument("--no-ipv6", action="store_false",
2092
 
                        dest="use_ipv6", help="Do not use IPv6")
 
2531
                        dest="use_ipv6", help="Do not use IPv6",
 
2532
                        default=None)
2093
2533
    parser.add_argument("--no-restore", action="store_false",
2094
2534
                        dest="restore", help="Do not restore stored"
2095
 
                        " state")
 
2535
                        " state", default=None)
 
2536
    parser.add_argument("--socket", type=int,
 
2537
                        help="Specify a file descriptor to a network"
 
2538
                        " socket to use instead of creating one")
2096
2539
    parser.add_argument("--statedir", metavar="DIR",
2097
2540
                        help="Directory to save/restore state in")
 
2541
    parser.add_argument("--foreground", action="store_true",
 
2542
                        help="Run in foreground", default=None)
 
2543
    parser.add_argument("--no-zeroconf", action="store_false",
 
2544
                        dest="zeroconf", help="Do not use Zeroconf",
 
2545
                        default=None)
2098
2546
    
2099
2547
    options = parser.parse_args()
2100
2548
    
2101
2549
    if options.check:
2102
2550
        import doctest
2103
 
        doctest.testmod()
2104
 
        sys.exit()
 
2551
        fail_count, test_count = doctest.testmod()
 
2552
        sys.exit(os.EX_OK if fail_count == 0 else 1)
2105
2553
    
2106
2554
    # Default values for config file for server-global settings
2107
2555
    server_defaults = { "interface": "",
2109
2557
                        "port": "",
2110
2558
                        "debug": "False",
2111
2559
                        "priority":
2112
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
2560
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
 
2561
                        ":+SIGN-DSA-SHA256",
2113
2562
                        "servicename": "Mandos",
2114
2563
                        "use_dbus": "True",
2115
2564
                        "use_ipv6": "True",
2116
2565
                        "debuglevel": "",
2117
2566
                        "restore": "True",
2118
 
                        "statedir": "/var/lib/mandos"
2119
 
                        }
 
2567
                        "socket": "",
 
2568
                        "statedir": "/var/lib/mandos",
 
2569
                        "foreground": "False",
 
2570
                        "zeroconf": "True",
 
2571
                    }
2120
2572
    
2121
2573
    # Parse config file for server-global settings
2122
2574
    server_config = configparser.SafeConfigParser(server_defaults)
2123
2575
    del server_defaults
2124
 
    server_config.read(os.path.join(options.configdir,
2125
 
                                    "mandos.conf"))
 
2576
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
2126
2577
    # Convert the SafeConfigParser object to a dict
2127
2578
    server_settings = server_config.defaults()
2128
2579
    # Use the appropriate methods on the non-string config options
2129
 
    for option in ("debug", "use_dbus", "use_ipv6"):
 
2580
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2130
2581
        server_settings[option] = server_config.getboolean("DEFAULT",
2131
2582
                                                           option)
2132
2583
    if server_settings["port"]:
2133
2584
        server_settings["port"] = server_config.getint("DEFAULT",
2134
2585
                                                       "port")
 
2586
    if server_settings["socket"]:
 
2587
        server_settings["socket"] = server_config.getint("DEFAULT",
 
2588
                                                         "socket")
 
2589
        # Later, stdin will, and stdout and stderr might, be dup'ed
 
2590
        # over with an opened os.devnull.  But we don't want this to
 
2591
        # happen with a supplied network socket.
 
2592
        if 0 <= server_settings["socket"] <= 2:
 
2593
            server_settings["socket"] = os.dup(server_settings
 
2594
                                               ["socket"])
2135
2595
    del server_config
2136
2596
    
2137
2597
    # Override the settings from the config file with command line
2138
2598
    # options, if set.
2139
2599
    for option in ("interface", "address", "port", "debug",
2140
 
                   "priority", "servicename", "configdir",
2141
 
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2142
 
                   "statedir"):
 
2600
                   "priority", "servicename", "configdir", "use_dbus",
 
2601
                   "use_ipv6", "debuglevel", "restore", "statedir",
 
2602
                   "socket", "foreground", "zeroconf"):
2143
2603
        value = getattr(options, option)
2144
2604
        if value is not None:
2145
2605
            server_settings[option] = value
2146
2606
    del options
2147
2607
    # Force all strings to be unicode
2148
2608
    for option in server_settings.keys():
2149
 
        if type(server_settings[option]) is str:
2150
 
            server_settings[option] = unicode(server_settings[option])
 
2609
        if isinstance(server_settings[option], bytes):
 
2610
            server_settings[option] = (server_settings[option]
 
2611
                                       .decode("utf-8"))
 
2612
    # Force all boolean options to be boolean
 
2613
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
2614
                   "foreground", "zeroconf"):
 
2615
        server_settings[option] = bool(server_settings[option])
 
2616
    # Debug implies foreground
 
2617
    if server_settings["debug"]:
 
2618
        server_settings["foreground"] = True
2151
2619
    # Now we have our good server settings in "server_settings"
2152
2620
    
2153
2621
    ##################################################################
2154
2622
    
 
2623
    if (not server_settings["zeroconf"]
 
2624
        and not (server_settings["port"]
 
2625
                 or server_settings["socket"] != "")):
 
2626
        parser.error("Needs port or socket to work without Zeroconf")
 
2627
    
2155
2628
    # For convenience
2156
2629
    debug = server_settings["debug"]
2157
2630
    debuglevel = server_settings["debuglevel"]
2159
2632
    use_ipv6 = server_settings["use_ipv6"]
2160
2633
    stored_state_path = os.path.join(server_settings["statedir"],
2161
2634
                                     stored_state_file)
 
2635
    foreground = server_settings["foreground"]
 
2636
    zeroconf = server_settings["zeroconf"]
2162
2637
    
2163
2638
    if debug:
2164
2639
        initlogger(debug, logging.DEBUG)
2170
2645
            initlogger(debug, level)
2171
2646
    
2172
2647
    if server_settings["servicename"] != "Mandos":
2173
 
        syslogger.setFormatter(logging.Formatter
2174
 
                               ('Mandos (%s) [%%(process)d]:'
2175
 
                                ' %%(levelname)s: %%(message)s'
2176
 
                                % server_settings["servicename"]))
 
2648
        syslogger.setFormatter(
 
2649
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
2650
                              ' %(levelname)s: %(message)s'.format(
 
2651
                                  server_settings["servicename"])))
2177
2652
    
2178
2653
    # Parse config file with clients
2179
2654
    client_config = configparser.SafeConfigParser(Client
2184
2659
    global mandos_dbus_service
2185
2660
    mandos_dbus_service = None
2186
2661
    
2187
 
    tcp_server = MandosServer((server_settings["address"],
2188
 
                               server_settings["port"]),
2189
 
                              ClientHandler,
2190
 
                              interface=(server_settings["interface"]
2191
 
                                         or None),
2192
 
                              use_ipv6=use_ipv6,
2193
 
                              gnutls_priority=
2194
 
                              server_settings["priority"],
2195
 
                              use_dbus=use_dbus)
2196
 
    if not debug:
2197
 
        pidfilename = "/var/run/mandos.pid"
 
2662
    socketfd = None
 
2663
    if server_settings["socket"] != "":
 
2664
        socketfd = server_settings["socket"]
 
2665
    tcp_server = MandosServer(
 
2666
        (server_settings["address"], server_settings["port"]),
 
2667
        ClientHandler,
 
2668
        interface=(server_settings["interface"] or None),
 
2669
        use_ipv6=use_ipv6,
 
2670
        gnutls_priority=server_settings["priority"],
 
2671
        use_dbus=use_dbus,
 
2672
        socketfd=socketfd)
 
2673
    if not foreground:
 
2674
        pidfilename = "/run/mandos.pid"
 
2675
        if not os.path.isdir("/run/."):
 
2676
            pidfilename = "/var/run/mandos.pid"
 
2677
        pidfile = None
2198
2678
        try:
2199
 
            pidfile = open(pidfilename, "w")
2200
 
        except IOError:
2201
 
            logger.error("Could not open file %r", pidfilename)
 
2679
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
 
2680
        except IOError as e:
 
2681
            logger.error("Could not open file %r", pidfilename,
 
2682
                         exc_info=e)
2202
2683
    
2203
 
    try:
2204
 
        uid = pwd.getpwnam("_mandos").pw_uid
2205
 
        gid = pwd.getpwnam("_mandos").pw_gid
2206
 
    except KeyError:
 
2684
    for name in ("_mandos", "mandos", "nobody"):
2207
2685
        try:
2208
 
            uid = pwd.getpwnam("mandos").pw_uid
2209
 
            gid = pwd.getpwnam("mandos").pw_gid
 
2686
            uid = pwd.getpwnam(name).pw_uid
 
2687
            gid = pwd.getpwnam(name).pw_gid
 
2688
            break
2210
2689
        except KeyError:
2211
 
            try:
2212
 
                uid = pwd.getpwnam("nobody").pw_uid
2213
 
                gid = pwd.getpwnam("nobody").pw_gid
2214
 
            except KeyError:
2215
 
                uid = 65534
2216
 
                gid = 65534
 
2690
            continue
 
2691
    else:
 
2692
        uid = 65534
 
2693
        gid = 65534
2217
2694
    try:
2218
2695
        os.setgid(gid)
2219
2696
        os.setuid(uid)
2220
2697
    except OSError as error:
2221
 
        if error[0] != errno.EPERM:
2222
 
            raise error
 
2698
        if error.errno != errno.EPERM:
 
2699
            raise
2223
2700
    
2224
2701
    if debug:
2225
2702
        # Enable all possible GnuTLS debugging
2232
2709
        def debug_gnutls(level, string):
2233
2710
            logger.debug("GnuTLS: %s", string[:-1])
2234
2711
        
2235
 
        (gnutls.library.functions
2236
 
         .gnutls_global_set_log_function(debug_gnutls))
 
2712
        gnutls.library.functions.gnutls_global_set_log_function(
 
2713
            debug_gnutls)
2237
2714
        
2238
2715
        # Redirect stdin so all checkers get /dev/null
2239
2716
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2242
2719
            os.close(null)
2243
2720
    
2244
2721
    # Need to fork before connecting to D-Bus
2245
 
    if not debug:
 
2722
    if not foreground:
2246
2723
        # Close all input and output, do double fork, etc.
2247
2724
        daemon()
2248
2725
    
 
2726
    # multiprocessing will use threads, so before we use gobject we
 
2727
    # need to inform gobject that threads will be used.
2249
2728
    gobject.threads_init()
2250
2729
    
2251
2730
    global main_loop
2257
2736
    if use_dbus:
2258
2737
        try:
2259
2738
            bus_name = dbus.service.BusName("se.recompile.Mandos",
2260
 
                                            bus, do_not_queue=True)
2261
 
            old_bus_name = (dbus.service.BusName
2262
 
                            ("se.bsnet.fukt.Mandos", bus,
2263
 
                             do_not_queue=True))
2264
 
        except dbus.exceptions.NameExistsException as e:
2265
 
            logger.error(unicode(e) + ", disabling D-Bus")
 
2739
                                            bus,
 
2740
                                            do_not_queue=True)
 
2741
            old_bus_name = dbus.service.BusName(
 
2742
                "se.bsnet.fukt.Mandos", bus,
 
2743
                do_not_queue=True)
 
2744
        except dbus.exceptions.DBusException as e:
 
2745
            logger.error("Disabling D-Bus:", exc_info=e)
2266
2746
            use_dbus = False
2267
2747
            server_settings["use_dbus"] = False
2268
2748
            tcp_server.use_dbus = False
2269
 
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2270
 
    service = AvahiServiceToSyslog(name =
2271
 
                                   server_settings["servicename"],
2272
 
                                   servicetype = "_mandos._tcp",
2273
 
                                   protocol = protocol, bus = bus)
2274
 
    if server_settings["interface"]:
2275
 
        service.interface = (if_nametoindex
2276
 
                             (str(server_settings["interface"])))
 
2749
    if zeroconf:
 
2750
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
2751
        service = AvahiServiceToSyslog(
 
2752
            name = server_settings["servicename"],
 
2753
            servicetype = "_mandos._tcp",
 
2754
            protocol = protocol,
 
2755
            bus = bus)
 
2756
        if server_settings["interface"]:
 
2757
            service.interface = if_nametoindex(
 
2758
                server_settings["interface"].encode("utf-8"))
2277
2759
    
2278
2760
    global multiprocessing_manager
2279
2761
    multiprocessing_manager = multiprocessing.Manager()
2280
2762
    
2281
2763
    client_class = Client
2282
2764
    if use_dbus:
2283
 
        client_class = functools.partial(ClientDBusTransitional,
2284
 
                                         bus = bus)
 
2765
        client_class = functools.partial(ClientDBus, bus = bus)
2285
2766
    
2286
2767
    client_settings = Client.config_parser(client_config)
2287
2768
    old_client_settings = {}
2288
2769
    clients_data = {}
2289
2770
    
 
2771
    # This is used to redirect stdout and stderr for checker processes
 
2772
    global wnull
 
2773
    wnull = open(os.devnull, "w") # A writable /dev/null
 
2774
    # Only used if server is running in foreground but not in debug
 
2775
    # mode
 
2776
    if debug or not foreground:
 
2777
        wnull.close()
 
2778
    
2290
2779
    # Get client data and settings from last running state.
2291
2780
    if server_settings["restore"]:
2292
2781
        try:
2293
2782
            with open(stored_state_path, "rb") as stored_state:
2294
 
                clients_data, old_client_settings = (pickle.load
2295
 
                                                     (stored_state))
 
2783
                clients_data, old_client_settings = pickle.load(
 
2784
                    stored_state)
2296
2785
            os.remove(stored_state_path)
2297
2786
        except IOError as e:
2298
 
            logger.warning("Could not load persistent state: {0}"
2299
 
                           .format(e))
2300
 
            if e.errno != errno.ENOENT:
 
2787
            if e.errno == errno.ENOENT:
 
2788
                logger.warning("Could not load persistent state:"
 
2789
                               " {}".format(os.strerror(e.errno)))
 
2790
            else:
 
2791
                logger.critical("Could not load persistent state:",
 
2792
                                exc_info=e)
2301
2793
                raise
2302
2794
        except EOFError as e:
2303
2795
            logger.warning("Could not load persistent state: "
2304
 
                           "EOFError: {0}".format(e))
 
2796
                           "EOFError:",
 
2797
                           exc_info=e)
2305
2798
    
2306
2799
    with PGPEngine() as pgp:
2307
 
        for client_name, client in clients_data.iteritems():
 
2800
        for client_name, client in clients_data.items():
 
2801
            # Skip removed clients
 
2802
            if client_name not in client_settings:
 
2803
                continue
 
2804
            
2308
2805
            # Decide which value to use after restoring saved state.
2309
2806
            # We have three different values: Old config file,
2310
2807
            # new config file, and saved state.
2315
2812
                    # For each value in new config, check if it
2316
2813
                    # differs from the old config value (Except for
2317
2814
                    # the "secret" attribute)
2318
 
                    if (name != "secret" and
2319
 
                        value != old_client_settings[client_name]
2320
 
                        [name]):
 
2815
                    if (name != "secret"
 
2816
                        and (value !=
 
2817
                             old_client_settings[client_name][name])):
2321
2818
                        client[name] = value
2322
2819
                except KeyError:
2323
2820
                    pass
2324
2821
            
2325
2822
            # Clients who has passed its expire date can still be
2326
 
            # enabled if its last checker was successful.  Clients
 
2823
            # enabled if its last checker was successful.  A Client
2327
2824
            # whose checker succeeded before we stored its state is
2328
2825
            # assumed to have successfully run all checkers during
2329
2826
            # downtime.
2331
2828
                if datetime.datetime.utcnow() >= client["expires"]:
2332
2829
                    if not client["last_checked_ok"]:
2333
2830
                        logger.warning(
2334
 
                            "disabling client {0} - Client never "
2335
 
                            "performed a successful checker"
2336
 
                            .format(client_name))
 
2831
                            "disabling client {} - Client never "
 
2832
                            "performed a successful checker".format(
 
2833
                                client_name))
2337
2834
                        client["enabled"] = False
2338
2835
                    elif client["last_checker_status"] != 0:
2339
2836
                        logger.warning(
2340
 
                            "disabling client {0} - Client "
2341
 
                            "last checker failed with error code {1}"
2342
 
                            .format(client_name,
2343
 
                                    client["last_checker_status"]))
 
2837
                            "disabling client {} - Client last"
 
2838
                            " checker failed with error code"
 
2839
                            " {}".format(
 
2840
                                client_name,
 
2841
                                client["last_checker_status"]))
2344
2842
                        client["enabled"] = False
2345
2843
                    else:
2346
 
                        client["expires"] = (datetime.datetime
2347
 
                                             .utcnow()
2348
 
                                             + client["timeout"])
 
2844
                        client["expires"] = (
 
2845
                            datetime.datetime.utcnow()
 
2846
                            + client["timeout"])
2349
2847
                        logger.debug("Last checker succeeded,"
2350
 
                                     " keeping {0} enabled"
2351
 
                                     .format(client_name))
 
2848
                                     " keeping {} enabled".format(
 
2849
                                         client_name))
2352
2850
            try:
2353
 
                client["secret"] = (
2354
 
                    pgp.decrypt(client["encrypted_secret"],
2355
 
                                client_settings[client_name]
2356
 
                                ["secret"]))
 
2851
                client["secret"] = pgp.decrypt(
 
2852
                    client["encrypted_secret"],
 
2853
                    client_settings[client_name]["secret"])
2357
2854
            except PGPError:
2358
2855
                # If decryption fails, we use secret from new settings
2359
 
                logger.debug("Failed to decrypt {0} old secret"
2360
 
                             .format(client_name))
2361
 
                client["secret"] = (
2362
 
                    client_settings[client_name]["secret"])
2363
 
 
 
2856
                logger.debug("Failed to decrypt {} old secret".format(
 
2857
                    client_name))
 
2858
                client["secret"] = (client_settings[client_name]
 
2859
                                    ["secret"])
2364
2860
    
2365
2861
    # Add/remove clients based on new changes made to config
2366
2862
    for client_name in (set(old_client_settings)
2369
2865
    for client_name in (set(client_settings)
2370
2866
                        - set(old_client_settings)):
2371
2867
        clients_data[client_name] = client_settings[client_name]
2372
 
 
 
2868
    
2373
2869
    # Create all client objects
2374
 
    for client_name, client in clients_data.iteritems():
 
2870
    for client_name, client in clients_data.items():
2375
2871
        tcp_server.clients[client_name] = client_class(
2376
 
            name = client_name, settings = client)
 
2872
            name = client_name,
 
2873
            settings = client,
 
2874
            server_settings = server_settings)
2377
2875
    
2378
2876
    if not tcp_server.clients:
2379
2877
        logger.warning("No clients defined")
2380
 
        
2381
 
    if not debug:
2382
 
        try:
2383
 
            with pidfile:
2384
 
                pid = os.getpid()
2385
 
                pidfile.write(str(pid) + "\n".encode("utf-8"))
2386
 
            del pidfile
2387
 
        except IOError:
2388
 
            logger.error("Could not write to file %r with PID %d",
2389
 
                         pidfilename, pid)
2390
 
        except NameError:
2391
 
            # "pidfile" was never created
2392
 
            pass
 
2878
    
 
2879
    if not foreground:
 
2880
        if pidfile is not None:
 
2881
            pid = os.getpid()
 
2882
            try:
 
2883
                with pidfile:
 
2884
                    print(pid, file=pidfile)
 
2885
            except IOError:
 
2886
                logger.error("Could not write to file %r with PID %d",
 
2887
                             pidfilename, pid)
 
2888
        del pidfile
2393
2889
        del pidfilename
2394
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2395
2890
    
2396
2891
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2397
2892
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2398
2893
    
2399
2894
    if use_dbus:
2400
 
        class MandosDBusService(DBusObjectWithProperties):
 
2895
        
 
2896
        @alternate_dbus_interfaces(
 
2897
            { "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
 
2898
        class MandosDBusService(DBusObjectWithObjectManager):
2401
2899
            """A D-Bus proxy object"""
 
2900
            
2402
2901
            def __init__(self):
2403
2902
                dbus.service.Object.__init__(self, bus, "/")
 
2903
            
2404
2904
            _interface = "se.recompile.Mandos"
2405
2905
            
2406
 
            @dbus_interface_annotations(_interface)
2407
 
            def _foo(self):
2408
 
                return { "org.freedesktop.DBus.Property"
2409
 
                         ".EmitsChangedSignal":
2410
 
                             "false"}
2411
 
            
2412
2906
            @dbus.service.signal(_interface, signature="o")
2413
2907
            def ClientAdded(self, objpath):
2414
2908
                "D-Bus signal"
2419
2913
                "D-Bus signal"
2420
2914
                pass
2421
2915
            
 
2916
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
2917
                               "true"})
2422
2918
            @dbus.service.signal(_interface, signature="os")
2423
2919
            def ClientRemoved(self, objpath, name):
2424
2920
                "D-Bus signal"
2425
2921
                pass
2426
2922
            
 
2923
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
2924
                               "true"})
2427
2925
            @dbus.service.method(_interface, out_signature="ao")
2428
2926
            def GetAllClients(self):
2429
2927
                "D-Bus method"
2430
 
                return dbus.Array(c.dbus_object_path
2431
 
                                  for c in
 
2928
                return dbus.Array(c.dbus_object_path for c in
2432
2929
                                  tcp_server.clients.itervalues())
2433
2930
            
 
2931
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
2932
                               "true"})
2434
2933
            @dbus.service.method(_interface,
2435
2934
                                 out_signature="a{oa{sv}}")
2436
2935
            def GetAllClientsWithProperties(self):
2437
2936
                "D-Bus method"
2438
2937
                return dbus.Dictionary(
2439
 
                    ((c.dbus_object_path, c.GetAll(""))
2440
 
                     for c in tcp_server.clients.itervalues()),
 
2938
                    { c.dbus_object_path: c.GetAll(
 
2939
                        "se.recompile.Mandos.Client")
 
2940
                      for c in tcp_server.clients.itervalues() },
2441
2941
                    signature="oa{sv}")
2442
2942
            
2443
2943
            @dbus.service.method(_interface, in_signature="o")
2447
2947
                    if c.dbus_object_path == object_path:
2448
2948
                        del tcp_server.clients[c.name]
2449
2949
                        c.remove_from_connection()
2450
 
                        # Don't signal anything except ClientRemoved
 
2950
                        # Don't signal the disabling
2451
2951
                        c.disable(quiet=True)
2452
 
                        # Emit D-Bus signal
2453
 
                        self.ClientRemoved(object_path, c.name)
 
2952
                        # Emit D-Bus signal for removal
 
2953
                        self.client_removed_signal(c)
2454
2954
                        return
2455
2955
                raise KeyError(object_path)
2456
2956
            
2457
2957
            del _interface
 
2958
            
 
2959
            @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
 
2960
                                 out_signature = "a{oa{sa{sv}}}")
 
2961
            def GetManagedObjects(self):
 
2962
                """D-Bus method"""
 
2963
                return dbus.Dictionary(
 
2964
                    { client.dbus_object_path:
 
2965
                      dbus.Dictionary(
 
2966
                          { interface: client.GetAll(interface)
 
2967
                            for interface in
 
2968
                                 client._get_all_interface_names()})
 
2969
                      for client in tcp_server.clients.values()})
 
2970
            
 
2971
            def client_added_signal(self, client):
 
2972
                """Send the new standard signal and the old signal"""
 
2973
                if use_dbus:
 
2974
                    # New standard signal
 
2975
                    self.InterfacesAdded(
 
2976
                        client.dbus_object_path,
 
2977
                        dbus.Dictionary(
 
2978
                            { interface: client.GetAll(interface)
 
2979
                              for interface in
 
2980
                              client._get_all_interface_names()}))
 
2981
                    # Old signal
 
2982
                    self.ClientAdded(client.dbus_object_path)
 
2983
            
 
2984
            def client_removed_signal(self, client):
 
2985
                """Send the new standard signal and the old signal"""
 
2986
                if use_dbus:
 
2987
                    # New standard signal
 
2988
                    self.InterfacesRemoved(
 
2989
                        client.dbus_object_path,
 
2990
                        client._get_all_interface_names())
 
2991
                    # Old signal
 
2992
                    self.ClientRemoved(client.dbus_object_path,
 
2993
                                       client.name)
2458
2994
        
2459
 
        class MandosDBusServiceTransitional(MandosDBusService):
2460
 
            __metaclass__ = AlternateDBusNamesMetaclass
2461
 
        mandos_dbus_service = MandosDBusServiceTransitional()
 
2995
        mandos_dbus_service = MandosDBusService()
2462
2996
    
2463
2997
    def cleanup():
2464
2998
        "Cleanup function; run on exit"
2465
 
        service.cleanup()
 
2999
        if zeroconf:
 
3000
            service.cleanup()
2466
3001
        
2467
3002
        multiprocessing.active_children()
 
3003
        wnull.close()
2468
3004
        if not (tcp_server.clients or client_settings):
2469
3005
            return
2470
3006
        
2481
3017
                
2482
3018
                # A list of attributes that can not be pickled
2483
3019
                # + secret.
2484
 
                exclude = set(("bus", "changedstate", "secret",
2485
 
                               "checker"))
2486
 
                for name, typ in (inspect.getmembers
2487
 
                                  (dbus.service.Object)):
 
3020
                exclude = { "bus", "changedstate", "secret",
 
3021
                            "checker", "server_settings" }
 
3022
                for name, typ in inspect.getmembers(dbus.service
 
3023
                                                    .Object):
2488
3024
                    exclude.add(name)
2489
3025
                
2490
3026
                client_dict["encrypted_secret"] = (client
2497
3033
                del client_settings[client.name]["secret"]
2498
3034
        
2499
3035
        try:
2500
 
            tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2501
 
                                                prefix="clients-",
2502
 
                                                dir=os.path.dirname
2503
 
                                                (stored_state_path))
2504
 
            with os.fdopen(tempfd, "wb") as stored_state:
 
3036
            with tempfile.NamedTemporaryFile(
 
3037
                    mode='wb',
 
3038
                    suffix=".pickle",
 
3039
                    prefix='clients-',
 
3040
                    dir=os.path.dirname(stored_state_path),
 
3041
                    delete=False) as stored_state:
2505
3042
                pickle.dump((clients, client_settings), stored_state)
 
3043
                tempname = stored_state.name
2506
3044
            os.rename(tempname, stored_state_path)
2507
3045
        except (IOError, OSError) as e:
2508
 
            logger.warning("Could not save persistent state: {0}"
2509
 
                           .format(e))
2510
3046
            if not debug:
2511
3047
                try:
2512
3048
                    os.remove(tempname)
2513
3049
                except NameError:
2514
3050
                    pass
2515
 
            if e.errno not in set((errno.ENOENT, errno.EACCES,
2516
 
                                   errno.EEXIST)):
2517
 
                raise e
 
3051
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
 
3052
                logger.warning("Could not save persistent state: {}"
 
3053
                               .format(os.strerror(e.errno)))
 
3054
            else:
 
3055
                logger.warning("Could not save persistent state:",
 
3056
                               exc_info=e)
 
3057
                raise
2518
3058
        
2519
3059
        # Delete all clients, and settings from config
2520
3060
        while tcp_server.clients:
2521
3061
            name, client = tcp_server.clients.popitem()
2522
3062
            if use_dbus:
2523
3063
                client.remove_from_connection()
2524
 
            # Don't signal anything except ClientRemoved
 
3064
            # Don't signal the disabling
2525
3065
            client.disable(quiet=True)
2526
 
            if use_dbus:
2527
 
                # Emit D-Bus signal
2528
 
                mandos_dbus_service.ClientRemoved(client
2529
 
                                                  .dbus_object_path,
2530
 
                                                  client.name)
 
3066
            # Emit D-Bus signal for removal
 
3067
            mandos_dbus_service.client_removed_signal(client)
2531
3068
        client_settings.clear()
2532
3069
    
2533
3070
    atexit.register(cleanup)
2534
3071
    
2535
3072
    for client in tcp_server.clients.itervalues():
2536
3073
        if use_dbus:
2537
 
            # Emit D-Bus signal
2538
 
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
 
3074
            # Emit D-Bus signal for adding
 
3075
            mandos_dbus_service.client_added_signal(client)
2539
3076
        # Need to initiate checking of clients
2540
3077
        if client.enabled:
2541
3078
            client.init_checker()
2544
3081
    tcp_server.server_activate()
2545
3082
    
2546
3083
    # Find out what port we got
2547
 
    service.port = tcp_server.socket.getsockname()[1]
 
3084
    if zeroconf:
 
3085
        service.port = tcp_server.socket.getsockname()[1]
2548
3086
    if use_ipv6:
2549
3087
        logger.info("Now listening on address %r, port %d,"
2550
 
                    " flowinfo %d, scope_id %d"
2551
 
                    % tcp_server.socket.getsockname())
 
3088
                    " flowinfo %d, scope_id %d",
 
3089
                    *tcp_server.socket.getsockname())
2552
3090
    else:                       # IPv4
2553
 
        logger.info("Now listening on address %r, port %d"
2554
 
                    % tcp_server.socket.getsockname())
 
3091
        logger.info("Now listening on address %r, port %d",
 
3092
                    *tcp_server.socket.getsockname())
2555
3093
    
2556
3094
    #service.interface = tcp_server.socket.getsockname()[3]
2557
3095
    
2558
3096
    try:
2559
 
        # From the Avahi example code
2560
 
        try:
2561
 
            service.activate()
2562
 
        except dbus.exceptions.DBusException as error:
2563
 
            logger.critical("DBusException: %s", error)
2564
 
            cleanup()
2565
 
            sys.exit(1)
2566
 
        # End of Avahi example code
 
3097
        if zeroconf:
 
3098
            # From the Avahi example code
 
3099
            try:
 
3100
                service.activate()
 
3101
            except dbus.exceptions.DBusException as error:
 
3102
                logger.critical("D-Bus Exception", exc_info=error)
 
3103
                cleanup()
 
3104
                sys.exit(1)
 
3105
            # End of Avahi example code
2567
3106
        
2568
3107
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2569
3108
                             lambda *args, **kwargs:
2573
3112
        logger.debug("Starting main loop")
2574
3113
        main_loop.run()
2575
3114
    except AvahiError as error:
2576
 
        logger.critical("AvahiError: %s", error)
 
3115
        logger.critical("Avahi Error", exc_info=error)
2577
3116
        cleanup()
2578
3117
        sys.exit(1)
2579
3118
    except KeyboardInterrupt:
2584
3123
    # Must run before the D-Bus bus name gets deregistered
2585
3124
    cleanup()
2586
3125
 
 
3126
 
2587
3127
if __name__ == '__main__':
2588
3128
    main()