/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2014-10-05 19:39:25 UTC
  • Revision ID: teddy@recompile.se-20141005193925-jjqx2n2dt3icy28u
* mandos.service ([Unit]/Documentation): New.

Show diffs side-by-side

added added

removed removed

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