/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

merge
new approve/deny functionallity in mandos-monitor

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