/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: Björn Påhlsson
  • Date: 2011-11-09 17:16:03 UTC
  • mfrom: (518.1.1 mandos-persistent)
  • Revision ID: belorn@fukt.bsnet.se-20111109171603-srz21uoclpldp5ve
merge persistent state

Show diffs side-by-side

added added

removed removed

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