/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2014-07-14 21:41:08 UTC
  • Revision ID: teddy@recompile.se-20140714214108-awg7u6gaiy7d40dz
mandos-monitor: New "verbose" mode to see less important log messages.

* mandos-monitor (MandosClientWidget.__init__): Log client creation.
  (MandosClientWidget.checker_completed): Log a successful checker.
  (MandosClientWidget.checker_started): Log starting of a checker.
  (UserInterface.__init__): New optional "log_level" argument.
  (UserInterface.log_message, UserInterface.log_message_raw): Take
                                                              optional
                                                              "level"
                                                              arg.
  (UserInterface.toggle_log_display): Log visibility change.
  (UserInterface.change_log_display): Log wrap mode change.
  (UserInterface.process_input): Show new "v" key in help message and
                                 process "v" key if pressed.
* mandos-monitor.xml (KEYS): Document new "v" key.

Show diffs side-by-side

added added

removed removed

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