/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

* mandos (ClientDBus.notifychangeproperty): Bug fix: Use instance
                                            attributes instead of
                                            class attributes.

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
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
65
63
import cPickle as pickle
66
64
import multiprocessing
67
65
import types
68
 
import binascii
69
 
import tempfile
70
 
import itertools
71
 
import collections
72
66
 
73
67
import dbus
74
68
import dbus.service
88
82
    except ImportError:
89
83
        SO_BINDTODEVICE = None
90
84
 
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
 
 
 
85
 
 
86
version = "1.3.1"
 
87
 
 
88
#logger = logging.getLogger('mandos')
 
89
logger = logging.Logger('mandos')
 
90
syslogger = (logging.handlers.SysLogHandler
 
91
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
 
92
              address = str("/dev/log")))
 
93
syslogger.setFormatter(logging.Formatter
 
94
                       ('Mandos [%(process)d]: %(levelname)s:'
 
95
                        ' %(message)s'))
 
96
logger.addHandler(syslogger)
 
97
 
 
98
console = logging.StreamHandler()
 
99
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
 
100
                                       ' %(levelname)s:'
 
101
                                       ' %(message)s'))
 
102
logger.addHandler(console)
224
103
 
225
104
class AvahiError(Exception):
226
105
    def __init__(self, value, *args, **kwargs):
227
106
        self.value = value
228
 
        return super(AvahiError, self).__init__(value, *args,
229
 
                                                **kwargs)
 
107
        super(AvahiError, self).__init__(value, *args, **kwargs)
 
108
    def __unicode__(self):
 
109
        return unicode(repr(self.value))
230
110
 
231
111
class AvahiServiceError(AvahiError):
232
112
    pass
243
123
               Used to optionally bind to the specified interface.
244
124
    name: string; Example: 'Mandos'
245
125
    type: string; Example: '_mandos._tcp'.
246
 
     See <https://www.iana.org/assignments/service-names-port-numbers>
 
126
                  See <http://www.dns-sd.org/ServiceTypes.html>
247
127
    port: integer; what port to announce
248
128
    TXT: list of strings; TXT record for the service
249
129
    domain: string; Domain to publish on, default to .local if empty.
255
135
    server: D-Bus Server
256
136
    bus: dbus.SystemBus()
257
137
    """
258
 
    
259
138
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
260
139
                 servicetype = None, port = None, TXT = None,
261
140
                 domain = "", host = "", max_renames = 32768,
274
153
        self.server = None
275
154
        self.bus = bus
276
155
        self.entry_group_state_changed_match = None
277
 
    
278
 
    def rename(self, remove=True):
 
156
    def rename(self):
279
157
        """Derived from the Avahi example code"""
280
158
        if self.rename_count >= self.max_renames:
281
159
            logger.critical("No suitable Zeroconf service name found"
282
160
                            " after %i retries, exiting.",
283
161
                            self.rename_count)
284
162
            raise AvahiServiceError("Too many renames")
285
 
        self.name = str(self.server
286
 
                        .GetAlternativeServiceName(self.name))
287
 
        self.rename_count += 1
 
163
        self.name = unicode(self.server
 
164
                            .GetAlternativeServiceName(self.name))
288
165
        logger.info("Changing Zeroconf service name to %r ...",
289
166
                    self.name)
290
 
        if remove:
291
 
            self.remove()
 
167
        syslogger.setFormatter(logging.Formatter
 
168
                               ('Mandos (%s) [%%(process)d]:'
 
169
                                ' %%(levelname)s: %%(message)s'
 
170
                                % self.name))
 
171
        self.remove()
292
172
        try:
293
173
            self.add()
294
174
        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
 
    
 
175
            logger.critical("DBusException: %s", error)
 
176
            self.cleanup()
 
177
            os._exit(1)
 
178
        self.rename_count += 1
304
179
    def remove(self):
305
180
        """Derived from the Avahi example code"""
306
181
        if self.entry_group_state_changed_match is not None:
308
183
            self.entry_group_state_changed_match = None
309
184
        if self.group is not None:
310
185
            self.group.Reset()
311
 
    
312
186
    def add(self):
313
187
        """Derived from the Avahi example code"""
314
188
        self.remove()
319
193
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
320
194
        self.entry_group_state_changed_match = (
321
195
            self.group.connect_to_signal(
322
 
                'StateChanged', self.entry_group_state_changed))
 
196
                'StateChanged', self .entry_group_state_changed))
323
197
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
324
198
                     self.name, self.type)
325
199
        self.group.AddService(
331
205
            dbus.UInt16(self.port),
332
206
            avahi.string_array_to_txt_array(self.TXT))
333
207
        self.group.Commit()
334
 
    
335
208
    def entry_group_state_changed(self, state, error):
336
209
        """Derived from the Avahi example code"""
337
210
        logger.debug("Avahi entry group state change: %i", state)
343
216
            self.rename()
344
217
        elif state == avahi.ENTRY_GROUP_FAILURE:
345
218
            logger.critical("Avahi: Error in group state changed %s",
346
 
                            str(error))
347
 
            raise AvahiGroupError("State changed: {!s}"
348
 
                                  .format(error))
349
 
    
 
219
                            unicode(error))
 
220
            raise AvahiGroupError("State changed: %s"
 
221
                                  % unicode(error))
350
222
    def cleanup(self):
351
223
        """Derived from the Avahi example code"""
352
224
        if self.group is not None:
353
225
            try:
354
226
                self.group.Free()
355
227
            except (dbus.exceptions.UnknownMethodException,
356
 
                    dbus.exceptions.DBusException):
 
228
                    dbus.exceptions.DBusException) as e:
357
229
                pass
358
230
            self.group = None
359
231
        self.remove()
360
 
    
361
232
    def server_state_changed(self, state, error=None):
362
233
        """Derived from the Avahi example code"""
363
234
        logger.debug("Avahi server state change: %i", state)
382
253
                logger.debug("Unknown state: %r", state)
383
254
            else:
384
255
                logger.debug("Unknown state: %r: %r", state, error)
385
 
    
386
256
    def activate(self):
387
257
        """Derived from the Avahi example code"""
388
258
        if self.server is None:
396
266
        self.server_state_changed(self.server.GetState())
397
267
 
398
268
 
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
 
 
 
269
def _timedelta_to_milliseconds(td):
 
270
    "Convert a datetime.timedelta() to milliseconds"
 
271
    return ((td.days * 24 * 60 * 60 * 1000)
 
272
            + (td.seconds * 1000)
 
273
            + (td.microseconds // 1000))
 
274
        
410
275
class Client(object):
411
276
    """A representation of a client host served by this server.
412
277
    
413
278
    Attributes:
414
 
    approved:   bool(); 'None' if not yet approved/disapproved
 
279
    _approved:   bool(); 'None' if not yet approved/disapproved
415
280
    approval_delay: datetime.timedelta(); Time to wait for approval
416
281
    approval_duration: datetime.timedelta(); Duration of one approval
417
282
    checker:    subprocess.Popen(); a running checker process used
424
289
                     instance %(name)s can be used in the command.
425
290
    checker_initiator_tag: a gobject event source tag, or None
426
291
    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
292
    current_checker_command: string; current running checker_command
 
293
    disable_hook:  If set, called by disable() as disable_hook(self)
430
294
    disable_initiator_tag: a gobject event source tag, or None
431
295
    enabled:    bool()
432
296
    fingerprint: string (40 or 32 hexadecimal digits); used to
435
299
    interval:   datetime.timedelta(); How often to start a new checker
436
300
    last_approval_request: datetime.datetime(); (UTC) or None
437
301
    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
 
302
    last_enabled: datetime.datetime(); (UTC)
442
303
    name:       string; from the config file, used in log messages and
443
304
                        D-Bus identifiers
444
305
    secret:     bytestring; sent verbatim (over TLS) to client
445
306
    timeout:    datetime.timedelta(); How long from last_checked_ok
446
307
                                      until this client is disabled
447
 
    extended_timeout:   extra long timeout when secret has been sent
 
308
    extended_timeout:   extra long timeout when password has been sent
448
309
    runtime_expansions: Allowed attributes for runtime expansion.
449
310
    expires:    datetime.datetime(); time (UTC) when a client will be
450
311
                disabled, or None
451
 
    server_settings: The server_settings dict from main()
452
312
    """
453
313
    
454
314
    runtime_expansions = ("approval_delay", "approval_duration",
455
 
                          "created", "enabled", "expires",
456
 
                          "fingerprint", "host", "interval",
457
 
                          "last_approval_request", "last_checked_ok",
 
315
                          "created", "enabled", "fingerprint",
 
316
                          "host", "interval", "last_checked_ok",
458
317
                          "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):
 
318
    
 
319
    def timeout_milliseconds(self):
 
320
        "Return the 'timeout' attribute in milliseconds"
 
321
        return _timedelta_to_milliseconds(self.timeout)
 
322
    
 
323
    def extended_timeout_milliseconds(self):
 
324
        "Return the 'extended_timeout' attribute in milliseconds"
 
325
        return _timedelta_to_milliseconds(self.extended_timeout)
 
326
    
 
327
    def interval_milliseconds(self):
 
328
        "Return the 'interval' attribute in milliseconds"
 
329
        return _timedelta_to_milliseconds(self.interval)
 
330
    
 
331
    def approval_delay_milliseconds(self):
 
332
        return _timedelta_to_milliseconds(self.approval_delay)
 
333
    
 
334
    def __init__(self, name = None, disable_hook=None, config=None):
 
335
        """Note: the 'checker' key in 'config' sets the
 
336
        'checker_command' attribute and *not* the 'checker'
 
337
        attribute."""
521
338
        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
 
        
 
339
        if config is None:
 
340
            config = {}
539
341
        logger.debug("Creating client %r", self.name)
 
342
        # Uppercase and remove spaces from fingerprint for later
 
343
        # comparison purposes with return value from the fingerprint()
 
344
        # function
 
345
        self.fingerprint = (config["fingerprint"].upper()
 
346
                            .replace(" ", ""))
540
347
        logger.debug("  Fingerprint: %s", self.fingerprint)
541
 
        self.created = settings.get("created",
542
 
                                    datetime.datetime.utcnow())
543
 
        
544
 
        # attributes specific for this server instance
 
348
        if "secret" in config:
 
349
            self.secret = config["secret"].decode("base64")
 
350
        elif "secfile" in config:
 
351
            with open(os.path.expanduser(os.path.expandvars
 
352
                                         (config["secfile"])),
 
353
                      "rb") as secfile:
 
354
                self.secret = secfile.read()
 
355
        else:
 
356
            raise TypeError("No secret or secfile for client %s"
 
357
                            % self.name)
 
358
        self.host = config.get("host", "")
 
359
        self.created = datetime.datetime.utcnow()
 
360
        self.enabled = False
 
361
        self.last_approval_request = None
 
362
        self.last_enabled = None
 
363
        self.last_checked_ok = None
 
364
        self.timeout = string_to_delta(config["timeout"])
 
365
        self.extended_timeout = string_to_delta(config
 
366
                                                ["extended_timeout"])
 
367
        self.interval = string_to_delta(config["interval"])
 
368
        self.disable_hook = disable_hook
545
369
        self.checker = None
546
370
        self.checker_initiator_tag = None
547
371
        self.disable_initiator_tag = None
 
372
        self.expires = None
548
373
        self.checker_callback_tag = None
 
374
        self.checker_command = config["checker"]
549
375
        self.current_checker_command = None
550
 
        self.approved = None
 
376
        self.last_connect = None
 
377
        self._approved = None
 
378
        self.approved_by_default = config.get("approved_by_default",
 
379
                                              True)
551
380
        self.approvals_pending = 0
 
381
        self.approval_delay = string_to_delta(
 
382
            config["approval_delay"])
 
383
        self.approval_duration = string_to_delta(
 
384
            config["approval_duration"])
552
385
        self.changedstate = (multiprocessing_manager
553
386
                             .Condition(multiprocessing_manager
554
387
                                        .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)
566
388
    
567
 
    # Send notice to process children that client state has changed
568
389
    def send_changedstate(self):
569
 
        with self.changedstate:
570
 
            self.changedstate.notify_all()
 
390
        self.changedstate.acquire()
 
391
        self.changedstate.notify_all()
 
392
        self.changedstate.release()
571
393
    
572
394
    def enable(self):
573
395
        """Start this client's checker and timeout hooks"""
574
396
        if getattr(self, "enabled", False):
575
397
            # Already enabled
576
398
            return
 
399
        self.send_changedstate()
 
400
        # Schedule a new checker to be started an 'interval' from now,
 
401
        # and every interval from then on.
 
402
        self.checker_initiator_tag = (gobject.timeout_add
 
403
                                      (self.interval_milliseconds(),
 
404
                                       self.start_checker))
 
405
        # Schedule a disable() when 'timeout' has passed
577
406
        self.expires = datetime.datetime.utcnow() + self.timeout
 
407
        self.disable_initiator_tag = (gobject.timeout_add
 
408
                                   (self.timeout_milliseconds(),
 
409
                                    self.disable))
578
410
        self.enabled = True
579
411
        self.last_enabled = datetime.datetime.utcnow()
580
 
        self.init_checker()
581
 
        self.send_changedstate()
 
412
        # Also start a new checker *right now*.
 
413
        self.start_checker()
582
414
    
583
415
    def disable(self, quiet=True):
584
416
        """Disable this client."""
585
417
        if not getattr(self, "enabled", False):
586
418
            return False
587
419
        if not quiet:
 
420
            self.send_changedstate()
 
421
        if not quiet:
588
422
            logger.info("Disabling client %s", self.name)
589
 
        if getattr(self, "disable_initiator_tag", None) is not None:
 
423
        if getattr(self, "disable_initiator_tag", False):
590
424
            gobject.source_remove(self.disable_initiator_tag)
591
425
            self.disable_initiator_tag = None
592
426
        self.expires = None
593
 
        if getattr(self, "checker_initiator_tag", None) is not None:
 
427
        if getattr(self, "checker_initiator_tag", False):
594
428
            gobject.source_remove(self.checker_initiator_tag)
595
429
            self.checker_initiator_tag = None
596
430
        self.stop_checker()
 
431
        if self.disable_hook:
 
432
            self.disable_hook(self)
597
433
        self.enabled = False
598
 
        if not quiet:
599
 
            self.send_changedstate()
600
434
        # Do not run this again if called by a gobject.timeout_add
601
435
        return False
602
436
    
603
437
    def __del__(self):
 
438
        self.disable_hook = None
604
439
        self.disable()
605
440
    
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
441
    def checker_callback(self, pid, condition, command):
626
442
        """The checker has completed, so take appropriate actions."""
627
443
        self.checker_callback_tag = None
628
444
        self.checker = None
629
445
        if os.WIFEXITED(condition):
630
 
            self.last_checker_status = os.WEXITSTATUS(condition)
631
 
            if self.last_checker_status == 0:
 
446
            exitstatus = os.WEXITSTATUS(condition)
 
447
            if exitstatus == 0:
632
448
                logger.info("Checker for %(name)s succeeded",
633
449
                            vars(self))
634
450
                self.checked_ok()
636
452
                logger.info("Checker for %(name)s failed",
637
453
                            vars(self))
638
454
        else:
639
 
            self.last_checker_status = -1
640
455
            logger.warning("Checker for %(name)s crashed?",
641
456
                           vars(self))
642
457
    
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."""
 
458
    def checked_ok(self, timeout=None):
 
459
        """Bump up the timeout for this client.
 
460
        
 
461
        This should only be called when the client has been seen,
 
462
        alive and well.
 
463
        """
651
464
        if timeout is None:
652
465
            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
 
466
        self.last_checked_ok = datetime.datetime.utcnow()
 
467
        gobject.source_remove(self.disable_initiator_tag)
 
468
        self.expires = datetime.datetime.utcnow() + timeout
 
469
        self.disable_initiator_tag = (gobject.timeout_add
 
470
                                      (_timedelta_to_milliseconds
 
471
                                       (timeout), self.disable))
661
472
    
662
473
    def need_approval(self):
663
474
        self.last_approval_request = datetime.datetime.utcnow()
668
479
        If a checker already exists, leave it running and do
669
480
        nothing."""
670
481
        # 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
 
482
        # did that, then if a checker (for some reason) started
 
483
        # running slowly and taking more than 'interval' time, the
 
484
        # client would inevitably timeout, since no checker would get
 
485
        # a chance to run to completion.  If we instead leave running
675
486
        # checkers alone, the checker would have to take more time
676
487
        # than 'timeout' for the client to be disabled, which is as it
677
488
        # should be.
679
490
        # If a checker exists, make sure it is not a zombie
680
491
        try:
681
492
            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
 
493
        except (AttributeError, OSError) as error:
 
494
            if (isinstance(error, OSError)
 
495
                and error.errno != errno.ECHILD):
 
496
                raise error
687
497
        else:
688
498
            if pid:
689
499
                logger.warning("Checker was a zombie")
692
502
                                      self.current_checker_command)
693
503
        # Start a new checker if needed
694
504
        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
505
            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
 
506
                # In case checker_command has exactly one % operator
 
507
                command = self.checker_command % self.host
 
508
            except TypeError:
 
509
                # Escape attributes for the shell
 
510
                escaped_attrs = dict(
 
511
                    (attr,
 
512
                     re.escape(unicode(str(getattr(self, attr, "")),
 
513
                                       errors=
 
514
                                       'replace')))
 
515
                    for attr in
 
516
                    self.runtime_expansions)
 
517
                
 
518
                try:
 
519
                    command = self.checker_command % escaped_attrs
 
520
                except TypeError as error:
 
521
                    logger.error('Could not format string "%s":'
 
522
                                 ' %s', self.checker_command, error)
 
523
                    return True # Try again later
705
524
            self.current_checker_command = command
706
525
            try:
707
526
                logger.info("Starting checker %r for %s",
710
529
                # in normal mode, that is already done by daemon(),
711
530
                # and in debug mode we don't want to.  (Stdin is
712
531
                # 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
532
                self.checker = subprocess.Popen(command,
722
533
                                                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:
 
534
                                                shell=True, cwd="/")
 
535
                self.checker_callback_tag = (gobject.child_watch_add
 
536
                                             (self.checker.pid,
 
537
                                              self.checker_callback,
 
538
                                              data=command))
 
539
                # The checker may have completed before the gobject
 
540
                # watch was added.  Check for this.
736
541
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
542
                if pid:
 
543
                    gobject.source_remove(self.checker_callback_tag)
 
544
                    self.checker_callback(pid, status, command)
737
545
            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)
 
546
                logger.error("Failed to start subprocess: %s",
 
547
                             error)
747
548
        # Re-run this periodically if run by gobject.timeout_add
748
549
        return True
749
550
    
756
557
            return
757
558
        logger.debug("Stopping checker for %(name)s", vars(self))
758
559
        try:
759
 
            self.checker.terminate()
 
560
            os.kill(self.checker.pid, signal.SIGTERM)
760
561
            #time.sleep(0.5)
761
562
            #if self.checker.poll() is None:
762
 
            #    self.checker.kill()
 
563
            #    os.kill(self.checker.pid, signal.SIGKILL)
763
564
        except OSError as error:
764
565
            if error.errno != errno.ESRCH: # No such process
765
566
                raise
782
583
    # "Set" method, so we fail early here:
783
584
    if byte_arrays and signature != "ay":
784
585
        raise ValueError("Byte arrays not supported for non-'ay'"
785
 
                         " signature {!r}".format(signature))
 
586
                         " signature %r" % signature)
786
587
    def decorator(func):
787
588
        func._dbus_is_property = True
788
589
        func._dbus_interface = dbus_interface
796
597
    return decorator
797
598
 
798
599
 
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
600
class DBusPropertyException(dbus.exceptions.DBusException):
837
601
    """A base class for D-Bus property-related exceptions
838
602
    """
839
 
    pass
 
603
    def __unicode__(self):
 
604
        return unicode(str(self))
 
605
 
840
606
 
841
607
class DBusPropertyAccessException(DBusPropertyException):
842
608
    """A property's access permissions disallows an operation.
859
625
    """
860
626
    
861
627
    @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)
 
628
    def _is_dbus_property(obj):
 
629
        return getattr(obj, "_dbus_is_property", False)
870
630
    
871
 
    def _get_all_dbus_things(self, thing):
 
631
    def _get_all_dbus_properties(self):
872
632
        """Returns a generator of (name, attribute) pairs
873
633
        """
874
 
        return ((getattr(athing.__get__(self), "_dbus_name",
875
 
                         name),
876
 
                 athing.__get__(self))
 
634
        return ((prop.__get__(self)._dbus_name, prop.__get__(self))
877
635
                for cls in self.__class__.__mro__
878
 
                for name, athing in
879
 
                inspect.getmembers(cls,
880
 
                                   self._is_dbus_thing(thing)))
 
636
                for name, prop in
 
637
                inspect.getmembers(cls, self._is_dbus_property))
881
638
    
882
639
    def _get_dbus_property(self, interface_name, property_name):
883
640
        """Returns a bound method if one exists which is a D-Bus
885
642
        """
886
643
        for cls in  self.__class__.__mro__:
887
644
            for name, value in (inspect.getmembers
888
 
                                (cls,
889
 
                                 self._is_dbus_thing("property"))):
 
645
                                (cls, self._is_dbus_property)):
890
646
                if (value._dbus_name == property_name
891
647
                    and value._dbus_interface == interface_name):
892
648
                    return value.__get__(self)
920
676
            # The byte_arrays option is not supported yet on
921
677
            # signatures other than "ay".
922
678
            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))
 
679
                raise ValueError
 
680
            value = dbus.ByteArray(''.join(unichr(byte)
 
681
                                           for byte in value))
928
682
        prop(value)
929
683
    
930
684
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
935
689
        
936
690
        Note: Will not include properties with access="write".
937
691
        """
938
 
        properties = {}
939
 
        for name, prop in self._get_all_dbus_things("property"):
 
692
        all = {}
 
693
        for name, prop in self._get_all_dbus_properties():
940
694
            if (interface_name
941
695
                and interface_name != prop._dbus_interface):
942
696
                # Interface non-empty but did not match
946
700
                continue
947
701
            value = prop()
948
702
            if not hasattr(value, "variant_level"):
949
 
                properties[name] = value
 
703
                all[name] = value
950
704
                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
 
705
            all[name] = type(value)(value, variant_level=
 
706
                                    value.variant_level+1)
 
707
        return dbus.Dictionary(all, signature="sv")
962
708
    
963
709
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
964
710
                         out_signature="s",
965
711
                         path_keyword='object_path',
966
712
                         connection_keyword='connection')
967
713
    def Introspect(self, object_path, connection):
968
 
        """Overloading of standard D-Bus method.
969
 
        
970
 
        Inserts property tags and interface annotation tags.
 
714
        """Standard D-Bus method, overloaded to insert property tags.
971
715
        """
972
716
        xmlstring = dbus.service.Object.Introspect(self, object_path,
973
717
                                                   connection)
980
724
                e.setAttribute("access", prop._dbus_access)
981
725
                return e
982
726
            for if_tag in document.getElementsByTagName("interface"):
983
 
                # Add property tags
984
727
                for tag in (make_tag(document, name, prop)
985
728
                            for name, prop
986
 
                            in self._get_all_dbus_things("property")
 
729
                            in self._get_all_dbus_properties()
987
730
                            if prop._dbus_interface
988
731
                            == if_tag.getAttribute("name")):
989
732
                    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
733
                # Add the names to the return values for the
1022
734
                # "org.freedesktop.DBus.Properties" methods
1023
735
                if (if_tag.getAttribute("name")
1038
750
        except (AttributeError, xml.dom.DOMException,
1039
751
                xml.parsers.expat.ExpatError) as error:
1040
752
            logger.error("Failed to override Introspection method",
1041
 
                         exc_info=error)
 
753
                         error)
1042
754
        return xmlstring
1043
755
 
1044
756
 
1045
 
def datetime_to_dbus(dt, variant_level=0):
 
757
def datetime_to_dbus (dt, variant_level=0):
1046
758
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1047
759
    if dt is None:
1048
760
        return dbus.String("", variant_level = variant_level)
1049
761
    return dbus.String(dt.isoformat(),
1050
762
                       variant_level=variant_level)
1051
763
 
1052
 
 
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).
 
764
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
 
765
                                  .__metaclass__):
 
766
    """Applied to an empty subclass of a D-Bus object, this metaclass
 
767
    will add additional D-Bus attributes matching a certain pattern.
1075
768
    """
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):
 
769
    def __new__(mcs, name, bases, attr):
 
770
        # Go through all the base classes which could have D-Bus
 
771
        # methods, signals, or properties in them
 
772
        for base in (b for b in bases
 
773
                     if issubclass(b, dbus.service.Object)):
 
774
            # Go though all attributes of the base class
 
775
            for attrname, attribute in inspect.getmembers(base):
1083
776
                # Ignore non-D-Bus attributes, and D-Bus attributes
1084
777
                # with the wrong interface name
1085
778
                if (not hasattr(attribute, "_dbus_interface")
1086
779
                    or not attribute._dbus_interface
1087
 
                    .startswith(orig_interface_name)):
 
780
                    .startswith("se.recompile.Mandos")):
1088
781
                    continue
1089
782
                # Create an alternate D-Bus interface name based on
1090
783
                # the current name
1091
784
                alt_interface = (attribute._dbus_interface
1092
 
                                 .replace(orig_interface_name,
1093
 
                                          alt_interface_name))
1094
 
                interface_names.add(alt_interface)
 
785
                                 .replace("se.recompile.Mandos",
 
786
                                          "se.bsnet.fukt.Mandos"))
1095
787
                # Is this a D-Bus signal?
1096
788
                if getattr(attribute, "_dbus_is_signal", False):
1097
 
                    # Extract the original non-method undecorated
1098
 
                    # function by black magic
 
789
                    # Extract the original non-method function by
 
790
                    # black magic
1099
791
                    nonmethod_func = (dict(
1100
792
                            zip(attribute.func_code.co_freevars,
1101
793
                                attribute.__closure__))["func"]
1112
804
                                nonmethod_func.func_name,
1113
805
                                nonmethod_func.func_defaults,
1114
806
                                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
807
                    # 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
 
808
                    # old and new functions, so both the old and new
 
809
                    # signals gets sent when the function is called
1125
810
                    def fixscope(func1, func2):
1126
811
                        """This function is a scope container to pass
1127
812
                        func1 and func2 to the "call_both" function
1134
819
                        return call_both
1135
820
                    # Create the "call_both" function and add it to
1136
821
                    # the class
1137
 
                    attr[attrname] = fixscope(attribute, new_function)
 
822
                    attr[attrname] = fixscope(attribute,
 
823
                                              new_function)
1138
824
                # Is this a D-Bus method?
1139
825
                elif getattr(attribute, "_dbus_is_method", False):
1140
826
                    # Create a new, but exactly alike, function
1151
837
                                        attribute.func_name,
1152
838
                                        attribute.func_defaults,
1153
839
                                        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
840
                # Is this a D-Bus property?
1161
841
                elif getattr(attribute, "_dbus_is_property", False):
1162
842
                    # Create a new, but exactly alike, function
1176
856
                                        attribute.func_name,
1177
857
                                        attribute.func_defaults,
1178
858
                                        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"})
 
859
        return type.__new__(mcs, name, bases, attr)
 
860
 
1224
861
class ClientDBus(Client, DBusObjectWithProperties):
1225
862
    """A Client class using D-Bus
1226
863
    
1232
869
    runtime_expansions = (Client.runtime_expansions
1233
870
                          + ("dbus_object_path",))
1234
871
    
1235
 
    _interface = "se.recompile.Mandos.Client"
1236
 
    
1237
872
    # dbus.service.Object doesn't use super(), so we can't either.
1238
873
    
1239
874
    def __init__(self, bus = None, *args, **kwargs):
 
875
        self._approvals_pending = 0
1240
876
        self.bus = bus
1241
877
        Client.__init__(self, *args, **kwargs)
1242
878
        # Only now, when this client is initialized, can it show up on
1243
879
        # the D-Bus
1244
 
        client_object_name = str(self.name).translate(
 
880
        client_object_name = unicode(self.name).translate(
1245
881
            {ord("."): ord("_"),
1246
882
             ord("-"): ord("_")})
1247
883
        self.dbus_object_path = (dbus.ObjectPath
1248
884
                                 ("/clients/" + client_object_name))
1249
885
        DBusObjectWithProperties.__init__(self, self.bus,
1250
886
                                          self.dbus_object_path)
1251
 
    
 
887
        
1252
888
    def notifychangeproperty(transform_func,
1253
889
                             dbus_name, type_func=lambda x: x,
1254
 
                             variant_level=1, invalidate_only=False,
1255
 
                             _interface=_interface):
 
890
                             variant_level=1):
1256
891
        """ Modify a variable so that it's a property which announces
1257
892
        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.
 
893
 
 
894
        transform_fun: Function that takes a value and transforms it
 
895
                       to a D-Bus type.
1261
896
        dbus_name: D-Bus name of the variable
1262
897
        type_func: Function that transform the value before sending it
1263
898
                   to the D-Bus.  Default: no transform
1264
899
        variant_level: D-Bus variant level.  Default: 1
1265
900
        """
1266
 
        attrname = "_{}".format(dbus_name)
 
901
        attrname = "_{0}".format(dbus_name)
1267
902
        def setter(self, value):
1268
903
            if hasattr(self, "dbus_object_path"):
1269
904
                if (not hasattr(self, attrname) or
1270
905
                    type_func(getattr(self, attrname, None))
1271
906
                    != 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())
 
907
                    dbus_value = transform_func(type_func(value),
 
908
                                                variant_level)
 
909
                    self.PropertyChanged(dbus.String(dbus_name),
 
910
                                         dbus_value)
1287
911
            setattr(self, attrname, value)
1288
912
        
1289
913
        return property(lambda self: getattr(self, attrname), setter)
1290
914
    
 
915
    
1291
916
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1292
917
    approvals_pending = notifychangeproperty(dbus.Boolean,
1293
918
                                             "ApprovalPending",
1300
925
                                       checker is not None)
1301
926
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1302
927
                                           "LastCheckedOK")
1303
 
    last_checker_status = notifychangeproperty(dbus.Int16,
1304
 
                                               "LastCheckerStatus")
1305
928
    last_approval_request = notifychangeproperty(
1306
929
        datetime_to_dbus, "LastApprovalRequest")
1307
930
    approved_by_default = notifychangeproperty(dbus.Boolean,
1308
931
                                               "ApprovedByDefault")
1309
 
    approval_delay = notifychangeproperty(dbus.UInt64,
 
932
    approval_delay = notifychangeproperty(dbus.UInt16,
1310
933
                                          "ApprovalDelay",
1311
934
                                          type_func =
1312
 
                                          lambda td: td.total_seconds()
1313
 
                                          * 1000)
 
935
                                          _timedelta_to_milliseconds)
1314
936
    approval_duration = notifychangeproperty(
1315
 
        dbus.UInt64, "ApprovalDuration",
1316
 
        type_func = lambda td: td.total_seconds() * 1000)
 
937
        dbus.UInt16, "ApprovalDuration",
 
938
        type_func = _timedelta_to_milliseconds)
1317
939
    host = notifychangeproperty(dbus.String, "Host")
1318
 
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1319
 
                                   type_func = lambda td:
1320
 
                                       td.total_seconds() * 1000)
 
940
    timeout = notifychangeproperty(dbus.UInt16, "Timeout",
 
941
                                   type_func =
 
942
                                   _timedelta_to_milliseconds)
1321
943
    extended_timeout = notifychangeproperty(
1322
 
        dbus.UInt64, "ExtendedTimeout",
1323
 
        type_func = lambda td: td.total_seconds() * 1000)
1324
 
    interval = notifychangeproperty(dbus.UInt64,
 
944
        dbus.UInt16, "ExtendedTimeout",
 
945
        type_func = _timedelta_to_milliseconds)
 
946
    interval = notifychangeproperty(dbus.UInt16,
1325
947
                                    "Interval",
1326
948
                                    type_func =
1327
 
                                    lambda td: td.total_seconds()
1328
 
                                    * 1000)
 
949
                                    _timedelta_to_milliseconds)
1329
950
    checker_command = notifychangeproperty(dbus.String, "Checker")
1330
 
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
1331
 
                                  invalidate_only=True)
1332
951
    
1333
952
    del notifychangeproperty
1334
953
    
1361
980
                                       *args, **kwargs)
1362
981
    
1363
982
    def start_checker(self, *args, **kwargs):
1364
 
        old_checker_pid = getattr(self.checker, "pid", None)
 
983
        old_checker = self.checker
 
984
        if self.checker is not None:
 
985
            old_checker_pid = self.checker.pid
 
986
        else:
 
987
            old_checker_pid = None
1365
988
        r = Client.start_checker(self, *args, **kwargs)
1366
989
        # Only if new checker process was started
1367
990
        if (self.checker is not None
1371
994
        return r
1372
995
    
1373
996
    def _reset_approved(self):
1374
 
        self.approved = None
 
997
        self._approved = None
1375
998
        return False
1376
999
    
1377
1000
    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
1001
        self.send_changedstate()
 
1002
        self._approved = value
 
1003
        gobject.timeout_add(_timedelta_to_milliseconds
 
1004
                            (self.approval_duration),
 
1005
                            self._reset_approved)
 
1006
    
1382
1007
    
1383
1008
    ## D-Bus methods, signals & properties
1384
 
    
1385
 
    ## Interfaces
 
1009
    _interface = "se.recompile.Mandos.Client"
1386
1010
    
1387
1011
    ## Signals
1388
1012
    
1399
1023
        pass
1400
1024
    
1401
1025
    # PropertyChanged - signal
1402
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1403
1026
    @dbus.service.signal(_interface, signature="sv")
1404
1027
    def PropertyChanged(self, property, value):
1405
1028
        "D-Bus signal"
1481
1104
                           access="readwrite")
1482
1105
    def ApprovalDelay_dbus_property(self, value=None):
1483
1106
        if value is None:       # get
1484
 
            return dbus.UInt64(self.approval_delay.total_seconds()
1485
 
                               * 1000)
 
1107
            return dbus.UInt64(self.approval_delay_milliseconds())
1486
1108
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1487
1109
    
1488
1110
    # ApprovalDuration - property
1490
1112
                           access="readwrite")
1491
1113
    def ApprovalDuration_dbus_property(self, value=None):
1492
1114
        if value is None:       # get
1493
 
            return dbus.UInt64(self.approval_duration.total_seconds()
1494
 
                               * 1000)
 
1115
            return dbus.UInt64(_timedelta_to_milliseconds(
 
1116
                    self.approval_duration))
1495
1117
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1496
1118
    
1497
1119
    # Name - property
1510
1132
    def Host_dbus_property(self, value=None):
1511
1133
        if value is None:       # get
1512
1134
            return dbus.String(self.host)
1513
 
        self.host = str(value)
 
1135
        self.host = value
1514
1136
    
1515
1137
    # Created - property
1516
1138
    @dbus_service_property(_interface, signature="s", access="read")
1517
1139
    def Created_dbus_property(self):
1518
 
        return datetime_to_dbus(self.created)
 
1140
        return dbus.String(datetime_to_dbus(self.created))
1519
1141
    
1520
1142
    # LastEnabled - property
1521
1143
    @dbus_service_property(_interface, signature="s", access="read")
1542
1164
            return
1543
1165
        return datetime_to_dbus(self.last_checked_ok)
1544
1166
    
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
1167
    # Expires - property
1552
1168
    @dbus_service_property(_interface, signature="s", access="read")
1553
1169
    def Expires_dbus_property(self):
1563
1179
                           access="readwrite")
1564
1180
    def Timeout_dbus_property(self, value=None):
1565
1181
        if value is None:       # get
1566
 
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
1567
 
        old_timeout = self.timeout
 
1182
            return dbus.UInt64(self.timeout_milliseconds())
1568
1183
        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))
 
1184
        if getattr(self, "disable_initiator_tag", None) is None:
 
1185
            return
 
1186
        # Reschedule timeout
 
1187
        gobject.source_remove(self.disable_initiator_tag)
 
1188
        self.disable_initiator_tag = None
 
1189
        self.expires = None
 
1190
        time_to_die = (self.
 
1191
                       _timedelta_to_milliseconds((self
 
1192
                                                   .last_checked_ok
 
1193
                                                   + self.timeout)
 
1194
                                                  - datetime.datetime
 
1195
                                                  .utcnow()))
 
1196
        if time_to_die <= 0:
 
1197
            # The timeout has passed
 
1198
            self.disable()
 
1199
        else:
 
1200
            self.expires = (datetime.datetime.utcnow()
 
1201
                            + datetime.timedelta(milliseconds =
 
1202
                                                 time_to_die))
 
1203
            self.disable_initiator_tag = (gobject.timeout_add
 
1204
                                          (time_to_die, self.disable))
1585
1205
    
1586
1206
    # ExtendedTimeout - property
1587
1207
    @dbus_service_property(_interface, signature="t",
1588
1208
                           access="readwrite")
1589
1209
    def ExtendedTimeout_dbus_property(self, value=None):
1590
1210
        if value is None:       # get
1591
 
            return dbus.UInt64(self.extended_timeout.total_seconds()
1592
 
                               * 1000)
 
1211
            return dbus.UInt64(self.extended_timeout_milliseconds())
1593
1212
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1594
1213
    
1595
1214
    # Interval - property
1597
1216
                           access="readwrite")
1598
1217
    def Interval_dbus_property(self, value=None):
1599
1218
        if value is None:       # get
1600
 
            return dbus.UInt64(self.interval.total_seconds() * 1000)
 
1219
            return dbus.UInt64(self.interval_milliseconds())
1601
1220
        self.interval = datetime.timedelta(0, 0, 0, value)
1602
1221
        if getattr(self, "checker_initiator_tag", None) is None:
1603
1222
            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
 
1223
        # Reschedule checker run
 
1224
        gobject.source_remove(self.checker_initiator_tag)
 
1225
        self.checker_initiator_tag = (gobject.timeout_add
 
1226
                                      (value, self.start_checker))
 
1227
        self.start_checker()    # Start one now, too
1610
1228
    
1611
1229
    # Checker - property
1612
1230
    @dbus_service_property(_interface, signature="s",
1614
1232
    def Checker_dbus_property(self, value=None):
1615
1233
        if value is None:       # get
1616
1234
            return dbus.String(self.checker_command)
1617
 
        self.checker_command = str(value)
 
1235
        self.checker_command = value
1618
1236
    
1619
1237
    # CheckerRunning - property
1620
1238
    @dbus_service_property(_interface, signature="b",
1636
1254
    @dbus_service_property(_interface, signature="ay",
1637
1255
                           access="write", byte_arrays=True)
1638
1256
    def Secret_dbus_property(self, value):
1639
 
        self.secret = bytes(value)
 
1257
        self.secret = str(value)
1640
1258
    
1641
1259
    del _interface
1642
1260
 
1649
1267
            raise KeyError()
1650
1268
    
1651
1269
    def __getattribute__(self, name):
1652
 
        if name == '_pipe':
 
1270
        if(name == '_pipe'):
1653
1271
            return super(ProxyClient, self).__getattribute__(name)
1654
1272
        self._pipe.send(('getattr', name))
1655
1273
        data = self._pipe.recv()
1662
1280
            return func
1663
1281
    
1664
1282
    def __setattr__(self, name, value):
1665
 
        if name == '_pipe':
 
1283
        if(name == '_pipe'):
1666
1284
            return super(ProxyClient, self).__setattr__(name, value)
1667
1285
        self._pipe.send(('setattr', name, value))
1668
1286
 
 
1287
class ClientDBusTransitional(ClientDBus):
 
1288
    __metaclass__ = AlternateDBusNamesMetaclass
1669
1289
 
1670
1290
class ClientHandler(socketserver.BaseRequestHandler, object):
1671
1291
    """A class to handle client connections.
1676
1296
    def handle(self):
1677
1297
        with contextlib.closing(self.server.child_pipe) as child_pipe:
1678
1298
            logger.info("TCP connection from: %s",
1679
 
                        str(self.client_address))
 
1299
                        unicode(self.client_address))
1680
1300
            logger.debug("Pipe FD: %d",
1681
1301
                         self.server.child_pipe.fileno())
1682
1302
            
1708
1328
            logger.debug("Protocol version: %r", line)
1709
1329
            try:
1710
1330
                if int(line.strip().split()[0]) > 1:
1711
 
                    raise RuntimeError(line)
 
1331
                    raise RuntimeError
1712
1332
            except (ValueError, IndexError, RuntimeError) as error:
1713
1333
                logger.error("Unknown protocol version: %s", error)
1714
1334
                return
1754
1374
                            client.Rejected("Disabled")
1755
1375
                        return
1756
1376
                    
1757
 
                    if client.approved or not client.approval_delay:
 
1377
                    if client._approved or not client.approval_delay:
1758
1378
                        #We are approved or approval is disabled
1759
1379
                        break
1760
 
                    elif client.approved is None:
 
1380
                    elif client._approved is None:
1761
1381
                        logger.info("Client %s needs approval",
1762
1382
                                    client.name)
1763
1383
                        if self.server.use_dbus:
1764
1384
                            # Emit D-Bus signal
1765
1385
                            client.NeedApproval(
1766
 
                                client.approval_delay.total_seconds()
1767
 
                                * 1000, client.approved_by_default)
 
1386
                                client.approval_delay_milliseconds(),
 
1387
                                client.approved_by_default)
1768
1388
                    else:
1769
1389
                        logger.warning("Client %s was not approved",
1770
1390
                                       client.name)
1774
1394
                        return
1775
1395
                    
1776
1396
                    #wait until timeout or approved
 
1397
                    #x = float(client
 
1398
                    #          ._timedelta_to_milliseconds(delay))
1777
1399
                    time = datetime.datetime.now()
1778
1400
                    client.changedstate.acquire()
1779
 
                    client.changedstate.wait(delay.total_seconds())
 
1401
                    (client.changedstate.wait
 
1402
                     (float(client._timedelta_to_milliseconds(delay)
 
1403
                            / 1000)))
1780
1404
                    client.changedstate.release()
1781
1405
                    time2 = datetime.datetime.now()
1782
1406
                    if (time2 - time) >= delay:
1798
1422
                    try:
1799
1423
                        sent = session.send(client.secret[sent_size:])
1800
1424
                    except gnutls.errors.GNUTLSError as error:
1801
 
                        logger.warning("gnutls send failed",
1802
 
                                       exc_info=error)
 
1425
                        logger.warning("gnutls send failed")
1803
1426
                        return
1804
1427
                    logger.debug("Sent: %d, remaining: %d",
1805
1428
                                 sent, len(client.secret)
1807
1430
                    sent_size += sent
1808
1431
                
1809
1432
                logger.info("Sending secret to %s", client.name)
1810
 
                # bump the timeout using extended_timeout
1811
 
                client.bump_timeout(client.extended_timeout)
 
1433
                # bump the timeout as if seen
 
1434
                client.checked_ok(client.extended_timeout)
1812
1435
                if self.server.use_dbus:
1813
1436
                    # Emit D-Bus signal
1814
1437
                    client.GotSecret()
1819
1442
                try:
1820
1443
                    session.bye()
1821
1444
                except gnutls.errors.GNUTLSError as error:
1822
 
                    logger.warning("GnuTLS bye failed",
1823
 
                                   exc_info=error)
 
1445
                    logger.warning("GnuTLS bye failed")
1824
1446
    
1825
1447
    @staticmethod
1826
1448
    def peer_certificate(session):
1882
1504
        # Convert the buffer to a Python bytestring
1883
1505
        fpr = ctypes.string_at(buf, buf_len.value)
1884
1506
        # Convert the bytestring to hexadecimal notation
1885
 
        hex_fpr = binascii.hexlify(fpr).upper()
 
1507
        hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
1886
1508
        return hex_fpr
1887
1509
 
1888
1510
 
1891
1513
    def sub_process_main(self, request, address):
1892
1514
        try:
1893
1515
            self.finish_request(request, address)
1894
 
        except Exception:
 
1516
        except:
1895
1517
            self.handle_error(request, address)
1896
1518
        self.close_request(request)
1897
 
    
 
1519
            
1898
1520
    def process_request(self, request, address):
1899
1521
        """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
 
1522
        multiprocessing.Process(target = self.sub_process_main,
 
1523
                                args = (request, address)).start()
1904
1524
 
1905
1525
 
1906
1526
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1912
1532
        """
1913
1533
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
1914
1534
        
1915
 
        proc = MultiprocessingMixIn.process_request(self, request,
1916
 
                                                    client_address)
 
1535
        super(MultiprocessingMixInWithPipe,
 
1536
              self).process_request(request, client_address)
1917
1537
        self.child_pipe.close()
1918
 
        self.add_pipe(parent_pipe, proc)
 
1538
        self.add_pipe(parent_pipe)
1919
1539
    
1920
 
    def add_pipe(self, parent_pipe, proc):
 
1540
    def add_pipe(self, parent_pipe):
1921
1541
        """Dummy function; override as necessary"""
1922
 
        raise NotImplementedError()
 
1542
        raise NotImplementedError
1923
1543
 
1924
1544
 
1925
1545
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1932
1552
        use_ipv6:       Boolean; to use IPv6 or not
1933
1553
    """
1934
1554
    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
 
        """
 
1555
                 interface=None, use_ipv6=True):
1939
1556
        self.interface = interface
1940
1557
        if use_ipv6:
1941
1558
            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
1559
        socketserver.TCPServer.__init__(self, server_address,
1969
1560
                                        RequestHandlerClass)
1970
 
    
1971
1561
    def server_bind(self):
1972
1562
        """This overrides the normal server_bind() function
1973
1563
        to bind to an interface if one was specified, and also NOT to
1981
1571
                try:
1982
1572
                    self.socket.setsockopt(socket.SOL_SOCKET,
1983
1573
                                           SO_BINDTODEVICE,
1984
 
                                           (self.interface + "\0")
1985
 
                                           .encode("utf-8"))
 
1574
                                           str(self.interface
 
1575
                                               + '\0'))
1986
1576
                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:
 
1577
                    if error[0] == errno.EPERM:
 
1578
                        logger.error("No permission to"
 
1579
                                     " bind to interface %s",
 
1580
                                     self.interface)
 
1581
                    elif error[0] == errno.ENOPROTOOPT:
1991
1582
                        logger.error("SO_BINDTODEVICE not available;"
1992
1583
                                     " cannot bind to interface %s",
1993
1584
                                     self.interface)
1994
 
                    elif error.errno == errno.ENODEV:
1995
 
                        logger.error("Interface %s does not exist,"
1996
 
                                     " cannot bind", self.interface)
1997
1585
                    else:
1998
1586
                        raise
1999
1587
        # Only bind(2) the socket if we really need to.
2002
1590
                if self.address_family == socket.AF_INET6:
2003
1591
                    any_address = "::" # in6addr_any
2004
1592
                else:
2005
 
                    any_address = "0.0.0.0" # INADDR_ANY
 
1593
                    any_address = socket.INADDR_ANY
2006
1594
                self.server_address = (any_address,
2007
1595
                                       self.server_address[1])
2008
1596
            elif not self.server_address[1]:
2029
1617
    """
2030
1618
    def __init__(self, server_address, RequestHandlerClass,
2031
1619
                 interface=None, use_ipv6=True, clients=None,
2032
 
                 gnutls_priority=None, use_dbus=True, socketfd=None):
 
1620
                 gnutls_priority=None, use_dbus=True):
2033
1621
        self.enabled = False
2034
1622
        self.clients = clients
2035
1623
        if self.clients is None:
2036
 
            self.clients = {}
 
1624
            self.clients = set()
2037
1625
        self.use_dbus = use_dbus
2038
1626
        self.gnutls_priority = gnutls_priority
2039
1627
        IPv6_TCPServer.__init__(self, server_address,
2040
1628
                                RequestHandlerClass,
2041
1629
                                interface = interface,
2042
 
                                use_ipv6 = use_ipv6,
2043
 
                                socketfd = socketfd)
 
1630
                                use_ipv6 = use_ipv6)
2044
1631
    def server_activate(self):
2045
1632
        if self.enabled:
2046
1633
            return socketserver.TCPServer.server_activate(self)
2047
 
    
2048
1634
    def enable(self):
2049
1635
        self.enabled = True
2050
 
    
2051
 
    def add_pipe(self, parent_pipe, proc):
 
1636
    def add_pipe(self, parent_pipe):
2052
1637
        # Call "handle_ipc" for both data and EOF events
2053
1638
        gobject.io_add_watch(parent_pipe.fileno(),
2054
1639
                             gobject.IO_IN | gobject.IO_HUP,
2055
1640
                             functools.partial(self.handle_ipc,
2056
1641
                                               parent_pipe =
2057
 
                                               parent_pipe,
2058
 
                                               proc = proc))
2059
 
    
 
1642
                                               parent_pipe))
 
1643
        
2060
1644
    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()
 
1645
                   client_object=None):
 
1646
        condition_names = {
 
1647
            gobject.IO_IN: "IN",   # There is data to read.
 
1648
            gobject.IO_OUT: "OUT", # Data can be written (without
 
1649
                                    # blocking).
 
1650
            gobject.IO_PRI: "PRI", # There is urgent data to read.
 
1651
            gobject.IO_ERR: "ERR", # Error condition.
 
1652
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
 
1653
                                    # broken, usually for pipes and
 
1654
                                    # sockets).
 
1655
            }
 
1656
        conditions_string = ' | '.join(name
 
1657
                                       for cond, name in
 
1658
                                       condition_names.iteritems()
 
1659
                                       if cond & condition)
 
1660
        # error or the other end of multiprocessing.Pipe has closed
 
1661
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2066
1662
            return False
2067
1663
        
2068
1664
        # Read a request from the child
2073
1669
            fpr = request[1]
2074
1670
            address = request[2]
2075
1671
            
2076
 
            for c in self.clients.itervalues():
 
1672
            for c in self.clients:
2077
1673
                if c.fingerprint == fpr:
2078
1674
                    client = c
2079
1675
                    break
2092
1688
                                 functools.partial(self.handle_ipc,
2093
1689
                                                   parent_pipe =
2094
1690
                                                   parent_pipe,
2095
 
                                                   proc = proc,
2096
1691
                                                   client_object =
2097
1692
                                                   client))
2098
1693
            parent_pipe.send(True)
2124
1719
        return True
2125
1720
 
2126
1721
 
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
1722
def string_to_delta(interval):
2227
1723
    """Parse a string and return a datetime.timedelta
2228
1724
    
2239
1735
    >>> string_to_delta('5m 30s')
2240
1736
    datetime.timedelta(0, 330)
2241
1737
    """
2242
 
    
2243
 
    try:
2244
 
        return rfc3339_duration_to_delta(interval)
2245
 
    except ValueError:
2246
 
        pass
2247
 
    
2248
1738
    timevalue = datetime.timedelta(0)
2249
1739
    for s in interval.split():
2250
1740
        try:
2251
 
            suffix = s[-1]
 
1741
            suffix = unicode(s[-1])
2252
1742
            value = int(s[:-1])
2253
1743
            if suffix == "d":
2254
1744
                delta = datetime.timedelta(value)
2261
1751
            elif suffix == "w":
2262
1752
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2263
1753
            else:
2264
 
                raise ValueError("Unknown suffix {!r}"
2265
 
                                 .format(suffix))
2266
 
        except IndexError as e:
 
1754
                raise ValueError("Unknown suffix %r" % suffix)
 
1755
        except (ValueError, IndexError) as e:
2267
1756
            raise ValueError(*(e.args))
2268
1757
        timevalue += delta
2269
1758
    return timevalue
2270
1759
 
2271
1760
 
 
1761
def if_nametoindex(interface):
 
1762
    """Call the C function if_nametoindex(), or equivalent
 
1763
    
 
1764
    Note: This function cannot accept a unicode string."""
 
1765
    global if_nametoindex
 
1766
    try:
 
1767
        if_nametoindex = (ctypes.cdll.LoadLibrary
 
1768
                          (ctypes.util.find_library("c"))
 
1769
                          .if_nametoindex)
 
1770
    except (OSError, AttributeError):
 
1771
        logger.warning("Doing if_nametoindex the hard way")
 
1772
        def if_nametoindex(interface):
 
1773
            "Get an interface index the hard way, i.e. using fcntl()"
 
1774
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
 
1775
            with contextlib.closing(socket.socket()) as s:
 
1776
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
 
1777
                                    struct.pack(str("16s16x"),
 
1778
                                                interface))
 
1779
            interface_index = struct.unpack(str("I"),
 
1780
                                            ifreq[16:20])[0]
 
1781
            return interface_index
 
1782
    return if_nametoindex(interface)
 
1783
 
 
1784
 
2272
1785
def daemon(nochdir = False, noclose = False):
2273
1786
    """See daemon(3).  Standard BSD Unix function.
2274
1787
    
2282
1795
        sys.exit()
2283
1796
    if not noclose:
2284
1797
        # Close all standard open file descriptors
2285
 
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
1798
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2286
1799
        if not stat.S_ISCHR(os.fstat(null).st_mode):
2287
 
            raise OSError(errno.ENODEV, "{} not a character device"
2288
 
                          .format(os.devnull))
 
1800
            raise OSError(errno.ENODEV,
 
1801
                          "%s not a character device"
 
1802
                          % os.path.devnull)
2289
1803
        os.dup2(null, sys.stdin.fileno())
2290
1804
        os.dup2(null, sys.stdout.fileno())
2291
1805
        os.dup2(null, sys.stderr.fileno())
2300
1814
    
2301
1815
    parser = argparse.ArgumentParser()
2302
1816
    parser.add_argument("-v", "--version", action="version",
2303
 
                        version = "%(prog)s {}".format(version),
 
1817
                        version = "%%(prog)s %s" % version,
2304
1818
                        help="show version number and exit")
2305
1819
    parser.add_argument("-i", "--interface", metavar="IF",
2306
1820
                        help="Bind to interface IF")
2312
1826
                        help="Run self-test")
2313
1827
    parser.add_argument("--debug", action="store_true",
2314
1828
                        help="Debug mode; run in foreground and log"
2315
 
                        " to terminal", default=None)
 
1829
                        " to terminal")
2316
1830
    parser.add_argument("--debuglevel", metavar="LEVEL",
2317
1831
                        help="Debug level for stdout output")
2318
1832
    parser.add_argument("--priority", help="GnuTLS"
2325
1839
                        " files")
2326
1840
    parser.add_argument("--no-dbus", action="store_false",
2327
1841
                        dest="use_dbus", help="Do not provide D-Bus"
2328
 
                        " system bus interface", default=None)
 
1842
                        " system bus interface")
2329
1843
    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
 
    
 
1844
                        dest="use_ipv6", help="Do not use IPv6")
2346
1845
    options = parser.parse_args()
2347
1846
    
2348
1847
    if options.check:
2349
1848
        import doctest
2350
 
        fail_count, test_count = doctest.testmod()
2351
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
1849
        doctest.testmod()
 
1850
        sys.exit()
2352
1851
    
2353
1852
    # Default values for config file for server-global settings
2354
1853
    server_defaults = { "interface": "",
2356
1855
                        "port": "",
2357
1856
                        "debug": "False",
2358
1857
                        "priority":
2359
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2360
 
                        ":+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
 
1858
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2361
1859
                        "servicename": "Mandos",
2362
1860
                        "use_dbus": "True",
2363
1861
                        "use_ipv6": "True",
2364
1862
                        "debuglevel": "",
2365
 
                        "restore": "True",
2366
 
                        "socket": "",
2367
 
                        "statedir": "/var/lib/mandos",
2368
 
                        "foreground": "False",
2369
 
                        "zeroconf": "True",
2370
1863
                        }
2371
1864
    
2372
1865
    # Parse config file for server-global settings
2377
1870
    # Convert the SafeConfigParser object to a dict
2378
1871
    server_settings = server_config.defaults()
2379
1872
    # Use the appropriate methods on the non-string config options
2380
 
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
 
1873
    for option in ("debug", "use_dbus", "use_ipv6"):
2381
1874
        server_settings[option] = server_config.getboolean("DEFAULT",
2382
1875
                                                           option)
2383
1876
    if server_settings["port"]:
2384
1877
        server_settings["port"] = server_config.getint("DEFAULT",
2385
1878
                                                       "port")
2386
 
    if server_settings["socket"]:
2387
 
        server_settings["socket"] = server_config.getint("DEFAULT",
2388
 
                                                         "socket")
2389
 
        # Later, stdin will, and stdout and stderr might, be dup'ed
2390
 
        # over with an opened os.devnull.  But we don't want this to
2391
 
        # happen with a supplied network socket.
2392
 
        if 0 <= server_settings["socket"] <= 2:
2393
 
            server_settings["socket"] = os.dup(server_settings
2394
 
                                               ["socket"])
2395
1879
    del server_config
2396
1880
    
2397
1881
    # Override the settings from the config file with command line
2398
1882
    # options, if set.
2399
1883
    for option in ("interface", "address", "port", "debug",
2400
1884
                   "priority", "servicename", "configdir",
2401
 
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2402
 
                   "statedir", "socket", "foreground", "zeroconf"):
 
1885
                   "use_dbus", "use_ipv6", "debuglevel"):
2403
1886
        value = getattr(options, option)
2404
1887
        if value is not None:
2405
1888
            server_settings[option] = value
2406
1889
    del options
2407
1890
    # Force all strings to be unicode
2408
1891
    for option in server_settings.keys():
2409
 
        if isinstance(server_settings[option], bytes):
2410
 
            server_settings[option] = (server_settings[option]
2411
 
                                       .decode("utf-8"))
2412
 
    # Force all boolean options to be boolean
2413
 
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
2414
 
                   "foreground", "zeroconf"):
2415
 
        server_settings[option] = bool(server_settings[option])
2416
 
    # Debug implies foreground
2417
 
    if server_settings["debug"]:
2418
 
        server_settings["foreground"] = True
 
1892
        if type(server_settings[option]) is str:
 
1893
            server_settings[option] = unicode(server_settings[option])
2419
1894
    # Now we have our good server settings in "server_settings"
2420
1895
    
2421
1896
    ##################################################################
2422
1897
    
2423
 
    if (not server_settings["zeroconf"] and
2424
 
        not (server_settings["port"]
2425
 
             or server_settings["socket"] != "")):
2426
 
            parser.error("Needs port or socket to work without"
2427
 
                         " Zeroconf")
2428
 
    
2429
1898
    # For convenience
2430
1899
    debug = server_settings["debug"]
2431
1900
    debuglevel = server_settings["debuglevel"]
2432
1901
    use_dbus = server_settings["use_dbus"]
2433
1902
    use_ipv6 = server_settings["use_ipv6"]
2434
 
    stored_state_path = os.path.join(server_settings["statedir"],
2435
 
                                     stored_state_file)
2436
 
    foreground = server_settings["foreground"]
2437
 
    zeroconf = server_settings["zeroconf"]
2438
 
    
2439
 
    if debug:
2440
 
        initlogger(debug, logging.DEBUG)
2441
 
    else:
2442
 
        if not debuglevel:
2443
 
            initlogger(debug)
2444
 
        else:
2445
 
            level = getattr(logging, debuglevel.upper())
2446
 
            initlogger(debug, level)
2447
1903
    
2448
1904
    if server_settings["servicename"] != "Mandos":
2449
1905
        syslogger.setFormatter(logging.Formatter
2450
 
                               ('Mandos ({}) [%(process)d]:'
2451
 
                                ' %(levelname)s: %(message)s'
2452
 
                                .format(server_settings
2453
 
                                        ["servicename"])))
 
1906
                               ('Mandos (%s) [%%(process)d]:'
 
1907
                                ' %%(levelname)s: %%(message)s'
 
1908
                                % server_settings["servicename"]))
2454
1909
    
2455
1910
    # Parse config file with clients
2456
 
    client_config = configparser.SafeConfigParser(Client
2457
 
                                                  .client_defaults)
 
1911
    client_defaults = { "timeout": "5m",
 
1912
                        "extended_timeout": "15m",
 
1913
                        "interval": "2m",
 
1914
                        "checker": "fping -q -- %%(host)s",
 
1915
                        "host": "",
 
1916
                        "approval_delay": "0s",
 
1917
                        "approval_duration": "1s",
 
1918
                        }
 
1919
    client_config = configparser.SafeConfigParser(client_defaults)
2458
1920
    client_config.read(os.path.join(server_settings["configdir"],
2459
1921
                                    "clients.conf"))
2460
1922
    
2461
1923
    global mandos_dbus_service
2462
1924
    mandos_dbus_service = None
2463
1925
    
2464
 
    socketfd = None
2465
 
    if server_settings["socket"] != "":
2466
 
        socketfd = server_settings["socket"]
2467
1926
    tcp_server = MandosServer((server_settings["address"],
2468
1927
                               server_settings["port"]),
2469
1928
                              ClientHandler,
2472
1931
                              use_ipv6=use_ipv6,
2473
1932
                              gnutls_priority=
2474
1933
                              server_settings["priority"],
2475
 
                              use_dbus=use_dbus,
2476
 
                              socketfd=socketfd)
2477
 
    if not foreground:
2478
 
        pidfilename = "/run/mandos.pid"
2479
 
        if not os.path.isdir("/run/."):
2480
 
            pidfilename = "/var/run/mandos.pid"
2481
 
        pidfile = None
 
1934
                              use_dbus=use_dbus)
 
1935
    if not debug:
 
1936
        pidfilename = "/var/run/mandos.pid"
2482
1937
        try:
2483
1938
            pidfile = open(pidfilename, "w")
2484
 
        except IOError as e:
2485
 
            logger.error("Could not open file %r", pidfilename,
2486
 
                         exc_info=e)
 
1939
        except IOError:
 
1940
            logger.error("Could not open file %r", pidfilename)
2487
1941
    
2488
 
    for name in ("_mandos", "mandos", "nobody"):
 
1942
    try:
 
1943
        uid = pwd.getpwnam("_mandos").pw_uid
 
1944
        gid = pwd.getpwnam("_mandos").pw_gid
 
1945
    except KeyError:
2489
1946
        try:
2490
 
            uid = pwd.getpwnam(name).pw_uid
2491
 
            gid = pwd.getpwnam(name).pw_gid
2492
 
            break
 
1947
            uid = pwd.getpwnam("mandos").pw_uid
 
1948
            gid = pwd.getpwnam("mandos").pw_gid
2493
1949
        except KeyError:
2494
 
            continue
2495
 
    else:
2496
 
        uid = 65534
2497
 
        gid = 65534
 
1950
            try:
 
1951
                uid = pwd.getpwnam("nobody").pw_uid
 
1952
                gid = pwd.getpwnam("nobody").pw_gid
 
1953
            except KeyError:
 
1954
                uid = 65534
 
1955
                gid = 65534
2498
1956
    try:
2499
1957
        os.setgid(gid)
2500
1958
        os.setuid(uid)
2501
1959
    except OSError as error:
2502
 
        if error.errno != errno.EPERM:
2503
 
            raise
 
1960
        if error[0] != errno.EPERM:
 
1961
            raise error
 
1962
    
 
1963
    if not debug and not debuglevel:
 
1964
        syslogger.setLevel(logging.WARNING)
 
1965
        console.setLevel(logging.WARNING)
 
1966
    if debuglevel:
 
1967
        level = getattr(logging, debuglevel.upper())
 
1968
        syslogger.setLevel(level)
 
1969
        console.setLevel(level)
2504
1970
    
2505
1971
    if debug:
2506
1972
        # Enable all possible GnuTLS debugging
2517
1983
         .gnutls_global_set_log_function(debug_gnutls))
2518
1984
        
2519
1985
        # Redirect stdin so all checkers get /dev/null
2520
 
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
1986
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2521
1987
        os.dup2(null, sys.stdin.fileno())
2522
1988
        if null > 2:
2523
1989
            os.close(null)
 
1990
    else:
 
1991
        # No console logging
 
1992
        logger.removeHandler(console)
2524
1993
    
2525
1994
    # Need to fork before connecting to D-Bus
2526
 
    if not foreground:
 
1995
    if not debug:
2527
1996
        # Close all input and output, do double fork, etc.
2528
1997
        daemon()
2529
1998
    
2530
 
    # multiprocessing will use threads, so before we use gobject we
2531
 
    # need to inform gobject that threads will be used.
2532
 
    gobject.threads_init()
2533
 
    
2534
1999
    global main_loop
2535
2000
    # From the Avahi example code
2536
 
    DBusGMainLoop(set_as_default=True)
 
2001
    DBusGMainLoop(set_as_default=True )
2537
2002
    main_loop = gobject.MainLoop()
2538
2003
    bus = dbus.SystemBus()
2539
2004
    # End of Avahi example code
2545
2010
                            ("se.bsnet.fukt.Mandos", bus,
2546
2011
                             do_not_queue=True))
2547
2012
        except dbus.exceptions.NameExistsException as e:
2548
 
            logger.error("Disabling D-Bus:", exc_info=e)
 
2013
            logger.error(unicode(e) + ", disabling D-Bus")
2549
2014
            use_dbus = False
2550
2015
            server_settings["use_dbus"] = False
2551
2016
            tcp_server.use_dbus = False
2552
 
    if zeroconf:
2553
 
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2554
 
        service = AvahiServiceToSyslog(name =
2555
 
                                       server_settings["servicename"],
2556
 
                                       servicetype = "_mandos._tcp",
2557
 
                                       protocol = protocol, bus = bus)
2558
 
        if server_settings["interface"]:
2559
 
            service.interface = (if_nametoindex
2560
 
                                 (server_settings["interface"]
2561
 
                                  .encode("utf-8")))
 
2017
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
2018
    service = AvahiService(name = server_settings["servicename"],
 
2019
                           servicetype = "_mandos._tcp",
 
2020
                           protocol = protocol, bus = bus)
 
2021
    if server_settings["interface"]:
 
2022
        service.interface = (if_nametoindex
 
2023
                             (str(server_settings["interface"])))
2562
2024
    
2563
2025
    global multiprocessing_manager
2564
2026
    multiprocessing_manager = multiprocessing.Manager()
2565
2027
    
2566
2028
    client_class = Client
2567
2029
    if use_dbus:
2568
 
        client_class = functools.partial(ClientDBus, bus = bus)
2569
 
    
2570
 
    client_settings = Client.config_parser(client_config)
2571
 
    old_client_settings = {}
2572
 
    clients_data = {}
2573
 
    
2574
 
    # This is used to redirect stdout and stderr for checker processes
2575
 
    global wnull
2576
 
    wnull = open(os.devnull, "w") # A writable /dev/null
2577
 
    # Only used if server is running in foreground but not in debug
2578
 
    # mode
2579
 
    if debug or not foreground:
2580
 
        wnull.close()
2581
 
    
2582
 
    # Get client data and settings from last running state.
2583
 
    if server_settings["restore"]:
2584
 
        try:
2585
 
            with open(stored_state_path, "rb") as stored_state:
2586
 
                clients_data, old_client_settings = (pickle.load
2587
 
                                                     (stored_state))
2588
 
            os.remove(stored_state_path)
2589
 
        except IOError as e:
2590
 
            if e.errno == errno.ENOENT:
2591
 
                logger.warning("Could not load persistent state: {}"
2592
 
                                .format(os.strerror(e.errno)))
2593
 
            else:
2594
 
                logger.critical("Could not load persistent state:",
2595
 
                                exc_info=e)
2596
 
                raise
2597
 
        except EOFError as e:
2598
 
            logger.warning("Could not load persistent state: "
2599
 
                           "EOFError:", exc_info=e)
2600
 
    
2601
 
    with PGPEngine() as pgp:
2602
 
        for client_name, client in clients_data.items():
2603
 
            # Skip removed clients
2604
 
            if client_name not in client_settings:
2605
 
                continue
2606
 
            
2607
 
            # Decide which value to use after restoring saved state.
2608
 
            # We have three different values: Old config file,
2609
 
            # new config file, and saved state.
2610
 
            # New config value takes precedence if it differs from old
2611
 
            # config value, otherwise use saved state.
2612
 
            for name, value in client_settings[client_name].items():
2613
 
                try:
2614
 
                    # For each value in new config, check if it
2615
 
                    # differs from the old config value (Except for
2616
 
                    # the "secret" attribute)
2617
 
                    if (name != "secret" and
2618
 
                        value != old_client_settings[client_name]
2619
 
                        [name]):
2620
 
                        client[name] = value
2621
 
                except KeyError:
2622
 
                    pass
2623
 
            
2624
 
            # Clients who has passed its expire date can still be
2625
 
            # enabled if its last checker was successful.  Clients
2626
 
            # whose checker succeeded before we stored its state is
2627
 
            # assumed to have successfully run all checkers during
2628
 
            # downtime.
2629
 
            if client["enabled"]:
2630
 
                if datetime.datetime.utcnow() >= client["expires"]:
2631
 
                    if not client["last_checked_ok"]:
2632
 
                        logger.warning(
2633
 
                            "disabling client {} - Client never "
2634
 
                            "performed a successful checker"
2635
 
                            .format(client_name))
2636
 
                        client["enabled"] = False
2637
 
                    elif client["last_checker_status"] != 0:
2638
 
                        logger.warning(
2639
 
                            "disabling client {} - Client last"
2640
 
                            " checker failed with error code {}"
2641
 
                            .format(client_name,
2642
 
                                    client["last_checker_status"]))
2643
 
                        client["enabled"] = False
2644
 
                    else:
2645
 
                        client["expires"] = (datetime.datetime
2646
 
                                             .utcnow()
2647
 
                                             + client["timeout"])
2648
 
                        logger.debug("Last checker succeeded,"
2649
 
                                     " keeping {} enabled"
2650
 
                                     .format(client_name))
 
2030
        client_class = functools.partial(ClientDBusTransitional,
 
2031
                                         bus = bus)
 
2032
    def client_config_items(config, section):
 
2033
        special_settings = {
 
2034
            "approved_by_default":
 
2035
                lambda: config.getboolean(section,
 
2036
                                          "approved_by_default"),
 
2037
            }
 
2038
        for name, value in config.items(section):
2651
2039
            try:
2652
 
                client["secret"] = (
2653
 
                    pgp.decrypt(client["encrypted_secret"],
2654
 
                                client_settings[client_name]
2655
 
                                ["secret"]))
2656
 
            except PGPError:
2657
 
                # If decryption fails, we use secret from new settings
2658
 
                logger.debug("Failed to decrypt {} old secret"
2659
 
                             .format(client_name))
2660
 
                client["secret"] = (
2661
 
                    client_settings[client_name]["secret"])
2662
 
    
2663
 
    # Add/remove clients based on new changes made to config
2664
 
    for client_name in (set(old_client_settings)
2665
 
                        - set(client_settings)):
2666
 
        del clients_data[client_name]
2667
 
    for client_name in (set(client_settings)
2668
 
                        - set(old_client_settings)):
2669
 
        clients_data[client_name] = client_settings[client_name]
2670
 
    
2671
 
    # Create all client objects
2672
 
    for client_name, client in clients_data.items():
2673
 
        tcp_server.clients[client_name] = client_class(
2674
 
            name = client_name, settings = client,
2675
 
            server_settings = server_settings)
2676
 
    
 
2040
                yield (name, special_settings[name]())
 
2041
            except KeyError:
 
2042
                yield (name, value)
 
2043
    
 
2044
    tcp_server.clients.update(set(
 
2045
            client_class(name = section,
 
2046
                         config= dict(client_config_items(
 
2047
                        client_config, section)))
 
2048
            for section in client_config.sections()))
2677
2049
    if not tcp_server.clients:
2678
2050
        logger.warning("No clients defined")
2679
 
    
2680
 
    if not foreground:
2681
 
        if pidfile is not None:
2682
 
            try:
2683
 
                with pidfile:
2684
 
                    pid = os.getpid()
2685
 
                    pidfile.write("{}\n".format(pid).encode("utf-8"))
2686
 
            except IOError:
2687
 
                logger.error("Could not write to file %r with PID %d",
2688
 
                             pidfilename, pid)
2689
 
        del pidfile
 
2051
        
 
2052
    if not debug:
 
2053
        try:
 
2054
            with pidfile:
 
2055
                pid = os.getpid()
 
2056
                pidfile.write(str(pid) + "\n".encode("utf-8"))
 
2057
            del pidfile
 
2058
        except IOError:
 
2059
            logger.error("Could not write to file %r with PID %d",
 
2060
                         pidfilename, pid)
 
2061
        except NameError:
 
2062
            # "pidfile" was never created
 
2063
            pass
2690
2064
        del pidfilename
 
2065
        
 
2066
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2691
2067
    
2692
2068
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2693
2069
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2694
2070
    
2695
2071
    if use_dbus:
2696
 
        @alternate_dbus_interfaces({"se.recompile.Mandos":
2697
 
                                        "se.bsnet.fukt.Mandos"})
2698
 
        class MandosDBusService(DBusObjectWithProperties):
 
2072
        class MandosDBusService(dbus.service.Object):
2699
2073
            """A D-Bus proxy object"""
2700
2074
            def __init__(self):
2701
2075
                dbus.service.Object.__init__(self, bus, "/")
2702
2076
            _interface = "se.recompile.Mandos"
2703
2077
            
2704
 
            @dbus_interface_annotations(_interface)
2705
 
            def _foo(self):
2706
 
                return { "org.freedesktop.DBus.Property"
2707
 
                         ".EmitsChangedSignal":
2708
 
                             "false"}
2709
 
            
2710
2078
            @dbus.service.signal(_interface, signature="o")
2711
2079
            def ClientAdded(self, objpath):
2712
2080
                "D-Bus signal"
2726
2094
            def GetAllClients(self):
2727
2095
                "D-Bus method"
2728
2096
                return dbus.Array(c.dbus_object_path
2729
 
                                  for c in
2730
 
                                  tcp_server.clients.itervalues())
 
2097
                                  for c in tcp_server.clients)
2731
2098
            
2732
2099
            @dbus.service.method(_interface,
2733
2100
                                 out_signature="a{oa{sv}}")
2734
2101
            def GetAllClientsWithProperties(self):
2735
2102
                "D-Bus method"
2736
2103
                return dbus.Dictionary(
2737
 
                    { c.dbus_object_path: c.GetAll("")
2738
 
                      for c in tcp_server.clients.itervalues() },
 
2104
                    ((c.dbus_object_path, c.GetAll(""))
 
2105
                     for c in tcp_server.clients),
2739
2106
                    signature="oa{sv}")
2740
2107
            
2741
2108
            @dbus.service.method(_interface, in_signature="o")
2742
2109
            def RemoveClient(self, object_path):
2743
2110
                "D-Bus method"
2744
 
                for c in tcp_server.clients.itervalues():
 
2111
                for c in tcp_server.clients:
2745
2112
                    if c.dbus_object_path == object_path:
2746
 
                        del tcp_server.clients[c.name]
 
2113
                        tcp_server.clients.remove(c)
2747
2114
                        c.remove_from_connection()
2748
2115
                        # Don't signal anything except ClientRemoved
2749
2116
                        c.disable(quiet=True)
2754
2121
            
2755
2122
            del _interface
2756
2123
        
2757
 
        mandos_dbus_service = MandosDBusService()
 
2124
        class MandosDBusServiceTransitional(MandosDBusService):
 
2125
            __metaclass__ = AlternateDBusNamesMetaclass
 
2126
        mandos_dbus_service = MandosDBusServiceTransitional()
2758
2127
    
2759
2128
    def cleanup():
2760
2129
        "Cleanup function; run on exit"
2761
 
        if zeroconf:
2762
 
            service.cleanup()
2763
 
        
2764
 
        multiprocessing.active_children()
2765
 
        wnull.close()
2766
 
        if not (tcp_server.clients or client_settings):
2767
 
            return
2768
 
        
2769
 
        # Store client before exiting. Secrets are encrypted with key
2770
 
        # based on what config file has. If config file is
2771
 
        # removed/edited, old secret will thus be unrecovable.
2772
 
        clients = {}
2773
 
        with PGPEngine() as pgp:
2774
 
            for client in tcp_server.clients.itervalues():
2775
 
                key = client_settings[client.name]["secret"]
2776
 
                client.encrypted_secret = pgp.encrypt(client.secret,
2777
 
                                                      key)
2778
 
                client_dict = {}
2779
 
                
2780
 
                # A list of attributes that can not be pickled
2781
 
                # + secret.
2782
 
                exclude = { "bus", "changedstate", "secret",
2783
 
                            "checker", "server_settings" }
2784
 
                for name, typ in (inspect.getmembers
2785
 
                                  (dbus.service.Object)):
2786
 
                    exclude.add(name)
2787
 
                
2788
 
                client_dict["encrypted_secret"] = (client
2789
 
                                                   .encrypted_secret)
2790
 
                for attr in client.client_structure:
2791
 
                    if attr not in exclude:
2792
 
                        client_dict[attr] = getattr(client, attr)
2793
 
                
2794
 
                clients[client.name] = client_dict
2795
 
                del client_settings[client.name]["secret"]
2796
 
        
2797
 
        try:
2798
 
            with (tempfile.NamedTemporaryFile
2799
 
                  (mode='wb', suffix=".pickle", prefix='clients-',
2800
 
                   dir=os.path.dirname(stored_state_path),
2801
 
                   delete=False)) as stored_state:
2802
 
                pickle.dump((clients, client_settings), stored_state)
2803
 
                tempname=stored_state.name
2804
 
            os.rename(tempname, stored_state_path)
2805
 
        except (IOError, OSError) as e:
2806
 
            if not debug:
2807
 
                try:
2808
 
                    os.remove(tempname)
2809
 
                except NameError:
2810
 
                    pass
2811
 
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2812
 
                logger.warning("Could not save persistent state: {}"
2813
 
                               .format(os.strerror(e.errno)))
2814
 
            else:
2815
 
                logger.warning("Could not save persistent state:",
2816
 
                               exc_info=e)
2817
 
                raise
2818
 
        
2819
 
        # Delete all clients, and settings from config
 
2130
        service.cleanup()
 
2131
        
2820
2132
        while tcp_server.clients:
2821
 
            name, client = tcp_server.clients.popitem()
 
2133
            client = tcp_server.clients.pop()
2822
2134
            if use_dbus:
2823
2135
                client.remove_from_connection()
 
2136
            client.disable_hook = None
2824
2137
            # Don't signal anything except ClientRemoved
2825
2138
            client.disable(quiet=True)
2826
2139
            if use_dbus:
2828
2141
                mandos_dbus_service.ClientRemoved(client
2829
2142
                                                  .dbus_object_path,
2830
2143
                                                  client.name)
2831
 
        client_settings.clear()
2832
2144
    
2833
2145
    atexit.register(cleanup)
2834
2146
    
2835
 
    for client in tcp_server.clients.itervalues():
 
2147
    for client in tcp_server.clients:
2836
2148
        if use_dbus:
2837
2149
            # Emit D-Bus signal
2838
2150
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
2839
 
        # Need to initiate checking of clients
2840
 
        if client.enabled:
2841
 
            client.init_checker()
 
2151
        client.enable()
2842
2152
    
2843
2153
    tcp_server.enable()
2844
2154
    tcp_server.server_activate()
2845
2155
    
2846
2156
    # Find out what port we got
2847
 
    if zeroconf:
2848
 
        service.port = tcp_server.socket.getsockname()[1]
 
2157
    service.port = tcp_server.socket.getsockname()[1]
2849
2158
    if use_ipv6:
2850
2159
        logger.info("Now listening on address %r, port %d,"
2851
 
                    " flowinfo %d, scope_id %d",
2852
 
                    *tcp_server.socket.getsockname())
 
2160
                    " flowinfo %d, scope_id %d"
 
2161
                    % tcp_server.socket.getsockname())
2853
2162
    else:                       # IPv4
2854
 
        logger.info("Now listening on address %r, port %d",
2855
 
                    *tcp_server.socket.getsockname())
 
2163
        logger.info("Now listening on address %r, port %d"
 
2164
                    % tcp_server.socket.getsockname())
2856
2165
    
2857
2166
    #service.interface = tcp_server.socket.getsockname()[3]
2858
2167
    
2859
2168
    try:
2860
 
        if zeroconf:
2861
 
            # From the Avahi example code
2862
 
            try:
2863
 
                service.activate()
2864
 
            except dbus.exceptions.DBusException as error:
2865
 
                logger.critical("D-Bus Exception", exc_info=error)
2866
 
                cleanup()
2867
 
                sys.exit(1)
2868
 
            # End of Avahi example code
 
2169
        # From the Avahi example code
 
2170
        try:
 
2171
            service.activate()
 
2172
        except dbus.exceptions.DBusException as error:
 
2173
            logger.critical("DBusException: %s", error)
 
2174
            cleanup()
 
2175
            sys.exit(1)
 
2176
        # End of Avahi example code
2869
2177
        
2870
2178
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2871
2179
                             lambda *args, **kwargs:
2875
2183
        logger.debug("Starting main loop")
2876
2184
        main_loop.run()
2877
2185
    except AvahiError as error:
2878
 
        logger.critical("Avahi Error", exc_info=error)
 
2186
        logger.critical("AvahiError: %s", error)
2879
2187
        cleanup()
2880
2188
        sys.exit(1)
2881
2189
    except KeyboardInterrupt:
2886
2194
    # Must run before the D-Bus bus name gets deregistered
2887
2195
    cleanup()
2888
2196
 
 
2197
 
2889
2198
if __name__ == '__main__':
2890
2199
    main()