/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-07-31 13:05:34 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110731130534-v4d9hsvek80ms9uo
* plugins.d/mandos-client.c (avahi_loop_with_timeout): Fix warning.
  (main): Disallow "--retry" arguments < 0.  Allow brackets [] around
          IPv6 addresses, as recommended by RFC 5952.  Bug fix: When
          using --connect, really use retry_interval, not 1 second.
* plugins.d/mandos-client.xml (DESCRIPTION): Add retry info.
  (--retry): Remove repeated word.

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