/mandos/trunk

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

« back to all changes in this revision

Viewing changes to server.py

  • Committer: Teddy Hogeborn
  • Date: 2008-07-22 06:23:29 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080722062329-jaex5y5mslf6sqjx
* mandos-clients.conf ([DEFAULT]): New section.

* plugins.d/mandosclient.c (start_mandos_communication): Only print if
                                                         debugging.
                                                         Print server
                                                         name.
                                                         Bug fix: Loop
                                                         until suc-
                                                         cess.

* server.py (serverName): Set via option, not globally.
  (Client.__init__): Removed argument "options".  Require "timeout"
                     and "interval" arguments.
  (tcp_handler.handle): Set "priority" from self.server.options.
  (main): Removed "--timeout" and "--interval" options.  New options
          "--priority" and "--servicename".  Add defaults for
          "timeout" and "interval".  Set "serviceName" from options.
          Do not pass "options" to "Client()".

Show diffs side-by-side

added added

removed removed

Lines of Context:
server.py
6
6
# This program is partly derived from an example program for an Avahi
7
7
# service publisher, downloaded from
8
8
# <http://avahi.org/wiki/PythonPublishExample>.  This includes the
9
 
# methods "add" and "remove" in the "AvahiService" class, the
10
 
# "server_state_changed" and "entry_group_state_changed" functions,
11
 
# and some lines in "main".
 
9
# following functions: "add_service", "remove_service",
 
10
# "server_state_changed", "entry_group_state_changed", and some lines
 
11
# in "main".
12
12
# 
13
 
# Everything else is
14
 
# Copyright © 2008,2009 Teddy Hogeborn
15
 
# Copyright © 2008,2009 Björn Påhlsson
 
13
# Everything else is Copyright © 2007-2008 Teddy Hogeborn and Björn
 
14
# 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
 
# Contact the authors at <mandos@fukt.bsnet.se>.
 
29
# Contact the authors at <https://www.fukt.bsnet.se/~belorn/> and
 
30
# <https://www.fukt.bsnet.se/~teddy/>.
32
31
# 
33
32
 
34
 
from __future__ import division, with_statement, absolute_import
 
33
from __future__ import division
35
34
 
36
35
import SocketServer
37
36
import socket
38
 
import optparse
 
37
import select
 
38
from optparse import OptionParser
39
39
import datetime
40
40
import errno
41
41
import gnutls.crypto
55
55
import stat
56
56
import logging
57
57
import logging.handlers
58
 
import pwd
59
 
from contextlib import closing
60
58
 
61
59
import dbus
62
 
import dbus.service
63
60
import gobject
64
61
import avahi
65
62
from dbus.mainloop.glib import DBusGMainLoop
66
63
import ctypes
67
 
import ctypes.util
68
 
 
69
 
version = "1.0.5"
 
64
 
 
65
# Brief description of the operation of this program:
 
66
# 
 
67
# This server announces itself as a Zeroconf service.  Connecting
 
68
# clients use the TLS protocol, with the unusual quirk that this
 
69
# server program acts as a TLS "client" while the connecting clients
 
70
# acts as a TLS "server".  The clients (acting as a TLS "server") must
 
71
# supply an OpenPGP certificate, and the fingerprint of this
 
72
# certificate is used by this server to look up (in a list read from a
 
73
# file at start time) which binary blob to give the client.  No other
 
74
# authentication or authorization is done by this server.
 
75
 
70
76
 
71
77
logger = logging.Logger('mandos')
72
 
syslogger = (logging.handlers.SysLogHandler
73
 
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
74
 
              address = "/dev/log"))
75
 
syslogger.setFormatter(logging.Formatter
76
 
                       ('Mandos: %(levelname)s: %(message)s'))
 
78
syslogger = logging.handlers.SysLogHandler\
 
79
            (facility = logging.handlers.SysLogHandler.LOG_DAEMON)
 
80
syslogger.setFormatter(logging.Formatter\
 
81
                        ('%(levelname)s: %(message)s'))
77
82
logger.addHandler(syslogger)
78
 
 
79
 
console = logging.StreamHandler()
80
 
console.setFormatter(logging.Formatter('%(name)s: %(levelname)s:'
81
 
                                       ' %(message)s'))
82
 
logger.addHandler(console)
83
 
 
84
 
class AvahiError(Exception):
85
 
    def __init__(self, value, *args, **kwargs):
86
 
        self.value = value
87
 
        super(AvahiError, self).__init__(value, *args, **kwargs)
88
 
    def __unicode__(self):
89
 
        return unicode(repr(self.value))
90
 
 
91
 
class AvahiServiceError(AvahiError):
92
 
    pass
93
 
 
94
 
class AvahiGroupError(AvahiError):
95
 
    pass
96
 
 
97
 
 
98
 
class AvahiService(object):
99
 
    """An Avahi (Zeroconf) service.
100
 
    Attributes:
101
 
    interface: integer; avahi.IF_UNSPEC or an interface index.
102
 
               Used to optionally bind to the specified interface.
103
 
    name: string; Example: 'Mandos'
104
 
    type: string; Example: '_mandos._tcp'.
105
 
                  See <http://www.dns-sd.org/ServiceTypes.html>
106
 
    port: integer; what port to announce
107
 
    TXT: list of strings; TXT record for the service
108
 
    domain: string; Domain to publish on, default to .local if empty.
109
 
    host: string; Host to publish records for, default is localhost
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
113
 
    """
114
 
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
115
 
                 servicetype = None, port = None, TXT = None,
116
 
                 domain = "", host = "", max_renames = 32768):
117
 
        self.interface = interface
118
 
        self.name = name
119
 
        self.type = servicetype
120
 
        self.port = port
121
 
        self.TXT = TXT if TXT is not None else []
122
 
        self.domain = domain
123
 
        self.host = host
124
 
        self.rename_count = 0
125
 
        self.max_renames = max_renames
126
 
    def rename(self):
127
 
        """Derived from the Avahi example code"""
128
 
        if self.rename_count >= self.max_renames:
129
 
            logger.critical(u"No suitable Zeroconf service name found"
130
 
                            u" after %i retries, exiting.",
131
 
                            self.rename_count)
132
 
            raise AvahiServiceError(u"Too many renames")
133
 
        self.name = server.GetAlternativeServiceName(self.name)
134
 
        logger.info(u"Changing Zeroconf service name to %r ...",
135
 
                    str(self.name))
136
 
        syslogger.setFormatter(logging.Formatter
137
 
                               ('Mandos (%s): %%(levelname)s:'
138
 
                                ' %%(message)s' % self.name))
139
 
        self.remove()
140
 
        self.add()
141
 
        self.rename_count += 1
142
 
    def remove(self):
143
 
        """Derived from the Avahi example code"""
144
 
        if group is not None:
145
 
            group.Reset()
146
 
    def add(self):
147
 
        """Derived from the Avahi example code"""
148
 
        global group
149
 
        if group is None:
150
 
            group = dbus.Interface(bus.get_object
151
 
                                   (avahi.DBUS_NAME,
152
 
                                    server.EntryGroupNew()),
153
 
                                   avahi.DBUS_INTERFACE_ENTRY_GROUP)
154
 
            group.connect_to_signal('StateChanged',
155
 
                                    entry_group_state_changed)
156
 
        logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
157
 
                     service.name, service.type)
158
 
        group.AddService(
159
 
                self.interface,         # interface
160
 
                avahi.PROTO_INET6,      # protocol
161
 
                dbus.UInt32(0),         # flags
162
 
                self.name, self.type,
163
 
                self.domain, self.host,
164
 
                dbus.UInt16(self.port),
165
 
                avahi.string_array_to_txt_array(self.TXT))
166
 
        group.Commit()
167
 
 
 
83
del syslogger
 
84
 
 
85
# This variable is used to optionally bind to a specified interface.
 
86
# It is a global variable to fit in with the other variables from the
 
87
# Avahi example code.
 
88
serviceInterface = avahi.IF_UNSPEC
168
89
# From the Avahi example code:
169
 
group = None                            # our entry group
 
90
serviceName = None
 
91
serviceType = "_mandos._tcp" # http://www.dns-sd.org/ServiceTypes.html
 
92
servicePort = None                      # Not known at startup
 
93
serviceTXT = []                         # TXT record for the service
 
94
domain = ""                  # Domain to publish on, default to .local
 
95
host = ""          # Host to publish records for, default to localhost
 
96
group = None #our entry group
 
97
rename_count = 12       # Counter so we only rename after collisions a
 
98
                        # sensible number of times
170
99
# End of Avahi example code
171
100
 
172
101
 
173
 
def _datetime_to_dbus(dt, variant_level=0):
174
 
    """Convert a UTC datetime.datetime() to a D-Bus type."""
175
 
    return dbus.String(dt.isoformat(), variant_level=variant_level)
176
 
 
177
 
 
178
 
class Client(dbus.service.Object):
 
102
class Client(object):
179
103
    """A representation of a client host served by this server.
180
104
    Attributes:
181
 
    name:       string; from the config file, used in log messages and
182
 
                        D-Bus identifiers
 
105
    name:      string; from the config file, used in log messages
183
106
    fingerprint: string (40 or 32 hexadecimal digits); used to
184
107
                 uniquely identify the client
185
 
    secret:     bytestring; sent verbatim (over TLS) to client
186
 
    host:       string; available for use by the checker command
187
 
    created:    datetime.datetime(); (UTC) object creation
188
 
    last_enabled: datetime.datetime(); (UTC)
189
 
    enabled:    bool()
190
 
    last_checked_ok: datetime.datetime(); (UTC) or None
191
 
    timeout:    datetime.timedelta(); How long from last_checked_ok
192
 
                                      until this client is invalid
193
 
    interval:   datetime.timedelta(); How often to start a new checker
194
 
    disable_hook:  If set, called by disable() as disable_hook(self)
195
 
    checker:    subprocess.Popen(); a running checker process used
196
 
                                    to see if the client lives.
197
 
                                    'None' if no process is running.
 
108
    secret:    bytestring; sent verbatim (over TLS) to client
 
109
    fqdn:      string (FQDN); available for use by the checker command
 
110
    created:   datetime.datetime()
 
111
    last_seen: datetime.datetime() or None if not yet seen
 
112
    timeout:   datetime.timedelta(); How long from last_seen until
 
113
                                     this client is invalid
 
114
    interval:  datetime.timedelta(); How often to start a new checker
 
115
    stop_hook: If set, called by stop() as stop_hook(self)
 
116
    checker:   subprocess.Popen(); a running checker process used
 
117
                                   to see if the client lives.
 
118
                                   Is None if no process is running.
198
119
    checker_initiator_tag: a gobject event source tag, or None
199
 
    disable_initiator_tag:    - '' -
 
120
    stop_initiator_tag:    - '' -
200
121
    checker_callback_tag:  - '' -
201
122
    checker_command: string; External command which is run to check if
202
 
                     client lives.  %() expansions are done at
 
123
                     client lives.  %()s expansions are done at
203
124
                     runtime with vars(self) as dict, so that for
204
125
                     instance %(name)s can be used in the command.
205
 
    use_dbus: bool(); Whether to provide D-Bus interface and signals
206
 
    dbus_object_path: dbus.ObjectPath ; only set if self.use_dbus
 
126
    Private attibutes:
 
127
    _timeout: Real variable for 'timeout'
 
128
    _interval: Real variable for 'interval'
 
129
    _timeout_milliseconds: Used by gobject.timeout_add()
 
130
    _interval_milliseconds: - '' -
207
131
    """
208
 
    def timeout_milliseconds(self):
209
 
        "Return the 'timeout' attribute in milliseconds"
210
 
        return ((self.timeout.days * 24 * 60 * 60 * 1000)
211
 
                + (self.timeout.seconds * 1000)
212
 
                + (self.timeout.microseconds // 1000))
213
 
    
214
 
    def interval_milliseconds(self):
215
 
        "Return the 'interval' attribute in milliseconds"
216
 
        return ((self.interval.days * 24 * 60 * 60 * 1000)
217
 
                + (self.interval.seconds * 1000)
218
 
                + (self.interval.microseconds // 1000))
219
 
    
220
 
    def __init__(self, name = None, disable_hook=None, config=None,
221
 
                 use_dbus=True):
222
 
        """Note: the 'checker' key in 'config' sets the
223
 
        'checker_command' attribute and *not* the 'checker'
224
 
        attribute."""
 
132
    def _set_timeout(self, timeout):
 
133
        "Setter function for 'timeout' attribute"
 
134
        self._timeout = timeout
 
135
        self._timeout_milliseconds = ((self.timeout.days
 
136
                                       * 24 * 60 * 60 * 1000)
 
137
                                      + (self.timeout.seconds * 1000)
 
138
                                      + (self.timeout.microseconds
 
139
                                         // 1000))
 
140
    timeout = property(lambda self: self._timeout,
 
141
                       _set_timeout)
 
142
    del _set_timeout
 
143
    def _set_interval(self, interval):
 
144
        "Setter function for 'interval' attribute"
 
145
        self._interval = interval
 
146
        self._interval_milliseconds = ((self.interval.days
 
147
                                        * 24 * 60 * 60 * 1000)
 
148
                                       + (self.interval.seconds
 
149
                                          * 1000)
 
150
                                       + (self.interval.microseconds
 
151
                                          // 1000))
 
152
    interval = property(lambda self: self._interval,
 
153
                        _set_interval)
 
154
    del _set_interval
 
155
    def __init__(self, name=None, stop_hook=None, fingerprint=None,
 
156
                 secret=None, secfile=None, fqdn=None, timeout=None,
 
157
                 interval=-1, checker=None):
 
158
        """Note: the 'checker' argument sets the 'checker_command'
 
159
        attribute and not the 'checker' attribute.."""
225
160
        self.name = name
226
 
        if config is None:
227
 
            config = {}
228
161
        logger.debug(u"Creating client %r", self.name)
229
 
        self.use_dbus = False   # During __init__
230
 
        # Uppercase and remove spaces from fingerprint for later
231
 
        # comparison purposes with return value from the fingerprint()
232
 
        # function
233
 
        self.fingerprint = (config["fingerprint"].upper()
234
 
                            .replace(u" ", u""))
 
162
        # Uppercase and remove spaces from fingerprint
 
163
        # for later comparison purposes with return value of
 
164
        # the fingerprint() function
 
165
        self.fingerprint = fingerprint.upper().replace(u" ", u"")
235
166
        logger.debug(u"  Fingerprint: %s", self.fingerprint)
236
 
        if "secret" in config:
237
 
            self.secret = config["secret"].decode(u"base64")
238
 
        elif "secfile" in config:
239
 
            with closing(open(os.path.expanduser
240
 
                              (os.path.expandvars
241
 
                               (config["secfile"])))) as secfile:
242
 
                self.secret = secfile.read()
 
167
        if secret:
 
168
            self.secret = secret.decode(u"base64")
 
169
        elif secfile:
 
170
            sf = open(secfile)
 
171
            self.secret = sf.read()
 
172
            sf.close()
243
173
        else:
244
 
            raise TypeError(u"No secret or secfile for client %s"
245
 
                            % self.name)
246
 
        self.host = config.get("host", "")
247
 
        self.created = datetime.datetime.utcnow()
248
 
        self.enabled = False
249
 
        self.last_enabled = None
250
 
        self.last_checked_ok = None
251
 
        self.timeout = string_to_delta(config["timeout"])
252
 
        self.interval = string_to_delta(config["interval"])
253
 
        self.disable_hook = disable_hook
 
174
            raise RuntimeError(u"No secret or secfile for client %s"
 
175
                               % self.name)
 
176
        self.fqdn = fqdn                # string
 
177
        self.created = datetime.datetime.now()
 
178
        self.last_seen = None
 
179
        self.timeout = string_to_delta(timeout)
 
180
        self.interval = string_to_delta(interval)
 
181
        self.stop_hook = stop_hook
254
182
        self.checker = None
255
183
        self.checker_initiator_tag = None
256
 
        self.disable_initiator_tag = None
 
184
        self.stop_initiator_tag = None
257
185
        self.checker_callback_tag = None
258
 
        self.checker_command = config["checker"]
259
 
        self.last_connect = None
260
 
        # Only now, when this client is initialized, can it show up on
261
 
        # the D-Bus
262
 
        self.use_dbus = use_dbus
263
 
        if self.use_dbus:
264
 
            self.dbus_object_path = (dbus.ObjectPath
265
 
                                     ("/clients/"
266
 
                                      + self.name.replace(".", "_")))
267
 
            dbus.service.Object.__init__(self, bus,
268
 
                                         self.dbus_object_path)
269
 
    
270
 
    def enable(self):
 
186
        self.check_command = checker
 
187
    def start(self):
271
188
        """Start this client's checker and timeout hooks"""
272
 
        self.last_enabled = datetime.datetime.utcnow()
273
189
        # Schedule a new checker to be started an 'interval' from now,
274
190
        # and every interval from then on.
275
 
        self.checker_initiator_tag = (gobject.timeout_add
276
 
                                      (self.interval_milliseconds(),
277
 
                                       self.start_checker))
 
191
        self.checker_initiator_tag = gobject.timeout_add\
 
192
                                     (self._interval_milliseconds,
 
193
                                      self.start_checker)
278
194
        # Also start a new checker *right now*.
279
195
        self.start_checker()
280
 
        # Schedule a disable() when 'timeout' has passed
281
 
        self.disable_initiator_tag = (gobject.timeout_add
282
 
                                   (self.timeout_milliseconds(),
283
 
                                    self.disable))
284
 
        self.enabled = True
285
 
        if self.use_dbus:
286
 
            # Emit D-Bus signals
287
 
            self.PropertyChanged(dbus.String(u"enabled"),
288
 
                                 dbus.Boolean(True, variant_level=1))
289
 
            self.PropertyChanged(dbus.String(u"last_enabled"),
290
 
                                 (_datetime_to_dbus(self.last_enabled,
291
 
                                                    variant_level=1)))
292
 
    
293
 
    def disable(self):
294
 
        """Disable this client."""
295
 
        if not getattr(self, "enabled", False):
 
196
        # Schedule a stop() when 'timeout' has passed
 
197
        self.stop_initiator_tag = gobject.timeout_add\
 
198
                                  (self._timeout_milliseconds,
 
199
                                   self.stop)
 
200
    def stop(self):
 
201
        """Stop this client.
 
202
        The possibility that this client might be restarted is left
 
203
        open, but not currently used."""
 
204
        # If this client doesn't have a secret, it is already stopped.
 
205
        if self.secret:
 
206
            logger.debug(u"Stopping client %s", self.name)
 
207
            self.secret = None
 
208
        else:
296
209
            return False
297
 
        logger.info(u"Disabling client %s", self.name)
298
 
        if getattr(self, "disable_initiator_tag", False):
299
 
            gobject.source_remove(self.disable_initiator_tag)
300
 
            self.disable_initiator_tag = None
301
 
        if getattr(self, "checker_initiator_tag", False):
 
210
        if hasattr(self, "stop_initiator_tag") \
 
211
               and self.stop_initiator_tag:
 
212
            gobject.source_remove(self.stop_initiator_tag)
 
213
            self.stop_initiator_tag = None
 
214
        if hasattr(self, "checker_initiator_tag") \
 
215
               and self.checker_initiator_tag:
302
216
            gobject.source_remove(self.checker_initiator_tag)
303
217
            self.checker_initiator_tag = None
304
218
        self.stop_checker()
305
 
        if self.disable_hook:
306
 
            self.disable_hook(self)
307
 
        self.enabled = False
308
 
        if self.use_dbus:
309
 
            # Emit D-Bus signal
310
 
            self.PropertyChanged(dbus.String(u"enabled"),
311
 
                                 dbus.Boolean(False, variant_level=1))
 
219
        if self.stop_hook:
 
220
            self.stop_hook(self)
312
221
        # Do not run this again if called by a gobject.timeout_add
313
222
        return False
314
 
    
315
223
    def __del__(self):
316
 
        self.disable_hook = None
317
 
        self.disable()
318
 
    
319
 
    def checker_callback(self, pid, condition, command):
 
224
        self.stop_hook = None
 
225
        self.stop()
 
226
    def checker_callback(self, pid, condition):
320
227
        """The checker has completed, so take appropriate actions."""
 
228
        now = datetime.datetime.now()
321
229
        self.checker_callback_tag = None
322
230
        self.checker = None
323
 
        if self.use_dbus:
324
 
            # Emit D-Bus signal
325
 
            self.PropertyChanged(dbus.String(u"checker_running"),
326
 
                                 dbus.Boolean(False, variant_level=1))
327
 
        if os.WIFEXITED(condition):
328
 
            exitstatus = os.WEXITSTATUS(condition)
329
 
            if exitstatus == 0:
330
 
                logger.info(u"Checker for %(name)s succeeded",
331
 
                            vars(self))
332
 
                self.checked_ok()
333
 
            else:
334
 
                logger.info(u"Checker for %(name)s failed",
335
 
                            vars(self))
336
 
            if self.use_dbus:
337
 
                # Emit D-Bus signal
338
 
                self.CheckerCompleted(dbus.Int16(exitstatus),
339
 
                                      dbus.Int64(condition),
340
 
                                      dbus.String(command))
341
 
        else:
 
231
        if os.WIFEXITED(condition) \
 
232
               and (os.WEXITSTATUS(condition) == 0):
 
233
            logger.debug(u"Checker for %(name)s succeeded",
 
234
                         vars(self))
 
235
            self.last_seen = now
 
236
            gobject.source_remove(self.stop_initiator_tag)
 
237
            self.stop_initiator_tag = gobject.timeout_add\
 
238
                                      (self._timeout_milliseconds,
 
239
                                       self.stop)
 
240
        elif not os.WIFEXITED(condition):
342
241
            logger.warning(u"Checker for %(name)s crashed?",
343
242
                           vars(self))
344
 
            if self.use_dbus:
345
 
                # Emit D-Bus signal
346
 
                self.CheckerCompleted(dbus.Int16(-1),
347
 
                                      dbus.Int64(condition),
348
 
                                      dbus.String(command))
349
 
    
350
 
    def checked_ok(self):
351
 
        """Bump up the timeout for this client.
352
 
        This should only be called when the client has been seen,
353
 
        alive and well.
354
 
        """
355
 
        self.last_checked_ok = datetime.datetime.utcnow()
356
 
        gobject.source_remove(self.disable_initiator_tag)
357
 
        self.disable_initiator_tag = (gobject.timeout_add
358
 
                                      (self.timeout_milliseconds(),
359
 
                                       self.disable))
360
 
        if self.use_dbus:
361
 
            # Emit D-Bus signal
362
 
            self.PropertyChanged(
363
 
                dbus.String(u"last_checked_ok"),
364
 
                (_datetime_to_dbus(self.last_checked_ok,
365
 
                                   variant_level=1)))
366
 
    
 
243
        else:
 
244
            logger.debug(u"Checker for %(name)s failed",
 
245
                         vars(self))
367
246
    def start_checker(self):
368
247
        """Start a new checker subprocess if one is not running.
369
248
        If a checker already exists, leave it running and do
378
257
        # is as it should be.
379
258
        if self.checker is None:
380
259
            try:
381
 
                # In case checker_command has exactly one % operator
382
 
                command = self.checker_command % self.host
 
260
                command = self.check_command % self.fqdn
383
261
            except TypeError:
384
 
                # Escape attributes for the shell
385
262
                escaped_attrs = dict((key, re.escape(str(val)))
386
263
                                     for key, val in
387
264
                                     vars(self).iteritems())
388
265
                try:
389
 
                    command = self.checker_command % escaped_attrs
 
266
                    command = self.check_command % escaped_attrs
390
267
                except TypeError, error:
391
 
                    logger.error(u'Could not format string "%s":'
392
 
                                 u' %s', self.checker_command, error)
 
268
                    logger.critical(u'Could not format string "%s":'
 
269
                                    u' %s', self.check_command, error)
393
270
                    return True # Try again later
394
271
            try:
395
 
                logger.info(u"Starting checker %r for %s",
396
 
                            command, self.name)
397
 
                # We don't need to redirect stdout and stderr, since
398
 
                # in normal mode, that is already done by daemon(),
399
 
                # and in debug mode we don't want to.  (Stdin is
400
 
                # always replaced by /dev/null.)
401
 
                self.checker = subprocess.Popen(command,
402
 
                                                close_fds=True,
403
 
                                                shell=True, cwd="/")
404
 
                if self.use_dbus:
405
 
                    # Emit D-Bus signal
406
 
                    self.CheckerStarted(command)
407
 
                    self.PropertyChanged(
408
 
                        dbus.String("checker_running"),
409
 
                        dbus.Boolean(True, variant_level=1))
410
 
                self.checker_callback_tag = (gobject.child_watch_add
411
 
                                             (self.checker.pid,
412
 
                                              self.checker_callback,
413
 
                                              data=command))
414
 
            except OSError, error:
 
272
                logger.debug(u"Starting checker %r for %s",
 
273
                             command, self.name)
 
274
                self.checker = subprocess.\
 
275
                               Popen(command,
 
276
                                     close_fds=True, shell=True,
 
277
                                     cwd="/")
 
278
                self.checker_callback_tag = gobject.child_watch_add\
 
279
                                            (self.checker.pid,
 
280
                                             self.checker_callback)
 
281
            except subprocess.OSError, error:
415
282
                logger.error(u"Failed to start subprocess: %s",
416
283
                             error)
417
284
        # Re-run this periodically if run by gobject.timeout_add
418
285
        return True
419
 
    
420
286
    def stop_checker(self):
421
287
        """Force the checker process, if any, to stop."""
422
288
        if self.checker_callback_tag:
423
289
            gobject.source_remove(self.checker_callback_tag)
424
290
            self.checker_callback_tag = None
425
 
        if getattr(self, "checker", None) is None:
 
291
        if not hasattr(self, "checker") or self.checker is None:
426
292
            return
427
 
        logger.debug(u"Stopping checker for %(name)s", vars(self))
 
293
        logger.debug("Stopping checker for %(name)s", vars(self))
428
294
        try:
429
295
            os.kill(self.checker.pid, signal.SIGTERM)
430
296
            #os.sleep(0.5)
431
297
            #if self.checker.poll() is None:
432
298
            #    os.kill(self.checker.pid, signal.SIGKILL)
433
299
        except OSError, error:
434
 
            if error.errno != errno.ESRCH: # No such process
 
300
            if error.errno != errno.ESRCH:
435
301
                raise
436
302
        self.checker = None
437
 
        if self.use_dbus:
438
 
            self.PropertyChanged(dbus.String(u"checker_running"),
439
 
                                 dbus.Boolean(False, variant_level=1))
440
 
    
441
 
    def still_valid(self):
 
303
    def still_valid(self, now=None):
442
304
        """Has the timeout not yet passed for this client?"""
443
 
        if not getattr(self, "enabled", False):
444
 
            return False
445
 
        now = datetime.datetime.utcnow()
446
 
        if self.last_checked_ok is None:
 
305
        if now is None:
 
306
            now = datetime.datetime.now()
 
307
        if self.last_seen is None:
447
308
            return now < (self.created + self.timeout)
448
309
        else:
449
 
            return now < (self.last_checked_ok + self.timeout)
450
 
    
451
 
    ## D-Bus methods & signals
452
 
    _interface = u"se.bsnet.fukt.Mandos.Client"
453
 
    
454
 
    # CheckedOK - method
455
 
    CheckedOK = dbus.service.method(_interface)(checked_ok)
456
 
    CheckedOK.__name__ = "CheckedOK"
457
 
    
458
 
    # CheckerCompleted - signal
459
 
    @dbus.service.signal(_interface, signature="nxs")
460
 
    def CheckerCompleted(self, exitcode, waitstatus, command):
461
 
        "D-Bus signal"
462
 
        pass
463
 
    
464
 
    # CheckerStarted - signal
465
 
    @dbus.service.signal(_interface, signature="s")
466
 
    def CheckerStarted(self, command):
467
 
        "D-Bus signal"
468
 
        pass
469
 
    
470
 
    # GetAllProperties - method
471
 
    @dbus.service.method(_interface, out_signature="a{sv}")
472
 
    def GetAllProperties(self):
473
 
        "D-Bus method"
474
 
        return dbus.Dictionary({
475
 
                dbus.String("name"):
476
 
                    dbus.String(self.name, variant_level=1),
477
 
                dbus.String("fingerprint"):
478
 
                    dbus.String(self.fingerprint, variant_level=1),
479
 
                dbus.String("host"):
480
 
                    dbus.String(self.host, variant_level=1),
481
 
                dbus.String("created"):
482
 
                    _datetime_to_dbus(self.created, variant_level=1),
483
 
                dbus.String("last_enabled"):
484
 
                    (_datetime_to_dbus(self.last_enabled,
485
 
                                       variant_level=1)
486
 
                     if self.last_enabled is not None
487
 
                     else dbus.Boolean(False, variant_level=1)),
488
 
                dbus.String("enabled"):
489
 
                    dbus.Boolean(self.enabled, variant_level=1),
490
 
                dbus.String("last_checked_ok"):
491
 
                    (_datetime_to_dbus(self.last_checked_ok,
492
 
                                       variant_level=1)
493
 
                     if self.last_checked_ok is not None
494
 
                     else dbus.Boolean (False, variant_level=1)),
495
 
                dbus.String("timeout"):
496
 
                    dbus.UInt64(self.timeout_milliseconds(),
497
 
                                variant_level=1),
498
 
                dbus.String("interval"):
499
 
                    dbus.UInt64(self.interval_milliseconds(),
500
 
                                variant_level=1),
501
 
                dbus.String("checker"):
502
 
                    dbus.String(self.checker_command,
503
 
                                variant_level=1),
504
 
                dbus.String("checker_running"):
505
 
                    dbus.Boolean(self.checker is not None,
506
 
                                 variant_level=1),
507
 
                dbus.String("object_path"):
508
 
                    dbus.ObjectPath(self.dbus_object_path,
509
 
                                    variant_level=1)
510
 
                }, signature="sv")
511
 
    
512
 
    # IsStillValid - method
513
 
    IsStillValid = (dbus.service.method(_interface, out_signature="b")
514
 
                    (still_valid))
515
 
    IsStillValid.__name__ = "IsStillValid"
516
 
    
517
 
    # PropertyChanged - signal
518
 
    @dbus.service.signal(_interface, signature="sv")
519
 
    def PropertyChanged(self, property, value):
520
 
        "D-Bus signal"
521
 
        pass
522
 
    
523
 
    # SetChecker - method
524
 
    @dbus.service.method(_interface, in_signature="s")
525
 
    def SetChecker(self, checker):
526
 
        "D-Bus setter method"
527
 
        self.checker_command = checker
528
 
        # Emit D-Bus signal
529
 
        self.PropertyChanged(dbus.String(u"checker"),
530
 
                             dbus.String(self.checker_command,
531
 
                                         variant_level=1))
532
 
    
533
 
    # SetHost - method
534
 
    @dbus.service.method(_interface, in_signature="s")
535
 
    def SetHost(self, host):
536
 
        "D-Bus setter method"
537
 
        self.host = host
538
 
        # Emit D-Bus signal
539
 
        self.PropertyChanged(dbus.String(u"host"),
540
 
                             dbus.String(self.host, variant_level=1))
541
 
    
542
 
    # SetInterval - method
543
 
    @dbus.service.method(_interface, in_signature="t")
544
 
    def SetInterval(self, milliseconds):
545
 
        self.interval = datetime.timedelta(0, 0, 0, milliseconds)
546
 
        # Emit D-Bus signal
547
 
        self.PropertyChanged(dbus.String(u"interval"),
548
 
                             (dbus.UInt64(self.interval_milliseconds(),
549
 
                                          variant_level=1)))
550
 
    
551
 
    # SetSecret - method
552
 
    @dbus.service.method(_interface, in_signature="ay",
553
 
                         byte_arrays=True)
554
 
    def SetSecret(self, secret):
555
 
        "D-Bus setter method"
556
 
        self.secret = str(secret)
557
 
    
558
 
    # SetTimeout - method
559
 
    @dbus.service.method(_interface, in_signature="t")
560
 
    def SetTimeout(self, milliseconds):
561
 
        self.timeout = datetime.timedelta(0, 0, 0, milliseconds)
562
 
        # Emit D-Bus signal
563
 
        self.PropertyChanged(dbus.String(u"timeout"),
564
 
                             (dbus.UInt64(self.timeout_milliseconds(),
565
 
                                          variant_level=1)))
566
 
    
567
 
    # Enable - method
568
 
    Enable = dbus.service.method(_interface)(enable)
569
 
    Enable.__name__ = "Enable"
570
 
    
571
 
    # StartChecker - method
572
 
    @dbus.service.method(_interface)
573
 
    def StartChecker(self):
574
 
        "D-Bus method"
575
 
        self.start_checker()
576
 
    
577
 
    # Disable - method
578
 
    @dbus.service.method(_interface)
579
 
    def Disable(self):
580
 
        "D-Bus method"
581
 
        self.disable()
582
 
    
583
 
    # StopChecker - method
584
 
    StopChecker = dbus.service.method(_interface)(stop_checker)
585
 
    StopChecker.__name__ = "StopChecker"
586
 
    
587
 
    del _interface
 
310
            return now < (self.last_seen + self.timeout)
588
311
 
589
312
 
590
313
def peer_certificate(session):
591
314
    "Return the peer's OpenPGP certificate as a bytestring"
592
315
    # If not an OpenPGP certificate...
593
 
    if (gnutls.library.functions
594
 
        .gnutls_certificate_type_get(session._c_object)
595
 
        != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
 
316
    if gnutls.library.functions.gnutls_certificate_type_get\
 
317
            (session._c_object) \
 
318
           != gnutls.library.constants.GNUTLS_CRT_OPENPGP:
596
319
        # ...do the normal thing
597
320
        return session.peer_certificate
598
 
    list_size = ctypes.c_uint(1)
599
 
    cert_list = (gnutls.library.functions
600
 
                 .gnutls_certificate_get_peers
601
 
                 (session._c_object, ctypes.byref(list_size)))
602
 
    if not bool(cert_list) and list_size.value != 0:
603
 
        raise gnutls.errors.GNUTLSError("error getting peer"
604
 
                                        " certificate")
 
321
    list_size = ctypes.c_uint()
 
322
    cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
 
323
        (session._c_object, ctypes.byref(list_size))
605
324
    if list_size.value == 0:
606
325
        return None
607
326
    cert = cert_list[0]
610
329
 
611
330
def fingerprint(openpgp):
612
331
    "Convert an OpenPGP bytestring to a hexdigit fingerprint string"
613
 
    # New GnuTLS "datum" with the OpenPGP public key
614
 
    datum = (gnutls.library.types
615
 
             .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
616
 
                                         ctypes.POINTER
617
 
                                         (ctypes.c_ubyte)),
618
 
                             ctypes.c_uint(len(openpgp))))
619
332
    # New empty GnuTLS certificate
620
333
    crt = gnutls.library.types.gnutls_openpgp_crt_t()
621
 
    (gnutls.library.functions
622
 
     .gnutls_openpgp_crt_init(ctypes.byref(crt)))
 
334
    gnutls.library.functions.gnutls_openpgp_crt_init\
 
335
        (ctypes.byref(crt))
 
336
    # New GnuTLS "datum" with the OpenPGP public key
 
337
    datum = gnutls.library.types.gnutls_datum_t\
 
338
        (ctypes.cast(ctypes.c_char_p(openpgp),
 
339
                     ctypes.POINTER(ctypes.c_ubyte)),
 
340
         ctypes.c_uint(len(openpgp)))
623
341
    # Import the OpenPGP public key into the certificate
624
 
    (gnutls.library.functions
625
 
     .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
626
 
                                gnutls.library.constants
627
 
                                .GNUTLS_OPENPGP_FMT_RAW))
628
 
    # Verify the self signature in the key
629
 
    crtverify = ctypes.c_uint()
630
 
    (gnutls.library.functions
631
 
     .gnutls_openpgp_crt_verify_self(crt, 0, ctypes.byref(crtverify)))
632
 
    if crtverify.value != 0:
633
 
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
634
 
        raise gnutls.errors.CertificateSecurityError("Verify failed")
 
342
    ret = gnutls.library.functions.gnutls_openpgp_crt_import\
 
343
        (crt,
 
344
         ctypes.byref(datum),
 
345
         gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
635
346
    # New buffer for the fingerprint
636
 
    buf = ctypes.create_string_buffer(20)
637
 
    buf_len = ctypes.c_size_t()
 
347
    buffer = ctypes.create_string_buffer(20)
 
348
    buffer_length = ctypes.c_size_t()
638
349
    # Get the fingerprint from the certificate into the buffer
639
 
    (gnutls.library.functions
640
 
     .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
641
 
                                         ctypes.byref(buf_len)))
 
350
    gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
 
351
        (crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
642
352
    # Deinit the certificate
643
353
    gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
644
354
    # Convert the buffer to a Python bytestring
645
 
    fpr = ctypes.string_at(buf, buf_len.value)
 
355
    fpr = ctypes.string_at(buffer, buffer_length.value)
646
356
    # Convert the bytestring to hexadecimal notation
647
357
    hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
648
358
    return hex_fpr
649
359
 
650
360
 
651
 
class TCP_handler(SocketServer.BaseRequestHandler, object):
 
361
class tcp_handler(SocketServer.BaseRequestHandler, object):
652
362
    """A TCP request handler class.
653
363
    Instantiated by IPv6_TCPServer for each request to handle it.
654
364
    Note: This will run in its own forked process."""
655
365
    
656
366
    def handle(self):
657
 
        logger.info(u"TCP connection from: %s",
658
 
                    unicode(self.client_address))
659
 
        session = (gnutls.connection
660
 
                   .ClientSession(self.request,
661
 
                                  gnutls.connection
662
 
                                  .X509Credentials()))
663
 
        
664
 
        line = self.request.makefile().readline()
665
 
        logger.debug(u"Protocol version: %r", line)
666
 
        try:
667
 
            if int(line.strip().split()[0]) > 1:
668
 
                raise RuntimeError
669
 
        except (ValueError, IndexError, RuntimeError), error:
670
 
            logger.error(u"Unknown protocol version: %s", error)
671
 
            return
672
 
        
673
 
        # Note: gnutls.connection.X509Credentials is really a generic
674
 
        # GnuTLS certificate credentials object so long as no X.509
675
 
        # keys are added to it.  Therefore, we can use it here despite
676
 
        # using OpenPGP certificates.
 
367
        logger.debug(u"TCP connection from: %s",
 
368
                     unicode(self.client_address))
 
369
        session = gnutls.connection.ClientSession(self.request,
 
370
                                                  gnutls.connection.\
 
371
                                                  X509Credentials())
677
372
        
678
373
        #priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
679
374
        #                "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
680
375
        #                "+DHE-DSS"))
681
 
        # Use a fallback default, since this MUST be set.
682
 
        priority = self.server.settings.get("priority", "NORMAL")
683
 
        (gnutls.library.functions
684
 
         .gnutls_priority_set_direct(session._c_object,
685
 
                                     priority, None))
 
376
        priority = "NORMAL"
 
377
        if self.server.options.priority:
 
378
            priority = self.server.options.priority
 
379
        gnutls.library.functions.gnutls_priority_set_direct\
 
380
            (session._c_object, priority, None);
686
381
        
687
382
        try:
688
383
            session.handshake()
689
384
        except gnutls.errors.GNUTLSError, error:
690
 
            logger.warning(u"Handshake failed: %s", error)
 
385
            logger.debug(u"Handshake failed: %s", error)
691
386
            # Do not run session.bye() here: the session is not
692
387
            # established.  Just abandon the request.
693
388
            return
694
 
        logger.debug(u"Handshake succeeded")
695
389
        try:
696
390
            fpr = fingerprint(peer_certificate(session))
697
391
        except (TypeError, gnutls.errors.GNUTLSError), error:
698
 
            logger.warning(u"Bad certificate: %s", error)
 
392
            logger.debug(u"Bad certificate: %s", error)
699
393
            session.bye()
700
394
            return
701
395
        logger.debug(u"Fingerprint: %s", fpr)
702
 
        
 
396
        client = None
703
397
        for c in self.server.clients:
704
398
            if c.fingerprint == fpr:
705
399
                client = c
706
400
                break
707
 
        else:
708
 
            logger.warning(u"Client not found for fingerprint: %s",
709
 
                           fpr)
710
 
            session.bye()
711
 
            return
712
401
        # Have to check if client.still_valid(), since it is possible
713
402
        # that the client timed out while establishing the GnuTLS
714
403
        # session.
715
 
        if not client.still_valid():
716
 
            logger.warning(u"Client %(name)s is invalid",
717
 
                           vars(client))
 
404
        if (not client) or (not client.still_valid()):
 
405
            if client:
 
406
                logger.debug(u"Client %(name)s is invalid",
 
407
                             vars(client))
 
408
            else:
 
409
                logger.debug(u"Client not found for fingerprint: %s",
 
410
                             fpr)
718
411
            session.bye()
719
412
            return
720
 
        ## This won't work here, since we're in a fork.
721
 
        # client.checked_ok()
722
413
        sent_size = 0
723
414
        while sent_size < len(client.secret):
724
415
            sent = session.send(client.secret[sent_size:])
729
420
        session.bye()
730
421
 
731
422
 
732
 
class IPv6_TCPServer(SocketServer.ForkingMixIn,
733
 
                     SocketServer.TCPServer, object):
 
423
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
734
424
    """IPv6 TCP server.  Accepts 'None' as address and/or port.
735
425
    Attributes:
736
 
        settings:       Server settings
 
426
        options:        Command line options
737
427
        clients:        Set() of Client objects
738
 
        enabled:        Boolean; whether this server is activated yet
739
428
    """
740
429
    address_family = socket.AF_INET6
741
430
    def __init__(self, *args, **kwargs):
742
 
        if "settings" in kwargs:
743
 
            self.settings = kwargs["settings"]
744
 
            del kwargs["settings"]
 
431
        if "options" in kwargs:
 
432
            self.options = kwargs["options"]
 
433
            del kwargs["options"]
745
434
        if "clients" in kwargs:
746
435
            self.clients = kwargs["clients"]
747
436
            del kwargs["clients"]
748
 
        self.enabled = False
749
 
        super(IPv6_TCPServer, self).__init__(*args, **kwargs)
 
437
        return super(type(self), self).__init__(*args, **kwargs)
750
438
    def server_bind(self):
751
439
        """This overrides the normal server_bind() function
752
440
        to bind to an interface if one was specified, and also NOT to
753
441
        bind to an address or port if they were not specified."""
754
 
        if self.settings["interface"]:
755
 
            # 25 is from /usr/include/asm-i486/socket.h
756
 
            SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
 
442
        if self.options.interface:
 
443
            if not hasattr(socket, "SO_BINDTODEVICE"):
 
444
                # From /usr/include/asm-i486/socket.h
 
445
                socket.SO_BINDTODEVICE = 25
757
446
            try:
758
447
                self.socket.setsockopt(socket.SOL_SOCKET,
759
 
                                       SO_BINDTODEVICE,
760
 
                                       self.settings["interface"])
 
448
                                       socket.SO_BINDTODEVICE,
 
449
                                       self.options.interface)
761
450
            except socket.error, error:
762
451
                if error[0] == errno.EPERM:
763
 
                    logger.error(u"No permission to"
764
 
                                 u" bind to interface %s",
765
 
                                 self.settings["interface"])
 
452
                    logger.warning(u"No permission to"
 
453
                                   u" bind to interface %s",
 
454
                                   self.options.interface)
766
455
                else:
767
456
                    raise error
768
457
        # Only bind(2) the socket if we really need to.
771
460
                in6addr_any = "::"
772
461
                self.server_address = (in6addr_any,
773
462
                                       self.server_address[1])
774
 
            elif not self.server_address[1]:
 
463
            elif self.server_address[1] is None:
775
464
                self.server_address = (self.server_address[0],
776
465
                                       0)
777
 
#                 if self.settings["interface"]:
778
 
#                     self.server_address = (self.server_address[0],
779
 
#                                            0, # port
780
 
#                                            0, # flowinfo
781
 
#                                            if_nametoindex
782
 
#                                            (self.settings
783
 
#                                             ["interface"]))
784
 
            return super(IPv6_TCPServer, self).server_bind()
785
 
    def server_activate(self):
786
 
        if self.enabled:
787
 
            return super(IPv6_TCPServer, self).server_activate()
788
 
    def enable(self):
789
 
        self.enabled = True
 
466
            return super(type(self), self).server_bind()
790
467
 
791
468
 
792
469
def string_to_delta(interval):
793
470
    """Parse a string and return a datetime.timedelta
794
 
    
 
471
 
795
472
    >>> string_to_delta('7d')
796
473
    datetime.timedelta(7)
797
474
    >>> string_to_delta('60s')
802
479
    datetime.timedelta(1)
803
480
    >>> string_to_delta(u'1w')
804
481
    datetime.timedelta(7)
805
 
    >>> string_to_delta('5m 30s')
806
 
    datetime.timedelta(0, 330)
807
482
    """
808
 
    timevalue = datetime.timedelta(0)
809
 
    for s in interval.split():
810
 
        try:
811
 
            suffix = unicode(s[-1])
812
 
            value = int(s[:-1])
813
 
            if suffix == u"d":
814
 
                delta = datetime.timedelta(value)
815
 
            elif suffix == u"s":
816
 
                delta = datetime.timedelta(0, value)
817
 
            elif suffix == u"m":
818
 
                delta = datetime.timedelta(0, 0, 0, 0, value)
819
 
            elif suffix == u"h":
820
 
                delta = datetime.timedelta(0, 0, 0, 0, 0, value)
821
 
            elif suffix == u"w":
822
 
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
823
 
            else:
824
 
                raise ValueError
825
 
        except (ValueError, IndexError):
 
483
    try:
 
484
        suffix=unicode(interval[-1])
 
485
        value=int(interval[:-1])
 
486
        if suffix == u"d":
 
487
            delta = datetime.timedelta(value)
 
488
        elif suffix == u"s":
 
489
            delta = datetime.timedelta(0, value)
 
490
        elif suffix == u"m":
 
491
            delta = datetime.timedelta(0, 0, 0, 0, value)
 
492
        elif suffix == u"h":
 
493
            delta = datetime.timedelta(0, 0, 0, 0, 0, value)
 
494
        elif suffix == u"w":
 
495
            delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
 
496
        else:
826
497
            raise ValueError
827
 
        timevalue += delta
828
 
    return timevalue
 
498
    except (ValueError, IndexError):
 
499
        raise ValueError
 
500
    return delta
 
501
 
 
502
 
 
503
def add_service():
 
504
    """Derived from the Avahi example code"""
 
505
    global group, serviceName, serviceType, servicePort, serviceTXT, \
 
506
           domain, host
 
507
    if group is None:
 
508
        group = dbus.Interface(
 
509
                bus.get_object( avahi.DBUS_NAME,
 
510
                                server.EntryGroupNew()),
 
511
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
 
512
        group.connect_to_signal('StateChanged',
 
513
                                entry_group_state_changed)
 
514
    logger.debug(u"Adding service '%s' of type '%s' ...",
 
515
                 serviceName, serviceType)
 
516
    
 
517
    group.AddService(
 
518
            serviceInterface,           # interface
 
519
            avahi.PROTO_INET6,          # protocol
 
520
            dbus.UInt32(0),             # flags
 
521
            serviceName, serviceType,
 
522
            domain, host,
 
523
            dbus.UInt16(servicePort),
 
524
            avahi.string_array_to_txt_array(serviceTXT))
 
525
    group.Commit()
 
526
 
 
527
 
 
528
def remove_service():
 
529
    """From the Avahi example code"""
 
530
    global group
 
531
    
 
532
    if not group is None:
 
533
        group.Reset()
829
534
 
830
535
 
831
536
def server_state_changed(state):
832
537
    """Derived from the Avahi example code"""
833
538
    if state == avahi.SERVER_COLLISION:
834
 
        logger.error(u"Zeroconf server name collision")
835
 
        service.remove()
 
539
        logger.warning(u"Server name collision")
 
540
        remove_service()
836
541
    elif state == avahi.SERVER_RUNNING:
837
 
        service.add()
 
542
        add_service()
838
543
 
839
544
 
840
545
def entry_group_state_changed(state, error):
841
546
    """Derived from the Avahi example code"""
842
 
    logger.debug(u"Avahi state change: %i", state)
 
547
    global serviceName, server, rename_count
 
548
    
 
549
    logger.debug(u"state change: %i", state)
843
550
    
844
551
    if state == avahi.ENTRY_GROUP_ESTABLISHED:
845
 
        logger.debug(u"Zeroconf service established.")
 
552
        logger.debug(u"Service established.")
846
553
    elif state == avahi.ENTRY_GROUP_COLLISION:
847
 
        logger.warning(u"Zeroconf service name collision.")
848
 
        service.rename()
 
554
        
 
555
        rename_count = rename_count - 1
 
556
        if rename_count > 0:
 
557
            name = server.GetAlternativeServiceName(name)
 
558
            logger.warning(u"Service name collision, "
 
559
                           u"changing name to '%s' ...", name)
 
560
            remove_service()
 
561
            add_service()
 
562
            
 
563
        else:
 
564
            logger.error(u"No suitable service name found after %i"
 
565
                         u" retries, exiting.", n_rename)
 
566
            killme(1)
849
567
    elif state == avahi.ENTRY_GROUP_FAILURE:
850
 
        logger.critical(u"Avahi: Error in group state changed %s",
851
 
                        unicode(error))
852
 
        raise AvahiGroupError(u"State changed: %s" % unicode(error))
 
568
        logger.error(u"Error in group state changed %s",
 
569
                     unicode(error))
 
570
        killme(1)
 
571
 
853
572
 
854
573
def if_nametoindex(interface):
855
 
    """Call the C function if_nametoindex(), or equivalent"""
856
 
    global if_nametoindex
 
574
    """Call the C function if_nametoindex()"""
857
575
    try:
858
 
        if_nametoindex = (ctypes.cdll.LoadLibrary
859
 
                          (ctypes.util.find_library("c"))
860
 
                          .if_nametoindex)
 
576
        libc = ctypes.cdll.LoadLibrary("libc.so.6")
 
577
        return libc.if_nametoindex(interface)
861
578
    except (OSError, AttributeError):
862
579
        if "struct" not in sys.modules:
863
580
            import struct
864
581
        if "fcntl" not in sys.modules:
865
582
            import fcntl
866
 
        def if_nametoindex(interface):
867
 
            "Get an interface index the hard way, i.e. using fcntl()"
868
 
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
869
 
            with closing(socket.socket()) as s:
870
 
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
871
 
                                    struct.pack("16s16x", interface))
872
 
            interface_index = struct.unpack("I", ifreq[16:20])[0]
873
 
            return interface_index
874
 
    return if_nametoindex(interface)
875
 
 
876
 
 
877
 
def daemon(nochdir = False, noclose = False):
 
583
        SIOCGIFINDEX = 0x8933      # From /usr/include/linux/sockios.h
 
584
        s = socket.socket()
 
585
        ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
 
586
                            struct.pack("16s16x", interface))
 
587
        s.close()
 
588
        interface_index = struct.unpack("I", ifreq[16:20])[0]
 
589
        return interface_index
 
590
 
 
591
 
 
592
def daemon(nochdir, noclose):
878
593
    """See daemon(3).  Standard BSD Unix function.
879
594
    This should really exist as os.daemon, but it doesn't (yet)."""
880
595
    if os.fork():
882
597
    os.setsid()
883
598
    if not nochdir:
884
599
        os.chdir("/")
885
 
    if os.fork():
886
 
        sys.exit()
887
600
    if not noclose:
888
601
        # Close all standard open file descriptors
889
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
602
        null = os.open("/dev/null", os.O_NOCTTY | os.O_RDWR)
890
603
        if not stat.S_ISCHR(os.fstat(null).st_mode):
891
604
            raise OSError(errno.ENODEV,
892
605
                          "/dev/null not a character device")
897
610
            os.close(null)
898
611
 
899
612
 
 
613
def killme(status = 0):
 
614
    logger.debug("Stopping server with exit status %d", status)
 
615
    exitstatus = status
 
616
    if main_loop_started:
 
617
        main_loop.quit()
 
618
    else:
 
619
        sys.exit(status)
 
620
 
 
621
 
900
622
def main():
901
 
    parser = optparse.OptionParser(version = "%%prog %s" % version)
 
623
    global exitstatus
 
624
    exitstatus = 0
 
625
    global main_loop_started
 
626
    main_loop_started = False
 
627
    
 
628
    parser = OptionParser()
902
629
    parser.add_option("-i", "--interface", type="string",
903
 
                      metavar="IF", help="Bind to interface IF")
904
 
    parser.add_option("-a", "--address", type="string",
 
630
                      default=None, metavar="IF",
 
631
                      help="Bind to interface IF")
 
632
    parser.add_option("-a", "--address", type="string", default=None,
905
633
                      help="Address to listen for requests on")
906
 
    parser.add_option("-p", "--port", type="int",
 
634
    parser.add_option("-p", "--port", type="int", default=None,
907
635
                      help="Port number to receive requests on")
908
 
    parser.add_option("--check", action="store_true",
 
636
    parser.add_option("--check", action="store_true", default=False,
909
637
                      help="Run self-test")
910
 
    parser.add_option("--debug", action="store_true",
911
 
                      help="Debug mode; run in foreground and log to"
912
 
                      " terminal")
913
 
    parser.add_option("--priority", type="string", help="GnuTLS"
914
 
                      " priority string (see GnuTLS documentation)")
915
 
    parser.add_option("--servicename", type="string", metavar="NAME",
916
 
                      help="Zeroconf service name")
917
 
    parser.add_option("--configdir", type="string",
918
 
                      default="/etc/mandos", metavar="DIR",
919
 
                      help="Directory to search for configuration"
920
 
                      " files")
921
 
    parser.add_option("--no-dbus", action="store_false",
922
 
                      dest="use_dbus",
923
 
                      help="Do not provide D-Bus system bus"
924
 
                      " interface")
925
 
    options = parser.parse_args()[0]
 
638
    parser.add_option("--debug", action="store_true", default=False,
 
639
                      help="Debug mode")
 
640
    parser.add_option("--priority", type="string",
 
641
                      default="SECURE256",
 
642
                      help="GnuTLS priority string"
 
643
                      " (see GnuTLS documentation)")
 
644
    parser.add_option("--servicename", type="string",
 
645
                      default="Mandos", help="Zeroconf service name")
 
646
    (options, args) = parser.parse_args()
926
647
    
927
648
    if options.check:
928
649
        import doctest
929
650
        doctest.testmod()
930
651
        sys.exit()
931
652
    
932
 
    # Default values for config file for server-global settings
933
 
    server_defaults = { "interface": "",
934
 
                        "address": "",
935
 
                        "port": "",
936
 
                        "debug": "False",
937
 
                        "priority":
938
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
939
 
                        "servicename": "Mandos",
940
 
                        "use_dbus": "True",
941
 
                        }
942
 
    
943
 
    # Parse config file for server-global settings
944
 
    server_config = ConfigParser.SafeConfigParser(server_defaults)
945
 
    del server_defaults
946
 
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
947
 
    # Convert the SafeConfigParser object to a dict
948
 
    server_settings = server_config.defaults()
949
 
    # Use the appropriate methods on the non-string config options
950
 
    server_settings["debug"] = server_config.getboolean("DEFAULT",
951
 
                                                        "debug")
952
 
    server_settings["use_dbus"] = server_config.getboolean("DEFAULT",
953
 
                                                           "use_dbus")
954
 
    if server_settings["port"]:
955
 
        server_settings["port"] = server_config.getint("DEFAULT",
956
 
                                                       "port")
957
 
    del server_config
958
 
    
959
 
    # Override the settings from the config file with command line
960
 
    # options, if set.
961
 
    for option in ("interface", "address", "port", "debug",
962
 
                   "priority", "servicename", "configdir",
963
 
                   "use_dbus"):
964
 
        value = getattr(options, option)
965
 
        if value is not None:
966
 
            server_settings[option] = value
967
 
    del options
968
 
    # Now we have our good server settings in "server_settings"
969
 
    
970
 
    # For convenience
971
 
    debug = server_settings["debug"]
972
 
    use_dbus = server_settings["use_dbus"]
973
 
 
974
 
    def sigsegvhandler(signum, frame):
975
 
        raise RuntimeError('Segmentation fault')
976
 
    
977
 
    if not debug:
978
 
        syslogger.setLevel(logging.WARNING)
979
 
        console.setLevel(logging.WARNING)
980
 
    else:
981
 
        signal.signal(signal.SIGSEGV, sigsegvhandler)
982
 
    
983
 
    if server_settings["servicename"] != "Mandos":
984
 
        syslogger.setFormatter(logging.Formatter
985
 
                               ('Mandos (%s): %%(levelname)s:'
986
 
                                ' %%(message)s'
987
 
                                % server_settings["servicename"]))
988
 
    
989
 
    # Parse config file with clients
990
 
    client_defaults = { "timeout": "1h",
991
 
                        "interval": "5m",
992
 
                        "checker": "fping -q -- %%(host)s",
993
 
                        "host": "",
994
 
                        }
995
 
    client_config = ConfigParser.SafeConfigParser(client_defaults)
996
 
    client_config.read(os.path.join(server_settings["configdir"],
997
 
                                    "clients.conf"))
998
 
    
999
 
    clients = Set()
1000
 
    tcp_server = IPv6_TCPServer((server_settings["address"],
1001
 
                                 server_settings["port"]),
1002
 
                                TCP_handler,
1003
 
                                settings=server_settings,
1004
 
                                clients=clients)
1005
 
    pidfilename = "/var/run/mandos.pid"
1006
 
    try:
1007
 
        pidfile = open(pidfilename, "w")
1008
 
    except IOError, error:
1009
 
        logger.error("Could not open file %r", pidfilename)
1010
 
    
1011
 
    try:
1012
 
        uid = pwd.getpwnam("_mandos").pw_uid
1013
 
        gid = pwd.getpwnam("_mandos").pw_gid
1014
 
    except KeyError:
1015
 
        try:
1016
 
            uid = pwd.getpwnam("mandos").pw_uid
1017
 
            gid = pwd.getpwnam("mandos").pw_gid
1018
 
        except KeyError:
1019
 
            try:
1020
 
                uid = pwd.getpwnam("nobody").pw_uid
1021
 
                gid = pwd.getpwnam("nogroup").pw_gid
1022
 
            except KeyError:
1023
 
                uid = 65534
1024
 
                gid = 65534
1025
 
    try:
1026
 
        os.setgid(gid)
1027
 
        os.setuid(uid)
1028
 
    except OSError, error:
1029
 
        if error[0] != errno.EPERM:
1030
 
            raise error
1031
 
    
1032
 
    # Enable all possible GnuTLS debugging
1033
 
    if debug:
1034
 
        # "Use a log level over 10 to enable all debugging options."
1035
 
        # - GnuTLS manual
1036
 
        gnutls.library.functions.gnutls_global_set_log_level(11)
1037
 
        
1038
 
        @gnutls.library.types.gnutls_log_func
1039
 
        def debug_gnutls(level, string):
1040
 
            logger.debug("GnuTLS: %s", string[:-1])
1041
 
        
1042
 
        (gnutls.library.functions
1043
 
         .gnutls_global_set_log_function(debug_gnutls))
1044
 
    
1045
 
    global service
1046
 
    service = AvahiService(name = server_settings["servicename"],
1047
 
                           servicetype = "_mandos._tcp", )
1048
 
    if server_settings["interface"]:
1049
 
        service.interface = (if_nametoindex
1050
 
                             (server_settings["interface"]))
 
653
    # Parse config file
 
654
    defaults = { "timeout": "1h",
 
655
                 "interval": "5m",
 
656
                 "checker": "fping -q -- %%(fqdn)s",
 
657
                 }
 
658
    client_config = ConfigParser.SafeConfigParser(defaults)
 
659
    #client_config.readfp(open("global.conf"), "global.conf")
 
660
    client_config.read("mandos-clients.conf")
 
661
    
 
662
    global serviceName
 
663
    serviceName = options.servicename;
1051
664
    
1052
665
    global main_loop
1053
666
    global bus
1056
669
    DBusGMainLoop(set_as_default=True )
1057
670
    main_loop = gobject.MainLoop()
1058
671
    bus = dbus.SystemBus()
1059
 
    server = dbus.Interface(bus.get_object(avahi.DBUS_NAME,
1060
 
                                           avahi.DBUS_PATH_SERVER),
1061
 
                            avahi.DBUS_INTERFACE_SERVER)
 
672
    server = dbus.Interface(
 
673
            bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
 
674
            avahi.DBUS_INTERFACE_SERVER )
1062
675
    # End of Avahi example code
1063
 
    if use_dbus:
1064
 
        bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos", bus)
1065
 
    
1066
 
    clients.update(Set(Client(name = section,
1067
 
                              config
1068
 
                              = dict(client_config.items(section)),
1069
 
                              use_dbus = use_dbus)
 
676
    
 
677
    debug = options.debug
 
678
    
 
679
    if debug:
 
680
        console = logging.StreamHandler()
 
681
        # console.setLevel(logging.DEBUG)
 
682
        console.setFormatter(logging.Formatter\
 
683
                             ('%(levelname)s: %(message)s'))
 
684
        logger.addHandler(console)
 
685
        del console
 
686
    
 
687
    clients = Set()
 
688
    def remove_from_clients(client):
 
689
        clients.remove(client)
 
690
        if not clients:
 
691
            logger.debug(u"No clients left, exiting")
 
692
            killme()
 
693
    
 
694
    clients.update(Set(Client(name=section,
 
695
                              stop_hook = remove_from_clients,
 
696
                              **(dict(client_config\
 
697
                                      .items(section))))
1070
698
                       for section in client_config.sections()))
1071
 
    if not clients:
1072
 
        logger.warning(u"No clients defined")
1073
 
    
1074
 
    if debug:
1075
 
        # Redirect stdin so all checkers get /dev/null
1076
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1077
 
        os.dup2(null, sys.stdin.fileno())
1078
 
        if null > 2:
1079
 
            os.close(null)
1080
 
    else:
1081
 
        # No console logging
1082
 
        logger.removeHandler(console)
1083
 
        # Close all input and output, do double fork, etc.
1084
 
        daemon()
1085
 
    
1086
 
    try:
1087
 
        pid = os.getpid()
1088
 
        pidfile.write(str(pid) + "\n")
1089
 
        pidfile.close()
1090
 
        del pidfile
1091
 
    except IOError:
1092
 
        logger.error(u"Could not write to file %r with PID %d",
1093
 
                     pidfilename, pid)
1094
 
    except NameError:
1095
 
        # "pidfile" was never created
1096
 
        pass
1097
 
    del pidfilename
 
699
    
 
700
    if not debug:
 
701
        daemon(False, False)
1098
702
    
1099
703
    def cleanup():
1100
704
        "Cleanup function; run on exit"
1107
711
        
1108
712
        while clients:
1109
713
            client = clients.pop()
1110
 
            client.disable_hook = None
1111
 
            client.disable()
 
714
            client.stop_hook = None
 
715
            client.stop()
1112
716
    
1113
717
    atexit.register(cleanup)
1114
718
    
1115
719
    if not debug:
1116
720
        signal.signal(signal.SIGINT, signal.SIG_IGN)
1117
 
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1118
 
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1119
 
    
1120
 
    if use_dbus:
1121
 
        class MandosServer(dbus.service.Object):
1122
 
            """A D-Bus proxy object"""
1123
 
            def __init__(self):
1124
 
                dbus.service.Object.__init__(self, bus, "/")
1125
 
            _interface = u"se.bsnet.fukt.Mandos"
1126
 
            
1127
 
            @dbus.service.signal(_interface, signature="oa{sv}")
1128
 
            def ClientAdded(self, objpath, properties):
1129
 
                "D-Bus signal"
1130
 
                pass
1131
 
            
1132
 
            @dbus.service.signal(_interface, signature="os")
1133
 
            def ClientRemoved(self, objpath, name):
1134
 
                "D-Bus signal"
1135
 
                pass
1136
 
            
1137
 
            @dbus.service.method(_interface, out_signature="ao")
1138
 
            def GetAllClients(self):
1139
 
                "D-Bus method"
1140
 
                return dbus.Array(c.dbus_object_path for c in clients)
1141
 
            
1142
 
            @dbus.service.method(_interface, out_signature="a{oa{sv}}")
1143
 
            def GetAllClientsWithProperties(self):
1144
 
                "D-Bus method"
1145
 
                return dbus.Dictionary(
1146
 
                    ((c.dbus_object_path, c.GetAllProperties())
1147
 
                     for c in clients),
1148
 
                    signature="oa{sv}")
1149
 
            
1150
 
            @dbus.service.method(_interface, in_signature="o")
1151
 
            def RemoveClient(self, object_path):
1152
 
                "D-Bus method"
1153
 
                for c in clients:
1154
 
                    if c.dbus_object_path == object_path:
1155
 
                        clients.remove(c)
1156
 
                        # Don't signal anything except ClientRemoved
1157
 
                        c.use_dbus = False
1158
 
                        c.disable()
1159
 
                        # Emit D-Bus signal
1160
 
                        self.ClientRemoved(object_path, c.name)
1161
 
                        return
1162
 
                raise KeyError
1163
 
            
1164
 
            del _interface
1165
 
        
1166
 
        mandos_server = MandosServer()
 
721
    signal.signal(signal.SIGHUP, lambda signum, frame: killme())
 
722
    signal.signal(signal.SIGTERM, lambda signum, frame: killme())
1167
723
    
1168
724
    for client in clients:
1169
 
        if use_dbus:
1170
 
            # Emit D-Bus signal
1171
 
            mandos_server.ClientAdded(client.dbus_object_path,
1172
 
                                      client.GetAllProperties())
1173
 
        client.enable()
1174
 
    
1175
 
    tcp_server.enable()
1176
 
    tcp_server.server_activate()
1177
 
    
1178
 
    # Find out what port we got
1179
 
    service.port = tcp_server.socket.getsockname()[1]
1180
 
    logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
1181
 
                u" scope_id %d" % tcp_server.socket.getsockname())
1182
 
    
1183
 
    #service.interface = tcp_server.socket.getsockname()[3]
1184
 
    
1185
 
    try:
1186
 
        # From the Avahi example code
1187
 
        server.connect_to_signal("StateChanged", server_state_changed)
1188
 
        try:
1189
 
            server_state_changed(server.GetState())
1190
 
        except dbus.exceptions.DBusException, error:
1191
 
            logger.critical(u"DBusException: %s", error)
1192
 
            sys.exit(1)
1193
 
        # End of Avahi example code
1194
 
        
1195
 
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
1196
 
                             lambda *args, **kwargs:
1197
 
                             (tcp_server.handle_request
1198
 
                              (*args[2:], **kwargs) or True))
1199
 
        
1200
 
        logger.debug(u"Starting main loop")
 
725
        client.start()
 
726
    
 
727
    tcp_server = IPv6_TCPServer((options.address, options.port),
 
728
                                tcp_handler,
 
729
                                options=options,
 
730
                                clients=clients)
 
731
    # Find out what random port we got
 
732
    global servicePort
 
733
    servicePort = tcp_server.socket.getsockname()[1]
 
734
    logger.debug(u"Now listening on port %d", servicePort)
 
735
    
 
736
    if options.interface is not None:
 
737
        global serviceInterface
 
738
        serviceInterface = if_nametoindex(options.interface)
 
739
    
 
740
    # From the Avahi example code
 
741
    server.connect_to_signal("StateChanged", server_state_changed)
 
742
    try:
 
743
        server_state_changed(server.GetState())
 
744
    except dbus.exceptions.DBusException, error:
 
745
        logger.critical(u"DBusException: %s", error)
 
746
        killme(1)
 
747
    # End of Avahi example code
 
748
    
 
749
    gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
 
750
                         lambda *args, **kwargs:
 
751
                         tcp_server.handle_request(*args[2:],
 
752
                                                   **kwargs) or True)
 
753
    try:
 
754
        logger.debug("Starting main loop")
 
755
        main_loop_started = True
1201
756
        main_loop.run()
1202
 
    except AvahiError, error:
1203
 
        logger.critical(u"AvahiError: %s", error)
1204
 
        sys.exit(1)
1205
757
    except KeyboardInterrupt:
1206
758
        if debug:
1207
759
            print
 
760
    
 
761
    sys.exit(exitstatus)
1208
762
 
1209
763
if __name__ == '__main__':
1210
764
    main()