/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-01-30 17:28:18 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080130172818-fnrq2xmtg1wa8wo2
* client.cpp (main): Get t_old early since it is used on error exits.

* server.py (Client.checker): New attribute.
  (Client.check_action, Client.start_checker, Client.stop_checker,
  Client.fileno, Client.next_stop, Client.still_valid,
  Client.it_is_time_to_check): New methods.
  (Client.handle_request): Alias to "check_action".
  (main): Stop all started checkers on exit.  Exit cleanly on keyboard
  interrupt.

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