/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2013-10-22 19:24:01 UTC
  • Revision ID: teddy@recompile.se-20131022192401-op6mwsb7f7gygjyh
* mandos (priority): Bug fix: Add even more magic to make the old
                     DSA/ELG 2048-bit keys work with GnuTLS.
* mandos-keygen (KEYCOMMENT): Changed default to "".
* mandos-keygen (OPTIONS): Document new default value of "--comment".
* mandos-options.xml (priority): Document new default value.
* mandos.conf (priority): - '' -

Show diffs side-by-side

added added

removed removed

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