/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2014-07-15 23:52:00 UTC
  • Revision ID: teddy@recompile.se-20140715235200-4dukd7i2tvbcix61
mandos-client: Bug Fix: Fix some memory leaks.

* plugins.d/mandos-client.c (resolve_callback): Always free resolver.
  (run_network_hooks): Free the individual direntries.
  (main): When listing network interfaces and when removing the GPGME
          temp directory, free the individual direntries.

Show diffs side-by-side

added added

removed removed

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