/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2013-12-31 16:02:18 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 307.
  • Revision ID: teddy@recompile.se-20131231160218-plmmb0o0iifkd5l2
Specify BusName in systemd service file.

* mandos.service (BusName): Uncommented.

Show diffs side-by-side

added added

removed removed

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