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