/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2008-08-27 01:18:25 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080827011825-ka3ni6xvy2ehi1y8
* .bzrignore: New.

* clients.conf ([foo]): Remove Radix-64 checksum.

* mandos (AvahiService.rename, server_state_changed,
          entry_group_state_changed): Make Avahi log messages more
                                      clear that they are about
                                      Zeroconf.
  (fingerprint): Use plain "0" instead of "ctypes.c_uint(0)".

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