/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

* mandos-ctl: Made work again after D-Bus API changes.
  (datetime_to_milliseconds): Renamed to "timedelta_to_milliseconds".
                              All callers changed.
  (milliseconds_to_string): Use clearer mapping string format.
  (string_to_delta): Add some comments.

Show diffs side-by-side

added added

removed removed

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