/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

working new feature: network-hooks - Enables user-scripts to take up
                     interfaces during bootup

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,2009 Teddy Hogeborn
15
 
# Copyright © 2008,2009 Björn Påhlsson
 
14
# Copyright © 2008-2011 Teddy Hogeborn
 
15
# Copyright © 2008-2011 Björn Påhlsson
16
16
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
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
 
from __future__ import division, with_statement, absolute_import
 
34
from __future__ import (division, absolute_import, print_function,
 
35
                        unicode_literals)
35
36
 
36
37
import SocketServer as socketserver
37
38
import socket
38
 
import optparse
 
39
import argparse
39
40
import datetime
40
41
import errno
41
42
import gnutls.crypto
55
56
import logging
56
57
import logging.handlers
57
58
import pwd
58
 
from contextlib import closing
 
59
import contextlib
59
60
import struct
60
61
import fcntl
61
62
import functools
 
63
import cPickle as pickle
 
64
import multiprocessing
 
65
import types
 
66
import binascii
 
67
import tempfile
62
68
 
63
69
import dbus
64
70
import dbus.service
67
73
from dbus.mainloop.glib import DBusGMainLoop
68
74
import ctypes
69
75
import ctypes.util
 
76
import xml.dom.minidom
 
77
import inspect
 
78
import GnuPGInterface
70
79
 
71
80
try:
72
81
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
76
85
    except ImportError:
77
86
        SO_BINDTODEVICE = None
78
87
 
79
 
 
80
 
version = "1.0.11"
81
 
 
82
 
logger = logging.Logger(u'mandos')
 
88
version = "1.4.1"
 
89
stored_state_file = "clients.pickle"
 
90
 
 
91
logger = logging.getLogger()
83
92
syslogger = (logging.handlers.SysLogHandler
84
93
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
85
 
              address = "/dev/log"))
86
 
syslogger.setFormatter(logging.Formatter
87
 
                       (u'Mandos [%(process)d]: %(levelname)s:'
88
 
                        u' %(message)s'))
89
 
logger.addHandler(syslogger)
90
 
 
91
 
console = logging.StreamHandler()
92
 
console.setFormatter(logging.Formatter(u'%(name)s [%(process)d]:'
93
 
                                       u' %(levelname)s:'
94
 
                                       u' %(message)s'))
95
 
logger.addHandler(console)
 
94
              address = str("/dev/log")))
 
95
 
 
96
try:
 
97
    if_nametoindex = (ctypes.cdll.LoadLibrary
 
98
                      (ctypes.util.find_library("c"))
 
99
                      .if_nametoindex)
 
100
except (OSError, AttributeError):
 
101
    def if_nametoindex(interface):
 
102
        "Get an interface index the hard way, i.e. using fcntl()"
 
103
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
 
104
        with contextlib.closing(socket.socket()) as s:
 
105
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
 
106
                                struct.pack(str("16s16x"),
 
107
                                            interface))
 
108
        interface_index = struct.unpack(str("I"),
 
109
                                        ifreq[16:20])[0]
 
110
        return interface_index
 
111
 
 
112
 
 
113
def initlogger(level=logging.WARNING):
 
114
    """init logger and add loglevel"""
 
115
    
 
116
    syslogger.setFormatter(logging.Formatter
 
117
                           ('Mandos [%(process)d]: %(levelname)s:'
 
118
                            ' %(message)s'))
 
119
    logger.addHandler(syslogger)
 
120
    
 
121
    console = logging.StreamHandler()
 
122
    console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
 
123
                                           ' [%(process)d]:'
 
124
                                           ' %(levelname)s:'
 
125
                                           ' %(message)s'))
 
126
    logger.addHandler(console)
 
127
    logger.setLevel(level)
 
128
 
 
129
 
 
130
class PGPError(Exception):
 
131
    """Exception if encryption/decryption fails"""
 
132
    pass
 
133
 
 
134
 
 
135
class PGPEngine(object):
 
136
    """A simple class for OpenPGP symmetric encryption & decryption"""
 
137
    def __init__(self):
 
138
        self.gnupg = GnuPGInterface.GnuPG()
 
139
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
 
140
        self.gnupg = GnuPGInterface.GnuPG()
 
141
        self.gnupg.options.meta_interactive = False
 
142
        self.gnupg.options.homedir = self.tempdir
 
143
        self.gnupg.options.extra_args.extend(['--force-mdc',
 
144
                                              '--quiet'])
 
145
    
 
146
    def __enter__(self):
 
147
        return self
 
148
    
 
149
    def __exit__ (self, exc_type, exc_value, traceback):
 
150
        self._cleanup()
 
151
        return False
 
152
    
 
153
    def __del__(self):
 
154
        self._cleanup()
 
155
    
 
156
    def _cleanup(self):
 
157
        if self.tempdir is not None:
 
158
            # Delete contents of tempdir
 
159
            for root, dirs, files in os.walk(self.tempdir,
 
160
                                             topdown = False):
 
161
                for filename in files:
 
162
                    os.remove(os.path.join(root, filename))
 
163
                for dirname in dirs:
 
164
                    os.rmdir(os.path.join(root, dirname))
 
165
            # Remove tempdir
 
166
            os.rmdir(self.tempdir)
 
167
            self.tempdir = None
 
168
    
 
169
    def password_encode(self, password):
 
170
        # Passphrase can not be empty and can not contain newlines or
 
171
        # NUL bytes.  So we prefix it and hex encode it.
 
172
        return b"mandos" + binascii.hexlify(password)
 
173
    
 
174
    def encrypt(self, data, password):
 
175
        self.gnupg.passphrase = self.password_encode(password)
 
176
        with open(os.devnull) as devnull:
 
177
            try:
 
178
                proc = self.gnupg.run(['--symmetric'],
 
179
                                      create_fhs=['stdin', 'stdout'],
 
180
                                      attach_fhs={'stderr': devnull})
 
181
                with contextlib.closing(proc.handles['stdin']) as f:
 
182
                    f.write(data)
 
183
                with contextlib.closing(proc.handles['stdout']) as f:
 
184
                    ciphertext = f.read()
 
185
                proc.wait()
 
186
            except IOError as e:
 
187
                raise PGPError(e)
 
188
        self.gnupg.passphrase = None
 
189
        return ciphertext
 
190
    
 
191
    def decrypt(self, data, password):
 
192
        self.gnupg.passphrase = self.password_encode(password)
 
193
        with open(os.devnull) as devnull:
 
194
            try:
 
195
                proc = self.gnupg.run(['--decrypt'],
 
196
                                      create_fhs=['stdin', 'stdout'],
 
197
                                      attach_fhs={'stderr': devnull})
 
198
                with contextlib.closing(proc.handles['stdin'] ) as f:
 
199
                    f.write(data)
 
200
                with contextlib.closing(proc.handles['stdout']) as f:
 
201
                    decrypted_plaintext = f.read()
 
202
                proc.wait()
 
203
            except IOError as e:
 
204
                raise PGPError(e)
 
205
        self.gnupg.passphrase = None
 
206
        return decrypted_plaintext
 
207
 
 
208
 
96
209
 
97
210
class AvahiError(Exception):
98
211
    def __init__(self, value, *args, **kwargs):
114
227
    Attributes:
115
228
    interface: integer; avahi.IF_UNSPEC or an interface index.
116
229
               Used to optionally bind to the specified interface.
117
 
    name: string; Example: u'Mandos'
118
 
    type: string; Example: u'_mandos._tcp'.
 
230
    name: string; Example: 'Mandos'
 
231
    type: string; Example: '_mandos._tcp'.
119
232
                  See <http://www.dns-sd.org/ServiceTypes.html>
120
233
    port: integer; what port to announce
121
234
    TXT: list of strings; TXT record for the service
130
243
    """
131
244
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
132
245
                 servicetype = None, port = None, TXT = None,
133
 
                 domain = u"", host = u"", max_renames = 32768,
 
246
                 domain = "", host = "", max_renames = 32768,
134
247
                 protocol = avahi.PROTO_UNSPEC, bus = None):
135
248
        self.interface = interface
136
249
        self.name = name
145
258
        self.group = None       # our entry group
146
259
        self.server = None
147
260
        self.bus = bus
 
261
        self.entry_group_state_changed_match = None
148
262
    def rename(self):
149
263
        """Derived from the Avahi example code"""
150
264
        if self.rename_count >= self.max_renames:
151
 
            logger.critical(u"No suitable Zeroconf service name found"
152
 
                            u" after %i retries, exiting.",
 
265
            logger.critical("No suitable Zeroconf service name found"
 
266
                            " after %i retries, exiting.",
153
267
                            self.rename_count)
154
 
            raise AvahiServiceError(u"Too many renames")
155
 
        self.name = self.server.GetAlternativeServiceName(self.name)
156
 
        logger.info(u"Changing Zeroconf service name to %r ...",
157
 
                    unicode(self.name))
158
 
        syslogger.setFormatter(logging.Formatter
159
 
                               (u'Mandos (%s) [%%(process)d]:'
160
 
                                u' %%(levelname)s: %%(message)s'
161
 
                                % self.name))
 
268
            raise AvahiServiceError("Too many renames")
 
269
        self.name = unicode(self.server
 
270
                            .GetAlternativeServiceName(self.name))
 
271
        logger.info("Changing Zeroconf service name to %r ...",
 
272
                    self.name)
162
273
        self.remove()
163
 
        self.add()
 
274
        try:
 
275
            self.add()
 
276
        except dbus.exceptions.DBusException as error:
 
277
            logger.critical("DBusException: %s", error)
 
278
            self.cleanup()
 
279
            os._exit(1)
164
280
        self.rename_count += 1
165
281
    def remove(self):
166
282
        """Derived from the Avahi example code"""
 
283
        if self.entry_group_state_changed_match is not None:
 
284
            self.entry_group_state_changed_match.remove()
 
285
            self.entry_group_state_changed_match = None
167
286
        if self.group is not None:
168
287
            self.group.Reset()
169
288
    def add(self):
170
289
        """Derived from the Avahi example code"""
 
290
        self.remove()
171
291
        if self.group is None:
172
292
            self.group = dbus.Interface(
173
293
                self.bus.get_object(avahi.DBUS_NAME,
174
294
                                    self.server.EntryGroupNew()),
175
295
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
176
 
            self.group.connect_to_signal('StateChanged',
177
 
                                         self.entry_group_state_changed)
178
 
        logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
 
296
        self.entry_group_state_changed_match = (
 
297
            self.group.connect_to_signal(
 
298
                'StateChanged', self.entry_group_state_changed))
 
299
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
179
300
                     self.name, self.type)
180
301
        self.group.AddService(
181
302
            self.interface,
188
309
        self.group.Commit()
189
310
    def entry_group_state_changed(self, state, error):
190
311
        """Derived from the Avahi example code"""
191
 
        logger.debug(u"Avahi state change: %i", state)
 
312
        logger.debug("Avahi entry group state change: %i", state)
192
313
        
193
314
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
194
 
            logger.debug(u"Zeroconf service established.")
 
315
            logger.debug("Zeroconf service established.")
195
316
        elif state == avahi.ENTRY_GROUP_COLLISION:
196
 
            logger.warning(u"Zeroconf service name collision.")
 
317
            logger.info("Zeroconf service name collision.")
197
318
            self.rename()
198
319
        elif state == avahi.ENTRY_GROUP_FAILURE:
199
 
            logger.critical(u"Avahi: Error in group state changed %s",
 
320
            logger.critical("Avahi: Error in group state changed %s",
200
321
                            unicode(error))
201
 
            raise AvahiGroupError(u"State changed: %s"
 
322
            raise AvahiGroupError("State changed: %s"
202
323
                                  % unicode(error))
203
324
    def cleanup(self):
204
325
        """Derived from the Avahi example code"""
205
326
        if self.group is not None:
206
 
            self.group.Free()
 
327
            try:
 
328
                self.group.Free()
 
329
            except (dbus.exceptions.UnknownMethodException,
 
330
                    dbus.exceptions.DBusException):
 
331
                pass
207
332
            self.group = None
208
 
    def server_state_changed(self, state):
 
333
        self.remove()
 
334
    def server_state_changed(self, state, error=None):
209
335
        """Derived from the Avahi example code"""
210
 
        if state == avahi.SERVER_COLLISION:
211
 
            logger.error(u"Zeroconf server name collision")
212
 
            self.remove()
 
336
        logger.debug("Avahi server state change: %i", state)
 
337
        bad_states = { avahi.SERVER_INVALID:
 
338
                           "Zeroconf server invalid",
 
339
                       avahi.SERVER_REGISTERING: None,
 
340
                       avahi.SERVER_COLLISION:
 
341
                           "Zeroconf server name collision",
 
342
                       avahi.SERVER_FAILURE:
 
343
                           "Zeroconf server failure" }
 
344
        if state in bad_states:
 
345
            if bad_states[state] is not None:
 
346
                if error is None:
 
347
                    logger.error(bad_states[state])
 
348
                else:
 
349
                    logger.error(bad_states[state] + ": %r", error)
 
350
            self.cleanup()
213
351
        elif state == avahi.SERVER_RUNNING:
214
352
            self.add()
 
353
        else:
 
354
            if error is None:
 
355
                logger.debug("Unknown state: %r", state)
 
356
            else:
 
357
                logger.debug("Unknown state: %r: %r", state, error)
215
358
    def activate(self):
216
359
        """Derived from the Avahi example code"""
217
360
        if self.server is None:
218
361
            self.server = dbus.Interface(
219
362
                self.bus.get_object(avahi.DBUS_NAME,
220
 
                                    avahi.DBUS_PATH_SERVER),
 
363
                                    avahi.DBUS_PATH_SERVER,
 
364
                                    follow_name_owner_changes=True),
221
365
                avahi.DBUS_INTERFACE_SERVER)
222
 
        self.server.connect_to_signal(u"StateChanged",
 
366
        self.server.connect_to_signal("StateChanged",
223
367
                                 self.server_state_changed)
224
368
        self.server_state_changed(self.server.GetState())
225
369
 
 
370
class AvahiServiceToSyslog(AvahiService):
 
371
    def rename(self):
 
372
        """Add the new name to the syslog messages"""
 
373
        ret = AvahiService.rename(self)
 
374
        syslogger.setFormatter(logging.Formatter
 
375
                               ('Mandos (%s) [%%(process)d]:'
 
376
                                ' %%(levelname)s: %%(message)s'
 
377
                                % self.name))
 
378
        return ret
226
379
 
 
380
def timedelta_to_milliseconds(td):
 
381
    "Convert a datetime.timedelta() to milliseconds"
 
382
    return ((td.days * 24 * 60 * 60 * 1000)
 
383
            + (td.seconds * 1000)
 
384
            + (td.microseconds // 1000))
 
385
        
227
386
class Client(object):
228
387
    """A representation of a client host served by this server.
229
388
    
230
389
    Attributes:
231
 
    name:       string; from the config file, used in log messages and
232
 
                        D-Bus identifiers
233
 
    fingerprint: string (40 or 32 hexadecimal digits); used to
234
 
                 uniquely identify the client
235
 
    secret:     bytestring; sent verbatim (over TLS) to client
236
 
    host:       string; available for use by the checker command
237
 
    created:    datetime.datetime(); (UTC) object creation
238
 
    last_enabled: datetime.datetime(); (UTC)
239
 
    enabled:    bool()
240
 
    last_checked_ok: datetime.datetime(); (UTC) or None
241
 
    timeout:    datetime.timedelta(); How long from last_checked_ok
242
 
                                      until this client is invalid
243
 
    interval:   datetime.timedelta(); How often to start a new checker
244
 
    disable_hook:  If set, called by disable() as disable_hook(self)
 
390
    approved:   bool(); 'None' if not yet approved/disapproved
 
391
    approval_delay: datetime.timedelta(); Time to wait for approval
 
392
    approval_duration: datetime.timedelta(); Duration of one approval
245
393
    checker:    subprocess.Popen(); a running checker process used
246
394
                                    to see if the client lives.
247
395
                                    'None' if no process is running.
248
 
    checker_initiator_tag: a gobject event source tag, or None
249
 
    disable_initiator_tag:    - '' -
250
 
    checker_callback_tag:  - '' -
251
 
    checker_command: string; External command which is run to check if
252
 
                     client lives.  %() expansions are done at
 
396
    checker_callback_tag: a gobject event source tag, or None
 
397
    checker_command: string; External command which is run to check
 
398
                     if client lives.  %() expansions are done at
253
399
                     runtime with vars(self) as dict, so that for
254
400
                     instance %(name)s can be used in the command.
 
401
    checker_initiator_tag: a gobject event source tag, or None
 
402
    created:    datetime.datetime(); (UTC) object creation
 
403
    client_structure: Object describing what attributes a client has
 
404
                      and is used for storing the client at exit
255
405
    current_checker_command: string; current running checker_command
 
406
    disable_initiator_tag: a gobject event source tag, or None
 
407
    enabled:    bool()
 
408
    fingerprint: string (40 or 32 hexadecimal digits); used to
 
409
                 uniquely identify the client
 
410
    host:       string; available for use by the checker command
 
411
    interval:   datetime.timedelta(); How often to start a new checker
 
412
    last_approval_request: datetime.datetime(); (UTC) or None
 
413
    last_checked_ok: datetime.datetime(); (UTC) or None
 
414
    last_checker_status: integer between 0 and 255 reflecting exit
 
415
                         status of last checker. -1 reflects crashed
 
416
                         checker, or None.
 
417
    last_enabled: datetime.datetime(); (UTC) or None
 
418
    name:       string; from the config file, used in log messages and
 
419
                        D-Bus identifiers
 
420
    secret:     bytestring; sent verbatim (over TLS) to client
 
421
    timeout:    datetime.timedelta(); How long from last_checked_ok
 
422
                                      until this client is disabled
 
423
    extended_timeout:   extra long timeout when password has been sent
 
424
    runtime_expansions: Allowed attributes for runtime expansion.
 
425
    expires:    datetime.datetime(); time (UTC) when a client will be
 
426
                disabled, or None
256
427
    """
257
428
    
258
 
    @staticmethod
259
 
    def _datetime_to_milliseconds(dt):
260
 
        "Convert a datetime.datetime() to milliseconds"
261
 
        return ((dt.days * 24 * 60 * 60 * 1000)
262
 
                + (dt.seconds * 1000)
263
 
                + (dt.microseconds // 1000))
 
429
    runtime_expansions = ("approval_delay", "approval_duration",
 
430
                          "created", "enabled", "fingerprint",
 
431
                          "host", "interval", "last_checked_ok",
 
432
                          "last_enabled", "name", "timeout")
 
433
    client_defaults = { "timeout": "5m",
 
434
                        "extended_timeout": "15m",
 
435
                        "interval": "2m",
 
436
                        "checker": "fping -q -- %%(host)s",
 
437
                        "host": "",
 
438
                        "approval_delay": "0s",
 
439
                        "approval_duration": "1s",
 
440
                        "approved_by_default": "True",
 
441
                        "enabled": "True",
 
442
                        }
264
443
    
265
444
    def timeout_milliseconds(self):
266
445
        "Return the 'timeout' attribute in milliseconds"
267
 
        return self._datetime_to_milliseconds(self.timeout)
 
446
        return timedelta_to_milliseconds(self.timeout)
 
447
    
 
448
    def extended_timeout_milliseconds(self):
 
449
        "Return the 'extended_timeout' attribute in milliseconds"
 
450
        return timedelta_to_milliseconds(self.extended_timeout)
268
451
    
269
452
    def interval_milliseconds(self):
270
453
        "Return the 'interval' attribute in milliseconds"
271
 
        return self._datetime_to_milliseconds(self.interval)
 
454
        return timedelta_to_milliseconds(self.interval)
272
455
    
273
 
    def __init__(self, name = None, disable_hook=None, config=None):
 
456
    def approval_delay_milliseconds(self):
 
457
        return timedelta_to_milliseconds(self.approval_delay)
 
458
 
 
459
    @staticmethod
 
460
    def config_parser(config):
 
461
        """ Construct a new dict of client settings of this form:
 
462
        { client_name: {setting_name: value, ...}, ...}
 
463
        with exceptions for any special settings as defined above"""
 
464
        settings = {}
 
465
        for client_name in config.sections():
 
466
            section = dict(config.items(client_name))
 
467
            client = settings[client_name] = {}
 
468
            
 
469
            client["host"] = section["host"]
 
470
            # Reformat values from string types to Python types
 
471
            client["approved_by_default"] = config.getboolean(
 
472
                client_name, "approved_by_default")
 
473
            client["enabled"] = config.getboolean(client_name, "enabled")
 
474
            
 
475
            client["fingerprint"] = (section["fingerprint"].upper()
 
476
                                     .replace(" ", ""))
 
477
            if "secret" in section:
 
478
                client["secret"] = section["secret"].decode("base64")
 
479
            elif "secfile" in section:
 
480
                with open(os.path.expanduser(os.path.expandvars
 
481
                                             (section["secfile"])),
 
482
                          "rb") as secfile:
 
483
                    client["secret"] = secfile.read()
 
484
            else:
 
485
                raise TypeError("No secret or secfile for section %s"
 
486
                                % section)
 
487
            client["timeout"] = string_to_delta(section["timeout"])
 
488
            client["extended_timeout"] = string_to_delta(
 
489
                section["extended_timeout"])
 
490
            client["interval"] = string_to_delta(section["interval"])
 
491
            client["approval_delay"] = string_to_delta(
 
492
                section["approval_delay"])
 
493
            client["approval_duration"] = string_to_delta(
 
494
                section["approval_duration"])
 
495
            client["checker_command"] = section["checker"]
 
496
            client["last_approval_request"] = None
 
497
            client["last_checked_ok"] = None
 
498
            client["last_checker_status"] = None
 
499
            if client["enabled"]:
 
500
                client["last_enabled"] = datetime.datetime.utcnow()
 
501
                client["expires"] = (datetime.datetime.utcnow()
 
502
                                     + client["timeout"])
 
503
            else:
 
504
                client["last_enabled"] = None
 
505
                client["expires"] = None
 
506
 
 
507
        return settings
 
508
        
 
509
        
 
510
    def __init__(self, settings, name = None):
274
511
        """Note: the 'checker' key in 'config' sets the
275
512
        'checker_command' attribute and *not* the 'checker'
276
513
        attribute."""
277
514
        self.name = name
278
 
        if config is None:
279
 
            config = {}
280
 
        logger.debug(u"Creating client %r", self.name)
 
515
        # adding all client settings
 
516
        for setting, value in settings.iteritems():
 
517
            setattr(self, setting, value)
 
518
        
 
519
        logger.debug("Creating client %r", self.name)
281
520
        # Uppercase and remove spaces from fingerprint for later
282
521
        # comparison purposes with return value from the fingerprint()
283
522
        # function
284
 
        self.fingerprint = (config[u"fingerprint"].upper()
285
 
                            .replace(u" ", u""))
286
 
        logger.debug(u"  Fingerprint: %s", self.fingerprint)
287
 
        if u"secret" in config:
288
 
            self.secret = config[u"secret"].decode(u"base64")
289
 
        elif u"secfile" in config:
290
 
            with closing(open(os.path.expanduser
291
 
                              (os.path.expandvars
292
 
                               (config[u"secfile"])))) as secfile:
293
 
                self.secret = secfile.read()
294
 
        else:
295
 
            raise TypeError(u"No secret or secfile for client %s"
296
 
                            % self.name)
297
 
        self.host = config.get(u"host", u"")
298
 
        self.created = datetime.datetime.utcnow()
299
 
        self.enabled = False
300
 
        self.last_enabled = None
301
 
        self.last_checked_ok = None
302
 
        self.timeout = string_to_delta(config[u"timeout"])
303
 
        self.interval = string_to_delta(config[u"interval"])
304
 
        self.disable_hook = disable_hook
 
523
        logger.debug("  Fingerprint: %s", self.fingerprint)
 
524
        self.created = settings.get("created", datetime.datetime.utcnow())
 
525
 
 
526
        # attributes specific for this server instance
305
527
        self.checker = None
306
528
        self.checker_initiator_tag = None
307
529
        self.disable_initiator_tag = None
308
530
        self.checker_callback_tag = None
309
 
        self.checker_command = config[u"checker"]
310
531
        self.current_checker_command = None
311
 
        self.last_connect = None
 
532
        self.approved = None
 
533
        self.approvals_pending = 0
 
534
        self.changedstate = (multiprocessing_manager
 
535
                             .Condition(multiprocessing_manager
 
536
                                        .Lock()))
 
537
        self.client_structure = [attr for attr in
 
538
                                 self.__dict__.iterkeys()
 
539
                                 if not attr.startswith("_")]
 
540
        self.client_structure.append("client_structure")
 
541
        
 
542
        for name, t in inspect.getmembers(type(self),
 
543
                                          lambda obj:
 
544
                                              isinstance(obj,
 
545
                                                         property)):
 
546
            if not name.startswith("_"):
 
547
                self.client_structure.append(name)
 
548
    
 
549
    # Send notice to process children that client state has changed
 
550
    def send_changedstate(self):
 
551
        with self.changedstate:
 
552
            self.changedstate.notify_all()
312
553
    
313
554
    def enable(self):
314
555
        """Start this client's checker and timeout hooks"""
315
 
        if getattr(self, u"enabled", False):
 
556
        if getattr(self, "enabled", False):
316
557
            # Already enabled
317
558
            return
 
559
        self.send_changedstate()
 
560
        self.expires = datetime.datetime.utcnow() + self.timeout
 
561
        self.enabled = True
318
562
        self.last_enabled = datetime.datetime.utcnow()
 
563
        self.init_checker()
 
564
    
 
565
    def disable(self, quiet=True):
 
566
        """Disable this client."""
 
567
        if not getattr(self, "enabled", False):
 
568
            return False
 
569
        if not quiet:
 
570
            self.send_changedstate()
 
571
        if not quiet:
 
572
            logger.info("Disabling client %s", self.name)
 
573
        if getattr(self, "disable_initiator_tag", False):
 
574
            gobject.source_remove(self.disable_initiator_tag)
 
575
            self.disable_initiator_tag = None
 
576
        self.expires = None
 
577
        if getattr(self, "checker_initiator_tag", False):
 
578
            gobject.source_remove(self.checker_initiator_tag)
 
579
            self.checker_initiator_tag = None
 
580
        self.stop_checker()
 
581
        self.enabled = False
 
582
        # Do not run this again if called by a gobject.timeout_add
 
583
        return False
 
584
    
 
585
    def __del__(self):
 
586
        self.disable()
 
587
    
 
588
    def init_checker(self):
319
589
        # Schedule a new checker to be started an 'interval' from now,
320
590
        # and every interval from then on.
321
591
        self.checker_initiator_tag = (gobject.timeout_add
322
592
                                      (self.interval_milliseconds(),
323
593
                                       self.start_checker))
324
 
        # Also start a new checker *right now*.
325
 
        self.start_checker()
326
594
        # Schedule a disable() when 'timeout' has passed
327
595
        self.disable_initiator_tag = (gobject.timeout_add
328
596
                                   (self.timeout_milliseconds(),
329
597
                                    self.disable))
330
 
        self.enabled = True
331
 
    
332
 
    def disable(self):
333
 
        """Disable this client."""
334
 
        if not getattr(self, "enabled", False):
335
 
            return False
336
 
        logger.info(u"Disabling client %s", self.name)
337
 
        if getattr(self, u"disable_initiator_tag", False):
338
 
            gobject.source_remove(self.disable_initiator_tag)
339
 
            self.disable_initiator_tag = None
340
 
        if getattr(self, u"checker_initiator_tag", False):
341
 
            gobject.source_remove(self.checker_initiator_tag)
342
 
            self.checker_initiator_tag = None
343
 
        self.stop_checker()
344
 
        if self.disable_hook:
345
 
            self.disable_hook(self)
346
 
        self.enabled = False
347
 
        # Do not run this again if called by a gobject.timeout_add
348
 
        return False
349
 
    
350
 
    def __del__(self):
351
 
        self.disable_hook = None
352
 
        self.disable()
 
598
        # Also start a new checker *right now*.
 
599
        self.start_checker()
353
600
    
354
601
    def checker_callback(self, pid, condition, command):
355
602
        """The checker has completed, so take appropriate actions."""
356
603
        self.checker_callback_tag = None
357
604
        self.checker = None
358
605
        if os.WIFEXITED(condition):
359
 
            exitstatus = os.WEXITSTATUS(condition)
360
 
            if exitstatus == 0:
361
 
                logger.info(u"Checker for %(name)s succeeded",
 
606
            self.last_checker_status = os.WEXITSTATUS(condition)
 
607
            if self.last_checker_status == 0:
 
608
                logger.info("Checker for %(name)s succeeded",
362
609
                            vars(self))
363
610
                self.checked_ok()
364
611
            else:
365
 
                logger.info(u"Checker for %(name)s failed",
 
612
                logger.info("Checker for %(name)s failed",
366
613
                            vars(self))
367
614
        else:
368
 
            logger.warning(u"Checker for %(name)s crashed?",
 
615
            self.last_checker_status = -1
 
616
            logger.warning("Checker for %(name)s crashed?",
369
617
                           vars(self))
370
618
    
371
 
    def checked_ok(self):
 
619
    def checked_ok(self, timeout=None):
372
620
        """Bump up the timeout for this client.
373
621
        
374
622
        This should only be called when the client has been seen,
375
623
        alive and well.
376
624
        """
 
625
        if timeout is None:
 
626
            timeout = self.timeout
377
627
        self.last_checked_ok = datetime.datetime.utcnow()
378
 
        gobject.source_remove(self.disable_initiator_tag)
379
 
        self.disable_initiator_tag = (gobject.timeout_add
380
 
                                      (self.timeout_milliseconds(),
381
 
                                       self.disable))
 
628
        if self.disable_initiator_tag is not None:
 
629
            gobject.source_remove(self.disable_initiator_tag)
 
630
        if getattr(self, "enabled", False):
 
631
            self.disable_initiator_tag = (gobject.timeout_add
 
632
                                          (timedelta_to_milliseconds
 
633
                                           (timeout), self.disable))
 
634
            self.expires = datetime.datetime.utcnow() + timeout
 
635
    
 
636
    def need_approval(self):
 
637
        self.last_approval_request = datetime.datetime.utcnow()
382
638
    
383
639
    def start_checker(self):
384
640
        """Start a new checker subprocess if one is not running.
391
647
        # client would inevitably timeout, since no checker would get
392
648
        # a chance to run to completion.  If we instead leave running
393
649
        # checkers alone, the checker would have to take more time
394
 
        # than 'timeout' for the client to be declared invalid, which
395
 
        # is as it should be.
 
650
        # than 'timeout' for the client to be disabled, which is as it
 
651
        # should be.
396
652
        
397
653
        # If a checker exists, make sure it is not a zombie
398
 
        if self.checker is not None:
 
654
        try:
399
655
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
656
        except (AttributeError, OSError) as error:
 
657
            if (isinstance(error, OSError)
 
658
                and error.errno != errno.ECHILD):
 
659
                raise error
 
660
        else:
400
661
            if pid:
401
 
                logger.warning(u"Checker was a zombie")
 
662
                logger.warning("Checker was a zombie")
402
663
                gobject.source_remove(self.checker_callback_tag)
403
664
                self.checker_callback(pid, status,
404
665
                                      self.current_checker_command)
409
670
                command = self.checker_command % self.host
410
671
            except TypeError:
411
672
                # Escape attributes for the shell
412
 
                escaped_attrs = dict((key,
413
 
                                      re.escape(unicode(str(val),
414
 
                                                        errors=
415
 
                                                        u'replace')))
416
 
                                     for key, val in
417
 
                                     vars(self).iteritems())
 
673
                escaped_attrs = dict(
 
674
                    (attr,
 
675
                     re.escape(unicode(str(getattr(self, attr, "")),
 
676
                                       errors=
 
677
                                       'replace')))
 
678
                    for attr in
 
679
                    self.runtime_expansions)
 
680
                
418
681
                try:
419
682
                    command = self.checker_command % escaped_attrs
420
 
                except TypeError, error:
421
 
                    logger.error(u'Could not format string "%s":'
422
 
                                 u' %s', self.checker_command, error)
 
683
                except TypeError as error:
 
684
                    logger.error('Could not format string "%s":'
 
685
                                 ' %s', self.checker_command, error)
423
686
                    return True # Try again later
424
687
            self.current_checker_command = command
425
688
            try:
426
 
                logger.info(u"Starting checker %r for %s",
 
689
                logger.info("Starting checker %r for %s",
427
690
                            command, self.name)
428
691
                # We don't need to redirect stdout and stderr, since
429
692
                # in normal mode, that is already done by daemon(),
431
694
                # always replaced by /dev/null.)
432
695
                self.checker = subprocess.Popen(command,
433
696
                                                close_fds=True,
434
 
                                                shell=True, cwd=u"/")
 
697
                                                shell=True, cwd="/")
435
698
                self.checker_callback_tag = (gobject.child_watch_add
436
699
                                             (self.checker.pid,
437
700
                                              self.checker_callback,
442
705
                if pid:
443
706
                    gobject.source_remove(self.checker_callback_tag)
444
707
                    self.checker_callback(pid, status, command)
445
 
            except OSError, error:
446
 
                logger.error(u"Failed to start subprocess: %s",
 
708
            except OSError as error:
 
709
                logger.error("Failed to start subprocess: %s",
447
710
                             error)
448
711
        # Re-run this periodically if run by gobject.timeout_add
449
712
        return True
453
716
        if self.checker_callback_tag:
454
717
            gobject.source_remove(self.checker_callback_tag)
455
718
            self.checker_callback_tag = None
456
 
        if getattr(self, u"checker", None) is None:
 
719
        if getattr(self, "checker", None) is None:
457
720
            return
458
 
        logger.debug(u"Stopping checker for %(name)s", vars(self))
 
721
        logger.debug("Stopping checker for %(name)s", vars(self))
459
722
        try:
460
723
            os.kill(self.checker.pid, signal.SIGTERM)
461
 
            #os.sleep(0.5)
 
724
            #time.sleep(0.5)
462
725
            #if self.checker.poll() is None:
463
726
            #    os.kill(self.checker.pid, signal.SIGKILL)
464
 
        except OSError, error:
 
727
        except OSError as error:
465
728
            if error.errno != errno.ESRCH: # No such process
466
729
                raise
467
730
        self.checker = None
468
 
    
469
 
    def still_valid(self):
470
 
        """Has the timeout not yet passed for this client?"""
471
 
        if not getattr(self, u"enabled", False):
472
 
            return False
473
 
        now = datetime.datetime.utcnow()
474
 
        if self.last_checked_ok is None:
475
 
            return now < (self.created + self.timeout)
476
 
        else:
477
 
            return now < (self.last_checked_ok + self.timeout)
478
 
 
479
 
 
480
 
class ClientDBus(Client, dbus.service.Object):
 
731
 
 
732
 
 
733
def dbus_service_property(dbus_interface, signature="v",
 
734
                          access="readwrite", byte_arrays=False):
 
735
    """Decorators for marking methods of a DBusObjectWithProperties to
 
736
    become properties on the D-Bus.
 
737
    
 
738
    The decorated method will be called with no arguments by "Get"
 
739
    and with one argument by "Set".
 
740
    
 
741
    The parameters, where they are supported, are the same as
 
742
    dbus.service.method, except there is only "signature", since the
 
743
    type from Get() and the type sent to Set() is the same.
 
744
    """
 
745
    # Encoding deeply encoded byte arrays is not supported yet by the
 
746
    # "Set" method, so we fail early here:
 
747
    if byte_arrays and signature != "ay":
 
748
        raise ValueError("Byte arrays not supported for non-'ay'"
 
749
                         " signature %r" % signature)
 
750
    def decorator(func):
 
751
        func._dbus_is_property = True
 
752
        func._dbus_interface = dbus_interface
 
753
        func._dbus_signature = signature
 
754
        func._dbus_access = access
 
755
        func._dbus_name = func.__name__
 
756
        if func._dbus_name.endswith("_dbus_property"):
 
757
            func._dbus_name = func._dbus_name[:-14]
 
758
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
 
759
        return func
 
760
    return decorator
 
761
 
 
762
 
 
763
class DBusPropertyException(dbus.exceptions.DBusException):
 
764
    """A base class for D-Bus property-related exceptions
 
765
    """
 
766
    def __unicode__(self):
 
767
        return unicode(str(self))
 
768
 
 
769
 
 
770
class DBusPropertyAccessException(DBusPropertyException):
 
771
    """A property's access permissions disallows an operation.
 
772
    """
 
773
    pass
 
774
 
 
775
 
 
776
class DBusPropertyNotFound(DBusPropertyException):
 
777
    """An attempt was made to access a non-existing property.
 
778
    """
 
779
    pass
 
780
 
 
781
 
 
782
class DBusObjectWithProperties(dbus.service.Object):
 
783
    """A D-Bus object with properties.
 
784
    
 
785
    Classes inheriting from this can use the dbus_service_property
 
786
    decorator to expose methods as D-Bus properties.  It exposes the
 
787
    standard Get(), Set(), and GetAll() methods on the D-Bus.
 
788
    """
 
789
    
 
790
    @staticmethod
 
791
    def _is_dbus_property(obj):
 
792
        return getattr(obj, "_dbus_is_property", False)
 
793
    
 
794
    def _get_all_dbus_properties(self):
 
795
        """Returns a generator of (name, attribute) pairs
 
796
        """
 
797
        return ((prop.__get__(self)._dbus_name, prop.__get__(self))
 
798
                for cls in self.__class__.__mro__
 
799
                for name, prop in
 
800
                inspect.getmembers(cls, self._is_dbus_property))
 
801
    
 
802
    def _get_dbus_property(self, interface_name, property_name):
 
803
        """Returns a bound method if one exists which is a D-Bus
 
804
        property with the specified name and interface.
 
805
        """
 
806
        for cls in  self.__class__.__mro__:
 
807
            for name, value in (inspect.getmembers
 
808
                                (cls, self._is_dbus_property)):
 
809
                if (value._dbus_name == property_name
 
810
                    and value._dbus_interface == interface_name):
 
811
                    return value.__get__(self)
 
812
        
 
813
        # No such property
 
814
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
 
815
                                   + interface_name + "."
 
816
                                   + property_name)
 
817
    
 
818
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
 
819
                         out_signature="v")
 
820
    def Get(self, interface_name, property_name):
 
821
        """Standard D-Bus property Get() method, see D-Bus standard.
 
822
        """
 
823
        prop = self._get_dbus_property(interface_name, property_name)
 
824
        if prop._dbus_access == "write":
 
825
            raise DBusPropertyAccessException(property_name)
 
826
        value = prop()
 
827
        if not hasattr(value, "variant_level"):
 
828
            return value
 
829
        return type(value)(value, variant_level=value.variant_level+1)
 
830
    
 
831
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
 
832
    def Set(self, interface_name, property_name, value):
 
833
        """Standard D-Bus property Set() method, see D-Bus standard.
 
834
        """
 
835
        prop = self._get_dbus_property(interface_name, property_name)
 
836
        if prop._dbus_access == "read":
 
837
            raise DBusPropertyAccessException(property_name)
 
838
        if prop._dbus_get_args_options["byte_arrays"]:
 
839
            # The byte_arrays option is not supported yet on
 
840
            # signatures other than "ay".
 
841
            if prop._dbus_signature != "ay":
 
842
                raise ValueError
 
843
            value = dbus.ByteArray(''.join(unichr(byte)
 
844
                                           for byte in value))
 
845
        prop(value)
 
846
    
 
847
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
 
848
                         out_signature="a{sv}")
 
849
    def GetAll(self, interface_name):
 
850
        """Standard D-Bus property GetAll() method, see D-Bus
 
851
        standard.
 
852
        
 
853
        Note: Will not include properties with access="write".
 
854
        """
 
855
        properties = {}
 
856
        for name, prop in self._get_all_dbus_properties():
 
857
            if (interface_name
 
858
                and interface_name != prop._dbus_interface):
 
859
                # Interface non-empty but did not match
 
860
                continue
 
861
            # Ignore write-only properties
 
862
            if prop._dbus_access == "write":
 
863
                continue
 
864
            value = prop()
 
865
            if not hasattr(value, "variant_level"):
 
866
                properties[name] = value
 
867
                continue
 
868
            properties[name] = type(value)(value, variant_level=
 
869
                                           value.variant_level+1)
 
870
        return dbus.Dictionary(properties, signature="sv")
 
871
    
 
872
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
873
                         out_signature="s",
 
874
                         path_keyword='object_path',
 
875
                         connection_keyword='connection')
 
876
    def Introspect(self, object_path, connection):
 
877
        """Standard D-Bus method, overloaded to insert property tags.
 
878
        """
 
879
        xmlstring = dbus.service.Object.Introspect(self, object_path,
 
880
                                                   connection)
 
881
        try:
 
882
            document = xml.dom.minidom.parseString(xmlstring)
 
883
            def make_tag(document, name, prop):
 
884
                e = document.createElement("property")
 
885
                e.setAttribute("name", name)
 
886
                e.setAttribute("type", prop._dbus_signature)
 
887
                e.setAttribute("access", prop._dbus_access)
 
888
                return e
 
889
            for if_tag in document.getElementsByTagName("interface"):
 
890
                for tag in (make_tag(document, name, prop)
 
891
                            for name, prop
 
892
                            in self._get_all_dbus_properties()
 
893
                            if prop._dbus_interface
 
894
                            == if_tag.getAttribute("name")):
 
895
                    if_tag.appendChild(tag)
 
896
                # Add the names to the return values for the
 
897
                # "org.freedesktop.DBus.Properties" methods
 
898
                if (if_tag.getAttribute("name")
 
899
                    == "org.freedesktop.DBus.Properties"):
 
900
                    for cn in if_tag.getElementsByTagName("method"):
 
901
                        if cn.getAttribute("name") == "Get":
 
902
                            for arg in cn.getElementsByTagName("arg"):
 
903
                                if (arg.getAttribute("direction")
 
904
                                    == "out"):
 
905
                                    arg.setAttribute("name", "value")
 
906
                        elif cn.getAttribute("name") == "GetAll":
 
907
                            for arg in cn.getElementsByTagName("arg"):
 
908
                                if (arg.getAttribute("direction")
 
909
                                    == "out"):
 
910
                                    arg.setAttribute("name", "props")
 
911
            xmlstring = document.toxml("utf-8")
 
912
            document.unlink()
 
913
        except (AttributeError, xml.dom.DOMException,
 
914
                xml.parsers.expat.ExpatError) as error:
 
915
            logger.error("Failed to override Introspection method",
 
916
                         error)
 
917
        return xmlstring
 
918
 
 
919
 
 
920
def datetime_to_dbus (dt, variant_level=0):
 
921
    """Convert a UTC datetime.datetime() to a D-Bus type."""
 
922
    if dt is None:
 
923
        return dbus.String("", variant_level = variant_level)
 
924
    return dbus.String(dt.isoformat(),
 
925
                       variant_level=variant_level)
 
926
 
 
927
 
 
928
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
 
929
                                  .__metaclass__):
 
930
    """Applied to an empty subclass of a D-Bus object, this metaclass
 
931
    will add additional D-Bus attributes matching a certain pattern.
 
932
    """
 
933
    def __new__(mcs, name, bases, attr):
 
934
        # Go through all the base classes which could have D-Bus
 
935
        # methods, signals, or properties in them
 
936
        for base in (b for b in bases
 
937
                     if issubclass(b, dbus.service.Object)):
 
938
            # Go though all attributes of the base class
 
939
            for attrname, attribute in inspect.getmembers(base):
 
940
                # Ignore non-D-Bus attributes, and D-Bus attributes
 
941
                # with the wrong interface name
 
942
                if (not hasattr(attribute, "_dbus_interface")
 
943
                    or not attribute._dbus_interface
 
944
                    .startswith("se.recompile.Mandos")):
 
945
                    continue
 
946
                # Create an alternate D-Bus interface name based on
 
947
                # the current name
 
948
                alt_interface = (attribute._dbus_interface
 
949
                                 .replace("se.recompile.Mandos",
 
950
                                          "se.bsnet.fukt.Mandos"))
 
951
                # Is this a D-Bus signal?
 
952
                if getattr(attribute, "_dbus_is_signal", False):
 
953
                    # Extract the original non-method function by
 
954
                    # black magic
 
955
                    nonmethod_func = (dict(
 
956
                            zip(attribute.func_code.co_freevars,
 
957
                                attribute.__closure__))["func"]
 
958
                                      .cell_contents)
 
959
                    # Create a new, but exactly alike, function
 
960
                    # object, and decorate it to be a new D-Bus signal
 
961
                    # with the alternate D-Bus interface name
 
962
                    new_function = (dbus.service.signal
 
963
                                    (alt_interface,
 
964
                                     attribute._dbus_signature)
 
965
                                    (types.FunctionType(
 
966
                                nonmethod_func.func_code,
 
967
                                nonmethod_func.func_globals,
 
968
                                nonmethod_func.func_name,
 
969
                                nonmethod_func.func_defaults,
 
970
                                nonmethod_func.func_closure)))
 
971
                    # Define a creator of a function to call both the
 
972
                    # old and new functions, so both the old and new
 
973
                    # signals gets sent when the function is called
 
974
                    def fixscope(func1, func2):
 
975
                        """This function is a scope container to pass
 
976
                        func1 and func2 to the "call_both" function
 
977
                        outside of its arguments"""
 
978
                        def call_both(*args, **kwargs):
 
979
                            """This function will emit two D-Bus
 
980
                            signals by calling func1 and func2"""
 
981
                            func1(*args, **kwargs)
 
982
                            func2(*args, **kwargs)
 
983
                        return call_both
 
984
                    # Create the "call_both" function and add it to
 
985
                    # the class
 
986
                    attr[attrname] = fixscope(attribute,
 
987
                                              new_function)
 
988
                # Is this a D-Bus method?
 
989
                elif getattr(attribute, "_dbus_is_method", False):
 
990
                    # Create a new, but exactly alike, function
 
991
                    # object.  Decorate it to be a new D-Bus method
 
992
                    # with the alternate D-Bus interface name.  Add it
 
993
                    # to the class.
 
994
                    attr[attrname] = (dbus.service.method
 
995
                                      (alt_interface,
 
996
                                       attribute._dbus_in_signature,
 
997
                                       attribute._dbus_out_signature)
 
998
                                      (types.FunctionType
 
999
                                       (attribute.func_code,
 
1000
                                        attribute.func_globals,
 
1001
                                        attribute.func_name,
 
1002
                                        attribute.func_defaults,
 
1003
                                        attribute.func_closure)))
 
1004
                # Is this a D-Bus property?
 
1005
                elif getattr(attribute, "_dbus_is_property", False):
 
1006
                    # Create a new, but exactly alike, function
 
1007
                    # object, and decorate it to be a new D-Bus
 
1008
                    # property with the alternate D-Bus interface
 
1009
                    # name.  Add it to the class.
 
1010
                    attr[attrname] = (dbus_service_property
 
1011
                                      (alt_interface,
 
1012
                                       attribute._dbus_signature,
 
1013
                                       attribute._dbus_access,
 
1014
                                       attribute
 
1015
                                       ._dbus_get_args_options
 
1016
                                       ["byte_arrays"])
 
1017
                                      (types.FunctionType
 
1018
                                       (attribute.func_code,
 
1019
                                        attribute.func_globals,
 
1020
                                        attribute.func_name,
 
1021
                                        attribute.func_defaults,
 
1022
                                        attribute.func_closure)))
 
1023
        return type.__new__(mcs, name, bases, attr)
 
1024
 
 
1025
 
 
1026
class ClientDBus(Client, DBusObjectWithProperties):
481
1027
    """A Client class using D-Bus
482
1028
    
483
1029
    Attributes:
484
1030
    dbus_object_path: dbus.ObjectPath
485
1031
    bus: dbus.SystemBus()
486
1032
    """
 
1033
    
 
1034
    runtime_expansions = (Client.runtime_expansions
 
1035
                          + ("dbus_object_path",))
 
1036
    
487
1037
    # dbus.service.Object doesn't use super(), so we can't either.
488
1038
    
489
1039
    def __init__(self, bus = None, *args, **kwargs):
490
1040
        self.bus = bus
491
1041
        Client.__init__(self, *args, **kwargs)
 
1042
        self._approvals_pending = 0
 
1043
        
 
1044
        self._approvals_pending = 0
492
1045
        # Only now, when this client is initialized, can it show up on
493
1046
        # the D-Bus
 
1047
        client_object_name = unicode(self.name).translate(
 
1048
            {ord("."): ord("_"),
 
1049
             ord("-"): ord("_")})
494
1050
        self.dbus_object_path = (dbus.ObjectPath
495
 
                                 (u"/clients/"
496
 
                                  + self.name.replace(u".", u"_")))
497
 
        dbus.service.Object.__init__(self, self.bus,
498
 
                                     self.dbus_object_path)
499
 
    
500
 
    @staticmethod
501
 
    def _datetime_to_dbus(dt, variant_level=0):
502
 
        """Convert a UTC datetime.datetime() to a D-Bus type."""
503
 
        return dbus.String(dt.isoformat(),
504
 
                           variant_level=variant_level)
505
 
    
506
 
    def enable(self):
507
 
        oldstate = getattr(self, u"enabled", False)
508
 
        r = Client.enable(self)
509
 
        if oldstate != self.enabled:
510
 
            # Emit D-Bus signals
511
 
            self.PropertyChanged(dbus.String(u"enabled"),
512
 
                                 dbus.Boolean(True, variant_level=1))
513
 
            self.PropertyChanged(
514
 
                dbus.String(u"last_enabled"),
515
 
                self._datetime_to_dbus(self.last_enabled,
516
 
                                       variant_level=1))
517
 
        return r
518
 
    
519
 
    def disable(self, signal = True):
520
 
        oldstate = getattr(self, u"enabled", False)
521
 
        r = Client.disable(self)
522
 
        if signal and oldstate != self.enabled:
523
 
            # Emit D-Bus signal
524
 
            self.PropertyChanged(dbus.String(u"enabled"),
525
 
                                 dbus.Boolean(False, variant_level=1))
526
 
        return r
 
1051
                                 ("/clients/" + client_object_name))
 
1052
        DBusObjectWithProperties.__init__(self, self.bus,
 
1053
                                          self.dbus_object_path)
 
1054
        
 
1055
    def notifychangeproperty(transform_func,
 
1056
                             dbus_name, type_func=lambda x: x,
 
1057
                             variant_level=1):
 
1058
        """ Modify a variable so that it's a property which announces
 
1059
        its changes to DBus.
 
1060
        
 
1061
        transform_fun: Function that takes a value and a variant_level
 
1062
                       and transforms it to a D-Bus type.
 
1063
        dbus_name: D-Bus name of the variable
 
1064
        type_func: Function that transform the value before sending it
 
1065
                   to the D-Bus.  Default: no transform
 
1066
        variant_level: D-Bus variant level.  Default: 1
 
1067
        """
 
1068
        attrname = "_{0}".format(dbus_name)
 
1069
        def setter(self, value):
 
1070
            if hasattr(self, "dbus_object_path"):
 
1071
                if (not hasattr(self, attrname) or
 
1072
                    type_func(getattr(self, attrname, None))
 
1073
                    != type_func(value)):
 
1074
                    dbus_value = transform_func(type_func(value),
 
1075
                                                variant_level
 
1076
                                                =variant_level)
 
1077
                    self.PropertyChanged(dbus.String(dbus_name),
 
1078
                                         dbus_value)
 
1079
            setattr(self, attrname, value)
 
1080
        
 
1081
        return property(lambda self: getattr(self, attrname), setter)
 
1082
    
 
1083
    
 
1084
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
 
1085
    approvals_pending = notifychangeproperty(dbus.Boolean,
 
1086
                                             "ApprovalPending",
 
1087
                                             type_func = bool)
 
1088
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
 
1089
    last_enabled = notifychangeproperty(datetime_to_dbus,
 
1090
                                        "LastEnabled")
 
1091
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
 
1092
                                   type_func = lambda checker:
 
1093
                                       checker is not None)
 
1094
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
 
1095
                                           "LastCheckedOK")
 
1096
    last_approval_request = notifychangeproperty(
 
1097
        datetime_to_dbus, "LastApprovalRequest")
 
1098
    approved_by_default = notifychangeproperty(dbus.Boolean,
 
1099
                                               "ApprovedByDefault")
 
1100
    approval_delay = notifychangeproperty(dbus.UInt64,
 
1101
                                          "ApprovalDelay",
 
1102
                                          type_func =
 
1103
                                          timedelta_to_milliseconds)
 
1104
    approval_duration = notifychangeproperty(
 
1105
        dbus.UInt64, "ApprovalDuration",
 
1106
        type_func = timedelta_to_milliseconds)
 
1107
    host = notifychangeproperty(dbus.String, "Host")
 
1108
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
 
1109
                                   type_func =
 
1110
                                   timedelta_to_milliseconds)
 
1111
    extended_timeout = notifychangeproperty(
 
1112
        dbus.UInt64, "ExtendedTimeout",
 
1113
        type_func = timedelta_to_milliseconds)
 
1114
    interval = notifychangeproperty(dbus.UInt64,
 
1115
                                    "Interval",
 
1116
                                    type_func =
 
1117
                                    timedelta_to_milliseconds)
 
1118
    checker_command = notifychangeproperty(dbus.String, "Checker")
 
1119
    
 
1120
    del notifychangeproperty
527
1121
    
528
1122
    def __del__(self, *args, **kwargs):
529
1123
        try:
530
1124
            self.remove_from_connection()
531
1125
        except LookupError:
532
1126
            pass
533
 
        if hasattr(dbus.service.Object, u"__del__"):
534
 
            dbus.service.Object.__del__(self, *args, **kwargs)
 
1127
        if hasattr(DBusObjectWithProperties, "__del__"):
 
1128
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
535
1129
        Client.__del__(self, *args, **kwargs)
536
1130
    
537
1131
    def checker_callback(self, pid, condition, command,
538
1132
                         *args, **kwargs):
539
1133
        self.checker_callback_tag = None
540
1134
        self.checker = None
541
 
        # Emit D-Bus signal
542
 
        self.PropertyChanged(dbus.String(u"checker_running"),
543
 
                             dbus.Boolean(False, variant_level=1))
544
1135
        if os.WIFEXITED(condition):
545
1136
            exitstatus = os.WEXITSTATUS(condition)
546
1137
            # Emit D-Bus signal
556
1147
        return Client.checker_callback(self, pid, condition, command,
557
1148
                                       *args, **kwargs)
558
1149
    
559
 
    def checked_ok(self, *args, **kwargs):
560
 
        r = Client.checked_ok(self, *args, **kwargs)
561
 
        # Emit D-Bus signal
562
 
        self.PropertyChanged(
563
 
            dbus.String(u"last_checked_ok"),
564
 
            (self._datetime_to_dbus(self.last_checked_ok,
565
 
                                    variant_level=1)))
566
 
        return r
567
 
    
568
1150
    def start_checker(self, *args, **kwargs):
569
1151
        old_checker = self.checker
570
1152
        if self.checker is not None:
577
1159
            and old_checker_pid != self.checker.pid):
578
1160
            # Emit D-Bus signal
579
1161
            self.CheckerStarted(self.current_checker_command)
580
 
            self.PropertyChanged(
581
 
                dbus.String(u"checker_running"),
582
 
                dbus.Boolean(True, variant_level=1))
583
 
        return r
584
 
    
585
 
    def stop_checker(self, *args, **kwargs):
586
 
        old_checker = getattr(self, u"checker", None)
587
 
        r = Client.stop_checker(self, *args, **kwargs)
588
 
        if (old_checker is not None
589
 
            and getattr(self, u"checker", None) is None):
590
 
            self.PropertyChanged(dbus.String(u"checker_running"),
591
 
                                 dbus.Boolean(False, variant_level=1))
592
 
        return r
593
 
    
594
 
    ## D-Bus methods & signals
595
 
    _interface = u"se.bsnet.fukt.Mandos.Client"
596
 
    
597
 
    # CheckedOK - method
598
 
    @dbus.service.method(_interface)
599
 
    def CheckedOK(self):
600
 
        return self.checked_ok()
 
1162
        return r
 
1163
    
 
1164
    def _reset_approved(self):
 
1165
        self.approved = None
 
1166
        return False
 
1167
    
 
1168
    def approve(self, value=True):
 
1169
        self.send_changedstate()
 
1170
        self.approved = value
 
1171
        gobject.timeout_add(timedelta_to_milliseconds
 
1172
                            (self.approval_duration),
 
1173
                            self._reset_approved)
 
1174
    
 
1175
    
 
1176
    ## D-Bus methods, signals & properties
 
1177
    _interface = "se.recompile.Mandos.Client"
 
1178
    
 
1179
    ## Signals
601
1180
    
602
1181
    # CheckerCompleted - signal
603
 
    @dbus.service.signal(_interface, signature=u"nxs")
 
1182
    @dbus.service.signal(_interface, signature="nxs")
604
1183
    def CheckerCompleted(self, exitcode, waitstatus, command):
605
1184
        "D-Bus signal"
606
1185
        pass
607
1186
    
608
1187
    # CheckerStarted - signal
609
 
    @dbus.service.signal(_interface, signature=u"s")
 
1188
    @dbus.service.signal(_interface, signature="s")
610
1189
    def CheckerStarted(self, command):
611
1190
        "D-Bus signal"
612
1191
        pass
613
1192
    
614
 
    # GetAllProperties - method
615
 
    @dbus.service.method(_interface, out_signature=u"a{sv}")
616
 
    def GetAllProperties(self):
617
 
        "D-Bus method"
618
 
        return dbus.Dictionary({
619
 
                dbus.String(u"name"):
620
 
                    dbus.String(self.name, variant_level=1),
621
 
                dbus.String(u"fingerprint"):
622
 
                    dbus.String(self.fingerprint, variant_level=1),
623
 
                dbus.String(u"host"):
624
 
                    dbus.String(self.host, variant_level=1),
625
 
                dbus.String(u"created"):
626
 
                    self._datetime_to_dbus(self.created,
627
 
                                           variant_level=1),
628
 
                dbus.String(u"last_enabled"):
629
 
                    (self._datetime_to_dbus(self.last_enabled,
630
 
                                            variant_level=1)
631
 
                     if self.last_enabled is not None
632
 
                     else dbus.Boolean(False, variant_level=1)),
633
 
                dbus.String(u"enabled"):
634
 
                    dbus.Boolean(self.enabled, variant_level=1),
635
 
                dbus.String(u"last_checked_ok"):
636
 
                    (self._datetime_to_dbus(self.last_checked_ok,
637
 
                                            variant_level=1)
638
 
                     if self.last_checked_ok is not None
639
 
                     else dbus.Boolean (False, variant_level=1)),
640
 
                dbus.String(u"timeout"):
641
 
                    dbus.UInt64(self.timeout_milliseconds(),
642
 
                                variant_level=1),
643
 
                dbus.String(u"interval"):
644
 
                    dbus.UInt64(self.interval_milliseconds(),
645
 
                                variant_level=1),
646
 
                dbus.String(u"checker"):
647
 
                    dbus.String(self.checker_command,
648
 
                                variant_level=1),
649
 
                dbus.String(u"checker_running"):
650
 
                    dbus.Boolean(self.checker is not None,
651
 
                                 variant_level=1),
652
 
                dbus.String(u"object_path"):
653
 
                    dbus.ObjectPath(self.dbus_object_path,
654
 
                                    variant_level=1)
655
 
                }, signature=u"sv")
656
 
    
657
 
    # IsStillValid - method
658
 
    @dbus.service.method(_interface, out_signature=u"b")
659
 
    def IsStillValid(self):
660
 
        return self.still_valid()
661
 
    
662
1193
    # PropertyChanged - signal
663
 
    @dbus.service.signal(_interface, signature=u"sv")
 
1194
    @dbus.service.signal(_interface, signature="sv")
664
1195
    def PropertyChanged(self, property, value):
665
1196
        "D-Bus signal"
666
1197
        pass
667
1198
    
668
 
    # ReceivedSecret - signal
 
1199
    # GotSecret - signal
669
1200
    @dbus.service.signal(_interface)
670
 
    def ReceivedSecret(self):
671
 
        "D-Bus signal"
 
1201
    def GotSecret(self):
 
1202
        """D-Bus signal
 
1203
        Is sent after a successful transfer of secret from the Mandos
 
1204
        server to mandos-client
 
1205
        """
672
1206
        pass
673
1207
    
674
1208
    # Rejected - signal
675
 
    @dbus.service.signal(_interface)
676
 
    def Rejected(self):
677
 
        "D-Bus signal"
678
 
        pass
679
 
    
680
 
    # SetChecker - method
681
 
    @dbus.service.method(_interface, in_signature=u"s")
682
 
    def SetChecker(self, checker):
683
 
        "D-Bus setter method"
684
 
        self.checker_command = checker
685
 
        # Emit D-Bus signal
686
 
        self.PropertyChanged(dbus.String(u"checker"),
687
 
                             dbus.String(self.checker_command,
688
 
                                         variant_level=1))
689
 
    
690
 
    # SetHost - method
691
 
    @dbus.service.method(_interface, in_signature=u"s")
692
 
    def SetHost(self, host):
693
 
        "D-Bus setter method"
694
 
        self.host = host
695
 
        # Emit D-Bus signal
696
 
        self.PropertyChanged(dbus.String(u"host"),
697
 
                             dbus.String(self.host, variant_level=1))
698
 
    
699
 
    # SetInterval - method
700
 
    @dbus.service.method(_interface, in_signature=u"t")
701
 
    def SetInterval(self, milliseconds):
702
 
        self.interval = datetime.timedelta(0, 0, 0, milliseconds)
703
 
        # Emit D-Bus signal
704
 
        self.PropertyChanged(dbus.String(u"interval"),
705
 
                             (dbus.UInt64(self.interval_milliseconds(),
706
 
                                          variant_level=1)))
707
 
    
708
 
    # SetSecret - method
709
 
    @dbus.service.method(_interface, in_signature=u"ay",
710
 
                         byte_arrays=True)
711
 
    def SetSecret(self, secret):
712
 
        "D-Bus setter method"
713
 
        self.secret = str(secret)
714
 
    
715
 
    # SetTimeout - method
716
 
    @dbus.service.method(_interface, in_signature=u"t")
717
 
    def SetTimeout(self, milliseconds):
718
 
        self.timeout = datetime.timedelta(0, 0, 0, milliseconds)
719
 
        # Emit D-Bus signal
720
 
        self.PropertyChanged(dbus.String(u"timeout"),
721
 
                             (dbus.UInt64(self.timeout_milliseconds(),
722
 
                                          variant_level=1)))
 
1209
    @dbus.service.signal(_interface, signature="s")
 
1210
    def Rejected(self, reason):
 
1211
        "D-Bus signal"
 
1212
        pass
 
1213
    
 
1214
    # NeedApproval - signal
 
1215
    @dbus.service.signal(_interface, signature="tb")
 
1216
    def NeedApproval(self, timeout, default):
 
1217
        "D-Bus signal"
 
1218
        return self.need_approval()
 
1219
    
 
1220
    # NeRwequest - signal
 
1221
    @dbus.service.signal(_interface, signature="s")
 
1222
    def NewRequest(self, ip):
 
1223
        """D-Bus signal
 
1224
        Is sent after a client request a password.
 
1225
        """
 
1226
        pass
 
1227
    
 
1228
    ## Methods
 
1229
    
 
1230
    # Approve - method
 
1231
    @dbus.service.method(_interface, in_signature="b")
 
1232
    def Approve(self, value):
 
1233
        self.approve(value)
 
1234
    
 
1235
    # CheckedOK - method
 
1236
    @dbus.service.method(_interface)
 
1237
    def CheckedOK(self):
 
1238
        self.checked_ok()
723
1239
    
724
1240
    # Enable - method
725
1241
    @dbus.service.method(_interface)
744
1260
    def StopChecker(self):
745
1261
        self.stop_checker()
746
1262
    
 
1263
    ## Properties
 
1264
    
 
1265
    # ApprovalPending - property
 
1266
    @dbus_service_property(_interface, signature="b", access="read")
 
1267
    def ApprovalPending_dbus_property(self):
 
1268
        return dbus.Boolean(bool(self.approvals_pending))
 
1269
    
 
1270
    # ApprovedByDefault - property
 
1271
    @dbus_service_property(_interface, signature="b",
 
1272
                           access="readwrite")
 
1273
    def ApprovedByDefault_dbus_property(self, value=None):
 
1274
        if value is None:       # get
 
1275
            return dbus.Boolean(self.approved_by_default)
 
1276
        self.approved_by_default = bool(value)
 
1277
    
 
1278
    # ApprovalDelay - property
 
1279
    @dbus_service_property(_interface, signature="t",
 
1280
                           access="readwrite")
 
1281
    def ApprovalDelay_dbus_property(self, value=None):
 
1282
        if value is None:       # get
 
1283
            return dbus.UInt64(self.approval_delay_milliseconds())
 
1284
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
 
1285
    
 
1286
    # ApprovalDuration - property
 
1287
    @dbus_service_property(_interface, signature="t",
 
1288
                           access="readwrite")
 
1289
    def ApprovalDuration_dbus_property(self, value=None):
 
1290
        if value is None:       # get
 
1291
            return dbus.UInt64(timedelta_to_milliseconds(
 
1292
                    self.approval_duration))
 
1293
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
 
1294
    
 
1295
    # Name - property
 
1296
    @dbus_service_property(_interface, signature="s", access="read")
 
1297
    def Name_dbus_property(self):
 
1298
        return dbus.String(self.name)
 
1299
    
 
1300
    # Fingerprint - property
 
1301
    @dbus_service_property(_interface, signature="s", access="read")
 
1302
    def Fingerprint_dbus_property(self):
 
1303
        return dbus.String(self.fingerprint)
 
1304
    
 
1305
    # Host - property
 
1306
    @dbus_service_property(_interface, signature="s",
 
1307
                           access="readwrite")
 
1308
    def Host_dbus_property(self, value=None):
 
1309
        if value is None:       # get
 
1310
            return dbus.String(self.host)
 
1311
        self.host = unicode(value)
 
1312
    
 
1313
    # Created - property
 
1314
    @dbus_service_property(_interface, signature="s", access="read")
 
1315
    def Created_dbus_property(self):
 
1316
        return datetime_to_dbus(self.created)
 
1317
    
 
1318
    # LastEnabled - property
 
1319
    @dbus_service_property(_interface, signature="s", access="read")
 
1320
    def LastEnabled_dbus_property(self):
 
1321
        return datetime_to_dbus(self.last_enabled)
 
1322
    
 
1323
    # Enabled - property
 
1324
    @dbus_service_property(_interface, signature="b",
 
1325
                           access="readwrite")
 
1326
    def Enabled_dbus_property(self, value=None):
 
1327
        if value is None:       # get
 
1328
            return dbus.Boolean(self.enabled)
 
1329
        if value:
 
1330
            self.enable()
 
1331
        else:
 
1332
            self.disable()
 
1333
    
 
1334
    # LastCheckedOK - property
 
1335
    @dbus_service_property(_interface, signature="s",
 
1336
                           access="readwrite")
 
1337
    def LastCheckedOK_dbus_property(self, value=None):
 
1338
        if value is not None:
 
1339
            self.checked_ok()
 
1340
            return
 
1341
        return datetime_to_dbus(self.last_checked_ok)
 
1342
    
 
1343
    # Expires - property
 
1344
    @dbus_service_property(_interface, signature="s", access="read")
 
1345
    def Expires_dbus_property(self):
 
1346
        return datetime_to_dbus(self.expires)
 
1347
    
 
1348
    # LastApprovalRequest - property
 
1349
    @dbus_service_property(_interface, signature="s", access="read")
 
1350
    def LastApprovalRequest_dbus_property(self):
 
1351
        return datetime_to_dbus(self.last_approval_request)
 
1352
    
 
1353
    # Timeout - property
 
1354
    @dbus_service_property(_interface, signature="t",
 
1355
                           access="readwrite")
 
1356
    def Timeout_dbus_property(self, value=None):
 
1357
        if value is None:       # get
 
1358
            return dbus.UInt64(self.timeout_milliseconds())
 
1359
        self.timeout = datetime.timedelta(0, 0, 0, value)
 
1360
        if getattr(self, "disable_initiator_tag", None) is None:
 
1361
            return
 
1362
        # Reschedule timeout
 
1363
        gobject.source_remove(self.disable_initiator_tag)
 
1364
        self.disable_initiator_tag = None
 
1365
        self.expires = None
 
1366
        time_to_die = timedelta_to_milliseconds((self
 
1367
                                                 .last_checked_ok
 
1368
                                                 + self.timeout)
 
1369
                                                - datetime.datetime
 
1370
                                                .utcnow())
 
1371
        if time_to_die <= 0:
 
1372
            # The timeout has passed
 
1373
            self.disable()
 
1374
        else:
 
1375
            self.expires = (datetime.datetime.utcnow()
 
1376
                            + datetime.timedelta(milliseconds =
 
1377
                                                 time_to_die))
 
1378
            self.disable_initiator_tag = (gobject.timeout_add
 
1379
                                          (time_to_die, self.disable))
 
1380
    
 
1381
    # ExtendedTimeout - property
 
1382
    @dbus_service_property(_interface, signature="t",
 
1383
                           access="readwrite")
 
1384
    def ExtendedTimeout_dbus_property(self, value=None):
 
1385
        if value is None:       # get
 
1386
            return dbus.UInt64(self.extended_timeout_milliseconds())
 
1387
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
 
1388
    
 
1389
    # Interval - property
 
1390
    @dbus_service_property(_interface, signature="t",
 
1391
                           access="readwrite")
 
1392
    def Interval_dbus_property(self, value=None):
 
1393
        if value is None:       # get
 
1394
            return dbus.UInt64(self.interval_milliseconds())
 
1395
        self.interval = datetime.timedelta(0, 0, 0, value)
 
1396
        if getattr(self, "checker_initiator_tag", None) is None:
 
1397
            return
 
1398
        if self.enabled:
 
1399
            # Reschedule checker run
 
1400
            gobject.source_remove(self.checker_initiator_tag)
 
1401
            self.checker_initiator_tag = (gobject.timeout_add
 
1402
                                          (value, self.start_checker))
 
1403
            self.start_checker()    # Start one now, too
 
1404
    
 
1405
    # Checker - property
 
1406
    @dbus_service_property(_interface, signature="s",
 
1407
                           access="readwrite")
 
1408
    def Checker_dbus_property(self, value=None):
 
1409
        if value is None:       # get
 
1410
            return dbus.String(self.checker_command)
 
1411
        self.checker_command = unicode(value)
 
1412
    
 
1413
    # CheckerRunning - property
 
1414
    @dbus_service_property(_interface, signature="b",
 
1415
                           access="readwrite")
 
1416
    def CheckerRunning_dbus_property(self, value=None):
 
1417
        if value is None:       # get
 
1418
            return dbus.Boolean(self.checker is not None)
 
1419
        if value:
 
1420
            self.start_checker()
 
1421
        else:
 
1422
            self.stop_checker()
 
1423
    
 
1424
    # ObjectPath - property
 
1425
    @dbus_service_property(_interface, signature="o", access="read")
 
1426
    def ObjectPath_dbus_property(self):
 
1427
        return self.dbus_object_path # is already a dbus.ObjectPath
 
1428
    
 
1429
    # Secret = property
 
1430
    @dbus_service_property(_interface, signature="ay",
 
1431
                           access="write", byte_arrays=True)
 
1432
    def Secret_dbus_property(self, value):
 
1433
        self.secret = str(value)
 
1434
    
747
1435
    del _interface
748
1436
 
749
1437
 
 
1438
class ProxyClient(object):
 
1439
    def __init__(self, child_pipe, fpr, address):
 
1440
        self._pipe = child_pipe
 
1441
        self._pipe.send(('init', fpr, address))
 
1442
        if not self._pipe.recv():
 
1443
            raise KeyError()
 
1444
    
 
1445
    def __getattribute__(self, name):
 
1446
        if name == '_pipe':
 
1447
            return super(ProxyClient, self).__getattribute__(name)
 
1448
        self._pipe.send(('getattr', name))
 
1449
        data = self._pipe.recv()
 
1450
        if data[0] == 'data':
 
1451
            return data[1]
 
1452
        if data[0] == 'function':
 
1453
            def func(*args, **kwargs):
 
1454
                self._pipe.send(('funcall', name, args, kwargs))
 
1455
                return self._pipe.recv()[1]
 
1456
            return func
 
1457
    
 
1458
    def __setattr__(self, name, value):
 
1459
        if name == '_pipe':
 
1460
            return super(ProxyClient, self).__setattr__(name, value)
 
1461
        self._pipe.send(('setattr', name, value))
 
1462
 
 
1463
 
 
1464
class ClientDBusTransitional(ClientDBus):
 
1465
    __metaclass__ = AlternateDBusNamesMetaclass
 
1466
 
 
1467
 
750
1468
class ClientHandler(socketserver.BaseRequestHandler, object):
751
1469
    """A class to handle client connections.
752
1470
    
754
1472
    Note: This will run in its own forked process."""
755
1473
    
756
1474
    def handle(self):
757
 
        logger.info(u"TCP connection from: %s",
758
 
                    unicode(self.client_address))
759
 
        logger.debug(u"IPC Pipe FD: %d", self.server.pipe[1])
760
 
        # Open IPC pipe to parent process
761
 
        with closing(os.fdopen(self.server.pipe[1], u"w", 1)) as ipc:
 
1475
        with contextlib.closing(self.server.child_pipe) as child_pipe:
 
1476
            logger.info("TCP connection from: %s",
 
1477
                        unicode(self.client_address))
 
1478
            logger.debug("Pipe FD: %d",
 
1479
                         self.server.child_pipe.fileno())
 
1480
            
762
1481
            session = (gnutls.connection
763
1482
                       .ClientSession(self.request,
764
1483
                                      gnutls.connection
765
1484
                                      .X509Credentials()))
766
1485
            
767
 
            line = self.request.makefile().readline()
768
 
            logger.debug(u"Protocol version: %r", line)
769
 
            try:
770
 
                if int(line.strip().split()[0]) > 1:
771
 
                    raise RuntimeError
772
 
            except (ValueError, IndexError, RuntimeError), error:
773
 
                logger.error(u"Unknown protocol version: %s", error)
774
 
                return
775
 
            
776
1486
            # Note: gnutls.connection.X509Credentials is really a
777
1487
            # generic GnuTLS certificate credentials object so long as
778
1488
            # no X.509 keys are added to it.  Therefore, we can use it
779
1489
            # here despite using OpenPGP certificates.
780
1490
            
781
 
            #priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
782
 
            #                      u"+AES-256-CBC", u"+SHA1",
783
 
            #                      u"+COMP-NULL", u"+CTYPE-OPENPGP",
784
 
            #                      u"+DHE-DSS"))
 
1491
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
 
1492
            #                      "+AES-256-CBC", "+SHA1",
 
1493
            #                      "+COMP-NULL", "+CTYPE-OPENPGP",
 
1494
            #                      "+DHE-DSS"))
785
1495
            # Use a fallback default, since this MUST be set.
786
1496
            priority = self.server.gnutls_priority
787
1497
            if priority is None:
788
 
                priority = u"NORMAL"
 
1498
                priority = "NORMAL"
789
1499
            (gnutls.library.functions
790
1500
             .gnutls_priority_set_direct(session._c_object,
791
1501
                                         priority, None))
792
1502
            
 
1503
            # Start communication using the Mandos protocol
 
1504
            # Get protocol number
 
1505
            line = self.request.makefile().readline()
 
1506
            logger.debug("Protocol version: %r", line)
 
1507
            try:
 
1508
                if int(line.strip().split()[0]) > 1:
 
1509
                    raise RuntimeError
 
1510
            except (ValueError, IndexError, RuntimeError) as error:
 
1511
                logger.error("Unknown protocol version: %s", error)
 
1512
                return
 
1513
            
 
1514
            # Start GnuTLS connection
793
1515
            try:
794
1516
                session.handshake()
795
 
            except gnutls.errors.GNUTLSError, error:
796
 
                logger.warning(u"Handshake failed: %s", error)
 
1517
            except gnutls.errors.GNUTLSError as error:
 
1518
                logger.warning("Handshake failed: %s", error)
797
1519
                # Do not run session.bye() here: the session is not
798
1520
                # established.  Just abandon the request.
799
1521
                return
800
 
            logger.debug(u"Handshake succeeded")
 
1522
            logger.debug("Handshake succeeded")
 
1523
            
 
1524
            approval_required = False
801
1525
            try:
802
 
                fpr = self.fingerprint(self.peer_certificate(session))
803
 
            except (TypeError, gnutls.errors.GNUTLSError), error:
804
 
                logger.warning(u"Bad certificate: %s", error)
805
 
                session.bye()
806
 
                return
807
 
            logger.debug(u"Fingerprint: %s", fpr)
 
1526
                try:
 
1527
                    fpr = self.fingerprint(self.peer_certificate
 
1528
                                           (session))
 
1529
                except (TypeError,
 
1530
                        gnutls.errors.GNUTLSError) as error:
 
1531
                    logger.warning("Bad certificate: %s", error)
 
1532
                    return
 
1533
                logger.debug("Fingerprint: %s", fpr)
 
1534
                
 
1535
                try:
 
1536
                    client = ProxyClient(child_pipe, fpr,
 
1537
                                         self.client_address)
 
1538
                except KeyError:
 
1539
                    return
 
1540
                
 
1541
                if self.server.use_dbus:
 
1542
                    # Emit D-Bus signal
 
1543
                    client.NewRequest(str(self.client_address))
 
1544
                
 
1545
                if client.approval_delay:
 
1546
                    delay = client.approval_delay
 
1547
                    client.approvals_pending += 1
 
1548
                    approval_required = True
 
1549
                
 
1550
                while True:
 
1551
                    if not client.enabled:
 
1552
                        logger.info("Client %s is disabled",
 
1553
                                       client.name)
 
1554
                        if self.server.use_dbus:
 
1555
                            # Emit D-Bus signal
 
1556
                            client.Rejected("Disabled")
 
1557
                        return
 
1558
                    
 
1559
                    if client.approved or not client.approval_delay:
 
1560
                        #We are approved or approval is disabled
 
1561
                        break
 
1562
                    elif client.approved is None:
 
1563
                        logger.info("Client %s needs approval",
 
1564
                                    client.name)
 
1565
                        if self.server.use_dbus:
 
1566
                            # Emit D-Bus signal
 
1567
                            client.NeedApproval(
 
1568
                                client.approval_delay_milliseconds(),
 
1569
                                client.approved_by_default)
 
1570
                    else:
 
1571
                        logger.warning("Client %s was not approved",
 
1572
                                       client.name)
 
1573
                        if self.server.use_dbus:
 
1574
                            # Emit D-Bus signal
 
1575
                            client.Rejected("Denied")
 
1576
                        return
 
1577
                    
 
1578
                    #wait until timeout or approved
 
1579
                    time = datetime.datetime.now()
 
1580
                    client.changedstate.acquire()
 
1581
                    (client.changedstate.wait
 
1582
                     (float(client.timedelta_to_milliseconds(delay)
 
1583
                            / 1000)))
 
1584
                    client.changedstate.release()
 
1585
                    time2 = datetime.datetime.now()
 
1586
                    if (time2 - time) >= delay:
 
1587
                        if not client.approved_by_default:
 
1588
                            logger.warning("Client %s timed out while"
 
1589
                                           " waiting for approval",
 
1590
                                           client.name)
 
1591
                            if self.server.use_dbus:
 
1592
                                # Emit D-Bus signal
 
1593
                                client.Rejected("Approval timed out")
 
1594
                            return
 
1595
                        else:
 
1596
                            break
 
1597
                    else:
 
1598
                        delay -= time2 - time
 
1599
                
 
1600
                sent_size = 0
 
1601
                while sent_size < len(client.secret):
 
1602
                    try:
 
1603
                        sent = session.send(client.secret[sent_size:])
 
1604
                    except gnutls.errors.GNUTLSError as error:
 
1605
                        logger.warning("gnutls send failed")
 
1606
                        return
 
1607
                    logger.debug("Sent: %d, remaining: %d",
 
1608
                                 sent, len(client.secret)
 
1609
                                 - (sent_size + sent))
 
1610
                    sent_size += sent
 
1611
                
 
1612
                logger.info("Sending secret to %s", client.name)
 
1613
                # bump the timeout using extended_timeout
 
1614
                client.checked_ok(client.extended_timeout)
 
1615
                if self.server.use_dbus:
 
1616
                    # Emit D-Bus signal
 
1617
                    client.GotSecret()
808
1618
            
809
 
            for c in self.server.clients:
810
 
                if c.fingerprint == fpr:
811
 
                    client = c
812
 
                    break
813
 
            else:
814
 
                ipc.write(u"NOTFOUND %s %s\n"
815
 
                          % (fpr, unicode(self.client_address)))
816
 
                session.bye()
817
 
                return
818
 
            # Have to check if client.still_valid(), since it is
819
 
            # possible that the client timed out while establishing
820
 
            # the GnuTLS session.
821
 
            if not client.still_valid():
822
 
                ipc.write(u"INVALID %s\n" % client.name)
823
 
                session.bye()
824
 
                return
825
 
            ipc.write(u"SENDING %s\n" % client.name)
826
 
            sent_size = 0
827
 
            while sent_size < len(client.secret):
828
 
                sent = session.send(client.secret[sent_size:])
829
 
                logger.debug(u"Sent: %d, remaining: %d",
830
 
                             sent, len(client.secret)
831
 
                             - (sent_size + sent))
832
 
                sent_size += sent
833
 
            session.bye()
 
1619
            finally:
 
1620
                if approval_required:
 
1621
                    client.approvals_pending -= 1
 
1622
                try:
 
1623
                    session.bye()
 
1624
                except gnutls.errors.GNUTLSError as error:
 
1625
                    logger.warning("GnuTLS bye failed")
834
1626
    
835
1627
    @staticmethod
836
1628
    def peer_certificate(session):
846
1638
                     .gnutls_certificate_get_peers
847
1639
                     (session._c_object, ctypes.byref(list_size)))
848
1640
        if not bool(cert_list) and list_size.value != 0:
849
 
            raise gnutls.errors.GNUTLSError(u"error getting peer"
850
 
                                            u" certificate")
 
1641
            raise gnutls.errors.GNUTLSError("error getting peer"
 
1642
                                            " certificate")
851
1643
        if list_size.value == 0:
852
1644
            return None
853
1645
        cert = cert_list[0]
879
1671
        if crtverify.value != 0:
880
1672
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
881
1673
            raise (gnutls.errors.CertificateSecurityError
882
 
                   (u"Verify failed"))
 
1674
                   ("Verify failed"))
883
1675
        # New buffer for the fingerprint
884
1676
        buf = ctypes.create_string_buffer(20)
885
1677
        buf_len = ctypes.c_size_t()
892
1684
        # Convert the buffer to a Python bytestring
893
1685
        fpr = ctypes.string_at(buf, buf_len.value)
894
1686
        # Convert the bytestring to hexadecimal notation
895
 
        hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
 
1687
        hex_fpr = binascii.hexlify(fpr).upper()
896
1688
        return hex_fpr
897
1689
 
898
1690
 
899
 
class ForkingMixInWithPipe(socketserver.ForkingMixIn, object):
900
 
    """Like socketserver.ForkingMixIn, but also pass a pipe."""
 
1691
class MultiprocessingMixIn(object):
 
1692
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
 
1693
    def sub_process_main(self, request, address):
 
1694
        try:
 
1695
            self.finish_request(request, address)
 
1696
        except Exception:
 
1697
            self.handle_error(request, address)
 
1698
        self.close_request(request)
 
1699
    
 
1700
    def process_request(self, request, address):
 
1701
        """Start a new process to process the request."""
 
1702
        proc = multiprocessing.Process(target = self.sub_process_main,
 
1703
                                       args = (request,
 
1704
                                               address))
 
1705
        proc.start()
 
1706
        return proc
 
1707
 
 
1708
 
 
1709
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
 
1710
    """ adds a pipe to the MixIn """
901
1711
    def process_request(self, request, client_address):
902
1712
        """Overrides and wraps the original process_request().
903
1713
        
904
1714
        This function creates a new pipe in self.pipe
905
1715
        """
906
 
        self.pipe = os.pipe()
907
 
        super(ForkingMixInWithPipe,
908
 
              self).process_request(request, client_address)
909
 
        os.close(self.pipe[1])  # close write end
910
 
        self.add_pipe(self.pipe[0])
911
 
    def add_pipe(self, pipe):
 
1716
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
 
1717
        
 
1718
        proc = MultiprocessingMixIn.process_request(self, request,
 
1719
                                                    client_address)
 
1720
        self.child_pipe.close()
 
1721
        self.add_pipe(parent_pipe, proc)
 
1722
    
 
1723
    def add_pipe(self, parent_pipe, proc):
912
1724
        """Dummy function; override as necessary"""
913
 
        os.close(pipe)
914
 
 
915
 
 
916
 
class IPv6_TCPServer(ForkingMixInWithPipe,
 
1725
        raise NotImplementedError
 
1726
 
 
1727
 
 
1728
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
917
1729
                     socketserver.TCPServer, object):
918
1730
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
919
1731
    
935
1747
        bind to an address or port if they were not specified."""
936
1748
        if self.interface is not None:
937
1749
            if SO_BINDTODEVICE is None:
938
 
                logger.error(u"SO_BINDTODEVICE does not exist;"
939
 
                             u" cannot bind to interface %s",
 
1750
                logger.error("SO_BINDTODEVICE does not exist;"
 
1751
                             " cannot bind to interface %s",
940
1752
                             self.interface)
941
1753
            else:
942
1754
                try:
943
1755
                    self.socket.setsockopt(socket.SOL_SOCKET,
944
1756
                                           SO_BINDTODEVICE,
945
1757
                                           str(self.interface
946
 
                                               + u'\0'))
947
 
                except socket.error, error:
 
1758
                                               + '\0'))
 
1759
                except socket.error as error:
948
1760
                    if error[0] == errno.EPERM:
949
 
                        logger.error(u"No permission to"
950
 
                                     u" bind to interface %s",
 
1761
                        logger.error("No permission to"
 
1762
                                     " bind to interface %s",
951
1763
                                     self.interface)
952
1764
                    elif error[0] == errno.ENOPROTOOPT:
953
 
                        logger.error(u"SO_BINDTODEVICE not available;"
954
 
                                     u" cannot bind to interface %s",
 
1765
                        logger.error("SO_BINDTODEVICE not available;"
 
1766
                                     " cannot bind to interface %s",
955
1767
                                     self.interface)
956
1768
                    else:
957
1769
                        raise
959
1771
        if self.server_address[0] or self.server_address[1]:
960
1772
            if not self.server_address[0]:
961
1773
                if self.address_family == socket.AF_INET6:
962
 
                    any_address = u"::" # in6addr_any
 
1774
                    any_address = "::" # in6addr_any
963
1775
                else:
964
1776
                    any_address = socket.INADDR_ANY
965
1777
                self.server_address = (any_address,
983
1795
        clients:        set of Client objects
984
1796
        gnutls_priority GnuTLS priority string
985
1797
        use_dbus:       Boolean; to emit D-Bus signals or not
986
 
        clients:        set of Client objects
987
 
        gnutls_priority GnuTLS priority string
988
 
        use_dbus:       Boolean; to emit D-Bus signals or not
989
1798
    
990
1799
    Assumes a gobject.MainLoop event loop.
991
1800
    """
995
1804
        self.enabled = False
996
1805
        self.clients = clients
997
1806
        if self.clients is None:
998
 
            self.clients = set()
 
1807
            self.clients = {}
999
1808
        self.use_dbus = use_dbus
1000
1809
        self.gnutls_priority = gnutls_priority
1001
1810
        IPv6_TCPServer.__init__(self, server_address,
1005
1814
    def server_activate(self):
1006
1815
        if self.enabled:
1007
1816
            return socketserver.TCPServer.server_activate(self)
 
1817
    
1008
1818
    def enable(self):
1009
1819
        self.enabled = True
1010
 
    def add_pipe(self, pipe):
 
1820
    
 
1821
    def add_pipe(self, parent_pipe, proc):
1011
1822
        # Call "handle_ipc" for both data and EOF events
1012
 
        gobject.io_add_watch(pipe, gobject.IO_IN | gobject.IO_HUP,
1013
 
                             self.handle_ipc)
1014
 
    def handle_ipc(self, source, condition, file_objects={}):
 
1823
        gobject.io_add_watch(parent_pipe.fileno(),
 
1824
                             gobject.IO_IN | gobject.IO_HUP,
 
1825
                             functools.partial(self.handle_ipc,
 
1826
                                               parent_pipe =
 
1827
                                               parent_pipe,
 
1828
                                               proc = proc))
 
1829
    
 
1830
    def handle_ipc(self, source, condition, parent_pipe=None,
 
1831
                   proc = None, client_object=None):
1015
1832
        condition_names = {
1016
 
            gobject.IO_IN: u"IN",   # There is data to read.
1017
 
            gobject.IO_OUT: u"OUT", # Data can be written (without
 
1833
            gobject.IO_IN: "IN",   # There is data to read.
 
1834
            gobject.IO_OUT: "OUT", # Data can be written (without
1018
1835
                                    # blocking).
1019
 
            gobject.IO_PRI: u"PRI", # There is urgent data to read.
1020
 
            gobject.IO_ERR: u"ERR", # Error condition.
1021
 
            gobject.IO_HUP: u"HUP"  # Hung up (the connection has been
 
1836
            gobject.IO_PRI: "PRI", # There is urgent data to read.
 
1837
            gobject.IO_ERR: "ERR", # Error condition.
 
1838
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
1022
1839
                                    # broken, usually for pipes and
1023
1840
                                    # sockets).
1024
1841
            }
1026
1843
                                       for cond, name in
1027
1844
                                       condition_names.iteritems()
1028
1845
                                       if cond & condition)
1029
 
        logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
1030
 
                     conditions_string)
1031
 
        
1032
 
        # Turn the pipe file descriptor into a Python file object
1033
 
        if source not in file_objects:
1034
 
            file_objects[source] = os.fdopen(source, u"r", 1)
1035
 
        
1036
 
        # Read a line from the file object
1037
 
        cmdline = file_objects[source].readline()
1038
 
        if not cmdline:             # Empty line means end of file
1039
 
            # close the IPC pipe
1040
 
            file_objects[source].close()
1041
 
            del file_objects[source]
1042
 
            
1043
 
            # Stop calling this function
1044
 
            return False
1045
 
        
1046
 
        logger.debug(u"IPC command: %r", cmdline)
1047
 
        
1048
 
        # Parse and act on command
1049
 
        cmd, args = cmdline.rstrip(u"\r\n").split(None, 1)
1050
 
        
1051
 
        if cmd == u"NOTFOUND":
1052
 
            logger.warning(u"Client not found for fingerprint: %s",
1053
 
                           args)
1054
 
            if self.use_dbus:
1055
 
                # Emit D-Bus signal
1056
 
                mandos_dbus_service.ClientNotFound(args)
1057
 
        elif cmd == u"INVALID":
1058
 
            for client in self.clients:
1059
 
                if client.name == args:
1060
 
                    logger.warning(u"Client %s is invalid", args)
1061
 
                    if self.use_dbus:
1062
 
                        # Emit D-Bus signal
1063
 
                        client.Rejected()
1064
 
                    break
1065
 
            else:
1066
 
                logger.error(u"Unknown client %s is invalid", args)
1067
 
        elif cmd == u"SENDING":
1068
 
            for client in self.clients:
1069
 
                if client.name == args:
1070
 
                    logger.info(u"Sending secret to %s", client.name)
1071
 
                    client.checked_ok()
1072
 
                    if self.use_dbus:
1073
 
                        # Emit D-Bus signal
1074
 
                        client.ReceivedSecret()
1075
 
                    break
1076
 
            else:
1077
 
                logger.error(u"Sending secret to unknown client %s",
1078
 
                             args)
1079
 
        else:
1080
 
            logger.error(u"Unknown IPC command: %r", cmdline)
1081
 
        
1082
 
        # Keep calling this function
 
1846
        # error, or the other end of multiprocessing.Pipe has closed
 
1847
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
 
1848
            # Wait for other process to exit
 
1849
            proc.join()
 
1850
            return False
 
1851
        
 
1852
        # Read a request from the child
 
1853
        request = parent_pipe.recv()
 
1854
        command = request[0]
 
1855
        
 
1856
        if command == 'init':
 
1857
            fpr = request[1]
 
1858
            address = request[2]
 
1859
            
 
1860
            for c in self.clients.itervalues():
 
1861
                if c.fingerprint == fpr:
 
1862
                    client = c
 
1863
                    break
 
1864
            else:
 
1865
                logger.info("Client not found for fingerprint: %s, ad"
 
1866
                            "dress: %s", fpr, address)
 
1867
                if self.use_dbus:
 
1868
                    # Emit D-Bus signal
 
1869
                    mandos_dbus_service.ClientNotFound(fpr,
 
1870
                                                       address[0])
 
1871
                parent_pipe.send(False)
 
1872
                return False
 
1873
            
 
1874
            gobject.io_add_watch(parent_pipe.fileno(),
 
1875
                                 gobject.IO_IN | gobject.IO_HUP,
 
1876
                                 functools.partial(self.handle_ipc,
 
1877
                                                   parent_pipe =
 
1878
                                                   parent_pipe,
 
1879
                                                   proc = proc,
 
1880
                                                   client_object =
 
1881
                                                   client))
 
1882
            parent_pipe.send(True)
 
1883
            # remove the old hook in favor of the new above hook on
 
1884
            # same fileno
 
1885
            return False
 
1886
        if command == 'funcall':
 
1887
            funcname = request[1]
 
1888
            args = request[2]
 
1889
            kwargs = request[3]
 
1890
            
 
1891
            parent_pipe.send(('data', getattr(client_object,
 
1892
                                              funcname)(*args,
 
1893
                                                         **kwargs)))
 
1894
        
 
1895
        if command == 'getattr':
 
1896
            attrname = request[1]
 
1897
            if callable(client_object.__getattribute__(attrname)):
 
1898
                parent_pipe.send(('function',))
 
1899
            else:
 
1900
                parent_pipe.send(('data', client_object
 
1901
                                  .__getattribute__(attrname)))
 
1902
        
 
1903
        if command == 'setattr':
 
1904
            attrname = request[1]
 
1905
            value = request[2]
 
1906
            setattr(client_object, attrname, value)
 
1907
        
1083
1908
        return True
1084
1909
 
1085
1910
 
1086
1911
def string_to_delta(interval):
1087
1912
    """Parse a string and return a datetime.timedelta
1088
1913
    
1089
 
    >>> string_to_delta(u'7d')
 
1914
    >>> string_to_delta('7d')
1090
1915
    datetime.timedelta(7)
1091
 
    >>> string_to_delta(u'60s')
 
1916
    >>> string_to_delta('60s')
1092
1917
    datetime.timedelta(0, 60)
1093
 
    >>> string_to_delta(u'60m')
 
1918
    >>> string_to_delta('60m')
1094
1919
    datetime.timedelta(0, 3600)
1095
 
    >>> string_to_delta(u'24h')
 
1920
    >>> string_to_delta('24h')
1096
1921
    datetime.timedelta(1)
1097
 
    >>> string_to_delta(u'1w')
 
1922
    >>> string_to_delta('1w')
1098
1923
    datetime.timedelta(7)
1099
 
    >>> string_to_delta(u'5m 30s')
 
1924
    >>> string_to_delta('5m 30s')
1100
1925
    datetime.timedelta(0, 330)
1101
1926
    """
1102
1927
    timevalue = datetime.timedelta(0)
1104
1929
        try:
1105
1930
            suffix = unicode(s[-1])
1106
1931
            value = int(s[:-1])
1107
 
            if suffix == u"d":
 
1932
            if suffix == "d":
1108
1933
                delta = datetime.timedelta(value)
1109
 
            elif suffix == u"s":
 
1934
            elif suffix == "s":
1110
1935
                delta = datetime.timedelta(0, value)
1111
 
            elif suffix == u"m":
 
1936
            elif suffix == "m":
1112
1937
                delta = datetime.timedelta(0, 0, 0, 0, value)
1113
 
            elif suffix == u"h":
 
1938
            elif suffix == "h":
1114
1939
                delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1115
 
            elif suffix == u"w":
 
1940
            elif suffix == "w":
1116
1941
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1117
1942
            else:
1118
 
                raise ValueError
1119
 
        except (ValueError, IndexError):
1120
 
            raise ValueError
 
1943
                raise ValueError("Unknown suffix %r" % suffix)
 
1944
        except (ValueError, IndexError) as e:
 
1945
            raise ValueError(*(e.args))
1121
1946
        timevalue += delta
1122
1947
    return timevalue
1123
1948
 
1124
1949
 
1125
 
def if_nametoindex(interface):
1126
 
    """Call the C function if_nametoindex(), or equivalent
1127
 
    
1128
 
    Note: This function cannot accept a unicode string."""
1129
 
    global if_nametoindex
1130
 
    try:
1131
 
        if_nametoindex = (ctypes.cdll.LoadLibrary
1132
 
                          (ctypes.util.find_library(u"c"))
1133
 
                          .if_nametoindex)
1134
 
    except (OSError, AttributeError):
1135
 
        logger.warning(u"Doing if_nametoindex the hard way")
1136
 
        def if_nametoindex(interface):
1137
 
            "Get an interface index the hard way, i.e. using fcntl()"
1138
 
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
1139
 
            with closing(socket.socket()) as s:
1140
 
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1141
 
                                    struct.pack(str(u"16s16x"),
1142
 
                                                interface))
1143
 
            interface_index = struct.unpack(str(u"I"),
1144
 
                                            ifreq[16:20])[0]
1145
 
            return interface_index
1146
 
    return if_nametoindex(interface)
1147
 
 
1148
 
 
1149
1950
def daemon(nochdir = False, noclose = False):
1150
1951
    """See daemon(3).  Standard BSD Unix function.
1151
1952
    
1154
1955
        sys.exit()
1155
1956
    os.setsid()
1156
1957
    if not nochdir:
1157
 
        os.chdir(u"/")
 
1958
        os.chdir("/")
1158
1959
    if os.fork():
1159
1960
        sys.exit()
1160
1961
    if not noclose:
1162
1963
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1163
1964
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1164
1965
            raise OSError(errno.ENODEV,
1165
 
                          u"/dev/null not a character device")
 
1966
                          "%s not a character device"
 
1967
                          % os.path.devnull)
1166
1968
        os.dup2(null, sys.stdin.fileno())
1167
1969
        os.dup2(null, sys.stdout.fileno())
1168
1970
        os.dup2(null, sys.stderr.fileno())
1172
1974
 
1173
1975
def main():
1174
1976
    
1175
 
    ######################################################################
 
1977
    ##################################################################
1176
1978
    # Parsing of options, both command line and config file
1177
1979
    
1178
 
    parser = optparse.OptionParser(version = "%%prog %s" % version)
1179
 
    parser.add_option("-i", u"--interface", type=u"string",
1180
 
                      metavar="IF", help=u"Bind to interface IF")
1181
 
    parser.add_option("-a", u"--address", type=u"string",
1182
 
                      help=u"Address to listen for requests on")
1183
 
    parser.add_option("-p", u"--port", type=u"int",
1184
 
                      help=u"Port number to receive requests on")
1185
 
    parser.add_option("--check", action=u"store_true",
1186
 
                      help=u"Run self-test")
1187
 
    parser.add_option("--debug", action=u"store_true",
1188
 
                      help=u"Debug mode; run in foreground and log to"
1189
 
                      u" terminal")
1190
 
    parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1191
 
                      u" priority string (see GnuTLS documentation)")
1192
 
    parser.add_option("--servicename", type=u"string",
1193
 
                      metavar=u"NAME", help=u"Zeroconf service name")
1194
 
    parser.add_option("--configdir", type=u"string",
1195
 
                      default=u"/etc/mandos", metavar=u"DIR",
1196
 
                      help=u"Directory to search for configuration"
1197
 
                      u" files")
1198
 
    parser.add_option("--no-dbus", action=u"store_false",
1199
 
                      dest=u"use_dbus", help=u"Do not provide D-Bus"
1200
 
                      u" system bus interface")
1201
 
    parser.add_option("--no-ipv6", action=u"store_false",
1202
 
                      dest=u"use_ipv6", help=u"Do not use IPv6")
1203
 
    options = parser.parse_args()[0]
 
1980
    parser = argparse.ArgumentParser()
 
1981
    parser.add_argument("-v", "--version", action="version",
 
1982
                        version = "%%(prog)s %s" % version,
 
1983
                        help="show version number and exit")
 
1984
    parser.add_argument("-i", "--interface", metavar="IF",
 
1985
                        help="Bind to interface IF")
 
1986
    parser.add_argument("-a", "--address",
 
1987
                        help="Address to listen for requests on")
 
1988
    parser.add_argument("-p", "--port", type=int,
 
1989
                        help="Port number to receive requests on")
 
1990
    parser.add_argument("--check", action="store_true",
 
1991
                        help="Run self-test")
 
1992
    parser.add_argument("--debug", action="store_true",
 
1993
                        help="Debug mode; run in foreground and log"
 
1994
                        " to terminal")
 
1995
    parser.add_argument("--debuglevel", metavar="LEVEL",
 
1996
                        help="Debug level for stdout output")
 
1997
    parser.add_argument("--priority", help="GnuTLS"
 
1998
                        " priority string (see GnuTLS documentation)")
 
1999
    parser.add_argument("--servicename",
 
2000
                        metavar="NAME", help="Zeroconf service name")
 
2001
    parser.add_argument("--configdir",
 
2002
                        default="/etc/mandos", metavar="DIR",
 
2003
                        help="Directory to search for configuration"
 
2004
                        " files")
 
2005
    parser.add_argument("--no-dbus", action="store_false",
 
2006
                        dest="use_dbus", help="Do not provide D-Bus"
 
2007
                        " system bus interface")
 
2008
    parser.add_argument("--no-ipv6", action="store_false",
 
2009
                        dest="use_ipv6", help="Do not use IPv6")
 
2010
    parser.add_argument("--no-restore", action="store_false",
 
2011
                        dest="restore", help="Do not restore stored"
 
2012
                        " state")
 
2013
    parser.add_argument("--statedir", metavar="DIR",
 
2014
                        help="Directory to save/restore state in")
 
2015
    
 
2016
    options = parser.parse_args()
1204
2017
    
1205
2018
    if options.check:
1206
2019
        import doctest
1208
2021
        sys.exit()
1209
2022
    
1210
2023
    # Default values for config file for server-global settings
1211
 
    server_defaults = { u"interface": u"",
1212
 
                        u"address": u"",
1213
 
                        u"port": u"",
1214
 
                        u"debug": u"False",
1215
 
                        u"priority":
1216
 
                        u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1217
 
                        u"servicename": u"Mandos",
1218
 
                        u"use_dbus": u"True",
1219
 
                        u"use_ipv6": u"True",
 
2024
    server_defaults = { "interface": "",
 
2025
                        "address": "",
 
2026
                        "port": "",
 
2027
                        "debug": "False",
 
2028
                        "priority":
 
2029
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
2030
                        "servicename": "Mandos",
 
2031
                        "use_dbus": "True",
 
2032
                        "use_ipv6": "True",
 
2033
                        "debuglevel": "",
 
2034
                        "restore": "True",
 
2035
                        "statedir": "/var/lib/mandos"
1220
2036
                        }
1221
2037
    
1222
2038
    # Parse config file for server-global settings
1223
2039
    server_config = configparser.SafeConfigParser(server_defaults)
1224
2040
    del server_defaults
1225
2041
    server_config.read(os.path.join(options.configdir,
1226
 
                                    u"mandos.conf"))
 
2042
                                    "mandos.conf"))
1227
2043
    # Convert the SafeConfigParser object to a dict
1228
2044
    server_settings = server_config.defaults()
1229
2045
    # Use the appropriate methods on the non-string config options
1230
 
    for option in (u"debug", u"use_dbus", u"use_ipv6"):
1231
 
        server_settings[option] = server_config.getboolean(u"DEFAULT",
 
2046
    for option in ("debug", "use_dbus", "use_ipv6"):
 
2047
        server_settings[option] = server_config.getboolean("DEFAULT",
1232
2048
                                                           option)
1233
2049
    if server_settings["port"]:
1234
 
        server_settings["port"] = server_config.getint(u"DEFAULT",
1235
 
                                                       u"port")
 
2050
        server_settings["port"] = server_config.getint("DEFAULT",
 
2051
                                                       "port")
1236
2052
    del server_config
1237
2053
    
1238
2054
    # Override the settings from the config file with command line
1239
2055
    # options, if set.
1240
 
    for option in (u"interface", u"address", u"port", u"debug",
1241
 
                   u"priority", u"servicename", u"configdir",
1242
 
                   u"use_dbus", u"use_ipv6"):
 
2056
    for option in ("interface", "address", "port", "debug",
 
2057
                   "priority", "servicename", "configdir",
 
2058
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
 
2059
                   "statedir"):
1243
2060
        value = getattr(options, option)
1244
2061
        if value is not None:
1245
2062
            server_settings[option] = value
1253
2070
    ##################################################################
1254
2071
    
1255
2072
    # For convenience
1256
 
    debug = server_settings[u"debug"]
1257
 
    use_dbus = server_settings[u"use_dbus"]
1258
 
    use_ipv6 = server_settings[u"use_ipv6"]
1259
 
    
1260
 
    if not debug:
1261
 
        syslogger.setLevel(logging.WARNING)
1262
 
        console.setLevel(logging.WARNING)
1263
 
    
1264
 
    if server_settings[u"servicename"] != u"Mandos":
 
2073
    debug = server_settings["debug"]
 
2074
    debuglevel = server_settings["debuglevel"]
 
2075
    use_dbus = server_settings["use_dbus"]
 
2076
    use_ipv6 = server_settings["use_ipv6"]
 
2077
    stored_state_path = os.path.join(server_settings["statedir"],
 
2078
                                     stored_state_file)
 
2079
    
 
2080
    if debug:
 
2081
        initlogger(logging.DEBUG)
 
2082
    else:
 
2083
        if not debuglevel:
 
2084
            initlogger()
 
2085
        else:
 
2086
            level = getattr(logging, debuglevel.upper())
 
2087
            initlogger(level)
 
2088
    
 
2089
    if server_settings["servicename"] != "Mandos":
1265
2090
        syslogger.setFormatter(logging.Formatter
1266
 
                               (u'Mandos (%s) [%%(process)d]:'
1267
 
                                u' %%(levelname)s: %%(message)s'
1268
 
                                % server_settings[u"servicename"]))
 
2091
                               ('Mandos (%s) [%%(process)d]:'
 
2092
                                ' %%(levelname)s: %%(message)s'
 
2093
                                % server_settings["servicename"]))
1269
2094
    
1270
2095
    # Parse config file with clients
1271
 
    client_defaults = { u"timeout": u"1h",
1272
 
                        u"interval": u"5m",
1273
 
                        u"checker": u"fping -q -- %%(host)s",
1274
 
                        u"host": u"",
1275
 
                        }
1276
 
    client_config = configparser.SafeConfigParser(client_defaults)
1277
 
    client_config.read(os.path.join(server_settings[u"configdir"],
1278
 
                                    u"clients.conf"))
 
2096
    client_config = configparser.SafeConfigParser(Client.client_defaults)
 
2097
    client_config.read(os.path.join(server_settings["configdir"],
 
2098
                                    "clients.conf"))
1279
2099
    
1280
2100
    global mandos_dbus_service
1281
2101
    mandos_dbus_service = None
1282
2102
    
1283
 
    tcp_server = MandosServer((server_settings[u"address"],
1284
 
                               server_settings[u"port"]),
 
2103
    tcp_server = MandosServer((server_settings["address"],
 
2104
                               server_settings["port"]),
1285
2105
                              ClientHandler,
1286
 
                              interface=server_settings[u"interface"],
 
2106
                              interface=(server_settings["interface"]
 
2107
                                         or None),
1287
2108
                              use_ipv6=use_ipv6,
1288
2109
                              gnutls_priority=
1289
 
                              server_settings[u"priority"],
 
2110
                              server_settings["priority"],
1290
2111
                              use_dbus=use_dbus)
1291
 
    pidfilename = u"/var/run/mandos.pid"
1292
 
    try:
1293
 
        pidfile = open(pidfilename, u"w")
1294
 
    except IOError:
1295
 
        logger.error(u"Could not open file %r", pidfilename)
 
2112
    if not debug:
 
2113
        pidfilename = "/var/run/mandos.pid"
 
2114
        try:
 
2115
            pidfile = open(pidfilename, "w")
 
2116
        except IOError:
 
2117
            logger.error("Could not open file %r", pidfilename)
1296
2118
    
1297
2119
    try:
1298
 
        uid = pwd.getpwnam(u"_mandos").pw_uid
1299
 
        gid = pwd.getpwnam(u"_mandos").pw_gid
 
2120
        uid = pwd.getpwnam("_mandos").pw_uid
 
2121
        gid = pwd.getpwnam("_mandos").pw_gid
1300
2122
    except KeyError:
1301
2123
        try:
1302
 
            uid = pwd.getpwnam(u"mandos").pw_uid
1303
 
            gid = pwd.getpwnam(u"mandos").pw_gid
 
2124
            uid = pwd.getpwnam("mandos").pw_uid
 
2125
            gid = pwd.getpwnam("mandos").pw_gid
1304
2126
        except KeyError:
1305
2127
            try:
1306
 
                uid = pwd.getpwnam(u"nobody").pw_uid
1307
 
                gid = pwd.getpwnam(u"nobody").pw_gid
 
2128
                uid = pwd.getpwnam("nobody").pw_uid
 
2129
                gid = pwd.getpwnam("nobody").pw_gid
1308
2130
            except KeyError:
1309
2131
                uid = 65534
1310
2132
                gid = 65534
1311
2133
    try:
1312
2134
        os.setgid(gid)
1313
2135
        os.setuid(uid)
1314
 
    except OSError, error:
 
2136
    except OSError as error:
1315
2137
        if error[0] != errno.EPERM:
1316
2138
            raise error
1317
2139
    
1318
 
    # Enable all possible GnuTLS debugging
1319
2140
    if debug:
 
2141
        # Enable all possible GnuTLS debugging
 
2142
        
1320
2143
        # "Use a log level over 10 to enable all debugging options."
1321
2144
        # - GnuTLS manual
1322
2145
        gnutls.library.functions.gnutls_global_set_log_level(11)
1323
2146
        
1324
2147
        @gnutls.library.types.gnutls_log_func
1325
2148
        def debug_gnutls(level, string):
1326
 
            logger.debug(u"GnuTLS: %s", string[:-1])
 
2149
            logger.debug("GnuTLS: %s", string[:-1])
1327
2150
        
1328
2151
        (gnutls.library.functions
1329
2152
         .gnutls_global_set_log_function(debug_gnutls))
 
2153
        
 
2154
        # Redirect stdin so all checkers get /dev/null
 
2155
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2156
        os.dup2(null, sys.stdin.fileno())
 
2157
        if null > 2:
 
2158
            os.close(null)
 
2159
    else:
 
2160
        # No console logging
 
2161
        logger.removeHandler(console)
 
2162
    
 
2163
    # Need to fork before connecting to D-Bus
 
2164
    if not debug:
 
2165
        # Close all input and output, do double fork, etc.
 
2166
        daemon()
1330
2167
    
1331
2168
    global main_loop
1332
2169
    # From the Avahi example code
1335
2172
    bus = dbus.SystemBus()
1336
2173
    # End of Avahi example code
1337
2174
    if use_dbus:
1338
 
        bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos", bus)
 
2175
        try:
 
2176
            bus_name = dbus.service.BusName("se.recompile.Mandos",
 
2177
                                            bus, do_not_queue=True)
 
2178
            old_bus_name = (dbus.service.BusName
 
2179
                            ("se.bsnet.fukt.Mandos", bus,
 
2180
                             do_not_queue=True))
 
2181
        except dbus.exceptions.NameExistsException as e:
 
2182
            logger.error(unicode(e) + ", disabling D-Bus")
 
2183
            use_dbus = False
 
2184
            server_settings["use_dbus"] = False
 
2185
            tcp_server.use_dbus = False
1339
2186
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1340
 
    service = AvahiService(name = server_settings[u"servicename"],
1341
 
                           servicetype = u"_mandos._tcp",
1342
 
                           protocol = protocol, bus = bus)
 
2187
    service = AvahiServiceToSyslog(name =
 
2188
                                   server_settings["servicename"],
 
2189
                                   servicetype = "_mandos._tcp",
 
2190
                                   protocol = protocol, bus = bus)
1343
2191
    if server_settings["interface"]:
1344
2192
        service.interface = (if_nametoindex
1345
 
                             (str(server_settings[u"interface"])))
 
2193
                             (str(server_settings["interface"])))
 
2194
    
 
2195
    global multiprocessing_manager
 
2196
    multiprocessing_manager = multiprocessing.Manager()
1346
2197
    
1347
2198
    client_class = Client
1348
2199
    if use_dbus:
1349
 
        client_class = functools.partial(ClientDBus, bus = bus)
1350
 
    tcp_server.clients.update(set(
1351
 
            client_class(name = section,
1352
 
                         config= dict(client_config.items(section)))
1353
 
            for section in client_config.sections()))
 
2200
        client_class = functools.partial(ClientDBusTransitional,
 
2201
                                         bus = bus)
 
2202
    
 
2203
    client_settings = Client.config_parser(client_config)
 
2204
    old_client_settings = {}
 
2205
    clients_data = {}
 
2206
    
 
2207
    # Get client data and settings from last running state.
 
2208
    if server_settings["restore"]:
 
2209
        try:
 
2210
            with open(stored_state_path, "rb") as stored_state:
 
2211
                clients_data, old_client_settings = (pickle.load
 
2212
                                                     (stored_state))
 
2213
            os.remove(stored_state_path)
 
2214
        except IOError as e:
 
2215
            logger.warning("Could not load persistent state: {0}"
 
2216
                           .format(e))
 
2217
            if e.errno != errno.ENOENT:
 
2218
                raise
 
2219
    
 
2220
    with PGPEngine() as pgp:
 
2221
        for client_name, client in clients_data.iteritems():
 
2222
            # Decide which value to use after restoring saved state.
 
2223
            # We have three different values: Old config file,
 
2224
            # new config file, and saved state.
 
2225
            # New config value takes precedence if it differs from old
 
2226
            # config value, otherwise use saved state.
 
2227
            for name, value in client_settings[client_name].items():
 
2228
                try:
 
2229
                    # For each value in new config, check if it
 
2230
                    # differs from the old config value (Except for
 
2231
                    # the "secret" attribute)
 
2232
                    if (name != "secret" and
 
2233
                        value != old_client_settings[client_name]
 
2234
                        [name]):
 
2235
                        client[name] = value
 
2236
                except KeyError:
 
2237
                    pass
 
2238
            
 
2239
            # Clients who has passed its expire date can still be
 
2240
            # enabled if its last checker was successful.  Clients
 
2241
            # whose checker failed before we stored its state is
 
2242
            # assumed to have failed all checkers during downtime.
 
2243
            if client["enabled"]:
 
2244
                if datetime.datetime.utcnow() >= client["expires"]:
 
2245
                    if not client["last_checked_ok"]:
 
2246
                        logger.warning(
 
2247
                            "disabling client {0} - Client never "
 
2248
                            "performed a successfull checker"
 
2249
                            .format(client["name"]))
 
2250
                        client["enabled"] = False
 
2251
                    elif client["last_checker_status"] != 0:
 
2252
                        logger.warning(
 
2253
                            "disabling client {0} - Client "
 
2254
                            "last checker failed with error code {1}"
 
2255
                            .format(client["name"],
 
2256
                                    client["last_checker_status"]))
 
2257
                        client["enabled"] = False
 
2258
                    else:
 
2259
                        client["expires"] = (datetime.datetime
 
2260
                                             .utcnow()
 
2261
                                             + client["timeout"])
 
2262
                    
 
2263
            try:
 
2264
                client["secret"] = (
 
2265
                    pgp.decrypt(client["encrypted_secret"],
 
2266
                                client_settings[client_name]
 
2267
                                ["secret"]))
 
2268
            except PGPError:
 
2269
                # If decryption fails, we use secret from new settings
 
2270
                logger.debug("Failed to decrypt {0} old secret"
 
2271
                             .format(client_name))
 
2272
                client["secret"] = (
 
2273
                    client_settings[client_name]["secret"])
 
2274
 
 
2275
    
 
2276
    # Add/remove clients based on new changes made to config
 
2277
    for client_name in set(old_client_settings) - set(client_settings):
 
2278
        del clients_data[client_name]
 
2279
    for client_name in set(client_settings) - set(old_client_settings):
 
2280
        clients_data[client_name] = client_settings[client_name]
 
2281
 
 
2282
    # Create clients all clients
 
2283
    for client_name, client in clients_data.iteritems():
 
2284
        tcp_server.clients[client_name] = client_class(
 
2285
            name = client_name, settings = client)
 
2286
    
1354
2287
    if not tcp_server.clients:
1355
 
        logger.warning(u"No clients defined")
1356
 
    
1357
 
    if debug:
1358
 
        # Redirect stdin so all checkers get /dev/null
1359
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1360
 
        os.dup2(null, sys.stdin.fileno())
1361
 
        if null > 2:
1362
 
            os.close(null)
1363
 
    else:
1364
 
        # No console logging
1365
 
        logger.removeHandler(console)
1366
 
        # Close all input and output, do double fork, etc.
1367
 
        daemon()
1368
 
    
1369
 
    try:
1370
 
        with closing(pidfile):
1371
 
            pid = os.getpid()
1372
 
            pidfile.write(str(pid) + "\n")
1373
 
        del pidfile
1374
 
    except IOError:
1375
 
        logger.error(u"Could not write to file %r with PID %d",
1376
 
                     pidfilename, pid)
1377
 
    except NameError:
1378
 
        # "pidfile" was never created
1379
 
        pass
1380
 
    del pidfilename
1381
 
    
1382
 
    def cleanup():
1383
 
        "Cleanup function; run on exit"
1384
 
        service.cleanup()
 
2288
        logger.warning("No clients defined")
1385
2289
        
1386
 
        while tcp_server.clients:
1387
 
            client = tcp_server.clients.pop()
1388
 
            client.disable_hook = None
1389
 
            client.disable()
1390
 
    
1391
 
    atexit.register(cleanup)
1392
 
    
1393
2290
    if not debug:
 
2291
        try:
 
2292
            with pidfile:
 
2293
                pid = os.getpid()
 
2294
                pidfile.write(str(pid) + "\n".encode("utf-8"))
 
2295
            del pidfile
 
2296
        except IOError:
 
2297
            logger.error("Could not write to file %r with PID %d",
 
2298
                         pidfilename, pid)
 
2299
        except NameError:
 
2300
            # "pidfile" was never created
 
2301
            pass
 
2302
        del pidfilename
1394
2303
        signal.signal(signal.SIGINT, signal.SIG_IGN)
 
2304
    
1395
2305
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1396
2306
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1397
2307
    
1399
2309
        class MandosDBusService(dbus.service.Object):
1400
2310
            """A D-Bus proxy object"""
1401
2311
            def __init__(self):
1402
 
                dbus.service.Object.__init__(self, bus, u"/")
1403
 
            _interface = u"se.bsnet.fukt.Mandos"
1404
 
            
1405
 
            @dbus.service.signal(_interface, signature=u"oa{sv}")
1406
 
            def ClientAdded(self, objpath, properties):
1407
 
                "D-Bus signal"
1408
 
                pass
1409
 
            
1410
 
            @dbus.service.signal(_interface, signature=u"s")
1411
 
            def ClientNotFound(self, fingerprint):
1412
 
                "D-Bus signal"
1413
 
                pass
1414
 
            
1415
 
            @dbus.service.signal(_interface, signature=u"os")
 
2312
                dbus.service.Object.__init__(self, bus, "/")
 
2313
            _interface = "se.recompile.Mandos"
 
2314
            
 
2315
            @dbus.service.signal(_interface, signature="o")
 
2316
            def ClientAdded(self, objpath):
 
2317
                "D-Bus signal"
 
2318
                pass
 
2319
            
 
2320
            @dbus.service.signal(_interface, signature="ss")
 
2321
            def ClientNotFound(self, fingerprint, address):
 
2322
                "D-Bus signal"
 
2323
                pass
 
2324
            
 
2325
            @dbus.service.signal(_interface, signature="os")
1416
2326
            def ClientRemoved(self, objpath, name):
1417
2327
                "D-Bus signal"
1418
2328
                pass
1419
2329
            
1420
 
            @dbus.service.method(_interface, out_signature=u"ao")
 
2330
            @dbus.service.method(_interface, out_signature="ao")
1421
2331
            def GetAllClients(self):
1422
2332
                "D-Bus method"
1423
2333
                return dbus.Array(c.dbus_object_path
1424
 
                                  for c in tcp_server.clients)
 
2334
                                  for c in
 
2335
                                  tcp_server.clients.itervalues())
1425
2336
            
1426
2337
            @dbus.service.method(_interface,
1427
 
                                 out_signature=u"a{oa{sv}}")
 
2338
                                 out_signature="a{oa{sv}}")
1428
2339
            def GetAllClientsWithProperties(self):
1429
2340
                "D-Bus method"
1430
2341
                return dbus.Dictionary(
1431
 
                    ((c.dbus_object_path, c.GetAllProperties())
1432
 
                     for c in tcp_server.clients),
1433
 
                    signature=u"oa{sv}")
 
2342
                    ((c.dbus_object_path, c.GetAll(""))
 
2343
                     for c in tcp_server.clients.itervalues()),
 
2344
                    signature="oa{sv}")
1434
2345
            
1435
 
            @dbus.service.method(_interface, in_signature=u"o")
 
2346
            @dbus.service.method(_interface, in_signature="o")
1436
2347
            def RemoveClient(self, object_path):
1437
2348
                "D-Bus method"
1438
 
                for c in tcp_server.clients:
 
2349
                for c in tcp_server.clients.itervalues():
1439
2350
                    if c.dbus_object_path == object_path:
1440
 
                        tcp_server.clients.remove(c)
 
2351
                        del tcp_server.clients[c.name]
1441
2352
                        c.remove_from_connection()
1442
2353
                        # Don't signal anything except ClientRemoved
1443
 
                        c.disable(signal=False)
 
2354
                        c.disable(quiet=True)
1444
2355
                        # Emit D-Bus signal
1445
2356
                        self.ClientRemoved(object_path, c.name)
1446
2357
                        return
1447
 
                raise KeyError
 
2358
                raise KeyError(object_path)
1448
2359
            
1449
2360
            del _interface
1450
2361
        
1451
 
        mandos_dbus_service = MandosDBusService()
1452
 
    
1453
 
    for client in tcp_server.clients:
 
2362
        class MandosDBusServiceTransitional(MandosDBusService):
 
2363
            __metaclass__ = AlternateDBusNamesMetaclass
 
2364
        mandos_dbus_service = MandosDBusServiceTransitional()
 
2365
    
 
2366
    def cleanup():
 
2367
        "Cleanup function; run on exit"
 
2368
        service.cleanup()
 
2369
        
 
2370
        multiprocessing.active_children()
 
2371
        if not (tcp_server.clients or client_settings):
 
2372
            return
 
2373
        
 
2374
        # Store client before exiting. Secrets are encrypted with key
 
2375
        # based on what config file has. If config file is
 
2376
        # removed/edited, old secret will thus be unrecovable.
 
2377
        clients = {}
 
2378
        with PGPEngine() as pgp:
 
2379
            for client in tcp_server.clients.itervalues():
 
2380
                key = client_settings[client.name]["secret"]
 
2381
                client.encrypted_secret = pgp.encrypt(client.secret,
 
2382
                                                      key)
 
2383
                client_dict = {}
 
2384
                
 
2385
                # A list of attributes that can not be pickled
 
2386
                # + secret.
 
2387
                exclude = set(("bus", "changedstate", "secret",
 
2388
                               "checker"))
 
2389
                for name, typ in (inspect.getmembers
 
2390
                                  (dbus.service.Object)):
 
2391
                    exclude.add(name)
 
2392
                
 
2393
                client_dict["encrypted_secret"] = (client
 
2394
                                                   .encrypted_secret)
 
2395
                for attr in client.client_structure:
 
2396
                    if attr not in exclude:
 
2397
                        client_dict[attr] = getattr(client, attr)
 
2398
                
 
2399
                clients[client.name] = client_dict
 
2400
                del client_settings[client.name]["secret"]
 
2401
        
 
2402
        try:
 
2403
            with os.fdopen(os.open(stored_state_path,
 
2404
                                   os.O_CREAT|os.O_WRONLY|os.O_TRUNC,
 
2405
                                   0600), "wb") as stored_state:
 
2406
                pickle.dump((clients, client_settings), stored_state)
 
2407
        except (IOError, OSError) as e:
 
2408
            logger.warning("Could not save persistent state: {0}"
 
2409
                           .format(e))
 
2410
            if e.errno not in (errno.ENOENT, errno.EACCES):
 
2411
                raise
 
2412
        
 
2413
        # Delete all clients, and settings from config
 
2414
        while tcp_server.clients:
 
2415
            name, client = tcp_server.clients.popitem()
 
2416
            if use_dbus:
 
2417
                client.remove_from_connection()
 
2418
            # Don't signal anything except ClientRemoved
 
2419
            client.disable(quiet=True)
 
2420
            if use_dbus:
 
2421
                # Emit D-Bus signal
 
2422
                mandos_dbus_service.ClientRemoved(client
 
2423
                                                  .dbus_object_path,
 
2424
                                                  client.name)
 
2425
        client_settings.clear()
 
2426
    
 
2427
    atexit.register(cleanup)
 
2428
    
 
2429
    for client in tcp_server.clients.itervalues():
1454
2430
        if use_dbus:
1455
2431
            # Emit D-Bus signal
1456
 
            mandos_dbus_service.ClientAdded(client.dbus_object_path,
1457
 
                                            client.GetAllProperties())
1458
 
        client.enable()
 
2432
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
 
2433
        # Need to initiate checking of clients
 
2434
        if client.enabled:
 
2435
            client.init_checker()
1459
2436
    
1460
2437
    tcp_server.enable()
1461
2438
    tcp_server.server_activate()
1463
2440
    # Find out what port we got
1464
2441
    service.port = tcp_server.socket.getsockname()[1]
1465
2442
    if use_ipv6:
1466
 
        logger.info(u"Now listening on address %r, port %d,"
 
2443
        logger.info("Now listening on address %r, port %d,"
1467
2444
                    " flowinfo %d, scope_id %d"
1468
2445
                    % tcp_server.socket.getsockname())
1469
2446
    else:                       # IPv4
1470
 
        logger.info(u"Now listening on address %r, port %d"
 
2447
        logger.info("Now listening on address %r, port %d"
1471
2448
                    % tcp_server.socket.getsockname())
1472
2449
    
1473
2450
    #service.interface = tcp_server.socket.getsockname()[3]
1476
2453
        # From the Avahi example code
1477
2454
        try:
1478
2455
            service.activate()
1479
 
        except dbus.exceptions.DBusException, error:
1480
 
            logger.critical(u"DBusException: %s", error)
 
2456
        except dbus.exceptions.DBusException as error:
 
2457
            logger.critical("DBusException: %s", error)
 
2458
            cleanup()
1481
2459
            sys.exit(1)
1482
2460
        # End of Avahi example code
1483
2461
        
1486
2464
                             (tcp_server.handle_request
1487
2465
                              (*args[2:], **kwargs) or True))
1488
2466
        
1489
 
        logger.debug(u"Starting main loop")
 
2467
        logger.debug("Starting main loop")
1490
2468
        main_loop.run()
1491
 
    except AvahiError, error:
1492
 
        logger.critical(u"AvahiError: %s", error)
 
2469
    except AvahiError as error:
 
2470
        logger.critical("AvahiError: %s", error)
 
2471
        cleanup()
1493
2472
        sys.exit(1)
1494
2473
    except KeyboardInterrupt:
1495
2474
        if debug:
1496
 
            print >> sys.stderr
1497
 
        logger.debug(u"Server received KeyboardInterrupt")
1498
 
    logger.debug(u"Server exiting")
 
2475
            print("", file=sys.stderr)
 
2476
        logger.debug("Server received KeyboardInterrupt")
 
2477
    logger.debug("Server exiting")
 
2478
    # Must run before the D-Bus bus name gets deregistered
 
2479
    cleanup()
1499
2480
 
1500
2481
if __name__ == '__main__':
1501
2482
    main()