/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 at bsnet
  • Date: 2010-09-23 20:14:08 UTC
  • Revision ID: teddy@fukt.bsnet.se-20100923201408-4vcvjmml000fr8y5
* Makefile (DOCS): Added "plymouth.8mandos".
  (install-server): Also install "mandos-monitor.8" and
                    "mandos-ctl.8".
  (install-client-nokey): Also install "plymouth.8mandos".
  (uninstall-server): Also remove "mandos-monitor.8" and
                      "mandos-ctl.8".
  (uninstall-client): Also remove "plymouth.8mandos".
* plugins.d/plymouth.xml: New.

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