/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2014-02-16 03:56:48 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 309.
  • Revision ID: teddy@recompile.se-20140216035648-i6rjq2mp8jicxudo
Allow self-tests to run without needing /dev/log.

* mandos (main): Only open /dev/log on initlogger() call.

Show diffs side-by-side

added added

removed removed

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