/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2013-10-20 15:25:09 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 305.
  • Revision ID: teddy@recompile.se-20131020152509-zkhuy2yse76w10hg
* Makefile (CFLAGS, LDFLAGS): Keep default flags from environment.
  (purge-server): PID file changed to "/run/mandos.pid".
* debian/compat: Changed to "9".
* debian/control (Standards-Version): Updated to "3.9.4".
  (DM-Upload-Allowed): Removed.
  (mandos/Depends): Add "initscripts (>= 2.88dsf-13.3)" to be able to
                    use the "/run" directory (for mandos.pid).
* debian/copyright (Copyright): Update year.
* init.d-mandos (PIDFILE): Changed to "/run/mandos.pid".
* mandos: Update copyright year.
  (pidfilename): Changed to "/run/mandos.pid".
* mandos-clients.conf.xml (OPTIONS/approval_delay): Bug fix: default
                                                    is "PT0S" - using
                                                    the new RFC 3339
                                                    duration syntax.
* mandos-keygen: Update copyright year.
* mandos-monitor: - '' -
* mandos.conf.xml: - '' -
* mandos.xml: - '' -
  (FILES): PID file changed to "/run/mandos.pid".
* plugin-runner.c: Update copyright year.
* plugins.d/mandos-client.c: - '' -
* plugins.d/mandos-client.xml: - '' -
* plugins.d/password-prompt.c: - '' -
* plugins.d/plymouth.c: - '' -

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