/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2013-12-31 16:02:18 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 307.
  • Revision ID: teddy@recompile.se-20131231160218-plmmb0o0iifkd5l2
Specify BusName in systemd service file.

* mandos.service (BusName): Uncommented.

Show diffs side-by-side

added added

removed removed

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