/mandos/trunk

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

« back to all changes in this revision

Viewing changes to server.py

  • Committer: Teddy Hogeborn
  • Date: 2008-07-19 18:43:24 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080719184324-iwhoa5in75xa0u2u
* mandos-clients.conf ([foo]/dn, [foo]/password, [braxen_client]/dn,
                       [braxen_client]/password): Removed.
  ([foo]/fingerprint, [braxen_client]/fingerprint): New.
  ([foo]/checker): New.
  ([foo]/secfile): New.
  ([braxen_client]/secret): New.

* server.py: New "--debug" option to set debug flag.  Removed "cert",
             "key", "ca", "crl", and "cred" variables.  Added default
             value for "checker" config file setting.  Do not pass
             credentials to IPv6_TCPServer constructor.
  (debug): New global debug flag.  Used by most debugging output code.
  (Client.__init__): Keyword argument "dn" replaced by "fingerprint",
                     "password" renamed to "secret", and "passfile"
                     renamed to "secfile".  New keyword argument
                     "checker". All callers changed.
  (Client.dn): Removed.
  (Client.fingerprint): New.
  (Client.password): Renamed to "secret"; all users changed.
  (Client.passfile): Renamed to "secfile"; all users changed.
  (Client.timeout, Client.interval): Changed to be properties; now
                                     automatically updates the
                                     "_timeout_milliseconds" and
                                     "_interval_milliseconds" values.
  (Client.timeout_milliseconds): Renamed to "_timeout_milliseconds".
  (Client.interval_milliseconds): Renamed to "_interval_milliseconds".
  (Client.check_command): New.
  (Client.start_checker): Use the new "check_command" attribute.
  (peer_certificate, fingerprint): New functions.

  (tcp_handler.handle): Use ClientSession with empty credentials
                        object instead of ServerSession.  Set gnutls
                        priority string.  Do not verify peer.  Use
                        fingerprint instead of DN when searching for
                        clients.  Bug fix: Loop sending data so even large
                        secret data strings are sent.
  (IPv6_TCPServer.credentials): Removed.
  (if_nametoindex): Do not import ctypes since that is now imported
                    globally.

Show diffs side-by-side

added added

removed removed

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