/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2011-09-26 19:36:18 UTC
  • mfrom: (24.1.184 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20110926193618-vtj5c9hena1maixx
Merge from Björn

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#!/usr/bin/python2.7
 
1
#!/usr/bin/python
2
2
# -*- mode: python; coding: utf-8 -*-
3
3
4
4
# Mandos server - give out binary blobs to connecting clients.
11
11
# "AvahiService" class, and some lines in "main".
12
12
13
13
# Everything else is
14
 
# Copyright © 2008-2014 Teddy Hogeborn
15
 
# Copyright © 2008-2014 Björn Påhlsson
 
14
# Copyright © 2008-2011 Teddy Hogeborn
 
15
# Copyright © 2008-2011 Björn Påhlsson
16
16
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
28
28
# along with this program.  If not, see
29
29
# <http://www.gnu.org/licenses/>.
30
30
31
 
# Contact the authors at <mandos@recompile.se>.
 
31
# Contact the authors at <mandos@fukt.bsnet.se>.
32
32
33
33
 
34
34
from __future__ import (division, absolute_import, print_function,
35
35
                        unicode_literals)
36
36
 
37
 
from future_builtins import *
38
 
 
39
37
import SocketServer as socketserver
40
38
import socket
41
39
import argparse
64
62
import functools
65
63
import cPickle as pickle
66
64
import multiprocessing
67
 
import types
68
 
import binascii
69
 
import tempfile
70
 
import itertools
71
 
import collections
72
65
 
73
66
import dbus
74
67
import dbus.service
88
81
    except ImportError:
89
82
        SO_BINDTODEVICE = None
90
83
 
91
 
version = "1.6.7"
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
 
 
 
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)
223
102
 
224
103
class AvahiError(Exception):
225
104
    def __init__(self, value, *args, **kwargs):
243
122
               Used to optionally bind to the specified interface.
244
123
    name: string; Example: 'Mandos'
245
124
    type: string; Example: '_mandos._tcp'.
246
 
     See <https://www.iana.org/assignments/service-names-port-numbers>
 
125
                  See <http://www.dns-sd.org/ServiceTypes.html>
247
126
    port: integer; what port to announce
248
127
    TXT: list of strings; TXT record for the service
249
128
    domain: string; Domain to publish on, default to .local if empty.
255
134
    server: D-Bus Server
256
135
    bus: dbus.SystemBus()
257
136
    """
258
 
    
259
137
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
260
138
                 servicetype = None, port = None, TXT = None,
261
139
                 domain = "", host = "", max_renames = 32768,
274
152
        self.server = None
275
153
        self.bus = bus
276
154
        self.entry_group_state_changed_match = None
277
 
    
278
155
    def rename(self):
279
156
        """Derived from the Avahi example code"""
280
157
        if self.rename_count >= self.max_renames:
282
159
                            " after %i retries, exiting.",
283
160
                            self.rename_count)
284
161
            raise AvahiServiceError("Too many renames")
285
 
        self.name = unicode(self.server
286
 
                            .GetAlternativeServiceName(self.name))
 
162
        self.name = unicode(self.server.GetAlternativeServiceName(self.name))
287
163
        logger.info("Changing Zeroconf service name to %r ...",
288
164
                    self.name)
 
165
        syslogger.setFormatter(logging.Formatter
 
166
                               ('Mandos (%s) [%%(process)d]:'
 
167
                                ' %%(levelname)s: %%(message)s'
 
168
                                % self.name))
289
169
        self.remove()
290
170
        try:
291
171
            self.add()
292
172
        except dbus.exceptions.DBusException as error:
293
 
            logger.critical("D-Bus Exception", exc_info=error)
 
173
            logger.critical("DBusException: %s", error)
294
174
            self.cleanup()
295
175
            os._exit(1)
296
176
        self.rename_count += 1
297
 
    
298
177
    def remove(self):
299
178
        """Derived from the Avahi example code"""
300
179
        if self.entry_group_state_changed_match is not None:
302
181
            self.entry_group_state_changed_match = None
303
182
        if self.group is not None:
304
183
            self.group.Reset()
305
 
    
306
184
    def add(self):
307
185
        """Derived from the Avahi example code"""
308
186
        self.remove()
313
191
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
314
192
        self.entry_group_state_changed_match = (
315
193
            self.group.connect_to_signal(
316
 
                'StateChanged', self.entry_group_state_changed))
 
194
                'StateChanged', self .entry_group_state_changed))
317
195
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
318
196
                     self.name, self.type)
319
197
        self.group.AddService(
325
203
            dbus.UInt16(self.port),
326
204
            avahi.string_array_to_txt_array(self.TXT))
327
205
        self.group.Commit()
328
 
    
329
206
    def entry_group_state_changed(self, state, error):
330
207
        """Derived from the Avahi example code"""
331
208
        logger.debug("Avahi entry group state change: %i", state)
338
215
        elif state == avahi.ENTRY_GROUP_FAILURE:
339
216
            logger.critical("Avahi: Error in group state changed %s",
340
217
                            unicode(error))
341
 
            raise AvahiGroupError("State changed: {0!s}"
342
 
                                  .format(error))
343
 
    
 
218
            raise AvahiGroupError("State changed: %s"
 
219
                                  % unicode(error))
344
220
    def cleanup(self):
345
221
        """Derived from the Avahi example code"""
346
222
        if self.group is not None:
347
223
            try:
348
224
                self.group.Free()
349
225
            except (dbus.exceptions.UnknownMethodException,
350
 
                    dbus.exceptions.DBusException):
 
226
                    dbus.exceptions.DBusException) as e:
351
227
                pass
352
228
            self.group = None
353
229
        self.remove()
354
 
    
355
230
    def server_state_changed(self, state, error=None):
356
231
        """Derived from the Avahi example code"""
357
232
        logger.debug("Avahi server state change: %i", state)
376
251
                logger.debug("Unknown state: %r", state)
377
252
            else:
378
253
                logger.debug("Unknown state: %r: %r", state, error)
379
 
    
380
254
    def activate(self):
381
255
        """Derived from the Avahi example code"""
382
256
        if self.server is None:
390
264
        self.server_state_changed(self.server.GetState())
391
265
 
392
266
 
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):
 
267
def _timedelta_to_milliseconds(td):
405
268
    "Convert a datetime.timedelta() to milliseconds"
406
269
    return ((td.days * 24 * 60 * 60 * 1000)
407
270
            + (td.seconds * 1000)
408
271
            + (td.microseconds // 1000))
409
 
 
410
 
 
 
272
        
411
273
class Client(object):
412
274
    """A representation of a client host served by this server.
413
275
    
414
276
    Attributes:
415
 
    approved:   bool(); 'None' if not yet approved/disapproved
 
277
    _approved:   bool(); 'None' if not yet approved/disapproved
416
278
    approval_delay: datetime.timedelta(); Time to wait for approval
417
279
    approval_duration: datetime.timedelta(); Duration of one approval
418
280
    checker:    subprocess.Popen(); a running checker process used
425
287
                     instance %(name)s can be used in the command.
426
288
    checker_initiator_tag: a gobject event source tag, or None
427
289
    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
430
290
    current_checker_command: string; current running checker_command
 
291
    disable_hook:  If set, called by disable() as disable_hook(self)
431
292
    disable_initiator_tag: a gobject event source tag, or None
432
293
    enabled:    bool()
433
294
    fingerprint: string (40 or 32 hexadecimal digits); used to
436
297
    interval:   datetime.timedelta(); How often to start a new checker
437
298
    last_approval_request: datetime.datetime(); (UTC) or None
438
299
    last_checked_ok: datetime.datetime(); (UTC) or None
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
 
300
    last_enabled: datetime.datetime(); (UTC)
443
301
    name:       string; from the config file, used in log messages and
444
302
                        D-Bus identifiers
445
303
    secret:     bytestring; sent verbatim (over TLS) to client
446
304
    timeout:    datetime.timedelta(); How long from last_checked_ok
447
305
                                      until this client is disabled
448
 
    extended_timeout:   extra long timeout when secret has been sent
 
306
    extended_timeout:   extra long timeout when password has been sent
449
307
    runtime_expansions: Allowed attributes for runtime expansion.
450
308
    expires:    datetime.datetime(); time (UTC) when a client will be
451
309
                disabled, or None
452
 
    server_settings: The server_settings dict from main()
453
310
    """
454
311
    
455
312
    runtime_expansions = ("approval_delay", "approval_duration",
456
 
                          "created", "enabled", "expires",
457
 
                          "fingerprint", "host", "interval",
458
 
                          "last_approval_request", "last_checked_ok",
 
313
                          "created", "enabled", "fingerprint",
 
314
                          "host", "interval", "last_checked_ok",
459
315
                          "last_enabled", "name", "timeout")
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
 
    
 
316
        
471
317
    def timeout_milliseconds(self):
472
318
        "Return the 'timeout' attribute in milliseconds"
473
 
        return timedelta_to_milliseconds(self.timeout)
474
 
    
 
319
        return _timedelta_to_milliseconds(self.timeout)
 
320
 
475
321
    def extended_timeout_milliseconds(self):
476
322
        "Return the 'extended_timeout' attribute in milliseconds"
477
 
        return timedelta_to_milliseconds(self.extended_timeout)
 
323
        return _timedelta_to_milliseconds(self.extended_timeout)    
478
324
    
479
325
    def interval_milliseconds(self):
480
326
        "Return the 'interval' attribute in milliseconds"
481
 
        return timedelta_to_milliseconds(self.interval)
482
 
    
 
327
        return _timedelta_to_milliseconds(self.interval)
 
328
 
483
329
    def approval_delay_milliseconds(self):
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):
 
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."""
534
336
        self.name = name
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
 
        
 
337
        if config is None:
 
338
            config = {}
552
339
        logger.debug("Creating client %r", self.name)
553
340
        # Uppercase and remove spaces from fingerprint for later
554
341
        # comparison purposes with return value from the fingerprint()
555
342
        # function
 
343
        self.fingerprint = (config["fingerprint"].upper()
 
344
                            .replace(" ", ""))
556
345
        logger.debug("  Fingerprint: %s", self.fingerprint)
557
 
        self.created = settings.get("created",
558
 
                                    datetime.datetime.utcnow())
559
 
        
560
 
        # attributes specific for this server instance
 
346
        if "secret" in config:
 
347
            self.secret = config["secret"].decode("base64")
 
348
        elif "secfile" in config:
 
349
            with open(os.path.expanduser(os.path.expandvars
 
350
                                         (config["secfile"])),
 
351
                      "rb") as secfile:
 
352
                self.secret = secfile.read()
 
353
        else:
 
354
            raise TypeError("No secret or secfile for client %s"
 
355
                            % self.name)
 
356
        self.host = config.get("host", "")
 
357
        self.created = datetime.datetime.utcnow()
 
358
        self.enabled = False
 
359
        self.last_approval_request = None
 
360
        self.last_enabled = None
 
361
        self.last_checked_ok = None
 
362
        self.timeout = string_to_delta(config["timeout"])
 
363
        self.extended_timeout = string_to_delta(config["extended_timeout"])
 
364
        self.interval = string_to_delta(config["interval"])
 
365
        self.disable_hook = disable_hook
561
366
        self.checker = None
562
367
        self.checker_initiator_tag = None
563
368
        self.disable_initiator_tag = None
 
369
        self.expires = None
564
370
        self.checker_callback_tag = None
 
371
        self.checker_command = config["checker"]
565
372
        self.current_checker_command = None
566
 
        self.approved = None
 
373
        self.last_connect = None
 
374
        self._approved = None
 
375
        self.approved_by_default = config.get("approved_by_default",
 
376
                                              True)
567
377
        self.approvals_pending = 0
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)
 
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())
582
383
    
583
 
    # Send notice to process children that client state has changed
584
384
    def send_changedstate(self):
585
 
        with self.changedstate:
586
 
            self.changedstate.notify_all()
587
 
    
 
385
        self.changedstate.acquire()
 
386
        self.changedstate.notify_all()
 
387
        self.changedstate.release()
 
388
        
588
389
    def enable(self):
589
390
        """Start this client's checker and timeout hooks"""
590
391
        if getattr(self, "enabled", False):
591
392
            # Already enabled
592
393
            return
 
394
        self.send_changedstate()
 
395
        # Schedule a new checker to be started an 'interval' from now,
 
396
        # and every interval from then on.
 
397
        self.checker_initiator_tag = (gobject.timeout_add
 
398
                                      (self.interval_milliseconds(),
 
399
                                       self.start_checker))
 
400
        # Schedule a disable() when 'timeout' has passed
593
401
        self.expires = datetime.datetime.utcnow() + self.timeout
 
402
        self.disable_initiator_tag = (gobject.timeout_add
 
403
                                   (self.timeout_milliseconds(),
 
404
                                    self.disable))
594
405
        self.enabled = True
595
406
        self.last_enabled = datetime.datetime.utcnow()
596
 
        self.init_checker()
597
 
        self.send_changedstate()
 
407
        # Also start a new checker *right now*.
 
408
        self.start_checker()
598
409
    
599
410
    def disable(self, quiet=True):
600
411
        """Disable this client."""
601
412
        if not getattr(self, "enabled", False):
602
413
            return False
603
414
        if not quiet:
 
415
            self.send_changedstate()
 
416
        if not quiet:
604
417
            logger.info("Disabling client %s", self.name)
605
 
        if getattr(self, "disable_initiator_tag", None) is not None:
 
418
        if getattr(self, "disable_initiator_tag", False):
606
419
            gobject.source_remove(self.disable_initiator_tag)
607
420
            self.disable_initiator_tag = None
608
421
        self.expires = None
609
 
        if getattr(self, "checker_initiator_tag", None) is not None:
 
422
        if getattr(self, "checker_initiator_tag", False):
610
423
            gobject.source_remove(self.checker_initiator_tag)
611
424
            self.checker_initiator_tag = None
612
425
        self.stop_checker()
 
426
        if self.disable_hook:
 
427
            self.disable_hook(self)
613
428
        self.enabled = False
614
 
        if not quiet:
615
 
            self.send_changedstate()
616
429
        # Do not run this again if called by a gobject.timeout_add
617
430
        return False
618
431
    
619
432
    def __del__(self):
 
433
        self.disable_hook = None
620
434
        self.disable()
621
435
    
622
 
    def init_checker(self):
623
 
        # Schedule a new checker to be started an 'interval' from now,
624
 
        # and every interval from then on.
625
 
        if self.checker_initiator_tag is not None:
626
 
            gobject.source_remove(self.checker_initiator_tag)
627
 
        self.checker_initiator_tag = (gobject.timeout_add
628
 
                                      (self.interval_milliseconds(),
629
 
                                       self.start_checker))
630
 
        # Schedule a disable() when 'timeout' has passed
631
 
        if self.disable_initiator_tag is not None:
632
 
            gobject.source_remove(self.disable_initiator_tag)
633
 
        self.disable_initiator_tag = (gobject.timeout_add
634
 
                                   (self.timeout_milliseconds(),
635
 
                                    self.disable))
636
 
        # Also start a new checker *right now*.
637
 
        self.start_checker()
638
 
    
639
436
    def checker_callback(self, pid, condition, command):
640
437
        """The checker has completed, so take appropriate actions."""
641
438
        self.checker_callback_tag = None
642
439
        self.checker = None
643
440
        if os.WIFEXITED(condition):
644
 
            self.last_checker_status = os.WEXITSTATUS(condition)
645
 
            if self.last_checker_status == 0:
 
441
            exitstatus = os.WEXITSTATUS(condition)
 
442
            if exitstatus == 0:
646
443
                logger.info("Checker for %(name)s succeeded",
647
444
                            vars(self))
648
445
                self.checked_ok()
650
447
                logger.info("Checker for %(name)s failed",
651
448
                            vars(self))
652
449
        else:
653
 
            self.last_checker_status = -1
654
450
            logger.warning("Checker for %(name)s crashed?",
655
451
                           vars(self))
656
452
    
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."""
 
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
        """
665
459
        if timeout is None:
666
460
            timeout = self.timeout
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
 
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))
675
467
    
676
468
    def need_approval(self):
677
469
        self.last_approval_request = datetime.datetime.utcnow()
682
474
        If a checker already exists, leave it running and do
683
475
        nothing."""
684
476
        # The reason for not killing a running checker is that if we
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
 
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
689
481
        # checkers alone, the checker would have to take more time
690
482
        # than 'timeout' for the client to be disabled, which is as it
691
483
        # should be.
693
485
        # If a checker exists, make sure it is not a zombie
694
486
        try:
695
487
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
696
 
        except AttributeError:
697
 
            pass
698
 
        except OSError as error:
699
 
            if error.errno != errno.ECHILD:
700
 
                raise
 
488
        except (AttributeError, OSError) as error:
 
489
            if (isinstance(error, OSError)
 
490
                and error.errno != errno.ECHILD):
 
491
                raise error
701
492
        else:
702
493
            if pid:
703
494
                logger.warning("Checker was a zombie")
706
497
                                      self.current_checker_command)
707
498
        # Start a new checker if needed
708
499
        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)
714
500
            try:
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
 
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
720
519
            self.current_checker_command = command
721
520
            try:
722
521
                logger.info("Starting checker %r for %s",
725
524
                # in normal mode, that is already done by daemon(),
726
525
                # and in debug mode we don't want to.  (Stdin is
727
526
                # 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 })
736
527
                self.checker = subprocess.Popen(command,
737
528
                                                close_fds=True,
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:
 
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.
751
536
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
537
                if pid:
 
538
                    gobject.source_remove(self.checker_callback_tag)
 
539
                    self.checker_callback(pid, status, command)
752
540
            except OSError as 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)
 
541
                logger.error("Failed to start subprocess: %s",
 
542
                             error)
762
543
        # Re-run this periodically if run by gobject.timeout_add
763
544
        return True
764
545
    
771
552
            return
772
553
        logger.debug("Stopping checker for %(name)s", vars(self))
773
554
        try:
774
 
            self.checker.terminate()
 
555
            os.kill(self.checker.pid, signal.SIGTERM)
775
556
            #time.sleep(0.5)
776
557
            #if self.checker.poll() is None:
777
 
            #    self.checker.kill()
 
558
            #    os.kill(self.checker.pid, signal.SIGKILL)
778
559
        except OSError as error:
779
560
            if error.errno != errno.ESRCH: # No such process
780
561
                raise
781
562
        self.checker = None
782
563
 
783
 
 
784
564
def dbus_service_property(dbus_interface, signature="v",
785
565
                          access="readwrite", byte_arrays=False):
786
566
    """Decorators for marking methods of a DBusObjectWithProperties to
797
577
    # "Set" method, so we fail early here:
798
578
    if byte_arrays and signature != "ay":
799
579
        raise ValueError("Byte arrays not supported for non-'ay'"
800
 
                         " signature {0!r}".format(signature))
 
580
                         " signature %r" % signature)
801
581
    def decorator(func):
802
582
        func._dbus_is_property = True
803
583
        func._dbus_interface = dbus_interface
811
591
    return decorator
812
592
 
813
593
 
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
 
 
851
594
class DBusPropertyException(dbus.exceptions.DBusException):
852
595
    """A base class for D-Bus property-related exceptions
853
596
    """
869
612
 
870
613
class DBusObjectWithProperties(dbus.service.Object):
871
614
    """A D-Bus object with properties.
872
 
    
 
615
 
873
616
    Classes inheriting from this can use the dbus_service_property
874
617
    decorator to expose methods as D-Bus properties.  It exposes the
875
618
    standard Get(), Set(), and GetAll() methods on the D-Bus.
876
619
    """
877
620
    
878
621
    @staticmethod
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)
 
622
    def _is_dbus_property(obj):
 
623
        return getattr(obj, "_dbus_is_property", False)
887
624
    
888
 
    def _get_all_dbus_things(self, thing):
 
625
    def _get_all_dbus_properties(self):
889
626
        """Returns a generator of (name, attribute) pairs
890
627
        """
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)))
 
628
        return ((prop._dbus_name, prop)
 
629
                for name, prop in
 
630
                inspect.getmembers(self, self._is_dbus_property))
898
631
    
899
632
    def _get_dbus_property(self, interface_name, property_name):
900
633
        """Returns a bound method if one exists which is a D-Bus
901
634
        property with the specified name and interface.
902
635
        """
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
 
        
 
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
911
646
        # No such property
912
647
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
913
648
                                   + interface_name + "."
937
672
            # The byte_arrays option is not supported yet on
938
673
            # signatures other than "ay".
939
674
            if prop._dbus_signature != "ay":
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))
 
675
                raise ValueError
 
676
            value = dbus.ByteArray(''.join(unichr(byte)
 
677
                                           for byte in value))
945
678
        prop(value)
946
679
    
947
680
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
949
682
    def GetAll(self, interface_name):
950
683
        """Standard D-Bus property GetAll() method, see D-Bus
951
684
        standard.
952
 
        
 
685
 
953
686
        Note: Will not include properties with access="write".
954
687
        """
955
 
        properties = {}
956
 
        for name, prop in self._get_all_dbus_things("property"):
 
688
        all = {}
 
689
        for name, prop in self._get_all_dbus_properties():
957
690
            if (interface_name
958
691
                and interface_name != prop._dbus_interface):
959
692
                # Interface non-empty but did not match
963
696
                continue
964
697
            value = prop()
965
698
            if not hasattr(value, "variant_level"):
966
 
                properties[name] = value
 
699
                all[name] = value
967
700
                continue
968
 
            properties[name] = type(value)(value, variant_level=
969
 
                                           value.variant_level+1)
970
 
        return dbus.Dictionary(properties, signature="sv")
 
701
            all[name] = type(value)(value, variant_level=
 
702
                                    value.variant_level+1)
 
703
        return dbus.Dictionary(all, signature="sv")
971
704
    
972
705
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
973
706
                         out_signature="s",
974
707
                         path_keyword='object_path',
975
708
                         connection_keyword='connection')
976
709
    def Introspect(self, object_path, connection):
977
 
        """Overloading of standard D-Bus method.
978
 
        
979
 
        Inserts property tags and interface annotation tags.
 
710
        """Standard D-Bus method, overloaded to insert property tags.
980
711
        """
981
712
        xmlstring = dbus.service.Object.Introspect(self, object_path,
982
713
                                                   connection)
989
720
                e.setAttribute("access", prop._dbus_access)
990
721
                return e
991
722
            for if_tag in document.getElementsByTagName("interface"):
992
 
                # Add property tags
993
723
                for tag in (make_tag(document, name, prop)
994
724
                            for name, prop
995
 
                            in self._get_all_dbus_things("property")
 
725
                            in self._get_all_dbus_properties()
996
726
                            if prop._dbus_interface
997
727
                            == if_tag.getAttribute("name")):
998
728
                    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)
1030
729
                # Add the names to the return values for the
1031
730
                # "org.freedesktop.DBus.Properties" methods
1032
731
                if (if_tag.getAttribute("name")
1047
746
        except (AttributeError, xml.dom.DOMException,
1048
747
                xml.parsers.expat.ExpatError) as error:
1049
748
            logger.error("Failed to override Introspection method",
1050
 
                         exc_info=error)
 
749
                         error)
1051
750
        return xmlstring
1052
751
 
1053
752
 
1054
 
def datetime_to_dbus(dt, variant_level=0):
 
753
def datetime_to_dbus (dt, variant_level=0):
1055
754
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1056
755
    if dt is None:
1057
756
        return dbus.String("", variant_level = variant_level)
1058
757
    return dbus.String(dt.isoformat(),
1059
758
                       variant_level=variant_level)
1060
759
 
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"})
1233
760
class ClientDBus(Client, DBusObjectWithProperties):
1234
761
    """A Client class using D-Bus
1235
762
    
1244
771
    # dbus.service.Object doesn't use super(), so we can't either.
1245
772
    
1246
773
    def __init__(self, bus = None, *args, **kwargs):
 
774
        self._approvals_pending = 0
1247
775
        self.bus = bus
1248
776
        Client.__init__(self, *args, **kwargs)
1249
777
        # Only now, when this client is initialized, can it show up on
1255
783
                                 ("/clients/" + client_object_name))
1256
784
        DBusObjectWithProperties.__init__(self, self.bus,
1257
785
                                          self.dbus_object_path)
1258
 
    
 
786
        
1259
787
    def notifychangeproperty(transform_func,
1260
788
                             dbus_name, type_func=lambda x: x,
1261
789
                             variant_level=1):
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
 
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
1268
795
        type_func: Function that transform the value before sending it
1269
 
                   to the D-Bus.  Default: no transform
1270
 
        variant_level: D-Bus variant level.  Default: 1
 
796
                   to DBus
 
797
        variant_level: DBus variant level. default: 1
1271
798
        """
1272
 
        attrname = "_{0}".format(dbus_name)
 
799
        real_value = [None,]
1273
800
        def setter(self, value):
 
801
            old_value = real_value[0]
 
802
            real_value[0] = value
1274
803
            if hasattr(self, "dbus_object_path"):
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)
 
804
                if type_func(old_value) != type_func(real_value[0]):
 
805
                    dbus_value = transform_func(type_func(real_value[0]),
 
806
                                                variant_level)
1281
807
                    self.PropertyChanged(dbus.String(dbus_name),
1282
808
                                         dbus_value)
1283
 
            setattr(self, attrname, value)
1284
 
        
1285
 
        return property(lambda self: getattr(self, attrname), setter)
1286
 
    
 
809
 
 
810
        return property(lambda self: real_value[0], setter)
 
811
 
 
812
 
1287
813
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1288
814
    approvals_pending = notifychangeproperty(dbus.Boolean,
1289
815
                                             "ApprovalPending",
1292
818
    last_enabled = notifychangeproperty(datetime_to_dbus,
1293
819
                                        "LastEnabled")
1294
820
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1295
 
                                   type_func = lambda checker:
1296
 
                                       checker is not None)
 
821
                                   type_func = lambda checker: checker is not None)
1297
822
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1298
823
                                           "LastCheckedOK")
1299
 
    last_checker_status = notifychangeproperty(dbus.Int16,
1300
 
                                               "LastCheckerStatus")
1301
 
    last_approval_request = notifychangeproperty(
1302
 
        datetime_to_dbus, "LastApprovalRequest")
 
824
    last_approval_request = notifychangeproperty(datetime_to_dbus,
 
825
                                                 "LastApprovalRequest")
1303
826
    approved_by_default = notifychangeproperty(dbus.Boolean,
1304
827
                                               "ApprovedByDefault")
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)
 
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)
1312
832
    host = notifychangeproperty(dbus.String, "Host")
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)
 
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)
1323
839
    checker_command = notifychangeproperty(dbus.String, "Checker")
1324
840
    
1325
841
    del notifychangeproperty
1351
867
        
1352
868
        return Client.checker_callback(self, pid, condition, command,
1353
869
                                       *args, **kwargs)
1354
 
    
 
870
 
1355
871
    def start_checker(self, *args, **kwargs):
1356
 
        old_checker_pid = getattr(self.checker, "pid", None)
 
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
1357
877
        r = Client.start_checker(self, *args, **kwargs)
1358
878
        # Only if new checker process was started
1359
879
        if (self.checker is not None
1363
883
        return r
1364
884
    
1365
885
    def _reset_approved(self):
1366
 
        self.approved = None
 
886
        self._approved = None
1367
887
        return False
1368
888
    
1369
889
    def approve(self, value=True):
1370
 
        self.approved = value
1371
 
        gobject.timeout_add(timedelta_to_milliseconds
 
890
        self.send_changedstate()
 
891
        self._approved = value
 
892
        gobject.timeout_add(_timedelta_to_milliseconds
1372
893
                            (self.approval_duration),
1373
894
                            self._reset_approved)
1374
 
        self.send_changedstate()
 
895
    
1375
896
    
1376
897
    ## D-Bus methods, signals & properties
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"}
 
898
    _interface = "se.bsnet.fukt.Mandos.Client"
1385
899
    
1386
900
    ## Signals
1387
901
    
1487
1001
                           access="readwrite")
1488
1002
    def ApprovalDuration_dbus_property(self, value=None):
1489
1003
        if value is None:       # get
1490
 
            return dbus.UInt64(timedelta_to_milliseconds(
 
1004
            return dbus.UInt64(_timedelta_to_milliseconds(
1491
1005
                    self.approval_duration))
1492
1006
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1493
1007
    
1507
1021
    def Host_dbus_property(self, value=None):
1508
1022
        if value is None:       # get
1509
1023
            return dbus.String(self.host)
1510
 
        self.host = unicode(value)
 
1024
        self.host = value
1511
1025
    
1512
1026
    # Created - property
1513
1027
    @dbus_service_property(_interface, signature="s", access="read")
1514
1028
    def Created_dbus_property(self):
1515
 
        return datetime_to_dbus(self.created)
 
1029
        return dbus.String(datetime_to_dbus(self.created))
1516
1030
    
1517
1031
    # LastEnabled - property
1518
1032
    @dbus_service_property(_interface, signature="s", access="read")
1539
1053
            return
1540
1054
        return datetime_to_dbus(self.last_checked_ok)
1541
1055
    
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
 
    
1548
1056
    # Expires - property
1549
1057
    @dbus_service_property(_interface, signature="s", access="read")
1550
1058
    def Expires_dbus_property(self):
1561
1069
    def Timeout_dbus_property(self, value=None):
1562
1070
        if value is None:       # get
1563
1071
            return dbus.UInt64(self.timeout_milliseconds())
1564
 
        old_timeout = self.timeout
1565
1072
        self.timeout = datetime.timedelta(0, 0, 0, value)
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
 
    
 
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
 
1583
1094
    # ExtendedTimeout - property
1584
1095
    @dbus_service_property(_interface, signature="t",
1585
1096
                           access="readwrite")
1587
1098
        if value is None:       # get
1588
1099
            return dbus.UInt64(self.extended_timeout_milliseconds())
1589
1100
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1590
 
    
 
1101
 
1591
1102
    # Interval - property
1592
1103
    @dbus_service_property(_interface, signature="t",
1593
1104
                           access="readwrite")
1597
1108
        self.interval = datetime.timedelta(0, 0, 0, value)
1598
1109
        if getattr(self, "checker_initiator_tag", None) is None:
1599
1110
            return
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
 
    
 
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
 
1607
1117
    # Checker - property
1608
1118
    @dbus_service_property(_interface, signature="s",
1609
1119
                           access="readwrite")
1610
1120
    def Checker_dbus_property(self, value=None):
1611
1121
        if value is None:       # get
1612
1122
            return dbus.String(self.checker_command)
1613
 
        self.checker_command = unicode(value)
 
1123
        self.checker_command = value
1614
1124
    
1615
1125
    # CheckerRunning - property
1616
1126
    @dbus_service_property(_interface, signature="b",
1643
1153
        self._pipe.send(('init', fpr, address))
1644
1154
        if not self._pipe.recv():
1645
1155
            raise KeyError()
1646
 
    
 
1156
 
1647
1157
    def __getattribute__(self, name):
1648
 
        if name == '_pipe':
 
1158
        if(name == '_pipe'):
1649
1159
            return super(ProxyClient, self).__getattribute__(name)
1650
1160
        self._pipe.send(('getattr', name))
1651
1161
        data = self._pipe.recv()
1656
1166
                self._pipe.send(('funcall', name, args, kwargs))
1657
1167
                return self._pipe.recv()[1]
1658
1168
            return func
1659
 
    
 
1169
 
1660
1170
    def __setattr__(self, name, value):
1661
 
        if name == '_pipe':
 
1171
        if(name == '_pipe'):
1662
1172
            return super(ProxyClient, self).__setattr__(name, value)
1663
1173
        self._pipe.send(('setattr', name, value))
1664
1174
 
1675
1185
                        unicode(self.client_address))
1676
1186
            logger.debug("Pipe FD: %d",
1677
1187
                         self.server.child_pipe.fileno())
1678
 
            
 
1188
 
1679
1189
            session = (gnutls.connection
1680
1190
                       .ClientSession(self.request,
1681
1191
                                      gnutls.connection
1682
1192
                                      .X509Credentials()))
1683
 
            
 
1193
 
1684
1194
            # Note: gnutls.connection.X509Credentials is really a
1685
1195
            # generic GnuTLS certificate credentials object so long as
1686
1196
            # no X.509 keys are added to it.  Therefore, we can use it
1687
1197
            # here despite using OpenPGP certificates.
1688
 
            
 
1198
 
1689
1199
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
1690
1200
            #                      "+AES-256-CBC", "+SHA1",
1691
1201
            #                      "+COMP-NULL", "+CTYPE-OPENPGP",
1697
1207
            (gnutls.library.functions
1698
1208
             .gnutls_priority_set_direct(session._c_object,
1699
1209
                                         priority, None))
1700
 
            
 
1210
 
1701
1211
            # Start communication using the Mandos protocol
1702
1212
            # Get protocol number
1703
1213
            line = self.request.makefile().readline()
1704
1214
            logger.debug("Protocol version: %r", line)
1705
1215
            try:
1706
1216
                if int(line.strip().split()[0]) > 1:
1707
 
                    raise RuntimeError(line)
 
1217
                    raise RuntimeError
1708
1218
            except (ValueError, IndexError, RuntimeError) as error:
1709
1219
                logger.error("Unknown protocol version: %s", error)
1710
1220
                return
1711
 
            
 
1221
 
1712
1222
            # Start GnuTLS connection
1713
1223
            try:
1714
1224
                session.handshake()
1718
1228
                # established.  Just abandon the request.
1719
1229
                return
1720
1230
            logger.debug("Handshake succeeded")
1721
 
            
 
1231
 
1722
1232
            approval_required = False
1723
1233
            try:
1724
1234
                try:
1729
1239
                    logger.warning("Bad certificate: %s", error)
1730
1240
                    return
1731
1241
                logger.debug("Fingerprint: %s", fpr)
1732
 
                
 
1242
 
1733
1243
                try:
1734
1244
                    client = ProxyClient(child_pipe, fpr,
1735
1245
                                         self.client_address)
1747
1257
                                       client.name)
1748
1258
                        if self.server.use_dbus:
1749
1259
                            # Emit D-Bus signal
1750
 
                            client.Rejected("Disabled")
 
1260
                            client.Rejected("Disabled")                    
1751
1261
                        return
1752
1262
                    
1753
 
                    if client.approved or not client.approval_delay:
 
1263
                    if client._approved or not client.approval_delay:
1754
1264
                        #We are approved or approval is disabled
1755
1265
                        break
1756
 
                    elif client.approved is None:
 
1266
                    elif client._approved is None:
1757
1267
                        logger.info("Client %s needs approval",
1758
1268
                                    client.name)
1759
1269
                        if self.server.use_dbus:
1770
1280
                        return
1771
1281
                    
1772
1282
                    #wait until timeout or approved
 
1283
                    #x = float(client._timedelta_to_milliseconds(delay))
1773
1284
                    time = datetime.datetime.now()
1774
1285
                    client.changedstate.acquire()
1775
 
                    client.changedstate.wait(
1776
 
                        float(timedelta_to_milliseconds(delay)
1777
 
                              / 1000))
 
1286
                    client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
1778
1287
                    client.changedstate.release()
1779
1288
                    time2 = datetime.datetime.now()
1780
1289
                    if (time2 - time) >= delay:
1796
1305
                    try:
1797
1306
                        sent = session.send(client.secret[sent_size:])
1798
1307
                    except gnutls.errors.GNUTLSError as error:
1799
 
                        logger.warning("gnutls send failed",
1800
 
                                       exc_info=error)
 
1308
                        logger.warning("gnutls send failed")
1801
1309
                        return
1802
1310
                    logger.debug("Sent: %d, remaining: %d",
1803
1311
                                 sent, len(client.secret)
1804
1312
                                 - (sent_size + sent))
1805
1313
                    sent_size += sent
1806
 
                
 
1314
 
1807
1315
                logger.info("Sending secret to %s", client.name)
1808
 
                # bump the timeout using extended_timeout
1809
 
                client.bump_timeout(client.extended_timeout)
 
1316
                # bump the timeout as if seen
 
1317
                client.checked_ok(client.extended_timeout)
1810
1318
                if self.server.use_dbus:
1811
1319
                    # Emit D-Bus signal
1812
1320
                    client.GotSecret()
1817
1325
                try:
1818
1326
                    session.bye()
1819
1327
                except gnutls.errors.GNUTLSError as error:
1820
 
                    logger.warning("GnuTLS bye failed",
1821
 
                                   exc_info=error)
 
1328
                    logger.warning("GnuTLS bye failed")
1822
1329
    
1823
1330
    @staticmethod
1824
1331
    def peer_certificate(session):
1880
1387
        # Convert the buffer to a Python bytestring
1881
1388
        fpr = ctypes.string_at(buf, buf_len.value)
1882
1389
        # Convert the bytestring to hexadecimal notation
1883
 
        hex_fpr = binascii.hexlify(fpr).upper()
 
1390
        hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
1884
1391
        return hex_fpr
1885
1392
 
1886
1393
 
1889
1396
    def sub_process_main(self, request, address):
1890
1397
        try:
1891
1398
            self.finish_request(request, address)
1892
 
        except Exception:
 
1399
        except:
1893
1400
            self.handle_error(request, address)
1894
1401
        self.close_request(request)
1895
 
    
 
1402
            
1896
1403
    def process_request(self, request, address):
1897
1404
        """Start a new process to process the request."""
1898
 
        proc = multiprocessing.Process(target = self.sub_process_main,
1899
 
                                       args = (request, address))
1900
 
        proc.start()
1901
 
        return proc
1902
 
 
 
1405
        multiprocessing.Process(target = self.sub_process_main,
 
1406
                                args = (request, address)).start()
1903
1407
 
1904
1408
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1905
1409
    """ adds a pipe to the MixIn """
1909
1413
        This function creates a new pipe in self.pipe
1910
1414
        """
1911
1415
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
1912
 
        
1913
 
        proc = MultiprocessingMixIn.process_request(self, request,
1914
 
                                                    client_address)
 
1416
 
 
1417
        super(MultiprocessingMixInWithPipe,
 
1418
              self).process_request(request, client_address)
1915
1419
        self.child_pipe.close()
1916
 
        self.add_pipe(parent_pipe, proc)
1917
 
    
1918
 
    def add_pipe(self, parent_pipe, proc):
 
1420
        self.add_pipe(parent_pipe)
 
1421
 
 
1422
    def add_pipe(self, parent_pipe):
1919
1423
        """Dummy function; override as necessary"""
1920
 
        raise NotImplementedError()
1921
 
 
 
1424
        raise NotImplementedError
1922
1425
 
1923
1426
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1924
1427
                     socketserver.TCPServer, object):
1930
1433
        use_ipv6:       Boolean; to use IPv6 or not
1931
1434
    """
1932
1435
    def __init__(self, server_address, RequestHandlerClass,
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
 
        """
 
1436
                 interface=None, use_ipv6=True):
1937
1437
        self.interface = interface
1938
1438
        if use_ipv6:
1939
1439
            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.
1966
1440
        socketserver.TCPServer.__init__(self, server_address,
1967
1441
                                        RequestHandlerClass)
1968
 
    
1969
1442
    def server_bind(self):
1970
1443
        """This overrides the normal server_bind() function
1971
1444
        to bind to an interface if one was specified, and also NOT to
1979
1452
                try:
1980
1453
                    self.socket.setsockopt(socket.SOL_SOCKET,
1981
1454
                                           SO_BINDTODEVICE,
1982
 
                                           str(self.interface + '\0'))
 
1455
                                           str(self.interface
 
1456
                                               + '\0'))
1983
1457
                except socket.error as error:
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:
 
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:
1988
1463
                        logger.error("SO_BINDTODEVICE not available;"
1989
1464
                                     " cannot bind to interface %s",
1990
1465
                                     self.interface)
1991
 
                    elif error.errno == errno.ENODEV:
1992
 
                        logger.error("Interface %s does not exist,"
1993
 
                                     " cannot bind", self.interface)
1994
1466
                    else:
1995
1467
                        raise
1996
1468
        # Only bind(2) the socket if we really need to.
1999
1471
                if self.address_family == socket.AF_INET6:
2000
1472
                    any_address = "::" # in6addr_any
2001
1473
                else:
2002
 
                    any_address = "0.0.0.0" # INADDR_ANY
 
1474
                    any_address = socket.INADDR_ANY
2003
1475
                self.server_address = (any_address,
2004
1476
                                       self.server_address[1])
2005
1477
            elif not self.server_address[1]:
2026
1498
    """
2027
1499
    def __init__(self, server_address, RequestHandlerClass,
2028
1500
                 interface=None, use_ipv6=True, clients=None,
2029
 
                 gnutls_priority=None, use_dbus=True, socketfd=None):
 
1501
                 gnutls_priority=None, use_dbus=True):
2030
1502
        self.enabled = False
2031
1503
        self.clients = clients
2032
1504
        if self.clients is None:
2033
 
            self.clients = {}
 
1505
            self.clients = set()
2034
1506
        self.use_dbus = use_dbus
2035
1507
        self.gnutls_priority = gnutls_priority
2036
1508
        IPv6_TCPServer.__init__(self, server_address,
2037
1509
                                RequestHandlerClass,
2038
1510
                                interface = interface,
2039
 
                                use_ipv6 = use_ipv6,
2040
 
                                socketfd = socketfd)
 
1511
                                use_ipv6 = use_ipv6)
2041
1512
    def server_activate(self):
2042
1513
        if self.enabled:
2043
1514
            return socketserver.TCPServer.server_activate(self)
2044
 
    
2045
1515
    def enable(self):
2046
1516
        self.enabled = True
2047
 
    
2048
 
    def add_pipe(self, parent_pipe, proc):
 
1517
    def add_pipe(self, parent_pipe):
2049
1518
        # Call "handle_ipc" for both data and EOF events
2050
1519
        gobject.io_add_watch(parent_pipe.fileno(),
2051
1520
                             gobject.IO_IN | gobject.IO_HUP,
2052
1521
                             functools.partial(self.handle_ipc,
2053
 
                                               parent_pipe =
2054
 
                                               parent_pipe,
2055
 
                                               proc = proc))
2056
 
    
 
1522
                                               parent_pipe = parent_pipe))
 
1523
        
2057
1524
    def handle_ipc(self, source, condition, parent_pipe=None,
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()
 
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):
2063
1542
            return False
2064
1543
        
2065
1544
        # Read a request from the child
2070
1549
            fpr = request[1]
2071
1550
            address = request[2]
2072
1551
            
2073
 
            for c in self.clients.itervalues():
 
1552
            for c in self.clients:
2074
1553
                if c.fingerprint == fpr:
2075
1554
                    client = c
2076
1555
                    break
2079
1558
                            "dress: %s", fpr, address)
2080
1559
                if self.use_dbus:
2081
1560
                    # Emit D-Bus signal
2082
 
                    mandos_dbus_service.ClientNotFound(fpr,
2083
 
                                                       address[0])
 
1561
                    mandos_dbus_service.ClientNotFound(fpr, address[0])
2084
1562
                parent_pipe.send(False)
2085
1563
                return False
2086
1564
            
2087
1565
            gobject.io_add_watch(parent_pipe.fileno(),
2088
1566
                                 gobject.IO_IN | gobject.IO_HUP,
2089
1567
                                 functools.partial(self.handle_ipc,
2090
 
                                                   parent_pipe =
2091
 
                                                   parent_pipe,
2092
 
                                                   proc = proc,
2093
 
                                                   client_object =
2094
 
                                                   client))
 
1568
                                                   parent_pipe = parent_pipe,
 
1569
                                                   client_object = client))
2095
1570
            parent_pipe.send(True)
2096
 
            # remove the old hook in favor of the new above hook on
2097
 
            # same fileno
 
1571
            # remove the old hook in favor of the new above hook on same fileno
2098
1572
            return False
2099
1573
        if command == 'funcall':
2100
1574
            funcname = request[1]
2101
1575
            args = request[2]
2102
1576
            kwargs = request[3]
2103
1577
            
2104
 
            parent_pipe.send(('data', getattr(client_object,
2105
 
                                              funcname)(*args,
2106
 
                                                         **kwargs)))
2107
 
        
 
1578
            parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
 
1579
 
2108
1580
        if command == 'getattr':
2109
1581
            attrname = request[1]
2110
1582
            if callable(client_object.__getattribute__(attrname)):
2111
1583
                parent_pipe.send(('function',))
2112
1584
            else:
2113
 
                parent_pipe.send(('data', client_object
2114
 
                                  .__getattribute__(attrname)))
 
1585
                parent_pipe.send(('data', client_object.__getattribute__(attrname)))
2115
1586
        
2116
1587
        if command == 'setattr':
2117
1588
            attrname = request[1]
2118
1589
            value = request[2]
2119
1590
            setattr(client_object, attrname, value)
2120
 
        
 
1591
 
2121
1592
        return True
2122
1593
 
2123
1594
 
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
 
 
2223
1595
def string_to_delta(interval):
2224
1596
    """Parse a string and return a datetime.timedelta
2225
1597
    
2236
1608
    >>> string_to_delta('5m 30s')
2237
1609
    datetime.timedelta(0, 330)
2238
1610
    """
2239
 
    
2240
 
    try:
2241
 
        return rfc3339_duration_to_delta(interval)
2242
 
    except ValueError:
2243
 
        pass
2244
 
    
2245
1611
    timevalue = datetime.timedelta(0)
2246
1612
    for s in interval.split():
2247
1613
        try:
2258
1624
            elif suffix == "w":
2259
1625
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2260
1626
            else:
2261
 
                raise ValueError("Unknown suffix {0!r}"
2262
 
                                 .format(suffix))
2263
 
        except IndexError as e:
 
1627
                raise ValueError("Unknown suffix %r" % suffix)
 
1628
        except (ValueError, IndexError) as e:
2264
1629
            raise ValueError(*(e.args))
2265
1630
        timevalue += delta
2266
1631
    return timevalue
2267
1632
 
2268
1633
 
 
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
 
2269
1658
def daemon(nochdir = False, noclose = False):
2270
1659
    """See daemon(3).  Standard BSD Unix function.
2271
1660
    
2279
1668
        sys.exit()
2280
1669
    if not noclose:
2281
1670
        # Close all standard open file descriptors
2282
 
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
1671
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2283
1672
        if not stat.S_ISCHR(os.fstat(null).st_mode):
2284
1673
            raise OSError(errno.ENODEV,
2285
 
                          "{0} not a character device"
2286
 
                          .format(os.devnull))
 
1674
                          "%s not a character device"
 
1675
                          % os.path.devnull)
2287
1676
        os.dup2(null, sys.stdin.fileno())
2288
1677
        os.dup2(null, sys.stdout.fileno())
2289
1678
        os.dup2(null, sys.stderr.fileno())
2298
1687
    
2299
1688
    parser = argparse.ArgumentParser()
2300
1689
    parser.add_argument("-v", "--version", action="version",
2301
 
                        version = "%(prog)s {0}".format(version),
 
1690
                        version = "%%(prog)s %s" % version,
2302
1691
                        help="show version number and exit")
2303
1692
    parser.add_argument("-i", "--interface", metavar="IF",
2304
1693
                        help="Bind to interface IF")
2310
1699
                        help="Run self-test")
2311
1700
    parser.add_argument("--debug", action="store_true",
2312
1701
                        help="Debug mode; run in foreground and log"
2313
 
                        " to terminal", default=None)
 
1702
                        " to terminal")
2314
1703
    parser.add_argument("--debuglevel", metavar="LEVEL",
2315
1704
                        help="Debug level for stdout output")
2316
1705
    parser.add_argument("--priority", help="GnuTLS"
2323
1712
                        " files")
2324
1713
    parser.add_argument("--no-dbus", action="store_false",
2325
1714
                        dest="use_dbus", help="Do not provide D-Bus"
2326
 
                        " system bus interface", default=None)
 
1715
                        " system bus interface")
2327
1716
    parser.add_argument("--no-ipv6", action="store_false",
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
 
    
 
1717
                        dest="use_ipv6", help="Do not use IPv6")
2344
1718
    options = parser.parse_args()
2345
1719
    
2346
1720
    if options.check:
2347
1721
        import doctest
2348
 
        fail_count, test_count = doctest.testmod()
2349
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
1722
        doctest.testmod()
 
1723
        sys.exit()
2350
1724
    
2351
1725
    # Default values for config file for server-global settings
2352
1726
    server_defaults = { "interface": "",
2354
1728
                        "port": "",
2355
1729
                        "debug": "False",
2356
1730
                        "priority":
2357
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
 
1731
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2358
1732
                        "servicename": "Mandos",
2359
1733
                        "use_dbus": "True",
2360
1734
                        "use_ipv6": "True",
2361
1735
                        "debuglevel": "",
2362
 
                        "restore": "True",
2363
 
                        "socket": "",
2364
 
                        "statedir": "/var/lib/mandos",
2365
 
                        "foreground": "False",
2366
 
                        "zeroconf": "True",
2367
1736
                        }
2368
1737
    
2369
1738
    # Parse config file for server-global settings
2374
1743
    # Convert the SafeConfigParser object to a dict
2375
1744
    server_settings = server_config.defaults()
2376
1745
    # Use the appropriate methods on the non-string config options
2377
 
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
 
1746
    for option in ("debug", "use_dbus", "use_ipv6"):
2378
1747
        server_settings[option] = server_config.getboolean("DEFAULT",
2379
1748
                                                           option)
2380
1749
    if server_settings["port"]:
2381
1750
        server_settings["port"] = server_config.getint("DEFAULT",
2382
1751
                                                       "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"])
2392
1752
    del server_config
2393
1753
    
2394
1754
    # Override the settings from the config file with command line
2395
1755
    # options, if set.
2396
1756
    for option in ("interface", "address", "port", "debug",
2397
1757
                   "priority", "servicename", "configdir",
2398
 
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2399
 
                   "statedir", "socket", "foreground", "zeroconf"):
 
1758
                   "use_dbus", "use_ipv6", "debuglevel"):
2400
1759
        value = getattr(options, option)
2401
1760
        if value is not None:
2402
1761
            server_settings[option] = value
2405
1764
    for option in server_settings.keys():
2406
1765
        if type(server_settings[option]) is str:
2407
1766
            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
2415
1767
    # Now we have our good server settings in "server_settings"
2416
1768
    
2417
1769
    ##################################################################
2418
1770
    
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
 
    
2425
1771
    # For convenience
2426
1772
    debug = server_settings["debug"]
2427
1773
    debuglevel = server_settings["debuglevel"]
2428
1774
    use_dbus = server_settings["use_dbus"]
2429
1775
    use_ipv6 = server_settings["use_ipv6"]
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
 
    
 
1776
 
2444
1777
    if server_settings["servicename"] != "Mandos":
2445
1778
        syslogger.setFormatter(logging.Formatter
2446
 
                               ('Mandos ({0}) [%(process)d]:'
2447
 
                                ' %(levelname)s: %(message)s'
2448
 
                                .format(server_settings
2449
 
                                        ["servicename"])))
 
1779
                               ('Mandos (%s) [%%(process)d]:'
 
1780
                                ' %%(levelname)s: %%(message)s'
 
1781
                                % server_settings["servicename"]))
2450
1782
    
2451
1783
    # Parse config file with clients
2452
 
    client_config = configparser.SafeConfigParser(Client
2453
 
                                                  .client_defaults)
 
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)
2454
1793
    client_config.read(os.path.join(server_settings["configdir"],
2455
1794
                                    "clients.conf"))
2456
1795
    
2457
1796
    global mandos_dbus_service
2458
1797
    mandos_dbus_service = None
2459
1798
    
2460
 
    socketfd = None
2461
 
    if server_settings["socket"] != "":
2462
 
        socketfd = server_settings["socket"]
2463
1799
    tcp_server = MandosServer((server_settings["address"],
2464
1800
                               server_settings["port"]),
2465
1801
                              ClientHandler,
2468
1804
                              use_ipv6=use_ipv6,
2469
1805
                              gnutls_priority=
2470
1806
                              server_settings["priority"],
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
 
1807
                              use_dbus=use_dbus)
 
1808
    if not debug:
 
1809
        pidfilename = "/var/run/mandos.pid"
2478
1810
        try:
2479
1811
            pidfile = open(pidfilename, "w")
2480
 
        except IOError as e:
2481
 
            logger.error("Could not open file %r", pidfilename,
2482
 
                         exc_info=e)
 
1812
        except IOError:
 
1813
            logger.error("Could not open file %r", pidfilename)
2483
1814
    
2484
 
    for name in ("_mandos", "mandos", "nobody"):
 
1815
    try:
 
1816
        uid = pwd.getpwnam("_mandos").pw_uid
 
1817
        gid = pwd.getpwnam("_mandos").pw_gid
 
1818
    except KeyError:
2485
1819
        try:
2486
 
            uid = pwd.getpwnam(name).pw_uid
2487
 
            gid = pwd.getpwnam(name).pw_gid
2488
 
            break
 
1820
            uid = pwd.getpwnam("mandos").pw_uid
 
1821
            gid = pwd.getpwnam("mandos").pw_gid
2489
1822
        except KeyError:
2490
 
            continue
2491
 
    else:
2492
 
        uid = 65534
2493
 
        gid = 65534
 
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
2494
1829
    try:
2495
1830
        os.setgid(gid)
2496
1831
        os.setuid(uid)
2497
1832
    except OSError as error:
2498
 
        if error.errno != errno.EPERM:
2499
 
            raise
 
1833
        if error[0] != errno.EPERM:
 
1834
            raise error
2500
1835
    
 
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
 
2501
1844
    if debug:
2502
1845
        # Enable all possible GnuTLS debugging
2503
1846
        
2513
1856
         .gnutls_global_set_log_function(debug_gnutls))
2514
1857
        
2515
1858
        # Redirect stdin so all checkers get /dev/null
2516
 
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
1859
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2517
1860
        os.dup2(null, sys.stdin.fileno())
2518
1861
        if null > 2:
2519
1862
            os.close(null)
 
1863
    else:
 
1864
        # No console logging
 
1865
        logger.removeHandler(console)
2520
1866
    
2521
1867
    # Need to fork before connecting to D-Bus
2522
 
    if not foreground:
 
1868
    if not debug:
2523
1869
        # Close all input and output, do double fork, etc.
2524
1870
        daemon()
2525
1871
    
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
 
    
2530
1872
    global main_loop
2531
1873
    # From the Avahi example code
2532
 
    DBusGMainLoop(set_as_default=True)
 
1874
    DBusGMainLoop(set_as_default=True )
2533
1875
    main_loop = gobject.MainLoop()
2534
1876
    bus = dbus.SystemBus()
2535
1877
    # End of Avahi example code
2536
1878
    if use_dbus:
2537
1879
        try:
2538
 
            bus_name = dbus.service.BusName("se.recompile.Mandos",
 
1880
            bus_name = dbus.service.BusName("se.bsnet.fukt.Mandos",
2539
1881
                                            bus, do_not_queue=True)
2540
 
            old_bus_name = (dbus.service.BusName
2541
 
                            ("se.bsnet.fukt.Mandos", bus,
2542
 
                             do_not_queue=True))
2543
1882
        except dbus.exceptions.NameExistsException as e:
2544
 
            logger.error("Disabling D-Bus:", exc_info=e)
 
1883
            logger.error(unicode(e) + ", disabling D-Bus")
2545
1884
            use_dbus = False
2546
1885
            server_settings["use_dbus"] = False
2547
1886
            tcp_server.use_dbus = False
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"])))
 
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"])))
2557
1894
    
2558
1895
    global multiprocessing_manager
2559
1896
    multiprocessing_manager = multiprocessing.Manager()
2561
1898
    client_class = Client
2562
1899
    if use_dbus:
2563
1900
        client_class = functools.partial(ClientDBus, bus = bus)
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))
 
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):
2646
1908
            try:
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
 
    
 
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()))
2672
1918
    if not tcp_server.clients:
2673
1919
        logger.warning("No clients defined")
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
 
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
2685
1933
        del pidfilename
2686
 
    
 
1934
        
 
1935
        signal.signal(signal.SIGINT, signal.SIG_IGN)
 
1936
 
2687
1937
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2688
1938
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2689
1939
    
2690
1940
    if use_dbus:
2691
 
        @alternate_dbus_interfaces({"se.recompile.Mandos":
2692
 
                                        "se.bsnet.fukt.Mandos"})
2693
 
        class MandosDBusService(DBusObjectWithProperties):
 
1941
        class MandosDBusService(dbus.service.Object):
2694
1942
            """A D-Bus proxy object"""
2695
1943
            def __init__(self):
2696
1944
                dbus.service.Object.__init__(self, bus, "/")
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"}
 
1945
            _interface = "se.bsnet.fukt.Mandos"
2704
1946
            
2705
1947
            @dbus.service.signal(_interface, signature="o")
2706
1948
            def ClientAdded(self, objpath):
2721
1963
            def GetAllClients(self):
2722
1964
                "D-Bus method"
2723
1965
                return dbus.Array(c.dbus_object_path
2724
 
                                  for c in
2725
 
                                  tcp_server.clients.itervalues())
 
1966
                                  for c in tcp_server.clients)
2726
1967
            
2727
1968
            @dbus.service.method(_interface,
2728
1969
                                 out_signature="a{oa{sv}}")
2730
1971
                "D-Bus method"
2731
1972
                return dbus.Dictionary(
2732
1973
                    ((c.dbus_object_path, c.GetAll(""))
2733
 
                     for c in tcp_server.clients.itervalues()),
 
1974
                     for c in tcp_server.clients),
2734
1975
                    signature="oa{sv}")
2735
1976
            
2736
1977
            @dbus.service.method(_interface, in_signature="o")
2737
1978
            def RemoveClient(self, object_path):
2738
1979
                "D-Bus method"
2739
 
                for c in tcp_server.clients.itervalues():
 
1980
                for c in tcp_server.clients:
2740
1981
                    if c.dbus_object_path == object_path:
2741
 
                        del tcp_server.clients[c.name]
 
1982
                        tcp_server.clients.remove(c)
2742
1983
                        c.remove_from_connection()
2743
1984
                        # Don't signal anything except ClientRemoved
2744
1985
                        c.disable(quiet=True)
2753
1994
    
2754
1995
    def cleanup():
2755
1996
        "Cleanup function; run on exit"
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
 
1997
        service.cleanup()
 
1998
        
2815
1999
        while tcp_server.clients:
2816
 
            name, client = tcp_server.clients.popitem()
 
2000
            client = tcp_server.clients.pop()
2817
2001
            if use_dbus:
2818
2002
                client.remove_from_connection()
 
2003
            client.disable_hook = None
2819
2004
            # Don't signal anything except ClientRemoved
2820
2005
            client.disable(quiet=True)
2821
2006
            if use_dbus:
2822
2007
                # Emit D-Bus signal
2823
 
                mandos_dbus_service.ClientRemoved(client
2824
 
                                                  .dbus_object_path,
 
2008
                mandos_dbus_service.ClientRemoved(client.dbus_object_path,
2825
2009
                                                  client.name)
2826
 
        client_settings.clear()
2827
2010
    
2828
2011
    atexit.register(cleanup)
2829
2012
    
2830
 
    for client in tcp_server.clients.itervalues():
 
2013
    for client in tcp_server.clients:
2831
2014
        if use_dbus:
2832
2015
            # Emit D-Bus signal
2833
2016
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
2834
 
        # Need to initiate checking of clients
2835
 
        if client.enabled:
2836
 
            client.init_checker()
 
2017
        client.enable()
2837
2018
    
2838
2019
    tcp_server.enable()
2839
2020
    tcp_server.server_activate()
2840
2021
    
2841
2022
    # Find out what port we got
2842
 
    if zeroconf:
2843
 
        service.port = tcp_server.socket.getsockname()[1]
 
2023
    service.port = tcp_server.socket.getsockname()[1]
2844
2024
    if use_ipv6:
2845
2025
        logger.info("Now listening on address %r, port %d,"
2846
 
                    " flowinfo %d, scope_id %d",
2847
 
                    *tcp_server.socket.getsockname())
 
2026
                    " flowinfo %d, scope_id %d"
 
2027
                    % tcp_server.socket.getsockname())
2848
2028
    else:                       # IPv4
2849
 
        logger.info("Now listening on address %r, port %d",
2850
 
                    *tcp_server.socket.getsockname())
 
2029
        logger.info("Now listening on address %r, port %d"
 
2030
                    % tcp_server.socket.getsockname())
2851
2031
    
2852
2032
    #service.interface = tcp_server.socket.getsockname()[3]
2853
2033
    
2854
2034
    try:
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
 
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
2864
2043
        
2865
2044
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2866
2045
                             lambda *args, **kwargs:
2870
2049
        logger.debug("Starting main loop")
2871
2050
        main_loop.run()
2872
2051
    except AvahiError as error:
2873
 
        logger.critical("Avahi Error", exc_info=error)
 
2052
        logger.critical("AvahiError: %s", error)
2874
2053
        cleanup()
2875
2054
        sys.exit(1)
2876
2055
    except KeyboardInterrupt: