/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

Added optional parameters certdir, certkey and certfile that can be iven at start in the command line.

Show diffs side-by-side

added added

removed removed

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