/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-18 21:23:46 UTC
  • mfrom: (2.1.1 Project)
  • Revision ID: teddy@fukt.bsnet.se-20080118212346-qo103d6o8r7xs4za
Merged from Björn.

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