/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: teddy at bsnet
  • Date: 2010-08-23 19:23:15 UTC
  • mto: (24.1.154 mandos)
  • mto: This revision was merged to the branch mainline in revision 421.
  • Revision ID: teddy@fukt.bsnet.se-20100823192315-pefgye0l6cavcejs
* debian/control (mandos/Depends): Added "python-urwid".
* mandos (Client.approved_by_default): Changed default to "True".
  (Client.approved_delay): Changed default to "0s".
  (ClientDBus.GotSecret, ClientDBus.Rejected,
  ClientDBus.NeedApproval): Emit "PropertyChanged" signal for the
                            "approved_pending" property.

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