/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

working new feature: network-hooks - Enables user-scripts to take up
                     interfaces during bootup

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#!/usr/bin/python2.7
 
1
#!/usr/bin/python
2
2
# -*- mode: python; coding: utf-8 -*-
3
3
4
4
# Mandos server - give out binary blobs to connecting clients.
11
11
# "AvahiService" class, and some lines in "main".
12
12
13
13
# Everything else is
14
 
# Copyright © 2008-2014 Teddy Hogeborn
15
 
# Copyright © 2008-2014 Björn Påhlsson
 
14
# Copyright © 2008-2011 Teddy Hogeborn
 
15
# Copyright © 2008-2011 Björn Påhlsson
16
16
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
34
34
from __future__ import (division, absolute_import, print_function,
35
35
                        unicode_literals)
36
36
 
37
 
from future_builtins import *
38
 
 
39
37
import SocketServer as socketserver
40
38
import socket
41
39
import argparse
67
65
import types
68
66
import binascii
69
67
import tempfile
70
 
import itertools
71
 
import collections
72
68
 
73
69
import dbus
74
70
import dbus.service
79
75
import ctypes.util
80
76
import xml.dom.minidom
81
77
import inspect
 
78
import GnuPGInterface
82
79
 
83
80
try:
84
81
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
88
85
    except ImportError:
89
86
        SO_BINDTODEVICE = None
90
87
 
91
 
version = "1.6.8"
 
88
version = "1.4.1"
92
89
stored_state_file = "clients.pickle"
93
90
 
94
91
logger = logging.getLogger()
95
 
syslogger = None
 
92
syslogger = (logging.handlers.SysLogHandler
 
93
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
 
94
              address = str("/dev/log")))
96
95
 
97
96
try:
98
97
    if_nametoindex = (ctypes.cdll.LoadLibrary
104
103
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
105
104
        with contextlib.closing(socket.socket()) as s:
106
105
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
107
 
                                struct.pack(b"16s16x", interface))
108
 
        interface_index = struct.unpack("I", ifreq[16:20])[0]
 
106
                                struct.pack(str("16s16x"),
 
107
                                            interface))
 
108
        interface_index = struct.unpack(str("I"),
 
109
                                        ifreq[16:20])[0]
109
110
        return interface_index
110
111
 
111
112
 
112
 
def initlogger(debug, level=logging.WARNING):
 
113
def initlogger(level=logging.WARNING):
113
114
    """init logger and add loglevel"""
114
115
    
115
 
    global syslogger
116
 
    syslogger = (logging.handlers.SysLogHandler
117
 
                 (facility =
118
 
                  logging.handlers.SysLogHandler.LOG_DAEMON,
119
 
                  address = "/dev/log"))
120
116
    syslogger.setFormatter(logging.Formatter
121
117
                           ('Mandos [%(process)d]: %(levelname)s:'
122
118
                            ' %(message)s'))
123
119
    logger.addHandler(syslogger)
124
120
    
125
 
    if debug:
126
 
        console = logging.StreamHandler()
127
 
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
128
 
                                               ' [%(process)d]:'
129
 
                                               ' %(levelname)s:'
130
 
                                               ' %(message)s'))
131
 
        logger.addHandler(console)
 
121
    console = logging.StreamHandler()
 
122
    console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
 
123
                                           ' [%(process)d]:'
 
124
                                           ' %(levelname)s:'
 
125
                                           ' %(message)s'))
 
126
    logger.addHandler(console)
132
127
    logger.setLevel(level)
133
128
 
134
129
 
140
135
class PGPEngine(object):
141
136
    """A simple class for OpenPGP symmetric encryption & decryption"""
142
137
    def __init__(self):
 
138
        self.gnupg = GnuPGInterface.GnuPG()
143
139
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
144
 
        self.gnupgargs = ['--batch',
145
 
                          '--home', self.tempdir,
146
 
                          '--force-mdc',
147
 
                          '--quiet',
148
 
                          '--no-use-agent']
 
140
        self.gnupg = GnuPGInterface.GnuPG()
 
141
        self.gnupg.options.meta_interactive = False
 
142
        self.gnupg.options.homedir = self.tempdir
 
143
        self.gnupg.options.extra_args.extend(['--force-mdc',
 
144
                                              '--quiet'])
149
145
    
150
146
    def __enter__(self):
151
147
        return self
152
148
    
153
 
    def __exit__(self, exc_type, exc_value, traceback):
 
149
    def __exit__ (self, exc_type, exc_value, traceback):
154
150
        self._cleanup()
155
151
        return False
156
152
    
173
169
    def password_encode(self, password):
174
170
        # Passphrase can not be empty and can not contain newlines or
175
171
        # NUL bytes.  So we prefix it and hex encode it.
176
 
        encoded = b"mandos" + binascii.hexlify(password)
177
 
        if len(encoded) > 2048:
178
 
            # GnuPG can't handle long passwords, so encode differently
179
 
            encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
180
 
                       .replace(b"\n", b"\\n")
181
 
                       .replace(b"\0", b"\\x00"))
182
 
        return encoded
 
172
        return b"mandos" + binascii.hexlify(password)
183
173
    
184
174
    def encrypt(self, data, password):
185
 
        passphrase = self.password_encode(password)
186
 
        with tempfile.NamedTemporaryFile(dir=self.tempdir
187
 
                                         ) as passfile:
188
 
            passfile.write(passphrase)
189
 
            passfile.flush()
190
 
            proc = subprocess.Popen(['gpg', '--symmetric',
191
 
                                     '--passphrase-file',
192
 
                                     passfile.name]
193
 
                                    + self.gnupgargs,
194
 
                                    stdin = subprocess.PIPE,
195
 
                                    stdout = subprocess.PIPE,
196
 
                                    stderr = subprocess.PIPE)
197
 
            ciphertext, err = proc.communicate(input = data)
198
 
        if proc.returncode != 0:
199
 
            raise PGPError(err)
 
175
        self.gnupg.passphrase = self.password_encode(password)
 
176
        with open(os.devnull) as devnull:
 
177
            try:
 
178
                proc = self.gnupg.run(['--symmetric'],
 
179
                                      create_fhs=['stdin', 'stdout'],
 
180
                                      attach_fhs={'stderr': devnull})
 
181
                with contextlib.closing(proc.handles['stdin']) as f:
 
182
                    f.write(data)
 
183
                with contextlib.closing(proc.handles['stdout']) as f:
 
184
                    ciphertext = f.read()
 
185
                proc.wait()
 
186
            except IOError as e:
 
187
                raise PGPError(e)
 
188
        self.gnupg.passphrase = None
200
189
        return ciphertext
201
190
    
202
191
    def decrypt(self, data, password):
203
 
        passphrase = self.password_encode(password)
204
 
        with tempfile.NamedTemporaryFile(dir = self.tempdir
205
 
                                         ) as passfile:
206
 
            passfile.write(passphrase)
207
 
            passfile.flush()
208
 
            proc = subprocess.Popen(['gpg', '--decrypt',
209
 
                                     '--passphrase-file',
210
 
                                     passfile.name]
211
 
                                    + self.gnupgargs,
212
 
                                    stdin = subprocess.PIPE,
213
 
                                    stdout = subprocess.PIPE,
214
 
                                    stderr = subprocess.PIPE)
215
 
            decrypted_plaintext, err = proc.communicate(input
216
 
                                                        = data)
217
 
        if proc.returncode != 0:
218
 
            raise PGPError(err)
 
192
        self.gnupg.passphrase = self.password_encode(password)
 
193
        with open(os.devnull) as devnull:
 
194
            try:
 
195
                proc = self.gnupg.run(['--decrypt'],
 
196
                                      create_fhs=['stdin', 'stdout'],
 
197
                                      attach_fhs={'stderr': devnull})
 
198
                with contextlib.closing(proc.handles['stdin'] ) as f:
 
199
                    f.write(data)
 
200
                with contextlib.closing(proc.handles['stdout']) as f:
 
201
                    decrypted_plaintext = f.read()
 
202
                proc.wait()
 
203
            except IOError as e:
 
204
                raise PGPError(e)
 
205
        self.gnupg.passphrase = None
219
206
        return decrypted_plaintext
220
207
 
221
208
 
 
209
 
222
210
class AvahiError(Exception):
223
211
    def __init__(self, value, *args, **kwargs):
224
212
        self.value = value
225
 
        return super(AvahiError, self).__init__(value, *args,
226
 
                                                **kwargs)
 
213
        super(AvahiError, self).__init__(value, *args, **kwargs)
 
214
    def __unicode__(self):
 
215
        return unicode(repr(self.value))
227
216
 
228
217
class AvahiServiceError(AvahiError):
229
218
    pass
240
229
               Used to optionally bind to the specified interface.
241
230
    name: string; Example: 'Mandos'
242
231
    type: string; Example: '_mandos._tcp'.
243
 
     See <https://www.iana.org/assignments/service-names-port-numbers>
 
232
                  See <http://www.dns-sd.org/ServiceTypes.html>
244
233
    port: integer; what port to announce
245
234
    TXT: list of strings; TXT record for the service
246
235
    domain: string; Domain to publish on, default to .local if empty.
252
241
    server: D-Bus Server
253
242
    bus: dbus.SystemBus()
254
243
    """
255
 
    
256
244
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
257
245
                 servicetype = None, port = None, TXT = None,
258
246
                 domain = "", host = "", max_renames = 32768,
271
259
        self.server = None
272
260
        self.bus = bus
273
261
        self.entry_group_state_changed_match = None
274
 
    
275
262
    def rename(self):
276
263
        """Derived from the Avahi example code"""
277
264
        if self.rename_count >= self.max_renames:
287
274
        try:
288
275
            self.add()
289
276
        except dbus.exceptions.DBusException as error:
290
 
            logger.critical("D-Bus Exception", exc_info=error)
 
277
            logger.critical("DBusException: %s", error)
291
278
            self.cleanup()
292
279
            os._exit(1)
293
280
        self.rename_count += 1
294
 
    
295
281
    def remove(self):
296
282
        """Derived from the Avahi example code"""
297
283
        if self.entry_group_state_changed_match is not None:
299
285
            self.entry_group_state_changed_match = None
300
286
        if self.group is not None:
301
287
            self.group.Reset()
302
 
    
303
288
    def add(self):
304
289
        """Derived from the Avahi example code"""
305
290
        self.remove()
322
307
            dbus.UInt16(self.port),
323
308
            avahi.string_array_to_txt_array(self.TXT))
324
309
        self.group.Commit()
325
 
    
326
310
    def entry_group_state_changed(self, state, error):
327
311
        """Derived from the Avahi example code"""
328
312
        logger.debug("Avahi entry group state change: %i", state)
335
319
        elif state == avahi.ENTRY_GROUP_FAILURE:
336
320
            logger.critical("Avahi: Error in group state changed %s",
337
321
                            unicode(error))
338
 
            raise AvahiGroupError("State changed: {!s}"
339
 
                                  .format(error))
340
 
    
 
322
            raise AvahiGroupError("State changed: %s"
 
323
                                  % unicode(error))
341
324
    def cleanup(self):
342
325
        """Derived from the Avahi example code"""
343
326
        if self.group is not None:
348
331
                pass
349
332
            self.group = None
350
333
        self.remove()
351
 
    
352
334
    def server_state_changed(self, state, error=None):
353
335
        """Derived from the Avahi example code"""
354
336
        logger.debug("Avahi server state change: %i", state)
373
355
                logger.debug("Unknown state: %r", state)
374
356
            else:
375
357
                logger.debug("Unknown state: %r: %r", state, error)
376
 
    
377
358
    def activate(self):
378
359
        """Derived from the Avahi example code"""
379
360
        if self.server is None:
386
367
                                 self.server_state_changed)
387
368
        self.server_state_changed(self.server.GetState())
388
369
 
389
 
 
390
370
class AvahiServiceToSyslog(AvahiService):
391
371
    def rename(self):
392
372
        """Add the new name to the syslog messages"""
393
373
        ret = AvahiService.rename(self)
394
374
        syslogger.setFormatter(logging.Formatter
395
 
                               ('Mandos ({}) [%(process)d]:'
396
 
                                ' %(levelname)s: %(message)s'
397
 
                                .format(self.name)))
 
375
                               ('Mandos (%s) [%%(process)d]:'
 
376
                                ' %%(levelname)s: %%(message)s'
 
377
                                % self.name))
398
378
        return ret
399
379
 
400
 
 
 
380
def timedelta_to_milliseconds(td):
 
381
    "Convert a datetime.timedelta() to milliseconds"
 
382
    return ((td.days * 24 * 60 * 60 * 1000)
 
383
            + (td.seconds * 1000)
 
384
            + (td.microseconds // 1000))
 
385
        
401
386
class Client(object):
402
387
    """A representation of a client host served by this server.
403
388
    
428
413
    last_checked_ok: datetime.datetime(); (UTC) or None
429
414
    last_checker_status: integer between 0 and 255 reflecting exit
430
415
                         status of last checker. -1 reflects crashed
431
 
                         checker, -2 means no checker completed yet.
 
416
                         checker, or None.
432
417
    last_enabled: datetime.datetime(); (UTC) or None
433
418
    name:       string; from the config file, used in log messages and
434
419
                        D-Bus identifiers
435
420
    secret:     bytestring; sent verbatim (over TLS) to client
436
421
    timeout:    datetime.timedelta(); How long from last_checked_ok
437
422
                                      until this client is disabled
438
 
    extended_timeout:   extra long timeout when secret has been sent
 
423
    extended_timeout:   extra long timeout when password has been sent
439
424
    runtime_expansions: Allowed attributes for runtime expansion.
440
425
    expires:    datetime.datetime(); time (UTC) when a client will be
441
426
                disabled, or None
442
 
    server_settings: The server_settings dict from main()
443
427
    """
444
428
    
445
429
    runtime_expansions = ("approval_delay", "approval_duration",
446
 
                          "created", "enabled", "expires",
447
 
                          "fingerprint", "host", "interval",
448
 
                          "last_approval_request", "last_checked_ok",
 
430
                          "created", "enabled", "fingerprint",
 
431
                          "host", "interval", "last_checked_ok",
449
432
                          "last_enabled", "name", "timeout")
450
 
    client_defaults = { "timeout": "PT5M",
451
 
                        "extended_timeout": "PT15M",
452
 
                        "interval": "PT2M",
 
433
    client_defaults = { "timeout": "5m",
 
434
                        "extended_timeout": "15m",
 
435
                        "interval": "2m",
453
436
                        "checker": "fping -q -- %%(host)s",
454
437
                        "host": "",
455
 
                        "approval_delay": "PT0S",
456
 
                        "approval_duration": "PT1S",
 
438
                        "approval_delay": "0s",
 
439
                        "approval_duration": "1s",
457
440
                        "approved_by_default": "True",
458
441
                        "enabled": "True",
459
442
                        }
460
443
    
 
444
    def timeout_milliseconds(self):
 
445
        "Return the 'timeout' attribute in milliseconds"
 
446
        return timedelta_to_milliseconds(self.timeout)
 
447
    
 
448
    def extended_timeout_milliseconds(self):
 
449
        "Return the 'extended_timeout' attribute in milliseconds"
 
450
        return timedelta_to_milliseconds(self.extended_timeout)
 
451
    
 
452
    def interval_milliseconds(self):
 
453
        "Return the 'interval' attribute in milliseconds"
 
454
        return timedelta_to_milliseconds(self.interval)
 
455
    
 
456
    def approval_delay_milliseconds(self):
 
457
        return timedelta_to_milliseconds(self.approval_delay)
 
458
 
461
459
    @staticmethod
462
460
    def config_parser(config):
463
 
        """Construct a new dict of client settings of this form:
 
461
        """ Construct a new dict of client settings of this form:
464
462
        { client_name: {setting_name: value, ...}, ...}
465
 
        with exceptions for any special settings as defined above.
466
 
        NOTE: Must be a pure function. Must return the same result
467
 
        value given the same arguments.
468
 
        """
 
463
        with exceptions for any special settings as defined above"""
469
464
        settings = {}
470
465
        for client_name in config.sections():
471
466
            section = dict(config.items(client_name))
475
470
            # Reformat values from string types to Python types
476
471
            client["approved_by_default"] = config.getboolean(
477
472
                client_name, "approved_by_default")
478
 
            client["enabled"] = config.getboolean(client_name,
479
 
                                                  "enabled")
 
473
            client["enabled"] = config.getboolean(client_name, "enabled")
480
474
            
481
475
            client["fingerprint"] = (section["fingerprint"].upper()
482
476
                                     .replace(" ", ""))
488
482
                          "rb") as secfile:
489
483
                    client["secret"] = secfile.read()
490
484
            else:
491
 
                raise TypeError("No secret or secfile for section {}"
492
 
                                .format(section))
 
485
                raise TypeError("No secret or secfile for section %s"
 
486
                                % section)
493
487
            client["timeout"] = string_to_delta(section["timeout"])
494
488
            client["extended_timeout"] = string_to_delta(
495
489
                section["extended_timeout"])
501
495
            client["checker_command"] = section["checker"]
502
496
            client["last_approval_request"] = None
503
497
            client["last_checked_ok"] = None
504
 
            client["last_checker_status"] = -2
505
 
        
 
498
            client["last_checker_status"] = None
 
499
            if client["enabled"]:
 
500
                client["last_enabled"] = datetime.datetime.utcnow()
 
501
                client["expires"] = (datetime.datetime.utcnow()
 
502
                                     + client["timeout"])
 
503
            else:
 
504
                client["last_enabled"] = None
 
505
                client["expires"] = None
 
506
 
506
507
        return settings
507
 
    
508
 
    def __init__(self, settings, name = None, server_settings=None):
 
508
        
 
509
        
 
510
    def __init__(self, settings, name = None):
 
511
        """Note: the 'checker' key in 'config' sets the
 
512
        'checker_command' attribute and *not* the 'checker'
 
513
        attribute."""
509
514
        self.name = name
510
 
        if server_settings is None:
511
 
            server_settings = {}
512
 
        self.server_settings = server_settings
513
515
        # adding all client settings
514
 
        for setting, value in settings.items():
 
516
        for setting, value in settings.iteritems():
515
517
            setattr(self, setting, value)
516
518
        
517
 
        if self.enabled:
518
 
            if not hasattr(self, "last_enabled"):
519
 
                self.last_enabled = datetime.datetime.utcnow()
520
 
            if not hasattr(self, "expires"):
521
 
                self.expires = (datetime.datetime.utcnow()
522
 
                                + self.timeout)
523
 
        else:
524
 
            self.last_enabled = None
525
 
            self.expires = None
526
 
        
527
519
        logger.debug("Creating client %r", self.name)
528
520
        # Uppercase and remove spaces from fingerprint for later
529
521
        # comparison purposes with return value from the fingerprint()
530
522
        # function
531
523
        logger.debug("  Fingerprint: %s", self.fingerprint)
532
 
        self.created = settings.get("created",
533
 
                                    datetime.datetime.utcnow())
534
 
        
 
524
        self.created = settings.get("created", datetime.datetime.utcnow())
 
525
 
535
526
        # attributes specific for this server instance
536
527
        self.checker = None
537
528
        self.checker_initiator_tag = None
565
556
        if getattr(self, "enabled", False):
566
557
            # Already enabled
567
558
            return
 
559
        self.send_changedstate()
568
560
        self.expires = datetime.datetime.utcnow() + self.timeout
569
561
        self.enabled = True
570
562
        self.last_enabled = datetime.datetime.utcnow()
571
563
        self.init_checker()
572
 
        self.send_changedstate()
573
564
    
574
565
    def disable(self, quiet=True):
575
566
        """Disable this client."""
576
567
        if not getattr(self, "enabled", False):
577
568
            return False
578
569
        if not quiet:
 
570
            self.send_changedstate()
 
571
        if not quiet:
579
572
            logger.info("Disabling client %s", self.name)
580
 
        if getattr(self, "disable_initiator_tag", None) is not None:
 
573
        if getattr(self, "disable_initiator_tag", False):
581
574
            gobject.source_remove(self.disable_initiator_tag)
582
575
            self.disable_initiator_tag = None
583
576
        self.expires = None
584
 
        if getattr(self, "checker_initiator_tag", None) is not None:
 
577
        if getattr(self, "checker_initiator_tag", False):
585
578
            gobject.source_remove(self.checker_initiator_tag)
586
579
            self.checker_initiator_tag = None
587
580
        self.stop_checker()
588
581
        self.enabled = False
589
 
        if not quiet:
590
 
            self.send_changedstate()
591
582
        # Do not run this again if called by a gobject.timeout_add
592
583
        return False
593
584
    
597
588
    def init_checker(self):
598
589
        # Schedule a new checker to be started an 'interval' from now,
599
590
        # and every interval from then on.
600
 
        if self.checker_initiator_tag is not None:
601
 
            gobject.source_remove(self.checker_initiator_tag)
602
591
        self.checker_initiator_tag = (gobject.timeout_add
603
 
                                      (int(self.interval
604
 
                                           .total_seconds() * 1000),
 
592
                                      (self.interval_milliseconds(),
605
593
                                       self.start_checker))
606
594
        # Schedule a disable() when 'timeout' has passed
607
 
        if self.disable_initiator_tag is not None:
608
 
            gobject.source_remove(self.disable_initiator_tag)
609
595
        self.disable_initiator_tag = (gobject.timeout_add
610
 
                                      (int(self.timeout
611
 
                                           .total_seconds() * 1000),
612
 
                                       self.disable))
 
596
                                   (self.timeout_milliseconds(),
 
597
                                    self.disable))
613
598
        # Also start a new checker *right now*.
614
599
        self.start_checker()
615
600
    
631
616
            logger.warning("Checker for %(name)s crashed?",
632
617
                           vars(self))
633
618
    
634
 
    def checked_ok(self):
635
 
        """Assert that the client has been seen, alive and well."""
636
 
        self.last_checked_ok = datetime.datetime.utcnow()
637
 
        self.last_checker_status = 0
638
 
        self.bump_timeout()
639
 
    
640
 
    def bump_timeout(self, timeout=None):
641
 
        """Bump up the timeout for this client."""
 
619
    def checked_ok(self, timeout=None):
 
620
        """Bump up the timeout for this client.
 
621
        
 
622
        This should only be called when the client has been seen,
 
623
        alive and well.
 
624
        """
642
625
        if timeout is None:
643
626
            timeout = self.timeout
 
627
        self.last_checked_ok = datetime.datetime.utcnow()
644
628
        if self.disable_initiator_tag is not None:
645
629
            gobject.source_remove(self.disable_initiator_tag)
646
 
            self.disable_initiator_tag = None
647
630
        if getattr(self, "enabled", False):
648
631
            self.disable_initiator_tag = (gobject.timeout_add
649
 
                                          (int(timeout.total_seconds()
650
 
                                               * 1000), self.disable))
 
632
                                          (timedelta_to_milliseconds
 
633
                                           (timeout), self.disable))
651
634
            self.expires = datetime.datetime.utcnow() + timeout
652
635
    
653
636
    def need_approval(self):
659
642
        If a checker already exists, leave it running and do
660
643
        nothing."""
661
644
        # The reason for not killing a running checker is that if we
662
 
        # did that, and if a checker (for some reason) started running
663
 
        # slowly and taking more than 'interval' time, then the client
664
 
        # would inevitably timeout, since no checker would get a
665
 
        # chance to run to completion.  If we instead leave running
 
645
        # did that, then if a checker (for some reason) started
 
646
        # running slowly and taking more than 'interval' time, the
 
647
        # client would inevitably timeout, since no checker would get
 
648
        # a chance to run to completion.  If we instead leave running
666
649
        # checkers alone, the checker would have to take more time
667
650
        # than 'timeout' for the client to be disabled, which is as it
668
651
        # should be.
670
653
        # If a checker exists, make sure it is not a zombie
671
654
        try:
672
655
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
673
 
        except AttributeError:
674
 
            pass
675
 
        except OSError as error:
676
 
            if error.errno != errno.ECHILD:
677
 
                raise
 
656
        except (AttributeError, OSError) as error:
 
657
            if (isinstance(error, OSError)
 
658
                and error.errno != errno.ECHILD):
 
659
                raise error
678
660
        else:
679
661
            if pid:
680
662
                logger.warning("Checker was a zombie")
683
665
                                      self.current_checker_command)
684
666
        # Start a new checker if needed
685
667
        if self.checker is None:
686
 
            # Escape attributes for the shell
687
 
            escaped_attrs = { attr:
688
 
                                  re.escape(unicode(getattr(self,
689
 
                                                            attr)))
690
 
                              for attr in self.runtime_expansions }
691
668
            try:
692
 
                command = self.checker_command % escaped_attrs
693
 
            except TypeError as error:
694
 
                logger.error('Could not format string "%s"',
695
 
                             self.checker_command, exc_info=error)
696
 
                return True # Try again later
 
669
                # In case checker_command has exactly one % operator
 
670
                command = self.checker_command % self.host
 
671
            except TypeError:
 
672
                # Escape attributes for the shell
 
673
                escaped_attrs = dict(
 
674
                    (attr,
 
675
                     re.escape(unicode(str(getattr(self, attr, "")),
 
676
                                       errors=
 
677
                                       'replace')))
 
678
                    for attr in
 
679
                    self.runtime_expansions)
 
680
                
 
681
                try:
 
682
                    command = self.checker_command % escaped_attrs
 
683
                except TypeError as error:
 
684
                    logger.error('Could not format string "%s":'
 
685
                                 ' %s', self.checker_command, error)
 
686
                    return True # Try again later
697
687
            self.current_checker_command = command
698
688
            try:
699
689
                logger.info("Starting checker %r for %s",
702
692
                # in normal mode, that is already done by daemon(),
703
693
                # and in debug mode we don't want to.  (Stdin is
704
694
                # always replaced by /dev/null.)
705
 
                # The exception is when not debugging but nevertheless
706
 
                # running in the foreground; use the previously
707
 
                # created wnull.
708
 
                popen_args = {}
709
 
                if (not self.server_settings["debug"]
710
 
                    and self.server_settings["foreground"]):
711
 
                    popen_args.update({"stdout": wnull,
712
 
                                       "stderr": wnull })
713
695
                self.checker = subprocess.Popen(command,
714
696
                                                close_fds=True,
715
 
                                                shell=True, cwd="/",
716
 
                                                **popen_args)
717
 
            except OSError as error:
718
 
                logger.error("Failed to start subprocess",
719
 
                             exc_info=error)
720
 
                return True
721
 
            self.checker_callback_tag = (gobject.child_watch_add
722
 
                                         (self.checker.pid,
723
 
                                          self.checker_callback,
724
 
                                          data=command))
725
 
            # The checker may have completed before the gobject
726
 
            # watch was added.  Check for this.
727
 
            try:
 
697
                                                shell=True, cwd="/")
 
698
                self.checker_callback_tag = (gobject.child_watch_add
 
699
                                             (self.checker.pid,
 
700
                                              self.checker_callback,
 
701
                                              data=command))
 
702
                # The checker may have completed before the gobject
 
703
                # watch was added.  Check for this.
728
704
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
705
                if pid:
 
706
                    gobject.source_remove(self.checker_callback_tag)
 
707
                    self.checker_callback(pid, status, command)
729
708
            except OSError as error:
730
 
                if error.errno == errno.ECHILD:
731
 
                    # This should never happen
732
 
                    logger.error("Child process vanished",
733
 
                                 exc_info=error)
734
 
                    return True
735
 
                raise
736
 
            if pid:
737
 
                gobject.source_remove(self.checker_callback_tag)
738
 
                self.checker_callback(pid, status, command)
 
709
                logger.error("Failed to start subprocess: %s",
 
710
                             error)
739
711
        # Re-run this periodically if run by gobject.timeout_add
740
712
        return True
741
713
    
748
720
            return
749
721
        logger.debug("Stopping checker for %(name)s", vars(self))
750
722
        try:
751
 
            self.checker.terminate()
 
723
            os.kill(self.checker.pid, signal.SIGTERM)
752
724
            #time.sleep(0.5)
753
725
            #if self.checker.poll() is None:
754
 
            #    self.checker.kill()
 
726
            #    os.kill(self.checker.pid, signal.SIGKILL)
755
727
        except OSError as error:
756
728
            if error.errno != errno.ESRCH: # No such process
757
729
                raise
774
746
    # "Set" method, so we fail early here:
775
747
    if byte_arrays and signature != "ay":
776
748
        raise ValueError("Byte arrays not supported for non-'ay'"
777
 
                         " signature {!r}".format(signature))
 
749
                         " signature %r" % signature)
778
750
    def decorator(func):
779
751
        func._dbus_is_property = True
780
752
        func._dbus_interface = dbus_interface
788
760
    return decorator
789
761
 
790
762
 
791
 
def dbus_interface_annotations(dbus_interface):
792
 
    """Decorator for marking functions returning interface annotations
793
 
    
794
 
    Usage:
795
 
    
796
 
    @dbus_interface_annotations("org.example.Interface")
797
 
    def _foo(self):  # Function name does not matter
798
 
        return {"org.freedesktop.DBus.Deprecated": "true",
799
 
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
800
 
                    "false"}
801
 
    """
802
 
    def decorator(func):
803
 
        func._dbus_is_interface = True
804
 
        func._dbus_interface = dbus_interface
805
 
        func._dbus_name = dbus_interface
806
 
        return func
807
 
    return decorator
808
 
 
809
 
 
810
 
def dbus_annotations(annotations):
811
 
    """Decorator to annotate D-Bus methods, signals or properties
812
 
    Usage:
813
 
    
814
 
    @dbus_service_property("org.example.Interface", signature="b",
815
 
                           access="r")
816
 
    @dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
817
 
                        "org.freedesktop.DBus.Property."
818
 
                        "EmitsChangedSignal": "false"})
819
 
    def Property_dbus_property(self):
820
 
        return dbus.Boolean(False)
821
 
    """
822
 
    def decorator(func):
823
 
        func._dbus_annotations = annotations
824
 
        return func
825
 
    return decorator
826
 
 
827
 
 
828
763
class DBusPropertyException(dbus.exceptions.DBusException):
829
764
    """A base class for D-Bus property-related exceptions
830
765
    """
831
 
    pass
 
766
    def __unicode__(self):
 
767
        return unicode(str(self))
 
768
 
832
769
 
833
770
class DBusPropertyAccessException(DBusPropertyException):
834
771
    """A property's access permissions disallows an operation.
851
788
    """
852
789
    
853
790
    @staticmethod
854
 
    def _is_dbus_thing(thing):
855
 
        """Returns a function testing if an attribute is a D-Bus thing
856
 
        
857
 
        If called like _is_dbus_thing("method") it returns a function
858
 
        suitable for use as predicate to inspect.getmembers().
859
 
        """
860
 
        return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
861
 
                                   False)
 
791
    def _is_dbus_property(obj):
 
792
        return getattr(obj, "_dbus_is_property", False)
862
793
    
863
 
    def _get_all_dbus_things(self, thing):
 
794
    def _get_all_dbus_properties(self):
864
795
        """Returns a generator of (name, attribute) pairs
865
796
        """
866
 
        return ((getattr(athing.__get__(self), "_dbus_name",
867
 
                         name),
868
 
                 athing.__get__(self))
 
797
        return ((prop.__get__(self)._dbus_name, prop.__get__(self))
869
798
                for cls in self.__class__.__mro__
870
 
                for name, athing in
871
 
                inspect.getmembers(cls,
872
 
                                   self._is_dbus_thing(thing)))
 
799
                for name, prop in
 
800
                inspect.getmembers(cls, self._is_dbus_property))
873
801
    
874
802
    def _get_dbus_property(self, interface_name, property_name):
875
803
        """Returns a bound method if one exists which is a D-Bus
877
805
        """
878
806
        for cls in  self.__class__.__mro__:
879
807
            for name, value in (inspect.getmembers
880
 
                                (cls,
881
 
                                 self._is_dbus_thing("property"))):
 
808
                                (cls, self._is_dbus_property)):
882
809
                if (value._dbus_name == property_name
883
810
                    and value._dbus_interface == interface_name):
884
811
                    return value.__get__(self)
912
839
            # The byte_arrays option is not supported yet on
913
840
            # signatures other than "ay".
914
841
            if prop._dbus_signature != "ay":
915
 
                raise ValueError("Byte arrays not supported for non-"
916
 
                                 "'ay' signature {!r}"
917
 
                                 .format(prop._dbus_signature))
918
 
            value = dbus.ByteArray(b''.join(chr(byte)
919
 
                                            for byte in value))
 
842
                raise ValueError
 
843
            value = dbus.ByteArray(''.join(unichr(byte)
 
844
                                           for byte in value))
920
845
        prop(value)
921
846
    
922
847
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
928
853
        Note: Will not include properties with access="write".
929
854
        """
930
855
        properties = {}
931
 
        for name, prop in self._get_all_dbus_things("property"):
 
856
        for name, prop in self._get_all_dbus_properties():
932
857
            if (interface_name
933
858
                and interface_name != prop._dbus_interface):
934
859
                # Interface non-empty but did not match
949
874
                         path_keyword='object_path',
950
875
                         connection_keyword='connection')
951
876
    def Introspect(self, object_path, connection):
952
 
        """Overloading of standard D-Bus method.
953
 
        
954
 
        Inserts property tags and interface annotation tags.
 
877
        """Standard D-Bus method, overloaded to insert property tags.
955
878
        """
956
879
        xmlstring = dbus.service.Object.Introspect(self, object_path,
957
880
                                                   connection)
964
887
                e.setAttribute("access", prop._dbus_access)
965
888
                return e
966
889
            for if_tag in document.getElementsByTagName("interface"):
967
 
                # Add property tags
968
890
                for tag in (make_tag(document, name, prop)
969
891
                            for name, prop
970
 
                            in self._get_all_dbus_things("property")
 
892
                            in self._get_all_dbus_properties()
971
893
                            if prop._dbus_interface
972
894
                            == if_tag.getAttribute("name")):
973
895
                    if_tag.appendChild(tag)
974
 
                # Add annotation tags
975
 
                for typ in ("method", "signal", "property"):
976
 
                    for tag in if_tag.getElementsByTagName(typ):
977
 
                        annots = dict()
978
 
                        for name, prop in (self.
979
 
                                           _get_all_dbus_things(typ)):
980
 
                            if (name == tag.getAttribute("name")
981
 
                                and prop._dbus_interface
982
 
                                == if_tag.getAttribute("name")):
983
 
                                annots.update(getattr
984
 
                                              (prop,
985
 
                                               "_dbus_annotations",
986
 
                                               {}))
987
 
                        for name, value in annots.items():
988
 
                            ann_tag = document.createElement(
989
 
                                "annotation")
990
 
                            ann_tag.setAttribute("name", name)
991
 
                            ann_tag.setAttribute("value", value)
992
 
                            tag.appendChild(ann_tag)
993
 
                # Add interface annotation tags
994
 
                for annotation, value in dict(
995
 
                    itertools.chain.from_iterable(
996
 
                        annotations().items()
997
 
                        for name, annotations in
998
 
                        self._get_all_dbus_things("interface")
999
 
                        if name == if_tag.getAttribute("name")
1000
 
                        )).items():
1001
 
                    ann_tag = document.createElement("annotation")
1002
 
                    ann_tag.setAttribute("name", annotation)
1003
 
                    ann_tag.setAttribute("value", value)
1004
 
                    if_tag.appendChild(ann_tag)
1005
896
                # Add the names to the return values for the
1006
897
                # "org.freedesktop.DBus.Properties" methods
1007
898
                if (if_tag.getAttribute("name")
1022
913
        except (AttributeError, xml.dom.DOMException,
1023
914
                xml.parsers.expat.ExpatError) as error:
1024
915
            logger.error("Failed to override Introspection method",
1025
 
                         exc_info=error)
 
916
                         error)
1026
917
        return xmlstring
1027
918
 
1028
919
 
1029
 
def datetime_to_dbus(dt, variant_level=0):
 
920
def datetime_to_dbus (dt, variant_level=0):
1030
921
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1031
922
    if dt is None:
1032
923
        return dbus.String("", variant_level = variant_level)
1034
925
                       variant_level=variant_level)
1035
926
 
1036
927
 
1037
 
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1038
 
    """A class decorator; applied to a subclass of
1039
 
    dbus.service.Object, it will add alternate D-Bus attributes with
1040
 
    interface names according to the "alt_interface_names" mapping.
1041
 
    Usage:
1042
 
    
1043
 
    @alternate_dbus_interfaces({"org.example.Interface":
1044
 
                                    "net.example.AlternateInterface"})
1045
 
    class SampleDBusObject(dbus.service.Object):
1046
 
        @dbus.service.method("org.example.Interface")
1047
 
        def SampleDBusMethod():
1048
 
            pass
1049
 
    
1050
 
    The above "SampleDBusMethod" on "SampleDBusObject" will be
1051
 
    reachable via two interfaces: "org.example.Interface" and
1052
 
    "net.example.AlternateInterface", the latter of which will have
1053
 
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1054
 
    "true", unless "deprecate" is passed with a False value.
1055
 
    
1056
 
    This works for methods and signals, and also for D-Bus properties
1057
 
    (from DBusObjectWithProperties) and interfaces (from the
1058
 
    dbus_interface_annotations decorator).
 
928
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
 
929
                                  .__metaclass__):
 
930
    """Applied to an empty subclass of a D-Bus object, this metaclass
 
931
    will add additional D-Bus attributes matching a certain pattern.
1059
932
    """
1060
 
    def wrapper(cls):
1061
 
        for orig_interface_name, alt_interface_name in (
1062
 
            alt_interface_names.items()):
1063
 
            attr = {}
1064
 
            interface_names = set()
1065
 
            # Go though all attributes of the class
1066
 
            for attrname, attribute in inspect.getmembers(cls):
 
933
    def __new__(mcs, name, bases, attr):
 
934
        # Go through all the base classes which could have D-Bus
 
935
        # methods, signals, or properties in them
 
936
        for base in (b for b in bases
 
937
                     if issubclass(b, dbus.service.Object)):
 
938
            # Go though all attributes of the base class
 
939
            for attrname, attribute in inspect.getmembers(base):
1067
940
                # Ignore non-D-Bus attributes, and D-Bus attributes
1068
941
                # with the wrong interface name
1069
942
                if (not hasattr(attribute, "_dbus_interface")
1070
943
                    or not attribute._dbus_interface
1071
 
                    .startswith(orig_interface_name)):
 
944
                    .startswith("se.recompile.Mandos")):
1072
945
                    continue
1073
946
                # Create an alternate D-Bus interface name based on
1074
947
                # the current name
1075
948
                alt_interface = (attribute._dbus_interface
1076
 
                                 .replace(orig_interface_name,
1077
 
                                          alt_interface_name))
1078
 
                interface_names.add(alt_interface)
 
949
                                 .replace("se.recompile.Mandos",
 
950
                                          "se.bsnet.fukt.Mandos"))
1079
951
                # Is this a D-Bus signal?
1080
952
                if getattr(attribute, "_dbus_is_signal", False):
1081
 
                    # Extract the original non-method undecorated
1082
 
                    # function by black magic
 
953
                    # Extract the original non-method function by
 
954
                    # black magic
1083
955
                    nonmethod_func = (dict(
1084
956
                            zip(attribute.func_code.co_freevars,
1085
957
                                attribute.__closure__))["func"]
1096
968
                                nonmethod_func.func_name,
1097
969
                                nonmethod_func.func_defaults,
1098
970
                                nonmethod_func.func_closure)))
1099
 
                    # Copy annotations, if any
1100
 
                    try:
1101
 
                        new_function._dbus_annotations = (
1102
 
                            dict(attribute._dbus_annotations))
1103
 
                    except AttributeError:
1104
 
                        pass
1105
971
                    # Define a creator of a function to call both the
1106
 
                    # original and alternate functions, so both the
1107
 
                    # original and alternate signals gets sent when
1108
 
                    # the function is called
 
972
                    # old and new functions, so both the old and new
 
973
                    # signals gets sent when the function is called
1109
974
                    def fixscope(func1, func2):
1110
975
                        """This function is a scope container to pass
1111
976
                        func1 and func2 to the "call_both" function
1118
983
                        return call_both
1119
984
                    # Create the "call_both" function and add it to
1120
985
                    # the class
1121
 
                    attr[attrname] = fixscope(attribute, new_function)
 
986
                    attr[attrname] = fixscope(attribute,
 
987
                                              new_function)
1122
988
                # Is this a D-Bus method?
1123
989
                elif getattr(attribute, "_dbus_is_method", False):
1124
990
                    # Create a new, but exactly alike, function
1135
1001
                                        attribute.func_name,
1136
1002
                                        attribute.func_defaults,
1137
1003
                                        attribute.func_closure)))
1138
 
                    # Copy annotations, if any
1139
 
                    try:
1140
 
                        attr[attrname]._dbus_annotations = (
1141
 
                            dict(attribute._dbus_annotations))
1142
 
                    except AttributeError:
1143
 
                        pass
1144
1004
                # Is this a D-Bus property?
1145
1005
                elif getattr(attribute, "_dbus_is_property", False):
1146
1006
                    # Create a new, but exactly alike, function
1160
1020
                                        attribute.func_name,
1161
1021
                                        attribute.func_defaults,
1162
1022
                                        attribute.func_closure)))
1163
 
                    # Copy annotations, if any
1164
 
                    try:
1165
 
                        attr[attrname]._dbus_annotations = (
1166
 
                            dict(attribute._dbus_annotations))
1167
 
                    except AttributeError:
1168
 
                        pass
1169
 
                # Is this a D-Bus interface?
1170
 
                elif getattr(attribute, "_dbus_is_interface", False):
1171
 
                    # Create a new, but exactly alike, function
1172
 
                    # object.  Decorate it to be a new D-Bus interface
1173
 
                    # with the alternate D-Bus interface name.  Add it
1174
 
                    # to the class.
1175
 
                    attr[attrname] = (dbus_interface_annotations
1176
 
                                      (alt_interface)
1177
 
                                      (types.FunctionType
1178
 
                                       (attribute.func_code,
1179
 
                                        attribute.func_globals,
1180
 
                                        attribute.func_name,
1181
 
                                        attribute.func_defaults,
1182
 
                                        attribute.func_closure)))
1183
 
            if deprecate:
1184
 
                # Deprecate all alternate interfaces
1185
 
                iname="_AlternateDBusNames_interface_annotation{}"
1186
 
                for interface_name in interface_names:
1187
 
                    @dbus_interface_annotations(interface_name)
1188
 
                    def func(self):
1189
 
                        return { "org.freedesktop.DBus.Deprecated":
1190
 
                                     "true" }
1191
 
                    # Find an unused name
1192
 
                    for aname in (iname.format(i)
1193
 
                                  for i in itertools.count()):
1194
 
                        if aname not in attr:
1195
 
                            attr[aname] = func
1196
 
                            break
1197
 
            if interface_names:
1198
 
                # Replace the class with a new subclass of it with
1199
 
                # methods, signals, etc. as created above.
1200
 
                cls = type(b"{}Alternate".format(cls.__name__),
1201
 
                           (cls,), attr)
1202
 
        return cls
1203
 
    return wrapper
1204
 
 
1205
 
 
1206
 
@alternate_dbus_interfaces({"se.recompile.Mandos":
1207
 
                                "se.bsnet.fukt.Mandos"})
 
1023
        return type.__new__(mcs, name, bases, attr)
 
1024
 
 
1025
 
1208
1026
class ClientDBus(Client, DBusObjectWithProperties):
1209
1027
    """A Client class using D-Bus
1210
1028
    
1221
1039
    def __init__(self, bus = None, *args, **kwargs):
1222
1040
        self.bus = bus
1223
1041
        Client.__init__(self, *args, **kwargs)
 
1042
        self._approvals_pending = 0
 
1043
        
 
1044
        self._approvals_pending = 0
1224
1045
        # Only now, when this client is initialized, can it show up on
1225
1046
        # the D-Bus
1226
1047
        client_object_name = unicode(self.name).translate(
1230
1051
                                 ("/clients/" + client_object_name))
1231
1052
        DBusObjectWithProperties.__init__(self, self.bus,
1232
1053
                                          self.dbus_object_path)
1233
 
    
 
1054
        
1234
1055
    def notifychangeproperty(transform_func,
1235
1056
                             dbus_name, type_func=lambda x: x,
1236
1057
                             variant_level=1):
1244
1065
                   to the D-Bus.  Default: no transform
1245
1066
        variant_level: D-Bus variant level.  Default: 1
1246
1067
        """
1247
 
        attrname = "_{}".format(dbus_name)
 
1068
        attrname = "_{0}".format(dbus_name)
1248
1069
        def setter(self, value):
1249
1070
            if hasattr(self, "dbus_object_path"):
1250
1071
                if (not hasattr(self, attrname) or
1259
1080
        
1260
1081
        return property(lambda self: getattr(self, attrname), setter)
1261
1082
    
 
1083
    
1262
1084
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1263
1085
    approvals_pending = notifychangeproperty(dbus.Boolean,
1264
1086
                                             "ApprovalPending",
1271
1093
                                       checker is not None)
1272
1094
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1273
1095
                                           "LastCheckedOK")
1274
 
    last_checker_status = notifychangeproperty(dbus.Int16,
1275
 
                                               "LastCheckerStatus")
1276
1096
    last_approval_request = notifychangeproperty(
1277
1097
        datetime_to_dbus, "LastApprovalRequest")
1278
1098
    approved_by_default = notifychangeproperty(dbus.Boolean,
1280
1100
    approval_delay = notifychangeproperty(dbus.UInt64,
1281
1101
                                          "ApprovalDelay",
1282
1102
                                          type_func =
1283
 
                                          lambda td: td.total_seconds()
1284
 
                                          * 1000)
 
1103
                                          timedelta_to_milliseconds)
1285
1104
    approval_duration = notifychangeproperty(
1286
1105
        dbus.UInt64, "ApprovalDuration",
1287
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1106
        type_func = timedelta_to_milliseconds)
1288
1107
    host = notifychangeproperty(dbus.String, "Host")
1289
1108
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1290
 
                                   type_func = lambda td:
1291
 
                                       td.total_seconds() * 1000)
 
1109
                                   type_func =
 
1110
                                   timedelta_to_milliseconds)
1292
1111
    extended_timeout = notifychangeproperty(
1293
1112
        dbus.UInt64, "ExtendedTimeout",
1294
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1113
        type_func = timedelta_to_milliseconds)
1295
1114
    interval = notifychangeproperty(dbus.UInt64,
1296
1115
                                    "Interval",
1297
1116
                                    type_func =
1298
 
                                    lambda td: td.total_seconds()
1299
 
                                    * 1000)
 
1117
                                    timedelta_to_milliseconds)
1300
1118
    checker_command = notifychangeproperty(dbus.String, "Checker")
1301
1119
    
1302
1120
    del notifychangeproperty
1330
1148
                                       *args, **kwargs)
1331
1149
    
1332
1150
    def start_checker(self, *args, **kwargs):
1333
 
        old_checker_pid = getattr(self.checker, "pid", None)
 
1151
        old_checker = self.checker
 
1152
        if self.checker is not None:
 
1153
            old_checker_pid = self.checker.pid
 
1154
        else:
 
1155
            old_checker_pid = None
1334
1156
        r = Client.start_checker(self, *args, **kwargs)
1335
1157
        # Only if new checker process was started
1336
1158
        if (self.checker is not None
1344
1166
        return False
1345
1167
    
1346
1168
    def approve(self, value=True):
 
1169
        self.send_changedstate()
1347
1170
        self.approved = value
1348
 
        gobject.timeout_add(int(self.approval_duration.total_seconds()
1349
 
                                * 1000), self._reset_approved)
1350
 
        self.send_changedstate()
 
1171
        gobject.timeout_add(timedelta_to_milliseconds
 
1172
                            (self.approval_duration),
 
1173
                            self._reset_approved)
 
1174
    
1351
1175
    
1352
1176
    ## D-Bus methods, signals & properties
1353
1177
    _interface = "se.recompile.Mandos.Client"
1354
1178
    
1355
 
    ## Interfaces
1356
 
    
1357
 
    @dbus_interface_annotations(_interface)
1358
 
    def _foo(self):
1359
 
        return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1360
 
                     "false"}
1361
 
    
1362
1179
    ## Signals
1363
1180
    
1364
1181
    # CheckerCompleted - signal
1400
1217
        "D-Bus signal"
1401
1218
        return self.need_approval()
1402
1219
    
 
1220
    # NeRwequest - signal
 
1221
    @dbus.service.signal(_interface, signature="s")
 
1222
    def NewRequest(self, ip):
 
1223
        """D-Bus signal
 
1224
        Is sent after a client request a password.
 
1225
        """
 
1226
        pass
 
1227
    
1403
1228
    ## Methods
1404
1229
    
1405
1230
    # Approve - method
1455
1280
                           access="readwrite")
1456
1281
    def ApprovalDelay_dbus_property(self, value=None):
1457
1282
        if value is None:       # get
1458
 
            return dbus.UInt64(self.approval_delay.total_seconds()
1459
 
                               * 1000)
 
1283
            return dbus.UInt64(self.approval_delay_milliseconds())
1460
1284
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1461
1285
    
1462
1286
    # ApprovalDuration - property
1464
1288
                           access="readwrite")
1465
1289
    def ApprovalDuration_dbus_property(self, value=None):
1466
1290
        if value is None:       # get
1467
 
            return dbus.UInt64(self.approval_duration.total_seconds()
1468
 
                               * 1000)
 
1291
            return dbus.UInt64(timedelta_to_milliseconds(
 
1292
                    self.approval_duration))
1469
1293
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1470
1294
    
1471
1295
    # Name - property
1516
1340
            return
1517
1341
        return datetime_to_dbus(self.last_checked_ok)
1518
1342
    
1519
 
    # LastCheckerStatus - property
1520
 
    @dbus_service_property(_interface, signature="n",
1521
 
                           access="read")
1522
 
    def LastCheckerStatus_dbus_property(self):
1523
 
        return dbus.Int16(self.last_checker_status)
1524
 
    
1525
1343
    # Expires - property
1526
1344
    @dbus_service_property(_interface, signature="s", access="read")
1527
1345
    def Expires_dbus_property(self):
1537
1355
                           access="readwrite")
1538
1356
    def Timeout_dbus_property(self, value=None):
1539
1357
        if value is None:       # get
1540
 
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
1541
 
        old_timeout = self.timeout
 
1358
            return dbus.UInt64(self.timeout_milliseconds())
1542
1359
        self.timeout = datetime.timedelta(0, 0, 0, value)
1543
 
        # Reschedule disabling
1544
 
        if self.enabled:
1545
 
            now = datetime.datetime.utcnow()
1546
 
            self.expires += self.timeout - old_timeout
1547
 
            if self.expires <= now:
1548
 
                # The timeout has passed
1549
 
                self.disable()
1550
 
            else:
1551
 
                if (getattr(self, "disable_initiator_tag", None)
1552
 
                    is None):
1553
 
                    return
1554
 
                gobject.source_remove(self.disable_initiator_tag)
1555
 
                self.disable_initiator_tag = (
1556
 
                    gobject.timeout_add(
1557
 
                        int((self.expires - now).total_seconds()
1558
 
                            * 1000), self.disable))
 
1360
        if getattr(self, "disable_initiator_tag", None) is None:
 
1361
            return
 
1362
        # Reschedule timeout
 
1363
        gobject.source_remove(self.disable_initiator_tag)
 
1364
        self.disable_initiator_tag = None
 
1365
        self.expires = None
 
1366
        time_to_die = timedelta_to_milliseconds((self
 
1367
                                                 .last_checked_ok
 
1368
                                                 + self.timeout)
 
1369
                                                - datetime.datetime
 
1370
                                                .utcnow())
 
1371
        if time_to_die <= 0:
 
1372
            # The timeout has passed
 
1373
            self.disable()
 
1374
        else:
 
1375
            self.expires = (datetime.datetime.utcnow()
 
1376
                            + datetime.timedelta(milliseconds =
 
1377
                                                 time_to_die))
 
1378
            self.disable_initiator_tag = (gobject.timeout_add
 
1379
                                          (time_to_die, self.disable))
1559
1380
    
1560
1381
    # ExtendedTimeout - property
1561
1382
    @dbus_service_property(_interface, signature="t",
1562
1383
                           access="readwrite")
1563
1384
    def ExtendedTimeout_dbus_property(self, value=None):
1564
1385
        if value is None:       # get
1565
 
            return dbus.UInt64(self.extended_timeout.total_seconds()
1566
 
                               * 1000)
 
1386
            return dbus.UInt64(self.extended_timeout_milliseconds())
1567
1387
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1568
1388
    
1569
1389
    # Interval - property
1571
1391
                           access="readwrite")
1572
1392
    def Interval_dbus_property(self, value=None):
1573
1393
        if value is None:       # get
1574
 
            return dbus.UInt64(self.interval.total_seconds() * 1000)
 
1394
            return dbus.UInt64(self.interval_milliseconds())
1575
1395
        self.interval = datetime.timedelta(0, 0, 0, value)
1576
1396
        if getattr(self, "checker_initiator_tag", None) is None:
1577
1397
            return
1610
1430
    @dbus_service_property(_interface, signature="ay",
1611
1431
                           access="write", byte_arrays=True)
1612
1432
    def Secret_dbus_property(self, value):
1613
 
        self.secret = bytes(value)
 
1433
        self.secret = str(value)
1614
1434
    
1615
1435
    del _interface
1616
1436
 
1641
1461
        self._pipe.send(('setattr', name, value))
1642
1462
 
1643
1463
 
 
1464
class ClientDBusTransitional(ClientDBus):
 
1465
    __metaclass__ = AlternateDBusNamesMetaclass
 
1466
 
 
1467
 
1644
1468
class ClientHandler(socketserver.BaseRequestHandler, object):
1645
1469
    """A class to handle client connections.
1646
1470
    
1682
1506
            logger.debug("Protocol version: %r", line)
1683
1507
            try:
1684
1508
                if int(line.strip().split()[0]) > 1:
1685
 
                    raise RuntimeError(line)
 
1509
                    raise RuntimeError
1686
1510
            except (ValueError, IndexError, RuntimeError) as error:
1687
1511
                logger.error("Unknown protocol version: %s", error)
1688
1512
                return
1714
1538
                except KeyError:
1715
1539
                    return
1716
1540
                
 
1541
                if self.server.use_dbus:
 
1542
                    # Emit D-Bus signal
 
1543
                    client.NewRequest(str(self.client_address))
 
1544
                
1717
1545
                if client.approval_delay:
1718
1546
                    delay = client.approval_delay
1719
1547
                    client.approvals_pending += 1
1737
1565
                        if self.server.use_dbus:
1738
1566
                            # Emit D-Bus signal
1739
1567
                            client.NeedApproval(
1740
 
                                client.approval_delay.total_seconds()
1741
 
                                * 1000, client.approved_by_default)
 
1568
                                client.approval_delay_milliseconds(),
 
1569
                                client.approved_by_default)
1742
1570
                    else:
1743
1571
                        logger.warning("Client %s was not approved",
1744
1572
                                       client.name)
1750
1578
                    #wait until timeout or approved
1751
1579
                    time = datetime.datetime.now()
1752
1580
                    client.changedstate.acquire()
1753
 
                    client.changedstate.wait(delay.total_seconds())
 
1581
                    (client.changedstate.wait
 
1582
                     (float(client.timedelta_to_milliseconds(delay)
 
1583
                            / 1000)))
1754
1584
                    client.changedstate.release()
1755
1585
                    time2 = datetime.datetime.now()
1756
1586
                    if (time2 - time) >= delay:
1772
1602
                    try:
1773
1603
                        sent = session.send(client.secret[sent_size:])
1774
1604
                    except gnutls.errors.GNUTLSError as error:
1775
 
                        logger.warning("gnutls send failed",
1776
 
                                       exc_info=error)
 
1605
                        logger.warning("gnutls send failed")
1777
1606
                        return
1778
1607
                    logger.debug("Sent: %d, remaining: %d",
1779
1608
                                 sent, len(client.secret)
1782
1611
                
1783
1612
                logger.info("Sending secret to %s", client.name)
1784
1613
                # bump the timeout using extended_timeout
1785
 
                client.bump_timeout(client.extended_timeout)
 
1614
                client.checked_ok(client.extended_timeout)
1786
1615
                if self.server.use_dbus:
1787
1616
                    # Emit D-Bus signal
1788
1617
                    client.GotSecret()
1793
1622
                try:
1794
1623
                    session.bye()
1795
1624
                except gnutls.errors.GNUTLSError as error:
1796
 
                    logger.warning("GnuTLS bye failed",
1797
 
                                   exc_info=error)
 
1625
                    logger.warning("GnuTLS bye failed")
1798
1626
    
1799
1627
    @staticmethod
1800
1628
    def peer_certificate(session):
1872
1700
    def process_request(self, request, address):
1873
1701
        """Start a new process to process the request."""
1874
1702
        proc = multiprocessing.Process(target = self.sub_process_main,
1875
 
                                       args = (request, address))
 
1703
                                       args = (request,
 
1704
                                               address))
1876
1705
        proc.start()
1877
1706
        return proc
1878
1707
 
1893
1722
    
1894
1723
    def add_pipe(self, parent_pipe, proc):
1895
1724
        """Dummy function; override as necessary"""
1896
 
        raise NotImplementedError()
 
1725
        raise NotImplementedError
1897
1726
 
1898
1727
 
1899
1728
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1906
1735
        use_ipv6:       Boolean; to use IPv6 or not
1907
1736
    """
1908
1737
    def __init__(self, server_address, RequestHandlerClass,
1909
 
                 interface=None, use_ipv6=True, socketfd=None):
1910
 
        """If socketfd is set, use that file descriptor instead of
1911
 
        creating a new one with socket.socket().
1912
 
        """
 
1738
                 interface=None, use_ipv6=True):
1913
1739
        self.interface = interface
1914
1740
        if use_ipv6:
1915
1741
            self.address_family = socket.AF_INET6
1916
 
        if socketfd is not None:
1917
 
            # Save the file descriptor
1918
 
            self.socketfd = socketfd
1919
 
            # Save the original socket.socket() function
1920
 
            self.socket_socket = socket.socket
1921
 
            # To implement --socket, we monkey patch socket.socket.
1922
 
            # 
1923
 
            # (When socketserver.TCPServer is a new-style class, we
1924
 
            # could make self.socket into a property instead of monkey
1925
 
            # patching socket.socket.)
1926
 
            # 
1927
 
            # Create a one-time-only replacement for socket.socket()
1928
 
            @functools.wraps(socket.socket)
1929
 
            def socket_wrapper(*args, **kwargs):
1930
 
                # Restore original function so subsequent calls are
1931
 
                # not affected.
1932
 
                socket.socket = self.socket_socket
1933
 
                del self.socket_socket
1934
 
                # This time only, return a new socket object from the
1935
 
                # saved file descriptor.
1936
 
                return socket.fromfd(self.socketfd, *args, **kwargs)
1937
 
            # Replace socket.socket() function with wrapper
1938
 
            socket.socket = socket_wrapper
1939
 
        # The socketserver.TCPServer.__init__ will call
1940
 
        # socket.socket(), which might be our replacement,
1941
 
        # socket_wrapper(), if socketfd was set.
1942
1742
        socketserver.TCPServer.__init__(self, server_address,
1943
1743
                                        RequestHandlerClass)
1944
 
    
1945
1744
    def server_bind(self):
1946
1745
        """This overrides the normal server_bind() function
1947
1746
        to bind to an interface if one was specified, and also NOT to
1955
1754
                try:
1956
1755
                    self.socket.setsockopt(socket.SOL_SOCKET,
1957
1756
                                           SO_BINDTODEVICE,
1958
 
                                           (self.interface + "\0")
1959
 
                                           .encode("utf-8"))
 
1757
                                           str(self.interface
 
1758
                                               + '\0'))
1960
1759
                except socket.error as error:
1961
 
                    if error.errno == errno.EPERM:
1962
 
                        logger.error("No permission to bind to"
1963
 
                                     " interface %s", self.interface)
1964
 
                    elif error.errno == errno.ENOPROTOOPT:
 
1760
                    if error[0] == errno.EPERM:
 
1761
                        logger.error("No permission to"
 
1762
                                     " bind to interface %s",
 
1763
                                     self.interface)
 
1764
                    elif error[0] == errno.ENOPROTOOPT:
1965
1765
                        logger.error("SO_BINDTODEVICE not available;"
1966
1766
                                     " cannot bind to interface %s",
1967
1767
                                     self.interface)
1968
 
                    elif error.errno == errno.ENODEV:
1969
 
                        logger.error("Interface %s does not exist,"
1970
 
                                     " cannot bind", self.interface)
1971
1768
                    else:
1972
1769
                        raise
1973
1770
        # Only bind(2) the socket if we really need to.
1976
1773
                if self.address_family == socket.AF_INET6:
1977
1774
                    any_address = "::" # in6addr_any
1978
1775
                else:
1979
 
                    any_address = "0.0.0.0" # INADDR_ANY
 
1776
                    any_address = socket.INADDR_ANY
1980
1777
                self.server_address = (any_address,
1981
1778
                                       self.server_address[1])
1982
1779
            elif not self.server_address[1]:
2003
1800
    """
2004
1801
    def __init__(self, server_address, RequestHandlerClass,
2005
1802
                 interface=None, use_ipv6=True, clients=None,
2006
 
                 gnutls_priority=None, use_dbus=True, socketfd=None):
 
1803
                 gnutls_priority=None, use_dbus=True):
2007
1804
        self.enabled = False
2008
1805
        self.clients = clients
2009
1806
        if self.clients is None:
2013
1810
        IPv6_TCPServer.__init__(self, server_address,
2014
1811
                                RequestHandlerClass,
2015
1812
                                interface = interface,
2016
 
                                use_ipv6 = use_ipv6,
2017
 
                                socketfd = socketfd)
 
1813
                                use_ipv6 = use_ipv6)
2018
1814
    def server_activate(self):
2019
1815
        if self.enabled:
2020
1816
            return socketserver.TCPServer.server_activate(self)
2033
1829
    
2034
1830
    def handle_ipc(self, source, condition, parent_pipe=None,
2035
1831
                   proc = None, client_object=None):
 
1832
        condition_names = {
 
1833
            gobject.IO_IN: "IN",   # There is data to read.
 
1834
            gobject.IO_OUT: "OUT", # Data can be written (without
 
1835
                                    # blocking).
 
1836
            gobject.IO_PRI: "PRI", # There is urgent data to read.
 
1837
            gobject.IO_ERR: "ERR", # Error condition.
 
1838
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
 
1839
                                    # broken, usually for pipes and
 
1840
                                    # sockets).
 
1841
            }
 
1842
        conditions_string = ' | '.join(name
 
1843
                                       for cond, name in
 
1844
                                       condition_names.iteritems()
 
1845
                                       if cond & condition)
2036
1846
        # error, or the other end of multiprocessing.Pipe has closed
2037
 
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
 
1847
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2038
1848
            # Wait for other process to exit
2039
1849
            proc.join()
2040
1850
            return False
2098
1908
        return True
2099
1909
 
2100
1910
 
2101
 
def rfc3339_duration_to_delta(duration):
2102
 
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2103
 
    
2104
 
    >>> rfc3339_duration_to_delta("P7D")
2105
 
    datetime.timedelta(7)
2106
 
    >>> rfc3339_duration_to_delta("PT60S")
2107
 
    datetime.timedelta(0, 60)
2108
 
    >>> rfc3339_duration_to_delta("PT60M")
2109
 
    datetime.timedelta(0, 3600)
2110
 
    >>> rfc3339_duration_to_delta("PT24H")
2111
 
    datetime.timedelta(1)
2112
 
    >>> rfc3339_duration_to_delta("P1W")
2113
 
    datetime.timedelta(7)
2114
 
    >>> rfc3339_duration_to_delta("PT5M30S")
2115
 
    datetime.timedelta(0, 330)
2116
 
    >>> rfc3339_duration_to_delta("P1DT3M20S")
2117
 
    datetime.timedelta(1, 200)
2118
 
    """
2119
 
    
2120
 
    # Parsing an RFC 3339 duration with regular expressions is not
2121
 
    # possible - there would have to be multiple places for the same
2122
 
    # values, like seconds.  The current code, while more esoteric, is
2123
 
    # cleaner without depending on a parsing library.  If Python had a
2124
 
    # built-in library for parsing we would use it, but we'd like to
2125
 
    # avoid excessive use of external libraries.
2126
 
    
2127
 
    # New type for defining tokens, syntax, and semantics all-in-one
2128
 
    Token = collections.namedtuple("Token",
2129
 
                                   ("regexp", # To match token; if
2130
 
                                              # "value" is not None,
2131
 
                                              # must have a "group"
2132
 
                                              # containing digits
2133
 
                                    "value",  # datetime.timedelta or
2134
 
                                              # None
2135
 
                                    "followers")) # Tokens valid after
2136
 
                                                  # this token
2137
 
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
2138
 
    # the "duration" ABNF definition in RFC 3339, Appendix A.
2139
 
    token_end = Token(re.compile(r"$"), None, frozenset())
2140
 
    token_second = Token(re.compile(r"(\d+)S"),
2141
 
                         datetime.timedelta(seconds=1),
2142
 
                         frozenset((token_end,)))
2143
 
    token_minute = Token(re.compile(r"(\d+)M"),
2144
 
                         datetime.timedelta(minutes=1),
2145
 
                         frozenset((token_second, token_end)))
2146
 
    token_hour = Token(re.compile(r"(\d+)H"),
2147
 
                       datetime.timedelta(hours=1),
2148
 
                       frozenset((token_minute, token_end)))
2149
 
    token_time = Token(re.compile(r"T"),
2150
 
                       None,
2151
 
                       frozenset((token_hour, token_minute,
2152
 
                                  token_second)))
2153
 
    token_day = Token(re.compile(r"(\d+)D"),
2154
 
                      datetime.timedelta(days=1),
2155
 
                      frozenset((token_time, token_end)))
2156
 
    token_month = Token(re.compile(r"(\d+)M"),
2157
 
                        datetime.timedelta(weeks=4),
2158
 
                        frozenset((token_day, token_end)))
2159
 
    token_year = Token(re.compile(r"(\d+)Y"),
2160
 
                       datetime.timedelta(weeks=52),
2161
 
                       frozenset((token_month, token_end)))
2162
 
    token_week = Token(re.compile(r"(\d+)W"),
2163
 
                       datetime.timedelta(weeks=1),
2164
 
                       frozenset((token_end,)))
2165
 
    token_duration = Token(re.compile(r"P"), None,
2166
 
                           frozenset((token_year, token_month,
2167
 
                                      token_day, token_time,
2168
 
                                      token_week)))
2169
 
    # Define starting values
2170
 
    value = datetime.timedelta() # Value so far
2171
 
    found_token = None
2172
 
    followers = frozenset((token_duration,)) # Following valid tokens
2173
 
    s = duration                # String left to parse
2174
 
    # Loop until end token is found
2175
 
    while found_token is not token_end:
2176
 
        # Search for any currently valid tokens
2177
 
        for token in followers:
2178
 
            match = token.regexp.match(s)
2179
 
            if match is not None:
2180
 
                # Token found
2181
 
                if token.value is not None:
2182
 
                    # Value found, parse digits
2183
 
                    factor = int(match.group(1), 10)
2184
 
                    # Add to value so far
2185
 
                    value += factor * token.value
2186
 
                # Strip token from string
2187
 
                s = token.regexp.sub("", s, 1)
2188
 
                # Go to found token
2189
 
                found_token = token
2190
 
                # Set valid next tokens
2191
 
                followers = found_token.followers
2192
 
                break
2193
 
        else:
2194
 
            # No currently valid tokens were found
2195
 
            raise ValueError("Invalid RFC 3339 duration")
2196
 
    # End token found
2197
 
    return value
2198
 
 
2199
 
 
2200
1911
def string_to_delta(interval):
2201
1912
    """Parse a string and return a datetime.timedelta
2202
1913
    
2213
1924
    >>> string_to_delta('5m 30s')
2214
1925
    datetime.timedelta(0, 330)
2215
1926
    """
2216
 
    
2217
 
    try:
2218
 
        return rfc3339_duration_to_delta(interval)
2219
 
    except ValueError:
2220
 
        pass
2221
 
    
2222
1927
    timevalue = datetime.timedelta(0)
2223
1928
    for s in interval.split():
2224
1929
        try:
2225
 
            suffix = s[-1]
 
1930
            suffix = unicode(s[-1])
2226
1931
            value = int(s[:-1])
2227
1932
            if suffix == "d":
2228
1933
                delta = datetime.timedelta(value)
2235
1940
            elif suffix == "w":
2236
1941
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2237
1942
            else:
2238
 
                raise ValueError("Unknown suffix {!r}"
2239
 
                                 .format(suffix))
2240
 
        except IndexError as e:
 
1943
                raise ValueError("Unknown suffix %r" % suffix)
 
1944
        except (ValueError, IndexError) as e:
2241
1945
            raise ValueError(*(e.args))
2242
1946
        timevalue += delta
2243
1947
    return timevalue
2256
1960
        sys.exit()
2257
1961
    if not noclose:
2258
1962
        # Close all standard open file descriptors
2259
 
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
1963
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2260
1964
        if not stat.S_ISCHR(os.fstat(null).st_mode):
2261
 
            raise OSError(errno.ENODEV, "{} not a character device"
2262
 
                          .format(os.devnull))
 
1965
            raise OSError(errno.ENODEV,
 
1966
                          "%s not a character device"
 
1967
                          % os.path.devnull)
2263
1968
        os.dup2(null, sys.stdin.fileno())
2264
1969
        os.dup2(null, sys.stdout.fileno())
2265
1970
        os.dup2(null, sys.stderr.fileno())
2274
1979
    
2275
1980
    parser = argparse.ArgumentParser()
2276
1981
    parser.add_argument("-v", "--version", action="version",
2277
 
                        version = "%(prog)s {}".format(version),
 
1982
                        version = "%%(prog)s %s" % version,
2278
1983
                        help="show version number and exit")
2279
1984
    parser.add_argument("-i", "--interface", metavar="IF",
2280
1985
                        help="Bind to interface IF")
2286
1991
                        help="Run self-test")
2287
1992
    parser.add_argument("--debug", action="store_true",
2288
1993
                        help="Debug mode; run in foreground and log"
2289
 
                        " to terminal", default=None)
 
1994
                        " to terminal")
2290
1995
    parser.add_argument("--debuglevel", metavar="LEVEL",
2291
1996
                        help="Debug level for stdout output")
2292
1997
    parser.add_argument("--priority", help="GnuTLS"
2299
2004
                        " files")
2300
2005
    parser.add_argument("--no-dbus", action="store_false",
2301
2006
                        dest="use_dbus", help="Do not provide D-Bus"
2302
 
                        " system bus interface", default=None)
 
2007
                        " system bus interface")
2303
2008
    parser.add_argument("--no-ipv6", action="store_false",
2304
 
                        dest="use_ipv6", help="Do not use IPv6",
2305
 
                        default=None)
 
2009
                        dest="use_ipv6", help="Do not use IPv6")
2306
2010
    parser.add_argument("--no-restore", action="store_false",
2307
2011
                        dest="restore", help="Do not restore stored"
2308
 
                        " state", default=None)
2309
 
    parser.add_argument("--socket", type=int,
2310
 
                        help="Specify a file descriptor to a network"
2311
 
                        " socket to use instead of creating one")
 
2012
                        " state")
2312
2013
    parser.add_argument("--statedir", metavar="DIR",
2313
2014
                        help="Directory to save/restore state in")
2314
 
    parser.add_argument("--foreground", action="store_true",
2315
 
                        help="Run in foreground", default=None)
2316
 
    parser.add_argument("--no-zeroconf", action="store_false",
2317
 
                        dest="zeroconf", help="Do not use Zeroconf",
2318
 
                        default=None)
2319
2015
    
2320
2016
    options = parser.parse_args()
2321
2017
    
2322
2018
    if options.check:
2323
2019
        import doctest
2324
 
        fail_count, test_count = doctest.testmod()
2325
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
2020
        doctest.testmod()
 
2021
        sys.exit()
2326
2022
    
2327
2023
    # Default values for config file for server-global settings
2328
2024
    server_defaults = { "interface": "",
2330
2026
                        "port": "",
2331
2027
                        "debug": "False",
2332
2028
                        "priority":
2333
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
 
2029
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2334
2030
                        "servicename": "Mandos",
2335
2031
                        "use_dbus": "True",
2336
2032
                        "use_ipv6": "True",
2337
2033
                        "debuglevel": "",
2338
2034
                        "restore": "True",
2339
 
                        "socket": "",
2340
 
                        "statedir": "/var/lib/mandos",
2341
 
                        "foreground": "False",
2342
 
                        "zeroconf": "True",
 
2035
                        "statedir": "/var/lib/mandos"
2343
2036
                        }
2344
2037
    
2345
2038
    # Parse config file for server-global settings
2350
2043
    # Convert the SafeConfigParser object to a dict
2351
2044
    server_settings = server_config.defaults()
2352
2045
    # Use the appropriate methods on the non-string config options
2353
 
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
 
2046
    for option in ("debug", "use_dbus", "use_ipv6"):
2354
2047
        server_settings[option] = server_config.getboolean("DEFAULT",
2355
2048
                                                           option)
2356
2049
    if server_settings["port"]:
2357
2050
        server_settings["port"] = server_config.getint("DEFAULT",
2358
2051
                                                       "port")
2359
 
    if server_settings["socket"]:
2360
 
        server_settings["socket"] = server_config.getint("DEFAULT",
2361
 
                                                         "socket")
2362
 
        # Later, stdin will, and stdout and stderr might, be dup'ed
2363
 
        # over with an opened os.devnull.  But we don't want this to
2364
 
        # happen with a supplied network socket.
2365
 
        if 0 <= server_settings["socket"] <= 2:
2366
 
            server_settings["socket"] = os.dup(server_settings
2367
 
                                               ["socket"])
2368
2052
    del server_config
2369
2053
    
2370
2054
    # Override the settings from the config file with command line
2372
2056
    for option in ("interface", "address", "port", "debug",
2373
2057
                   "priority", "servicename", "configdir",
2374
2058
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2375
 
                   "statedir", "socket", "foreground", "zeroconf"):
 
2059
                   "statedir"):
2376
2060
        value = getattr(options, option)
2377
2061
        if value is not None:
2378
2062
            server_settings[option] = value
2379
2063
    del options
2380
2064
    # Force all strings to be unicode
2381
2065
    for option in server_settings.keys():
2382
 
        if isinstance(server_settings[option], bytes):
2383
 
            server_settings[option] = (server_settings[option]
2384
 
                                       .decode("utf-8"))
2385
 
    # Force all boolean options to be boolean
2386
 
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
2387
 
                   "foreground", "zeroconf"):
2388
 
        server_settings[option] = bool(server_settings[option])
2389
 
    # Debug implies foreground
2390
 
    if server_settings["debug"]:
2391
 
        server_settings["foreground"] = True
 
2066
        if type(server_settings[option]) is str:
 
2067
            server_settings[option] = unicode(server_settings[option])
2392
2068
    # Now we have our good server settings in "server_settings"
2393
2069
    
2394
2070
    ##################################################################
2395
2071
    
2396
 
    if (not server_settings["zeroconf"] and
2397
 
        not (server_settings["port"]
2398
 
             or server_settings["socket"] != "")):
2399
 
            parser.error("Needs port or socket to work without"
2400
 
                         " Zeroconf")
2401
 
    
2402
2072
    # For convenience
2403
2073
    debug = server_settings["debug"]
2404
2074
    debuglevel = server_settings["debuglevel"]
2406
2076
    use_ipv6 = server_settings["use_ipv6"]
2407
2077
    stored_state_path = os.path.join(server_settings["statedir"],
2408
2078
                                     stored_state_file)
2409
 
    foreground = server_settings["foreground"]
2410
 
    zeroconf = server_settings["zeroconf"]
2411
2079
    
2412
2080
    if debug:
2413
 
        initlogger(debug, logging.DEBUG)
 
2081
        initlogger(logging.DEBUG)
2414
2082
    else:
2415
2083
        if not debuglevel:
2416
 
            initlogger(debug)
 
2084
            initlogger()
2417
2085
        else:
2418
2086
            level = getattr(logging, debuglevel.upper())
2419
 
            initlogger(debug, level)
 
2087
            initlogger(level)
2420
2088
    
2421
2089
    if server_settings["servicename"] != "Mandos":
2422
2090
        syslogger.setFormatter(logging.Formatter
2423
 
                               ('Mandos ({}) [%(process)d]:'
2424
 
                                ' %(levelname)s: %(message)s'
2425
 
                                .format(server_settings
2426
 
                                        ["servicename"])))
 
2091
                               ('Mandos (%s) [%%(process)d]:'
 
2092
                                ' %%(levelname)s: %%(message)s'
 
2093
                                % server_settings["servicename"]))
2427
2094
    
2428
2095
    # Parse config file with clients
2429
 
    client_config = configparser.SafeConfigParser(Client
2430
 
                                                  .client_defaults)
 
2096
    client_config = configparser.SafeConfigParser(Client.client_defaults)
2431
2097
    client_config.read(os.path.join(server_settings["configdir"],
2432
2098
                                    "clients.conf"))
2433
2099
    
2434
2100
    global mandos_dbus_service
2435
2101
    mandos_dbus_service = None
2436
2102
    
2437
 
    socketfd = None
2438
 
    if server_settings["socket"] != "":
2439
 
        socketfd = server_settings["socket"]
2440
2103
    tcp_server = MandosServer((server_settings["address"],
2441
2104
                               server_settings["port"]),
2442
2105
                              ClientHandler,
2445
2108
                              use_ipv6=use_ipv6,
2446
2109
                              gnutls_priority=
2447
2110
                              server_settings["priority"],
2448
 
                              use_dbus=use_dbus,
2449
 
                              socketfd=socketfd)
2450
 
    if not foreground:
2451
 
        pidfilename = "/run/mandos.pid"
2452
 
        if not os.path.isdir("/run/."):
2453
 
            pidfilename = "/var/run/mandos.pid"
2454
 
        pidfile = None
 
2111
                              use_dbus=use_dbus)
 
2112
    if not debug:
 
2113
        pidfilename = "/var/run/mandos.pid"
2455
2114
        try:
2456
2115
            pidfile = open(pidfilename, "w")
2457
 
        except IOError as e:
2458
 
            logger.error("Could not open file %r", pidfilename,
2459
 
                         exc_info=e)
 
2116
        except IOError:
 
2117
            logger.error("Could not open file %r", pidfilename)
2460
2118
    
2461
 
    for name in ("_mandos", "mandos", "nobody"):
 
2119
    try:
 
2120
        uid = pwd.getpwnam("_mandos").pw_uid
 
2121
        gid = pwd.getpwnam("_mandos").pw_gid
 
2122
    except KeyError:
2462
2123
        try:
2463
 
            uid = pwd.getpwnam(name).pw_uid
2464
 
            gid = pwd.getpwnam(name).pw_gid
2465
 
            break
 
2124
            uid = pwd.getpwnam("mandos").pw_uid
 
2125
            gid = pwd.getpwnam("mandos").pw_gid
2466
2126
        except KeyError:
2467
 
            continue
2468
 
    else:
2469
 
        uid = 65534
2470
 
        gid = 65534
 
2127
            try:
 
2128
                uid = pwd.getpwnam("nobody").pw_uid
 
2129
                gid = pwd.getpwnam("nobody").pw_gid
 
2130
            except KeyError:
 
2131
                uid = 65534
 
2132
                gid = 65534
2471
2133
    try:
2472
2134
        os.setgid(gid)
2473
2135
        os.setuid(uid)
2474
2136
    except OSError as error:
2475
 
        if error.errno != errno.EPERM:
2476
 
            raise
 
2137
        if error[0] != errno.EPERM:
 
2138
            raise error
2477
2139
    
2478
2140
    if debug:
2479
2141
        # Enable all possible GnuTLS debugging
2490
2152
         .gnutls_global_set_log_function(debug_gnutls))
2491
2153
        
2492
2154
        # Redirect stdin so all checkers get /dev/null
2493
 
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
2155
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2494
2156
        os.dup2(null, sys.stdin.fileno())
2495
2157
        if null > 2:
2496
2158
            os.close(null)
 
2159
    else:
 
2160
        # No console logging
 
2161
        logger.removeHandler(console)
2497
2162
    
2498
2163
    # Need to fork before connecting to D-Bus
2499
 
    if not foreground:
 
2164
    if not debug:
2500
2165
        # Close all input and output, do double fork, etc.
2501
2166
        daemon()
2502
2167
    
2503
 
    # multiprocessing will use threads, so before we use gobject we
2504
 
    # need to inform gobject that threads will be used.
2505
 
    gobject.threads_init()
2506
 
    
2507
2168
    global main_loop
2508
2169
    # From the Avahi example code
2509
 
    DBusGMainLoop(set_as_default=True)
 
2170
    DBusGMainLoop(set_as_default=True )
2510
2171
    main_loop = gobject.MainLoop()
2511
2172
    bus = dbus.SystemBus()
2512
2173
    # End of Avahi example code
2518
2179
                            ("se.bsnet.fukt.Mandos", bus,
2519
2180
                             do_not_queue=True))
2520
2181
        except dbus.exceptions.NameExistsException as e:
2521
 
            logger.error("Disabling D-Bus:", exc_info=e)
 
2182
            logger.error(unicode(e) + ", disabling D-Bus")
2522
2183
            use_dbus = False
2523
2184
            server_settings["use_dbus"] = False
2524
2185
            tcp_server.use_dbus = False
2525
 
    if zeroconf:
2526
 
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2527
 
        service = AvahiServiceToSyslog(name =
2528
 
                                       server_settings["servicename"],
2529
 
                                       servicetype = "_mandos._tcp",
2530
 
                                       protocol = protocol, bus = bus)
2531
 
        if server_settings["interface"]:
2532
 
            service.interface = (if_nametoindex
2533
 
                                 (server_settings["interface"]
2534
 
                                  .encode("utf-8")))
 
2186
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
2187
    service = AvahiServiceToSyslog(name =
 
2188
                                   server_settings["servicename"],
 
2189
                                   servicetype = "_mandos._tcp",
 
2190
                                   protocol = protocol, bus = bus)
 
2191
    if server_settings["interface"]:
 
2192
        service.interface = (if_nametoindex
 
2193
                             (str(server_settings["interface"])))
2535
2194
    
2536
2195
    global multiprocessing_manager
2537
2196
    multiprocessing_manager = multiprocessing.Manager()
2538
2197
    
2539
2198
    client_class = Client
2540
2199
    if use_dbus:
2541
 
        client_class = functools.partial(ClientDBus, bus = bus)
 
2200
        client_class = functools.partial(ClientDBusTransitional,
 
2201
                                         bus = bus)
2542
2202
    
2543
2203
    client_settings = Client.config_parser(client_config)
2544
2204
    old_client_settings = {}
2545
2205
    clients_data = {}
2546
2206
    
2547
 
    # This is used to redirect stdout and stderr for checker processes
2548
 
    global wnull
2549
 
    wnull = open(os.devnull, "w") # A writable /dev/null
2550
 
    # Only used if server is running in foreground but not in debug
2551
 
    # mode
2552
 
    if debug or not foreground:
2553
 
        wnull.close()
2554
 
    
2555
2207
    # Get client data and settings from last running state.
2556
2208
    if server_settings["restore"]:
2557
2209
        try:
2560
2212
                                                     (stored_state))
2561
2213
            os.remove(stored_state_path)
2562
2214
        except IOError as e:
2563
 
            if e.errno == errno.ENOENT:
2564
 
                logger.warning("Could not load persistent state: {}"
2565
 
                                .format(os.strerror(e.errno)))
2566
 
            else:
2567
 
                logger.critical("Could not load persistent state:",
2568
 
                                exc_info=e)
 
2215
            logger.warning("Could not load persistent state: {0}"
 
2216
                           .format(e))
 
2217
            if e.errno != errno.ENOENT:
2569
2218
                raise
2570
 
        except EOFError as e:
2571
 
            logger.warning("Could not load persistent state: "
2572
 
                           "EOFError:", exc_info=e)
2573
2219
    
2574
2220
    with PGPEngine() as pgp:
2575
 
        for client_name, client in clients_data.items():
2576
 
            # Skip removed clients
2577
 
            if client_name not in client_settings:
2578
 
                continue
2579
 
            
 
2221
        for client_name, client in clients_data.iteritems():
2580
2222
            # Decide which value to use after restoring saved state.
2581
2223
            # We have three different values: Old config file,
2582
2224
            # new config file, and saved state.
2596
2238
            
2597
2239
            # Clients who has passed its expire date can still be
2598
2240
            # enabled if its last checker was successful.  Clients
2599
 
            # whose checker succeeded before we stored its state is
2600
 
            # assumed to have successfully run all checkers during
2601
 
            # downtime.
 
2241
            # whose checker failed before we stored its state is
 
2242
            # assumed to have failed all checkers during downtime.
2602
2243
            if client["enabled"]:
2603
2244
                if datetime.datetime.utcnow() >= client["expires"]:
2604
2245
                    if not client["last_checked_ok"]:
2605
2246
                        logger.warning(
2606
 
                            "disabling client {} - Client never "
2607
 
                            "performed a successful checker"
2608
 
                            .format(client_name))
 
2247
                            "disabling client {0} - Client never "
 
2248
                            "performed a successfull checker"
 
2249
                            .format(client["name"]))
2609
2250
                        client["enabled"] = False
2610
2251
                    elif client["last_checker_status"] != 0:
2611
2252
                        logger.warning(
2612
 
                            "disabling client {} - Client last"
2613
 
                            " checker failed with error code {}"
2614
 
                            .format(client_name,
 
2253
                            "disabling client {0} - Client "
 
2254
                            "last checker failed with error code {1}"
 
2255
                            .format(client["name"],
2615
2256
                                    client["last_checker_status"]))
2616
2257
                        client["enabled"] = False
2617
2258
                    else:
2618
2259
                        client["expires"] = (datetime.datetime
2619
2260
                                             .utcnow()
2620
2261
                                             + client["timeout"])
2621
 
                        logger.debug("Last checker succeeded,"
2622
 
                                     " keeping {} enabled"
2623
 
                                     .format(client_name))
 
2262
                    
2624
2263
            try:
2625
2264
                client["secret"] = (
2626
2265
                    pgp.decrypt(client["encrypted_secret"],
2628
2267
                                ["secret"]))
2629
2268
            except PGPError:
2630
2269
                # If decryption fails, we use secret from new settings
2631
 
                logger.debug("Failed to decrypt {} old secret"
 
2270
                logger.debug("Failed to decrypt {0} old secret"
2632
2271
                             .format(client_name))
2633
2272
                client["secret"] = (
2634
2273
                    client_settings[client_name]["secret"])
 
2274
 
2635
2275
    
2636
2276
    # Add/remove clients based on new changes made to config
2637
 
    for client_name in (set(old_client_settings)
2638
 
                        - set(client_settings)):
 
2277
    for client_name in set(old_client_settings) - set(client_settings):
2639
2278
        del clients_data[client_name]
2640
 
    for client_name in (set(client_settings)
2641
 
                        - set(old_client_settings)):
 
2279
    for client_name in set(client_settings) - set(old_client_settings):
2642
2280
        clients_data[client_name] = client_settings[client_name]
2643
 
    
2644
 
    # Create all client objects
2645
 
    for client_name, client in clients_data.items():
 
2281
 
 
2282
    # Create clients all clients
 
2283
    for client_name, client in clients_data.iteritems():
2646
2284
        tcp_server.clients[client_name] = client_class(
2647
 
            name = client_name, settings = client,
2648
 
            server_settings = server_settings)
 
2285
            name = client_name, settings = client)
2649
2286
    
2650
2287
    if not tcp_server.clients:
2651
2288
        logger.warning("No clients defined")
2652
 
    
2653
 
    if not foreground:
2654
 
        if pidfile is not None:
2655
 
            try:
2656
 
                with pidfile:
2657
 
                    pid = os.getpid()
2658
 
                    pidfile.write("{}\n".format(pid).encode("utf-8"))
2659
 
            except IOError:
2660
 
                logger.error("Could not write to file %r with PID %d",
2661
 
                             pidfilename, pid)
2662
 
        del pidfile
 
2289
        
 
2290
    if not debug:
 
2291
        try:
 
2292
            with pidfile:
 
2293
                pid = os.getpid()
 
2294
                pidfile.write(str(pid) + "\n".encode("utf-8"))
 
2295
            del pidfile
 
2296
        except IOError:
 
2297
            logger.error("Could not write to file %r with PID %d",
 
2298
                         pidfilename, pid)
 
2299
        except NameError:
 
2300
            # "pidfile" was never created
 
2301
            pass
2663
2302
        del pidfilename
 
2303
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2664
2304
    
2665
2305
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2666
2306
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2667
2307
    
2668
2308
    if use_dbus:
2669
 
        @alternate_dbus_interfaces({"se.recompile.Mandos":
2670
 
                                        "se.bsnet.fukt.Mandos"})
2671
 
        class MandosDBusService(DBusObjectWithProperties):
 
2309
        class MandosDBusService(dbus.service.Object):
2672
2310
            """A D-Bus proxy object"""
2673
2311
            def __init__(self):
2674
2312
                dbus.service.Object.__init__(self, bus, "/")
2675
2313
            _interface = "se.recompile.Mandos"
2676
2314
            
2677
 
            @dbus_interface_annotations(_interface)
2678
 
            def _foo(self):
2679
 
                return { "org.freedesktop.DBus.Property"
2680
 
                         ".EmitsChangedSignal":
2681
 
                             "false"}
2682
 
            
2683
2315
            @dbus.service.signal(_interface, signature="o")
2684
2316
            def ClientAdded(self, objpath):
2685
2317
                "D-Bus signal"
2727
2359
            
2728
2360
            del _interface
2729
2361
        
2730
 
        mandos_dbus_service = MandosDBusService()
 
2362
        class MandosDBusServiceTransitional(MandosDBusService):
 
2363
            __metaclass__ = AlternateDBusNamesMetaclass
 
2364
        mandos_dbus_service = MandosDBusServiceTransitional()
2731
2365
    
2732
2366
    def cleanup():
2733
2367
        "Cleanup function; run on exit"
2734
 
        if zeroconf:
2735
 
            service.cleanup()
 
2368
        service.cleanup()
2736
2369
        
2737
2370
        multiprocessing.active_children()
2738
 
        wnull.close()
2739
2371
        if not (tcp_server.clients or client_settings):
2740
2372
            return
2741
2373
        
2752
2384
                
2753
2385
                # A list of attributes that can not be pickled
2754
2386
                # + secret.
2755
 
                exclude = { "bus", "changedstate", "secret",
2756
 
                            "checker", "server_settings" }
 
2387
                exclude = set(("bus", "changedstate", "secret",
 
2388
                               "checker"))
2757
2389
                for name, typ in (inspect.getmembers
2758
2390
                                  (dbus.service.Object)):
2759
2391
                    exclude.add(name)
2768
2400
                del client_settings[client.name]["secret"]
2769
2401
        
2770
2402
        try:
2771
 
            with (tempfile.NamedTemporaryFile
2772
 
                  (mode='wb', suffix=".pickle", prefix='clients-',
2773
 
                   dir=os.path.dirname(stored_state_path),
2774
 
                   delete=False)) as stored_state:
 
2403
            with os.fdopen(os.open(stored_state_path,
 
2404
                                   os.O_CREAT|os.O_WRONLY|os.O_TRUNC,
 
2405
                                   0600), "wb") as stored_state:
2775
2406
                pickle.dump((clients, client_settings), stored_state)
2776
 
                tempname=stored_state.name
2777
 
            os.rename(tempname, stored_state_path)
2778
2407
        except (IOError, OSError) as e:
2779
 
            if not debug:
2780
 
                try:
2781
 
                    os.remove(tempname)
2782
 
                except NameError:
2783
 
                    pass
2784
 
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2785
 
                logger.warning("Could not save persistent state: {}"
2786
 
                               .format(os.strerror(e.errno)))
2787
 
            else:
2788
 
                logger.warning("Could not save persistent state:",
2789
 
                               exc_info=e)
 
2408
            logger.warning("Could not save persistent state: {0}"
 
2409
                           .format(e))
 
2410
            if e.errno not in (errno.ENOENT, errno.EACCES):
2790
2411
                raise
2791
2412
        
2792
2413
        # Delete all clients, and settings from config
2817
2438
    tcp_server.server_activate()
2818
2439
    
2819
2440
    # Find out what port we got
2820
 
    if zeroconf:
2821
 
        service.port = tcp_server.socket.getsockname()[1]
 
2441
    service.port = tcp_server.socket.getsockname()[1]
2822
2442
    if use_ipv6:
2823
2443
        logger.info("Now listening on address %r, port %d,"
2824
 
                    " flowinfo %d, scope_id %d",
2825
 
                    *tcp_server.socket.getsockname())
 
2444
                    " flowinfo %d, scope_id %d"
 
2445
                    % tcp_server.socket.getsockname())
2826
2446
    else:                       # IPv4
2827
 
        logger.info("Now listening on address %r, port %d",
2828
 
                    *tcp_server.socket.getsockname())
 
2447
        logger.info("Now listening on address %r, port %d"
 
2448
                    % tcp_server.socket.getsockname())
2829
2449
    
2830
2450
    #service.interface = tcp_server.socket.getsockname()[3]
2831
2451
    
2832
2452
    try:
2833
 
        if zeroconf:
2834
 
            # From the Avahi example code
2835
 
            try:
2836
 
                service.activate()
2837
 
            except dbus.exceptions.DBusException as error:
2838
 
                logger.critical("D-Bus Exception", exc_info=error)
2839
 
                cleanup()
2840
 
                sys.exit(1)
2841
 
            # End of Avahi example code
 
2453
        # From the Avahi example code
 
2454
        try:
 
2455
            service.activate()
 
2456
        except dbus.exceptions.DBusException as error:
 
2457
            logger.critical("DBusException: %s", error)
 
2458
            cleanup()
 
2459
            sys.exit(1)
 
2460
        # End of Avahi example code
2842
2461
        
2843
2462
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2844
2463
                             lambda *args, **kwargs:
2848
2467
        logger.debug("Starting main loop")
2849
2468
        main_loop.run()
2850
2469
    except AvahiError as error:
2851
 
        logger.critical("Avahi Error", exc_info=error)
 
2470
        logger.critical("AvahiError: %s", error)
2852
2471
        cleanup()
2853
2472
        sys.exit(1)
2854
2473
    except KeyboardInterrupt: