/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2016-02-21 14:24:01 UTC
  • Revision ID: teddy@recompile.se-20160221142401-j7glu6a2hg604d1e
Use AddressSanitizer and UndefinedBehaviorSanitizer.

* Makefile (SANITIZE): New; set to all sanitizing options depending on
                       GCC version.
  (CFLAGS): Added "$(SANITIZE)".

Show diffs side-by-side

added added

removed removed

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