/mandos/release

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

« back to all changes in this revision

Viewing changes to server.py

  • Committer: Teddy Hogeborn
  • Date: 2008-08-01 06:33:15 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080801063315-4k33q3ek28hjc3tu
* plugins.d/plugbasedclient.c: Update include file comments.
  (struct process.disable): Renamed to "disabled".  All users changed.
  (addarguments): Renamed to "addargument".  All callers changed.
  (doc, args_doc): Removed.
  (main): Changed default "plugindir" to
          "/conf/conf.d/mandos/plugins.d".  Renamed "rfds_orig" to
           "rfds_all"; all users changed.  New "debug" and
           "exitstatus" variables.  New "--debug" option.  Removed
           unnecessary ".flags = 0" from all options.  Changed so that
           "--disable-plugin" only takes one plugin.  Check for
           non-existence of ":" in argument to "--options-for".  Added
           some debugging outputs.  Set the FD_CLOEXEC flag on the
           directory FD.  More capable code for dealing with
           disallowed plugin file name prefixes and suffixes.  Bug
           fix: check for some malloc failures.  Moved allocating the
           "struct process *new_process" to after the fork.  Do
           _exit() instead of exit() in the child.

* plugins.d/mandosclient.c: Updated contact information.

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