/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2014-03-01 09:39:25 UTC
  • Revision ID: teddy@recompile.se-20140301093925-0x6nwf21f0zljk6e
* debian/copyright: Change year to "2014".
* mandos-ctl: - '' -
* mandos-monitor: - '' -
* plugins.d/mandos-client.xml: - '' -

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