/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2014-07-25 22:44:20 UTC
  • mto: This revision was merged to the branch mainline in revision 724.
  • Revision ID: teddy@recompile.se-20140725224420-4a5ct2ptt0hsc92z
Require Python 2.7.

This is in preparation for the eventual move to Python 3, which will
happen as soon as all Python modules required by Mandos are available.
The mandos-ctl and mandos-monitor programs are already portable
between Python 2.6 and Python 3 without changes; this change will
bring the requirement up to Python 2.7.

* INSTALL (Prerequisites/Libraries/Mandos Server): Document
                                                   requirement of
                                                   Python 2.7; remove
                                                   Python-argparse
                                                   which is in the
                                                   Python 2.7 standard
                                                   library.
* debian/control (Source: mandos/Build-Depends-Indep): Depend on
                                                       exactly the
                                                       python2.7
                                                       package and all
                                                       the Python 2.7
                                                       versions of the
                                                       python modules.
  (Package: mandos/Depends): - '' - but still depend on python (<=2.7)
                            and the generic versions of the Python
                            modules; this is for mandos-ctl and
                            mandos-monitor, both of which are
                            compatible with Python 3, and use
                            #!/usr/bin/python.
* mandos: Use #!/usr/bin/python2.7 instead of #!/usr/bin/python.

Show diffs side-by-side

added added

removed removed

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