/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

* clients.conf ([DEFAULT]/timeout): Changed default value to "5m".
  ([DEFAULT]/interval): Changed default value to "2m".
  ([DEFAULT]/extenden_timeout): New.
  ([bar]/interval): Changed to "1m".

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
28
28
# along with this program.  If not, see
29
29
# <http://www.gnu.org/licenses/>.
30
30
31
 
# Contact the authors at <mandos@recompile.se>.
 
31
# Contact the authors at <mandos@fukt.bsnet.se>.
32
32
33
33
 
34
34
from __future__ import (division, absolute_import, print_function,
62
62
import functools
63
63
import cPickle as pickle
64
64
import multiprocessing
65
 
import types
66
 
import binascii
67
 
import tempfile
68
 
import itertools
69
65
 
70
66
import dbus
71
67
import dbus.service
76
72
import ctypes.util
77
73
import xml.dom.minidom
78
74
import inspect
79
 
import GnuPGInterface
80
75
 
81
76
try:
82
77
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
86
81
    except ImportError:
87
82
        SO_BINDTODEVICE = None
88
83
 
89
 
version = "1.5.3"
90
 
stored_state_file = "clients.pickle"
91
 
 
92
 
logger = logging.getLogger()
 
84
 
 
85
version = "1.3.1"
 
86
 
 
87
#logger = logging.getLogger('mandos')
 
88
logger = logging.Logger('mandos')
93
89
syslogger = (logging.handlers.SysLogHandler
94
90
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
95
91
              address = str("/dev/log")))
96
 
 
97
 
try:
98
 
    if_nametoindex = (ctypes.cdll.LoadLibrary
99
 
                      (ctypes.util.find_library("c"))
100
 
                      .if_nametoindex)
101
 
except (OSError, AttributeError):
102
 
    def if_nametoindex(interface):
103
 
        "Get an interface index the hard way, i.e. using fcntl()"
104
 
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
105
 
        with contextlib.closing(socket.socket()) as s:
106
 
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
107
 
                                struct.pack(str("16s16x"),
108
 
                                            interface))
109
 
        interface_index = struct.unpack(str("I"),
110
 
                                        ifreq[16:20])[0]
111
 
        return interface_index
112
 
 
113
 
 
114
 
def initlogger(debug, level=logging.WARNING):
115
 
    """init logger and add loglevel"""
116
 
    
117
 
    syslogger.setFormatter(logging.Formatter
118
 
                           ('Mandos [%(process)d]: %(levelname)s:'
119
 
                            ' %(message)s'))
120
 
    logger.addHandler(syslogger)
121
 
    
122
 
    if debug:
123
 
        console = logging.StreamHandler()
124
 
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
125
 
                                               ' [%(process)d]:'
126
 
                                               ' %(levelname)s:'
127
 
                                               ' %(message)s'))
128
 
        logger.addHandler(console)
129
 
    logger.setLevel(level)
130
 
 
131
 
 
132
 
class PGPError(Exception):
133
 
    """Exception if encryption/decryption fails"""
134
 
    pass
135
 
 
136
 
 
137
 
class PGPEngine(object):
138
 
    """A simple class for OpenPGP symmetric encryption & decryption"""
139
 
    def __init__(self):
140
 
        self.gnupg = GnuPGInterface.GnuPG()
141
 
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
142
 
        self.gnupg = GnuPGInterface.GnuPG()
143
 
        self.gnupg.options.meta_interactive = False
144
 
        self.gnupg.options.homedir = self.tempdir
145
 
        self.gnupg.options.extra_args.extend(['--force-mdc',
146
 
                                              '--quiet',
147
 
                                              '--no-use-agent'])
148
 
    
149
 
    def __enter__(self):
150
 
        return self
151
 
    
152
 
    def __exit__ (self, exc_type, exc_value, traceback):
153
 
        self._cleanup()
154
 
        return False
155
 
    
156
 
    def __del__(self):
157
 
        self._cleanup()
158
 
    
159
 
    def _cleanup(self):
160
 
        if self.tempdir is not None:
161
 
            # Delete contents of tempdir
162
 
            for root, dirs, files in os.walk(self.tempdir,
163
 
                                             topdown = False):
164
 
                for filename in files:
165
 
                    os.remove(os.path.join(root, filename))
166
 
                for dirname in dirs:
167
 
                    os.rmdir(os.path.join(root, dirname))
168
 
            # Remove tempdir
169
 
            os.rmdir(self.tempdir)
170
 
            self.tempdir = None
171
 
    
172
 
    def password_encode(self, password):
173
 
        # Passphrase can not be empty and can not contain newlines or
174
 
        # NUL bytes.  So we prefix it and hex encode it.
175
 
        return b"mandos" + binascii.hexlify(password)
176
 
    
177
 
    def encrypt(self, data, password):
178
 
        self.gnupg.passphrase = self.password_encode(password)
179
 
        with open(os.devnull, "w") as devnull:
180
 
            try:
181
 
                proc = self.gnupg.run(['--symmetric'],
182
 
                                      create_fhs=['stdin', 'stdout'],
183
 
                                      attach_fhs={'stderr': devnull})
184
 
                with contextlib.closing(proc.handles['stdin']) as f:
185
 
                    f.write(data)
186
 
                with contextlib.closing(proc.handles['stdout']) as f:
187
 
                    ciphertext = f.read()
188
 
                proc.wait()
189
 
            except IOError as e:
190
 
                raise PGPError(e)
191
 
        self.gnupg.passphrase = None
192
 
        return ciphertext
193
 
    
194
 
    def decrypt(self, data, password):
195
 
        self.gnupg.passphrase = self.password_encode(password)
196
 
        with open(os.devnull, "w") as devnull:
197
 
            try:
198
 
                proc = self.gnupg.run(['--decrypt'],
199
 
                                      create_fhs=['stdin', 'stdout'],
200
 
                                      attach_fhs={'stderr': devnull})
201
 
                with contextlib.closing(proc.handles['stdin']) as f:
202
 
                    f.write(data)
203
 
                with contextlib.closing(proc.handles['stdout']) as f:
204
 
                    decrypted_plaintext = f.read()
205
 
                proc.wait()
206
 
            except IOError as e:
207
 
                raise PGPError(e)
208
 
        self.gnupg.passphrase = None
209
 
        return decrypted_plaintext
210
 
 
211
 
 
 
92
syslogger.setFormatter(logging.Formatter
 
93
                       ('Mandos [%(process)d]: %(levelname)s:'
 
94
                        ' %(message)s'))
 
95
logger.addHandler(syslogger)
 
96
 
 
97
console = logging.StreamHandler()
 
98
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
 
99
                                       ' %(levelname)s:'
 
100
                                       ' %(message)s'))
 
101
logger.addHandler(console)
212
102
 
213
103
class AvahiError(Exception):
214
104
    def __init__(self, value, *args, **kwargs):
269
159
                            " after %i retries, exiting.",
270
160
                            self.rename_count)
271
161
            raise AvahiServiceError("Too many renames")
272
 
        self.name = unicode(self.server
273
 
                            .GetAlternativeServiceName(self.name))
 
162
        self.name = unicode(self.server.GetAlternativeServiceName(self.name))
274
163
        logger.info("Changing Zeroconf service name to %r ...",
275
164
                    self.name)
 
165
        syslogger.setFormatter(logging.Formatter
 
166
                               ('Mandos (%s) [%%(process)d]:'
 
167
                                ' %%(levelname)s: %%(message)s'
 
168
                                % self.name))
276
169
        self.remove()
277
170
        try:
278
171
            self.add()
298
191
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
299
192
        self.entry_group_state_changed_match = (
300
193
            self.group.connect_to_signal(
301
 
                'StateChanged', self.entry_group_state_changed))
 
194
                'StateChanged', self .entry_group_state_changed))
302
195
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
303
196
                     self.name, self.type)
304
197
        self.group.AddService(
330
223
            try:
331
224
                self.group.Free()
332
225
            except (dbus.exceptions.UnknownMethodException,
333
 
                    dbus.exceptions.DBusException):
 
226
                    dbus.exceptions.DBusException) as e:
334
227
                pass
335
228
            self.group = None
336
229
        self.remove()
370
263
                                 self.server_state_changed)
371
264
        self.server_state_changed(self.server.GetState())
372
265
 
373
 
class AvahiServiceToSyslog(AvahiService):
374
 
    def rename(self):
375
 
        """Add the new name to the syslog messages"""
376
 
        ret = AvahiService.rename(self)
377
 
        syslogger.setFormatter(logging.Formatter
378
 
                               ('Mandos (%s) [%%(process)d]:'
379
 
                                ' %%(levelname)s: %%(message)s'
380
 
                                % self.name))
381
 
        return ret
382
266
 
383
 
def timedelta_to_milliseconds(td):
384
 
    "Convert a datetime.timedelta() to milliseconds"
385
 
    return ((td.days * 24 * 60 * 60 * 1000)
386
 
            + (td.seconds * 1000)
387
 
            + (td.microseconds // 1000))
388
 
        
389
267
class Client(object):
390
268
    """A representation of a client host served by this server.
391
269
    
392
270
    Attributes:
393
 
    approved:   bool(); 'None' if not yet approved/disapproved
 
271
    _approved:   bool(); 'None' if not yet approved/disapproved
394
272
    approval_delay: datetime.timedelta(); Time to wait for approval
395
273
    approval_duration: datetime.timedelta(); Duration of one approval
396
274
    checker:    subprocess.Popen(); a running checker process used
403
281
                     instance %(name)s can be used in the command.
404
282
    checker_initiator_tag: a gobject event source tag, or None
405
283
    created:    datetime.datetime(); (UTC) object creation
406
 
    client_structure: Object describing what attributes a client has
407
 
                      and is used for storing the client at exit
408
284
    current_checker_command: string; current running checker_command
 
285
    disable_hook:  If set, called by disable() as disable_hook(self)
409
286
    disable_initiator_tag: a gobject event source tag, or None
410
287
    enabled:    bool()
411
288
    fingerprint: string (40 or 32 hexadecimal digits); used to
414
291
    interval:   datetime.timedelta(); How often to start a new checker
415
292
    last_approval_request: datetime.datetime(); (UTC) or None
416
293
    last_checked_ok: datetime.datetime(); (UTC) or None
417
 
    last_checker_status: integer between 0 and 255 reflecting exit
418
 
                         status of last checker. -1 reflects crashed
419
 
                         checker, -2 means no checker completed yet.
420
 
    last_enabled: datetime.datetime(); (UTC) or None
 
294
    last_enabled: datetime.datetime(); (UTC)
421
295
    name:       string; from the config file, used in log messages and
422
296
                        D-Bus identifiers
423
297
    secret:     bytestring; sent verbatim (over TLS) to client
424
298
    timeout:    datetime.timedelta(); How long from last_checked_ok
425
299
                                      until this client is disabled
426
 
    extended_timeout:   extra long timeout when secret has been sent
 
300
    extended_timeout:   extra long timeout when password has been sent
427
301
    runtime_expansions: Allowed attributes for runtime expansion.
428
302
    expires:    datetime.datetime(); time (UTC) when a client will be
429
303
                disabled, or None
433
307
                          "created", "enabled", "fingerprint",
434
308
                          "host", "interval", "last_checked_ok",
435
309
                          "last_enabled", "name", "timeout")
436
 
    client_defaults = { "timeout": "5m",
437
 
                        "extended_timeout": "15m",
438
 
                        "interval": "2m",
439
 
                        "checker": "fping -q -- %%(host)s",
440
 
                        "host": "",
441
 
                        "approval_delay": "0s",
442
 
                        "approval_duration": "1s",
443
 
                        "approved_by_default": "True",
444
 
                        "enabled": "True",
445
 
                        }
 
310
    
 
311
    @staticmethod
 
312
    def _timedelta_to_milliseconds(td):
 
313
        "Convert a datetime.timedelta() to milliseconds"
 
314
        return ((td.days * 24 * 60 * 60 * 1000)
 
315
                + (td.seconds * 1000)
 
316
                + (td.microseconds // 1000))
446
317
    
447
318
    def timeout_milliseconds(self):
448
319
        "Return the 'timeout' attribute in milliseconds"
449
 
        return timedelta_to_milliseconds(self.timeout)
450
 
    
 
320
        return self._timedelta_to_milliseconds(self.timeout)
 
321
 
451
322
    def extended_timeout_milliseconds(self):
452
323
        "Return the 'extended_timeout' attribute in milliseconds"
453
 
        return timedelta_to_milliseconds(self.extended_timeout)
 
324
        return self._timedelta_to_milliseconds(self.extended_timeout)    
454
325
    
455
326
    def interval_milliseconds(self):
456
327
        "Return the 'interval' attribute in milliseconds"
457
 
        return timedelta_to_milliseconds(self.interval)
458
 
    
 
328
        return self._timedelta_to_milliseconds(self.interval)
 
329
 
459
330
    def approval_delay_milliseconds(self):
460
 
        return timedelta_to_milliseconds(self.approval_delay)
461
 
 
462
 
    @staticmethod
463
 
    def config_parser(config):
464
 
        """Construct a new dict of client settings of this form:
465
 
        { client_name: {setting_name: value, ...}, ...}
466
 
        with exceptions for any special settings as defined above.
467
 
        NOTE: Must be a pure function. Must return the same result
468
 
        value given the same arguments.
469
 
        """
470
 
        settings = {}
471
 
        for client_name in config.sections():
472
 
            section = dict(config.items(client_name))
473
 
            client = settings[client_name] = {}
474
 
            
475
 
            client["host"] = section["host"]
476
 
            # Reformat values from string types to Python types
477
 
            client["approved_by_default"] = config.getboolean(
478
 
                client_name, "approved_by_default")
479
 
            client["enabled"] = config.getboolean(client_name,
480
 
                                                  "enabled")
481
 
            
482
 
            client["fingerprint"] = (section["fingerprint"].upper()
483
 
                                     .replace(" ", ""))
484
 
            if "secret" in section:
485
 
                client["secret"] = section["secret"].decode("base64")
486
 
            elif "secfile" in section:
487
 
                with open(os.path.expanduser(os.path.expandvars
488
 
                                             (section["secfile"])),
489
 
                          "rb") as secfile:
490
 
                    client["secret"] = secfile.read()
491
 
            else:
492
 
                raise TypeError("No secret or secfile for section %s"
493
 
                                % section)
494
 
            client["timeout"] = string_to_delta(section["timeout"])
495
 
            client["extended_timeout"] = string_to_delta(
496
 
                section["extended_timeout"])
497
 
            client["interval"] = string_to_delta(section["interval"])
498
 
            client["approval_delay"] = string_to_delta(
499
 
                section["approval_delay"])
500
 
            client["approval_duration"] = string_to_delta(
501
 
                section["approval_duration"])
502
 
            client["checker_command"] = section["checker"]
503
 
            client["last_approval_request"] = None
504
 
            client["last_checked_ok"] = None
505
 
            client["last_checker_status"] = -2
506
 
        
507
 
        return settings
508
 
        
509
 
        
510
 
    def __init__(self, settings, name = None):
 
331
        return self._timedelta_to_milliseconds(self.approval_delay)
 
332
    
 
333
    def __init__(self, name = None, disable_hook=None, config=None):
511
334
        """Note: the 'checker' key in 'config' sets the
512
335
        'checker_command' attribute and *not* the 'checker'
513
336
        attribute."""
514
337
        self.name = name
515
 
        # adding all client settings
516
 
        for setting, value in settings.iteritems():
517
 
            setattr(self, setting, value)
518
 
        
519
 
        if self.enabled:
520
 
            if not hasattr(self, "last_enabled"):
521
 
                self.last_enabled = datetime.datetime.utcnow()
522
 
            if not hasattr(self, "expires"):
523
 
                self.expires = (datetime.datetime.utcnow()
524
 
                                + self.timeout)
525
 
        else:
526
 
            self.last_enabled = None
527
 
            self.expires = None
528
 
       
 
338
        if config is None:
 
339
            config = {}
529
340
        logger.debug("Creating client %r", self.name)
530
341
        # Uppercase and remove spaces from fingerprint for later
531
342
        # comparison purposes with return value from the fingerprint()
532
343
        # function
 
344
        self.fingerprint = (config["fingerprint"].upper()
 
345
                            .replace(" ", ""))
533
346
        logger.debug("  Fingerprint: %s", self.fingerprint)
534
 
        self.created = settings.get("created",
535
 
                                    datetime.datetime.utcnow())
536
 
 
537
 
        # attributes specific for this server instance
 
347
        if "secret" in config:
 
348
            self.secret = config["secret"].decode("base64")
 
349
        elif "secfile" in config:
 
350
            with open(os.path.expanduser(os.path.expandvars
 
351
                                         (config["secfile"])),
 
352
                      "rb") as secfile:
 
353
                self.secret = secfile.read()
 
354
        else:
 
355
            raise TypeError("No secret or secfile for client %s"
 
356
                            % self.name)
 
357
        self.host = config.get("host", "")
 
358
        self.created = datetime.datetime.utcnow()
 
359
        self.enabled = False
 
360
        self.last_approval_request = None
 
361
        self.last_enabled = None
 
362
        self.last_checked_ok = None
 
363
        self.timeout = string_to_delta(config["timeout"])
 
364
        self.extended_timeout = string_to_delta(config["extended_timeout"])
 
365
        self.interval = string_to_delta(config["interval"])
 
366
        self.disable_hook = disable_hook
538
367
        self.checker = None
539
368
        self.checker_initiator_tag = None
540
369
        self.disable_initiator_tag = None
 
370
        self.expires = None
541
371
        self.checker_callback_tag = None
 
372
        self.checker_command = config["checker"]
542
373
        self.current_checker_command = None
543
 
        self.approved = None
 
374
        self.last_connect = None
 
375
        self._approved = None
 
376
        self.approved_by_default = config.get("approved_by_default",
 
377
                                              True)
544
378
        self.approvals_pending = 0
545
 
        self.changedstate = (multiprocessing_manager
546
 
                             .Condition(multiprocessing_manager
547
 
                                        .Lock()))
548
 
        self.client_structure = [attr for attr in
549
 
                                 self.__dict__.iterkeys()
550
 
                                 if not attr.startswith("_")]
551
 
        self.client_structure.append("client_structure")
552
 
        
553
 
        for name, t in inspect.getmembers(type(self),
554
 
                                          lambda obj:
555
 
                                              isinstance(obj,
556
 
                                                         property)):
557
 
            if not name.startswith("_"):
558
 
                self.client_structure.append(name)
 
379
        self.approval_delay = string_to_delta(
 
380
            config["approval_delay"])
 
381
        self.approval_duration = string_to_delta(
 
382
            config["approval_duration"])
 
383
        self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
559
384
    
560
 
    # Send notice to process children that client state has changed
561
385
    def send_changedstate(self):
562
 
        with self.changedstate:
563
 
            self.changedstate.notify_all()
564
 
    
 
386
        self.changedstate.acquire()
 
387
        self.changedstate.notify_all()
 
388
        self.changedstate.release()
 
389
        
565
390
    def enable(self):
566
391
        """Start this client's checker and timeout hooks"""
567
392
        if getattr(self, "enabled", False):
568
393
            # Already enabled
569
394
            return
570
395
        self.send_changedstate()
 
396
        self.last_enabled = datetime.datetime.utcnow()
 
397
        # Schedule a new checker to be started an 'interval' from now,
 
398
        # and every interval from then on.
 
399
        self.checker_initiator_tag = (gobject.timeout_add
 
400
                                      (self.interval_milliseconds(),
 
401
                                       self.start_checker))
 
402
        # Schedule a disable() when 'timeout' has passed
571
403
        self.expires = datetime.datetime.utcnow() + self.timeout
 
404
        self.disable_initiator_tag = (gobject.timeout_add
 
405
                                   (self.timeout_milliseconds(),
 
406
                                    self.disable))
572
407
        self.enabled = True
573
 
        self.last_enabled = datetime.datetime.utcnow()
574
 
        self.init_checker()
 
408
        # Also start a new checker *right now*.
 
409
        self.start_checker()
575
410
    
576
411
    def disable(self, quiet=True):
577
412
        """Disable this client."""
589
424
            gobject.source_remove(self.checker_initiator_tag)
590
425
            self.checker_initiator_tag = None
591
426
        self.stop_checker()
 
427
        if self.disable_hook:
 
428
            self.disable_hook(self)
592
429
        self.enabled = False
593
430
        # Do not run this again if called by a gobject.timeout_add
594
431
        return False
595
432
    
596
433
    def __del__(self):
 
434
        self.disable_hook = None
597
435
        self.disable()
598
436
    
599
 
    def init_checker(self):
600
 
        # Schedule a new checker to be started an 'interval' from now,
601
 
        # and every interval from then on.
602
 
        self.checker_initiator_tag = (gobject.timeout_add
603
 
                                      (self.interval_milliseconds(),
604
 
                                       self.start_checker))
605
 
        # Schedule a disable() when 'timeout' has passed
606
 
        self.disable_initiator_tag = (gobject.timeout_add
607
 
                                   (self.timeout_milliseconds(),
608
 
                                    self.disable))
609
 
        # Also start a new checker *right now*.
610
 
        self.start_checker()
611
 
    
612
437
    def checker_callback(self, pid, condition, command):
613
438
        """The checker has completed, so take appropriate actions."""
614
439
        self.checker_callback_tag = None
615
440
        self.checker = None
616
441
        if os.WIFEXITED(condition):
617
 
            self.last_checker_status = os.WEXITSTATUS(condition)
618
 
            if self.last_checker_status == 0:
 
442
            exitstatus = os.WEXITSTATUS(condition)
 
443
            if exitstatus == 0:
619
444
                logger.info("Checker for %(name)s succeeded",
620
445
                            vars(self))
621
446
                self.checked_ok()
623
448
                logger.info("Checker for %(name)s failed",
624
449
                            vars(self))
625
450
        else:
626
 
            self.last_checker_status = -1
627
451
            logger.warning("Checker for %(name)s crashed?",
628
452
                           vars(self))
629
453
    
630
 
    def checked_ok(self):
631
 
        """Assert that the client has been seen, alive and well."""
632
 
        self.last_checked_ok = datetime.datetime.utcnow()
633
 
        self.last_checker_status = 0
634
 
        self.bump_timeout()
635
 
    
636
 
    def bump_timeout(self, timeout=None):
637
 
        """Bump up the timeout for this client."""
 
454
    def checked_ok(self, timeout=None):
 
455
        """Bump up the timeout for this client.
 
456
        
 
457
        This should only be called when the client has been seen,
 
458
        alive and well.
 
459
        """
638
460
        if timeout is None:
639
461
            timeout = self.timeout
640
 
        if self.disable_initiator_tag is not None:
641
 
            gobject.source_remove(self.disable_initiator_tag)
642
 
        if getattr(self, "enabled", False):
643
 
            self.disable_initiator_tag = (gobject.timeout_add
644
 
                                          (timedelta_to_milliseconds
645
 
                                           (timeout), self.disable))
646
 
            self.expires = datetime.datetime.utcnow() + timeout
 
462
        self.last_checked_ok = datetime.datetime.utcnow()
 
463
        gobject.source_remove(self.disable_initiator_tag)
 
464
        self.expires = datetime.datetime.utcnow() + timeout
 
465
        self.disable_initiator_tag = (gobject.timeout_add
 
466
                                      (self._timedelta_to_milliseconds(timeout),
 
467
                                       self.disable))
647
468
    
648
469
    def need_approval(self):
649
470
        self.last_approval_request = datetime.datetime.utcnow()
689
510
                                       'replace')))
690
511
                    for attr in
691
512
                    self.runtime_expansions)
692
 
                
 
513
 
693
514
                try:
694
515
                    command = self.checker_command % escaped_attrs
695
516
                except TypeError as error:
741
562
                raise
742
563
        self.checker = None
743
564
 
744
 
 
745
565
def dbus_service_property(dbus_interface, signature="v",
746
566
                          access="readwrite", byte_arrays=False):
747
567
    """Decorators for marking methods of a DBusObjectWithProperties to
772
592
    return decorator
773
593
 
774
594
 
775
 
def dbus_interface_annotations(dbus_interface):
776
 
    """Decorator for marking functions returning interface annotations.
777
 
    
778
 
    Usage:
779
 
    
780
 
    @dbus_interface_annotations("org.example.Interface")
781
 
    def _foo(self):  # Function name does not matter
782
 
        return {"org.freedesktop.DBus.Deprecated": "true",
783
 
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
784
 
                    "false"}
785
 
    """
786
 
    def decorator(func):
787
 
        func._dbus_is_interface = True
788
 
        func._dbus_interface = dbus_interface
789
 
        func._dbus_name = dbus_interface
790
 
        return func
791
 
    return decorator
792
 
 
793
 
 
794
 
def dbus_annotations(annotations):
795
 
    """Decorator to annotate D-Bus methods, signals or properties
796
 
    Usage:
797
 
    
798
 
    @dbus_service_property("org.example.Interface", signature="b",
799
 
                           access="r")
800
 
    @dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
801
 
                        "org.freedesktop.DBus.Property."
802
 
                        "EmitsChangedSignal": "false"})
803
 
    def Property_dbus_property(self):
804
 
        return dbus.Boolean(False)
805
 
    """
806
 
    def decorator(func):
807
 
        func._dbus_annotations = annotations
808
 
        return func
809
 
    return decorator
810
 
 
811
 
 
812
595
class DBusPropertyException(dbus.exceptions.DBusException):
813
596
    """A base class for D-Bus property-related exceptions
814
597
    """
830
613
 
831
614
class DBusObjectWithProperties(dbus.service.Object):
832
615
    """A D-Bus object with properties.
833
 
    
 
616
 
834
617
    Classes inheriting from this can use the dbus_service_property
835
618
    decorator to expose methods as D-Bus properties.  It exposes the
836
619
    standard Get(), Set(), and GetAll() methods on the D-Bus.
837
620
    """
838
621
    
839
622
    @staticmethod
840
 
    def _is_dbus_thing(thing):
841
 
        """Returns a function testing if an attribute is a D-Bus thing
842
 
        
843
 
        If called like _is_dbus_thing("method") it returns a function
844
 
        suitable for use as predicate to inspect.getmembers().
845
 
        """
846
 
        return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
847
 
                                   False)
 
623
    def _is_dbus_property(obj):
 
624
        return getattr(obj, "_dbus_is_property", False)
848
625
    
849
 
    def _get_all_dbus_things(self, thing):
 
626
    def _get_all_dbus_properties(self):
850
627
        """Returns a generator of (name, attribute) pairs
851
628
        """
852
 
        return ((getattr(athing.__get__(self), "_dbus_name",
853
 
                         name),
854
 
                 athing.__get__(self))
855
 
                for cls in self.__class__.__mro__
856
 
                for name, athing in
857
 
                inspect.getmembers(cls,
858
 
                                   self._is_dbus_thing(thing)))
 
629
        return ((prop._dbus_name, prop)
 
630
                for name, prop in
 
631
                inspect.getmembers(self, self._is_dbus_property))
859
632
    
860
633
    def _get_dbus_property(self, interface_name, property_name):
861
634
        """Returns a bound method if one exists which is a D-Bus
862
635
        property with the specified name and interface.
863
636
        """
864
 
        for cls in  self.__class__.__mro__:
865
 
            for name, value in (inspect.getmembers
866
 
                                (cls,
867
 
                                 self._is_dbus_thing("property"))):
868
 
                if (value._dbus_name == property_name
869
 
                    and value._dbus_interface == interface_name):
870
 
                    return value.__get__(self)
871
 
        
 
637
        for name in (property_name,
 
638
                     property_name + "_dbus_property"):
 
639
            prop = getattr(self, name, None)
 
640
            if (prop is None
 
641
                or not self._is_dbus_property(prop)
 
642
                or prop._dbus_name != property_name
 
643
                or (interface_name and prop._dbus_interface
 
644
                    and interface_name != prop._dbus_interface)):
 
645
                continue
 
646
            return prop
872
647
        # No such property
873
648
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
874
649
                                   + interface_name + "."
899
674
            # signatures other than "ay".
900
675
            if prop._dbus_signature != "ay":
901
676
                raise ValueError
902
 
            value = dbus.ByteArray(b''.join(chr(byte)
903
 
                                            for byte in value))
 
677
            value = dbus.ByteArray(''.join(unichr(byte)
 
678
                                           for byte in value))
904
679
        prop(value)
905
680
    
906
681
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
908
683
    def GetAll(self, interface_name):
909
684
        """Standard D-Bus property GetAll() method, see D-Bus
910
685
        standard.
911
 
        
 
686
 
912
687
        Note: Will not include properties with access="write".
913
688
        """
914
 
        properties = {}
915
 
        for name, prop in self._get_all_dbus_things("property"):
 
689
        all = {}
 
690
        for name, prop in self._get_all_dbus_properties():
916
691
            if (interface_name
917
692
                and interface_name != prop._dbus_interface):
918
693
                # Interface non-empty but did not match
922
697
                continue
923
698
            value = prop()
924
699
            if not hasattr(value, "variant_level"):
925
 
                properties[name] = value
 
700
                all[name] = value
926
701
                continue
927
 
            properties[name] = type(value)(value, variant_level=
928
 
                                           value.variant_level+1)
929
 
        return dbus.Dictionary(properties, signature="sv")
 
702
            all[name] = type(value)(value, variant_level=
 
703
                                    value.variant_level+1)
 
704
        return dbus.Dictionary(all, signature="sv")
930
705
    
931
706
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
932
707
                         out_signature="s",
933
708
                         path_keyword='object_path',
934
709
                         connection_keyword='connection')
935
710
    def Introspect(self, object_path, connection):
936
 
        """Overloading of standard D-Bus method.
937
 
        
938
 
        Inserts property tags and interface annotation tags.
 
711
        """Standard D-Bus method, overloaded to insert property tags.
939
712
        """
940
713
        xmlstring = dbus.service.Object.Introspect(self, object_path,
941
714
                                                   connection)
948
721
                e.setAttribute("access", prop._dbus_access)
949
722
                return e
950
723
            for if_tag in document.getElementsByTagName("interface"):
951
 
                # Add property tags
952
724
                for tag in (make_tag(document, name, prop)
953
725
                            for name, prop
954
 
                            in self._get_all_dbus_things("property")
 
726
                            in self._get_all_dbus_properties()
955
727
                            if prop._dbus_interface
956
728
                            == if_tag.getAttribute("name")):
957
729
                    if_tag.appendChild(tag)
958
 
                # Add annotation tags
959
 
                for typ in ("method", "signal", "property"):
960
 
                    for tag in if_tag.getElementsByTagName(typ):
961
 
                        annots = dict()
962
 
                        for name, prop in (self.
963
 
                                           _get_all_dbus_things(typ)):
964
 
                            if (name == tag.getAttribute("name")
965
 
                                and prop._dbus_interface
966
 
                                == if_tag.getAttribute("name")):
967
 
                                annots.update(getattr
968
 
                                              (prop,
969
 
                                               "_dbus_annotations",
970
 
                                               {}))
971
 
                        for name, value in annots.iteritems():
972
 
                            ann_tag = document.createElement(
973
 
                                "annotation")
974
 
                            ann_tag.setAttribute("name", name)
975
 
                            ann_tag.setAttribute("value", value)
976
 
                            tag.appendChild(ann_tag)
977
 
                # Add interface annotation tags
978
 
                for annotation, value in dict(
979
 
                    itertools.chain(
980
 
                        *(annotations().iteritems()
981
 
                          for name, annotations in
982
 
                          self._get_all_dbus_things("interface")
983
 
                          if name == if_tag.getAttribute("name")
984
 
                          ))).iteritems():
985
 
                    ann_tag = document.createElement("annotation")
986
 
                    ann_tag.setAttribute("name", annotation)
987
 
                    ann_tag.setAttribute("value", value)
988
 
                    if_tag.appendChild(ann_tag)
989
730
                # Add the names to the return values for the
990
731
                # "org.freedesktop.DBus.Properties" methods
991
732
                if (if_tag.getAttribute("name")
1010
751
        return xmlstring
1011
752
 
1012
753
 
1013
 
def datetime_to_dbus (dt, variant_level=0):
1014
 
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1015
 
    if dt is None:
1016
 
        return dbus.String("", variant_level = variant_level)
1017
 
    return dbus.String(dt.isoformat(),
1018
 
                       variant_level=variant_level)
1019
 
 
1020
 
 
1021
 
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
1022
 
                                  .__metaclass__):
1023
 
    """Applied to an empty subclass of a D-Bus object, this metaclass
1024
 
    will add additional D-Bus attributes matching a certain pattern.
1025
 
    """
1026
 
    def __new__(mcs, name, bases, attr):
1027
 
        # Go through all the base classes which could have D-Bus
1028
 
        # methods, signals, or properties in them
1029
 
        old_interface_names = []
1030
 
        for base in (b for b in bases
1031
 
                     if issubclass(b, dbus.service.Object)):
1032
 
            # Go though all attributes of the base class
1033
 
            for attrname, attribute in inspect.getmembers(base):
1034
 
                # Ignore non-D-Bus attributes, and D-Bus attributes
1035
 
                # with the wrong interface name
1036
 
                if (not hasattr(attribute, "_dbus_interface")
1037
 
                    or not attribute._dbus_interface
1038
 
                    .startswith("se.recompile.Mandos")):
1039
 
                    continue
1040
 
                # Create an alternate D-Bus interface name based on
1041
 
                # the current name
1042
 
                alt_interface = (attribute._dbus_interface
1043
 
                                 .replace("se.recompile.Mandos",
1044
 
                                          "se.bsnet.fukt.Mandos"))
1045
 
                if alt_interface != attribute._dbus_interface:
1046
 
                    old_interface_names.append(alt_interface)
1047
 
                # Is this a D-Bus signal?
1048
 
                if getattr(attribute, "_dbus_is_signal", False):
1049
 
                    # Extract the original non-method function by
1050
 
                    # black magic
1051
 
                    nonmethod_func = (dict(
1052
 
                            zip(attribute.func_code.co_freevars,
1053
 
                                attribute.__closure__))["func"]
1054
 
                                      .cell_contents)
1055
 
                    # Create a new, but exactly alike, function
1056
 
                    # object, and decorate it to be a new D-Bus signal
1057
 
                    # with the alternate D-Bus interface name
1058
 
                    new_function = (dbus.service.signal
1059
 
                                    (alt_interface,
1060
 
                                     attribute._dbus_signature)
1061
 
                                    (types.FunctionType(
1062
 
                                nonmethod_func.func_code,
1063
 
                                nonmethod_func.func_globals,
1064
 
                                nonmethod_func.func_name,
1065
 
                                nonmethod_func.func_defaults,
1066
 
                                nonmethod_func.func_closure)))
1067
 
                    # Copy annotations, if any
1068
 
                    try:
1069
 
                        new_function._dbus_annotations = (
1070
 
                            dict(attribute._dbus_annotations))
1071
 
                    except AttributeError:
1072
 
                        pass
1073
 
                    # Define a creator of a function to call both the
1074
 
                    # old and new functions, so both the old and new
1075
 
                    # signals gets sent when the function is called
1076
 
                    def fixscope(func1, func2):
1077
 
                        """This function is a scope container to pass
1078
 
                        func1 and func2 to the "call_both" function
1079
 
                        outside of its arguments"""
1080
 
                        def call_both(*args, **kwargs):
1081
 
                            """This function will emit two D-Bus
1082
 
                            signals by calling func1 and func2"""
1083
 
                            func1(*args, **kwargs)
1084
 
                            func2(*args, **kwargs)
1085
 
                        return call_both
1086
 
                    # Create the "call_both" function and add it to
1087
 
                    # the class
1088
 
                    attr[attrname] = fixscope(attribute,
1089
 
                                              new_function)
1090
 
                # Is this a D-Bus method?
1091
 
                elif getattr(attribute, "_dbus_is_method", False):
1092
 
                    # Create a new, but exactly alike, function
1093
 
                    # object.  Decorate it to be a new D-Bus method
1094
 
                    # with the alternate D-Bus interface name.  Add it
1095
 
                    # to the class.
1096
 
                    attr[attrname] = (dbus.service.method
1097
 
                                      (alt_interface,
1098
 
                                       attribute._dbus_in_signature,
1099
 
                                       attribute._dbus_out_signature)
1100
 
                                      (types.FunctionType
1101
 
                                       (attribute.func_code,
1102
 
                                        attribute.func_globals,
1103
 
                                        attribute.func_name,
1104
 
                                        attribute.func_defaults,
1105
 
                                        attribute.func_closure)))
1106
 
                    # Copy annotations, if any
1107
 
                    try:
1108
 
                        attr[attrname]._dbus_annotations = (
1109
 
                            dict(attribute._dbus_annotations))
1110
 
                    except AttributeError:
1111
 
                        pass
1112
 
                # Is this a D-Bus property?
1113
 
                elif getattr(attribute, "_dbus_is_property", False):
1114
 
                    # Create a new, but exactly alike, function
1115
 
                    # object, and decorate it to be a new D-Bus
1116
 
                    # property with the alternate D-Bus interface
1117
 
                    # name.  Add it to the class.
1118
 
                    attr[attrname] = (dbus_service_property
1119
 
                                      (alt_interface,
1120
 
                                       attribute._dbus_signature,
1121
 
                                       attribute._dbus_access,
1122
 
                                       attribute
1123
 
                                       ._dbus_get_args_options
1124
 
                                       ["byte_arrays"])
1125
 
                                      (types.FunctionType
1126
 
                                       (attribute.func_code,
1127
 
                                        attribute.func_globals,
1128
 
                                        attribute.func_name,
1129
 
                                        attribute.func_defaults,
1130
 
                                        attribute.func_closure)))
1131
 
                    # Copy annotations, if any
1132
 
                    try:
1133
 
                        attr[attrname]._dbus_annotations = (
1134
 
                            dict(attribute._dbus_annotations))
1135
 
                    except AttributeError:
1136
 
                        pass
1137
 
                # Is this a D-Bus interface?
1138
 
                elif getattr(attribute, "_dbus_is_interface", False):
1139
 
                    # Create a new, but exactly alike, function
1140
 
                    # object.  Decorate it to be a new D-Bus interface
1141
 
                    # with the alternate D-Bus interface name.  Add it
1142
 
                    # to the class.
1143
 
                    attr[attrname] = (dbus_interface_annotations
1144
 
                                      (alt_interface)
1145
 
                                      (types.FunctionType
1146
 
                                       (attribute.func_code,
1147
 
                                        attribute.func_globals,
1148
 
                                        attribute.func_name,
1149
 
                                        attribute.func_defaults,
1150
 
                                        attribute.func_closure)))
1151
 
        # Deprecate all old interfaces
1152
 
        basename="_AlternateDBusNamesMetaclass_interface_annotation{0}"
1153
 
        for old_interface_name in old_interface_names:
1154
 
            @dbus_interface_annotations(old_interface_name)
1155
 
            def func(self):
1156
 
                return { "org.freedesktop.DBus.Deprecated": "true" }
1157
 
            # Find an unused name
1158
 
            for aname in (basename.format(i) for i in
1159
 
                          itertools.count()):
1160
 
                if aname not in attr:
1161
 
                    attr[aname] = func
1162
 
                    break
1163
 
        return type.__new__(mcs, name, bases, attr)
1164
 
 
1165
 
 
1166
754
class ClientDBus(Client, DBusObjectWithProperties):
1167
755
    """A Client class using D-Bus
1168
756
    
1177
765
    # dbus.service.Object doesn't use super(), so we can't either.
1178
766
    
1179
767
    def __init__(self, bus = None, *args, **kwargs):
 
768
        self._approvals_pending = 0
1180
769
        self.bus = bus
1181
770
        Client.__init__(self, *args, **kwargs)
1182
771
        # Only now, when this client is initialized, can it show up on
1188
777
                                 ("/clients/" + client_object_name))
1189
778
        DBusObjectWithProperties.__init__(self, self.bus,
1190
779
                                          self.dbus_object_path)
1191
 
        
1192
 
    def notifychangeproperty(transform_func,
1193
 
                             dbus_name, type_func=lambda x: x,
1194
 
                             variant_level=1):
1195
 
        """ Modify a variable so that it's a property which announces
1196
 
        its changes to DBus.
1197
 
        
1198
 
        transform_fun: Function that takes a value and a variant_level
1199
 
                       and transforms it to a D-Bus type.
1200
 
        dbus_name: D-Bus name of the variable
1201
 
        type_func: Function that transform the value before sending it
1202
 
                   to the D-Bus.  Default: no transform
1203
 
        variant_level: D-Bus variant level.  Default: 1
1204
 
        """
1205
 
        attrname = "_{0}".format(dbus_name)
1206
 
        def setter(self, value):
1207
 
            if hasattr(self, "dbus_object_path"):
1208
 
                if (not hasattr(self, attrname) or
1209
 
                    type_func(getattr(self, attrname, None))
1210
 
                    != type_func(value)):
1211
 
                    dbus_value = transform_func(type_func(value),
1212
 
                                                variant_level
1213
 
                                                =variant_level)
1214
 
                    self.PropertyChanged(dbus.String(dbus_name),
1215
 
                                         dbus_value)
1216
 
            setattr(self, attrname, value)
1217
 
        
1218
 
        return property(lambda self: getattr(self, attrname), setter)
1219
 
    
1220
 
    
1221
 
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1222
 
    approvals_pending = notifychangeproperty(dbus.Boolean,
1223
 
                                             "ApprovalPending",
1224
 
                                             type_func = bool)
1225
 
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1226
 
    last_enabled = notifychangeproperty(datetime_to_dbus,
1227
 
                                        "LastEnabled")
1228
 
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1229
 
                                   type_func = lambda checker:
1230
 
                                       checker is not None)
1231
 
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1232
 
                                           "LastCheckedOK")
1233
 
    last_checker_status = notifychangeproperty(dbus.Int16,
1234
 
                                               "LastCheckerStatus")
1235
 
    last_approval_request = notifychangeproperty(
1236
 
        datetime_to_dbus, "LastApprovalRequest")
1237
 
    approved_by_default = notifychangeproperty(dbus.Boolean,
1238
 
                                               "ApprovedByDefault")
1239
 
    approval_delay = notifychangeproperty(dbus.UInt64,
1240
 
                                          "ApprovalDelay",
1241
 
                                          type_func =
1242
 
                                          timedelta_to_milliseconds)
1243
 
    approval_duration = notifychangeproperty(
1244
 
        dbus.UInt64, "ApprovalDuration",
1245
 
        type_func = timedelta_to_milliseconds)
1246
 
    host = notifychangeproperty(dbus.String, "Host")
1247
 
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1248
 
                                   type_func =
1249
 
                                   timedelta_to_milliseconds)
1250
 
    extended_timeout = notifychangeproperty(
1251
 
        dbus.UInt64, "ExtendedTimeout",
1252
 
        type_func = timedelta_to_milliseconds)
1253
 
    interval = notifychangeproperty(dbus.UInt64,
1254
 
                                    "Interval",
1255
 
                                    type_func =
1256
 
                                    timedelta_to_milliseconds)
1257
 
    checker_command = notifychangeproperty(dbus.String, "Checker")
1258
 
    
1259
 
    del notifychangeproperty
 
780
    def _set_expires(self, value):
 
781
        old_value = getattr(self, "_expires", None)
 
782
        self._expires = value
 
783
        if hasattr(self, "dbus_object_path") and old_value != value:
 
784
            dbus_time = (self._datetime_to_dbus(self._expires,
 
785
                                                variant_level=1))
 
786
            self.PropertyChanged(dbus.String("Expires"),
 
787
                                 dbus_time)
 
788
    expires = property(lambda self: self._expires, _set_expires)
 
789
    del _set_expires
 
790
        
 
791
    def _get_approvals_pending(self):
 
792
        return self._approvals_pending
 
793
    def _set_approvals_pending(self, value):
 
794
        old_value = self._approvals_pending
 
795
        self._approvals_pending = value
 
796
        bval = bool(value)
 
797
        if (hasattr(self, "dbus_object_path")
 
798
            and bval is not bool(old_value)):
 
799
            dbus_bool = dbus.Boolean(bval, variant_level=1)
 
800
            self.PropertyChanged(dbus.String("ApprovalPending"),
 
801
                                 dbus_bool)
 
802
 
 
803
    approvals_pending = property(_get_approvals_pending,
 
804
                                 _set_approvals_pending)
 
805
    del _get_approvals_pending, _set_approvals_pending
 
806
    
 
807
    @staticmethod
 
808
    def _datetime_to_dbus(dt, variant_level=0):
 
809
        """Convert a UTC datetime.datetime() to a D-Bus type."""
 
810
        if dt is None:
 
811
            return dbus.String("", variant_level = variant_level)
 
812
        return dbus.String(dt.isoformat(),
 
813
                           variant_level=variant_level)
 
814
    
 
815
    def enable(self):
 
816
        oldstate = getattr(self, "enabled", False)
 
817
        r = Client.enable(self)
 
818
        if oldstate != self.enabled:
 
819
            # Emit D-Bus signals
 
820
            self.PropertyChanged(dbus.String("Enabled"),
 
821
                                 dbus.Boolean(True, variant_level=1))
 
822
            self.PropertyChanged(
 
823
                dbus.String("LastEnabled"),
 
824
                self._datetime_to_dbus(self.last_enabled,
 
825
                                       variant_level=1))
 
826
        return r
 
827
    
 
828
    def disable(self, quiet = False):
 
829
        oldstate = getattr(self, "enabled", False)
 
830
        r = Client.disable(self, quiet=quiet)
 
831
        if not quiet and oldstate != self.enabled:
 
832
            # Emit D-Bus signal
 
833
            self.PropertyChanged(dbus.String("Enabled"),
 
834
                                 dbus.Boolean(False, variant_level=1))
 
835
        return r
1260
836
    
1261
837
    def __del__(self, *args, **kwargs):
1262
838
        try:
1271
847
                         *args, **kwargs):
1272
848
        self.checker_callback_tag = None
1273
849
        self.checker = None
 
850
        # Emit D-Bus signal
 
851
        self.PropertyChanged(dbus.String("CheckerRunning"),
 
852
                             dbus.Boolean(False, variant_level=1))
1274
853
        if os.WIFEXITED(condition):
1275
854
            exitstatus = os.WEXITSTATUS(condition)
1276
855
            # Emit D-Bus signal
1286
865
        return Client.checker_callback(self, pid, condition, command,
1287
866
                                       *args, **kwargs)
1288
867
    
 
868
    def checked_ok(self, *args, **kwargs):
 
869
        Client.checked_ok(self, *args, **kwargs)
 
870
        # Emit D-Bus signal
 
871
        self.PropertyChanged(
 
872
            dbus.String("LastCheckedOK"),
 
873
            (self._datetime_to_dbus(self.last_checked_ok,
 
874
                                    variant_level=1)))
 
875
    
 
876
    def need_approval(self, *args, **kwargs):
 
877
        r = Client.need_approval(self, *args, **kwargs)
 
878
        # Emit D-Bus signal
 
879
        self.PropertyChanged(
 
880
            dbus.String("LastApprovalRequest"),
 
881
            (self._datetime_to_dbus(self.last_approval_request,
 
882
                                    variant_level=1)))
 
883
        return r
 
884
    
1289
885
    def start_checker(self, *args, **kwargs):
1290
886
        old_checker = self.checker
1291
887
        if self.checker is not None:
1298
894
            and old_checker_pid != self.checker.pid):
1299
895
            # Emit D-Bus signal
1300
896
            self.CheckerStarted(self.current_checker_command)
 
897
            self.PropertyChanged(
 
898
                dbus.String("CheckerRunning"),
 
899
                dbus.Boolean(True, variant_level=1))
1301
900
        return r
1302
901
    
 
902
    def stop_checker(self, *args, **kwargs):
 
903
        old_checker = getattr(self, "checker", None)
 
904
        r = Client.stop_checker(self, *args, **kwargs)
 
905
        if (old_checker is not None
 
906
            and getattr(self, "checker", None) is None):
 
907
            self.PropertyChanged(dbus.String("CheckerRunning"),
 
908
                                 dbus.Boolean(False, variant_level=1))
 
909
        return r
 
910
 
1303
911
    def _reset_approved(self):
1304
 
        self.approved = None
 
912
        self._approved = None
1305
913
        return False
1306
914
    
1307
915
    def approve(self, value=True):
1308
916
        self.send_changedstate()
1309
 
        self.approved = value
1310
 
        gobject.timeout_add(timedelta_to_milliseconds
 
917
        self._approved = value
 
918
        gobject.timeout_add(self._timedelta_to_milliseconds
1311
919
                            (self.approval_duration),
1312
920
                            self._reset_approved)
1313
921
    
1314
922
    
1315
923
    ## D-Bus methods, signals & properties
1316
 
    _interface = "se.recompile.Mandos.Client"
1317
 
    
1318
 
    ## Interfaces
1319
 
    
1320
 
    @dbus_interface_annotations(_interface)
1321
 
    def _foo(self):
1322
 
        return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1323
 
                     "false"}
 
924
    _interface = "se.bsnet.fukt.Mandos.Client"
1324
925
    
1325
926
    ## Signals
1326
927
    
1411
1012
    def ApprovedByDefault_dbus_property(self, value=None):
1412
1013
        if value is None:       # get
1413
1014
            return dbus.Boolean(self.approved_by_default)
 
1015
        old_value = self.approved_by_default
1414
1016
        self.approved_by_default = bool(value)
 
1017
        # Emit D-Bus signal
 
1018
        if old_value != self.approved_by_default:
 
1019
            self.PropertyChanged(dbus.String("ApprovedByDefault"),
 
1020
                                 dbus.Boolean(value, variant_level=1))
1415
1021
    
1416
1022
    # ApprovalDelay - property
1417
1023
    @dbus_service_property(_interface, signature="t",
1419
1025
    def ApprovalDelay_dbus_property(self, value=None):
1420
1026
        if value is None:       # get
1421
1027
            return dbus.UInt64(self.approval_delay_milliseconds())
 
1028
        old_value = self.approval_delay
1422
1029
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
 
1030
        # Emit D-Bus signal
 
1031
        if old_value != self.approval_delay:
 
1032
            self.PropertyChanged(dbus.String("ApprovalDelay"),
 
1033
                                 dbus.UInt64(value, variant_level=1))
1423
1034
    
1424
1035
    # ApprovalDuration - property
1425
1036
    @dbus_service_property(_interface, signature="t",
1426
1037
                           access="readwrite")
1427
1038
    def ApprovalDuration_dbus_property(self, value=None):
1428
1039
        if value is None:       # get
1429
 
            return dbus.UInt64(timedelta_to_milliseconds(
 
1040
            return dbus.UInt64(self._timedelta_to_milliseconds(
1430
1041
                    self.approval_duration))
 
1042
        old_value = self.approval_duration
1431
1043
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
 
1044
        # Emit D-Bus signal
 
1045
        if old_value != self.approval_duration:
 
1046
            self.PropertyChanged(dbus.String("ApprovalDuration"),
 
1047
                                 dbus.UInt64(value, variant_level=1))
1432
1048
    
1433
1049
    # Name - property
1434
1050
    @dbus_service_property(_interface, signature="s", access="read")
1446
1062
    def Host_dbus_property(self, value=None):
1447
1063
        if value is None:       # get
1448
1064
            return dbus.String(self.host)
1449
 
        self.host = unicode(value)
 
1065
        old_value = self.host
 
1066
        self.host = value
 
1067
        # Emit D-Bus signal
 
1068
        if old_value != self.host:
 
1069
            self.PropertyChanged(dbus.String("Host"),
 
1070
                                 dbus.String(value, variant_level=1))
1450
1071
    
1451
1072
    # Created - property
1452
1073
    @dbus_service_property(_interface, signature="s", access="read")
1453
1074
    def Created_dbus_property(self):
1454
 
        return datetime_to_dbus(self.created)
 
1075
        return dbus.String(self._datetime_to_dbus(self.created))
1455
1076
    
1456
1077
    # LastEnabled - property
1457
1078
    @dbus_service_property(_interface, signature="s", access="read")
1458
1079
    def LastEnabled_dbus_property(self):
1459
 
        return datetime_to_dbus(self.last_enabled)
 
1080
        return self._datetime_to_dbus(self.last_enabled)
1460
1081
    
1461
1082
    # Enabled - property
1462
1083
    @dbus_service_property(_interface, signature="b",
1476
1097
        if value is not None:
1477
1098
            self.checked_ok()
1478
1099
            return
1479
 
        return datetime_to_dbus(self.last_checked_ok)
1480
 
    
1481
 
    # LastCheckerStatus - property
1482
 
    @dbus_service_property(_interface, signature="n",
1483
 
                           access="read")
1484
 
    def LastCheckerStatus_dbus_property(self):
1485
 
        return dbus.Int16(self.last_checker_status)
 
1100
        return self._datetime_to_dbus(self.last_checked_ok)
1486
1101
    
1487
1102
    # Expires - property
1488
1103
    @dbus_service_property(_interface, signature="s", access="read")
1489
1104
    def Expires_dbus_property(self):
1490
 
        return datetime_to_dbus(self.expires)
 
1105
        return self._datetime_to_dbus(self.expires)
1491
1106
    
1492
1107
    # LastApprovalRequest - property
1493
1108
    @dbus_service_property(_interface, signature="s", access="read")
1494
1109
    def LastApprovalRequest_dbus_property(self):
1495
 
        return datetime_to_dbus(self.last_approval_request)
 
1110
        return self._datetime_to_dbus(self.last_approval_request)
1496
1111
    
1497
1112
    # Timeout - property
1498
1113
    @dbus_service_property(_interface, signature="t",
1500
1115
    def Timeout_dbus_property(self, value=None):
1501
1116
        if value is None:       # get
1502
1117
            return dbus.UInt64(self.timeout_milliseconds())
 
1118
        old_value = self.timeout
1503
1119
        self.timeout = datetime.timedelta(0, 0, 0, value)
 
1120
        # Emit D-Bus signal
 
1121
        if old_value != self.timeout:
 
1122
            self.PropertyChanged(dbus.String("Timeout"),
 
1123
                                 dbus.UInt64(value, variant_level=1))
 
1124
        if getattr(self, "disable_initiator_tag", None) is None:
 
1125
            return
1504
1126
        # Reschedule timeout
1505
 
        if self.enabled:
1506
 
            now = datetime.datetime.utcnow()
1507
 
            time_to_die = timedelta_to_milliseconds(
1508
 
                (self.last_checked_ok + self.timeout) - now)
1509
 
            if time_to_die <= 0:
1510
 
                # The timeout has passed
1511
 
                self.disable()
1512
 
            else:
1513
 
                self.expires = (now +
1514
 
                                datetime.timedelta(milliseconds =
1515
 
                                                   time_to_die))
1516
 
                if (getattr(self, "disable_initiator_tag", None)
1517
 
                    is None):
1518
 
                    return
1519
 
                gobject.source_remove(self.disable_initiator_tag)
1520
 
                self.disable_initiator_tag = (gobject.timeout_add
1521
 
                                              (time_to_die,
1522
 
                                               self.disable))
1523
 
    
 
1127
        gobject.source_remove(self.disable_initiator_tag)
 
1128
        self.disable_initiator_tag = None
 
1129
        self.expires = None
 
1130
        time_to_die = (self.
 
1131
                       _timedelta_to_milliseconds((self
 
1132
                                                   .last_checked_ok
 
1133
                                                   + self.timeout)
 
1134
                                                  - datetime.datetime
 
1135
                                                  .utcnow()))
 
1136
        if time_to_die <= 0:
 
1137
            # The timeout has passed
 
1138
            self.disable()
 
1139
        else:
 
1140
            self.expires = (datetime.datetime.utcnow()
 
1141
                            + datetime.timedelta(milliseconds = time_to_die))
 
1142
            self.disable_initiator_tag = (gobject.timeout_add
 
1143
                                          (time_to_die, self.disable))
 
1144
 
1524
1145
    # ExtendedTimeout - property
1525
1146
    @dbus_service_property(_interface, signature="t",
1526
1147
                           access="readwrite")
1527
1148
    def ExtendedTimeout_dbus_property(self, value=None):
1528
1149
        if value is None:       # get
1529
1150
            return dbus.UInt64(self.extended_timeout_milliseconds())
 
1151
        old_value = self.extended_timeout
1530
1152
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1531
 
    
 
1153
        # Emit D-Bus signal
 
1154
        if old_value != self.extended_timeout:
 
1155
            self.PropertyChanged(dbus.String("ExtendedTimeout"),
 
1156
                                 dbus.UInt64(value, variant_level=1))
 
1157
 
1532
1158
    # Interval - property
1533
1159
    @dbus_service_property(_interface, signature="t",
1534
1160
                           access="readwrite")
1535
1161
    def Interval_dbus_property(self, value=None):
1536
1162
        if value is None:       # get
1537
1163
            return dbus.UInt64(self.interval_milliseconds())
 
1164
        old_value = self.interval
1538
1165
        self.interval = datetime.timedelta(0, 0, 0, value)
 
1166
        # Emit D-Bus signal
 
1167
        if old_value != self.interval:
 
1168
            self.PropertyChanged(dbus.String("Interval"),
 
1169
                                 dbus.UInt64(value, variant_level=1))
1539
1170
        if getattr(self, "checker_initiator_tag", None) is None:
1540
1171
            return
1541
 
        if self.enabled:
1542
 
            # Reschedule checker run
1543
 
            gobject.source_remove(self.checker_initiator_tag)
1544
 
            self.checker_initiator_tag = (gobject.timeout_add
1545
 
                                          (value, self.start_checker))
1546
 
            self.start_checker()    # Start one now, too
1547
 
    
 
1172
        # Reschedule checker run
 
1173
        gobject.source_remove(self.checker_initiator_tag)
 
1174
        self.checker_initiator_tag = (gobject.timeout_add
 
1175
                                      (value, self.start_checker))
 
1176
        self.start_checker()    # Start one now, too
 
1177
 
1548
1178
    # Checker - property
1549
1179
    @dbus_service_property(_interface, signature="s",
1550
1180
                           access="readwrite")
1551
1181
    def Checker_dbus_property(self, value=None):
1552
1182
        if value is None:       # get
1553
1183
            return dbus.String(self.checker_command)
1554
 
        self.checker_command = unicode(value)
 
1184
        old_value = self.checker_command
 
1185
        self.checker_command = value
 
1186
        # Emit D-Bus signal
 
1187
        if old_value != self.checker_command:
 
1188
            self.PropertyChanged(dbus.String("Checker"),
 
1189
                                 dbus.String(self.checker_command,
 
1190
                                             variant_level=1))
1555
1191
    
1556
1192
    # CheckerRunning - property
1557
1193
    @dbus_service_property(_interface, signature="b",
1584
1220
        self._pipe.send(('init', fpr, address))
1585
1221
        if not self._pipe.recv():
1586
1222
            raise KeyError()
1587
 
    
 
1223
 
1588
1224
    def __getattribute__(self, name):
1589
 
        if name == '_pipe':
 
1225
        if(name == '_pipe'):
1590
1226
            return super(ProxyClient, self).__getattribute__(name)
1591
1227
        self._pipe.send(('getattr', name))
1592
1228
        data = self._pipe.recv()
1597
1233
                self._pipe.send(('funcall', name, args, kwargs))
1598
1234
                return self._pipe.recv()[1]
1599
1235
            return func
1600
 
    
 
1236
 
1601
1237
    def __setattr__(self, name, value):
1602
 
        if name == '_pipe':
 
1238
        if(name == '_pipe'):
1603
1239
            return super(ProxyClient, self).__setattr__(name, value)
1604
1240
        self._pipe.send(('setattr', name, value))
1605
1241
 
1606
1242
 
1607
 
class ClientDBusTransitional(ClientDBus):
1608
 
    __metaclass__ = AlternateDBusNamesMetaclass
1609
 
 
1610
 
 
1611
1243
class ClientHandler(socketserver.BaseRequestHandler, object):
1612
1244
    """A class to handle client connections.
1613
1245
    
1620
1252
                        unicode(self.client_address))
1621
1253
            logger.debug("Pipe FD: %d",
1622
1254
                         self.server.child_pipe.fileno())
1623
 
            
 
1255
 
1624
1256
            session = (gnutls.connection
1625
1257
                       .ClientSession(self.request,
1626
1258
                                      gnutls.connection
1627
1259
                                      .X509Credentials()))
1628
 
            
 
1260
 
1629
1261
            # Note: gnutls.connection.X509Credentials is really a
1630
1262
            # generic GnuTLS certificate credentials object so long as
1631
1263
            # no X.509 keys are added to it.  Therefore, we can use it
1632
1264
            # here despite using OpenPGP certificates.
1633
 
            
 
1265
 
1634
1266
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
1635
1267
            #                      "+AES-256-CBC", "+SHA1",
1636
1268
            #                      "+COMP-NULL", "+CTYPE-OPENPGP",
1642
1274
            (gnutls.library.functions
1643
1275
             .gnutls_priority_set_direct(session._c_object,
1644
1276
                                         priority, None))
1645
 
            
 
1277
 
1646
1278
            # Start communication using the Mandos protocol
1647
1279
            # Get protocol number
1648
1280
            line = self.request.makefile().readline()
1653
1285
            except (ValueError, IndexError, RuntimeError) as error:
1654
1286
                logger.error("Unknown protocol version: %s", error)
1655
1287
                return
1656
 
            
 
1288
 
1657
1289
            # Start GnuTLS connection
1658
1290
            try:
1659
1291
                session.handshake()
1663
1295
                # established.  Just abandon the request.
1664
1296
                return
1665
1297
            logger.debug("Handshake succeeded")
1666
 
            
 
1298
 
1667
1299
            approval_required = False
1668
1300
            try:
1669
1301
                try:
1674
1306
                    logger.warning("Bad certificate: %s", error)
1675
1307
                    return
1676
1308
                logger.debug("Fingerprint: %s", fpr)
1677
 
                
 
1309
 
1678
1310
                try:
1679
1311
                    client = ProxyClient(child_pipe, fpr,
1680
1312
                                         self.client_address)
1692
1324
                                       client.name)
1693
1325
                        if self.server.use_dbus:
1694
1326
                            # Emit D-Bus signal
1695
 
                            client.Rejected("Disabled")
 
1327
                            client.Rejected("Disabled")                    
1696
1328
                        return
1697
1329
                    
1698
 
                    if client.approved or not client.approval_delay:
 
1330
                    if client._approved or not client.approval_delay:
1699
1331
                        #We are approved or approval is disabled
1700
1332
                        break
1701
 
                    elif client.approved is None:
 
1333
                    elif client._approved is None:
1702
1334
                        logger.info("Client %s needs approval",
1703
1335
                                    client.name)
1704
1336
                        if self.server.use_dbus:
1715
1347
                        return
1716
1348
                    
1717
1349
                    #wait until timeout or approved
 
1350
                    #x = float(client._timedelta_to_milliseconds(delay))
1718
1351
                    time = datetime.datetime.now()
1719
1352
                    client.changedstate.acquire()
1720
 
                    (client.changedstate.wait
1721
 
                     (float(client.timedelta_to_milliseconds(delay)
1722
 
                            / 1000)))
 
1353
                    client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
1723
1354
                    client.changedstate.release()
1724
1355
                    time2 = datetime.datetime.now()
1725
1356
                    if (time2 - time) >= delay:
1747
1378
                                 sent, len(client.secret)
1748
1379
                                 - (sent_size + sent))
1749
1380
                    sent_size += sent
1750
 
                
 
1381
 
1751
1382
                logger.info("Sending secret to %s", client.name)
1752
 
                # bump the timeout using extended_timeout
1753
 
                client.bump_timeout(client.extended_timeout)
 
1383
                # bump the timeout as if seen
 
1384
                client.checked_ok(client.extended_timeout)
1754
1385
                if self.server.use_dbus:
1755
1386
                    # Emit D-Bus signal
1756
1387
                    client.GotSecret()
1823
1454
        # Convert the buffer to a Python bytestring
1824
1455
        fpr = ctypes.string_at(buf, buf_len.value)
1825
1456
        # Convert the bytestring to hexadecimal notation
1826
 
        hex_fpr = binascii.hexlify(fpr).upper()
 
1457
        hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
1827
1458
        return hex_fpr
1828
1459
 
1829
1460
 
1832
1463
    def sub_process_main(self, request, address):
1833
1464
        try:
1834
1465
            self.finish_request(request, address)
1835
 
        except Exception:
 
1466
        except:
1836
1467
            self.handle_error(request, address)
1837
1468
        self.close_request(request)
1838
 
    
 
1469
            
1839
1470
    def process_request(self, request, address):
1840
1471
        """Start a new process to process the request."""
1841
 
        proc = multiprocessing.Process(target = self.sub_process_main,
1842
 
                                       args = (request,
1843
 
                                               address))
1844
 
        proc.start()
1845
 
        return proc
1846
 
 
 
1472
        multiprocessing.Process(target = self.sub_process_main,
 
1473
                                args = (request, address)).start()
1847
1474
 
1848
1475
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1849
1476
    """ adds a pipe to the MixIn """
1853
1480
        This function creates a new pipe in self.pipe
1854
1481
        """
1855
1482
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
1856
 
        
1857
 
        proc = MultiprocessingMixIn.process_request(self, request,
1858
 
                                                    client_address)
 
1483
 
 
1484
        super(MultiprocessingMixInWithPipe,
 
1485
              self).process_request(request, client_address)
1859
1486
        self.child_pipe.close()
1860
 
        self.add_pipe(parent_pipe, proc)
1861
 
    
1862
 
    def add_pipe(self, parent_pipe, proc):
 
1487
        self.add_pipe(parent_pipe)
 
1488
 
 
1489
    def add_pipe(self, parent_pipe):
1863
1490
        """Dummy function; override as necessary"""
1864
1491
        raise NotImplementedError
1865
1492
 
1866
 
 
1867
1493
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1868
1494
                     socketserver.TCPServer, object):
1869
1495
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
1943
1569
        self.enabled = False
1944
1570
        self.clients = clients
1945
1571
        if self.clients is None:
1946
 
            self.clients = {}
 
1572
            self.clients = set()
1947
1573
        self.use_dbus = use_dbus
1948
1574
        self.gnutls_priority = gnutls_priority
1949
1575
        IPv6_TCPServer.__init__(self, server_address,
1953
1579
    def server_activate(self):
1954
1580
        if self.enabled:
1955
1581
            return socketserver.TCPServer.server_activate(self)
1956
 
    
1957
1582
    def enable(self):
1958
1583
        self.enabled = True
1959
 
    
1960
 
    def add_pipe(self, parent_pipe, proc):
 
1584
    def add_pipe(self, parent_pipe):
1961
1585
        # Call "handle_ipc" for both data and EOF events
1962
1586
        gobject.io_add_watch(parent_pipe.fileno(),
1963
1587
                             gobject.IO_IN | gobject.IO_HUP,
1964
1588
                             functools.partial(self.handle_ipc,
1965
 
                                               parent_pipe =
1966
 
                                               parent_pipe,
1967
 
                                               proc = proc))
1968
 
    
 
1589
                                               parent_pipe = parent_pipe))
 
1590
        
1969
1591
    def handle_ipc(self, source, condition, parent_pipe=None,
1970
 
                   proc = None, client_object=None):
 
1592
                   client_object=None):
1971
1593
        condition_names = {
1972
1594
            gobject.IO_IN: "IN",   # There is data to read.
1973
1595
            gobject.IO_OUT: "OUT", # Data can be written (without
1982
1604
                                       for cond, name in
1983
1605
                                       condition_names.iteritems()
1984
1606
                                       if cond & condition)
1985
 
        # error, or the other end of multiprocessing.Pipe has closed
 
1607
        # error or the other end of multiprocessing.Pipe has closed
1986
1608
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
1987
 
            # Wait for other process to exit
1988
 
            proc.join()
1989
1609
            return False
1990
1610
        
1991
1611
        # Read a request from the child
1996
1616
            fpr = request[1]
1997
1617
            address = request[2]
1998
1618
            
1999
 
            for c in self.clients.itervalues():
 
1619
            for c in self.clients:
2000
1620
                if c.fingerprint == fpr:
2001
1621
                    client = c
2002
1622
                    break
2005
1625
                            "dress: %s", fpr, address)
2006
1626
                if self.use_dbus:
2007
1627
                    # Emit D-Bus signal
2008
 
                    mandos_dbus_service.ClientNotFound(fpr,
2009
 
                                                       address[0])
 
1628
                    mandos_dbus_service.ClientNotFound(fpr, address[0])
2010
1629
                parent_pipe.send(False)
2011
1630
                return False
2012
1631
            
2013
1632
            gobject.io_add_watch(parent_pipe.fileno(),
2014
1633
                                 gobject.IO_IN | gobject.IO_HUP,
2015
1634
                                 functools.partial(self.handle_ipc,
2016
 
                                                   parent_pipe =
2017
 
                                                   parent_pipe,
2018
 
                                                   proc = proc,
2019
 
                                                   client_object =
2020
 
                                                   client))
 
1635
                                                   parent_pipe = parent_pipe,
 
1636
                                                   client_object = client))
2021
1637
            parent_pipe.send(True)
2022
 
            # remove the old hook in favor of the new above hook on
2023
 
            # same fileno
 
1638
            # remove the old hook in favor of the new above hook on same fileno
2024
1639
            return False
2025
1640
        if command == 'funcall':
2026
1641
            funcname = request[1]
2027
1642
            args = request[2]
2028
1643
            kwargs = request[3]
2029
1644
            
2030
 
            parent_pipe.send(('data', getattr(client_object,
2031
 
                                              funcname)(*args,
2032
 
                                                         **kwargs)))
2033
 
        
 
1645
            parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
 
1646
 
2034
1647
        if command == 'getattr':
2035
1648
            attrname = request[1]
2036
1649
            if callable(client_object.__getattribute__(attrname)):
2037
1650
                parent_pipe.send(('function',))
2038
1651
            else:
2039
 
                parent_pipe.send(('data', client_object
2040
 
                                  .__getattribute__(attrname)))
 
1652
                parent_pipe.send(('data', client_object.__getattribute__(attrname)))
2041
1653
        
2042
1654
        if command == 'setattr':
2043
1655
            attrname = request[1]
2044
1656
            value = request[2]
2045
1657
            setattr(client_object, attrname, value)
2046
 
        
 
1658
 
2047
1659
        return True
2048
1660
 
2049
1661
 
2086
1698
    return timevalue
2087
1699
 
2088
1700
 
 
1701
def if_nametoindex(interface):
 
1702
    """Call the C function if_nametoindex(), or equivalent
 
1703
    
 
1704
    Note: This function cannot accept a unicode string."""
 
1705
    global if_nametoindex
 
1706
    try:
 
1707
        if_nametoindex = (ctypes.cdll.LoadLibrary
 
1708
                          (ctypes.util.find_library("c"))
 
1709
                          .if_nametoindex)
 
1710
    except (OSError, AttributeError):
 
1711
        logger.warning("Doing if_nametoindex the hard way")
 
1712
        def if_nametoindex(interface):
 
1713
            "Get an interface index the hard way, i.e. using fcntl()"
 
1714
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
 
1715
            with contextlib.closing(socket.socket()) as s:
 
1716
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
 
1717
                                    struct.pack(str("16s16x"),
 
1718
                                                interface))
 
1719
            interface_index = struct.unpack(str("I"),
 
1720
                                            ifreq[16:20])[0]
 
1721
            return interface_index
 
1722
    return if_nametoindex(interface)
 
1723
 
 
1724
 
2089
1725
def daemon(nochdir = False, noclose = False):
2090
1726
    """See daemon(3).  Standard BSD Unix function.
2091
1727
    
2099
1735
        sys.exit()
2100
1736
    if not noclose:
2101
1737
        # Close all standard open file descriptors
2102
 
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
1738
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2103
1739
        if not stat.S_ISCHR(os.fstat(null).st_mode):
2104
1740
            raise OSError(errno.ENODEV,
2105
1741
                          "%s not a character device"
2106
 
                          % os.devnull)
 
1742
                          % os.path.devnull)
2107
1743
        os.dup2(null, sys.stdin.fileno())
2108
1744
        os.dup2(null, sys.stdout.fileno())
2109
1745
        os.dup2(null, sys.stderr.fileno())
2146
1782
                        " system bus interface")
2147
1783
    parser.add_argument("--no-ipv6", action="store_false",
2148
1784
                        dest="use_ipv6", help="Do not use IPv6")
2149
 
    parser.add_argument("--no-restore", action="store_false",
2150
 
                        dest="restore", help="Do not restore stored"
2151
 
                        " state")
2152
 
    parser.add_argument("--statedir", metavar="DIR",
2153
 
                        help="Directory to save/restore state in")
2154
 
    
2155
1785
    options = parser.parse_args()
2156
1786
    
2157
1787
    if options.check:
2170
1800
                        "use_dbus": "True",
2171
1801
                        "use_ipv6": "True",
2172
1802
                        "debuglevel": "",
2173
 
                        "restore": "True",
2174
 
                        "statedir": "/var/lib/mandos"
2175
1803
                        }
2176
1804
    
2177
1805
    # Parse config file for server-global settings
2194
1822
    # options, if set.
2195
1823
    for option in ("interface", "address", "port", "debug",
2196
1824
                   "priority", "servicename", "configdir",
2197
 
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2198
 
                   "statedir"):
 
1825
                   "use_dbus", "use_ipv6", "debuglevel"):
2199
1826
        value = getattr(options, option)
2200
1827
        if value is not None:
2201
1828
            server_settings[option] = value
2213
1840
    debuglevel = server_settings["debuglevel"]
2214
1841
    use_dbus = server_settings["use_dbus"]
2215
1842
    use_ipv6 = server_settings["use_ipv6"]
2216
 
    stored_state_path = os.path.join(server_settings["statedir"],
2217
 
                                     stored_state_file)
2218
 
    
2219
 
    if debug:
2220
 
        initlogger(debug, logging.DEBUG)
2221
 
    else:
2222
 
        if not debuglevel:
2223
 
            initlogger(debug)
2224
 
        else:
2225
 
            level = getattr(logging, debuglevel.upper())
2226
 
            initlogger(debug, level)
2227
 
    
 
1843
 
2228
1844
    if server_settings["servicename"] != "Mandos":
2229
1845
        syslogger.setFormatter(logging.Formatter
2230
1846
                               ('Mandos (%s) [%%(process)d]:'
2232
1848
                                % server_settings["servicename"]))
2233
1849
    
2234
1850
    # Parse config file with clients
2235
 
    client_config = configparser.SafeConfigParser(Client
2236
 
                                                  .client_defaults)
 
1851
    client_defaults = { "timeout": "5m",
 
1852
                        "extended_timeout": "15m",
 
1853
                        "interval": "2m",
 
1854
                        "checker": "fping -q -- %%(host)s",
 
1855
                        "host": "",
 
1856
                        "approval_delay": "0s",
 
1857
                        "approval_duration": "1s",
 
1858
                        }
 
1859
    client_config = configparser.SafeConfigParser(client_defaults)
2237
1860
    client_config.read(os.path.join(server_settings["configdir"],
2238
1861
                                    "clients.conf"))
2239
1862
    
2277
1900
        if error[0] != errno.EPERM:
2278
1901
            raise error
2279
1902
    
 
1903
    if not debug and not debuglevel:
 
1904
        syslogger.setLevel(logging.WARNING)
 
1905
        console.setLevel(logging.WARNING)
 
1906
    if debuglevel:
 
1907
        level = getattr(logging, debuglevel.upper())
 
1908
        syslogger.setLevel(level)
 
1909
        console.setLevel(level)
 
1910
 
2280
1911
    if debug:
2281
1912
        # Enable all possible GnuTLS debugging
2282
1913
        
2292
1923
         .gnutls_global_set_log_function(debug_gnutls))
2293
1924
        
2294
1925
        # Redirect stdin so all checkers get /dev/null
2295
 
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
1926
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2296
1927
        os.dup2(null, sys.stdin.fileno())
2297
1928
        if null > 2:
2298
1929
            os.close(null)
 
1930
    else:
 
1931
        # No console logging
 
1932
        logger.removeHandler(console)
2299
1933
    
2300
1934
    # Need to fork before connecting to D-Bus
2301
1935
    if not debug:
2302
1936
        # Close all input and output, do double fork, etc.
2303
1937
        daemon()
2304
1938
    
2305
 
    gobject.threads_init()
2306
 
    
2307
1939
    global main_loop
2308
1940
    # From the Avahi example code
2309
 
    DBusGMainLoop(set_as_default=True)
 
1941
    DBusGMainLoop(set_as_default=True )
2310
1942
    main_loop = gobject.MainLoop()
2311
1943
    bus = dbus.SystemBus()
2312
1944
    # End of Avahi example code
2313
1945
    if use_dbus:
2314
1946
        try:
2315
 
            bus_name = dbus.service.BusName("se.recompile.Mandos",
 
1947
            bus_name = dbus.service.BusName("se.bsnet.fukt.Mandos",
2316
1948
                                            bus, do_not_queue=True)
2317
 
            old_bus_name = (dbus.service.BusName
2318
 
                            ("se.bsnet.fukt.Mandos", bus,
2319
 
                             do_not_queue=True))
2320
1949
        except dbus.exceptions.NameExistsException as e:
2321
1950
            logger.error(unicode(e) + ", disabling D-Bus")
2322
1951
            use_dbus = False
2323
1952
            server_settings["use_dbus"] = False
2324
1953
            tcp_server.use_dbus = False
2325
1954
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2326
 
    service = AvahiServiceToSyslog(name =
2327
 
                                   server_settings["servicename"],
2328
 
                                   servicetype = "_mandos._tcp",
2329
 
                                   protocol = protocol, bus = bus)
 
1955
    service = AvahiService(name = server_settings["servicename"],
 
1956
                           servicetype = "_mandos._tcp",
 
1957
                           protocol = protocol, bus = bus)
2330
1958
    if server_settings["interface"]:
2331
1959
        service.interface = (if_nametoindex
2332
1960
                             (str(server_settings["interface"])))
2336
1964
    
2337
1965
    client_class = Client
2338
1966
    if use_dbus:
2339
 
        client_class = functools.partial(ClientDBusTransitional,
2340
 
                                         bus = bus)
2341
 
    
2342
 
    client_settings = Client.config_parser(client_config)
2343
 
    old_client_settings = {}
2344
 
    clients_data = {}
2345
 
    
2346
 
    # Get client data and settings from last running state.
2347
 
    if server_settings["restore"]:
2348
 
        try:
2349
 
            with open(stored_state_path, "rb") as stored_state:
2350
 
                clients_data, old_client_settings = (pickle.load
2351
 
                                                     (stored_state))
2352
 
            os.remove(stored_state_path)
2353
 
        except IOError as e:
2354
 
            logger.warning("Could not load persistent state: {0}"
2355
 
                           .format(e))
2356
 
            if e.errno != errno.ENOENT:
2357
 
                raise
2358
 
        except EOFError as e:
2359
 
            logger.warning("Could not load persistent state: "
2360
 
                           "EOFError: {0}".format(e))
2361
 
    
2362
 
    with PGPEngine() as pgp:
2363
 
        for client_name, client in clients_data.iteritems():
2364
 
            # Decide which value to use after restoring saved state.
2365
 
            # We have three different values: Old config file,
2366
 
            # new config file, and saved state.
2367
 
            # New config value takes precedence if it differs from old
2368
 
            # config value, otherwise use saved state.
2369
 
            for name, value in client_settings[client_name].items():
2370
 
                try:
2371
 
                    # For each value in new config, check if it
2372
 
                    # differs from the old config value (Except for
2373
 
                    # the "secret" attribute)
2374
 
                    if (name != "secret" and
2375
 
                        value != old_client_settings[client_name]
2376
 
                        [name]):
2377
 
                        client[name] = value
2378
 
                except KeyError:
2379
 
                    pass
2380
 
            
2381
 
            # Clients who has passed its expire date can still be
2382
 
            # enabled if its last checker was successful.  Clients
2383
 
            # whose checker succeeded before we stored its state is
2384
 
            # assumed to have successfully run all checkers during
2385
 
            # downtime.
2386
 
            if client["enabled"]:
2387
 
                if datetime.datetime.utcnow() >= client["expires"]:
2388
 
                    if not client["last_checked_ok"]:
2389
 
                        logger.warning(
2390
 
                            "disabling client {0} - Client never "
2391
 
                            "performed a successful checker"
2392
 
                            .format(client_name))
2393
 
                        client["enabled"] = False
2394
 
                    elif client["last_checker_status"] != 0:
2395
 
                        logger.warning(
2396
 
                            "disabling client {0} - Client "
2397
 
                            "last checker failed with error code {1}"
2398
 
                            .format(client_name,
2399
 
                                    client["last_checker_status"]))
2400
 
                        client["enabled"] = False
2401
 
                    else:
2402
 
                        client["expires"] = (datetime.datetime
2403
 
                                             .utcnow()
2404
 
                                             + client["timeout"])
2405
 
                        logger.debug("Last checker succeeded,"
2406
 
                                     " keeping {0} enabled"
2407
 
                                     .format(client_name))
 
1967
        client_class = functools.partial(ClientDBus, bus = bus)
 
1968
    def client_config_items(config, section):
 
1969
        special_settings = {
 
1970
            "approved_by_default":
 
1971
                lambda: config.getboolean(section,
 
1972
                                          "approved_by_default"),
 
1973
            }
 
1974
        for name, value in config.items(section):
2408
1975
            try:
2409
 
                client["secret"] = (
2410
 
                    pgp.decrypt(client["encrypted_secret"],
2411
 
                                client_settings[client_name]
2412
 
                                ["secret"]))
2413
 
            except PGPError:
2414
 
                # If decryption fails, we use secret from new settings
2415
 
                logger.debug("Failed to decrypt {0} old secret"
2416
 
                             .format(client_name))
2417
 
                client["secret"] = (
2418
 
                    client_settings[client_name]["secret"])
2419
 
 
2420
 
    
2421
 
    # Add/remove clients based on new changes made to config
2422
 
    for client_name in (set(old_client_settings)
2423
 
                        - set(client_settings)):
2424
 
        del clients_data[client_name]
2425
 
    for client_name in (set(client_settings)
2426
 
                        - set(old_client_settings)):
2427
 
        clients_data[client_name] = client_settings[client_name]
2428
 
 
2429
 
    # Create all client objects
2430
 
    for client_name, client in clients_data.iteritems():
2431
 
        tcp_server.clients[client_name] = client_class(
2432
 
            name = client_name, settings = client)
2433
 
    
 
1976
                yield (name, special_settings[name]())
 
1977
            except KeyError:
 
1978
                yield (name, value)
 
1979
    
 
1980
    tcp_server.clients.update(set(
 
1981
            client_class(name = section,
 
1982
                         config= dict(client_config_items(
 
1983
                        client_config, section)))
 
1984
            for section in client_config.sections()))
2434
1985
    if not tcp_server.clients:
2435
1986
        logger.warning("No clients defined")
2436
1987
        
2447
1998
            # "pidfile" was never created
2448
1999
            pass
2449
2000
        del pidfilename
 
2001
        
2450
2002
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2451
 
    
 
2003
 
2452
2004
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2453
2005
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2454
2006
    
2455
2007
    if use_dbus:
2456
 
        class MandosDBusService(DBusObjectWithProperties):
 
2008
        class MandosDBusService(dbus.service.Object):
2457
2009
            """A D-Bus proxy object"""
2458
2010
            def __init__(self):
2459
2011
                dbus.service.Object.__init__(self, bus, "/")
2460
 
            _interface = "se.recompile.Mandos"
2461
 
            
2462
 
            @dbus_interface_annotations(_interface)
2463
 
            def _foo(self):
2464
 
                return { "org.freedesktop.DBus.Property"
2465
 
                         ".EmitsChangedSignal":
2466
 
                             "false"}
 
2012
            _interface = "se.bsnet.fukt.Mandos"
2467
2013
            
2468
2014
            @dbus.service.signal(_interface, signature="o")
2469
2015
            def ClientAdded(self, objpath):
2484
2030
            def GetAllClients(self):
2485
2031
                "D-Bus method"
2486
2032
                return dbus.Array(c.dbus_object_path
2487
 
                                  for c in
2488
 
                                  tcp_server.clients.itervalues())
 
2033
                                  for c in tcp_server.clients)
2489
2034
            
2490
2035
            @dbus.service.method(_interface,
2491
2036
                                 out_signature="a{oa{sv}}")
2493
2038
                "D-Bus method"
2494
2039
                return dbus.Dictionary(
2495
2040
                    ((c.dbus_object_path, c.GetAll(""))
2496
 
                     for c in tcp_server.clients.itervalues()),
 
2041
                     for c in tcp_server.clients),
2497
2042
                    signature="oa{sv}")
2498
2043
            
2499
2044
            @dbus.service.method(_interface, in_signature="o")
2500
2045
            def RemoveClient(self, object_path):
2501
2046
                "D-Bus method"
2502
 
                for c in tcp_server.clients.itervalues():
 
2047
                for c in tcp_server.clients:
2503
2048
                    if c.dbus_object_path == object_path:
2504
 
                        del tcp_server.clients[c.name]
 
2049
                        tcp_server.clients.remove(c)
2505
2050
                        c.remove_from_connection()
2506
2051
                        # Don't signal anything except ClientRemoved
2507
2052
                        c.disable(quiet=True)
2512
2057
            
2513
2058
            del _interface
2514
2059
        
2515
 
        class MandosDBusServiceTransitional(MandosDBusService):
2516
 
            __metaclass__ = AlternateDBusNamesMetaclass
2517
 
        mandos_dbus_service = MandosDBusServiceTransitional()
 
2060
        mandos_dbus_service = MandosDBusService()
2518
2061
    
2519
2062
    def cleanup():
2520
2063
        "Cleanup function; run on exit"
2521
2064
        service.cleanup()
2522
2065
        
2523
 
        multiprocessing.active_children()
2524
 
        if not (tcp_server.clients or client_settings):
2525
 
            return
2526
 
        
2527
 
        # Store client before exiting. Secrets are encrypted with key
2528
 
        # based on what config file has. If config file is
2529
 
        # removed/edited, old secret will thus be unrecovable.
2530
 
        clients = {}
2531
 
        with PGPEngine() as pgp:
2532
 
            for client in tcp_server.clients.itervalues():
2533
 
                key = client_settings[client.name]["secret"]
2534
 
                client.encrypted_secret = pgp.encrypt(client.secret,
2535
 
                                                      key)
2536
 
                client_dict = {}
2537
 
                
2538
 
                # A list of attributes that can not be pickled
2539
 
                # + secret.
2540
 
                exclude = set(("bus", "changedstate", "secret",
2541
 
                               "checker"))
2542
 
                for name, typ in (inspect.getmembers
2543
 
                                  (dbus.service.Object)):
2544
 
                    exclude.add(name)
2545
 
                
2546
 
                client_dict["encrypted_secret"] = (client
2547
 
                                                   .encrypted_secret)
2548
 
                for attr in client.client_structure:
2549
 
                    if attr not in exclude:
2550
 
                        client_dict[attr] = getattr(client, attr)
2551
 
                
2552
 
                clients[client.name] = client_dict
2553
 
                del client_settings[client.name]["secret"]
2554
 
        
2555
 
        try:
2556
 
            tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2557
 
                                                prefix="clients-",
2558
 
                                                dir=os.path.dirname
2559
 
                                                (stored_state_path))
2560
 
            with os.fdopen(tempfd, "wb") as stored_state:
2561
 
                pickle.dump((clients, client_settings), stored_state)
2562
 
            os.rename(tempname, stored_state_path)
2563
 
        except (IOError, OSError) as e:
2564
 
            logger.warning("Could not save persistent state: {0}"
2565
 
                           .format(e))
2566
 
            if not debug:
2567
 
                try:
2568
 
                    os.remove(tempname)
2569
 
                except NameError:
2570
 
                    pass
2571
 
            if e.errno not in set((errno.ENOENT, errno.EACCES,
2572
 
                                   errno.EEXIST)):
2573
 
                raise e
2574
 
        
2575
 
        # Delete all clients, and settings from config
2576
2066
        while tcp_server.clients:
2577
 
            name, client = tcp_server.clients.popitem()
 
2067
            client = tcp_server.clients.pop()
2578
2068
            if use_dbus:
2579
2069
                client.remove_from_connection()
 
2070
            client.disable_hook = None
2580
2071
            # Don't signal anything except ClientRemoved
2581
2072
            client.disable(quiet=True)
2582
2073
            if use_dbus:
2583
2074
                # Emit D-Bus signal
2584
 
                mandos_dbus_service.ClientRemoved(client
2585
 
                                                  .dbus_object_path,
 
2075
                mandos_dbus_service.ClientRemoved(client.dbus_object_path,
2586
2076
                                                  client.name)
2587
 
        client_settings.clear()
2588
2077
    
2589
2078
    atexit.register(cleanup)
2590
2079
    
2591
 
    for client in tcp_server.clients.itervalues():
 
2080
    for client in tcp_server.clients:
2592
2081
        if use_dbus:
2593
2082
            # Emit D-Bus signal
2594
2083
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
2595
 
        # Need to initiate checking of clients
2596
 
        if client.enabled:
2597
 
            client.init_checker()
 
2084
        client.enable()
2598
2085
    
2599
2086
    tcp_server.enable()
2600
2087
    tcp_server.server_activate()