/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2011-09-26 21:06:14 UTC
  • mto: This revision was merged to the branch mainline in revision 503.
  • Revision ID: teddy@fukt.bsnet.se-20110926210614-tvxkpb6xfhkq3gc3
* mandos: White space fixes only.

Show diffs side-by-side

added added

removed removed

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