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