/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

* plugins.d/mandos-client.c: Some white space fixes.
  (runnable_hook): Simplify name rule.  More debug messages.

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.5.5"
92
 
stored_state_file = "clients.pickle"
93
 
 
94
 
logger = logging.getLogger()
 
85
 
 
86
version = "1.4.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
579
 
        self.expires = datetime.datetime.utcnow() + self.timeout
580
 
        self.enabled = True
581
 
        self.last_enabled = datetime.datetime.utcnow()
582
 
        self.init_checker()
583
399
        self.send_changedstate()
584
 
    
585
 
    def disable(self, quiet=True):
586
 
        """Disable this client."""
587
 
        if not getattr(self, "enabled", False):
588
 
            return False
589
 
        if not quiet:
590
 
            logger.info("Disabling client %s", self.name)
591
 
        if getattr(self, "disable_initiator_tag", None) is not None:
592
 
            gobject.source_remove(self.disable_initiator_tag)
593
 
            self.disable_initiator_tag = None
594
 
        self.expires = None
595
 
        if getattr(self, "checker_initiator_tag", None) is not None:
596
 
            gobject.source_remove(self.checker_initiator_tag)
597
 
            self.checker_initiator_tag = None
598
 
        self.stop_checker()
599
 
        self.enabled = False
600
 
        if not quiet:
601
 
            self.send_changedstate()
602
 
        # Do not run this again if called by a gobject.timeout_add
603
 
        return False
604
 
    
605
 
    def __del__(self):
606
 
        self.disable()
607
 
    
608
 
    def init_checker(self):
609
400
        # Schedule a new checker to be started an 'interval' from now,
610
401
        # and every interval from then on.
611
 
        if self.checker_initiator_tag is not None:
612
 
            gobject.source_remove(self.checker_initiator_tag)
613
402
        self.checker_initiator_tag = (gobject.timeout_add
614
403
                                      (self.interval_milliseconds(),
615
404
                                       self.start_checker))
616
405
        # Schedule a disable() when 'timeout' has passed
617
 
        if self.disable_initiator_tag is not None:
618
 
            gobject.source_remove(self.disable_initiator_tag)
 
406
        self.expires = datetime.datetime.utcnow() + self.timeout
619
407
        self.disable_initiator_tag = (gobject.timeout_add
620
408
                                   (self.timeout_milliseconds(),
621
409
                                    self.disable))
 
410
        self.enabled = True
 
411
        self.last_enabled = datetime.datetime.utcnow()
622
412
        # Also start a new checker *right now*.
623
413
        self.start_checker()
624
414
    
 
415
    def disable(self, quiet=True):
 
416
        """Disable this client."""
 
417
        if not getattr(self, "enabled", False):
 
418
            return False
 
419
        if not quiet:
 
420
            self.send_changedstate()
 
421
        if not quiet:
 
422
            logger.info("Disabling client %s", self.name)
 
423
        if getattr(self, "disable_initiator_tag", False):
 
424
            gobject.source_remove(self.disable_initiator_tag)
 
425
            self.disable_initiator_tag = None
 
426
        self.expires = None
 
427
        if getattr(self, "checker_initiator_tag", False):
 
428
            gobject.source_remove(self.checker_initiator_tag)
 
429
            self.checker_initiator_tag = None
 
430
        self.stop_checker()
 
431
        if self.disable_hook:
 
432
            self.disable_hook(self)
 
433
        self.enabled = False
 
434
        # Do not run this again if called by a gobject.timeout_add
 
435
        return False
 
436
    
 
437
    def __del__(self):
 
438
        self.disable_hook = None
 
439
        self.disable()
 
440
    
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
 
466
        self.last_checked_ok = datetime.datetime.utcnow()
653
467
        if self.disable_initiator_tag is not None:
654
468
            gobject.source_remove(self.disable_initiator_tag)
655
 
            self.disable_initiator_tag = None
656
469
        if getattr(self, "enabled", False):
657
470
            self.disable_initiator_tag = (gobject.timeout_add
658
 
                                          (timedelta_to_milliseconds
 
471
                                          (_timedelta_to_milliseconds
659
472
                                           (timeout), self.disable))
660
473
            self.expires = datetime.datetime.utcnow() + timeout
661
474
    
668
481
        If a checker already exists, leave it running and do
669
482
        nothing."""
670
483
        # 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
 
484
        # did that, then if a checker (for some reason) started
 
485
        # running slowly and taking more than 'interval' time, the
 
486
        # client would inevitably timeout, since no checker would get
 
487
        # a chance to run to completion.  If we instead leave running
675
488
        # checkers alone, the checker would have to take more time
676
489
        # than 'timeout' for the client to be disabled, which is as it
677
490
        # should be.
691
504
                                      self.current_checker_command)
692
505
        # Start a new checker if needed
693
506
        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
507
            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
 
508
                # In case checker_command has exactly one % operator
 
509
                command = self.checker_command % self.host
 
510
            except TypeError:
 
511
                # Escape attributes for the shell
 
512
                escaped_attrs = dict(
 
513
                    (attr,
 
514
                     re.escape(unicode(str(getattr(self, attr, "")),
 
515
                                       errors=
 
516
                                       'replace')))
 
517
                    for attr in
 
518
                    self.runtime_expansions)
 
519
                
 
520
                try:
 
521
                    command = self.checker_command % escaped_attrs
 
522
                except TypeError as error:
 
523
                    logger.error('Could not format string "%s":'
 
524
                                 ' %s', self.checker_command, error)
 
525
                    return True # Try again later
705
526
            self.current_checker_command = command
706
527
            try:
707
528
                logger.info("Starting checker %r for %s",
713
534
                self.checker = subprocess.Popen(command,
714
535
                                                close_fds=True,
715
536
                                                shell=True, cwd="/")
 
537
                self.checker_callback_tag = (gobject.child_watch_add
 
538
                                             (self.checker.pid,
 
539
                                              self.checker_callback,
 
540
                                              data=command))
 
541
                # The checker may have completed before the gobject
 
542
                # watch was added.  Check for this.
 
543
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
544
                if pid:
 
545
                    gobject.source_remove(self.checker_callback_tag)
 
546
                    self.checker_callback(pid, status, command)
716
547
            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)
 
548
                logger.error("Failed to start subprocess: %s",
 
549
                             error)
729
550
        # Re-run this periodically if run by gobject.timeout_add
730
551
        return True
731
552
    
738
559
            return
739
560
        logger.debug("Stopping checker for %(name)s", vars(self))
740
561
        try:
741
 
            self.checker.terminate()
 
562
            os.kill(self.checker.pid, signal.SIGTERM)
742
563
            #time.sleep(0.5)
743
564
            #if self.checker.poll() is None:
744
 
            #    self.checker.kill()
 
565
            #    os.kill(self.checker.pid, signal.SIGKILL)
745
566
        except OSError as error:
746
567
            if error.errno != errno.ESRCH: # No such process
747
568
                raise
764
585
    # "Set" method, so we fail early here:
765
586
    if byte_arrays and signature != "ay":
766
587
        raise ValueError("Byte arrays not supported for non-'ay'"
767
 
                         " signature {0!r}".format(signature))
 
588
                         " signature %r" % signature)
768
589
    def decorator(func):
769
590
        func._dbus_is_property = True
770
591
        func._dbus_interface = dbus_interface
778
599
    return decorator
779
600
 
780
601
 
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
602
class DBusPropertyException(dbus.exceptions.DBusException):
819
603
    """A base class for D-Bus property-related exceptions
820
604
    """
843
627
    """
844
628
    
845
629
    @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)
 
630
    def _is_dbus_property(obj):
 
631
        return getattr(obj, "_dbus_is_property", False)
854
632
    
855
 
    def _get_all_dbus_things(self, thing):
 
633
    def _get_all_dbus_properties(self):
856
634
        """Returns a generator of (name, attribute) pairs
857
635
        """
858
 
        return ((getattr(athing.__get__(self), "_dbus_name",
859
 
                         name),
860
 
                 athing.__get__(self))
 
636
        return ((prop.__get__(self)._dbus_name, prop.__get__(self))
861
637
                for cls in self.__class__.__mro__
862
 
                for name, athing in
863
 
                inspect.getmembers(cls,
864
 
                                   self._is_dbus_thing(thing)))
 
638
                for name, prop in
 
639
                inspect.getmembers(cls, self._is_dbus_property))
865
640
    
866
641
    def _get_dbus_property(self, interface_name, property_name):
867
642
        """Returns a bound method if one exists which is a D-Bus
869
644
        """
870
645
        for cls in  self.__class__.__mro__:
871
646
            for name, value in (inspect.getmembers
872
 
                                (cls,
873
 
                                 self._is_dbus_thing("property"))):
 
647
                                (cls, self._is_dbus_property)):
874
648
                if (value._dbus_name == property_name
875
649
                    and value._dbus_interface == interface_name):
876
650
                    return value.__get__(self)
905
679
            # signatures other than "ay".
906
680
            if prop._dbus_signature != "ay":
907
681
                raise ValueError
908
 
            value = dbus.ByteArray(b''.join(chr(byte)
909
 
                                            for byte in value))
 
682
            value = dbus.ByteArray(''.join(unichr(byte)
 
683
                                           for byte in value))
910
684
        prop(value)
911
685
    
912
686
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
917
691
        
918
692
        Note: Will not include properties with access="write".
919
693
        """
920
 
        properties = {}
921
 
        for name, prop in self._get_all_dbus_things("property"):
 
694
        all = {}
 
695
        for name, prop in self._get_all_dbus_properties():
922
696
            if (interface_name
923
697
                and interface_name != prop._dbus_interface):
924
698
                # Interface non-empty but did not match
928
702
                continue
929
703
            value = prop()
930
704
            if not hasattr(value, "variant_level"):
931
 
                properties[name] = value
 
705
                all[name] = value
932
706
                continue
933
 
            properties[name] = type(value)(value, variant_level=
934
 
                                           value.variant_level+1)
935
 
        return dbus.Dictionary(properties, signature="sv")
 
707
            all[name] = type(value)(value, variant_level=
 
708
                                    value.variant_level+1)
 
709
        return dbus.Dictionary(all, signature="sv")
936
710
    
937
711
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
938
712
                         out_signature="s",
939
713
                         path_keyword='object_path',
940
714
                         connection_keyword='connection')
941
715
    def Introspect(self, object_path, connection):
942
 
        """Overloading of standard D-Bus method.
943
 
        
944
 
        Inserts property tags and interface annotation tags.
 
716
        """Standard D-Bus method, overloaded to insert property tags.
945
717
        """
946
718
        xmlstring = dbus.service.Object.Introspect(self, object_path,
947
719
                                                   connection)
954
726
                e.setAttribute("access", prop._dbus_access)
955
727
                return e
956
728
            for if_tag in document.getElementsByTagName("interface"):
957
 
                # Add property tags
958
729
                for tag in (make_tag(document, name, prop)
959
730
                            for name, prop
960
 
                            in self._get_all_dbus_things("property")
 
731
                            in self._get_all_dbus_properties()
961
732
                            if prop._dbus_interface
962
733
                            == if_tag.getAttribute("name")):
963
734
                    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
735
                # Add the names to the return values for the
996
736
                # "org.freedesktop.DBus.Properties" methods
997
737
                if (if_tag.getAttribute("name")
1012
752
        except (AttributeError, xml.dom.DOMException,
1013
753
                xml.parsers.expat.ExpatError) as error:
1014
754
            logger.error("Failed to override Introspection method",
1015
 
                         exc_info=error)
 
755
                         error)
1016
756
        return xmlstring
1017
757
 
1018
758
 
1019
 
def datetime_to_dbus(dt, variant_level=0):
 
759
def datetime_to_dbus (dt, variant_level=0):
1020
760
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1021
761
    if dt is None:
1022
762
        return dbus.String("", variant_level = variant_level)
1023
763
    return dbus.String(dt.isoformat(),
1024
764
                       variant_level=variant_level)
1025
765
 
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).
 
766
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
 
767
                                  .__metaclass__):
 
768
    """Applied to an empty subclass of a D-Bus object, this metaclass
 
769
    will add additional D-Bus attributes matching a certain pattern.
1049
770
    """
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):
 
771
    def __new__(mcs, name, bases, attr):
 
772
        # Go through all the base classes which could have D-Bus
 
773
        # methods, signals, or properties in them
 
774
        for base in (b for b in bases
 
775
                     if issubclass(b, dbus.service.Object)):
 
776
            # Go though all attributes of the base class
 
777
            for attrname, attribute in inspect.getmembers(base):
1057
778
                # Ignore non-D-Bus attributes, and D-Bus attributes
1058
779
                # with the wrong interface name
1059
780
                if (not hasattr(attribute, "_dbus_interface")
1060
781
                    or not attribute._dbus_interface
1061
 
                    .startswith(orig_interface_name)):
 
782
                    .startswith("se.recompile.Mandos")):
1062
783
                    continue
1063
784
                # Create an alternate D-Bus interface name based on
1064
785
                # the current name
1065
786
                alt_interface = (attribute._dbus_interface
1066
 
                                 .replace(orig_interface_name,
1067
 
                                          alt_interface_name))
1068
 
                interface_names.add(alt_interface)
 
787
                                 .replace("se.recompile.Mandos",
 
788
                                          "se.bsnet.fukt.Mandos"))
1069
789
                # Is this a D-Bus signal?
1070
790
                if getattr(attribute, "_dbus_is_signal", False):
1071
791
                    # Extract the original non-method function by
1086
806
                                nonmethod_func.func_name,
1087
807
                                nonmethod_func.func_defaults,
1088
808
                                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
809
                    # 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
 
810
                    # old and new functions, so both the old and new
 
811
                    # signals gets sent when the function is called
1099
812
                    def fixscope(func1, func2):
1100
813
                        """This function is a scope container to pass
1101
814
                        func1 and func2 to the "call_both" function
1108
821
                        return call_both
1109
822
                    # Create the "call_both" function and add it to
1110
823
                    # the class
1111
 
                    attr[attrname] = fixscope(attribute, new_function)
 
824
                    attr[attrname] = fixscope(attribute,
 
825
                                              new_function)
1112
826
                # Is this a D-Bus method?
1113
827
                elif getattr(attribute, "_dbus_is_method", False):
1114
828
                    # Create a new, but exactly alike, function
1125
839
                                        attribute.func_name,
1126
840
                                        attribute.func_defaults,
1127
841
                                        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
842
                # Is this a D-Bus property?
1135
843
                elif getattr(attribute, "_dbus_is_property", False):
1136
844
                    # Create a new, but exactly alike, function
1150
858
                                        attribute.func_name,
1151
859
                                        attribute.func_defaults,
1152
860
                                        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"})
 
861
        return type.__new__(mcs, name, bases, attr)
 
862
 
1198
863
class ClientDBus(Client, DBusObjectWithProperties):
1199
864
    """A Client class using D-Bus
1200
865
    
1209
874
    # dbus.service.Object doesn't use super(), so we can't either.
1210
875
    
1211
876
    def __init__(self, bus = None, *args, **kwargs):
 
877
        self._approvals_pending = 0
1212
878
        self.bus = bus
1213
879
        Client.__init__(self, *args, **kwargs)
1214
880
        # Only now, when this client is initialized, can it show up on
1220
886
                                 ("/clients/" + client_object_name))
1221
887
        DBusObjectWithProperties.__init__(self, self.bus,
1222
888
                                          self.dbus_object_path)
1223
 
    
 
889
        
1224
890
    def notifychangeproperty(transform_func,
1225
891
                             dbus_name, type_func=lambda x: x,
1226
892
                             variant_level=1):
1227
893
        """ Modify a variable so that it's a property which announces
1228
894
        its changes to DBus.
1229
 
        
 
895
 
1230
896
        transform_fun: Function that takes a value and a variant_level
1231
897
                       and transforms it to a D-Bus type.
1232
898
        dbus_name: D-Bus name of the variable
1249
915
        
1250
916
        return property(lambda self: getattr(self, attrname), setter)
1251
917
    
 
918
    
1252
919
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1253
920
    approvals_pending = notifychangeproperty(dbus.Boolean,
1254
921
                                             "ApprovalPending",
1261
928
                                       checker is not None)
1262
929
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1263
930
                                           "LastCheckedOK")
1264
 
    last_checker_status = notifychangeproperty(dbus.Int16,
1265
 
                                               "LastCheckerStatus")
1266
931
    last_approval_request = notifychangeproperty(
1267
932
        datetime_to_dbus, "LastApprovalRequest")
1268
933
    approved_by_default = notifychangeproperty(dbus.Boolean,
1269
934
                                               "ApprovedByDefault")
1270
 
    approval_delay = notifychangeproperty(dbus.UInt64,
 
935
    approval_delay = notifychangeproperty(dbus.UInt16,
1271
936
                                          "ApprovalDelay",
1272
937
                                          type_func =
1273
 
                                          timedelta_to_milliseconds)
 
938
                                          _timedelta_to_milliseconds)
1274
939
    approval_duration = notifychangeproperty(
1275
 
        dbus.UInt64, "ApprovalDuration",
1276
 
        type_func = timedelta_to_milliseconds)
 
940
        dbus.UInt16, "ApprovalDuration",
 
941
        type_func = _timedelta_to_milliseconds)
1277
942
    host = notifychangeproperty(dbus.String, "Host")
1278
 
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
 
943
    timeout = notifychangeproperty(dbus.UInt16, "Timeout",
1279
944
                                   type_func =
1280
 
                                   timedelta_to_milliseconds)
 
945
                                   _timedelta_to_milliseconds)
1281
946
    extended_timeout = notifychangeproperty(
1282
 
        dbus.UInt64, "ExtendedTimeout",
1283
 
        type_func = timedelta_to_milliseconds)
1284
 
    interval = notifychangeproperty(dbus.UInt64,
 
947
        dbus.UInt16, "ExtendedTimeout",
 
948
        type_func = _timedelta_to_milliseconds)
 
949
    interval = notifychangeproperty(dbus.UInt16,
1285
950
                                    "Interval",
1286
951
                                    type_func =
1287
 
                                    timedelta_to_milliseconds)
 
952
                                    _timedelta_to_milliseconds)
1288
953
    checker_command = notifychangeproperty(dbus.String, "Checker")
1289
954
    
1290
955
    del notifychangeproperty
1332
997
        return r
1333
998
    
1334
999
    def _reset_approved(self):
1335
 
        self.approved = None
 
1000
        self._approved = None
1336
1001
        return False
1337
1002
    
1338
1003
    def approve(self, value=True):
1339
 
        self.approved = value
1340
 
        gobject.timeout_add(timedelta_to_milliseconds
 
1004
        self.send_changedstate()
 
1005
        self._approved = value
 
1006
        gobject.timeout_add(_timedelta_to_milliseconds
1341
1007
                            (self.approval_duration),
1342
1008
                            self._reset_approved)
1343
 
        self.send_changedstate()
 
1009
    
1344
1010
    
1345
1011
    ## D-Bus methods, signals & properties
1346
1012
    _interface = "se.recompile.Mandos.Client"
1347
1013
    
1348
 
    ## Interfaces
1349
 
    
1350
 
    @dbus_interface_annotations(_interface)
1351
 
    def _foo(self):
1352
 
        return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1353
 
                     "false"}
1354
 
    
1355
1014
    ## Signals
1356
1015
    
1357
1016
    # CheckerCompleted - signal
1456
1115
                           access="readwrite")
1457
1116
    def ApprovalDuration_dbus_property(self, value=None):
1458
1117
        if value is None:       # get
1459
 
            return dbus.UInt64(timedelta_to_milliseconds(
 
1118
            return dbus.UInt64(_timedelta_to_milliseconds(
1460
1119
                    self.approval_duration))
1461
1120
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1462
1121
    
1476
1135
    def Host_dbus_property(self, value=None):
1477
1136
        if value is None:       # get
1478
1137
            return dbus.String(self.host)
1479
 
        self.host = unicode(value)
 
1138
        self.host = value
1480
1139
    
1481
1140
    # Created - property
1482
1141
    @dbus_service_property(_interface, signature="s", access="read")
1483
1142
    def Created_dbus_property(self):
1484
 
        return datetime_to_dbus(self.created)
 
1143
        return dbus.String(datetime_to_dbus(self.created))
1485
1144
    
1486
1145
    # LastEnabled - property
1487
1146
    @dbus_service_property(_interface, signature="s", access="read")
1508
1167
            return
1509
1168
        return datetime_to_dbus(self.last_checked_ok)
1510
1169
    
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
1170
    # Expires - property
1518
1171
    @dbus_service_property(_interface, signature="s", access="read")
1519
1172
    def Expires_dbus_property(self):
1530
1183
    def Timeout_dbus_property(self, value=None):
1531
1184
        if value is None:       # get
1532
1185
            return dbus.UInt64(self.timeout_milliseconds())
1533
 
        old_timeout = self.timeout
1534
1186
        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))
 
1187
        if getattr(self, "disable_initiator_tag", None) is None:
 
1188
            return
 
1189
        # Reschedule timeout
 
1190
        gobject.source_remove(self.disable_initiator_tag)
 
1191
        self.disable_initiator_tag = None
 
1192
        self.expires = None
 
1193
        time_to_die = _timedelta_to_milliseconds((self
 
1194
                                                  .last_checked_ok
 
1195
                                                  + self.timeout)
 
1196
                                                 - datetime.datetime
 
1197
                                                 .utcnow())
 
1198
        if time_to_die <= 0:
 
1199
            # The timeout has passed
 
1200
            self.disable()
 
1201
        else:
 
1202
            self.expires = (datetime.datetime.utcnow()
 
1203
                            + datetime.timedelta(milliseconds =
 
1204
                                                 time_to_die))
 
1205
            self.disable_initiator_tag = (gobject.timeout_add
 
1206
                                          (time_to_die, self.disable))
1551
1207
    
1552
1208
    # ExtendedTimeout - property
1553
1209
    @dbus_service_property(_interface, signature="t",
1566
1222
        self.interval = datetime.timedelta(0, 0, 0, value)
1567
1223
        if getattr(self, "checker_initiator_tag", None) is None:
1568
1224
            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
 
1225
        # Reschedule checker run
 
1226
        gobject.source_remove(self.checker_initiator_tag)
 
1227
        self.checker_initiator_tag = (gobject.timeout_add
 
1228
                                      (value, self.start_checker))
 
1229
        self.start_checker()    # Start one now, too
1575
1230
    
1576
1231
    # Checker - property
1577
1232
    @dbus_service_property(_interface, signature="s",
1579
1234
    def Checker_dbus_property(self, value=None):
1580
1235
        if value is None:       # get
1581
1236
            return dbus.String(self.checker_command)
1582
 
        self.checker_command = unicode(value)
 
1237
        self.checker_command = value
1583
1238
    
1584
1239
    # CheckerRunning - property
1585
1240
    @dbus_service_property(_interface, signature="b",
1614
1269
            raise KeyError()
1615
1270
    
1616
1271
    def __getattribute__(self, name):
1617
 
        if name == '_pipe':
 
1272
        if(name == '_pipe'):
1618
1273
            return super(ProxyClient, self).__getattribute__(name)
1619
1274
        self._pipe.send(('getattr', name))
1620
1275
        data = self._pipe.recv()
1627
1282
            return func
1628
1283
    
1629
1284
    def __setattr__(self, name, value):
1630
 
        if name == '_pipe':
 
1285
        if(name == '_pipe'):
1631
1286
            return super(ProxyClient, self).__setattr__(name, value)
1632
1287
        self._pipe.send(('setattr', name, value))
1633
1288
 
 
1289
class ClientDBusTransitional(ClientDBus):
 
1290
    __metaclass__ = AlternateDBusNamesMetaclass
1634
1291
 
1635
1292
class ClientHandler(socketserver.BaseRequestHandler, object):
1636
1293
    """A class to handle client connections.
1719
1376
                            client.Rejected("Disabled")
1720
1377
                        return
1721
1378
                    
1722
 
                    if client.approved or not client.approval_delay:
 
1379
                    if client._approved or not client.approval_delay:
1723
1380
                        #We are approved or approval is disabled
1724
1381
                        break
1725
 
                    elif client.approved is None:
 
1382
                    elif client._approved is None:
1726
1383
                        logger.info("Client %s needs approval",
1727
1384
                                    client.name)
1728
1385
                        if self.server.use_dbus:
1741
1398
                    #wait until timeout or approved
1742
1399
                    time = datetime.datetime.now()
1743
1400
                    client.changedstate.acquire()
1744
 
                    client.changedstate.wait(
1745
 
                        float(timedelta_to_milliseconds(delay)
1746
 
                              / 1000))
 
1401
                    (client.changedstate.wait
 
1402
                     (float(client._timedelta_to_milliseconds(delay)
 
1403
                            / 1000)))
1747
1404
                    client.changedstate.release()
1748
1405
                    time2 = datetime.datetime.now()
1749
1406
                    if (time2 - time) >= delay:
1765
1422
                    try:
1766
1423
                        sent = session.send(client.secret[sent_size:])
1767
1424
                    except gnutls.errors.GNUTLSError as error:
1768
 
                        logger.warning("gnutls send failed",
1769
 
                                       exc_info=error)
 
1425
                        logger.warning("gnutls send failed")
1770
1426
                        return
1771
1427
                    logger.debug("Sent: %d, remaining: %d",
1772
1428
                                 sent, len(client.secret)
1775
1431
                
1776
1432
                logger.info("Sending secret to %s", client.name)
1777
1433
                # bump the timeout using extended_timeout
1778
 
                client.bump_timeout(client.extended_timeout)
 
1434
                client.checked_ok(client.extended_timeout)
1779
1435
                if self.server.use_dbus:
1780
1436
                    # Emit D-Bus signal
1781
1437
                    client.GotSecret()
1786
1442
                try:
1787
1443
                    session.bye()
1788
1444
                except gnutls.errors.GNUTLSError as error:
1789
 
                    logger.warning("GnuTLS bye failed",
1790
 
                                   exc_info=error)
 
1445
                    logger.warning("GnuTLS bye failed")
1791
1446
    
1792
1447
    @staticmethod
1793
1448
    def peer_certificate(session):
1849
1504
        # Convert the buffer to a Python bytestring
1850
1505
        fpr = ctypes.string_at(buf, buf_len.value)
1851
1506
        # Convert the bytestring to hexadecimal notation
1852
 
        hex_fpr = binascii.hexlify(fpr).upper()
 
1507
        hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
1853
1508
        return hex_fpr
1854
1509
 
1855
1510
 
1858
1513
    def sub_process_main(self, request, address):
1859
1514
        try:
1860
1515
            self.finish_request(request, address)
1861
 
        except Exception:
 
1516
        except:
1862
1517
            self.handle_error(request, address)
1863
1518
        self.close_request(request)
1864
1519
    
1865
1520
    def process_request(self, request, address):
1866
1521
        """Start a new process to process the request."""
1867
1522
        proc = multiprocessing.Process(target = self.sub_process_main,
1868
 
                                       args = (request, address))
 
1523
                                       args = (request,
 
1524
                                               address))
1869
1525
        proc.start()
1870
1526
        return proc
1871
1527
 
1899
1555
        use_ipv6:       Boolean; to use IPv6 or not
1900
1556
    """
1901
1557
    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
 
        """
 
1558
                 interface=None, use_ipv6=True):
1906
1559
        self.interface = interface
1907
1560
        if use_ipv6:
1908
1561
            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
1562
        socketserver.TCPServer.__init__(self, server_address,
1936
1563
                                        RequestHandlerClass)
1937
 
    
1938
1564
    def server_bind(self):
1939
1565
        """This overrides the normal server_bind() function
1940
1566
        to bind to an interface if one was specified, and also NOT to
1951
1577
                                           str(self.interface
1952
1578
                                               + '\0'))
1953
1579
                except socket.error as error:
1954
 
                    if error.errno == errno.EPERM:
 
1580
                    if error[0] == errno.EPERM:
1955
1581
                        logger.error("No permission to"
1956
1582
                                     " bind to interface %s",
1957
1583
                                     self.interface)
1958
 
                    elif error.errno == errno.ENOPROTOOPT:
 
1584
                    elif error[0] == errno.ENOPROTOOPT:
1959
1585
                        logger.error("SO_BINDTODEVICE not available;"
1960
1586
                                     " cannot bind to interface %s",
1961
1587
                                     self.interface)
1962
 
                    elif error.errno == errno.ENODEV:
1963
 
                        logger.error("Interface %s does not"
1964
 
                                     " exist, cannot bind",
1965
 
                                     self.interface)
1966
1588
                    else:
1967
1589
                        raise
1968
1590
        # Only bind(2) the socket if we really need to.
1998
1620
    """
1999
1621
    def __init__(self, server_address, RequestHandlerClass,
2000
1622
                 interface=None, use_ipv6=True, clients=None,
2001
 
                 gnutls_priority=None, use_dbus=True, socketfd=None):
 
1623
                 gnutls_priority=None, use_dbus=True):
2002
1624
        self.enabled = False
2003
1625
        self.clients = clients
2004
1626
        if self.clients is None:
2005
 
            self.clients = {}
 
1627
            self.clients = set()
2006
1628
        self.use_dbus = use_dbus
2007
1629
        self.gnutls_priority = gnutls_priority
2008
1630
        IPv6_TCPServer.__init__(self, server_address,
2009
1631
                                RequestHandlerClass,
2010
1632
                                interface = interface,
2011
 
                                use_ipv6 = use_ipv6,
2012
 
                                socketfd = socketfd)
 
1633
                                use_ipv6 = use_ipv6)
2013
1634
    def server_activate(self):
2014
1635
        if self.enabled:
2015
1636
            return socketserver.TCPServer.server_activate(self)
2028
1649
    
2029
1650
    def handle_ipc(self, source, condition, parent_pipe=None,
2030
1651
                   proc = None, client_object=None):
 
1652
        condition_names = {
 
1653
            gobject.IO_IN: "IN",   # There is data to read.
 
1654
            gobject.IO_OUT: "OUT", # Data can be written (without
 
1655
                                    # blocking).
 
1656
            gobject.IO_PRI: "PRI", # There is urgent data to read.
 
1657
            gobject.IO_ERR: "ERR", # Error condition.
 
1658
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
 
1659
                                    # broken, usually for pipes and
 
1660
                                    # sockets).
 
1661
            }
 
1662
        conditions_string = ' | '.join(name
 
1663
                                       for cond, name in
 
1664
                                       condition_names.iteritems()
 
1665
                                       if cond & condition)
2031
1666
        # error, or the other end of multiprocessing.Pipe has closed
2032
 
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
 
1667
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2033
1668
            # Wait for other process to exit
2034
1669
            proc.join()
2035
1670
            return False
2042
1677
            fpr = request[1]
2043
1678
            address = request[2]
2044
1679
            
2045
 
            for c in self.clients.itervalues():
 
1680
            for c in self.clients:
2046
1681
                if c.fingerprint == fpr:
2047
1682
                    client = c
2048
1683
                    break
2125
1760
            elif suffix == "w":
2126
1761
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2127
1762
            else:
2128
 
                raise ValueError("Unknown suffix {0!r}"
2129
 
                                 .format(suffix))
 
1763
                raise ValueError("Unknown suffix %r" % suffix)
2130
1764
        except (ValueError, IndexError) as e:
2131
1765
            raise ValueError(*(e.args))
2132
1766
        timevalue += delta
2133
1767
    return timevalue
2134
1768
 
2135
1769
 
 
1770
def if_nametoindex(interface):
 
1771
    """Call the C function if_nametoindex(), or equivalent
 
1772
    
 
1773
    Note: This function cannot accept a unicode string."""
 
1774
    global if_nametoindex
 
1775
    try:
 
1776
        if_nametoindex = (ctypes.cdll.LoadLibrary
 
1777
                          (ctypes.util.find_library("c"))
 
1778
                          .if_nametoindex)
 
1779
    except (OSError, AttributeError):
 
1780
        logger.warning("Doing if_nametoindex the hard way")
 
1781
        def if_nametoindex(interface):
 
1782
            "Get an interface index the hard way, i.e. using fcntl()"
 
1783
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
 
1784
            with contextlib.closing(socket.socket()) as s:
 
1785
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
 
1786
                                    struct.pack(str("16s16x"),
 
1787
                                                interface))
 
1788
            interface_index = struct.unpack(str("I"),
 
1789
                                            ifreq[16:20])[0]
 
1790
            return interface_index
 
1791
    return if_nametoindex(interface)
 
1792
 
 
1793
 
2136
1794
def daemon(nochdir = False, noclose = False):
2137
1795
    """See daemon(3).  Standard BSD Unix function.
2138
1796
    
2146
1804
        sys.exit()
2147
1805
    if not noclose:
2148
1806
        # Close all standard open file descriptors
2149
 
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
1807
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2150
1808
        if not stat.S_ISCHR(os.fstat(null).st_mode):
2151
1809
            raise OSError(errno.ENODEV,
2152
 
                          "{0} not a character device"
2153
 
                          .format(os.devnull))
 
1810
                          "%s not a character device"
 
1811
                          % os.path.devnull)
2154
1812
        os.dup2(null, sys.stdin.fileno())
2155
1813
        os.dup2(null, sys.stdout.fileno())
2156
1814
        os.dup2(null, sys.stderr.fileno())
2165
1823
    
2166
1824
    parser = argparse.ArgumentParser()
2167
1825
    parser.add_argument("-v", "--version", action="version",
2168
 
                        version = "%(prog)s {0}".format(version),
 
1826
                        version = "%%(prog)s %s" % version,
2169
1827
                        help="show version number and exit")
2170
1828
    parser.add_argument("-i", "--interface", metavar="IF",
2171
1829
                        help="Bind to interface IF")
2193
1851
                        " system bus interface")
2194
1852
    parser.add_argument("--no-ipv6", action="store_false",
2195
1853
                        dest="use_ipv6", help="Do not use IPv6")
2196
 
    parser.add_argument("--no-restore", action="store_false",
2197
 
                        dest="restore", help="Do not restore stored"
2198
 
                        " state")
2199
 
    parser.add_argument("--socket", type=int,
2200
 
                        help="Specify a file descriptor to a network"
2201
 
                        " socket to use instead of creating one")
2202
 
    parser.add_argument("--statedir", metavar="DIR",
2203
 
                        help="Directory to save/restore state in")
2204
 
    
2205
1854
    options = parser.parse_args()
2206
1855
    
2207
1856
    if options.check:
2220
1869
                        "use_dbus": "True",
2221
1870
                        "use_ipv6": "True",
2222
1871
                        "debuglevel": "",
2223
 
                        "restore": "True",
2224
 
                        "socket": "",
2225
 
                        "statedir": "/var/lib/mandos"
2226
1872
                        }
2227
1873
    
2228
1874
    # Parse config file for server-global settings
2239
1885
    if server_settings["port"]:
2240
1886
        server_settings["port"] = server_config.getint("DEFAULT",
2241
1887
                                                       "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
1888
    del server_config
2252
1889
    
2253
1890
    # Override the settings from the config file with command line
2254
1891
    # options, if set.
2255
1892
    for option in ("interface", "address", "port", "debug",
2256
1893
                   "priority", "servicename", "configdir",
2257
 
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2258
 
                   "statedir", "socket"):
 
1894
                   "use_dbus", "use_ipv6", "debuglevel"):
2259
1895
        value = getattr(options, option)
2260
1896
        if value is not None:
2261
1897
            server_settings[option] = value
2273
1909
    debuglevel = server_settings["debuglevel"]
2274
1910
    use_dbus = server_settings["use_dbus"]
2275
1911
    use_ipv6 = server_settings["use_ipv6"]
2276
 
    stored_state_path = os.path.join(server_settings["statedir"],
2277
 
                                     stored_state_file)
2278
 
    
2279
 
    if debug:
2280
 
        initlogger(debug, logging.DEBUG)
2281
 
    else:
2282
 
        if not debuglevel:
2283
 
            initlogger(debug)
2284
 
        else:
2285
 
            level = getattr(logging, debuglevel.upper())
2286
 
            initlogger(debug, level)
2287
1912
    
2288
1913
    if server_settings["servicename"] != "Mandos":
2289
1914
        syslogger.setFormatter(logging.Formatter
2290
 
                               ('Mandos ({0}) [%(process)d]:'
2291
 
                                ' %(levelname)s: %(message)s'
2292
 
                                .format(server_settings
2293
 
                                        ["servicename"])))
 
1915
                               ('Mandos (%s) [%%(process)d]:'
 
1916
                                ' %%(levelname)s: %%(message)s'
 
1917
                                % server_settings["servicename"]))
2294
1918
    
2295
1919
    # Parse config file with clients
2296
 
    client_config = configparser.SafeConfigParser(Client
2297
 
                                                  .client_defaults)
 
1920
    client_defaults = { "timeout": "5m",
 
1921
                        "extended_timeout": "15m",
 
1922
                        "interval": "2m",
 
1923
                        "checker": "fping -q -- %%(host)s",
 
1924
                        "host": "",
 
1925
                        "approval_delay": "0s",
 
1926
                        "approval_duration": "1s",
 
1927
                        }
 
1928
    client_config = configparser.SafeConfigParser(client_defaults)
2298
1929
    client_config.read(os.path.join(server_settings["configdir"],
2299
1930
                                    "clients.conf"))
2300
1931
    
2309
1940
                              use_ipv6=use_ipv6,
2310
1941
                              gnutls_priority=
2311
1942
                              server_settings["priority"],
2312
 
                              use_dbus=use_dbus,
2313
 
                              socketfd=(server_settings["socket"]
2314
 
                                        or None))
 
1943
                              use_dbus=use_dbus)
2315
1944
    if not debug:
2316
1945
        pidfilename = "/var/run/mandos.pid"
2317
1946
        try:
2318
1947
            pidfile = open(pidfilename, "w")
2319
 
        except IOError as e:
2320
 
            logger.error("Could not open file %r", pidfilename,
2321
 
                         exc_info=e)
 
1948
        except IOError:
 
1949
            logger.error("Could not open file %r", pidfilename)
2322
1950
    
2323
 
    for name in ("_mandos", "mandos", "nobody"):
 
1951
    try:
 
1952
        uid = pwd.getpwnam("_mandos").pw_uid
 
1953
        gid = pwd.getpwnam("_mandos").pw_gid
 
1954
    except KeyError:
2324
1955
        try:
2325
 
            uid = pwd.getpwnam(name).pw_uid
2326
 
            gid = pwd.getpwnam(name).pw_gid
2327
 
            break
 
1956
            uid = pwd.getpwnam("mandos").pw_uid
 
1957
            gid = pwd.getpwnam("mandos").pw_gid
2328
1958
        except KeyError:
2329
 
            continue
2330
 
    else:
2331
 
        uid = 65534
2332
 
        gid = 65534
 
1959
            try:
 
1960
                uid = pwd.getpwnam("nobody").pw_uid
 
1961
                gid = pwd.getpwnam("nobody").pw_gid
 
1962
            except KeyError:
 
1963
                uid = 65534
 
1964
                gid = 65534
2333
1965
    try:
2334
1966
        os.setgid(gid)
2335
1967
        os.setuid(uid)
2336
1968
    except OSError as error:
2337
 
        if error.errno != errno.EPERM:
 
1969
        if error[0] != errno.EPERM:
2338
1970
            raise error
2339
1971
    
 
1972
    if not debug and not debuglevel:
 
1973
        syslogger.setLevel(logging.WARNING)
 
1974
        console.setLevel(logging.WARNING)
 
1975
    if debuglevel:
 
1976
        level = getattr(logging, debuglevel.upper())
 
1977
        syslogger.setLevel(level)
 
1978
        console.setLevel(level)
 
1979
    
2340
1980
    if debug:
2341
1981
        # Enable all possible GnuTLS debugging
2342
1982
        
2352
1992
         .gnutls_global_set_log_function(debug_gnutls))
2353
1993
        
2354
1994
        # Redirect stdin so all checkers get /dev/null
2355
 
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
1995
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2356
1996
        os.dup2(null, sys.stdin.fileno())
2357
1997
        if null > 2:
2358
1998
            os.close(null)
 
1999
    else:
 
2000
        # No console logging
 
2001
        logger.removeHandler(console)
2359
2002
    
2360
2003
    # Need to fork before connecting to D-Bus
2361
2004
    if not debug:
2362
2005
        # Close all input and output, do double fork, etc.
2363
2006
        daemon()
2364
2007
    
2365
 
    # multiprocessing will use threads, so before we use gobject we
2366
 
    # need to inform gobject that threads will be used.
2367
 
    gobject.threads_init()
2368
 
    
2369
2008
    global main_loop
2370
2009
    # From the Avahi example code
2371
 
    DBusGMainLoop(set_as_default=True)
 
2010
    DBusGMainLoop(set_as_default=True )
2372
2011
    main_loop = gobject.MainLoop()
2373
2012
    bus = dbus.SystemBus()
2374
2013
    # End of Avahi example code
2380
2019
                            ("se.bsnet.fukt.Mandos", bus,
2381
2020
                             do_not_queue=True))
2382
2021
        except dbus.exceptions.NameExistsException as e:
2383
 
            logger.error("Disabling D-Bus:", exc_info=e)
 
2022
            logger.error(unicode(e) + ", disabling D-Bus")
2384
2023
            use_dbus = False
2385
2024
            server_settings["use_dbus"] = False
2386
2025
            tcp_server.use_dbus = False
2387
2026
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2388
 
    service = AvahiServiceToSyslog(name =
2389
 
                                   server_settings["servicename"],
2390
 
                                   servicetype = "_mandos._tcp",
2391
 
                                   protocol = protocol, bus = bus)
 
2027
    service = AvahiService(name = server_settings["servicename"],
 
2028
                           servicetype = "_mandos._tcp",
 
2029
                           protocol = protocol, bus = bus)
2392
2030
    if server_settings["interface"]:
2393
2031
        service.interface = (if_nametoindex
2394
2032
                             (str(server_settings["interface"])))
2398
2036
    
2399
2037
    client_class = Client
2400
2038
    if use_dbus:
2401
 
        client_class = functools.partial(ClientDBus, bus = bus)
2402
 
    
2403
 
    client_settings = Client.config_parser(client_config)
2404
 
    old_client_settings = {}
2405
 
    clients_data = {}
2406
 
    
2407
 
    # Get client data and settings from last running state.
2408
 
    if server_settings["restore"]:
2409
 
        try:
2410
 
            with open(stored_state_path, "rb") as stored_state:
2411
 
                clients_data, old_client_settings = (pickle.load
2412
 
                                                     (stored_state))
2413
 
            os.remove(stored_state_path)
2414
 
        except IOError as e:
2415
 
            if e.errno == errno.ENOENT:
2416
 
                logger.warning("Could not load persistent state: {0}"
2417
 
                                .format(os.strerror(e.errno)))
2418
 
            else:
2419
 
                logger.critical("Could not load persistent state:",
2420
 
                                exc_info=e)
2421
 
                raise
2422
 
        except EOFError as e:
2423
 
            logger.warning("Could not load persistent state: "
2424
 
                           "EOFError:", exc_info=e)
2425
 
    
2426
 
    with PGPEngine() as pgp:
2427
 
        for client_name, client in clients_data.iteritems():
2428
 
            # Decide which value to use after restoring saved state.
2429
 
            # We have three different values: Old config file,
2430
 
            # new config file, and saved state.
2431
 
            # New config value takes precedence if it differs from old
2432
 
            # config value, otherwise use saved state.
2433
 
            for name, value in client_settings[client_name].items():
2434
 
                try:
2435
 
                    # For each value in new config, check if it
2436
 
                    # differs from the old config value (Except for
2437
 
                    # the "secret" attribute)
2438
 
                    if (name != "secret" and
2439
 
                        value != old_client_settings[client_name]
2440
 
                        [name]):
2441
 
                        client[name] = value
2442
 
                except KeyError:
2443
 
                    pass
2444
 
            
2445
 
            # Clients who has passed its expire date can still be
2446
 
            # enabled if its last checker was successful.  Clients
2447
 
            # whose checker succeeded before we stored its state is
2448
 
            # assumed to have successfully run all checkers during
2449
 
            # downtime.
2450
 
            if client["enabled"]:
2451
 
                if datetime.datetime.utcnow() >= client["expires"]:
2452
 
                    if not client["last_checked_ok"]:
2453
 
                        logger.warning(
2454
 
                            "disabling client {0} - Client never "
2455
 
                            "performed a successful checker"
2456
 
                            .format(client_name))
2457
 
                        client["enabled"] = False
2458
 
                    elif client["last_checker_status"] != 0:
2459
 
                        logger.warning(
2460
 
                            "disabling client {0} - Client "
2461
 
                            "last checker failed with error code {1}"
2462
 
                            .format(client_name,
2463
 
                                    client["last_checker_status"]))
2464
 
                        client["enabled"] = False
2465
 
                    else:
2466
 
                        client["expires"] = (datetime.datetime
2467
 
                                             .utcnow()
2468
 
                                             + client["timeout"])
2469
 
                        logger.debug("Last checker succeeded,"
2470
 
                                     " keeping {0} enabled"
2471
 
                                     .format(client_name))
 
2039
        client_class = functools.partial(ClientDBusTransitional,
 
2040
                                         bus = bus)
 
2041
    def client_config_items(config, section):
 
2042
        special_settings = {
 
2043
            "approved_by_default":
 
2044
                lambda: config.getboolean(section,
 
2045
                                          "approved_by_default"),
 
2046
            }
 
2047
        for name, value in config.items(section):
2472
2048
            try:
2473
 
                client["secret"] = (
2474
 
                    pgp.decrypt(client["encrypted_secret"],
2475
 
                                client_settings[client_name]
2476
 
                                ["secret"]))
2477
 
            except PGPError:
2478
 
                # If decryption fails, we use secret from new settings
2479
 
                logger.debug("Failed to decrypt {0} old secret"
2480
 
                             .format(client_name))
2481
 
                client["secret"] = (
2482
 
                    client_settings[client_name]["secret"])
2483
 
    
2484
 
    # Add/remove clients based on new changes made to config
2485
 
    for client_name in (set(old_client_settings)
2486
 
                        - set(client_settings)):
2487
 
        del clients_data[client_name]
2488
 
    for client_name in (set(client_settings)
2489
 
                        - set(old_client_settings)):
2490
 
        clients_data[client_name] = client_settings[client_name]
2491
 
    
2492
 
    # Create all client objects
2493
 
    for client_name, client in clients_data.iteritems():
2494
 
        tcp_server.clients[client_name] = client_class(
2495
 
            name = client_name, settings = client)
2496
 
    
 
2049
                yield (name, special_settings[name]())
 
2050
            except KeyError:
 
2051
                yield (name, value)
 
2052
    
 
2053
    tcp_server.clients.update(set(
 
2054
            client_class(name = section,
 
2055
                         config= dict(client_config_items(
 
2056
                        client_config, section)))
 
2057
            for section in client_config.sections()))
2497
2058
    if not tcp_server.clients:
2498
2059
        logger.warning("No clients defined")
2499
 
    
 
2060
        
2500
2061
    if not debug:
2501
2062
        try:
2502
2063
            with pidfile:
2510
2071
            # "pidfile" was never created
2511
2072
            pass
2512
2073
        del pidfilename
 
2074
        
 
2075
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2513
2076
    
2514
2077
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2515
2078
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2516
2079
    
2517
2080
    if use_dbus:
2518
 
        @alternate_dbus_interfaces({"se.recompile.Mandos":
2519
 
                                        "se.bsnet.fukt.Mandos"})
2520
 
        class MandosDBusService(DBusObjectWithProperties):
 
2081
        class MandosDBusService(dbus.service.Object):
2521
2082
            """A D-Bus proxy object"""
2522
2083
            def __init__(self):
2523
2084
                dbus.service.Object.__init__(self, bus, "/")
2524
2085
            _interface = "se.recompile.Mandos"
2525
2086
            
2526
 
            @dbus_interface_annotations(_interface)
2527
 
            def _foo(self):
2528
 
                return { "org.freedesktop.DBus.Property"
2529
 
                         ".EmitsChangedSignal":
2530
 
                             "false"}
2531
 
            
2532
2087
            @dbus.service.signal(_interface, signature="o")
2533
2088
            def ClientAdded(self, objpath):
2534
2089
                "D-Bus signal"
2548
2103
            def GetAllClients(self):
2549
2104
                "D-Bus method"
2550
2105
                return dbus.Array(c.dbus_object_path
2551
 
                                  for c in
2552
 
                                  tcp_server.clients.itervalues())
 
2106
                                  for c in tcp_server.clients)
2553
2107
            
2554
2108
            @dbus.service.method(_interface,
2555
2109
                                 out_signature="a{oa{sv}}")
2557
2111
                "D-Bus method"
2558
2112
                return dbus.Dictionary(
2559
2113
                    ((c.dbus_object_path, c.GetAll(""))
2560
 
                     for c in tcp_server.clients.itervalues()),
 
2114
                     for c in tcp_server.clients),
2561
2115
                    signature="oa{sv}")
2562
2116
            
2563
2117
            @dbus.service.method(_interface, in_signature="o")
2564
2118
            def RemoveClient(self, object_path):
2565
2119
                "D-Bus method"
2566
 
                for c in tcp_server.clients.itervalues():
 
2120
                for c in tcp_server.clients:
2567
2121
                    if c.dbus_object_path == object_path:
2568
 
                        del tcp_server.clients[c.name]
 
2122
                        tcp_server.clients.remove(c)
2569
2123
                        c.remove_from_connection()
2570
2124
                        # Don't signal anything except ClientRemoved
2571
2125
                        c.disable(quiet=True)
2576
2130
            
2577
2131
            del _interface
2578
2132
        
2579
 
        mandos_dbus_service = MandosDBusService()
 
2133
        class MandosDBusServiceTransitional(MandosDBusService):
 
2134
            __metaclass__ = AlternateDBusNamesMetaclass
 
2135
        mandos_dbus_service = MandosDBusServiceTransitional()
2580
2136
    
2581
2137
    def cleanup():
2582
2138
        "Cleanup function; run on exit"
2583
2139
        service.cleanup()
2584
2140
        
2585
2141
        multiprocessing.active_children()
2586
 
        if not (tcp_server.clients or client_settings):
2587
 
            return
2588
 
        
2589
 
        # Store client before exiting. Secrets are encrypted with key
2590
 
        # based on what config file has. If config file is
2591
 
        # removed/edited, old secret will thus be unrecovable.
2592
 
        clients = {}
2593
 
        with PGPEngine() as pgp:
2594
 
            for client in tcp_server.clients.itervalues():
2595
 
                key = client_settings[client.name]["secret"]
2596
 
                client.encrypted_secret = pgp.encrypt(client.secret,
2597
 
                                                      key)
2598
 
                client_dict = {}
2599
 
                
2600
 
                # A list of attributes that can not be pickled
2601
 
                # + secret.
2602
 
                exclude = set(("bus", "changedstate", "secret",
2603
 
                               "checker"))
2604
 
                for name, typ in (inspect.getmembers
2605
 
                                  (dbus.service.Object)):
2606
 
                    exclude.add(name)
2607
 
                
2608
 
                client_dict["encrypted_secret"] = (client
2609
 
                                                   .encrypted_secret)
2610
 
                for attr in client.client_structure:
2611
 
                    if attr not in exclude:
2612
 
                        client_dict[attr] = getattr(client, attr)
2613
 
                
2614
 
                clients[client.name] = client_dict
2615
 
                del client_settings[client.name]["secret"]
2616
 
        
2617
 
        try:
2618
 
            with (tempfile.NamedTemporaryFile
2619
 
                  (mode='wb', suffix=".pickle", prefix='clients-',
2620
 
                   dir=os.path.dirname(stored_state_path),
2621
 
                   delete=False)) as stored_state:
2622
 
                pickle.dump((clients, client_settings), stored_state)
2623
 
                tempname=stored_state.name
2624
 
            os.rename(tempname, stored_state_path)
2625
 
        except (IOError, OSError) as e:
2626
 
            if not debug:
2627
 
                try:
2628
 
                    os.remove(tempname)
2629
 
                except NameError:
2630
 
                    pass
2631
 
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2632
 
                logger.warning("Could not save persistent state: {0}"
2633
 
                               .format(os.strerror(e.errno)))
2634
 
            else:
2635
 
                logger.warning("Could not save persistent state:",
2636
 
                               exc_info=e)
2637
 
                raise e
2638
 
        
2639
 
        # Delete all clients, and settings from config
2640
2142
        while tcp_server.clients:
2641
 
            name, client = tcp_server.clients.popitem()
 
2143
            client = tcp_server.clients.pop()
2642
2144
            if use_dbus:
2643
2145
                client.remove_from_connection()
 
2146
            client.disable_hook = None
2644
2147
            # Don't signal anything except ClientRemoved
2645
2148
            client.disable(quiet=True)
2646
2149
            if use_dbus:
2648
2151
                mandos_dbus_service.ClientRemoved(client
2649
2152
                                                  .dbus_object_path,
2650
2153
                                                  client.name)
2651
 
        client_settings.clear()
2652
2154
    
2653
2155
    atexit.register(cleanup)
2654
2156
    
2655
 
    for client in tcp_server.clients.itervalues():
 
2157
    for client in tcp_server.clients:
2656
2158
        if use_dbus:
2657
2159
            # Emit D-Bus signal
2658
2160
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
2659
 
        # Need to initiate checking of clients
2660
 
        if client.enabled:
2661
 
            client.init_checker()
 
2161
        client.enable()
2662
2162
    
2663
2163
    tcp_server.enable()
2664
2164
    tcp_server.server_activate()
2667
2167
    service.port = tcp_server.socket.getsockname()[1]
2668
2168
    if use_ipv6:
2669
2169
        logger.info("Now listening on address %r, port %d,"
2670
 
                    " flowinfo %d, scope_id %d",
2671
 
                    *tcp_server.socket.getsockname())
 
2170
                    " flowinfo %d, scope_id %d"
 
2171
                    % tcp_server.socket.getsockname())
2672
2172
    else:                       # IPv4
2673
 
        logger.info("Now listening on address %r, port %d",
2674
 
                    *tcp_server.socket.getsockname())
 
2173
        logger.info("Now listening on address %r, port %d"
 
2174
                    % tcp_server.socket.getsockname())
2675
2175
    
2676
2176
    #service.interface = tcp_server.socket.getsockname()[3]
2677
2177
    
2680
2180
        try:
2681
2181
            service.activate()
2682
2182
        except dbus.exceptions.DBusException as error:
2683
 
            logger.critical("D-Bus Exception", exc_info=error)
 
2183
            logger.critical("DBusException: %s", error)
2684
2184
            cleanup()
2685
2185
            sys.exit(1)
2686
2186
        # End of Avahi example code
2693
2193
        logger.debug("Starting main loop")
2694
2194
        main_loop.run()
2695
2195
    except AvahiError as error:
2696
 
        logger.critical("Avahi Error", exc_info=error)
 
2196
        logger.critical("AvahiError: %s", error)
2697
2197
        cleanup()
2698
2198
        sys.exit(1)
2699
2199
    except KeyboardInterrupt:
2704
2204
    # Must run before the D-Bus bus name gets deregistered
2705
2205
    cleanup()
2706
2206
 
 
2207
 
2707
2208
if __name__ == '__main__':
2708
2209
    main()