/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2014-08-06 20:56:55 UTC
  • Revision ID: teddy@recompile.se-20140806205655-lq7xkfr3b9pbwr6l
Tags: version-1.6.8-1
* Makefile (version): Changed to "1.6.8".
* NEWS (Version 1.6.8): New entry.
* debian/changelog (1.6.8-1): - '' -

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