/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: 2014-03-10 06:55:54 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 311.
  • Revision ID: teddy@recompile.se-20140310065554-of3kz8jdhlll42l3
Use "struct sockaddr_storage" instead of a union in mandos-client.

Apparently using struct sockaddr_storage the way POSIX intended is
incompatible with strict aliasing, so turn that off in the Makefile.

* plugins.d/mandos-client.c (start_mandos_communication): Change "to"
                                                          from a union
                                                          to a struct
                                                          sockaddr_storage.
* Makefile (OPTIMIZE): Add "-fno-strict-aliasing".

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-2014 Teddy Hogeborn
 
15
# Copyright © 2008-2014 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.4.1"
87
 
 
88
 
#logger = logging.getLogger('mandos')
89
 
logger = logging.Logger('mandos')
90
 
syslogger = (logging.handlers.SysLogHandler
91
 
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
92
 
              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)
 
91
version = "1.6.4"
 
92
stored_state_file = "clients.pickle"
 
93
 
 
94
logger = logging.getLogger()
 
95
syslogger = None
 
96
 
 
97
try:
 
98
    if_nametoindex = (ctypes.cdll.LoadLibrary
 
99
                      (ctypes.util.find_library("c"))
 
100
                      .if_nametoindex)
 
101
except (OSError, AttributeError):
 
102
    def if_nametoindex(interface):
 
103
        "Get an interface index the hard way, i.e. using fcntl()"
 
104
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
 
105
        with contextlib.closing(socket.socket()) as s:
 
106
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
 
107
                                struct.pack(str("16s16x"),
 
108
                                            interface))
 
109
        interface_index = struct.unpack(str("I"),
 
110
                                        ifreq[16:20])[0]
 
111
        return interface_index
 
112
 
 
113
 
 
114
def initlogger(debug, level=logging.WARNING):
 
115
    """init logger and add loglevel"""
 
116
    
 
117
    syslogger = (logging.handlers.SysLogHandler
 
118
                 (facility =
 
119
                  logging.handlers.SysLogHandler.LOG_DAEMON,
 
120
                  address = str("/dev/log")))
 
121
    syslogger.setFormatter(logging.Formatter
 
122
                           ('Mandos [%(process)d]: %(levelname)s:'
 
123
                            ' %(message)s'))
 
124
    logger.addHandler(syslogger)
 
125
    
 
126
    if debug:
 
127
        console = logging.StreamHandler()
 
128
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
 
129
                                               ' [%(process)d]:'
 
130
                                               ' %(levelname)s:'
 
131
                                               ' %(message)s'))
 
132
        logger.addHandler(console)
 
133
    logger.setLevel(level)
 
134
 
 
135
 
 
136
class PGPError(Exception):
 
137
    """Exception if encryption/decryption fails"""
 
138
    pass
 
139
 
 
140
 
 
141
class PGPEngine(object):
 
142
    """A simple class for OpenPGP symmetric encryption & decryption"""
 
143
    def __init__(self):
 
144
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
 
145
        self.gnupgargs = ['--batch',
 
146
                          '--home', self.tempdir,
 
147
                          '--force-mdc',
 
148
                          '--quiet',
 
149
                          '--no-use-agent']
 
150
    
 
151
    def __enter__(self):
 
152
        return self
 
153
    
 
154
    def __exit__(self, exc_type, exc_value, traceback):
 
155
        self._cleanup()
 
156
        return False
 
157
    
 
158
    def __del__(self):
 
159
        self._cleanup()
 
160
    
 
161
    def _cleanup(self):
 
162
        if self.tempdir is not None:
 
163
            # Delete contents of tempdir
 
164
            for root, dirs, files in os.walk(self.tempdir,
 
165
                                             topdown = False):
 
166
                for filename in files:
 
167
                    os.remove(os.path.join(root, filename))
 
168
                for dirname in dirs:
 
169
                    os.rmdir(os.path.join(root, dirname))
 
170
            # Remove tempdir
 
171
            os.rmdir(self.tempdir)
 
172
            self.tempdir = None
 
173
    
 
174
    def password_encode(self, password):
 
175
        # Passphrase can not be empty and can not contain newlines or
 
176
        # NUL bytes.  So we prefix it and hex encode it.
 
177
        encoded = b"mandos" + binascii.hexlify(password)
 
178
        if len(encoded) > 2048:
 
179
            # GnuPG can't handle long passwords, so encode differently
 
180
            encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
 
181
                       .replace(b"\n", b"\\n")
 
182
                       .replace(b"\0", b"\\x00"))
 
183
        return encoded
 
184
    
 
185
    def encrypt(self, data, password):
 
186
        passphrase = self.password_encode(password)
 
187
        with tempfile.NamedTemporaryFile(dir=self.tempdir
 
188
                                         ) as passfile:
 
189
            passfile.write(passphrase)
 
190
            passfile.flush()
 
191
            proc = subprocess.Popen(['gpg', '--symmetric',
 
192
                                     '--passphrase-file',
 
193
                                     passfile.name]
 
194
                                    + self.gnupgargs,
 
195
                                    stdin = subprocess.PIPE,
 
196
                                    stdout = subprocess.PIPE,
 
197
                                    stderr = subprocess.PIPE)
 
198
            ciphertext, err = proc.communicate(input = data)
 
199
        if proc.returncode != 0:
 
200
            raise PGPError(err)
 
201
        return ciphertext
 
202
    
 
203
    def decrypt(self, data, password):
 
204
        passphrase = self.password_encode(password)
 
205
        with tempfile.NamedTemporaryFile(dir = self.tempdir
 
206
                                         ) as passfile:
 
207
            passfile.write(passphrase)
 
208
            passfile.flush()
 
209
            proc = subprocess.Popen(['gpg', '--decrypt',
 
210
                                     '--passphrase-file',
 
211
                                     passfile.name]
 
212
                                    + self.gnupgargs,
 
213
                                    stdin = subprocess.PIPE,
 
214
                                    stdout = subprocess.PIPE,
 
215
                                    stderr = subprocess.PIPE)
 
216
            decrypted_plaintext, err = proc.communicate(input
 
217
                                                        = data)
 
218
        if proc.returncode != 0:
 
219
            raise PGPError(err)
 
220
        return decrypted_plaintext
 
221
 
103
222
 
104
223
class AvahiError(Exception):
105
224
    def __init__(self, value, *args, **kwargs):
123
242
               Used to optionally bind to the specified interface.
124
243
    name: string; Example: 'Mandos'
125
244
    type: string; Example: '_mandos._tcp'.
126
 
                  See <http://www.dns-sd.org/ServiceTypes.html>
 
245
     See <https://www.iana.org/assignments/service-names-port-numbers>
127
246
    port: integer; what port to announce
128
247
    TXT: list of strings; TXT record for the service
129
248
    domain: string; Domain to publish on, default to .local if empty.
135
254
    server: D-Bus Server
136
255
    bus: dbus.SystemBus()
137
256
    """
 
257
    
138
258
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
139
259
                 servicetype = None, port = None, TXT = None,
140
260
                 domain = "", host = "", max_renames = 32768,
153
273
        self.server = None
154
274
        self.bus = bus
155
275
        self.entry_group_state_changed_match = None
 
276
    
156
277
    def rename(self):
157
278
        """Derived from the Avahi example code"""
158
279
        if self.rename_count >= self.max_renames:
164
285
                            .GetAlternativeServiceName(self.name))
165
286
        logger.info("Changing Zeroconf service name to %r ...",
166
287
                    self.name)
167
 
        syslogger.setFormatter(logging.Formatter
168
 
                               ('Mandos (%s) [%%(process)d]:'
169
 
                                ' %%(levelname)s: %%(message)s'
170
 
                                % self.name))
171
288
        self.remove()
172
289
        try:
173
290
            self.add()
174
291
        except dbus.exceptions.DBusException as error:
175
 
            logger.critical("DBusException: %s", error)
 
292
            logger.critical("D-Bus Exception", exc_info=error)
176
293
            self.cleanup()
177
294
            os._exit(1)
178
295
        self.rename_count += 1
 
296
    
179
297
    def remove(self):
180
298
        """Derived from the Avahi example code"""
181
299
        if self.entry_group_state_changed_match is not None:
183
301
            self.entry_group_state_changed_match = None
184
302
        if self.group is not None:
185
303
            self.group.Reset()
 
304
    
186
305
    def add(self):
187
306
        """Derived from the Avahi example code"""
188
307
        self.remove()
193
312
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
194
313
        self.entry_group_state_changed_match = (
195
314
            self.group.connect_to_signal(
196
 
                'StateChanged', self .entry_group_state_changed))
 
315
                'StateChanged', self.entry_group_state_changed))
197
316
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
198
317
                     self.name, self.type)
199
318
        self.group.AddService(
205
324
            dbus.UInt16(self.port),
206
325
            avahi.string_array_to_txt_array(self.TXT))
207
326
        self.group.Commit()
 
327
    
208
328
    def entry_group_state_changed(self, state, error):
209
329
        """Derived from the Avahi example code"""
210
330
        logger.debug("Avahi entry group state change: %i", state)
217
337
        elif state == avahi.ENTRY_GROUP_FAILURE:
218
338
            logger.critical("Avahi: Error in group state changed %s",
219
339
                            unicode(error))
220
 
            raise AvahiGroupError("State changed: %s"
221
 
                                  % unicode(error))
 
340
            raise AvahiGroupError("State changed: {0!s}"
 
341
                                  .format(error))
 
342
    
222
343
    def cleanup(self):
223
344
        """Derived from the Avahi example code"""
224
345
        if self.group is not None:
225
346
            try:
226
347
                self.group.Free()
227
348
            except (dbus.exceptions.UnknownMethodException,
228
 
                    dbus.exceptions.DBusException) as e:
 
349
                    dbus.exceptions.DBusException):
229
350
                pass
230
351
            self.group = None
231
352
        self.remove()
 
353
    
232
354
    def server_state_changed(self, state, error=None):
233
355
        """Derived from the Avahi example code"""
234
356
        logger.debug("Avahi server state change: %i", state)
253
375
                logger.debug("Unknown state: %r", state)
254
376
            else:
255
377
                logger.debug("Unknown state: %r: %r", state, error)
 
378
    
256
379
    def activate(self):
257
380
        """Derived from the Avahi example code"""
258
381
        if self.server is None:
266
389
        self.server_state_changed(self.server.GetState())
267
390
 
268
391
 
269
 
def _timedelta_to_milliseconds(td):
 
392
class AvahiServiceToSyslog(AvahiService):
 
393
    def rename(self):
 
394
        """Add the new name to the syslog messages"""
 
395
        ret = AvahiService.rename(self)
 
396
        syslogger.setFormatter(logging.Formatter
 
397
                               ('Mandos ({0}) [%(process)d]:'
 
398
                                ' %(levelname)s: %(message)s'
 
399
                                .format(self.name)))
 
400
        return ret
 
401
 
 
402
 
 
403
def timedelta_to_milliseconds(td):
270
404
    "Convert a datetime.timedelta() to milliseconds"
271
405
    return ((td.days * 24 * 60 * 60 * 1000)
272
406
            + (td.seconds * 1000)
273
407
            + (td.microseconds // 1000))
274
 
        
 
408
 
 
409
 
275
410
class Client(object):
276
411
    """A representation of a client host served by this server.
277
412
    
278
413
    Attributes:
279
 
    _approved:   bool(); 'None' if not yet approved/disapproved
 
414
    approved:   bool(); 'None' if not yet approved/disapproved
280
415
    approval_delay: datetime.timedelta(); Time to wait for approval
281
416
    approval_duration: datetime.timedelta(); Duration of one approval
282
417
    checker:    subprocess.Popen(); a running checker process used
289
424
                     instance %(name)s can be used in the command.
290
425
    checker_initiator_tag: a gobject event source tag, or None
291
426
    created:    datetime.datetime(); (UTC) object creation
 
427
    client_structure: Object describing what attributes a client has
 
428
                      and is used for storing the client at exit
292
429
    current_checker_command: string; current running checker_command
293
 
    disable_hook:  If set, called by disable() as disable_hook(self)
294
430
    disable_initiator_tag: a gobject event source tag, or None
295
431
    enabled:    bool()
296
432
    fingerprint: string (40 or 32 hexadecimal digits); used to
299
435
    interval:   datetime.timedelta(); How often to start a new checker
300
436
    last_approval_request: datetime.datetime(); (UTC) or None
301
437
    last_checked_ok: datetime.datetime(); (UTC) or None
302
 
    last_enabled: datetime.datetime(); (UTC)
 
438
    last_checker_status: integer between 0 and 255 reflecting exit
 
439
                         status of last checker. -1 reflects crashed
 
440
                         checker, -2 means no checker completed yet.
 
441
    last_enabled: datetime.datetime(); (UTC) or None
303
442
    name:       string; from the config file, used in log messages and
304
443
                        D-Bus identifiers
305
444
    secret:     bytestring; sent verbatim (over TLS) to client
306
445
    timeout:    datetime.timedelta(); How long from last_checked_ok
307
446
                                      until this client is disabled
308
 
    extended_timeout:   extra long timeout when password has been sent
 
447
    extended_timeout:   extra long timeout when secret has been sent
309
448
    runtime_expansions: Allowed attributes for runtime expansion.
310
449
    expires:    datetime.datetime(); time (UTC) when a client will be
311
450
                disabled, or None
 
451
    server_settings: The server_settings dict from main()
312
452
    """
313
453
    
314
454
    runtime_expansions = ("approval_delay", "approval_duration",
315
 
                          "created", "enabled", "fingerprint",
316
 
                          "host", "interval", "last_checked_ok",
 
455
                          "created", "enabled", "expires",
 
456
                          "fingerprint", "host", "interval",
 
457
                          "last_approval_request", "last_checked_ok",
317
458
                          "last_enabled", "name", "timeout")
 
459
    client_defaults = { "timeout": "PT5M",
 
460
                        "extended_timeout": "PT15M",
 
461
                        "interval": "PT2M",
 
462
                        "checker": "fping -q -- %%(host)s",
 
463
                        "host": "",
 
464
                        "approval_delay": "PT0S",
 
465
                        "approval_duration": "PT1S",
 
466
                        "approved_by_default": "True",
 
467
                        "enabled": "True",
 
468
                        }
318
469
    
319
470
    def timeout_milliseconds(self):
320
471
        "Return the 'timeout' attribute in milliseconds"
321
 
        return _timedelta_to_milliseconds(self.timeout)
 
472
        return timedelta_to_milliseconds(self.timeout)
322
473
    
323
474
    def extended_timeout_milliseconds(self):
324
475
        "Return the 'extended_timeout' attribute in milliseconds"
325
 
        return _timedelta_to_milliseconds(self.extended_timeout)
 
476
        return timedelta_to_milliseconds(self.extended_timeout)
326
477
    
327
478
    def interval_milliseconds(self):
328
479
        "Return the 'interval' attribute in milliseconds"
329
 
        return _timedelta_to_milliseconds(self.interval)
 
480
        return timedelta_to_milliseconds(self.interval)
330
481
    
331
482
    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."""
 
483
        return timedelta_to_milliseconds(self.approval_delay)
 
484
    
 
485
    @staticmethod
 
486
    def config_parser(config):
 
487
        """Construct a new dict of client settings of this form:
 
488
        { client_name: {setting_name: value, ...}, ...}
 
489
        with exceptions for any special settings as defined above.
 
490
        NOTE: Must be a pure function. Must return the same result
 
491
        value given the same arguments.
 
492
        """
 
493
        settings = {}
 
494
        for client_name in config.sections():
 
495
            section = dict(config.items(client_name))
 
496
            client = settings[client_name] = {}
 
497
            
 
498
            client["host"] = section["host"]
 
499
            # Reformat values from string types to Python types
 
500
            client["approved_by_default"] = config.getboolean(
 
501
                client_name, "approved_by_default")
 
502
            client["enabled"] = config.getboolean(client_name,
 
503
                                                  "enabled")
 
504
            
 
505
            client["fingerprint"] = (section["fingerprint"].upper()
 
506
                                     .replace(" ", ""))
 
507
            if "secret" in section:
 
508
                client["secret"] = section["secret"].decode("base64")
 
509
            elif "secfile" in section:
 
510
                with open(os.path.expanduser(os.path.expandvars
 
511
                                             (section["secfile"])),
 
512
                          "rb") as secfile:
 
513
                    client["secret"] = secfile.read()
 
514
            else:
 
515
                raise TypeError("No secret or secfile for section {0}"
 
516
                                .format(section))
 
517
            client["timeout"] = string_to_delta(section["timeout"])
 
518
            client["extended_timeout"] = string_to_delta(
 
519
                section["extended_timeout"])
 
520
            client["interval"] = string_to_delta(section["interval"])
 
521
            client["approval_delay"] = string_to_delta(
 
522
                section["approval_delay"])
 
523
            client["approval_duration"] = string_to_delta(
 
524
                section["approval_duration"])
 
525
            client["checker_command"] = section["checker"]
 
526
            client["last_approval_request"] = None
 
527
            client["last_checked_ok"] = None
 
528
            client["last_checker_status"] = -2
 
529
        
 
530
        return settings
 
531
    
 
532
    def __init__(self, settings, name = None, server_settings=None):
338
533
        self.name = name
339
 
        if config is None:
340
 
            config = {}
 
534
        if server_settings is None:
 
535
            server_settings = {}
 
536
        self.server_settings = server_settings
 
537
        # adding all client settings
 
538
        for setting, value in settings.iteritems():
 
539
            setattr(self, setting, value)
 
540
        
 
541
        if self.enabled:
 
542
            if not hasattr(self, "last_enabled"):
 
543
                self.last_enabled = datetime.datetime.utcnow()
 
544
            if not hasattr(self, "expires"):
 
545
                self.expires = (datetime.datetime.utcnow()
 
546
                                + self.timeout)
 
547
        else:
 
548
            self.last_enabled = None
 
549
            self.expires = None
 
550
        
341
551
        logger.debug("Creating client %r", self.name)
342
552
        # Uppercase and remove spaces from fingerprint for later
343
553
        # comparison purposes with return value from the fingerprint()
344
554
        # function
345
 
        self.fingerprint = (config["fingerprint"].upper()
346
 
                            .replace(" ", ""))
347
555
        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
 
556
        self.created = settings.get("created",
 
557
                                    datetime.datetime.utcnow())
 
558
        
 
559
        # attributes specific for this server instance
369
560
        self.checker = None
370
561
        self.checker_initiator_tag = None
371
562
        self.disable_initiator_tag = None
372
 
        self.expires = None
373
563
        self.checker_callback_tag = None
374
 
        self.checker_command = config["checker"]
375
564
        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)
 
565
        self.approved = None
380
566
        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
567
        self.changedstate = (multiprocessing_manager
386
568
                             .Condition(multiprocessing_manager
387
569
                                        .Lock()))
 
570
        self.client_structure = [attr for attr in
 
571
                                 self.__dict__.iterkeys()
 
572
                                 if not attr.startswith("_")]
 
573
        self.client_structure.append("client_structure")
 
574
        
 
575
        for name, t in inspect.getmembers(type(self),
 
576
                                          lambda obj:
 
577
                                              isinstance(obj,
 
578
                                                         property)):
 
579
            if not name.startswith("_"):
 
580
                self.client_structure.append(name)
388
581
    
 
582
    # Send notice to process children that client state has changed
389
583
    def send_changedstate(self):
390
 
        self.changedstate.acquire()
391
 
        self.changedstate.notify_all()
392
 
        self.changedstate.release()
 
584
        with self.changedstate:
 
585
            self.changedstate.notify_all()
393
586
    
394
587
    def enable(self):
395
588
        """Start this client's checker and timeout hooks"""
396
589
        if getattr(self, "enabled", False):
397
590
            # Already enabled
398
591
            return
 
592
        self.expires = datetime.datetime.utcnow() + self.timeout
 
593
        self.enabled = True
 
594
        self.last_enabled = datetime.datetime.utcnow()
 
595
        self.init_checker()
399
596
        self.send_changedstate()
 
597
    
 
598
    def disable(self, quiet=True):
 
599
        """Disable this client."""
 
600
        if not getattr(self, "enabled", False):
 
601
            return False
 
602
        if not quiet:
 
603
            logger.info("Disabling client %s", self.name)
 
604
        if getattr(self, "disable_initiator_tag", None) is not None:
 
605
            gobject.source_remove(self.disable_initiator_tag)
 
606
            self.disable_initiator_tag = None
 
607
        self.expires = None
 
608
        if getattr(self, "checker_initiator_tag", None) is not None:
 
609
            gobject.source_remove(self.checker_initiator_tag)
 
610
            self.checker_initiator_tag = None
 
611
        self.stop_checker()
 
612
        self.enabled = False
 
613
        if not quiet:
 
614
            self.send_changedstate()
 
615
        # Do not run this again if called by a gobject.timeout_add
 
616
        return False
 
617
    
 
618
    def __del__(self):
 
619
        self.disable()
 
620
    
 
621
    def init_checker(self):
400
622
        # Schedule a new checker to be started an 'interval' from now,
401
623
        # and every interval from then on.
 
624
        if self.checker_initiator_tag is not None:
 
625
            gobject.source_remove(self.checker_initiator_tag)
402
626
        self.checker_initiator_tag = (gobject.timeout_add
403
627
                                      (self.interval_milliseconds(),
404
628
                                       self.start_checker))
405
629
        # Schedule a disable() when 'timeout' has passed
406
 
        self.expires = datetime.datetime.utcnow() + self.timeout
 
630
        if self.disable_initiator_tag is not None:
 
631
            gobject.source_remove(self.disable_initiator_tag)
407
632
        self.disable_initiator_tag = (gobject.timeout_add
408
633
                                   (self.timeout_milliseconds(),
409
634
                                    self.disable))
410
 
        self.enabled = True
411
 
        self.last_enabled = datetime.datetime.utcnow()
412
635
        # Also start a new checker *right now*.
413
636
        self.start_checker()
414
637
    
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
638
    def checker_callback(self, pid, condition, command):
442
639
        """The checker has completed, so take appropriate actions."""
443
640
        self.checker_callback_tag = None
444
641
        self.checker = None
445
642
        if os.WIFEXITED(condition):
446
 
            exitstatus = os.WEXITSTATUS(condition)
447
 
            if exitstatus == 0:
 
643
            self.last_checker_status = os.WEXITSTATUS(condition)
 
644
            if self.last_checker_status == 0:
448
645
                logger.info("Checker for %(name)s succeeded",
449
646
                            vars(self))
450
647
                self.checked_ok()
452
649
                logger.info("Checker for %(name)s failed",
453
650
                            vars(self))
454
651
        else:
 
652
            self.last_checker_status = -1
455
653
            logger.warning("Checker for %(name)s crashed?",
456
654
                           vars(self))
457
655
    
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
 
        """
 
656
    def checked_ok(self):
 
657
        """Assert that the client has been seen, alive and well."""
 
658
        self.last_checked_ok = datetime.datetime.utcnow()
 
659
        self.last_checker_status = 0
 
660
        self.bump_timeout()
 
661
    
 
662
    def bump_timeout(self, timeout=None):
 
663
        """Bump up the timeout for this client."""
464
664
        if timeout is None:
465
665
            timeout = self.timeout
466
 
        self.last_checked_ok = datetime.datetime.utcnow()
467
666
        if self.disable_initiator_tag is not None:
468
667
            gobject.source_remove(self.disable_initiator_tag)
 
668
            self.disable_initiator_tag = None
469
669
        if getattr(self, "enabled", False):
470
670
            self.disable_initiator_tag = (gobject.timeout_add
471
 
                                          (_timedelta_to_milliseconds
 
671
                                          (timedelta_to_milliseconds
472
672
                                           (timeout), self.disable))
473
673
            self.expires = datetime.datetime.utcnow() + timeout
474
674
    
481
681
        If a checker already exists, leave it running and do
482
682
        nothing."""
483
683
        # The reason for not killing a running checker is that if we
484
 
        # did that, then if a checker (for some reason) started
485
 
        # running slowly and taking more than 'interval' time, the
486
 
        # client would inevitably timeout, since no checker would get
487
 
        # a chance to run to completion.  If we instead leave running
 
684
        # did that, and if a checker (for some reason) started running
 
685
        # slowly and taking more than 'interval' time, then the client
 
686
        # would inevitably timeout, since no checker would get a
 
687
        # chance to run to completion.  If we instead leave running
488
688
        # checkers alone, the checker would have to take more time
489
689
        # than 'timeout' for the client to be disabled, which is as it
490
690
        # should be.
492
692
        # If a checker exists, make sure it is not a zombie
493
693
        try:
494
694
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
495
 
        except (AttributeError, OSError) as error:
496
 
            if (isinstance(error, OSError)
497
 
                and error.errno != errno.ECHILD):
498
 
                raise error
 
695
        except AttributeError:
 
696
            pass
 
697
        except OSError as error:
 
698
            if error.errno != errno.ECHILD:
 
699
                raise
499
700
        else:
500
701
            if pid:
501
702
                logger.warning("Checker was a zombie")
504
705
                                      self.current_checker_command)
505
706
        # Start a new checker if needed
506
707
        if self.checker is None:
 
708
            # Escape attributes for the shell
 
709
            escaped_attrs = dict(
 
710
                (attr, re.escape(unicode(getattr(self, attr))))
 
711
                for attr in
 
712
                self.runtime_expansions)
507
713
            try:
508
 
                # In case checker_command has exactly one % operator
509
 
                command = self.checker_command % self.host
510
 
            except TypeError:
511
 
                # Escape attributes for the shell
512
 
                escaped_attrs = dict(
513
 
                    (attr,
514
 
                     re.escape(unicode(str(getattr(self, attr, "")),
515
 
                                       errors=
516
 
                                       'replace')))
517
 
                    for attr in
518
 
                    self.runtime_expansions)
519
 
                
520
 
                try:
521
 
                    command = self.checker_command % escaped_attrs
522
 
                except TypeError as error:
523
 
                    logger.error('Could not format string "%s":'
524
 
                                 ' %s', self.checker_command, error)
525
 
                    return True # Try again later
 
714
                command = self.checker_command % escaped_attrs
 
715
            except TypeError as error:
 
716
                logger.error('Could not format string "%s"',
 
717
                             self.checker_command, exc_info=error)
 
718
                return True # Try again later
526
719
            self.current_checker_command = command
527
720
            try:
528
721
                logger.info("Starting checker %r for %s",
531
724
                # in normal mode, that is already done by daemon(),
532
725
                # and in debug mode we don't want to.  (Stdin is
533
726
                # always replaced by /dev/null.)
 
727
                # The exception is when not debugging but nevertheless
 
728
                # running in the foreground; use the previously
 
729
                # created wnull.
 
730
                popen_args = {}
 
731
                if (not self.server_settings["debug"]
 
732
                    and self.server_settings["foreground"]):
 
733
                    popen_args.update({"stdout": wnull,
 
734
                                       "stderr": wnull })
534
735
                self.checker = subprocess.Popen(command,
535
736
                                                close_fds=True,
536
 
                                                shell=True, cwd="/")
537
 
                self.checker_callback_tag = (gobject.child_watch_add
538
 
                                             (self.checker.pid,
539
 
                                              self.checker_callback,
540
 
                                              data=command))
541
 
                # The checker may have completed before the gobject
542
 
                # watch was added.  Check for this.
 
737
                                                shell=True, cwd="/",
 
738
                                                **popen_args)
 
739
            except OSError as error:
 
740
                logger.error("Failed to start subprocess",
 
741
                             exc_info=error)
 
742
                return True
 
743
            self.checker_callback_tag = (gobject.child_watch_add
 
744
                                         (self.checker.pid,
 
745
                                          self.checker_callback,
 
746
                                          data=command))
 
747
            # The checker may have completed before the gobject
 
748
            # watch was added.  Check for this.
 
749
            try:
543
750
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
544
 
                if pid:
545
 
                    gobject.source_remove(self.checker_callback_tag)
546
 
                    self.checker_callback(pid, status, command)
547
751
            except OSError as error:
548
 
                logger.error("Failed to start subprocess: %s",
549
 
                             error)
 
752
                if error.errno == errno.ECHILD:
 
753
                    # This should never happen
 
754
                    logger.error("Child process vanished",
 
755
                                 exc_info=error)
 
756
                    return True
 
757
                raise
 
758
            if pid:
 
759
                gobject.source_remove(self.checker_callback_tag)
 
760
                self.checker_callback(pid, status, command)
550
761
        # Re-run this periodically if run by gobject.timeout_add
551
762
        return True
552
763
    
559
770
            return
560
771
        logger.debug("Stopping checker for %(name)s", vars(self))
561
772
        try:
562
 
            os.kill(self.checker.pid, signal.SIGTERM)
 
773
            self.checker.terminate()
563
774
            #time.sleep(0.5)
564
775
            #if self.checker.poll() is None:
565
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
 
776
            #    self.checker.kill()
566
777
        except OSError as error:
567
778
            if error.errno != errno.ESRCH: # No such process
568
779
                raise
585
796
    # "Set" method, so we fail early here:
586
797
    if byte_arrays and signature != "ay":
587
798
        raise ValueError("Byte arrays not supported for non-'ay'"
588
 
                         " signature %r" % signature)
 
799
                         " signature {0!r}".format(signature))
589
800
    def decorator(func):
590
801
        func._dbus_is_property = True
591
802
        func._dbus_interface = dbus_interface
599
810
    return decorator
600
811
 
601
812
 
 
813
def dbus_interface_annotations(dbus_interface):
 
814
    """Decorator for marking functions returning interface annotations
 
815
    
 
816
    Usage:
 
817
    
 
818
    @dbus_interface_annotations("org.example.Interface")
 
819
    def _foo(self):  # Function name does not matter
 
820
        return {"org.freedesktop.DBus.Deprecated": "true",
 
821
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
822
                    "false"}
 
823
    """
 
824
    def decorator(func):
 
825
        func._dbus_is_interface = True
 
826
        func._dbus_interface = dbus_interface
 
827
        func._dbus_name = dbus_interface
 
828
        return func
 
829
    return decorator
 
830
 
 
831
 
 
832
def dbus_annotations(annotations):
 
833
    """Decorator to annotate D-Bus methods, signals or properties
 
834
    Usage:
 
835
    
 
836
    @dbus_service_property("org.example.Interface", signature="b",
 
837
                           access="r")
 
838
    @dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
 
839
                        "org.freedesktop.DBus.Property."
 
840
                        "EmitsChangedSignal": "false"})
 
841
    def Property_dbus_property(self):
 
842
        return dbus.Boolean(False)
 
843
    """
 
844
    def decorator(func):
 
845
        func._dbus_annotations = annotations
 
846
        return func
 
847
    return decorator
 
848
 
 
849
 
602
850
class DBusPropertyException(dbus.exceptions.DBusException):
603
851
    """A base class for D-Bus property-related exceptions
604
852
    """
627
875
    """
628
876
    
629
877
    @staticmethod
630
 
    def _is_dbus_property(obj):
631
 
        return getattr(obj, "_dbus_is_property", False)
 
878
    def _is_dbus_thing(thing):
 
879
        """Returns a function testing if an attribute is a D-Bus thing
 
880
        
 
881
        If called like _is_dbus_thing("method") it returns a function
 
882
        suitable for use as predicate to inspect.getmembers().
 
883
        """
 
884
        return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
 
885
                                   False)
632
886
    
633
 
    def _get_all_dbus_properties(self):
 
887
    def _get_all_dbus_things(self, thing):
634
888
        """Returns a generator of (name, attribute) pairs
635
889
        """
636
 
        return ((prop.__get__(self)._dbus_name, prop.__get__(self))
 
890
        return ((getattr(athing.__get__(self), "_dbus_name",
 
891
                         name),
 
892
                 athing.__get__(self))
637
893
                for cls in self.__class__.__mro__
638
 
                for name, prop in
639
 
                inspect.getmembers(cls, self._is_dbus_property))
 
894
                for name, athing in
 
895
                inspect.getmembers(cls,
 
896
                                   self._is_dbus_thing(thing)))
640
897
    
641
898
    def _get_dbus_property(self, interface_name, property_name):
642
899
        """Returns a bound method if one exists which is a D-Bus
644
901
        """
645
902
        for cls in  self.__class__.__mro__:
646
903
            for name, value in (inspect.getmembers
647
 
                                (cls, self._is_dbus_property)):
 
904
                                (cls,
 
905
                                 self._is_dbus_thing("property"))):
648
906
                if (value._dbus_name == property_name
649
907
                    and value._dbus_interface == interface_name):
650
908
                    return value.__get__(self)
678
936
            # The byte_arrays option is not supported yet on
679
937
            # signatures other than "ay".
680
938
            if prop._dbus_signature != "ay":
681
 
                raise ValueError
682
 
            value = dbus.ByteArray(''.join(unichr(byte)
683
 
                                           for byte in value))
 
939
                raise ValueError("Byte arrays not supported for non-"
 
940
                                 "'ay' signature {0!r}"
 
941
                                 .format(prop._dbus_signature))
 
942
            value = dbus.ByteArray(b''.join(chr(byte)
 
943
                                            for byte in value))
684
944
        prop(value)
685
945
    
686
946
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
691
951
        
692
952
        Note: Will not include properties with access="write".
693
953
        """
694
 
        all = {}
695
 
        for name, prop in self._get_all_dbus_properties():
 
954
        properties = {}
 
955
        for name, prop in self._get_all_dbus_things("property"):
696
956
            if (interface_name
697
957
                and interface_name != prop._dbus_interface):
698
958
                # Interface non-empty but did not match
702
962
                continue
703
963
            value = prop()
704
964
            if not hasattr(value, "variant_level"):
705
 
                all[name] = value
 
965
                properties[name] = value
706
966
                continue
707
 
            all[name] = type(value)(value, variant_level=
708
 
                                    value.variant_level+1)
709
 
        return dbus.Dictionary(all, signature="sv")
 
967
            properties[name] = type(value)(value, variant_level=
 
968
                                           value.variant_level+1)
 
969
        return dbus.Dictionary(properties, signature="sv")
710
970
    
711
971
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
712
972
                         out_signature="s",
713
973
                         path_keyword='object_path',
714
974
                         connection_keyword='connection')
715
975
    def Introspect(self, object_path, connection):
716
 
        """Standard D-Bus method, overloaded to insert property tags.
 
976
        """Overloading of standard D-Bus method.
 
977
        
 
978
        Inserts property tags and interface annotation tags.
717
979
        """
718
980
        xmlstring = dbus.service.Object.Introspect(self, object_path,
719
981
                                                   connection)
726
988
                e.setAttribute("access", prop._dbus_access)
727
989
                return e
728
990
            for if_tag in document.getElementsByTagName("interface"):
 
991
                # Add property tags
729
992
                for tag in (make_tag(document, name, prop)
730
993
                            for name, prop
731
 
                            in self._get_all_dbus_properties()
 
994
                            in self._get_all_dbus_things("property")
732
995
                            if prop._dbus_interface
733
996
                            == if_tag.getAttribute("name")):
734
997
                    if_tag.appendChild(tag)
 
998
                # Add annotation tags
 
999
                for typ in ("method", "signal", "property"):
 
1000
                    for tag in if_tag.getElementsByTagName(typ):
 
1001
                        annots = dict()
 
1002
                        for name, prop in (self.
 
1003
                                           _get_all_dbus_things(typ)):
 
1004
                            if (name == tag.getAttribute("name")
 
1005
                                and prop._dbus_interface
 
1006
                                == if_tag.getAttribute("name")):
 
1007
                                annots.update(getattr
 
1008
                                              (prop,
 
1009
                                               "_dbus_annotations",
 
1010
                                               {}))
 
1011
                        for name, value in annots.iteritems():
 
1012
                            ann_tag = document.createElement(
 
1013
                                "annotation")
 
1014
                            ann_tag.setAttribute("name", name)
 
1015
                            ann_tag.setAttribute("value", value)
 
1016
                            tag.appendChild(ann_tag)
 
1017
                # Add interface annotation tags
 
1018
                for annotation, value in dict(
 
1019
                    itertools.chain.from_iterable(
 
1020
                        annotations().iteritems()
 
1021
                        for name, annotations in
 
1022
                        self._get_all_dbus_things("interface")
 
1023
                        if name == if_tag.getAttribute("name")
 
1024
                        )).iteritems():
 
1025
                    ann_tag = document.createElement("annotation")
 
1026
                    ann_tag.setAttribute("name", annotation)
 
1027
                    ann_tag.setAttribute("value", value)
 
1028
                    if_tag.appendChild(ann_tag)
735
1029
                # Add the names to the return values for the
736
1030
                # "org.freedesktop.DBus.Properties" methods
737
1031
                if (if_tag.getAttribute("name")
752
1046
        except (AttributeError, xml.dom.DOMException,
753
1047
                xml.parsers.expat.ExpatError) as error:
754
1048
            logger.error("Failed to override Introspection method",
755
 
                         error)
 
1049
                         exc_info=error)
756
1050
        return xmlstring
757
1051
 
758
1052
 
759
 
def datetime_to_dbus (dt, variant_level=0):
 
1053
def datetime_to_dbus(dt, variant_level=0):
760
1054
    """Convert a UTC datetime.datetime() to a D-Bus type."""
761
1055
    if dt is None:
762
1056
        return dbus.String("", variant_level = variant_level)
763
1057
    return dbus.String(dt.isoformat(),
764
1058
                       variant_level=variant_level)
765
1059
 
766
 
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
767
 
                                  .__metaclass__):
768
 
    """Applied to an empty subclass of a D-Bus object, this metaclass
769
 
    will add additional D-Bus attributes matching a certain pattern.
 
1060
 
 
1061
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
 
1062
    """A class decorator; applied to a subclass of
 
1063
    dbus.service.Object, it will add alternate D-Bus attributes with
 
1064
    interface names according to the "alt_interface_names" mapping.
 
1065
    Usage:
 
1066
    
 
1067
    @alternate_dbus_interfaces({"org.example.Interface":
 
1068
                                    "net.example.AlternateInterface"})
 
1069
    class SampleDBusObject(dbus.service.Object):
 
1070
        @dbus.service.method("org.example.Interface")
 
1071
        def SampleDBusMethod():
 
1072
            pass
 
1073
    
 
1074
    The above "SampleDBusMethod" on "SampleDBusObject" will be
 
1075
    reachable via two interfaces: "org.example.Interface" and
 
1076
    "net.example.AlternateInterface", the latter of which will have
 
1077
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
 
1078
    "true", unless "deprecate" is passed with a False value.
 
1079
    
 
1080
    This works for methods and signals, and also for D-Bus properties
 
1081
    (from DBusObjectWithProperties) and interfaces (from the
 
1082
    dbus_interface_annotations decorator).
770
1083
    """
771
 
    def __new__(mcs, name, bases, attr):
772
 
        # Go through all the base classes which could have D-Bus
773
 
        # methods, signals, or properties in them
774
 
        for base in (b for b in bases
775
 
                     if issubclass(b, dbus.service.Object)):
776
 
            # Go though all attributes of the base class
777
 
            for attrname, attribute in inspect.getmembers(base):
 
1084
    def wrapper(cls):
 
1085
        for orig_interface_name, alt_interface_name in (
 
1086
            alt_interface_names.iteritems()):
 
1087
            attr = {}
 
1088
            interface_names = set()
 
1089
            # Go though all attributes of the class
 
1090
            for attrname, attribute in inspect.getmembers(cls):
778
1091
                # Ignore non-D-Bus attributes, and D-Bus attributes
779
1092
                # with the wrong interface name
780
1093
                if (not hasattr(attribute, "_dbus_interface")
781
1094
                    or not attribute._dbus_interface
782
 
                    .startswith("se.recompile.Mandos")):
 
1095
                    .startswith(orig_interface_name)):
783
1096
                    continue
784
1097
                # Create an alternate D-Bus interface name based on
785
1098
                # the current name
786
1099
                alt_interface = (attribute._dbus_interface
787
 
                                 .replace("se.recompile.Mandos",
788
 
                                          "se.bsnet.fukt.Mandos"))
 
1100
                                 .replace(orig_interface_name,
 
1101
                                          alt_interface_name))
 
1102
                interface_names.add(alt_interface)
789
1103
                # Is this a D-Bus signal?
790
1104
                if getattr(attribute, "_dbus_is_signal", False):
791
 
                    # Extract the original non-method function by
792
 
                    # black magic
 
1105
                    # Extract the original non-method undecorated
 
1106
                    # function by black magic
793
1107
                    nonmethod_func = (dict(
794
1108
                            zip(attribute.func_code.co_freevars,
795
1109
                                attribute.__closure__))["func"]
806
1120
                                nonmethod_func.func_name,
807
1121
                                nonmethod_func.func_defaults,
808
1122
                                nonmethod_func.func_closure)))
 
1123
                    # Copy annotations, if any
 
1124
                    try:
 
1125
                        new_function._dbus_annotations = (
 
1126
                            dict(attribute._dbus_annotations))
 
1127
                    except AttributeError:
 
1128
                        pass
809
1129
                    # Define a creator of a function to call both the
810
 
                    # old and new functions, so both the old and new
811
 
                    # signals gets sent when the function is called
 
1130
                    # original and alternate functions, so both the
 
1131
                    # original and alternate signals gets sent when
 
1132
                    # the function is called
812
1133
                    def fixscope(func1, func2):
813
1134
                        """This function is a scope container to pass
814
1135
                        func1 and func2 to the "call_both" function
821
1142
                        return call_both
822
1143
                    # Create the "call_both" function and add it to
823
1144
                    # the class
824
 
                    attr[attrname] = fixscope(attribute,
825
 
                                              new_function)
 
1145
                    attr[attrname] = fixscope(attribute, new_function)
826
1146
                # Is this a D-Bus method?
827
1147
                elif getattr(attribute, "_dbus_is_method", False):
828
1148
                    # Create a new, but exactly alike, function
839
1159
                                        attribute.func_name,
840
1160
                                        attribute.func_defaults,
841
1161
                                        attribute.func_closure)))
 
1162
                    # Copy annotations, if any
 
1163
                    try:
 
1164
                        attr[attrname]._dbus_annotations = (
 
1165
                            dict(attribute._dbus_annotations))
 
1166
                    except AttributeError:
 
1167
                        pass
842
1168
                # Is this a D-Bus property?
843
1169
                elif getattr(attribute, "_dbus_is_property", False):
844
1170
                    # Create a new, but exactly alike, function
858
1184
                                        attribute.func_name,
859
1185
                                        attribute.func_defaults,
860
1186
                                        attribute.func_closure)))
861
 
        return type.__new__(mcs, name, bases, attr)
862
 
 
 
1187
                    # Copy annotations, if any
 
1188
                    try:
 
1189
                        attr[attrname]._dbus_annotations = (
 
1190
                            dict(attribute._dbus_annotations))
 
1191
                    except AttributeError:
 
1192
                        pass
 
1193
                # Is this a D-Bus interface?
 
1194
                elif getattr(attribute, "_dbus_is_interface", False):
 
1195
                    # Create a new, but exactly alike, function
 
1196
                    # object.  Decorate it to be a new D-Bus interface
 
1197
                    # with the alternate D-Bus interface name.  Add it
 
1198
                    # to the class.
 
1199
                    attr[attrname] = (dbus_interface_annotations
 
1200
                                      (alt_interface)
 
1201
                                      (types.FunctionType
 
1202
                                       (attribute.func_code,
 
1203
                                        attribute.func_globals,
 
1204
                                        attribute.func_name,
 
1205
                                        attribute.func_defaults,
 
1206
                                        attribute.func_closure)))
 
1207
            if deprecate:
 
1208
                # Deprecate all alternate interfaces
 
1209
                iname="_AlternateDBusNames_interface_annotation{0}"
 
1210
                for interface_name in interface_names:
 
1211
                    @dbus_interface_annotations(interface_name)
 
1212
                    def func(self):
 
1213
                        return { "org.freedesktop.DBus.Deprecated":
 
1214
                                     "true" }
 
1215
                    # Find an unused name
 
1216
                    for aname in (iname.format(i)
 
1217
                                  for i in itertools.count()):
 
1218
                        if aname not in attr:
 
1219
                            attr[aname] = func
 
1220
                            break
 
1221
            if interface_names:
 
1222
                # Replace the class with a new subclass of it with
 
1223
                # methods, signals, etc. as created above.
 
1224
                cls = type(b"{0}Alternate".format(cls.__name__),
 
1225
                           (cls,), attr)
 
1226
        return cls
 
1227
    return wrapper
 
1228
 
 
1229
 
 
1230
@alternate_dbus_interfaces({"se.recompile.Mandos":
 
1231
                                "se.bsnet.fukt.Mandos"})
863
1232
class ClientDBus(Client, DBusObjectWithProperties):
864
1233
    """A Client class using D-Bus
865
1234
    
874
1243
    # dbus.service.Object doesn't use super(), so we can't either.
875
1244
    
876
1245
    def __init__(self, bus = None, *args, **kwargs):
877
 
        self._approvals_pending = 0
878
1246
        self.bus = bus
879
1247
        Client.__init__(self, *args, **kwargs)
880
1248
        # Only now, when this client is initialized, can it show up on
886
1254
                                 ("/clients/" + client_object_name))
887
1255
        DBusObjectWithProperties.__init__(self, self.bus,
888
1256
                                          self.dbus_object_path)
889
 
        
 
1257
    
890
1258
    def notifychangeproperty(transform_func,
891
1259
                             dbus_name, type_func=lambda x: x,
892
1260
                             variant_level=1):
893
1261
        """ Modify a variable so that it's a property which announces
894
1262
        its changes to DBus.
895
 
 
 
1263
        
896
1264
        transform_fun: Function that takes a value and a variant_level
897
1265
                       and transforms it to a D-Bus type.
898
1266
        dbus_name: D-Bus name of the variable
915
1283
        
916
1284
        return property(lambda self: getattr(self, attrname), setter)
917
1285
    
918
 
    
919
1286
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
920
1287
    approvals_pending = notifychangeproperty(dbus.Boolean,
921
1288
                                             "ApprovalPending",
928
1295
                                       checker is not None)
929
1296
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
930
1297
                                           "LastCheckedOK")
 
1298
    last_checker_status = notifychangeproperty(dbus.Int16,
 
1299
                                               "LastCheckerStatus")
931
1300
    last_approval_request = notifychangeproperty(
932
1301
        datetime_to_dbus, "LastApprovalRequest")
933
1302
    approved_by_default = notifychangeproperty(dbus.Boolean,
934
1303
                                               "ApprovedByDefault")
935
 
    approval_delay = notifychangeproperty(dbus.UInt16,
 
1304
    approval_delay = notifychangeproperty(dbus.UInt64,
936
1305
                                          "ApprovalDelay",
937
1306
                                          type_func =
938
 
                                          _timedelta_to_milliseconds)
 
1307
                                          timedelta_to_milliseconds)
939
1308
    approval_duration = notifychangeproperty(
940
 
        dbus.UInt16, "ApprovalDuration",
941
 
        type_func = _timedelta_to_milliseconds)
 
1309
        dbus.UInt64, "ApprovalDuration",
 
1310
        type_func = timedelta_to_milliseconds)
942
1311
    host = notifychangeproperty(dbus.String, "Host")
943
 
    timeout = notifychangeproperty(dbus.UInt16, "Timeout",
 
1312
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
944
1313
                                   type_func =
945
 
                                   _timedelta_to_milliseconds)
 
1314
                                   timedelta_to_milliseconds)
946
1315
    extended_timeout = notifychangeproperty(
947
 
        dbus.UInt16, "ExtendedTimeout",
948
 
        type_func = _timedelta_to_milliseconds)
949
 
    interval = notifychangeproperty(dbus.UInt16,
 
1316
        dbus.UInt64, "ExtendedTimeout",
 
1317
        type_func = timedelta_to_milliseconds)
 
1318
    interval = notifychangeproperty(dbus.UInt64,
950
1319
                                    "Interval",
951
1320
                                    type_func =
952
 
                                    _timedelta_to_milliseconds)
 
1321
                                    timedelta_to_milliseconds)
953
1322
    checker_command = notifychangeproperty(dbus.String, "Checker")
954
1323
    
955
1324
    del notifychangeproperty
983
1352
                                       *args, **kwargs)
984
1353
    
985
1354
    def start_checker(self, *args, **kwargs):
986
 
        old_checker = self.checker
987
 
        if self.checker is not None:
988
 
            old_checker_pid = self.checker.pid
989
 
        else:
990
 
            old_checker_pid = None
 
1355
        old_checker_pid = getattr(self.checker, "pid", None)
991
1356
        r = Client.start_checker(self, *args, **kwargs)
992
1357
        # Only if new checker process was started
993
1358
        if (self.checker is not None
997
1362
        return r
998
1363
    
999
1364
    def _reset_approved(self):
1000
 
        self._approved = None
 
1365
        self.approved = None
1001
1366
        return False
1002
1367
    
1003
1368
    def approve(self, value=True):
1004
 
        self.send_changedstate()
1005
 
        self._approved = value
1006
 
        gobject.timeout_add(_timedelta_to_milliseconds
 
1369
        self.approved = value
 
1370
        gobject.timeout_add(timedelta_to_milliseconds
1007
1371
                            (self.approval_duration),
1008
1372
                            self._reset_approved)
1009
 
    
 
1373
        self.send_changedstate()
1010
1374
    
1011
1375
    ## D-Bus methods, signals & properties
1012
1376
    _interface = "se.recompile.Mandos.Client"
1013
1377
    
 
1378
    ## Interfaces
 
1379
    
 
1380
    @dbus_interface_annotations(_interface)
 
1381
    def _foo(self):
 
1382
        return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
1383
                     "false"}
 
1384
    
1014
1385
    ## Signals
1015
1386
    
1016
1387
    # CheckerCompleted - signal
1115
1486
                           access="readwrite")
1116
1487
    def ApprovalDuration_dbus_property(self, value=None):
1117
1488
        if value is None:       # get
1118
 
            return dbus.UInt64(_timedelta_to_milliseconds(
 
1489
            return dbus.UInt64(timedelta_to_milliseconds(
1119
1490
                    self.approval_duration))
1120
1491
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1121
1492
    
1135
1506
    def Host_dbus_property(self, value=None):
1136
1507
        if value is None:       # get
1137
1508
            return dbus.String(self.host)
1138
 
        self.host = value
 
1509
        self.host = unicode(value)
1139
1510
    
1140
1511
    # Created - property
1141
1512
    @dbus_service_property(_interface, signature="s", access="read")
1142
1513
    def Created_dbus_property(self):
1143
 
        return dbus.String(datetime_to_dbus(self.created))
 
1514
        return datetime_to_dbus(self.created)
1144
1515
    
1145
1516
    # LastEnabled - property
1146
1517
    @dbus_service_property(_interface, signature="s", access="read")
1167
1538
            return
1168
1539
        return datetime_to_dbus(self.last_checked_ok)
1169
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
    
1170
1547
    # Expires - property
1171
1548
    @dbus_service_property(_interface, signature="s", access="read")
1172
1549
    def Expires_dbus_property(self):
1183
1560
    def Timeout_dbus_property(self, value=None):
1184
1561
        if value is None:       # get
1185
1562
            return dbus.UInt64(self.timeout_milliseconds())
 
1563
        old_timeout = self.timeout
1186
1564
        self.timeout = datetime.timedelta(0, 0, 0, value)
1187
 
        if getattr(self, "disable_initiator_tag", None) is None:
1188
 
            return
1189
 
        # Reschedule timeout
1190
 
        gobject.source_remove(self.disable_initiator_tag)
1191
 
        self.disable_initiator_tag = None
1192
 
        self.expires = None
1193
 
        time_to_die = _timedelta_to_milliseconds((self
1194
 
                                                  .last_checked_ok
1195
 
                                                  + self.timeout)
1196
 
                                                 - datetime.datetime
1197
 
                                                 .utcnow())
1198
 
        if time_to_die <= 0:
1199
 
            # The timeout has passed
1200
 
            self.disable()
1201
 
        else:
1202
 
            self.expires = (datetime.datetime.utcnow()
1203
 
                            + datetime.timedelta(milliseconds =
1204
 
                                                 time_to_die))
1205
 
            self.disable_initiator_tag = (gobject.timeout_add
1206
 
                                          (time_to_die, self.disable))
 
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))
1207
1581
    
1208
1582
    # ExtendedTimeout - property
1209
1583
    @dbus_service_property(_interface, signature="t",
1222
1596
        self.interval = datetime.timedelta(0, 0, 0, value)
1223
1597
        if getattr(self, "checker_initiator_tag", None) is None:
1224
1598
            return
1225
 
        # Reschedule checker run
1226
 
        gobject.source_remove(self.checker_initiator_tag)
1227
 
        self.checker_initiator_tag = (gobject.timeout_add
1228
 
                                      (value, self.start_checker))
1229
 
        self.start_checker()    # Start one now, too
 
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
1230
1605
    
1231
1606
    # Checker - property
1232
1607
    @dbus_service_property(_interface, signature="s",
1234
1609
    def Checker_dbus_property(self, value=None):
1235
1610
        if value is None:       # get
1236
1611
            return dbus.String(self.checker_command)
1237
 
        self.checker_command = value
 
1612
        self.checker_command = unicode(value)
1238
1613
    
1239
1614
    # CheckerRunning - property
1240
1615
    @dbus_service_property(_interface, signature="b",
1269
1644
            raise KeyError()
1270
1645
    
1271
1646
    def __getattribute__(self, name):
1272
 
        if(name == '_pipe'):
 
1647
        if name == '_pipe':
1273
1648
            return super(ProxyClient, self).__getattribute__(name)
1274
1649
        self._pipe.send(('getattr', name))
1275
1650
        data = self._pipe.recv()
1282
1657
            return func
1283
1658
    
1284
1659
    def __setattr__(self, name, value):
1285
 
        if(name == '_pipe'):
 
1660
        if name == '_pipe':
1286
1661
            return super(ProxyClient, self).__setattr__(name, value)
1287
1662
        self._pipe.send(('setattr', name, value))
1288
1663
 
1289
 
class ClientDBusTransitional(ClientDBus):
1290
 
    __metaclass__ = AlternateDBusNamesMetaclass
1291
1664
 
1292
1665
class ClientHandler(socketserver.BaseRequestHandler, object):
1293
1666
    """A class to handle client connections.
1330
1703
            logger.debug("Protocol version: %r", line)
1331
1704
            try:
1332
1705
                if int(line.strip().split()[0]) > 1:
1333
 
                    raise RuntimeError
 
1706
                    raise RuntimeError(line)
1334
1707
            except (ValueError, IndexError, RuntimeError) as error:
1335
1708
                logger.error("Unknown protocol version: %s", error)
1336
1709
                return
1376
1749
                            client.Rejected("Disabled")
1377
1750
                        return
1378
1751
                    
1379
 
                    if client._approved or not client.approval_delay:
 
1752
                    if client.approved or not client.approval_delay:
1380
1753
                        #We are approved or approval is disabled
1381
1754
                        break
1382
 
                    elif client._approved is None:
 
1755
                    elif client.approved is None:
1383
1756
                        logger.info("Client %s needs approval",
1384
1757
                                    client.name)
1385
1758
                        if self.server.use_dbus:
1398
1771
                    #wait until timeout or approved
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)
1431
1805
                
1432
1806
                logger.info("Sending secret to %s", client.name)
1433
1807
                # bump the timeout using extended_timeout
1434
 
                client.checked_ok(client.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
1897
        proc = multiprocessing.Process(target = self.sub_process_main,
1523
 
                                       args = (request,
1524
 
                                               address))
 
1898
                                       args = (request, address))
1525
1899
        proc.start()
1526
1900
        return proc
1527
1901
 
1542
1916
    
1543
1917
    def add_pipe(self, parent_pipe, proc):
1544
1918
        """Dummy function; override as necessary"""
1545
 
        raise NotImplementedError
 
1919
        raise NotImplementedError()
1546
1920
 
1547
1921
 
1548
1922
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1555
1929
        use_ipv6:       Boolean; to use IPv6 or not
1556
1930
    """
1557
1931
    def __init__(self, server_address, RequestHandlerClass,
1558
 
                 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
        """
1559
1936
        self.interface = interface
1560
1937
        if use_ipv6:
1561
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.
1562
1965
        socketserver.TCPServer.__init__(self, server_address,
1563
1966
                                        RequestHandlerClass)
 
1967
    
1564
1968
    def server_bind(self):
1565
1969
        """This overrides the normal server_bind() function
1566
1970
        to bind to an interface if one was specified, and also NOT to
1574
1978
                try:
1575
1979
                    self.socket.setsockopt(socket.SOL_SOCKET,
1576
1980
                                           SO_BINDTODEVICE,
1577
 
                                           str(self.interface
1578
 
                                               + '\0'))
 
1981
                                           str(self.interface + '\0'))
1579
1982
                except socket.error as error:
1580
 
                    if error[0] == errno.EPERM:
1581
 
                        logger.error("No permission to"
1582
 
                                     " bind to interface %s",
1583
 
                                     self.interface)
1584
 
                    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:
1585
1987
                        logger.error("SO_BINDTODEVICE not available;"
1586
1988
                                     " cannot bind to interface %s",
1587
1989
                                     self.interface)
 
1990
                    elif error.errno == errno.ENODEV:
 
1991
                        logger.error("Interface %s does not exist,"
 
1992
                                     " cannot bind", self.interface)
1588
1993
                    else:
1589
1994
                        raise
1590
1995
        # Only bind(2) the socket if we really need to.
1593
1998
                if self.address_family == socket.AF_INET6:
1594
1999
                    any_address = "::" # in6addr_any
1595
2000
                else:
1596
 
                    any_address = socket.INADDR_ANY
 
2001
                    any_address = "0.0.0.0" # INADDR_ANY
1597
2002
                self.server_address = (any_address,
1598
2003
                                       self.server_address[1])
1599
2004
            elif not self.server_address[1]:
1620
2025
    """
1621
2026
    def __init__(self, server_address, RequestHandlerClass,
1622
2027
                 interface=None, use_ipv6=True, clients=None,
1623
 
                 gnutls_priority=None, use_dbus=True):
 
2028
                 gnutls_priority=None, use_dbus=True, socketfd=None):
1624
2029
        self.enabled = False
1625
2030
        self.clients = clients
1626
2031
        if self.clients is None:
1627
 
            self.clients = set()
 
2032
            self.clients = {}
1628
2033
        self.use_dbus = use_dbus
1629
2034
        self.gnutls_priority = gnutls_priority
1630
2035
        IPv6_TCPServer.__init__(self, server_address,
1631
2036
                                RequestHandlerClass,
1632
2037
                                interface = interface,
1633
 
                                use_ipv6 = use_ipv6)
 
2038
                                use_ipv6 = use_ipv6,
 
2039
                                socketfd = socketfd)
1634
2040
    def server_activate(self):
1635
2041
        if self.enabled:
1636
2042
            return socketserver.TCPServer.server_activate(self)
1649
2055
    
1650
2056
    def handle_ipc(self, source, condition, parent_pipe=None,
1651
2057
                   proc = None, client_object=None):
1652
 
        condition_names = {
1653
 
            gobject.IO_IN: "IN",   # There is data to read.
1654
 
            gobject.IO_OUT: "OUT", # Data can be written (without
1655
 
                                    # blocking).
1656
 
            gobject.IO_PRI: "PRI", # There is urgent data to read.
1657
 
            gobject.IO_ERR: "ERR", # Error condition.
1658
 
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
1659
 
                                    # broken, usually for pipes and
1660
 
                                    # sockets).
1661
 
            }
1662
 
        conditions_string = ' | '.join(name
1663
 
                                       for cond, name in
1664
 
                                       condition_names.iteritems()
1665
 
                                       if cond & condition)
1666
2058
        # error, or the other end of multiprocessing.Pipe has closed
1667
 
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
 
2059
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
1668
2060
            # Wait for other process to exit
1669
2061
            proc.join()
1670
2062
            return False
1677
2069
            fpr = request[1]
1678
2070
            address = request[2]
1679
2071
            
1680
 
            for c in self.clients:
 
2072
            for c in self.clients.itervalues():
1681
2073
                if c.fingerprint == fpr:
1682
2074
                    client = c
1683
2075
                    break
1728
2120
        return True
1729
2121
 
1730
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
 
1731
2222
def string_to_delta(interval):
1732
2223
    """Parse a string and return a datetime.timedelta
1733
2224
    
1744
2235
    >>> string_to_delta('5m 30s')
1745
2236
    datetime.timedelta(0, 330)
1746
2237
    """
 
2238
    
 
2239
    try:
 
2240
        return rfc3339_duration_to_delta(interval)
 
2241
    except ValueError:
 
2242
        pass
 
2243
    
1747
2244
    timevalue = datetime.timedelta(0)
1748
2245
    for s in interval.split():
1749
2246
        try:
1760
2257
            elif suffix == "w":
1761
2258
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1762
2259
            else:
1763
 
                raise ValueError("Unknown suffix %r" % suffix)
1764
 
        except (ValueError, IndexError) as e:
 
2260
                raise ValueError("Unknown suffix {0!r}"
 
2261
                                 .format(suffix))
 
2262
        except IndexError as e:
1765
2263
            raise ValueError(*(e.args))
1766
2264
        timevalue += delta
1767
2265
    return timevalue
1768
2266
 
1769
2267
 
1770
 
def if_nametoindex(interface):
1771
 
    """Call the C function if_nametoindex(), or equivalent
1772
 
    
1773
 
    Note: This function cannot accept a unicode string."""
1774
 
    global if_nametoindex
1775
 
    try:
1776
 
        if_nametoindex = (ctypes.cdll.LoadLibrary
1777
 
                          (ctypes.util.find_library("c"))
1778
 
                          .if_nametoindex)
1779
 
    except (OSError, AttributeError):
1780
 
        logger.warning("Doing if_nametoindex the hard way")
1781
 
        def if_nametoindex(interface):
1782
 
            "Get an interface index the hard way, i.e. using fcntl()"
1783
 
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
1784
 
            with contextlib.closing(socket.socket()) as s:
1785
 
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1786
 
                                    struct.pack(str("16s16x"),
1787
 
                                                interface))
1788
 
            interface_index = struct.unpack(str("I"),
1789
 
                                            ifreq[16:20])[0]
1790
 
            return interface_index
1791
 
    return if_nametoindex(interface)
1792
 
 
1793
 
 
1794
2268
def daemon(nochdir = False, noclose = False):
1795
2269
    """See daemon(3).  Standard BSD Unix function.
1796
2270
    
1804
2278
        sys.exit()
1805
2279
    if not noclose:
1806
2280
        # Close all standard open file descriptors
1807
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2281
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1808
2282
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1809
2283
            raise OSError(errno.ENODEV,
1810
 
                          "%s not a character device"
1811
 
                          % os.path.devnull)
 
2284
                          "{0} not a character device"
 
2285
                          .format(os.devnull))
1812
2286
        os.dup2(null, sys.stdin.fileno())
1813
2287
        os.dup2(null, sys.stdout.fileno())
1814
2288
        os.dup2(null, sys.stderr.fileno())
1823
2297
    
1824
2298
    parser = argparse.ArgumentParser()
1825
2299
    parser.add_argument("-v", "--version", action="version",
1826
 
                        version = "%%(prog)s %s" % version,
 
2300
                        version = "%(prog)s {0}".format(version),
1827
2301
                        help="show version number and exit")
1828
2302
    parser.add_argument("-i", "--interface", metavar="IF",
1829
2303
                        help="Bind to interface IF")
1835
2309
                        help="Run self-test")
1836
2310
    parser.add_argument("--debug", action="store_true",
1837
2311
                        help="Debug mode; run in foreground and log"
1838
 
                        " to terminal")
 
2312
                        " to terminal", default=None)
1839
2313
    parser.add_argument("--debuglevel", metavar="LEVEL",
1840
2314
                        help="Debug level for stdout output")
1841
2315
    parser.add_argument("--priority", help="GnuTLS"
1848
2322
                        " files")
1849
2323
    parser.add_argument("--no-dbus", action="store_false",
1850
2324
                        dest="use_dbus", help="Do not provide D-Bus"
1851
 
                        " system bus interface")
 
2325
                        " system bus interface", default=None)
1852
2326
    parser.add_argument("--no-ipv6", action="store_false",
1853
 
                        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
    
1854
2340
    options = parser.parse_args()
1855
2341
    
1856
2342
    if options.check:
1857
2343
        import doctest
1858
 
        doctest.testmod()
1859
 
        sys.exit()
 
2344
        fail_count, test_count = doctest.testmod()
 
2345
        sys.exit(os.EX_OK if fail_count == 0 else 1)
1860
2346
    
1861
2347
    # Default values for config file for server-global settings
1862
2348
    server_defaults = { "interface": "",
1864
2350
                        "port": "",
1865
2351
                        "debug": "False",
1866
2352
                        "priority":
1867
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
2353
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
1868
2354
                        "servicename": "Mandos",
1869
2355
                        "use_dbus": "True",
1870
2356
                        "use_ipv6": "True",
1871
2357
                        "debuglevel": "",
 
2358
                        "restore": "True",
 
2359
                        "socket": "",
 
2360
                        "statedir": "/var/lib/mandos",
 
2361
                        "foreground": "False",
1872
2362
                        }
1873
2363
    
1874
2364
    # Parse config file for server-global settings
1879
2369
    # Convert the SafeConfigParser object to a dict
1880
2370
    server_settings = server_config.defaults()
1881
2371
    # Use the appropriate methods on the non-string config options
1882
 
    for option in ("debug", "use_dbus", "use_ipv6"):
 
2372
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
1883
2373
        server_settings[option] = server_config.getboolean("DEFAULT",
1884
2374
                                                           option)
1885
2375
    if server_settings["port"]:
1886
2376
        server_settings["port"] = server_config.getint("DEFAULT",
1887
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"])
1888
2387
    del server_config
1889
2388
    
1890
2389
    # Override the settings from the config file with command line
1891
2390
    # options, if set.
1892
2391
    for option in ("interface", "address", "port", "debug",
1893
2392
                   "priority", "servicename", "configdir",
1894
 
                   "use_dbus", "use_ipv6", "debuglevel"):
 
2393
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
 
2394
                   "statedir", "socket", "foreground"):
1895
2395
        value = getattr(options, option)
1896
2396
        if value is not None:
1897
2397
            server_settings[option] = value
1900
2400
    for option in server_settings.keys():
1901
2401
        if type(server_settings[option]) is str:
1902
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
1903
2410
    # Now we have our good server settings in "server_settings"
1904
2411
    
1905
2412
    ##################################################################
1909
2416
    debuglevel = server_settings["debuglevel"]
1910
2417
    use_dbus = server_settings["use_dbus"]
1911
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)
1912
2431
    
1913
2432
    if server_settings["servicename"] != "Mandos":
1914
2433
        syslogger.setFormatter(logging.Formatter
1915
 
                               ('Mandos (%s) [%%(process)d]:'
1916
 
                                ' %%(levelname)s: %%(message)s'
1917
 
                                % server_settings["servicename"]))
 
2434
                               ('Mandos ({0}) [%(process)d]:'
 
2435
                                ' %(levelname)s: %(message)s'
 
2436
                                .format(server_settings
 
2437
                                        ["servicename"])))
1918
2438
    
1919
2439
    # Parse config file with clients
1920
 
    client_defaults = { "timeout": "5m",
1921
 
                        "extended_timeout": "15m",
1922
 
                        "interval": "2m",
1923
 
                        "checker": "fping -q -- %%(host)s",
1924
 
                        "host": "",
1925
 
                        "approval_delay": "0s",
1926
 
                        "approval_duration": "1s",
1927
 
                        }
1928
 
    client_config = configparser.SafeConfigParser(client_defaults)
 
2440
    client_config = configparser.SafeConfigParser(Client
 
2441
                                                  .client_defaults)
1929
2442
    client_config.read(os.path.join(server_settings["configdir"],
1930
2443
                                    "clients.conf"))
1931
2444
    
1940
2453
                              use_ipv6=use_ipv6,
1941
2454
                              gnutls_priority=
1942
2455
                              server_settings["priority"],
1943
 
                              use_dbus=use_dbus)
1944
 
    if not debug:
1945
 
        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
1946
2464
        try:
1947
2465
            pidfile = open(pidfilename, "w")
1948
 
        except IOError:
1949
 
            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)
1950
2469
    
1951
 
    try:
1952
 
        uid = pwd.getpwnam("_mandos").pw_uid
1953
 
        gid = pwd.getpwnam("_mandos").pw_gid
1954
 
    except KeyError:
 
2470
    for name in ("_mandos", "mandos", "nobody"):
1955
2471
        try:
1956
 
            uid = pwd.getpwnam("mandos").pw_uid
1957
 
            gid = pwd.getpwnam("mandos").pw_gid
 
2472
            uid = pwd.getpwnam(name).pw_uid
 
2473
            gid = pwd.getpwnam(name).pw_gid
 
2474
            break
1958
2475
        except KeyError:
1959
 
            try:
1960
 
                uid = pwd.getpwnam("nobody").pw_uid
1961
 
                gid = pwd.getpwnam("nobody").pw_gid
1962
 
            except KeyError:
1963
 
                uid = 65534
1964
 
                gid = 65534
 
2476
            continue
 
2477
    else:
 
2478
        uid = 65534
 
2479
        gid = 65534
1965
2480
    try:
1966
2481
        os.setgid(gid)
1967
2482
        os.setuid(uid)
1968
2483
    except OSError as error:
1969
 
        if error[0] != errno.EPERM:
1970
 
            raise error
1971
 
    
1972
 
    if not debug and not debuglevel:
1973
 
        syslogger.setLevel(logging.WARNING)
1974
 
        console.setLevel(logging.WARNING)
1975
 
    if debuglevel:
1976
 
        level = getattr(logging, debuglevel.upper())
1977
 
        syslogger.setLevel(level)
1978
 
        console.setLevel(level)
 
2484
        if error.errno != errno.EPERM:
 
2485
            raise
1979
2486
    
1980
2487
    if debug:
1981
2488
        # Enable all possible GnuTLS debugging
1992
2499
         .gnutls_global_set_log_function(debug_gnutls))
1993
2500
        
1994
2501
        # Redirect stdin so all checkers get /dev/null
1995
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2502
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1996
2503
        os.dup2(null, sys.stdin.fileno())
1997
2504
        if null > 2:
1998
2505
            os.close(null)
1999
 
    else:
2000
 
        # No console logging
2001
 
        logger.removeHandler(console)
2002
2506
    
2003
2507
    # Need to fork before connecting to D-Bus
2004
 
    if not debug:
 
2508
    if not foreground:
2005
2509
        # Close all input and output, do double fork, etc.
2006
2510
        daemon()
2007
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
    
2008
2516
    global main_loop
2009
2517
    # From the Avahi example code
2010
 
    DBusGMainLoop(set_as_default=True )
 
2518
    DBusGMainLoop(set_as_default=True)
2011
2519
    main_loop = gobject.MainLoop()
2012
2520
    bus = dbus.SystemBus()
2013
2521
    # End of Avahi example code
2019
2527
                            ("se.bsnet.fukt.Mandos", bus,
2020
2528
                             do_not_queue=True))
2021
2529
        except dbus.exceptions.NameExistsException as e:
2022
 
            logger.error(unicode(e) + ", disabling D-Bus")
 
2530
            logger.error("Disabling D-Bus:", exc_info=e)
2023
2531
            use_dbus = False
2024
2532
            server_settings["use_dbus"] = False
2025
2533
            tcp_server.use_dbus = False
2026
2534
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2027
 
    service = AvahiService(name = server_settings["servicename"],
2028
 
                           servicetype = "_mandos._tcp",
2029
 
                           protocol = protocol, bus = bus)
 
2535
    service = AvahiServiceToSyslog(name =
 
2536
                                   server_settings["servicename"],
 
2537
                                   servicetype = "_mandos._tcp",
 
2538
                                   protocol = protocol, bus = bus)
2030
2539
    if server_settings["interface"]:
2031
2540
        service.interface = (if_nametoindex
2032
2541
                             (str(server_settings["interface"])))
2036
2545
    
2037
2546
    client_class = Client
2038
2547
    if use_dbus:
2039
 
        client_class = functools.partial(ClientDBusTransitional,
2040
 
                                         bus = bus)
2041
 
    def client_config_items(config, section):
2042
 
        special_settings = {
2043
 
            "approved_by_default":
2044
 
                lambda: config.getboolean(section,
2045
 
                                          "approved_by_default"),
2046
 
            }
2047
 
        for name, value in config.items(section):
 
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))
2048
2631
            try:
2049
 
                yield (name, special_settings[name]())
2050
 
            except KeyError:
2051
 
                yield (name, value)
2052
 
    
2053
 
    tcp_server.clients.update(set(
2054
 
            client_class(name = section,
2055
 
                         config= dict(client_config_items(
2056
 
                        client_config, section)))
2057
 
            for section in client_config.sections()))
 
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
    
2058
2657
    if not tcp_server.clients:
2059
2658
        logger.warning("No clients defined")
2060
 
        
2061
 
    if not debug:
2062
 
        try:
2063
 
            with pidfile:
2064
 
                pid = os.getpid()
2065
 
                pidfile.write(str(pid) + "\n".encode("utf-8"))
2066
 
            del pidfile
2067
 
        except IOError:
2068
 
            logger.error("Could not write to file %r with PID %d",
2069
 
                         pidfilename, pid)
2070
 
        except NameError:
2071
 
            # "pidfile" was never created
2072
 
            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
2073
2670
        del pidfilename
2074
 
        
2075
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2076
2671
    
2077
2672
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2078
2673
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2079
2674
    
2080
2675
    if use_dbus:
2081
 
        class MandosDBusService(dbus.service.Object):
 
2676
        @alternate_dbus_interfaces({"se.recompile.Mandos":
 
2677
                                        "se.bsnet.fukt.Mandos"})
 
2678
        class MandosDBusService(DBusObjectWithProperties):
2082
2679
            """A D-Bus proxy object"""
2083
2680
            def __init__(self):
2084
2681
                dbus.service.Object.__init__(self, bus, "/")
2085
2682
            _interface = "se.recompile.Mandos"
2086
2683
            
 
2684
            @dbus_interface_annotations(_interface)
 
2685
            def _foo(self):
 
2686
                return { "org.freedesktop.DBus.Property"
 
2687
                         ".EmitsChangedSignal":
 
2688
                             "false"}
 
2689
            
2087
2690
            @dbus.service.signal(_interface, signature="o")
2088
2691
            def ClientAdded(self, objpath):
2089
2692
                "D-Bus signal"
2103
2706
            def GetAllClients(self):
2104
2707
                "D-Bus method"
2105
2708
                return dbus.Array(c.dbus_object_path
2106
 
                                  for c in tcp_server.clients)
 
2709
                                  for c in
 
2710
                                  tcp_server.clients.itervalues())
2107
2711
            
2108
2712
            @dbus.service.method(_interface,
2109
2713
                                 out_signature="a{oa{sv}}")
2111
2715
                "D-Bus method"
2112
2716
                return dbus.Dictionary(
2113
2717
                    ((c.dbus_object_path, c.GetAll(""))
2114
 
                     for c in tcp_server.clients),
 
2718
                     for c in tcp_server.clients.itervalues()),
2115
2719
                    signature="oa{sv}")
2116
2720
            
2117
2721
            @dbus.service.method(_interface, in_signature="o")
2118
2722
            def RemoveClient(self, object_path):
2119
2723
                "D-Bus method"
2120
 
                for c in tcp_server.clients:
 
2724
                for c in tcp_server.clients.itervalues():
2121
2725
                    if c.dbus_object_path == object_path:
2122
 
                        tcp_server.clients.remove(c)
 
2726
                        del tcp_server.clients[c.name]
2123
2727
                        c.remove_from_connection()
2124
2728
                        # Don't signal anything except ClientRemoved
2125
2729
                        c.disable(quiet=True)
2130
2734
            
2131
2735
            del _interface
2132
2736
        
2133
 
        class MandosDBusServiceTransitional(MandosDBusService):
2134
 
            __metaclass__ = AlternateDBusNamesMetaclass
2135
 
        mandos_dbus_service = MandosDBusServiceTransitional()
 
2737
        mandos_dbus_service = MandosDBusService()
2136
2738
    
2137
2739
    def cleanup():
2138
2740
        "Cleanup function; run on exit"
2139
2741
        service.cleanup()
2140
2742
        
2141
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
2142
2799
        while tcp_server.clients:
2143
 
            client = tcp_server.clients.pop()
 
2800
            name, client = tcp_server.clients.popitem()
2144
2801
            if use_dbus:
2145
2802
                client.remove_from_connection()
2146
 
            client.disable_hook = None
2147
2803
            # Don't signal anything except ClientRemoved
2148
2804
            client.disable(quiet=True)
2149
2805
            if use_dbus:
2151
2807
                mandos_dbus_service.ClientRemoved(client
2152
2808
                                                  .dbus_object_path,
2153
2809
                                                  client.name)
 
2810
        client_settings.clear()
2154
2811
    
2155
2812
    atexit.register(cleanup)
2156
2813
    
2157
 
    for client in tcp_server.clients:
 
2814
    for client in tcp_server.clients.itervalues():
2158
2815
        if use_dbus:
2159
2816
            # Emit D-Bus signal
2160
2817
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
2161
 
        client.enable()
 
2818
        # Need to initiate checking of clients
 
2819
        if client.enabled:
 
2820
            client.init_checker()
2162
2821
    
2163
2822
    tcp_server.enable()
2164
2823
    tcp_server.server_activate()
2167
2826
    service.port = tcp_server.socket.getsockname()[1]
2168
2827
    if use_ipv6:
2169
2828
        logger.info("Now listening on address %r, port %d,"
2170
 
                    " flowinfo %d, scope_id %d"
2171
 
                    % tcp_server.socket.getsockname())
 
2829
                    " flowinfo %d, scope_id %d",
 
2830
                    *tcp_server.socket.getsockname())
2172
2831
    else:                       # IPv4
2173
 
        logger.info("Now listening on address %r, port %d"
2174
 
                    % tcp_server.socket.getsockname())
 
2832
        logger.info("Now listening on address %r, port %d",
 
2833
                    *tcp_server.socket.getsockname())
2175
2834
    
2176
2835
    #service.interface = tcp_server.socket.getsockname()[3]
2177
2836
    
2180
2839
        try:
2181
2840
            service.activate()
2182
2841
        except dbus.exceptions.DBusException as error:
2183
 
            logger.critical("DBusException: %s", error)
 
2842
            logger.critical("D-Bus Exception", exc_info=error)
2184
2843
            cleanup()
2185
2844
            sys.exit(1)
2186
2845
        # End of Avahi example code
2193
2852
        logger.debug("Starting main loop")
2194
2853
        main_loop.run()
2195
2854
    except AvahiError as error:
2196
 
        logger.critical("AvahiError: %s", error)
 
2855
        logger.critical("Avahi Error", exc_info=error)
2197
2856
        cleanup()
2198
2857
        sys.exit(1)
2199
2858
    except KeyboardInterrupt:
2204
2863
    # Must run before the D-Bus bus name gets deregistered
2205
2864
    cleanup()
2206
2865
 
2207
 
 
2208
2866
if __name__ == '__main__':
2209
2867
    main()