/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2009-09-21 21:39:25 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090921213925-jbpt6tzu99otseng
Use D-Bus properties instead of our own methods.

* mandos (Client._datetime_to_milliseconds): Renamed to
                                             "_timedelta_to_milliseconds".
                                             All callers changed.
  (dbus_service_property): New decorator for D-Bus properties.
  (DBusPropertyException, DBusPropertyAccessException,
  DBusPropertyNotFound): New D-Bus exception classes.
  (DBusObjectWithProperties): New; extends "dbus.service.Object" with
                              support for properties.
  (ClientDBus): Inherit from, and call up to, "DBusObjectWithProperties".
  (ClientDBus.CheckedOK, ClientDBus.GetAllProperties,
  ClientDBus.SetChecker, ClientDBus.SetHost, ClientDBus.SetInterval,
  ClientDBus.SetSecret, ClientDBus.SetTimeout, ClientDBus.Enable,
  ClientDBus.StartChecker, ClientDBus.Disable,
  ClientDBus.StopChecker): Removed, replaced with properties.
  (ClientDBus.IsStillValid): Removed, superfluous.
  (ClientDBus.name_dbus_property,
  ClientDBus.fingerprint_dbus_property, ClientDBus.host_dbus_property,
  ClientDBus.created_dbus_property,
  ClientDBus.last_enabled_dbus_property,
  ClientDBus.enabled_dbus_property,
  ClientDBus.last_checked_ok_dbus_property,
  ClientDBus.timeout_dbus_property, ClientDBus.interval_dbus_property,
  ClientDBus.checker_dbus_property,
  ClientDBus.checker_running_dbus_property,
  ClientDBus.object_path_dbus_property,
  ClientDBus.secret_dbus_property): New D-Bus properties.

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