/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2009-01-18 00:18:50 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090118001850-pvg8xjwmbyt23fom
* debian/rules (install-indep): Removed "--no-start" from
                                dh_installinit.

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