/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

* mandos (Client.checked_ok): Set "expires" after setting timeout.
  (MultiprocessingMixIn.process_request): Return process object.
  (MultiprocessingMixInWithPipe.process_request): Receive proc object
                                                  and pass it to
                                                  add_pipe.  Do not
                                                  use super().
  (MultiprocessingMixInWithPipe.add_pipe): Take "proc" argument.  All
                                           callers changed.
  (MandosServer.add_pipe): Take "proc" argument.  All callers changed.
  (MandosServer.handle_ipc): Take "proc" argument.  All callers
                             changed.  Wait for process completion
                             when pipe closes.
  (main/cleanup): Remove any zombies.

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-2012 Teddy Hogeborn
15
 
# Copyright © 2008-2012 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
66
 
72
67
import dbus
73
68
import dbus.service
78
73
import ctypes.util
79
74
import xml.dom.minidom
80
75
import inspect
81
 
import GnuPGInterface
82
76
 
83
77
try:
84
78
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
88
82
    except ImportError:
89
83
        SO_BINDTODEVICE = None
90
84
 
91
 
version = "1.6.0"
92
 
stored_state_file = "clients.pickle"
93
 
 
94
 
logger = logging.getLogger()
 
85
 
 
86
version = "1.3.1"
 
87
 
 
88
#logger = logging.getLogger('mandos')
 
89
logger = logging.Logger('mandos')
95
90
syslogger = (logging.handlers.SysLogHandler
96
91
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
97
92
              address = str("/dev/log")))
98
 
 
99
 
try:
100
 
    if_nametoindex = (ctypes.cdll.LoadLibrary
101
 
                      (ctypes.util.find_library("c"))
102
 
                      .if_nametoindex)
103
 
except (OSError, AttributeError):
104
 
    def if_nametoindex(interface):
105
 
        "Get an interface index the hard way, i.e. using fcntl()"
106
 
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
107
 
        with contextlib.closing(socket.socket()) as s:
108
 
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
109
 
                                struct.pack(str("16s16x"),
110
 
                                            interface))
111
 
        interface_index = struct.unpack(str("I"),
112
 
                                        ifreq[16:20])[0]
113
 
        return interface_index
114
 
 
115
 
 
116
 
def initlogger(debug, level=logging.WARNING):
117
 
    """init logger and add loglevel"""
118
 
    
119
 
    syslogger.setFormatter(logging.Formatter
120
 
                           ('Mandos [%(process)d]: %(levelname)s:'
121
 
                            ' %(message)s'))
122
 
    logger.addHandler(syslogger)
123
 
    
124
 
    if debug:
125
 
        console = logging.StreamHandler()
126
 
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
127
 
                                               ' [%(process)d]:'
128
 
                                               ' %(levelname)s:'
129
 
                                               ' %(message)s'))
130
 
        logger.addHandler(console)
131
 
    logger.setLevel(level)
132
 
 
133
 
 
134
 
class PGPError(Exception):
135
 
    """Exception if encryption/decryption fails"""
136
 
    pass
137
 
 
138
 
 
139
 
class PGPEngine(object):
140
 
    """A simple class for OpenPGP symmetric encryption & decryption"""
141
 
    def __init__(self):
142
 
        self.gnupg = GnuPGInterface.GnuPG()
143
 
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
144
 
        self.gnupg = GnuPGInterface.GnuPG()
145
 
        self.gnupg.options.meta_interactive = False
146
 
        self.gnupg.options.homedir = self.tempdir
147
 
        self.gnupg.options.extra_args.extend(['--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
 
        return b"mandos" + binascii.hexlify(password)
178
 
    
179
 
    def encrypt(self, data, password):
180
 
        self.gnupg.passphrase = self.password_encode(password)
181
 
        with open(os.devnull, "w") as devnull:
182
 
            try:
183
 
                proc = self.gnupg.run(['--symmetric'],
184
 
                                      create_fhs=['stdin', 'stdout'],
185
 
                                      attach_fhs={'stderr': devnull})
186
 
                with contextlib.closing(proc.handles['stdin']) as f:
187
 
                    f.write(data)
188
 
                with contextlib.closing(proc.handles['stdout']) as f:
189
 
                    ciphertext = f.read()
190
 
                proc.wait()
191
 
            except IOError as e:
192
 
                raise PGPError(e)
193
 
        self.gnupg.passphrase = None
194
 
        return ciphertext
195
 
    
196
 
    def decrypt(self, data, password):
197
 
        self.gnupg.passphrase = self.password_encode(password)
198
 
        with open(os.devnull, "w") as devnull:
199
 
            try:
200
 
                proc = self.gnupg.run(['--decrypt'],
201
 
                                      create_fhs=['stdin', 'stdout'],
202
 
                                      attach_fhs={'stderr': devnull})
203
 
                with contextlib.closing(proc.handles['stdin']) as f:
204
 
                    f.write(data)
205
 
                with contextlib.closing(proc.handles['stdout']) as f:
206
 
                    decrypted_plaintext = f.read()
207
 
                proc.wait()
208
 
            except IOError as e:
209
 
                raise PGPError(e)
210
 
        self.gnupg.passphrase = None
211
 
        return decrypted_plaintext
212
 
 
 
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)
213
103
 
214
104
class AvahiError(Exception):
215
105
    def __init__(self, value, *args, **kwargs):
245
135
    server: D-Bus Server
246
136
    bus: dbus.SystemBus()
247
137
    """
248
 
    
249
138
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
250
139
                 servicetype = None, port = None, TXT = None,
251
140
                 domain = "", host = "", max_renames = 32768,
264
153
        self.server = None
265
154
        self.bus = bus
266
155
        self.entry_group_state_changed_match = None
267
 
    
268
156
    def rename(self):
269
157
        """Derived from the Avahi example code"""
270
158
        if self.rename_count >= self.max_renames:
276
164
                            .GetAlternativeServiceName(self.name))
277
165
        logger.info("Changing Zeroconf service name to %r ...",
278
166
                    self.name)
 
167
        syslogger.setFormatter(logging.Formatter
 
168
                               ('Mandos (%s) [%%(process)d]:'
 
169
                                ' %%(levelname)s: %%(message)s'
 
170
                                % self.name))
279
171
        self.remove()
280
172
        try:
281
173
            self.add()
282
174
        except dbus.exceptions.DBusException as error:
283
 
            logger.critical("D-Bus Exception", exc_info=error)
 
175
            logger.critical("DBusException: %s", error)
284
176
            self.cleanup()
285
177
            os._exit(1)
286
178
        self.rename_count += 1
287
 
    
288
179
    def remove(self):
289
180
        """Derived from the Avahi example code"""
290
181
        if self.entry_group_state_changed_match is not None:
292
183
            self.entry_group_state_changed_match = None
293
184
        if self.group is not None:
294
185
            self.group.Reset()
295
 
    
296
186
    def add(self):
297
187
        """Derived from the Avahi example code"""
298
188
        self.remove()
303
193
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
304
194
        self.entry_group_state_changed_match = (
305
195
            self.group.connect_to_signal(
306
 
                'StateChanged', self.entry_group_state_changed))
 
196
                'StateChanged', self .entry_group_state_changed))
307
197
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
308
198
                     self.name, self.type)
309
199
        self.group.AddService(
315
205
            dbus.UInt16(self.port),
316
206
            avahi.string_array_to_txt_array(self.TXT))
317
207
        self.group.Commit()
318
 
    
319
208
    def entry_group_state_changed(self, state, error):
320
209
        """Derived from the Avahi example code"""
321
210
        logger.debug("Avahi entry group state change: %i", state)
328
217
        elif state == avahi.ENTRY_GROUP_FAILURE:
329
218
            logger.critical("Avahi: Error in group state changed %s",
330
219
                            unicode(error))
331
 
            raise AvahiGroupError("State changed: {0!s}"
332
 
                                  .format(error))
333
 
    
 
220
            raise AvahiGroupError("State changed: %s"
 
221
                                  % unicode(error))
334
222
    def cleanup(self):
335
223
        """Derived from the Avahi example code"""
336
224
        if self.group is not None:
337
225
            try:
338
226
                self.group.Free()
339
227
            except (dbus.exceptions.UnknownMethodException,
340
 
                    dbus.exceptions.DBusException):
 
228
                    dbus.exceptions.DBusException) as e:
341
229
                pass
342
230
            self.group = None
343
231
        self.remove()
344
 
    
345
232
    def server_state_changed(self, state, error=None):
346
233
        """Derived from the Avahi example code"""
347
234
        logger.debug("Avahi server state change: %i", state)
366
253
                logger.debug("Unknown state: %r", state)
367
254
            else:
368
255
                logger.debug("Unknown state: %r: %r", state, error)
369
 
    
370
256
    def activate(self):
371
257
        """Derived from the Avahi example code"""
372
258
        if self.server is None:
380
266
        self.server_state_changed(self.server.GetState())
381
267
 
382
268
 
383
 
class AvahiServiceToSyslog(AvahiService):
384
 
    def rename(self):
385
 
        """Add the new name to the syslog messages"""
386
 
        ret = AvahiService.rename(self)
387
 
        syslogger.setFormatter(logging.Formatter
388
 
                               ('Mandos ({0}) [%(process)d]:'
389
 
                                ' %(levelname)s: %(message)s'
390
 
                                .format(self.name)))
391
 
        return ret
392
 
 
393
 
 
394
 
def timedelta_to_milliseconds(td):
 
269
def _timedelta_to_milliseconds(td):
395
270
    "Convert a datetime.timedelta() to milliseconds"
396
271
    return ((td.days * 24 * 60 * 60 * 1000)
397
272
            + (td.seconds * 1000)
398
273
            + (td.microseconds // 1000))
399
 
 
400
 
 
 
274
        
401
275
class Client(object):
402
276
    """A representation of a client host served by this server.
403
277
    
404
278
    Attributes:
405
 
    approved:   bool(); 'None' if not yet approved/disapproved
 
279
    _approved:   bool(); 'None' if not yet approved/disapproved
406
280
    approval_delay: datetime.timedelta(); Time to wait for approval
407
281
    approval_duration: datetime.timedelta(); Duration of one approval
408
282
    checker:    subprocess.Popen(); a running checker process used
415
289
                     instance %(name)s can be used in the command.
416
290
    checker_initiator_tag: a gobject event source tag, or None
417
291
    created:    datetime.datetime(); (UTC) object creation
418
 
    client_structure: Object describing what attributes a client has
419
 
                      and is used for storing the client at exit
420
292
    current_checker_command: string; current running checker_command
 
293
    disable_hook:  If set, called by disable() as disable_hook(self)
421
294
    disable_initiator_tag: a gobject event source tag, or None
422
295
    enabled:    bool()
423
296
    fingerprint: string (40 or 32 hexadecimal digits); used to
426
299
    interval:   datetime.timedelta(); How often to start a new checker
427
300
    last_approval_request: datetime.datetime(); (UTC) or None
428
301
    last_checked_ok: datetime.datetime(); (UTC) or None
429
 
    last_checker_status: integer between 0 and 255 reflecting exit
430
 
                         status of last checker. -1 reflects crashed
431
 
                         checker, -2 means no checker completed yet.
432
 
    last_enabled: datetime.datetime(); (UTC) or None
 
302
    last_enabled: datetime.datetime(); (UTC)
433
303
    name:       string; from the config file, used in log messages and
434
304
                        D-Bus identifiers
435
305
    secret:     bytestring; sent verbatim (over TLS) to client
436
306
    timeout:    datetime.timedelta(); How long from last_checked_ok
437
307
                                      until this client is disabled
438
 
    extended_timeout:   extra long timeout when secret has been sent
 
308
    extended_timeout:   extra long timeout when password has been sent
439
309
    runtime_expansions: Allowed attributes for runtime expansion.
440
310
    expires:    datetime.datetime(); time (UTC) when a client will be
441
311
                disabled, or None
442
312
    """
443
313
    
444
314
    runtime_expansions = ("approval_delay", "approval_duration",
445
 
                          "created", "enabled", "expires",
446
 
                          "fingerprint", "host", "interval",
447
 
                          "last_approval_request", "last_checked_ok",
 
315
                          "created", "enabled", "fingerprint",
 
316
                          "host", "interval", "last_checked_ok",
448
317
                          "last_enabled", "name", "timeout")
449
 
    client_defaults = { "timeout": "5m",
450
 
                        "extended_timeout": "15m",
451
 
                        "interval": "2m",
452
 
                        "checker": "fping -q -- %%(host)s",
453
 
                        "host": "",
454
 
                        "approval_delay": "0s",
455
 
                        "approval_duration": "1s",
456
 
                        "approved_by_default": "True",
457
 
                        "enabled": "True",
458
 
                        }
459
318
    
460
319
    def timeout_milliseconds(self):
461
320
        "Return the 'timeout' attribute in milliseconds"
462
 
        return timedelta_to_milliseconds(self.timeout)
 
321
        return _timedelta_to_milliseconds(self.timeout)
463
322
    
464
323
    def extended_timeout_milliseconds(self):
465
324
        "Return the 'extended_timeout' attribute in milliseconds"
466
 
        return timedelta_to_milliseconds(self.extended_timeout)
 
325
        return _timedelta_to_milliseconds(self.extended_timeout)
467
326
    
468
327
    def interval_milliseconds(self):
469
328
        "Return the 'interval' attribute in milliseconds"
470
 
        return timedelta_to_milliseconds(self.interval)
 
329
        return _timedelta_to_milliseconds(self.interval)
471
330
    
472
331
    def approval_delay_milliseconds(self):
473
 
        return timedelta_to_milliseconds(self.approval_delay)
474
 
    
475
 
    @staticmethod
476
 
    def config_parser(config):
477
 
        """Construct a new dict of client settings of this form:
478
 
        { client_name: {setting_name: value, ...}, ...}
479
 
        with exceptions for any special settings as defined above.
480
 
        NOTE: Must be a pure function. Must return the same result
481
 
        value given the same arguments.
482
 
        """
483
 
        settings = {}
484
 
        for client_name in config.sections():
485
 
            section = dict(config.items(client_name))
486
 
            client = settings[client_name] = {}
487
 
            
488
 
            client["host"] = section["host"]
489
 
            # Reformat values from string types to Python types
490
 
            client["approved_by_default"] = config.getboolean(
491
 
                client_name, "approved_by_default")
492
 
            client["enabled"] = config.getboolean(client_name,
493
 
                                                  "enabled")
494
 
            
495
 
            client["fingerprint"] = (section["fingerprint"].upper()
496
 
                                     .replace(" ", ""))
497
 
            if "secret" in section:
498
 
                client["secret"] = section["secret"].decode("base64")
499
 
            elif "secfile" in section:
500
 
                with open(os.path.expanduser(os.path.expandvars
501
 
                                             (section["secfile"])),
502
 
                          "rb") as secfile:
503
 
                    client["secret"] = secfile.read()
504
 
            else:
505
 
                raise TypeError("No secret or secfile for section {0}"
506
 
                                .format(section))
507
 
            client["timeout"] = string_to_delta(section["timeout"])
508
 
            client["extended_timeout"] = string_to_delta(
509
 
                section["extended_timeout"])
510
 
            client["interval"] = string_to_delta(section["interval"])
511
 
            client["approval_delay"] = string_to_delta(
512
 
                section["approval_delay"])
513
 
            client["approval_duration"] = string_to_delta(
514
 
                section["approval_duration"])
515
 
            client["checker_command"] = section["checker"]
516
 
            client["last_approval_request"] = None
517
 
            client["last_checked_ok"] = None
518
 
            client["last_checker_status"] = -2
519
 
        
520
 
        return settings
521
 
    
522
 
    def __init__(self, settings, name = 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."""
523
338
        self.name = name
524
 
        # adding all client settings
525
 
        for setting, value in settings.iteritems():
526
 
            setattr(self, setting, value)
527
 
        
528
 
        if self.enabled:
529
 
            if not hasattr(self, "last_enabled"):
530
 
                self.last_enabled = datetime.datetime.utcnow()
531
 
            if not hasattr(self, "expires"):
532
 
                self.expires = (datetime.datetime.utcnow()
533
 
                                + self.timeout)
534
 
        else:
535
 
            self.last_enabled = None
536
 
            self.expires = None
537
 
        
 
339
        if config is None:
 
340
            config = {}
538
341
        logger.debug("Creating client %r", self.name)
539
342
        # Uppercase and remove spaces from fingerprint for later
540
343
        # comparison purposes with return value from the fingerprint()
541
344
        # function
 
345
        self.fingerprint = (config["fingerprint"].upper()
 
346
                            .replace(" ", ""))
542
347
        logger.debug("  Fingerprint: %s", self.fingerprint)
543
 
        self.created = settings.get("created",
544
 
                                    datetime.datetime.utcnow())
545
 
        
546
 
        # 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
547
369
        self.checker = None
548
370
        self.checker_initiator_tag = None
549
371
        self.disable_initiator_tag = None
 
372
        self.expires = None
550
373
        self.checker_callback_tag = None
 
374
        self.checker_command = config["checker"]
551
375
        self.current_checker_command = None
552
 
        self.approved = None
 
376
        self.last_connect = None
 
377
        self._approved = None
 
378
        self.approved_by_default = config.get("approved_by_default",
 
379
                                              True)
553
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"])
554
385
        self.changedstate = (multiprocessing_manager
555
386
                             .Condition(multiprocessing_manager
556
387
                                        .Lock()))
557
 
        self.client_structure = [attr for attr in
558
 
                                 self.__dict__.iterkeys()
559
 
                                 if not attr.startswith("_")]
560
 
        self.client_structure.append("client_structure")
561
 
        
562
 
        for name, t in inspect.getmembers(type(self),
563
 
                                          lambda obj:
564
 
                                              isinstance(obj,
565
 
                                                         property)):
566
 
            if not name.startswith("_"):
567
 
                self.client_structure.append(name)
568
388
    
569
 
    # Send notice to process children that client state has changed
570
389
    def send_changedstate(self):
571
 
        with self.changedstate:
572
 
            self.changedstate.notify_all()
 
390
        self.changedstate.acquire()
 
391
        self.changedstate.notify_all()
 
392
        self.changedstate.release()
573
393
    
574
394
    def enable(self):
575
395
        """Start this client's checker and timeout hooks"""
576
396
        if getattr(self, "enabled", False):
577
397
            # Already enabled
578
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
579
406
        self.expires = datetime.datetime.utcnow() + self.timeout
 
407
        self.disable_initiator_tag = (gobject.timeout_add
 
408
                                   (self.timeout_milliseconds(),
 
409
                                    self.disable))
580
410
        self.enabled = True
581
411
        self.last_enabled = datetime.datetime.utcnow()
582
 
        self.init_checker()
583
 
        self.send_changedstate()
 
412
        # Also start a new checker *right now*.
 
413
        self.start_checker()
584
414
    
585
415
    def disable(self, quiet=True):
586
416
        """Disable this client."""
587
417
        if not getattr(self, "enabled", False):
588
418
            return False
589
419
        if not quiet:
 
420
            self.send_changedstate()
 
421
        if not quiet:
590
422
            logger.info("Disabling client %s", self.name)
591
 
        if getattr(self, "disable_initiator_tag", None) is not None:
 
423
        if getattr(self, "disable_initiator_tag", False):
592
424
            gobject.source_remove(self.disable_initiator_tag)
593
425
            self.disable_initiator_tag = None
594
426
        self.expires = None
595
 
        if getattr(self, "checker_initiator_tag", None) is not None:
 
427
        if getattr(self, "checker_initiator_tag", False):
596
428
            gobject.source_remove(self.checker_initiator_tag)
597
429
            self.checker_initiator_tag = None
598
430
        self.stop_checker()
 
431
        if self.disable_hook:
 
432
            self.disable_hook(self)
599
433
        self.enabled = False
600
 
        if not quiet:
601
 
            self.send_changedstate()
602
434
        # Do not run this again if called by a gobject.timeout_add
603
435
        return False
604
436
    
605
437
    def __del__(self):
 
438
        self.disable_hook = None
606
439
        self.disable()
607
440
    
608
 
    def init_checker(self):
609
 
        # Schedule a new checker to be started an 'interval' from now,
610
 
        # and every interval from then on.
611
 
        if self.checker_initiator_tag is not None:
612
 
            gobject.source_remove(self.checker_initiator_tag)
613
 
        self.checker_initiator_tag = (gobject.timeout_add
614
 
                                      (self.interval_milliseconds(),
615
 
                                       self.start_checker))
616
 
        # Schedule a disable() when 'timeout' has passed
617
 
        if self.disable_initiator_tag is not None:
618
 
            gobject.source_remove(self.disable_initiator_tag)
619
 
        self.disable_initiator_tag = (gobject.timeout_add
620
 
                                   (self.timeout_milliseconds(),
621
 
                                    self.disable))
622
 
        # Also start a new checker *right now*.
623
 
        self.start_checker()
624
 
    
625
441
    def checker_callback(self, pid, condition, command):
626
442
        """The checker has completed, so take appropriate actions."""
627
443
        self.checker_callback_tag = None
628
444
        self.checker = None
629
445
        if os.WIFEXITED(condition):
630
 
            self.last_checker_status = os.WEXITSTATUS(condition)
631
 
            if self.last_checker_status == 0:
 
446
            exitstatus = os.WEXITSTATUS(condition)
 
447
            if exitstatus == 0:
632
448
                logger.info("Checker for %(name)s succeeded",
633
449
                            vars(self))
634
450
                self.checked_ok()
636
452
                logger.info("Checker for %(name)s failed",
637
453
                            vars(self))
638
454
        else:
639
 
            self.last_checker_status = -1
640
455
            logger.warning("Checker for %(name)s crashed?",
641
456
                           vars(self))
642
457
    
643
 
    def checked_ok(self):
644
 
        """Assert that the client has been seen, alive and well."""
645
 
        self.last_checked_ok = datetime.datetime.utcnow()
646
 
        self.last_checker_status = 0
647
 
        self.bump_timeout()
648
 
    
649
 
    def bump_timeout(self, timeout=None):
650
 
        """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
        """
651
464
        if timeout is None:
652
465
            timeout = self.timeout
653
 
        if self.disable_initiator_tag is not None:
654
 
            gobject.source_remove(self.disable_initiator_tag)
655
 
            self.disable_initiator_tag = None
656
 
        if getattr(self, "enabled", False):
657
 
            self.disable_initiator_tag = (gobject.timeout_add
658
 
                                          (timedelta_to_milliseconds
659
 
                                           (timeout), self.disable))
660
 
            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
661
472
    
662
473
    def need_approval(self):
663
474
        self.last_approval_request = datetime.datetime.utcnow()
668
479
        If a checker already exists, leave it running and do
669
480
        nothing."""
670
481
        # The reason for not killing a running checker is that if we
671
 
        # did that, and if a checker (for some reason) started running
672
 
        # slowly and taking more than 'interval' time, then the client
673
 
        # would inevitably timeout, since no checker would get a
674
 
        # 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
675
486
        # checkers alone, the checker would have to take more time
676
487
        # than 'timeout' for the client to be disabled, which is as it
677
488
        # should be.
691
502
                                      self.current_checker_command)
692
503
        # Start a new checker if needed
693
504
        if self.checker is None:
694
 
            # Escape attributes for the shell
695
 
            escaped_attrs = dict(
696
 
                (attr, re.escape(unicode(getattr(self, attr))))
697
 
                for attr in
698
 
                self.runtime_expansions)
699
505
            try:
700
 
                command = self.checker_command % escaped_attrs
701
 
            except TypeError as error:
702
 
                logger.error('Could not format string "%s"',
703
 
                             self.checker_command, exc_info=error)
704
 
                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
705
524
            self.current_checker_command = command
706
525
            try:
707
526
                logger.info("Starting checker %r for %s",
713
532
                self.checker = subprocess.Popen(command,
714
533
                                                close_fds=True,
715
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.
 
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)
716
545
            except OSError as error:
717
 
                logger.error("Failed to start subprocess",
718
 
                             exc_info=error)
719
 
            self.checker_callback_tag = (gobject.child_watch_add
720
 
                                         (self.checker.pid,
721
 
                                          self.checker_callback,
722
 
                                          data=command))
723
 
            # The checker may have completed before the gobject
724
 
            # watch was added.  Check for this.
725
 
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
726
 
            if pid:
727
 
                gobject.source_remove(self.checker_callback_tag)
728
 
                self.checker_callback(pid, status, command)
 
546
                logger.error("Failed to start subprocess: %s",
 
547
                             error)
729
548
        # Re-run this periodically if run by gobject.timeout_add
730
549
        return True
731
550
    
738
557
            return
739
558
        logger.debug("Stopping checker for %(name)s", vars(self))
740
559
        try:
741
 
            self.checker.terminate()
 
560
            os.kill(self.checker.pid, signal.SIGTERM)
742
561
            #time.sleep(0.5)
743
562
            #if self.checker.poll() is None:
744
 
            #    self.checker.kill()
 
563
            #    os.kill(self.checker.pid, signal.SIGKILL)
745
564
        except OSError as error:
746
565
            if error.errno != errno.ESRCH: # No such process
747
566
                raise
764
583
    # "Set" method, so we fail early here:
765
584
    if byte_arrays and signature != "ay":
766
585
        raise ValueError("Byte arrays not supported for non-'ay'"
767
 
                         " signature {0!r}".format(signature))
 
586
                         " signature %r" % signature)
768
587
    def decorator(func):
769
588
        func._dbus_is_property = True
770
589
        func._dbus_interface = dbus_interface
778
597
    return decorator
779
598
 
780
599
 
781
 
def dbus_interface_annotations(dbus_interface):
782
 
    """Decorator for marking functions returning interface annotations
783
 
    
784
 
    Usage:
785
 
    
786
 
    @dbus_interface_annotations("org.example.Interface")
787
 
    def _foo(self):  # Function name does not matter
788
 
        return {"org.freedesktop.DBus.Deprecated": "true",
789
 
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
790
 
                    "false"}
791
 
    """
792
 
    def decorator(func):
793
 
        func._dbus_is_interface = True
794
 
        func._dbus_interface = dbus_interface
795
 
        func._dbus_name = dbus_interface
796
 
        return func
797
 
    return decorator
798
 
 
799
 
 
800
 
def dbus_annotations(annotations):
801
 
    """Decorator to annotate D-Bus methods, signals or properties
802
 
    Usage:
803
 
    
804
 
    @dbus_service_property("org.example.Interface", signature="b",
805
 
                           access="r")
806
 
    @dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
807
 
                        "org.freedesktop.DBus.Property."
808
 
                        "EmitsChangedSignal": "false"})
809
 
    def Property_dbus_property(self):
810
 
        return dbus.Boolean(False)
811
 
    """
812
 
    def decorator(func):
813
 
        func._dbus_annotations = annotations
814
 
        return func
815
 
    return decorator
816
 
 
817
 
 
818
600
class DBusPropertyException(dbus.exceptions.DBusException):
819
601
    """A base class for D-Bus property-related exceptions
820
602
    """
843
625
    """
844
626
    
845
627
    @staticmethod
846
 
    def _is_dbus_thing(thing):
847
 
        """Returns a function testing if an attribute is a D-Bus thing
848
 
        
849
 
        If called like _is_dbus_thing("method") it returns a function
850
 
        suitable for use as predicate to inspect.getmembers().
851
 
        """
852
 
        return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
853
 
                                   False)
 
628
    def _is_dbus_property(obj):
 
629
        return getattr(obj, "_dbus_is_property", False)
854
630
    
855
 
    def _get_all_dbus_things(self, thing):
 
631
    def _get_all_dbus_properties(self):
856
632
        """Returns a generator of (name, attribute) pairs
857
633
        """
858
 
        return ((getattr(athing.__get__(self), "_dbus_name",
859
 
                         name),
860
 
                 athing.__get__(self))
 
634
        return ((prop.__get__(self)._dbus_name, prop.__get__(self))
861
635
                for cls in self.__class__.__mro__
862
 
                for name, athing in
863
 
                inspect.getmembers(cls,
864
 
                                   self._is_dbus_thing(thing)))
 
636
                for name, prop in
 
637
                inspect.getmembers(cls, self._is_dbus_property))
865
638
    
866
639
    def _get_dbus_property(self, interface_name, property_name):
867
640
        """Returns a bound method if one exists which is a D-Bus
869
642
        """
870
643
        for cls in  self.__class__.__mro__:
871
644
            for name, value in (inspect.getmembers
872
 
                                (cls,
873
 
                                 self._is_dbus_thing("property"))):
 
645
                                (cls, self._is_dbus_property)):
874
646
                if (value._dbus_name == property_name
875
647
                    and value._dbus_interface == interface_name):
876
648
                    return value.__get__(self)
905
677
            # signatures other than "ay".
906
678
            if prop._dbus_signature != "ay":
907
679
                raise ValueError
908
 
            value = dbus.ByteArray(b''.join(chr(byte)
909
 
                                            for byte in value))
 
680
            value = dbus.ByteArray(''.join(unichr(byte)
 
681
                                           for byte in value))
910
682
        prop(value)
911
683
    
912
684
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
917
689
        
918
690
        Note: Will not include properties with access="write".
919
691
        """
920
 
        properties = {}
921
 
        for name, prop in self._get_all_dbus_things("property"):
 
692
        all = {}
 
693
        for name, prop in self._get_all_dbus_properties():
922
694
            if (interface_name
923
695
                and interface_name != prop._dbus_interface):
924
696
                # Interface non-empty but did not match
928
700
                continue
929
701
            value = prop()
930
702
            if not hasattr(value, "variant_level"):
931
 
                properties[name] = value
 
703
                all[name] = value
932
704
                continue
933
 
            properties[name] = type(value)(value, variant_level=
934
 
                                           value.variant_level+1)
935
 
        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")
936
708
    
937
709
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
938
710
                         out_signature="s",
939
711
                         path_keyword='object_path',
940
712
                         connection_keyword='connection')
941
713
    def Introspect(self, object_path, connection):
942
 
        """Overloading of standard D-Bus method.
943
 
        
944
 
        Inserts property tags and interface annotation tags.
 
714
        """Standard D-Bus method, overloaded to insert property tags.
945
715
        """
946
716
        xmlstring = dbus.service.Object.Introspect(self, object_path,
947
717
                                                   connection)
954
724
                e.setAttribute("access", prop._dbus_access)
955
725
                return e
956
726
            for if_tag in document.getElementsByTagName("interface"):
957
 
                # Add property tags
958
727
                for tag in (make_tag(document, name, prop)
959
728
                            for name, prop
960
 
                            in self._get_all_dbus_things("property")
 
729
                            in self._get_all_dbus_properties()
961
730
                            if prop._dbus_interface
962
731
                            == if_tag.getAttribute("name")):
963
732
                    if_tag.appendChild(tag)
964
 
                # Add annotation tags
965
 
                for typ in ("method", "signal", "property"):
966
 
                    for tag in if_tag.getElementsByTagName(typ):
967
 
                        annots = dict()
968
 
                        for name, prop in (self.
969
 
                                           _get_all_dbus_things(typ)):
970
 
                            if (name == tag.getAttribute("name")
971
 
                                and prop._dbus_interface
972
 
                                == if_tag.getAttribute("name")):
973
 
                                annots.update(getattr
974
 
                                              (prop,
975
 
                                               "_dbus_annotations",
976
 
                                               {}))
977
 
                        for name, value in annots.iteritems():
978
 
                            ann_tag = document.createElement(
979
 
                                "annotation")
980
 
                            ann_tag.setAttribute("name", name)
981
 
                            ann_tag.setAttribute("value", value)
982
 
                            tag.appendChild(ann_tag)
983
 
                # Add interface annotation tags
984
 
                for annotation, value in dict(
985
 
                    itertools.chain.from_iterable(
986
 
                        annotations().iteritems()
987
 
                        for name, annotations in
988
 
                        self._get_all_dbus_things("interface")
989
 
                        if name == if_tag.getAttribute("name")
990
 
                        )).iteritems():
991
 
                    ann_tag = document.createElement("annotation")
992
 
                    ann_tag.setAttribute("name", annotation)
993
 
                    ann_tag.setAttribute("value", value)
994
 
                    if_tag.appendChild(ann_tag)
995
733
                # Add the names to the return values for the
996
734
                # "org.freedesktop.DBus.Properties" methods
997
735
                if (if_tag.getAttribute("name")
1012
750
        except (AttributeError, xml.dom.DOMException,
1013
751
                xml.parsers.expat.ExpatError) as error:
1014
752
            logger.error("Failed to override Introspection method",
1015
 
                         exc_info=error)
 
753
                         error)
1016
754
        return xmlstring
1017
755
 
1018
756
 
1019
 
def datetime_to_dbus(dt, variant_level=0):
 
757
def datetime_to_dbus (dt, variant_level=0):
1020
758
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1021
759
    if dt is None:
1022
760
        return dbus.String("", variant_level = variant_level)
1023
761
    return dbus.String(dt.isoformat(),
1024
762
                       variant_level=variant_level)
1025
763
 
1026
 
 
1027
 
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1028
 
    """A class decorator; applied to a subclass of
1029
 
    dbus.service.Object, it will add alternate D-Bus attributes with
1030
 
    interface names according to the "alt_interface_names" mapping.
1031
 
    Usage:
1032
 
    
1033
 
    @alternate_dbus_interfaces({"org.example.Interface":
1034
 
                                    "net.example.AlternateInterface"})
1035
 
    class SampleDBusObject(dbus.service.Object):
1036
 
        @dbus.service.method("org.example.Interface")
1037
 
        def SampleDBusMethod():
1038
 
            pass
1039
 
    
1040
 
    The above "SampleDBusMethod" on "SampleDBusObject" will be
1041
 
    reachable via two interfaces: "org.example.Interface" and
1042
 
    "net.example.AlternateInterface", the latter of which will have
1043
 
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1044
 
    "true", unless "deprecate" is passed with a False value.
1045
 
    
1046
 
    This works for methods and signals, and also for D-Bus properties
1047
 
    (from DBusObjectWithProperties) and interfaces (from the
1048
 
    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.
1049
768
    """
1050
 
    def wrapper(cls):
1051
 
        for orig_interface_name, alt_interface_name in (
1052
 
            alt_interface_names.iteritems()):
1053
 
            attr = {}
1054
 
            interface_names = set()
1055
 
            # Go though all attributes of the class
1056
 
            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):
1057
776
                # Ignore non-D-Bus attributes, and D-Bus attributes
1058
777
                # with the wrong interface name
1059
778
                if (not hasattr(attribute, "_dbus_interface")
1060
779
                    or not attribute._dbus_interface
1061
 
                    .startswith(orig_interface_name)):
 
780
                    .startswith("se.recompile.Mandos")):
1062
781
                    continue
1063
782
                # Create an alternate D-Bus interface name based on
1064
783
                # the current name
1065
784
                alt_interface = (attribute._dbus_interface
1066
 
                                 .replace(orig_interface_name,
1067
 
                                          alt_interface_name))
1068
 
                interface_names.add(alt_interface)
 
785
                                 .replace("se.recompile.Mandos",
 
786
                                          "se.bsnet.fukt.Mandos"))
1069
787
                # Is this a D-Bus signal?
1070
788
                if getattr(attribute, "_dbus_is_signal", False):
1071
789
                    # Extract the original non-method function by
1086
804
                                nonmethod_func.func_name,
1087
805
                                nonmethod_func.func_defaults,
1088
806
                                nonmethod_func.func_closure)))
1089
 
                    # Copy annotations, if any
1090
 
                    try:
1091
 
                        new_function._dbus_annotations = (
1092
 
                            dict(attribute._dbus_annotations))
1093
 
                    except AttributeError:
1094
 
                        pass
1095
807
                    # Define a creator of a function to call both the
1096
 
                    # original and alternate functions, so both the
1097
 
                    # original and alternate signals gets sent when
1098
 
                    # the function is called
 
808
                    # old and new functions, so both the old and new
 
809
                    # signals gets sent when the function is called
1099
810
                    def fixscope(func1, func2):
1100
811
                        """This function is a scope container to pass
1101
812
                        func1 and func2 to the "call_both" function
1108
819
                        return call_both
1109
820
                    # Create the "call_both" function and add it to
1110
821
                    # the class
1111
 
                    attr[attrname] = fixscope(attribute, new_function)
 
822
                    attr[attrname] = fixscope(attribute,
 
823
                                              new_function)
1112
824
                # Is this a D-Bus method?
1113
825
                elif getattr(attribute, "_dbus_is_method", False):
1114
826
                    # Create a new, but exactly alike, function
1125
837
                                        attribute.func_name,
1126
838
                                        attribute.func_defaults,
1127
839
                                        attribute.func_closure)))
1128
 
                    # Copy annotations, if any
1129
 
                    try:
1130
 
                        attr[attrname]._dbus_annotations = (
1131
 
                            dict(attribute._dbus_annotations))
1132
 
                    except AttributeError:
1133
 
                        pass
1134
840
                # Is this a D-Bus property?
1135
841
                elif getattr(attribute, "_dbus_is_property", False):
1136
842
                    # Create a new, but exactly alike, function
1150
856
                                        attribute.func_name,
1151
857
                                        attribute.func_defaults,
1152
858
                                        attribute.func_closure)))
1153
 
                    # Copy annotations, if any
1154
 
                    try:
1155
 
                        attr[attrname]._dbus_annotations = (
1156
 
                            dict(attribute._dbus_annotations))
1157
 
                    except AttributeError:
1158
 
                        pass
1159
 
                # Is this a D-Bus interface?
1160
 
                elif getattr(attribute, "_dbus_is_interface", False):
1161
 
                    # Create a new, but exactly alike, function
1162
 
                    # object.  Decorate it to be a new D-Bus interface
1163
 
                    # with the alternate D-Bus interface name.  Add it
1164
 
                    # to the class.
1165
 
                    attr[attrname] = (dbus_interface_annotations
1166
 
                                      (alt_interface)
1167
 
                                      (types.FunctionType
1168
 
                                       (attribute.func_code,
1169
 
                                        attribute.func_globals,
1170
 
                                        attribute.func_name,
1171
 
                                        attribute.func_defaults,
1172
 
                                        attribute.func_closure)))
1173
 
            if deprecate:
1174
 
                # Deprecate all alternate interfaces
1175
 
                iname="_AlternateDBusNames_interface_annotation{0}"
1176
 
                for interface_name in interface_names:
1177
 
                    @dbus_interface_annotations(interface_name)
1178
 
                    def func(self):
1179
 
                        return { "org.freedesktop.DBus.Deprecated":
1180
 
                                     "true" }
1181
 
                    # Find an unused name
1182
 
                    for aname in (iname.format(i)
1183
 
                                  for i in itertools.count()):
1184
 
                        if aname not in attr:
1185
 
                            attr[aname] = func
1186
 
                            break
1187
 
            if interface_names:
1188
 
                # Replace the class with a new subclass of it with
1189
 
                # methods, signals, etc. as created above.
1190
 
                cls = type(b"{0}Alternate".format(cls.__name__),
1191
 
                           (cls,), attr)
1192
 
        return cls
1193
 
    return wrapper
1194
 
 
1195
 
 
1196
 
@alternate_dbus_interfaces({"se.recompile.Mandos":
1197
 
                                "se.bsnet.fukt.Mandos"})
 
859
        return type.__new__(mcs, name, bases, attr)
 
860
 
1198
861
class ClientDBus(Client, DBusObjectWithProperties):
1199
862
    """A Client class using D-Bus
1200
863
    
1209
872
    # dbus.service.Object doesn't use super(), so we can't either.
1210
873
    
1211
874
    def __init__(self, bus = None, *args, **kwargs):
 
875
        self._approvals_pending = 0
1212
876
        self.bus = bus
1213
877
        Client.__init__(self, *args, **kwargs)
1214
878
        # Only now, when this client is initialized, can it show up on
1220
884
                                 ("/clients/" + client_object_name))
1221
885
        DBusObjectWithProperties.__init__(self, self.bus,
1222
886
                                          self.dbus_object_path)
1223
 
    
 
887
        
1224
888
    def notifychangeproperty(transform_func,
1225
889
                             dbus_name, type_func=lambda x: x,
1226
890
                             variant_level=1):
1227
891
        """ Modify a variable so that it's a property which announces
1228
892
        its changes to DBus.
1229
 
        
1230
 
        transform_fun: Function that takes a value and a variant_level
1231
 
                       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.
1232
896
        dbus_name: D-Bus name of the variable
1233
897
        type_func: Function that transform the value before sending it
1234
898
                   to the D-Bus.  Default: no transform
1241
905
                    type_func(getattr(self, attrname, None))
1242
906
                    != type_func(value)):
1243
907
                    dbus_value = transform_func(type_func(value),
1244
 
                                                variant_level
1245
 
                                                =variant_level)
 
908
                                                variant_level)
1246
909
                    self.PropertyChanged(dbus.String(dbus_name),
1247
910
                                         dbus_value)
1248
911
            setattr(self, attrname, value)
1249
912
        
1250
913
        return property(lambda self: getattr(self, attrname), setter)
1251
914
    
 
915
    
1252
916
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1253
917
    approvals_pending = notifychangeproperty(dbus.Boolean,
1254
918
                                             "ApprovalPending",
1261
925
                                       checker is not None)
1262
926
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1263
927
                                           "LastCheckedOK")
1264
 
    last_checker_status = notifychangeproperty(dbus.Int16,
1265
 
                                               "LastCheckerStatus")
1266
928
    last_approval_request = notifychangeproperty(
1267
929
        datetime_to_dbus, "LastApprovalRequest")
1268
930
    approved_by_default = notifychangeproperty(dbus.Boolean,
1269
931
                                               "ApprovedByDefault")
1270
 
    approval_delay = notifychangeproperty(dbus.UInt64,
 
932
    approval_delay = notifychangeproperty(dbus.UInt16,
1271
933
                                          "ApprovalDelay",
1272
934
                                          type_func =
1273
 
                                          timedelta_to_milliseconds)
 
935
                                          _timedelta_to_milliseconds)
1274
936
    approval_duration = notifychangeproperty(
1275
 
        dbus.UInt64, "ApprovalDuration",
1276
 
        type_func = timedelta_to_milliseconds)
 
937
        dbus.UInt16, "ApprovalDuration",
 
938
        type_func = _timedelta_to_milliseconds)
1277
939
    host = notifychangeproperty(dbus.String, "Host")
1278
 
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
 
940
    timeout = notifychangeproperty(dbus.UInt16, "Timeout",
1279
941
                                   type_func =
1280
 
                                   timedelta_to_milliseconds)
 
942
                                   _timedelta_to_milliseconds)
1281
943
    extended_timeout = notifychangeproperty(
1282
 
        dbus.UInt64, "ExtendedTimeout",
1283
 
        type_func = timedelta_to_milliseconds)
1284
 
    interval = notifychangeproperty(dbus.UInt64,
 
944
        dbus.UInt16, "ExtendedTimeout",
 
945
        type_func = _timedelta_to_milliseconds)
 
946
    interval = notifychangeproperty(dbus.UInt16,
1285
947
                                    "Interval",
1286
948
                                    type_func =
1287
 
                                    timedelta_to_milliseconds)
 
949
                                    _timedelta_to_milliseconds)
1288
950
    checker_command = notifychangeproperty(dbus.String, "Checker")
1289
951
    
1290
952
    del notifychangeproperty
1332
994
        return r
1333
995
    
1334
996
    def _reset_approved(self):
1335
 
        self.approved = None
 
997
        self._approved = None
1336
998
        return False
1337
999
    
1338
1000
    def approve(self, value=True):
1339
 
        self.approved = value
1340
 
        gobject.timeout_add(timedelta_to_milliseconds
 
1001
        self.send_changedstate()
 
1002
        self._approved = value
 
1003
        gobject.timeout_add(_timedelta_to_milliseconds
1341
1004
                            (self.approval_duration),
1342
1005
                            self._reset_approved)
1343
 
        self.send_changedstate()
 
1006
    
1344
1007
    
1345
1008
    ## D-Bus methods, signals & properties
1346
1009
    _interface = "se.recompile.Mandos.Client"
1347
1010
    
1348
 
    ## Interfaces
1349
 
    
1350
 
    @dbus_interface_annotations(_interface)
1351
 
    def _foo(self):
1352
 
        return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1353
 
                     "false"}
1354
 
    
1355
1011
    ## Signals
1356
1012
    
1357
1013
    # CheckerCompleted - signal
1456
1112
                           access="readwrite")
1457
1113
    def ApprovalDuration_dbus_property(self, value=None):
1458
1114
        if value is None:       # get
1459
 
            return dbus.UInt64(timedelta_to_milliseconds(
 
1115
            return dbus.UInt64(_timedelta_to_milliseconds(
1460
1116
                    self.approval_duration))
1461
1117
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1462
1118
    
1476
1132
    def Host_dbus_property(self, value=None):
1477
1133
        if value is None:       # get
1478
1134
            return dbus.String(self.host)
1479
 
        self.host = unicode(value)
 
1135
        self.host = value
1480
1136
    
1481
1137
    # Created - property
1482
1138
    @dbus_service_property(_interface, signature="s", access="read")
1483
1139
    def Created_dbus_property(self):
1484
 
        return datetime_to_dbus(self.created)
 
1140
        return dbus.String(datetime_to_dbus(self.created))
1485
1141
    
1486
1142
    # LastEnabled - property
1487
1143
    @dbus_service_property(_interface, signature="s", access="read")
1508
1164
            return
1509
1165
        return datetime_to_dbus(self.last_checked_ok)
1510
1166
    
1511
 
    # LastCheckerStatus - property
1512
 
    @dbus_service_property(_interface, signature="n",
1513
 
                           access="read")
1514
 
    def LastCheckerStatus_dbus_property(self):
1515
 
        return dbus.Int16(self.last_checker_status)
1516
 
    
1517
1167
    # Expires - property
1518
1168
    @dbus_service_property(_interface, signature="s", access="read")
1519
1169
    def Expires_dbus_property(self):
1530
1180
    def Timeout_dbus_property(self, value=None):
1531
1181
        if value is None:       # get
1532
1182
            return dbus.UInt64(self.timeout_milliseconds())
1533
 
        old_timeout = self.timeout
1534
1183
        self.timeout = datetime.timedelta(0, 0, 0, value)
1535
 
        # Reschedule disabling
1536
 
        if self.enabled:
1537
 
            now = datetime.datetime.utcnow()
1538
 
            self.expires += self.timeout - old_timeout
1539
 
            if self.expires <= now:
1540
 
                # The timeout has passed
1541
 
                self.disable()
1542
 
            else:
1543
 
                if (getattr(self, "disable_initiator_tag", None)
1544
 
                    is None):
1545
 
                    return
1546
 
                gobject.source_remove(self.disable_initiator_tag)
1547
 
                self.disable_initiator_tag = (
1548
 
                    gobject.timeout_add(
1549
 
                        timedelta_to_milliseconds(self.expires - now),
1550
 
                        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))
1551
1205
    
1552
1206
    # ExtendedTimeout - property
1553
1207
    @dbus_service_property(_interface, signature="t",
1566
1220
        self.interval = datetime.timedelta(0, 0, 0, value)
1567
1221
        if getattr(self, "checker_initiator_tag", None) is None:
1568
1222
            return
1569
 
        if self.enabled:
1570
 
            # Reschedule checker run
1571
 
            gobject.source_remove(self.checker_initiator_tag)
1572
 
            self.checker_initiator_tag = (gobject.timeout_add
1573
 
                                          (value, self.start_checker))
1574
 
            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
1575
1228
    
1576
1229
    # Checker - property
1577
1230
    @dbus_service_property(_interface, signature="s",
1579
1232
    def Checker_dbus_property(self, value=None):
1580
1233
        if value is None:       # get
1581
1234
            return dbus.String(self.checker_command)
1582
 
        self.checker_command = unicode(value)
 
1235
        self.checker_command = value
1583
1236
    
1584
1237
    # CheckerRunning - property
1585
1238
    @dbus_service_property(_interface, signature="b",
1614
1267
            raise KeyError()
1615
1268
    
1616
1269
    def __getattribute__(self, name):
1617
 
        if name == '_pipe':
 
1270
        if(name == '_pipe'):
1618
1271
            return super(ProxyClient, self).__getattribute__(name)
1619
1272
        self._pipe.send(('getattr', name))
1620
1273
        data = self._pipe.recv()
1627
1280
            return func
1628
1281
    
1629
1282
    def __setattr__(self, name, value):
1630
 
        if name == '_pipe':
 
1283
        if(name == '_pipe'):
1631
1284
            return super(ProxyClient, self).__setattr__(name, value)
1632
1285
        self._pipe.send(('setattr', name, value))
1633
1286
 
 
1287
class ClientDBusTransitional(ClientDBus):
 
1288
    __metaclass__ = AlternateDBusNamesMetaclass
1634
1289
 
1635
1290
class ClientHandler(socketserver.BaseRequestHandler, object):
1636
1291
    """A class to handle client connections.
1719
1374
                            client.Rejected("Disabled")
1720
1375
                        return
1721
1376
                    
1722
 
                    if client.approved or not client.approval_delay:
 
1377
                    if client._approved or not client.approval_delay:
1723
1378
                        #We are approved or approval is disabled
1724
1379
                        break
1725
 
                    elif client.approved is None:
 
1380
                    elif client._approved is None:
1726
1381
                        logger.info("Client %s needs approval",
1727
1382
                                    client.name)
1728
1383
                        if self.server.use_dbus:
1741
1396
                    #wait until timeout or approved
1742
1397
                    time = datetime.datetime.now()
1743
1398
                    client.changedstate.acquire()
1744
 
                    client.changedstate.wait(
1745
 
                        float(timedelta_to_milliseconds(delay)
1746
 
                              / 1000))
 
1399
                    (client.changedstate.wait
 
1400
                     (float(client._timedelta_to_milliseconds(delay)
 
1401
                            / 1000)))
1747
1402
                    client.changedstate.release()
1748
1403
                    time2 = datetime.datetime.now()
1749
1404
                    if (time2 - time) >= delay:
1765
1420
                    try:
1766
1421
                        sent = session.send(client.secret[sent_size:])
1767
1422
                    except gnutls.errors.GNUTLSError as error:
1768
 
                        logger.warning("gnutls send failed",
1769
 
                                       exc_info=error)
 
1423
                        logger.warning("gnutls send failed")
1770
1424
                        return
1771
1425
                    logger.debug("Sent: %d, remaining: %d",
1772
1426
                                 sent, len(client.secret)
1774
1428
                    sent_size += sent
1775
1429
                
1776
1430
                logger.info("Sending secret to %s", client.name)
1777
 
                # bump the timeout using extended_timeout
1778
 
                client.bump_timeout(client.extended_timeout)
 
1431
                # bump the timeout as if seen
 
1432
                client.checked_ok(client.extended_timeout)
1779
1433
                if self.server.use_dbus:
1780
1434
                    # Emit D-Bus signal
1781
1435
                    client.GotSecret()
1786
1440
                try:
1787
1441
                    session.bye()
1788
1442
                except gnutls.errors.GNUTLSError as error:
1789
 
                    logger.warning("GnuTLS bye failed",
1790
 
                                   exc_info=error)
 
1443
                    logger.warning("GnuTLS bye failed")
1791
1444
    
1792
1445
    @staticmethod
1793
1446
    def peer_certificate(session):
1849
1502
        # Convert the buffer to a Python bytestring
1850
1503
        fpr = ctypes.string_at(buf, buf_len.value)
1851
1504
        # Convert the bytestring to hexadecimal notation
1852
 
        hex_fpr = binascii.hexlify(fpr).upper()
 
1505
        hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
1853
1506
        return hex_fpr
1854
1507
 
1855
1508
 
1858
1511
    def sub_process_main(self, request, address):
1859
1512
        try:
1860
1513
            self.finish_request(request, address)
1861
 
        except Exception:
 
1514
        except:
1862
1515
            self.handle_error(request, address)
1863
1516
        self.close_request(request)
1864
1517
    
1865
1518
    def process_request(self, request, address):
1866
1519
        """Start a new process to process the request."""
1867
1520
        proc = multiprocessing.Process(target = self.sub_process_main,
1868
 
                                       args = (request, address))
 
1521
                                       args = (request,
 
1522
                                               address))
1869
1523
        proc.start()
1870
1524
        return proc
1871
1525
 
1899
1553
        use_ipv6:       Boolean; to use IPv6 or not
1900
1554
    """
1901
1555
    def __init__(self, server_address, RequestHandlerClass,
1902
 
                 interface=None, use_ipv6=True, socketfd=None):
1903
 
        """If socketfd is set, use that file descriptor instead of
1904
 
        creating a new one with socket.socket().
1905
 
        """
 
1556
                 interface=None, use_ipv6=True):
1906
1557
        self.interface = interface
1907
1558
        if use_ipv6:
1908
1559
            self.address_family = socket.AF_INET6
1909
 
        if socketfd is not None:
1910
 
            # Save the file descriptor
1911
 
            self.socketfd = socketfd
1912
 
            # Save the original socket.socket() function
1913
 
            self.socket_socket = socket.socket
1914
 
            # To implement --socket, we monkey patch socket.socket.
1915
 
            # 
1916
 
            # (When socketserver.TCPServer is a new-style class, we
1917
 
            # could make self.socket into a property instead of monkey
1918
 
            # patching socket.socket.)
1919
 
            # 
1920
 
            # Create a one-time-only replacement for socket.socket()
1921
 
            @functools.wraps(socket.socket)
1922
 
            def socket_wrapper(*args, **kwargs):
1923
 
                # Restore original function so subsequent calls are
1924
 
                # not affected.
1925
 
                socket.socket = self.socket_socket
1926
 
                del self.socket_socket
1927
 
                # This time only, return a new socket object from the
1928
 
                # saved file descriptor.
1929
 
                return socket.fromfd(self.socketfd, *args, **kwargs)
1930
 
            # Replace socket.socket() function with wrapper
1931
 
            socket.socket = socket_wrapper
1932
 
        # The socketserver.TCPServer.__init__ will call
1933
 
        # socket.socket(), which might be our replacement,
1934
 
        # socket_wrapper(), if socketfd was set.
1935
1560
        socketserver.TCPServer.__init__(self, server_address,
1936
1561
                                        RequestHandlerClass)
1937
 
    
1938
1562
    def server_bind(self):
1939
1563
        """This overrides the normal server_bind() function
1940
1564
        to bind to an interface if one was specified, and also NOT to
1948
1572
                try:
1949
1573
                    self.socket.setsockopt(socket.SOL_SOCKET,
1950
1574
                                           SO_BINDTODEVICE,
1951
 
                                           str(self.interface + '\0'))
 
1575
                                           str(self.interface
 
1576
                                               + '\0'))
1952
1577
                except socket.error as error:
1953
 
                    if error.errno == errno.EPERM:
1954
 
                        logger.error("No permission to bind to"
1955
 
                                     " interface %s", self.interface)
1956
 
                    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:
1957
1583
                        logger.error("SO_BINDTODEVICE not available;"
1958
1584
                                     " cannot bind to interface %s",
1959
1585
                                     self.interface)
1960
 
                    elif error.errno == errno.ENODEV:
1961
 
                        logger.error("Interface %s does not exist,"
1962
 
                                     " cannot bind", self.interface)
1963
1586
                    else:
1964
1587
                        raise
1965
1588
        # Only bind(2) the socket if we really need to.
1995
1618
    """
1996
1619
    def __init__(self, server_address, RequestHandlerClass,
1997
1620
                 interface=None, use_ipv6=True, clients=None,
1998
 
                 gnutls_priority=None, use_dbus=True, socketfd=None):
 
1621
                 gnutls_priority=None, use_dbus=True):
1999
1622
        self.enabled = False
2000
1623
        self.clients = clients
2001
1624
        if self.clients is None:
2002
 
            self.clients = {}
 
1625
            self.clients = set()
2003
1626
        self.use_dbus = use_dbus
2004
1627
        self.gnutls_priority = gnutls_priority
2005
1628
        IPv6_TCPServer.__init__(self, server_address,
2006
1629
                                RequestHandlerClass,
2007
1630
                                interface = interface,
2008
 
                                use_ipv6 = use_ipv6,
2009
 
                                socketfd = socketfd)
 
1631
                                use_ipv6 = use_ipv6)
2010
1632
    def server_activate(self):
2011
1633
        if self.enabled:
2012
1634
            return socketserver.TCPServer.server_activate(self)
2025
1647
    
2026
1648
    def handle_ipc(self, source, condition, parent_pipe=None,
2027
1649
                   proc = None, client_object=None):
2028
 
        # error, or the other end of multiprocessing.Pipe has closed
2029
 
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
2030
 
            # Wait for other process to exit
 
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)
 
1664
        # error or the other end of multiprocessing.Pipe has closed
 
1665
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2031
1666
            proc.join()
2032
1667
            return False
2033
1668
        
2039
1674
            fpr = request[1]
2040
1675
            address = request[2]
2041
1676
            
2042
 
            for c in self.clients.itervalues():
 
1677
            for c in self.clients:
2043
1678
                if c.fingerprint == fpr:
2044
1679
                    client = c
2045
1680
                    break
2122
1757
            elif suffix == "w":
2123
1758
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2124
1759
            else:
2125
 
                raise ValueError("Unknown suffix {0!r}"
2126
 
                                 .format(suffix))
 
1760
                raise ValueError("Unknown suffix %r" % suffix)
2127
1761
        except (ValueError, IndexError) as e:
2128
1762
            raise ValueError(*(e.args))
2129
1763
        timevalue += delta
2130
1764
    return timevalue
2131
1765
 
2132
1766
 
 
1767
def if_nametoindex(interface):
 
1768
    """Call the C function if_nametoindex(), or equivalent
 
1769
    
 
1770
    Note: This function cannot accept a unicode string."""
 
1771
    global if_nametoindex
 
1772
    try:
 
1773
        if_nametoindex = (ctypes.cdll.LoadLibrary
 
1774
                          (ctypes.util.find_library("c"))
 
1775
                          .if_nametoindex)
 
1776
    except (OSError, AttributeError):
 
1777
        logger.warning("Doing if_nametoindex the hard way")
 
1778
        def if_nametoindex(interface):
 
1779
            "Get an interface index the hard way, i.e. using fcntl()"
 
1780
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
 
1781
            with contextlib.closing(socket.socket()) as s:
 
1782
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
 
1783
                                    struct.pack(str("16s16x"),
 
1784
                                                interface))
 
1785
            interface_index = struct.unpack(str("I"),
 
1786
                                            ifreq[16:20])[0]
 
1787
            return interface_index
 
1788
    return if_nametoindex(interface)
 
1789
 
 
1790
 
2133
1791
def daemon(nochdir = False, noclose = False):
2134
1792
    """See daemon(3).  Standard BSD Unix function.
2135
1793
    
2143
1801
        sys.exit()
2144
1802
    if not noclose:
2145
1803
        # Close all standard open file descriptors
2146
 
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
1804
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2147
1805
        if not stat.S_ISCHR(os.fstat(null).st_mode):
2148
1806
            raise OSError(errno.ENODEV,
2149
 
                          "{0} not a character device"
2150
 
                          .format(os.devnull))
 
1807
                          "%s not a character device"
 
1808
                          % os.path.devnull)
2151
1809
        os.dup2(null, sys.stdin.fileno())
2152
1810
        os.dup2(null, sys.stdout.fileno())
2153
1811
        os.dup2(null, sys.stderr.fileno())
2162
1820
    
2163
1821
    parser = argparse.ArgumentParser()
2164
1822
    parser.add_argument("-v", "--version", action="version",
2165
 
                        version = "%(prog)s {0}".format(version),
 
1823
                        version = "%%(prog)s %s" % version,
2166
1824
                        help="show version number and exit")
2167
1825
    parser.add_argument("-i", "--interface", metavar="IF",
2168
1826
                        help="Bind to interface IF")
2190
1848
                        " system bus interface")
2191
1849
    parser.add_argument("--no-ipv6", action="store_false",
2192
1850
                        dest="use_ipv6", help="Do not use IPv6")
2193
 
    parser.add_argument("--no-restore", action="store_false",
2194
 
                        dest="restore", help="Do not restore stored"
2195
 
                        " state")
2196
 
    parser.add_argument("--socket", type=int,
2197
 
                        help="Specify a file descriptor to a network"
2198
 
                        " socket to use instead of creating one")
2199
 
    parser.add_argument("--statedir", metavar="DIR",
2200
 
                        help="Directory to save/restore state in")
2201
 
    parser.add_argument("--foreground", action="store_true",
2202
 
                        help="Run in foreground")
2203
 
    
2204
1851
    options = parser.parse_args()
2205
1852
    
2206
1853
    if options.check:
2219
1866
                        "use_dbus": "True",
2220
1867
                        "use_ipv6": "True",
2221
1868
                        "debuglevel": "",
2222
 
                        "restore": "True",
2223
 
                        "socket": "",
2224
 
                        "statedir": "/var/lib/mandos",
2225
 
                        "foreground": "False",
2226
1869
                        }
2227
1870
    
2228
1871
    # Parse config file for server-global settings
2233
1876
    # Convert the SafeConfigParser object to a dict
2234
1877
    server_settings = server_config.defaults()
2235
1878
    # Use the appropriate methods on the non-string config options
2236
 
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
 
1879
    for option in ("debug", "use_dbus", "use_ipv6"):
2237
1880
        server_settings[option] = server_config.getboolean("DEFAULT",
2238
1881
                                                           option)
2239
1882
    if server_settings["port"]:
2240
1883
        server_settings["port"] = server_config.getint("DEFAULT",
2241
1884
                                                       "port")
2242
 
    if server_settings["socket"]:
2243
 
        server_settings["socket"] = server_config.getint("DEFAULT",
2244
 
                                                         "socket")
2245
 
        # Later, stdin will, and stdout and stderr might, be dup'ed
2246
 
        # over with an opened os.devnull.  But we don't want this to
2247
 
        # happen with a supplied network socket.
2248
 
        if 0 <= server_settings["socket"] <= 2:
2249
 
            server_settings["socket"] = os.dup(server_settings
2250
 
                                               ["socket"])
2251
1885
    del server_config
2252
1886
    
2253
1887
    # Override the settings from the config file with command line
2254
1888
    # options, if set.
2255
1889
    for option in ("interface", "address", "port", "debug",
2256
1890
                   "priority", "servicename", "configdir",
2257
 
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2258
 
                   "statedir", "socket", "foreground"):
 
1891
                   "use_dbus", "use_ipv6", "debuglevel"):
2259
1892
        value = getattr(options, option)
2260
1893
        if value is not None:
2261
1894
            server_settings[option] = value
2264
1897
    for option in server_settings.keys():
2265
1898
        if type(server_settings[option]) is str:
2266
1899
            server_settings[option] = unicode(server_settings[option])
2267
 
    # Debug implies foreground
2268
 
    if server_settings["debug"]:
2269
 
        server_settings["foreground"] = True
2270
1900
    # Now we have our good server settings in "server_settings"
2271
1901
    
2272
1902
    ##################################################################
2276
1906
    debuglevel = server_settings["debuglevel"]
2277
1907
    use_dbus = server_settings["use_dbus"]
2278
1908
    use_ipv6 = server_settings["use_ipv6"]
2279
 
    stored_state_path = os.path.join(server_settings["statedir"],
2280
 
                                     stored_state_file)
2281
 
    foreground = server_settings["foreground"]
2282
 
    
2283
 
    if debug:
2284
 
        initlogger(debug, logging.DEBUG)
2285
 
    else:
2286
 
        if not debuglevel:
2287
 
            initlogger(debug)
2288
 
        else:
2289
 
            level = getattr(logging, debuglevel.upper())
2290
 
            initlogger(debug, level)
2291
1909
    
2292
1910
    if server_settings["servicename"] != "Mandos":
2293
1911
        syslogger.setFormatter(logging.Formatter
2294
 
                               ('Mandos ({0}) [%(process)d]:'
2295
 
                                ' %(levelname)s: %(message)s'
2296
 
                                .format(server_settings
2297
 
                                        ["servicename"])))
 
1912
                               ('Mandos (%s) [%%(process)d]:'
 
1913
                                ' %%(levelname)s: %%(message)s'
 
1914
                                % server_settings["servicename"]))
2298
1915
    
2299
1916
    # Parse config file with clients
2300
 
    client_config = configparser.SafeConfigParser(Client
2301
 
                                                  .client_defaults)
 
1917
    client_defaults = { "timeout": "5m",
 
1918
                        "extended_timeout": "15m",
 
1919
                        "interval": "2m",
 
1920
                        "checker": "fping -q -- %%(host)s",
 
1921
                        "host": "",
 
1922
                        "approval_delay": "0s",
 
1923
                        "approval_duration": "1s",
 
1924
                        }
 
1925
    client_config = configparser.SafeConfigParser(client_defaults)
2302
1926
    client_config.read(os.path.join(server_settings["configdir"],
2303
1927
                                    "clients.conf"))
2304
1928
    
2313
1937
                              use_ipv6=use_ipv6,
2314
1938
                              gnutls_priority=
2315
1939
                              server_settings["priority"],
2316
 
                              use_dbus=use_dbus,
2317
 
                              socketfd=(server_settings["socket"]
2318
 
                                        or None))
2319
 
    if not foreground:
 
1940
                              use_dbus=use_dbus)
 
1941
    if not debug:
2320
1942
        pidfilename = "/var/run/mandos.pid"
2321
 
        pidfile = None
2322
1943
        try:
2323
1944
            pidfile = open(pidfilename, "w")
2324
 
        except IOError as e:
2325
 
            logger.error("Could not open file %r", pidfilename,
2326
 
                         exc_info=e)
 
1945
        except IOError:
 
1946
            logger.error("Could not open file %r", pidfilename)
2327
1947
    
2328
 
    for name in ("_mandos", "mandos", "nobody"):
 
1948
    try:
 
1949
        uid = pwd.getpwnam("_mandos").pw_uid
 
1950
        gid = pwd.getpwnam("_mandos").pw_gid
 
1951
    except KeyError:
2329
1952
        try:
2330
 
            uid = pwd.getpwnam(name).pw_uid
2331
 
            gid = pwd.getpwnam(name).pw_gid
2332
 
            break
 
1953
            uid = pwd.getpwnam("mandos").pw_uid
 
1954
            gid = pwd.getpwnam("mandos").pw_gid
2333
1955
        except KeyError:
2334
 
            continue
2335
 
    else:
2336
 
        uid = 65534
2337
 
        gid = 65534
 
1956
            try:
 
1957
                uid = pwd.getpwnam("nobody").pw_uid
 
1958
                gid = pwd.getpwnam("nobody").pw_gid
 
1959
            except KeyError:
 
1960
                uid = 65534
 
1961
                gid = 65534
2338
1962
    try:
2339
1963
        os.setgid(gid)
2340
1964
        os.setuid(uid)
2341
1965
    except OSError as error:
2342
 
        if error.errno != errno.EPERM:
 
1966
        if error[0] != errno.EPERM:
2343
1967
            raise error
2344
1968
    
 
1969
    if not debug and not debuglevel:
 
1970
        syslogger.setLevel(logging.WARNING)
 
1971
        console.setLevel(logging.WARNING)
 
1972
    if debuglevel:
 
1973
        level = getattr(logging, debuglevel.upper())
 
1974
        syslogger.setLevel(level)
 
1975
        console.setLevel(level)
 
1976
    
2345
1977
    if debug:
2346
1978
        # Enable all possible GnuTLS debugging
2347
1979
        
2357
1989
         .gnutls_global_set_log_function(debug_gnutls))
2358
1990
        
2359
1991
        # Redirect stdin so all checkers get /dev/null
2360
 
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
1992
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2361
1993
        os.dup2(null, sys.stdin.fileno())
2362
1994
        if null > 2:
2363
1995
            os.close(null)
 
1996
    else:
 
1997
        # No console logging
 
1998
        logger.removeHandler(console)
2364
1999
    
2365
2000
    # Need to fork before connecting to D-Bus
2366
 
    if not foreground:
 
2001
    if not debug:
2367
2002
        # Close all input and output, do double fork, etc.
2368
2003
        daemon()
2369
2004
    
2370
 
    # multiprocessing will use threads, so before we use gobject we
2371
 
    # need to inform gobject that threads will be used.
2372
 
    gobject.threads_init()
2373
 
    
2374
2005
    global main_loop
2375
2006
    # From the Avahi example code
2376
 
    DBusGMainLoop(set_as_default=True)
 
2007
    DBusGMainLoop(set_as_default=True )
2377
2008
    main_loop = gobject.MainLoop()
2378
2009
    bus = dbus.SystemBus()
2379
2010
    # End of Avahi example code
2385
2016
                            ("se.bsnet.fukt.Mandos", bus,
2386
2017
                             do_not_queue=True))
2387
2018
        except dbus.exceptions.NameExistsException as e:
2388
 
            logger.error("Disabling D-Bus:", exc_info=e)
 
2019
            logger.error(unicode(e) + ", disabling D-Bus")
2389
2020
            use_dbus = False
2390
2021
            server_settings["use_dbus"] = False
2391
2022
            tcp_server.use_dbus = False
2392
2023
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2393
 
    service = AvahiServiceToSyslog(name =
2394
 
                                   server_settings["servicename"],
2395
 
                                   servicetype = "_mandos._tcp",
2396
 
                                   protocol = protocol, bus = bus)
 
2024
    service = AvahiService(name = server_settings["servicename"],
 
2025
                           servicetype = "_mandos._tcp",
 
2026
                           protocol = protocol, bus = bus)
2397
2027
    if server_settings["interface"]:
2398
2028
        service.interface = (if_nametoindex
2399
2029
                             (str(server_settings["interface"])))
2403
2033
    
2404
2034
    client_class = Client
2405
2035
    if use_dbus:
2406
 
        client_class = functools.partial(ClientDBus, bus = bus)
2407
 
    
2408
 
    client_settings = Client.config_parser(client_config)
2409
 
    old_client_settings = {}
2410
 
    clients_data = {}
2411
 
    
2412
 
    # Get client data and settings from last running state.
2413
 
    if server_settings["restore"]:
2414
 
        try:
2415
 
            with open(stored_state_path, "rb") as stored_state:
2416
 
                clients_data, old_client_settings = (pickle.load
2417
 
                                                     (stored_state))
2418
 
            os.remove(stored_state_path)
2419
 
        except IOError as e:
2420
 
            if e.errno == errno.ENOENT:
2421
 
                logger.warning("Could not load persistent state: {0}"
2422
 
                                .format(os.strerror(e.errno)))
2423
 
            else:
2424
 
                logger.critical("Could not load persistent state:",
2425
 
                                exc_info=e)
2426
 
                raise
2427
 
        except EOFError as e:
2428
 
            logger.warning("Could not load persistent state: "
2429
 
                           "EOFError:", exc_info=e)
2430
 
    
2431
 
    with PGPEngine() as pgp:
2432
 
        for client_name, client in clients_data.iteritems():
2433
 
            # Decide which value to use after restoring saved state.
2434
 
            # We have three different values: Old config file,
2435
 
            # new config file, and saved state.
2436
 
            # New config value takes precedence if it differs from old
2437
 
            # config value, otherwise use saved state.
2438
 
            for name, value in client_settings[client_name].items():
2439
 
                try:
2440
 
                    # For each value in new config, check if it
2441
 
                    # differs from the old config value (Except for
2442
 
                    # the "secret" attribute)
2443
 
                    if (name != "secret" and
2444
 
                        value != old_client_settings[client_name]
2445
 
                        [name]):
2446
 
                        client[name] = value
2447
 
                except KeyError:
2448
 
                    pass
2449
 
            
2450
 
            # Clients who has passed its expire date can still be
2451
 
            # enabled if its last checker was successful.  Clients
2452
 
            # whose checker succeeded before we stored its state is
2453
 
            # assumed to have successfully run all checkers during
2454
 
            # downtime.
2455
 
            if client["enabled"]:
2456
 
                if datetime.datetime.utcnow() >= client["expires"]:
2457
 
                    if not client["last_checked_ok"]:
2458
 
                        logger.warning(
2459
 
                            "disabling client {0} - Client never "
2460
 
                            "performed a successful checker"
2461
 
                            .format(client_name))
2462
 
                        client["enabled"] = False
2463
 
                    elif client["last_checker_status"] != 0:
2464
 
                        logger.warning(
2465
 
                            "disabling client {0} - Client "
2466
 
                            "last checker failed with error code {1}"
2467
 
                            .format(client_name,
2468
 
                                    client["last_checker_status"]))
2469
 
                        client["enabled"] = False
2470
 
                    else:
2471
 
                        client["expires"] = (datetime.datetime
2472
 
                                             .utcnow()
2473
 
                                             + client["timeout"])
2474
 
                        logger.debug("Last checker succeeded,"
2475
 
                                     " keeping {0} enabled"
2476
 
                                     .format(client_name))
 
2036
        client_class = functools.partial(ClientDBusTransitional,
 
2037
                                         bus = bus)
 
2038
    def client_config_items(config, section):
 
2039
        special_settings = {
 
2040
            "approved_by_default":
 
2041
                lambda: config.getboolean(section,
 
2042
                                          "approved_by_default"),
 
2043
            }
 
2044
        for name, value in config.items(section):
2477
2045
            try:
2478
 
                client["secret"] = (
2479
 
                    pgp.decrypt(client["encrypted_secret"],
2480
 
                                client_settings[client_name]
2481
 
                                ["secret"]))
2482
 
            except PGPError:
2483
 
                # If decryption fails, we use secret from new settings
2484
 
                logger.debug("Failed to decrypt {0} old secret"
2485
 
                             .format(client_name))
2486
 
                client["secret"] = (
2487
 
                    client_settings[client_name]["secret"])
2488
 
    
2489
 
    # Add/remove clients based on new changes made to config
2490
 
    for client_name in (set(old_client_settings)
2491
 
                        - set(client_settings)):
2492
 
        del clients_data[client_name]
2493
 
    for client_name in (set(client_settings)
2494
 
                        - set(old_client_settings)):
2495
 
        clients_data[client_name] = client_settings[client_name]
2496
 
    
2497
 
    # Create all client objects
2498
 
    for client_name, client in clients_data.iteritems():
2499
 
        tcp_server.clients[client_name] = client_class(
2500
 
            name = client_name, settings = client)
2501
 
    
 
2046
                yield (name, special_settings[name]())
 
2047
            except KeyError:
 
2048
                yield (name, value)
 
2049
    
 
2050
    tcp_server.clients.update(set(
 
2051
            client_class(name = section,
 
2052
                         config= dict(client_config_items(
 
2053
                        client_config, section)))
 
2054
            for section in client_config.sections()))
2502
2055
    if not tcp_server.clients:
2503
2056
        logger.warning("No clients defined")
2504
 
    
2505
 
    if not foreground:
2506
 
        if pidfile is not None:
2507
 
            try:
2508
 
                with pidfile:
2509
 
                    pid = os.getpid()
2510
 
                    pidfile.write(str(pid) + "\n".encode("utf-8"))
2511
 
            except IOError:
2512
 
                logger.error("Could not write to file %r with PID %d",
2513
 
                             pidfilename, pid)
2514
 
        del pidfile
 
2057
        
 
2058
    if not debug:
 
2059
        try:
 
2060
            with pidfile:
 
2061
                pid = os.getpid()
 
2062
                pidfile.write(str(pid) + "\n".encode("utf-8"))
 
2063
            del pidfile
 
2064
        except IOError:
 
2065
            logger.error("Could not write to file %r with PID %d",
 
2066
                         pidfilename, pid)
 
2067
        except NameError:
 
2068
            # "pidfile" was never created
 
2069
            pass
2515
2070
        del pidfilename
 
2071
        
 
2072
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2516
2073
    
2517
2074
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2518
2075
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2519
2076
    
2520
2077
    if use_dbus:
2521
 
        @alternate_dbus_interfaces({"se.recompile.Mandos":
2522
 
                                        "se.bsnet.fukt.Mandos"})
2523
 
        class MandosDBusService(DBusObjectWithProperties):
 
2078
        class MandosDBusService(dbus.service.Object):
2524
2079
            """A D-Bus proxy object"""
2525
2080
            def __init__(self):
2526
2081
                dbus.service.Object.__init__(self, bus, "/")
2527
2082
            _interface = "se.recompile.Mandos"
2528
2083
            
2529
 
            @dbus_interface_annotations(_interface)
2530
 
            def _foo(self):
2531
 
                return { "org.freedesktop.DBus.Property"
2532
 
                         ".EmitsChangedSignal":
2533
 
                             "false"}
2534
 
            
2535
2084
            @dbus.service.signal(_interface, signature="o")
2536
2085
            def ClientAdded(self, objpath):
2537
2086
                "D-Bus signal"
2551
2100
            def GetAllClients(self):
2552
2101
                "D-Bus method"
2553
2102
                return dbus.Array(c.dbus_object_path
2554
 
                                  for c in
2555
 
                                  tcp_server.clients.itervalues())
 
2103
                                  for c in tcp_server.clients)
2556
2104
            
2557
2105
            @dbus.service.method(_interface,
2558
2106
                                 out_signature="a{oa{sv}}")
2560
2108
                "D-Bus method"
2561
2109
                return dbus.Dictionary(
2562
2110
                    ((c.dbus_object_path, c.GetAll(""))
2563
 
                     for c in tcp_server.clients.itervalues()),
 
2111
                     for c in tcp_server.clients),
2564
2112
                    signature="oa{sv}")
2565
2113
            
2566
2114
            @dbus.service.method(_interface, in_signature="o")
2567
2115
            def RemoveClient(self, object_path):
2568
2116
                "D-Bus method"
2569
 
                for c in tcp_server.clients.itervalues():
 
2117
                for c in tcp_server.clients:
2570
2118
                    if c.dbus_object_path == object_path:
2571
 
                        del tcp_server.clients[c.name]
 
2119
                        tcp_server.clients.remove(c)
2572
2120
                        c.remove_from_connection()
2573
2121
                        # Don't signal anything except ClientRemoved
2574
2122
                        c.disable(quiet=True)
2579
2127
            
2580
2128
            del _interface
2581
2129
        
2582
 
        mandos_dbus_service = MandosDBusService()
 
2130
        class MandosDBusServiceTransitional(MandosDBusService):
 
2131
            __metaclass__ = AlternateDBusNamesMetaclass
 
2132
        mandos_dbus_service = MandosDBusServiceTransitional()
2583
2133
    
2584
2134
    def cleanup():
2585
2135
        "Cleanup function; run on exit"
2586
2136
        service.cleanup()
2587
2137
        
2588
2138
        multiprocessing.active_children()
2589
 
        if not (tcp_server.clients or client_settings):
2590
 
            return
2591
 
        
2592
 
        # Store client before exiting. Secrets are encrypted with key
2593
 
        # based on what config file has. If config file is
2594
 
        # removed/edited, old secret will thus be unrecovable.
2595
 
        clients = {}
2596
 
        with PGPEngine() as pgp:
2597
 
            for client in tcp_server.clients.itervalues():
2598
 
                key = client_settings[client.name]["secret"]
2599
 
                client.encrypted_secret = pgp.encrypt(client.secret,
2600
 
                                                      key)
2601
 
                client_dict = {}
2602
 
                
2603
 
                # A list of attributes that can not be pickled
2604
 
                # + secret.
2605
 
                exclude = set(("bus", "changedstate", "secret",
2606
 
                               "checker"))
2607
 
                for name, typ in (inspect.getmembers
2608
 
                                  (dbus.service.Object)):
2609
 
                    exclude.add(name)
2610
 
                
2611
 
                client_dict["encrypted_secret"] = (client
2612
 
                                                   .encrypted_secret)
2613
 
                for attr in client.client_structure:
2614
 
                    if attr not in exclude:
2615
 
                        client_dict[attr] = getattr(client, attr)
2616
 
                
2617
 
                clients[client.name] = client_dict
2618
 
                del client_settings[client.name]["secret"]
2619
 
        
2620
 
        try:
2621
 
            with (tempfile.NamedTemporaryFile
2622
 
                  (mode='wb', suffix=".pickle", prefix='clients-',
2623
 
                   dir=os.path.dirname(stored_state_path),
2624
 
                   delete=False)) as stored_state:
2625
 
                pickle.dump((clients, client_settings), stored_state)
2626
 
                tempname=stored_state.name
2627
 
            os.rename(tempname, stored_state_path)
2628
 
        except (IOError, OSError) as e:
2629
 
            if not debug:
2630
 
                try:
2631
 
                    os.remove(tempname)
2632
 
                except NameError:
2633
 
                    pass
2634
 
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2635
 
                logger.warning("Could not save persistent state: {0}"
2636
 
                               .format(os.strerror(e.errno)))
2637
 
            else:
2638
 
                logger.warning("Could not save persistent state:",
2639
 
                               exc_info=e)
2640
 
                raise e
2641
 
        
2642
 
        # Delete all clients, and settings from config
2643
2139
        while tcp_server.clients:
2644
 
            name, client = tcp_server.clients.popitem()
 
2140
            client = tcp_server.clients.pop()
2645
2141
            if use_dbus:
2646
2142
                client.remove_from_connection()
 
2143
            client.disable_hook = None
2647
2144
            # Don't signal anything except ClientRemoved
2648
2145
            client.disable(quiet=True)
2649
2146
            if use_dbus:
2651
2148
                mandos_dbus_service.ClientRemoved(client
2652
2149
                                                  .dbus_object_path,
2653
2150
                                                  client.name)
2654
 
        client_settings.clear()
2655
2151
    
2656
2152
    atexit.register(cleanup)
2657
2153
    
2658
 
    for client in tcp_server.clients.itervalues():
 
2154
    for client in tcp_server.clients:
2659
2155
        if use_dbus:
2660
2156
            # Emit D-Bus signal
2661
2157
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
2662
 
        # Need to initiate checking of clients
2663
 
        if client.enabled:
2664
 
            client.init_checker()
 
2158
        client.enable()
2665
2159
    
2666
2160
    tcp_server.enable()
2667
2161
    tcp_server.server_activate()
2670
2164
    service.port = tcp_server.socket.getsockname()[1]
2671
2165
    if use_ipv6:
2672
2166
        logger.info("Now listening on address %r, port %d,"
2673
 
                    " flowinfo %d, scope_id %d",
2674
 
                    *tcp_server.socket.getsockname())
 
2167
                    " flowinfo %d, scope_id %d"
 
2168
                    % tcp_server.socket.getsockname())
2675
2169
    else:                       # IPv4
2676
 
        logger.info("Now listening on address %r, port %d",
2677
 
                    *tcp_server.socket.getsockname())
 
2170
        logger.info("Now listening on address %r, port %d"
 
2171
                    % tcp_server.socket.getsockname())
2678
2172
    
2679
2173
    #service.interface = tcp_server.socket.getsockname()[3]
2680
2174
    
2683
2177
        try:
2684
2178
            service.activate()
2685
2179
        except dbus.exceptions.DBusException as error:
2686
 
            logger.critical("D-Bus Exception", exc_info=error)
 
2180
            logger.critical("DBusException: %s", error)
2687
2181
            cleanup()
2688
2182
            sys.exit(1)
2689
2183
        # End of Avahi example code
2696
2190
        logger.debug("Starting main loop")
2697
2191
        main_loop.run()
2698
2192
    except AvahiError as error:
2699
 
        logger.critical("Avahi Error", exc_info=error)
 
2193
        logger.critical("AvahiError: %s", error)
2700
2194
        cleanup()
2701
2195
        sys.exit(1)
2702
2196
    except KeyboardInterrupt:
2707
2201
    # Must run before the D-Bus bus name gets deregistered
2708
2202
    cleanup()
2709
2203
 
 
2204
 
2710
2205
if __name__ == '__main__':
2711
2206
    main()