/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 at bsnet
  • Date: 2011-03-21 19:22:27 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110321192227-y74ngvvcy9eq6shi
* plugins.d/mandos-client.c (good_interface): Check if the interface
                                              name starts with "."
                                              before anything else.
                                              Bug fix: Fix memory
                                              leak.

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