/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

Merge

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