/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

Miscellaneous fixes prompted by lintian:

* debian/control (Conflicts): Changed to "Breaks:".
* debian/copyright: Updated format.
* debian/mandos-client.postinst: Use "set -e" instead of "#!/bin/sh -e".
* debian/mandos-client.postrm: - '' -
* debian/mandos.postinst: - '' -
* debian/mandos.prerm: Consistent magic.
* mandos: Small comment change.
* mandos-clients.conf.xml (OPTIONS/extended_timeout): Fix spelling.

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