/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2011-04-02 06:37:18 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110402063718-13ldrcuu0t33sdc4
* mandos: Tolerate restarting Avahi servers.  Also Changed to new
          "except x as y" exception syntax.
  (AvahiService.entry_group_state_changed_match): New; contains the
                                                  SignalMatch object.
  (AvahiService.remove): Really remove the group and the signal
                         connection, if any.
  (AvahiService.add): Always create a new group and signal connection.
  (AvahiService.cleanup): Changed to simply call remove().
  (AvahiService.server_state_changed): Handle and log more bad states.
  (AvahiService.activate): Set "follow_name_owner_changes=True" on the
                           Avahi Server proxy object.
  (ClientDBus.checked_ok): Do not return anything.
  (ClientDBus.CheckedOK): Do not return anything, as documented.
* mandos-monitor: Call D-Bus methods asynchronously.

Show diffs side-by-side

added added

removed removed

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