/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: 2015-05-31 15:56:58 UTC
  • Revision ID: teddy@recompile.se-20150531155658-l7znu7zlqr2dmuwd
mandos: Generate better messages in exceptions.

mandos (ProxyClient.__init__): Include fingerprint in KeyError().
(rfc3339_duration_to_delta): Include duration in ValueError().

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#!/usr/bin/python
 
1
#!/usr/bin/python2.7
2
2
# -*- mode: python; coding: utf-8 -*-
3
3
4
4
# Mandos server - give out binary blobs to connecting clients.
6
6
# This program is partly derived from an example program for an Avahi
7
7
# service publisher, downloaded from
8
8
# <http://avahi.org/wiki/PythonPublishExample>.  This includes the
9
 
# methods "add" and "remove" in the "AvahiService" class, the
10
 
# "server_state_changed" and "entry_group_state_changed" functions,
11
 
# and some lines in "main".
 
9
# methods "add", "remove", "server_state_changed",
 
10
# "entry_group_state_changed", "cleanup", and "activate" in the
 
11
# "AvahiService" class, and some lines in "main".
12
12
13
13
# Everything else is
14
 
# Copyright © 2007-2008 Teddy Hogeborn & Björn Påhlsson
 
14
# Copyright © 2008-2015 Teddy Hogeborn
 
15
# Copyright © 2008-2015 Björn Påhlsson
15
16
16
17
# This program is free software: you can redistribute it and/or modify
17
18
# it under the terms of the GNU General Public License as published by
24
25
#     GNU General Public License for more details.
25
26
26
27
# You should have received a copy of the GNU General Public License
27
 
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
28
 
29
 
# Contact the authors at <mandos@fukt.bsnet.se>.
30
 
31
 
 
32
 
from __future__ import division
33
 
 
34
 
import SocketServer
 
28
# along with this program.  If not, see
 
29
# <http://www.gnu.org/licenses/>.
 
30
 
31
# Contact the authors at <mandos@recompile.se>.
 
32
 
33
 
 
34
from __future__ import (division, absolute_import, print_function,
 
35
                        unicode_literals)
 
36
 
 
37
from future_builtins import *
 
38
 
 
39
try:
 
40
    import SocketServer as socketserver
 
41
except ImportError:
 
42
    import socketserver
35
43
import socket
36
 
import select
37
 
from optparse import OptionParser
 
44
import argparse
38
45
import datetime
39
46
import errno
40
47
import gnutls.crypto
43
50
import gnutls.library.functions
44
51
import gnutls.library.constants
45
52
import gnutls.library.types
46
 
import ConfigParser
 
53
try:
 
54
    import ConfigParser as configparser
 
55
except ImportError:
 
56
    import configparser
47
57
import sys
48
58
import re
49
59
import os
50
60
import signal
51
 
from sets import Set
52
61
import subprocess
53
62
import atexit
54
63
import stat
55
64
import logging
56
65
import logging.handlers
 
66
import pwd
 
67
import contextlib
 
68
import struct
 
69
import fcntl
 
70
import functools
 
71
try:
 
72
    import cPickle as pickle
 
73
except ImportError:
 
74
    import pickle
 
75
import multiprocessing
 
76
import types
 
77
import binascii
 
78
import tempfile
 
79
import itertools
 
80
import collections
 
81
import codecs
57
82
 
58
83
import dbus
59
 
import gobject
 
84
import dbus.service
 
85
try:
 
86
    import gobject
 
87
except ImportError:
 
88
    from gi.repository import GObject as gobject
60
89
import avahi
61
90
from dbus.mainloop.glib import DBusGMainLoop
62
91
import ctypes
63
 
 
64
 
version = "1.0"
65
 
 
66
 
logger = logging.Logger('mandos')
67
 
syslogger = logging.handlers.SysLogHandler\
68
 
            (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
69
 
             address = "/dev/log")
70
 
syslogger.setFormatter(logging.Formatter\
71
 
                        ('Mandos: %(levelname)s: %(message)s'))
72
 
logger.addHandler(syslogger)
73
 
 
74
 
console = logging.StreamHandler()
75
 
console.setFormatter(logging.Formatter('%(name)s: %(levelname)s:'
76
 
                                       ' %(message)s'))
77
 
logger.addHandler(console)
 
92
import ctypes.util
 
93
import xml.dom.minidom
 
94
import inspect
 
95
 
 
96
try:
 
97
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
 
98
except AttributeError:
 
99
    try:
 
100
        from IN import SO_BINDTODEVICE
 
101
    except ImportError:
 
102
        SO_BINDTODEVICE = None
 
103
 
 
104
if sys.version_info.major == 2:
 
105
    str = unicode
 
106
 
 
107
version = "1.6.9"
 
108
stored_state_file = "clients.pickle"
 
109
 
 
110
logger = logging.getLogger()
 
111
syslogger = None
 
112
 
 
113
try:
 
114
    if_nametoindex = ctypes.cdll.LoadLibrary(
 
115
        ctypes.util.find_library("c")).if_nametoindex
 
116
except (OSError, AttributeError):
 
117
    
 
118
    def if_nametoindex(interface):
 
119
        "Get an interface index the hard way, i.e. using fcntl()"
 
120
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
 
121
        with contextlib.closing(socket.socket()) as s:
 
122
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
 
123
                                struct.pack(b"16s16x", interface))
 
124
        interface_index = struct.unpack("I", ifreq[16:20])[0]
 
125
        return interface_index
 
126
 
 
127
 
 
128
def initlogger(debug, level=logging.WARNING):
 
129
    """init logger and add loglevel"""
 
130
    
 
131
    global syslogger
 
132
    syslogger = (logging.handlers.SysLogHandler(
 
133
        facility = logging.handlers.SysLogHandler.LOG_DAEMON,
 
134
        address = "/dev/log"))
 
135
    syslogger.setFormatter(logging.Formatter
 
136
                           ('Mandos [%(process)d]: %(levelname)s:'
 
137
                            ' %(message)s'))
 
138
    logger.addHandler(syslogger)
 
139
    
 
140
    if debug:
 
141
        console = logging.StreamHandler()
 
142
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
 
143
                                               ' [%(process)d]:'
 
144
                                               ' %(levelname)s:'
 
145
                                               ' %(message)s'))
 
146
        logger.addHandler(console)
 
147
    logger.setLevel(level)
 
148
 
 
149
 
 
150
class PGPError(Exception):
 
151
    """Exception if encryption/decryption fails"""
 
152
    pass
 
153
 
 
154
 
 
155
class PGPEngine(object):
 
156
    """A simple class for OpenPGP symmetric encryption & decryption"""
 
157
    
 
158
    def __init__(self):
 
159
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
 
160
        self.gnupgargs = ['--batch',
 
161
                          '--home', self.tempdir,
 
162
                          '--force-mdc',
 
163
                          '--quiet',
 
164
                          '--no-use-agent']
 
165
    
 
166
    def __enter__(self):
 
167
        return self
 
168
    
 
169
    def __exit__(self, exc_type, exc_value, traceback):
 
170
        self._cleanup()
 
171
        return False
 
172
    
 
173
    def __del__(self):
 
174
        self._cleanup()
 
175
    
 
176
    def _cleanup(self):
 
177
        if self.tempdir is not None:
 
178
            # Delete contents of tempdir
 
179
            for root, dirs, files in os.walk(self.tempdir,
 
180
                                             topdown = False):
 
181
                for filename in files:
 
182
                    os.remove(os.path.join(root, filename))
 
183
                for dirname in dirs:
 
184
                    os.rmdir(os.path.join(root, dirname))
 
185
            # Remove tempdir
 
186
            os.rmdir(self.tempdir)
 
187
            self.tempdir = None
 
188
    
 
189
    def password_encode(self, password):
 
190
        # Passphrase can not be empty and can not contain newlines or
 
191
        # NUL bytes.  So we prefix it and hex encode it.
 
192
        encoded = b"mandos" + binascii.hexlify(password)
 
193
        if len(encoded) > 2048:
 
194
            # GnuPG can't handle long passwords, so encode differently
 
195
            encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
 
196
                       .replace(b"\n", b"\\n")
 
197
                       .replace(b"\0", b"\\x00"))
 
198
        return encoded
 
199
    
 
200
    def encrypt(self, data, password):
 
201
        passphrase = self.password_encode(password)
 
202
        with tempfile.NamedTemporaryFile(
 
203
                dir=self.tempdir) as passfile:
 
204
            passfile.write(passphrase)
 
205
            passfile.flush()
 
206
            proc = subprocess.Popen(['gpg', '--symmetric',
 
207
                                     '--passphrase-file',
 
208
                                     passfile.name]
 
209
                                    + self.gnupgargs,
 
210
                                    stdin = subprocess.PIPE,
 
211
                                    stdout = subprocess.PIPE,
 
212
                                    stderr = subprocess.PIPE)
 
213
            ciphertext, err = proc.communicate(input = data)
 
214
        if proc.returncode != 0:
 
215
            raise PGPError(err)
 
216
        return ciphertext
 
217
    
 
218
    def decrypt(self, data, password):
 
219
        passphrase = self.password_encode(password)
 
220
        with tempfile.NamedTemporaryFile(
 
221
                dir = self.tempdir) as passfile:
 
222
            passfile.write(passphrase)
 
223
            passfile.flush()
 
224
            proc = subprocess.Popen(['gpg', '--decrypt',
 
225
                                     '--passphrase-file',
 
226
                                     passfile.name]
 
227
                                    + self.gnupgargs,
 
228
                                    stdin = subprocess.PIPE,
 
229
                                    stdout = subprocess.PIPE,
 
230
                                    stderr = subprocess.PIPE)
 
231
            decrypted_plaintext, err = proc.communicate(input = data)
 
232
        if proc.returncode != 0:
 
233
            raise PGPError(err)
 
234
        return decrypted_plaintext
 
235
 
78
236
 
79
237
class AvahiError(Exception):
80
 
    def __init__(self, value):
 
238
    def __init__(self, value, *args, **kwargs):
81
239
        self.value = value
82
 
    def __str__(self):
83
 
        return repr(self.value)
 
240
        return super(AvahiError, self).__init__(value, *args,
 
241
                                                **kwargs)
 
242
 
84
243
 
85
244
class AvahiServiceError(AvahiError):
86
245
    pass
87
246
 
 
247
 
88
248
class AvahiGroupError(AvahiError):
89
249
    pass
90
250
 
91
251
 
92
252
class AvahiService(object):
93
253
    """An Avahi (Zeroconf) service.
 
254
    
94
255
    Attributes:
95
256
    interface: integer; avahi.IF_UNSPEC or an interface index.
96
257
               Used to optionally bind to the specified interface.
97
258
    name: string; Example: 'Mandos'
98
259
    type: string; Example: '_mandos._tcp'.
99
 
                  See <http://www.dns-sd.org/ServiceTypes.html>
 
260
     See <https://www.iana.org/assignments/service-names-port-numbers>
100
261
    port: integer; what port to announce
101
262
    TXT: list of strings; TXT record for the service
102
263
    domain: string; Domain to publish on, default to .local if empty.
104
265
    max_renames: integer; maximum number of renames
105
266
    rename_count: integer; counter so we only rename after collisions
106
267
                  a sensible number of times
 
268
    group: D-Bus Entry Group
 
269
    server: D-Bus Server
 
270
    bus: dbus.SystemBus()
107
271
    """
108
 
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
109
 
                 type = None, port = None, TXT = None, domain = "",
110
 
                 host = "", max_renames = 32768):
 
272
    
 
273
    def __init__(self,
 
274
                 interface = avahi.IF_UNSPEC,
 
275
                 name = None,
 
276
                 servicetype = None,
 
277
                 port = None,
 
278
                 TXT = None,
 
279
                 domain = "",
 
280
                 host = "",
 
281
                 max_renames = 32768,
 
282
                 protocol = avahi.PROTO_UNSPEC,
 
283
                 bus = None):
111
284
        self.interface = interface
112
285
        self.name = name
113
 
        self.type = type
 
286
        self.type = servicetype
114
287
        self.port = port
115
 
        if TXT is None:
116
 
            self.TXT = []
117
 
        else:
118
 
            self.TXT = TXT
 
288
        self.TXT = TXT if TXT is not None else []
119
289
        self.domain = domain
120
290
        self.host = host
121
291
        self.rename_count = 0
122
292
        self.max_renames = max_renames
123
 
    def rename(self):
 
293
        self.protocol = protocol
 
294
        self.group = None       # our entry group
 
295
        self.server = None
 
296
        self.bus = bus
 
297
        self.entry_group_state_changed_match = None
 
298
    
 
299
    def rename(self, remove=True):
124
300
        """Derived from the Avahi example code"""
125
301
        if self.rename_count >= self.max_renames:
126
 
            logger.critical(u"No suitable service name found after %i"
127
 
                            u" retries, exiting.", rename_count)
 
302
            logger.critical("No suitable Zeroconf service name found"
 
303
                            " after %i retries, exiting.",
 
304
                            self.rename_count)
128
305
            raise AvahiServiceError("Too many renames")
129
 
        self.name = server.GetAlternativeServiceName(self.name)
130
 
        logger.info(u"Changing name to %r ...", str(self.name))
131
 
        syslogger.setFormatter(logging.Formatter\
132
 
                               ('Mandos (%s): %%(levelname)s:'
133
 
                               ' %%(message)s' % self.name))
134
 
        self.remove()
135
 
        self.add()
 
306
        self.name = str(
 
307
            self.server.GetAlternativeServiceName(self.name))
136
308
        self.rename_count += 1
 
309
        logger.info("Changing Zeroconf service name to %r ...",
 
310
                    self.name)
 
311
        if remove:
 
312
            self.remove()
 
313
        try:
 
314
            self.add()
 
315
        except dbus.exceptions.DBusException as error:
 
316
            if (error.get_dbus_name()
 
317
                == "org.freedesktop.Avahi.CollisionError"):
 
318
                logger.info("Local Zeroconf service name collision.")
 
319
                return self.rename(remove=False)
 
320
            else:
 
321
                logger.critical("D-Bus Exception", exc_info=error)
 
322
                self.cleanup()
 
323
                os._exit(1)
 
324
    
137
325
    def remove(self):
138
326
        """Derived from the Avahi example code"""
139
 
        if group is not None:
140
 
            group.Reset()
 
327
        if self.entry_group_state_changed_match is not None:
 
328
            self.entry_group_state_changed_match.remove()
 
329
            self.entry_group_state_changed_match = None
 
330
        if self.group is not None:
 
331
            self.group.Reset()
 
332
    
141
333
    def add(self):
142
334
        """Derived from the Avahi example code"""
143
 
        global group
144
 
        if group is None:
145
 
            group = dbus.Interface\
146
 
                    (bus.get_object(avahi.DBUS_NAME,
147
 
                                    server.EntryGroupNew()),
148
 
                     avahi.DBUS_INTERFACE_ENTRY_GROUP)
149
 
            group.connect_to_signal('StateChanged',
150
 
                                    entry_group_state_changed)
151
 
        logger.debug(u"Adding service '%s' of type '%s' ...",
152
 
                     service.name, service.type)
153
 
        group.AddService(
154
 
                self.interface,         # interface
155
 
                avahi.PROTO_INET6,      # protocol
156
 
                dbus.UInt32(0),         # flags
157
 
                self.name, self.type,
158
 
                self.domain, self.host,
159
 
                dbus.UInt16(self.port),
160
 
                avahi.string_array_to_txt_array(self.TXT))
161
 
        group.Commit()
162
 
 
163
 
# From the Avahi example code:
164
 
group = None                            # our entry group
165
 
# End of Avahi example code
 
335
        self.remove()
 
336
        if self.group is None:
 
337
            self.group = dbus.Interface(
 
338
                self.bus.get_object(avahi.DBUS_NAME,
 
339
                                    self.server.EntryGroupNew()),
 
340
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
 
341
        self.entry_group_state_changed_match = (
 
342
            self.group.connect_to_signal(
 
343
                'StateChanged', self.entry_group_state_changed))
 
344
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
 
345
                     self.name, self.type)
 
346
        self.group.AddService(
 
347
            self.interface,
 
348
            self.protocol,
 
349
            dbus.UInt32(0),     # flags
 
350
            self.name, self.type,
 
351
            self.domain, self.host,
 
352
            dbus.UInt16(self.port),
 
353
            avahi.string_array_to_txt_array(self.TXT))
 
354
        self.group.Commit()
 
355
    
 
356
    def entry_group_state_changed(self, state, error):
 
357
        """Derived from the Avahi example code"""
 
358
        logger.debug("Avahi entry group state change: %i", state)
 
359
        
 
360
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
 
361
            logger.debug("Zeroconf service established.")
 
362
        elif state == avahi.ENTRY_GROUP_COLLISION:
 
363
            logger.info("Zeroconf service name collision.")
 
364
            self.rename()
 
365
        elif state == avahi.ENTRY_GROUP_FAILURE:
 
366
            logger.critical("Avahi: Error in group state changed %s",
 
367
                            str(error))
 
368
            raise AvahiGroupError("State changed: {!s}".format(error))
 
369
    
 
370
    def cleanup(self):
 
371
        """Derived from the Avahi example code"""
 
372
        if self.group is not None:
 
373
            try:
 
374
                self.group.Free()
 
375
            except (dbus.exceptions.UnknownMethodException,
 
376
                    dbus.exceptions.DBusException):
 
377
                pass
 
378
            self.group = None
 
379
        self.remove()
 
380
    
 
381
    def server_state_changed(self, state, error=None):
 
382
        """Derived from the Avahi example code"""
 
383
        logger.debug("Avahi server state change: %i", state)
 
384
        bad_states = {
 
385
            avahi.SERVER_INVALID: "Zeroconf server invalid",
 
386
            avahi.SERVER_REGISTERING: None,
 
387
            avahi.SERVER_COLLISION: "Zeroconf server name collision",
 
388
            avahi.SERVER_FAILURE: "Zeroconf server failure",
 
389
        }
 
390
        if state in bad_states:
 
391
            if bad_states[state] is not None:
 
392
                if error is None:
 
393
                    logger.error(bad_states[state])
 
394
                else:
 
395
                    logger.error(bad_states[state] + ": %r", error)
 
396
            self.cleanup()
 
397
        elif state == avahi.SERVER_RUNNING:
 
398
            self.add()
 
399
        else:
 
400
            if error is None:
 
401
                logger.debug("Unknown state: %r", state)
 
402
            else:
 
403
                logger.debug("Unknown state: %r: %r", state, error)
 
404
    
 
405
    def activate(self):
 
406
        """Derived from the Avahi example code"""
 
407
        if self.server is None:
 
408
            self.server = dbus.Interface(
 
409
                self.bus.get_object(avahi.DBUS_NAME,
 
410
                                    avahi.DBUS_PATH_SERVER,
 
411
                                    follow_name_owner_changes=True),
 
412
                avahi.DBUS_INTERFACE_SERVER)
 
413
        self.server.connect_to_signal("StateChanged",
 
414
                                      self.server_state_changed)
 
415
        self.server_state_changed(self.server.GetState())
 
416
 
 
417
 
 
418
class AvahiServiceToSyslog(AvahiService):
 
419
    def rename(self, *args, **kwargs):
 
420
        """Add the new name to the syslog messages"""
 
421
        ret = AvahiService.rename(self, *args, **kwargs)
 
422
        syslogger.setFormatter(logging.Formatter(
 
423
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
 
424
            .format(self.name)))
 
425
        return ret
166
426
 
167
427
 
168
428
class Client(object):
169
429
    """A representation of a client host served by this server.
 
430
    
170
431
    Attributes:
171
 
    name:      string; from the config file, used in log messages
 
432
    approved:   bool(); 'None' if not yet approved/disapproved
 
433
    approval_delay: datetime.timedelta(); Time to wait for approval
 
434
    approval_duration: datetime.timedelta(); Duration of one approval
 
435
    checker:    subprocess.Popen(); a running checker process used
 
436
                                    to see if the client lives.
 
437
                                    'None' if no process is running.
 
438
    checker_callback_tag: a gobject event source tag, or None
 
439
    checker_command: string; External command which is run to check
 
440
                     if client lives.  %() expansions are done at
 
441
                     runtime with vars(self) as dict, so that for
 
442
                     instance %(name)s can be used in the command.
 
443
    checker_initiator_tag: a gobject event source tag, or None
 
444
    created:    datetime.datetime(); (UTC) object creation
 
445
    client_structure: Object describing what attributes a client has
 
446
                      and is used for storing the client at exit
 
447
    current_checker_command: string; current running checker_command
 
448
    disable_initiator_tag: a gobject event source tag, or None
 
449
    enabled:    bool()
172
450
    fingerprint: string (40 or 32 hexadecimal digits); used to
173
451
                 uniquely identify the client
174
 
    secret:    bytestring; sent verbatim (over TLS) to client
175
 
    host:      string; available for use by the checker command
176
 
    created:   datetime.datetime(); object creation, not client host
177
 
    last_checked_ok: datetime.datetime() or None if not yet checked OK
178
 
    timeout:   datetime.timedelta(); How long from last_checked_ok
179
 
                                     until this client is invalid
180
 
    interval:  datetime.timedelta(); How often to start a new checker
181
 
    stop_hook: If set, called by stop() as stop_hook(self)
182
 
    checker:   subprocess.Popen(); a running checker process used
183
 
                                   to see if the client lives.
184
 
                                   'None' if no process is running.
185
 
    checker_initiator_tag: a gobject event source tag, or None
186
 
    stop_initiator_tag:    - '' -
187
 
    checker_callback_tag:  - '' -
188
 
    checker_command: string; External command which is run to check if
189
 
                     client lives.  %() expansions are done at
190
 
                     runtime with vars(self) as dict, so that for
191
 
                     instance %(name)s can be used in the command.
192
 
    Private attibutes:
193
 
    _timeout: Real variable for 'timeout'
194
 
    _interval: Real variable for 'interval'
195
 
    _timeout_milliseconds: Used when calling gobject.timeout_add()
196
 
    _interval_milliseconds: - '' -
 
452
    host:       string; available for use by the checker command
 
453
    interval:   datetime.timedelta(); How often to start a new checker
 
454
    last_approval_request: datetime.datetime(); (UTC) or None
 
455
    last_checked_ok: datetime.datetime(); (UTC) or None
 
456
    last_checker_status: integer between 0 and 255 reflecting exit
 
457
                         status of last checker. -1 reflects crashed
 
458
                         checker, -2 means no checker completed yet.
 
459
    last_enabled: datetime.datetime(); (UTC) or None
 
460
    name:       string; from the config file, used in log messages and
 
461
                        D-Bus identifiers
 
462
    secret:     bytestring; sent verbatim (over TLS) to client
 
463
    timeout:    datetime.timedelta(); How long from last_checked_ok
 
464
                                      until this client is disabled
 
465
    extended_timeout:   extra long timeout when secret has been sent
 
466
    runtime_expansions: Allowed attributes for runtime expansion.
 
467
    expires:    datetime.datetime(); time (UTC) when a client will be
 
468
                disabled, or None
 
469
    server_settings: The server_settings dict from main()
197
470
    """
198
 
    def _set_timeout(self, timeout):
199
 
        "Setter function for 'timeout' attribute"
200
 
        self._timeout = timeout
201
 
        self._timeout_milliseconds = ((self.timeout.days
202
 
                                       * 24 * 60 * 60 * 1000)
203
 
                                      + (self.timeout.seconds * 1000)
204
 
                                      + (self.timeout.microseconds
205
 
                                         // 1000))
206
 
    timeout = property(lambda self: self._timeout,
207
 
                       _set_timeout)
208
 
    del _set_timeout
209
 
    def _set_interval(self, interval):
210
 
        "Setter function for 'interval' attribute"
211
 
        self._interval = interval
212
 
        self._interval_milliseconds = ((self.interval.days
213
 
                                        * 24 * 60 * 60 * 1000)
214
 
                                       + (self.interval.seconds
215
 
                                          * 1000)
216
 
                                       + (self.interval.microseconds
217
 
                                          // 1000))
218
 
    interval = property(lambda self: self._interval,
219
 
                        _set_interval)
220
 
    del _set_interval
221
 
    def __init__(self, name = None, stop_hook=None, config={}):
222
 
        """Note: the 'checker' key in 'config' sets the
223
 
        'checker_command' attribute and *not* the 'checker'
224
 
        attribute."""
 
471
    
 
472
    runtime_expansions = ("approval_delay", "approval_duration",
 
473
                          "created", "enabled", "expires",
 
474
                          "fingerprint", "host", "interval",
 
475
                          "last_approval_request", "last_checked_ok",
 
476
                          "last_enabled", "name", "timeout")
 
477
    client_defaults = {
 
478
        "timeout": "PT5M",
 
479
        "extended_timeout": "PT15M",
 
480
        "interval": "PT2M",
 
481
        "checker": "fping -q -- %%(host)s",
 
482
        "host": "",
 
483
        "approval_delay": "PT0S",
 
484
        "approval_duration": "PT1S",
 
485
        "approved_by_default": "True",
 
486
        "enabled": "True",
 
487
    }
 
488
    
 
489
    @staticmethod
 
490
    def config_parser(config):
 
491
        """Construct a new dict of client settings of this form:
 
492
        { client_name: {setting_name: value, ...}, ...}
 
493
        with exceptions for any special settings as defined above.
 
494
        NOTE: Must be a pure function. Must return the same result
 
495
        value given the same arguments.
 
496
        """
 
497
        settings = {}
 
498
        for client_name in config.sections():
 
499
            section = dict(config.items(client_name))
 
500
            client = settings[client_name] = {}
 
501
            
 
502
            client["host"] = section["host"]
 
503
            # Reformat values from string types to Python types
 
504
            client["approved_by_default"] = config.getboolean(
 
505
                client_name, "approved_by_default")
 
506
            client["enabled"] = config.getboolean(client_name,
 
507
                                                  "enabled")
 
508
            
 
509
            # Uppercase and remove spaces from fingerprint for later
 
510
            # comparison purposes with return value from the
 
511
            # fingerprint() function
 
512
            client["fingerprint"] = (section["fingerprint"].upper()
 
513
                                     .replace(" ", ""))
 
514
            if "secret" in section:
 
515
                client["secret"] = section["secret"].decode("base64")
 
516
            elif "secfile" in section:
 
517
                with open(os.path.expanduser(os.path.expandvars
 
518
                                             (section["secfile"])),
 
519
                          "rb") as secfile:
 
520
                    client["secret"] = secfile.read()
 
521
            else:
 
522
                raise TypeError("No secret or secfile for section {}"
 
523
                                .format(section))
 
524
            client["timeout"] = string_to_delta(section["timeout"])
 
525
            client["extended_timeout"] = string_to_delta(
 
526
                section["extended_timeout"])
 
527
            client["interval"] = string_to_delta(section["interval"])
 
528
            client["approval_delay"] = string_to_delta(
 
529
                section["approval_delay"])
 
530
            client["approval_duration"] = string_to_delta(
 
531
                section["approval_duration"])
 
532
            client["checker_command"] = section["checker"]
 
533
            client["last_approval_request"] = None
 
534
            client["last_checked_ok"] = None
 
535
            client["last_checker_status"] = -2
 
536
        
 
537
        return settings
 
538
    
 
539
    def __init__(self, settings, name = None, server_settings=None):
225
540
        self.name = name
226
 
        logger.debug(u"Creating client %r", self.name)
227
 
        # Uppercase and remove spaces from fingerprint for later
228
 
        # comparison purposes with return value from the fingerprint()
229
 
        # function
230
 
        self.fingerprint = config["fingerprint"].upper()\
231
 
                           .replace(u" ", u"")
232
 
        logger.debug(u"  Fingerprint: %s", self.fingerprint)
233
 
        if "secret" in config:
234
 
            self.secret = config["secret"].decode(u"base64")
235
 
        elif "secfile" in config:
236
 
            sf = open(config["secfile"])
237
 
            self.secret = sf.read()
238
 
            sf.close()
 
541
        if server_settings is None:
 
542
            server_settings = {}
 
543
        self.server_settings = server_settings
 
544
        # adding all client settings
 
545
        for setting, value in settings.items():
 
546
            setattr(self, setting, value)
 
547
        
 
548
        if self.enabled:
 
549
            if not hasattr(self, "last_enabled"):
 
550
                self.last_enabled = datetime.datetime.utcnow()
 
551
            if not hasattr(self, "expires"):
 
552
                self.expires = (datetime.datetime.utcnow()
 
553
                                + self.timeout)
239
554
        else:
240
 
            raise TypeError(u"No secret or secfile for client %s"
241
 
                            % self.name)
242
 
        self.host = config.get("host", "")
243
 
        self.created = datetime.datetime.now()
244
 
        self.last_checked_ok = None
245
 
        self.timeout = string_to_delta(config["timeout"])
246
 
        self.interval = string_to_delta(config["interval"])
247
 
        self.stop_hook = stop_hook
 
555
            self.last_enabled = None
 
556
            self.expires = None
 
557
        
 
558
        logger.debug("Creating client %r", self.name)
 
559
        logger.debug("  Fingerprint: %s", self.fingerprint)
 
560
        self.created = settings.get("created",
 
561
                                    datetime.datetime.utcnow())
 
562
        
 
563
        # attributes specific for this server instance
248
564
        self.checker = None
249
565
        self.checker_initiator_tag = None
250
 
        self.stop_initiator_tag = None
 
566
        self.disable_initiator_tag = None
251
567
        self.checker_callback_tag = None
252
 
        self.check_command = config["checker"]
253
 
    def start(self):
 
568
        self.current_checker_command = None
 
569
        self.approved = None
 
570
        self.approvals_pending = 0
 
571
        self.changedstate = multiprocessing_manager.Condition(
 
572
            multiprocessing_manager.Lock())
 
573
        self.client_structure = [attr
 
574
                                 for attr in self.__dict__.iterkeys()
 
575
                                 if not attr.startswith("_")]
 
576
        self.client_structure.append("client_structure")
 
577
        
 
578
        for name, t in inspect.getmembers(
 
579
                type(self), lambda obj: isinstance(obj, property)):
 
580
            if not name.startswith("_"):
 
581
                self.client_structure.append(name)
 
582
    
 
583
    # Send notice to process children that client state has changed
 
584
    def send_changedstate(self):
 
585
        with self.changedstate:
 
586
            self.changedstate.notify_all()
 
587
    
 
588
    def enable(self):
254
589
        """Start this client's checker and timeout hooks"""
 
590
        if getattr(self, "enabled", False):
 
591
            # Already enabled
 
592
            return
 
593
        self.expires = datetime.datetime.utcnow() + self.timeout
 
594
        self.enabled = True
 
595
        self.last_enabled = datetime.datetime.utcnow()
 
596
        self.init_checker()
 
597
        self.send_changedstate()
 
598
    
 
599
    def disable(self, quiet=True):
 
600
        """Disable this client."""
 
601
        if not getattr(self, "enabled", False):
 
602
            return False
 
603
        if not quiet:
 
604
            logger.info("Disabling client %s", self.name)
 
605
        if getattr(self, "disable_initiator_tag", None) is not None:
 
606
            gobject.source_remove(self.disable_initiator_tag)
 
607
            self.disable_initiator_tag = None
 
608
        self.expires = None
 
609
        if getattr(self, "checker_initiator_tag", None) is not None:
 
610
            gobject.source_remove(self.checker_initiator_tag)
 
611
            self.checker_initiator_tag = None
 
612
        self.stop_checker()
 
613
        self.enabled = False
 
614
        if not quiet:
 
615
            self.send_changedstate()
 
616
        # Do not run this again if called by a gobject.timeout_add
 
617
        return False
 
618
    
 
619
    def __del__(self):
 
620
        self.disable()
 
621
    
 
622
    def init_checker(self):
255
623
        # Schedule a new checker to be started an 'interval' from now,
256
624
        # and every interval from then on.
257
 
        self.checker_initiator_tag = gobject.timeout_add\
258
 
                                     (self._interval_milliseconds,
259
 
                                      self.start_checker)
 
625
        if self.checker_initiator_tag is not None:
 
626
            gobject.source_remove(self.checker_initiator_tag)
 
627
        self.checker_initiator_tag = gobject.timeout_add(
 
628
            int(self.interval.total_seconds() * 1000),
 
629
            self.start_checker)
 
630
        # Schedule a disable() when 'timeout' has passed
 
631
        if self.disable_initiator_tag is not None:
 
632
            gobject.source_remove(self.disable_initiator_tag)
 
633
        self.disable_initiator_tag = gobject.timeout_add(
 
634
            int(self.timeout.total_seconds() * 1000), self.disable)
260
635
        # Also start a new checker *right now*.
261
636
        self.start_checker()
262
 
        # Schedule a stop() when 'timeout' has passed
263
 
        self.stop_initiator_tag = gobject.timeout_add\
264
 
                                  (self._timeout_milliseconds,
265
 
                                   self.stop)
266
 
    def stop(self):
267
 
        """Stop this client.
268
 
        The possibility that a client might be restarted is left open,
269
 
        but not currently used."""
270
 
        # If this client doesn't have a secret, it is already stopped.
271
 
        if hasattr(self, "secret") and self.secret:
272
 
            logger.info(u"Stopping client %s", self.name)
273
 
            self.secret = None
274
 
        else:
275
 
            return False
276
 
        if getattr(self, "stop_initiator_tag", False):
277
 
            gobject.source_remove(self.stop_initiator_tag)
278
 
            self.stop_initiator_tag = None
279
 
        if getattr(self, "checker_initiator_tag", False):
280
 
            gobject.source_remove(self.checker_initiator_tag)
281
 
            self.checker_initiator_tag = None
282
 
        self.stop_checker()
283
 
        if self.stop_hook:
284
 
            self.stop_hook(self)
285
 
        # Do not run this again if called by a gobject.timeout_add
286
 
        return False
287
 
    def __del__(self):
288
 
        self.stop_hook = None
289
 
        self.stop()
290
 
    def checker_callback(self, pid, condition):
 
637
    
 
638
    def checker_callback(self, pid, condition, command):
291
639
        """The checker has completed, so take appropriate actions."""
292
 
        now = datetime.datetime.now()
293
640
        self.checker_callback_tag = None
294
641
        self.checker = None
295
 
        if os.WIFEXITED(condition) \
296
 
               and (os.WEXITSTATUS(condition) == 0):
297
 
            logger.info(u"Checker for %(name)s succeeded",
298
 
                        vars(self))
299
 
            self.last_checked_ok = now
300
 
            gobject.source_remove(self.stop_initiator_tag)
301
 
            self.stop_initiator_tag = gobject.timeout_add\
302
 
                                      (self._timeout_milliseconds,
303
 
                                       self.stop)
304
 
        elif not os.WIFEXITED(condition):
305
 
            logger.warning(u"Checker for %(name)s crashed?",
 
642
        if os.WIFEXITED(condition):
 
643
            self.last_checker_status = os.WEXITSTATUS(condition)
 
644
            if self.last_checker_status == 0:
 
645
                logger.info("Checker for %(name)s succeeded",
 
646
                            vars(self))
 
647
                self.checked_ok()
 
648
            else:
 
649
                logger.info("Checker for %(name)s failed", vars(self))
 
650
        else:
 
651
            self.last_checker_status = -1
 
652
            logger.warning("Checker for %(name)s crashed?",
306
653
                           vars(self))
307
 
        else:
308
 
            logger.info(u"Checker for %(name)s failed",
309
 
                        vars(self))
 
654
    
 
655
    def checked_ok(self):
 
656
        """Assert that the client has been seen, alive and well."""
 
657
        self.last_checked_ok = datetime.datetime.utcnow()
 
658
        self.last_checker_status = 0
 
659
        self.bump_timeout()
 
660
    
 
661
    def bump_timeout(self, timeout=None):
 
662
        """Bump up the timeout for this client."""
 
663
        if timeout is None:
 
664
            timeout = self.timeout
 
665
        if self.disable_initiator_tag is not None:
 
666
            gobject.source_remove(self.disable_initiator_tag)
 
667
            self.disable_initiator_tag = None
 
668
        if getattr(self, "enabled", False):
 
669
            self.disable_initiator_tag = gobject.timeout_add(
 
670
                int(timeout.total_seconds() * 1000), self.disable)
 
671
            self.expires = datetime.datetime.utcnow() + timeout
 
672
    
 
673
    def need_approval(self):
 
674
        self.last_approval_request = datetime.datetime.utcnow()
 
675
    
310
676
    def start_checker(self):
311
677
        """Start a new checker subprocess if one is not running.
 
678
        
312
679
        If a checker already exists, leave it running and do
313
680
        nothing."""
314
681
        # The reason for not killing a running checker is that if we
315
 
        # did that, then if a checker (for some reason) started
316
 
        # running slowly and taking more than 'interval' time, the
317
 
        # client would inevitably timeout, since no checker would get
318
 
        # a chance to run to completion.  If we instead leave running
 
682
        # did that, and if a checker (for some reason) started running
 
683
        # slowly and taking more than 'interval' time, then the client
 
684
        # would inevitably timeout, since no checker would get a
 
685
        # chance to run to completion.  If we instead leave running
319
686
        # checkers alone, the checker would have to take more time
320
 
        # than 'timeout' for the client to be declared invalid, which
321
 
        # is as it should be.
 
687
        # than 'timeout' for the client to be disabled, which is as it
 
688
        # should be.
 
689
        
 
690
        # If a checker exists, make sure it is not a zombie
 
691
        try:
 
692
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
693
        except AttributeError:
 
694
            pass
 
695
        except OSError as error:
 
696
            if error.errno != errno.ECHILD:
 
697
                raise
 
698
        else:
 
699
            if pid:
 
700
                logger.warning("Checker was a zombie")
 
701
                gobject.source_remove(self.checker_callback_tag)
 
702
                self.checker_callback(pid, status,
 
703
                                      self.current_checker_command)
 
704
        # Start a new checker if needed
322
705
        if self.checker is None:
323
 
            try:
324
 
                # In case check_command has exactly one % operator
325
 
                command = self.check_command % self.host
326
 
            except TypeError:
327
 
                # Escape attributes for the shell
328
 
                escaped_attrs = dict((key, re.escape(str(val)))
329
 
                                     for key, val in
330
 
                                     vars(self).iteritems())
331
 
                try:
332
 
                    command = self.check_command % escaped_attrs
333
 
                except TypeError, error:
334
 
                    logger.error(u'Could not format string "%s":'
335
 
                                 u' %s', self.check_command, error)
336
 
                    return True # Try again later
337
 
            try:
338
 
                logger.info(u"Starting checker %r for %s",
339
 
                            command, self.name)
 
706
            # Escape attributes for the shell
 
707
            escaped_attrs = {
 
708
                attr: re.escape(str(getattr(self, attr)))
 
709
                for attr in self.runtime_expansions }
 
710
            try:
 
711
                command = self.checker_command % escaped_attrs
 
712
            except TypeError as error:
 
713
                logger.error('Could not format string "%s"',
 
714
                             self.checker_command,
 
715
                             exc_info=error)
 
716
                return True     # Try again later
 
717
            self.current_checker_command = command
 
718
            try:
 
719
                logger.info("Starting checker %r for %s", command,
 
720
                            self.name)
340
721
                # We don't need to redirect stdout and stderr, since
341
722
                # in normal mode, that is already done by daemon(),
342
723
                # and in debug mode we don't want to.  (Stdin is
343
724
                # always replaced by /dev/null.)
 
725
                # The exception is when not debugging but nevertheless
 
726
                # running in the foreground; use the previously
 
727
                # created wnull.
 
728
                popen_args = {}
 
729
                if (not self.server_settings["debug"]
 
730
                    and self.server_settings["foreground"]):
 
731
                    popen_args.update({"stdout": wnull,
 
732
                                       "stderr": wnull })
344
733
                self.checker = subprocess.Popen(command,
345
734
                                                close_fds=True,
346
 
                                                shell=True, cwd="/")
347
 
                self.checker_callback_tag = gobject.child_watch_add\
348
 
                                            (self.checker.pid,
349
 
                                             self.checker_callback)
350
 
            except OSError, error:
351
 
                logger.error(u"Failed to start subprocess: %s",
352
 
                             error)
 
735
                                                shell=True,
 
736
                                                cwd="/",
 
737
                                                **popen_args)
 
738
            except OSError as error:
 
739
                logger.error("Failed to start subprocess",
 
740
                             exc_info=error)
 
741
                return True
 
742
            self.checker_callback_tag = gobject.child_watch_add(
 
743
                self.checker.pid, self.checker_callback, data=command)
 
744
            # The checker may have completed before the gobject
 
745
            # watch was added.  Check for this.
 
746
            try:
 
747
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
748
            except OSError as error:
 
749
                if error.errno == errno.ECHILD:
 
750
                    # This should never happen
 
751
                    logger.error("Child process vanished",
 
752
                                 exc_info=error)
 
753
                    return True
 
754
                raise
 
755
            if pid:
 
756
                gobject.source_remove(self.checker_callback_tag)
 
757
                self.checker_callback(pid, status, command)
353
758
        # Re-run this periodically if run by gobject.timeout_add
354
759
        return True
 
760
    
355
761
    def stop_checker(self):
356
762
        """Force the checker process, if any, to stop."""
357
763
        if self.checker_callback_tag:
359
765
            self.checker_callback_tag = None
360
766
        if getattr(self, "checker", None) is None:
361
767
            return
362
 
        logger.debug(u"Stopping checker for %(name)s", vars(self))
 
768
        logger.debug("Stopping checker for %(name)s", vars(self))
363
769
        try:
364
 
            os.kill(self.checker.pid, signal.SIGTERM)
365
 
            #os.sleep(0.5)
 
770
            self.checker.terminate()
 
771
            #time.sleep(0.5)
366
772
            #if self.checker.poll() is None:
367
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
368
 
        except OSError, error:
 
773
            #    self.checker.kill()
 
774
        except OSError as error:
369
775
            if error.errno != errno.ESRCH: # No such process
370
776
                raise
371
777
        self.checker = None
372
 
    def still_valid(self):
373
 
        """Has the timeout not yet passed for this client?"""
374
 
        now = datetime.datetime.now()
375
 
        if self.last_checked_ok is None:
376
 
            return now < (self.created + self.timeout)
377
 
        else:
378
 
            return now < (self.last_checked_ok + self.timeout)
379
 
 
380
 
 
381
 
def peer_certificate(session):
382
 
    "Return the peer's OpenPGP certificate as a bytestring"
383
 
    # If not an OpenPGP certificate...
384
 
    if gnutls.library.functions.gnutls_certificate_type_get\
385
 
            (session._c_object) \
386
 
           != gnutls.library.constants.GNUTLS_CRT_OPENPGP:
387
 
        # ...do the normal thing
388
 
        return session.peer_certificate
389
 
    list_size = ctypes.c_uint()
390
 
    cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
391
 
        (session._c_object, ctypes.byref(list_size))
392
 
    if list_size.value == 0:
393
 
        return None
394
 
    cert = cert_list[0]
395
 
    return ctypes.string_at(cert.data, cert.size)
396
 
 
397
 
 
398
 
def fingerprint(openpgp):
399
 
    "Convert an OpenPGP bytestring to a hexdigit fingerprint string"
400
 
    # New GnuTLS "datum" with the OpenPGP public key
401
 
    datum = gnutls.library.types.gnutls_datum_t\
402
 
        (ctypes.cast(ctypes.c_char_p(openpgp),
403
 
                     ctypes.POINTER(ctypes.c_ubyte)),
404
 
         ctypes.c_uint(len(openpgp)))
405
 
    # New empty GnuTLS certificate
406
 
    crt = gnutls.library.types.gnutls_openpgp_crt_t()
407
 
    gnutls.library.functions.gnutls_openpgp_crt_init\
408
 
        (ctypes.byref(crt))
409
 
    # Import the OpenPGP public key into the certificate
410
 
    gnutls.library.functions.gnutls_openpgp_crt_import\
411
 
                    (crt, ctypes.byref(datum),
412
 
                     gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
413
 
    # Verify the self signature in the key
414
 
    crtverify = ctypes.c_uint();
415
 
    gnutls.library.functions.gnutls_openpgp_crt_verify_self\
416
 
        (crt, ctypes.c_uint(0), ctypes.byref(crtverify))
417
 
    if crtverify.value != 0:
418
 
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
419
 
        raise gnutls.errors.CertificateSecurityError("Verify failed")
420
 
    # New buffer for the fingerprint
421
 
    buffer = ctypes.create_string_buffer(20)
422
 
    buffer_length = ctypes.c_size_t()
423
 
    # Get the fingerprint from the certificate into the buffer
424
 
    gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
425
 
        (crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
426
 
    # Deinit the certificate
427
 
    gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
428
 
    # Convert the buffer to a Python bytestring
429
 
    fpr = ctypes.string_at(buffer, buffer_length.value)
430
 
    # Convert the bytestring to hexadecimal notation
431
 
    hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
432
 
    return hex_fpr
433
 
 
434
 
 
435
 
class tcp_handler(SocketServer.BaseRequestHandler, object):
436
 
    """A TCP request handler class.
437
 
    Instantiated by IPv6_TCPServer for each request to handle it.
 
778
 
 
779
 
 
780
def dbus_service_property(dbus_interface,
 
781
                          signature="v",
 
782
                          access="readwrite",
 
783
                          byte_arrays=False):
 
784
    """Decorators for marking methods of a DBusObjectWithProperties to
 
785
    become properties on the D-Bus.
 
786
    
 
787
    The decorated method will be called with no arguments by "Get"
 
788
    and with one argument by "Set".
 
789
    
 
790
    The parameters, where they are supported, are the same as
 
791
    dbus.service.method, except there is only "signature", since the
 
792
    type from Get() and the type sent to Set() is the same.
 
793
    """
 
794
    # Encoding deeply encoded byte arrays is not supported yet by the
 
795
    # "Set" method, so we fail early here:
 
796
    if byte_arrays and signature != "ay":
 
797
        raise ValueError("Byte arrays not supported for non-'ay'"
 
798
                         " signature {!r}".format(signature))
 
799
    
 
800
    def decorator(func):
 
801
        func._dbus_is_property = True
 
802
        func._dbus_interface = dbus_interface
 
803
        func._dbus_signature = signature
 
804
        func._dbus_access = access
 
805
        func._dbus_name = func.__name__
 
806
        if func._dbus_name.endswith("_dbus_property"):
 
807
            func._dbus_name = func._dbus_name[:-14]
 
808
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
 
809
        return func
 
810
    
 
811
    return decorator
 
812
 
 
813
 
 
814
def dbus_interface_annotations(dbus_interface):
 
815
    """Decorator for marking functions returning interface annotations
 
816
    
 
817
    Usage:
 
818
    
 
819
    @dbus_interface_annotations("org.example.Interface")
 
820
    def _foo(self):  # Function name does not matter
 
821
        return {"org.freedesktop.DBus.Deprecated": "true",
 
822
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
823
                    "false"}
 
824
    """
 
825
    
 
826
    def decorator(func):
 
827
        func._dbus_is_interface = True
 
828
        func._dbus_interface = dbus_interface
 
829
        func._dbus_name = dbus_interface
 
830
        return func
 
831
    
 
832
    return decorator
 
833
 
 
834
 
 
835
def dbus_annotations(annotations):
 
836
    """Decorator to annotate D-Bus methods, signals or properties
 
837
    Usage:
 
838
    
 
839
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
 
840
                       "org.freedesktop.DBus.Property."
 
841
                       "EmitsChangedSignal": "false"})
 
842
    @dbus_service_property("org.example.Interface", signature="b",
 
843
                           access="r")
 
844
    def Property_dbus_property(self):
 
845
        return dbus.Boolean(False)
 
846
    """
 
847
    
 
848
    def decorator(func):
 
849
        func._dbus_annotations = annotations
 
850
        return func
 
851
    
 
852
    return decorator
 
853
 
 
854
 
 
855
class DBusPropertyException(dbus.exceptions.DBusException):
 
856
    """A base class for D-Bus property-related exceptions
 
857
    """
 
858
    pass
 
859
 
 
860
 
 
861
class DBusPropertyAccessException(DBusPropertyException):
 
862
    """A property's access permissions disallows an operation.
 
863
    """
 
864
    pass
 
865
 
 
866
 
 
867
class DBusPropertyNotFound(DBusPropertyException):
 
868
    """An attempt was made to access a non-existing property.
 
869
    """
 
870
    pass
 
871
 
 
872
 
 
873
class DBusObjectWithProperties(dbus.service.Object):
 
874
    """A D-Bus object with properties.
 
875
    
 
876
    Classes inheriting from this can use the dbus_service_property
 
877
    decorator to expose methods as D-Bus properties.  It exposes the
 
878
    standard Get(), Set(), and GetAll() methods on the D-Bus.
 
879
    """
 
880
    
 
881
    @staticmethod
 
882
    def _is_dbus_thing(thing):
 
883
        """Returns a function testing if an attribute is a D-Bus thing
 
884
        
 
885
        If called like _is_dbus_thing("method") it returns a function
 
886
        suitable for use as predicate to inspect.getmembers().
 
887
        """
 
888
        return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
 
889
                                   False)
 
890
    
 
891
    def _get_all_dbus_things(self, thing):
 
892
        """Returns a generator of (name, attribute) pairs
 
893
        """
 
894
        return ((getattr(athing.__get__(self), "_dbus_name", name),
 
895
                 athing.__get__(self))
 
896
                for cls in self.__class__.__mro__
 
897
                for name, athing in
 
898
                inspect.getmembers(cls, self._is_dbus_thing(thing)))
 
899
    
 
900
    def _get_dbus_property(self, interface_name, property_name):
 
901
        """Returns a bound method if one exists which is a D-Bus
 
902
        property with the specified name and interface.
 
903
        """
 
904
        for cls in self.__class__.__mro__:
 
905
            for name, value in inspect.getmembers(
 
906
                    cls, self._is_dbus_thing("property")):
 
907
                if (value._dbus_name == property_name
 
908
                    and value._dbus_interface == interface_name):
 
909
                    return value.__get__(self)
 
910
        
 
911
        # No such property
 
912
        raise DBusPropertyNotFound("{}:{}.{}".format(
 
913
            self.dbus_object_path, interface_name, property_name))
 
914
    
 
915
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
916
                         in_signature="ss",
 
917
                         out_signature="v")
 
918
    def Get(self, interface_name, property_name):
 
919
        """Standard D-Bus property Get() method, see D-Bus standard.
 
920
        """
 
921
        prop = self._get_dbus_property(interface_name, property_name)
 
922
        if prop._dbus_access == "write":
 
923
            raise DBusPropertyAccessException(property_name)
 
924
        value = prop()
 
925
        if not hasattr(value, "variant_level"):
 
926
            return value
 
927
        return type(value)(value, variant_level=value.variant_level+1)
 
928
    
 
929
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
 
930
    def Set(self, interface_name, property_name, value):
 
931
        """Standard D-Bus property Set() method, see D-Bus standard.
 
932
        """
 
933
        prop = self._get_dbus_property(interface_name, property_name)
 
934
        if prop._dbus_access == "read":
 
935
            raise DBusPropertyAccessException(property_name)
 
936
        if prop._dbus_get_args_options["byte_arrays"]:
 
937
            # The byte_arrays option is not supported yet on
 
938
            # signatures other than "ay".
 
939
            if prop._dbus_signature != "ay":
 
940
                raise ValueError("Byte arrays not supported for non-"
 
941
                                 "'ay' signature {!r}"
 
942
                                 .format(prop._dbus_signature))
 
943
            value = dbus.ByteArray(b''.join(chr(byte)
 
944
                                            for byte in value))
 
945
        prop(value)
 
946
    
 
947
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
948
                         in_signature="s",
 
949
                         out_signature="a{sv}")
 
950
    def GetAll(self, interface_name):
 
951
        """Standard D-Bus property GetAll() method, see D-Bus
 
952
        standard.
 
953
        
 
954
        Note: Will not include properties with access="write".
 
955
        """
 
956
        properties = {}
 
957
        for name, prop in self._get_all_dbus_things("property"):
 
958
            if (interface_name
 
959
                and interface_name != prop._dbus_interface):
 
960
                # Interface non-empty but did not match
 
961
                continue
 
962
            # Ignore write-only properties
 
963
            if prop._dbus_access == "write":
 
964
                continue
 
965
            value = prop()
 
966
            if not hasattr(value, "variant_level"):
 
967
                properties[name] = value
 
968
                continue
 
969
            properties[name] = type(value)(
 
970
                value, variant_level = value.variant_level + 1)
 
971
        return dbus.Dictionary(properties, signature="sv")
 
972
    
 
973
    @dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
 
974
    def PropertiesChanged(self, interface_name, changed_properties,
 
975
                          invalidated_properties):
 
976
        """Standard D-Bus PropertiesChanged() signal, see D-Bus
 
977
        standard.
 
978
        """
 
979
        pass
 
980
    
 
981
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
982
                         out_signature="s",
 
983
                         path_keyword='object_path',
 
984
                         connection_keyword='connection')
 
985
    def Introspect(self, object_path, connection):
 
986
        """Overloading of standard D-Bus method.
 
987
        
 
988
        Inserts property tags and interface annotation tags.
 
989
        """
 
990
        xmlstring = dbus.service.Object.Introspect(self, object_path,
 
991
                                                   connection)
 
992
        try:
 
993
            document = xml.dom.minidom.parseString(xmlstring)
 
994
            
 
995
            def make_tag(document, name, prop):
 
996
                e = document.createElement("property")
 
997
                e.setAttribute("name", name)
 
998
                e.setAttribute("type", prop._dbus_signature)
 
999
                e.setAttribute("access", prop._dbus_access)
 
1000
                return e
 
1001
            
 
1002
            for if_tag in document.getElementsByTagName("interface"):
 
1003
                # Add property tags
 
1004
                for tag in (make_tag(document, name, prop)
 
1005
                            for name, prop
 
1006
                            in self._get_all_dbus_things("property")
 
1007
                            if prop._dbus_interface
 
1008
                            == if_tag.getAttribute("name")):
 
1009
                    if_tag.appendChild(tag)
 
1010
                # Add annotation tags
 
1011
                for typ in ("method", "signal", "property"):
 
1012
                    for tag in if_tag.getElementsByTagName(typ):
 
1013
                        annots = dict()
 
1014
                        for name, prop in (self.
 
1015
                                           _get_all_dbus_things(typ)):
 
1016
                            if (name == tag.getAttribute("name")
 
1017
                                and prop._dbus_interface
 
1018
                                == if_tag.getAttribute("name")):
 
1019
                                annots.update(getattr(
 
1020
                                    prop, "_dbus_annotations", {}))
 
1021
                        for name, value in annots.items():
 
1022
                            ann_tag = document.createElement(
 
1023
                                "annotation")
 
1024
                            ann_tag.setAttribute("name", name)
 
1025
                            ann_tag.setAttribute("value", value)
 
1026
                            tag.appendChild(ann_tag)
 
1027
                # Add interface annotation tags
 
1028
                for annotation, value in dict(
 
1029
                    itertools.chain.from_iterable(
 
1030
                        annotations().items()
 
1031
                        for name, annotations
 
1032
                        in self._get_all_dbus_things("interface")
 
1033
                        if name == if_tag.getAttribute("name")
 
1034
                        )).items():
 
1035
                    ann_tag = document.createElement("annotation")
 
1036
                    ann_tag.setAttribute("name", annotation)
 
1037
                    ann_tag.setAttribute("value", value)
 
1038
                    if_tag.appendChild(ann_tag)
 
1039
                # Add the names to the return values for the
 
1040
                # "org.freedesktop.DBus.Properties" methods
 
1041
                if (if_tag.getAttribute("name")
 
1042
                    == "org.freedesktop.DBus.Properties"):
 
1043
                    for cn in if_tag.getElementsByTagName("method"):
 
1044
                        if cn.getAttribute("name") == "Get":
 
1045
                            for arg in cn.getElementsByTagName("arg"):
 
1046
                                if (arg.getAttribute("direction")
 
1047
                                    == "out"):
 
1048
                                    arg.setAttribute("name", "value")
 
1049
                        elif cn.getAttribute("name") == "GetAll":
 
1050
                            for arg in cn.getElementsByTagName("arg"):
 
1051
                                if (arg.getAttribute("direction")
 
1052
                                    == "out"):
 
1053
                                    arg.setAttribute("name", "props")
 
1054
            xmlstring = document.toxml("utf-8")
 
1055
            document.unlink()
 
1056
        except (AttributeError, xml.dom.DOMException,
 
1057
                xml.parsers.expat.ExpatError) as error:
 
1058
            logger.error("Failed to override Introspection method",
 
1059
                         exc_info=error)
 
1060
        return xmlstring
 
1061
 
 
1062
 
 
1063
def datetime_to_dbus(dt, variant_level=0):
 
1064
    """Convert a UTC datetime.datetime() to a D-Bus type."""
 
1065
    if dt is None:
 
1066
        return dbus.String("", variant_level = variant_level)
 
1067
    return dbus.String(dt.isoformat(), variant_level=variant_level)
 
1068
 
 
1069
 
 
1070
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
 
1071
    """A class decorator; applied to a subclass of
 
1072
    dbus.service.Object, it will add alternate D-Bus attributes with
 
1073
    interface names according to the "alt_interface_names" mapping.
 
1074
    Usage:
 
1075
    
 
1076
    @alternate_dbus_interfaces({"org.example.Interface":
 
1077
                                    "net.example.AlternateInterface"})
 
1078
    class SampleDBusObject(dbus.service.Object):
 
1079
        @dbus.service.method("org.example.Interface")
 
1080
        def SampleDBusMethod():
 
1081
            pass
 
1082
    
 
1083
    The above "SampleDBusMethod" on "SampleDBusObject" will be
 
1084
    reachable via two interfaces: "org.example.Interface" and
 
1085
    "net.example.AlternateInterface", the latter of which will have
 
1086
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
 
1087
    "true", unless "deprecate" is passed with a False value.
 
1088
    
 
1089
    This works for methods and signals, and also for D-Bus properties
 
1090
    (from DBusObjectWithProperties) and interfaces (from the
 
1091
    dbus_interface_annotations decorator).
 
1092
    """
 
1093
    
 
1094
    def wrapper(cls):
 
1095
        for orig_interface_name, alt_interface_name in (
 
1096
                alt_interface_names.items()):
 
1097
            attr = {}
 
1098
            interface_names = set()
 
1099
            # Go though all attributes of the class
 
1100
            for attrname, attribute in inspect.getmembers(cls):
 
1101
                # Ignore non-D-Bus attributes, and D-Bus attributes
 
1102
                # with the wrong interface name
 
1103
                if (not hasattr(attribute, "_dbus_interface")
 
1104
                    or not attribute._dbus_interface.startswith(
 
1105
                        orig_interface_name)):
 
1106
                    continue
 
1107
                # Create an alternate D-Bus interface name based on
 
1108
                # the current name
 
1109
                alt_interface = attribute._dbus_interface.replace(
 
1110
                    orig_interface_name, alt_interface_name)
 
1111
                interface_names.add(alt_interface)
 
1112
                # Is this a D-Bus signal?
 
1113
                if getattr(attribute, "_dbus_is_signal", False):
 
1114
                    # Extract the original non-method undecorated
 
1115
                    # function by black magic
 
1116
                    nonmethod_func = (dict(
 
1117
                        zip(attribute.func_code.co_freevars,
 
1118
                            attribute.__closure__))
 
1119
                                      ["func"].cell_contents)
 
1120
                    # Create a new, but exactly alike, function
 
1121
                    # object, and decorate it to be a new D-Bus signal
 
1122
                    # with the alternate D-Bus interface name
 
1123
                    new_function = (dbus.service.signal(
 
1124
                        alt_interface, attribute._dbus_signature)
 
1125
                                    (types.FunctionType(
 
1126
                                        nonmethod_func.func_code,
 
1127
                                        nonmethod_func.func_globals,
 
1128
                                        nonmethod_func.func_name,
 
1129
                                        nonmethod_func.func_defaults,
 
1130
                                        nonmethod_func.func_closure)))
 
1131
                    # Copy annotations, if any
 
1132
                    try:
 
1133
                        new_function._dbus_annotations = dict(
 
1134
                            attribute._dbus_annotations)
 
1135
                    except AttributeError:
 
1136
                        pass
 
1137
                    # Define a creator of a function to call both the
 
1138
                    # original and alternate functions, so both the
 
1139
                    # original and alternate signals gets sent when
 
1140
                    # the function is called
 
1141
                    def fixscope(func1, func2):
 
1142
                        """This function is a scope container to pass
 
1143
                        func1 and func2 to the "call_both" function
 
1144
                        outside of its arguments"""
 
1145
                        
 
1146
                        def call_both(*args, **kwargs):
 
1147
                            """This function will emit two D-Bus
 
1148
                            signals by calling func1 and func2"""
 
1149
                            func1(*args, **kwargs)
 
1150
                            func2(*args, **kwargs)
 
1151
                        
 
1152
                        return call_both
 
1153
                    # Create the "call_both" function and add it to
 
1154
                    # the class
 
1155
                    attr[attrname] = fixscope(attribute, new_function)
 
1156
                # Is this a D-Bus method?
 
1157
                elif getattr(attribute, "_dbus_is_method", False):
 
1158
                    # Create a new, but exactly alike, function
 
1159
                    # object.  Decorate it to be a new D-Bus method
 
1160
                    # with the alternate D-Bus interface name.  Add it
 
1161
                    # to the class.
 
1162
                    attr[attrname] = (
 
1163
                        dbus.service.method(
 
1164
                            alt_interface,
 
1165
                            attribute._dbus_in_signature,
 
1166
                            attribute._dbus_out_signature)
 
1167
                        (types.FunctionType(attribute.func_code,
 
1168
                                            attribute.func_globals,
 
1169
                                            attribute.func_name,
 
1170
                                            attribute.func_defaults,
 
1171
                                            attribute.func_closure)))
 
1172
                    # Copy annotations, if any
 
1173
                    try:
 
1174
                        attr[attrname]._dbus_annotations = dict(
 
1175
                            attribute._dbus_annotations)
 
1176
                    except AttributeError:
 
1177
                        pass
 
1178
                # Is this a D-Bus property?
 
1179
                elif getattr(attribute, "_dbus_is_property", False):
 
1180
                    # Create a new, but exactly alike, function
 
1181
                    # object, and decorate it to be a new D-Bus
 
1182
                    # property with the alternate D-Bus interface
 
1183
                    # name.  Add it to the class.
 
1184
                    attr[attrname] = (dbus_service_property(
 
1185
                        alt_interface, attribute._dbus_signature,
 
1186
                        attribute._dbus_access,
 
1187
                        attribute._dbus_get_args_options
 
1188
                        ["byte_arrays"])
 
1189
                                      (types.FunctionType(
 
1190
                                          attribute.func_code,
 
1191
                                          attribute.func_globals,
 
1192
                                          attribute.func_name,
 
1193
                                          attribute.func_defaults,
 
1194
                                          attribute.func_closure)))
 
1195
                    # Copy annotations, if any
 
1196
                    try:
 
1197
                        attr[attrname]._dbus_annotations = dict(
 
1198
                            attribute._dbus_annotations)
 
1199
                    except AttributeError:
 
1200
                        pass
 
1201
                # Is this a D-Bus interface?
 
1202
                elif getattr(attribute, "_dbus_is_interface", False):
 
1203
                    # Create a new, but exactly alike, function
 
1204
                    # object.  Decorate it to be a new D-Bus interface
 
1205
                    # with the alternate D-Bus interface name.  Add it
 
1206
                    # to the class.
 
1207
                    attr[attrname] = (
 
1208
                        dbus_interface_annotations(alt_interface)
 
1209
                        (types.FunctionType(attribute.func_code,
 
1210
                                            attribute.func_globals,
 
1211
                                            attribute.func_name,
 
1212
                                            attribute.func_defaults,
 
1213
                                            attribute.func_closure)))
 
1214
            if deprecate:
 
1215
                # Deprecate all alternate interfaces
 
1216
                iname="_AlternateDBusNames_interface_annotation{}"
 
1217
                for interface_name in interface_names:
 
1218
                    
 
1219
                    @dbus_interface_annotations(interface_name)
 
1220
                    def func(self):
 
1221
                        return { "org.freedesktop.DBus.Deprecated":
 
1222
                                 "true" }
 
1223
                    # Find an unused name
 
1224
                    for aname in (iname.format(i)
 
1225
                                  for i in itertools.count()):
 
1226
                        if aname not in attr:
 
1227
                            attr[aname] = func
 
1228
                            break
 
1229
            if interface_names:
 
1230
                # Replace the class with a new subclass of it with
 
1231
                # methods, signals, etc. as created above.
 
1232
                cls = type(b"{}Alternate".format(cls.__name__),
 
1233
                           (cls, ), attr)
 
1234
        return cls
 
1235
    
 
1236
    return wrapper
 
1237
 
 
1238
 
 
1239
@alternate_dbus_interfaces({"se.recompile.Mandos":
 
1240
                            "se.bsnet.fukt.Mandos"})
 
1241
class ClientDBus(Client, DBusObjectWithProperties):
 
1242
    """A Client class using D-Bus
 
1243
    
 
1244
    Attributes:
 
1245
    dbus_object_path: dbus.ObjectPath
 
1246
    bus: dbus.SystemBus()
 
1247
    """
 
1248
    
 
1249
    runtime_expansions = (Client.runtime_expansions
 
1250
                          + ("dbus_object_path", ))
 
1251
    
 
1252
    _interface = "se.recompile.Mandos.Client"
 
1253
    
 
1254
    # dbus.service.Object doesn't use super(), so we can't either.
 
1255
    
 
1256
    def __init__(self, bus = None, *args, **kwargs):
 
1257
        self.bus = bus
 
1258
        Client.__init__(self, *args, **kwargs)
 
1259
        # Only now, when this client is initialized, can it show up on
 
1260
        # the D-Bus
 
1261
        client_object_name = str(self.name).translate(
 
1262
            {ord("."): ord("_"),
 
1263
             ord("-"): ord("_")})
 
1264
        self.dbus_object_path = dbus.ObjectPath(
 
1265
            "/clients/" + client_object_name)
 
1266
        DBusObjectWithProperties.__init__(self, self.bus,
 
1267
                                          self.dbus_object_path)
 
1268
    
 
1269
    def notifychangeproperty(transform_func, dbus_name,
 
1270
                             type_func=lambda x: x,
 
1271
                             variant_level=1,
 
1272
                             invalidate_only=False,
 
1273
                             _interface=_interface):
 
1274
        """ Modify a variable so that it's a property which announces
 
1275
        its changes to DBus.
 
1276
        
 
1277
        transform_fun: Function that takes a value and a variant_level
 
1278
                       and transforms it to a D-Bus type.
 
1279
        dbus_name: D-Bus name of the variable
 
1280
        type_func: Function that transform the value before sending it
 
1281
                   to the D-Bus.  Default: no transform
 
1282
        variant_level: D-Bus variant level.  Default: 1
 
1283
        """
 
1284
        attrname = "_{}".format(dbus_name)
 
1285
        
 
1286
        def setter(self, value):
 
1287
            if hasattr(self, "dbus_object_path"):
 
1288
                if (not hasattr(self, attrname) or
 
1289
                    type_func(getattr(self, attrname, None))
 
1290
                    != type_func(value)):
 
1291
                    if invalidate_only:
 
1292
                        self.PropertiesChanged(
 
1293
                            _interface, dbus.Dictionary(),
 
1294
                            dbus.Array((dbus_name, )))
 
1295
                    else:
 
1296
                        dbus_value = transform_func(
 
1297
                            type_func(value),
 
1298
                            variant_level = variant_level)
 
1299
                        self.PropertyChanged(dbus.String(dbus_name),
 
1300
                                             dbus_value)
 
1301
                        self.PropertiesChanged(
 
1302
                            _interface,
 
1303
                            dbus.Dictionary({ dbus.String(dbus_name):
 
1304
                                              dbus_value }),
 
1305
                            dbus.Array())
 
1306
            setattr(self, attrname, value)
 
1307
        
 
1308
        return property(lambda self: getattr(self, attrname), setter)
 
1309
    
 
1310
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
 
1311
    approvals_pending = notifychangeproperty(dbus.Boolean,
 
1312
                                             "ApprovalPending",
 
1313
                                             type_func = bool)
 
1314
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
 
1315
    last_enabled = notifychangeproperty(datetime_to_dbus,
 
1316
                                        "LastEnabled")
 
1317
    checker = notifychangeproperty(
 
1318
        dbus.Boolean, "CheckerRunning",
 
1319
        type_func = lambda checker: checker is not None)
 
1320
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
 
1321
                                           "LastCheckedOK")
 
1322
    last_checker_status = notifychangeproperty(dbus.Int16,
 
1323
                                               "LastCheckerStatus")
 
1324
    last_approval_request = notifychangeproperty(
 
1325
        datetime_to_dbus, "LastApprovalRequest")
 
1326
    approved_by_default = notifychangeproperty(dbus.Boolean,
 
1327
                                               "ApprovedByDefault")
 
1328
    approval_delay = notifychangeproperty(
 
1329
        dbus.UInt64, "ApprovalDelay",
 
1330
        type_func = lambda td: td.total_seconds() * 1000)
 
1331
    approval_duration = notifychangeproperty(
 
1332
        dbus.UInt64, "ApprovalDuration",
 
1333
        type_func = lambda td: td.total_seconds() * 1000)
 
1334
    host = notifychangeproperty(dbus.String, "Host")
 
1335
    timeout = notifychangeproperty(
 
1336
        dbus.UInt64, "Timeout",
 
1337
        type_func = lambda td: td.total_seconds() * 1000)
 
1338
    extended_timeout = notifychangeproperty(
 
1339
        dbus.UInt64, "ExtendedTimeout",
 
1340
        type_func = lambda td: td.total_seconds() * 1000)
 
1341
    interval = notifychangeproperty(
 
1342
        dbus.UInt64, "Interval",
 
1343
        type_func = lambda td: td.total_seconds() * 1000)
 
1344
    checker_command = notifychangeproperty(dbus.String, "Checker")
 
1345
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
 
1346
                                  invalidate_only=True)
 
1347
    
 
1348
    del notifychangeproperty
 
1349
    
 
1350
    def __del__(self, *args, **kwargs):
 
1351
        try:
 
1352
            self.remove_from_connection()
 
1353
        except LookupError:
 
1354
            pass
 
1355
        if hasattr(DBusObjectWithProperties, "__del__"):
 
1356
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
 
1357
        Client.__del__(self, *args, **kwargs)
 
1358
    
 
1359
    def checker_callback(self, pid, condition, command,
 
1360
                         *args, **kwargs):
 
1361
        self.checker_callback_tag = None
 
1362
        self.checker = None
 
1363
        if os.WIFEXITED(condition):
 
1364
            exitstatus = os.WEXITSTATUS(condition)
 
1365
            # Emit D-Bus signal
 
1366
            self.CheckerCompleted(dbus.Int16(exitstatus),
 
1367
                                  dbus.Int64(condition),
 
1368
                                  dbus.String(command))
 
1369
        else:
 
1370
            # Emit D-Bus signal
 
1371
            self.CheckerCompleted(dbus.Int16(-1),
 
1372
                                  dbus.Int64(condition),
 
1373
                                  dbus.String(command))
 
1374
        
 
1375
        return Client.checker_callback(self, pid, condition, command,
 
1376
                                       *args, **kwargs)
 
1377
    
 
1378
    def start_checker(self, *args, **kwargs):
 
1379
        old_checker_pid = getattr(self.checker, "pid", None)
 
1380
        r = Client.start_checker(self, *args, **kwargs)
 
1381
        # Only if new checker process was started
 
1382
        if (self.checker is not None
 
1383
            and old_checker_pid != self.checker.pid):
 
1384
            # Emit D-Bus signal
 
1385
            self.CheckerStarted(self.current_checker_command)
 
1386
        return r
 
1387
    
 
1388
    def _reset_approved(self):
 
1389
        self.approved = None
 
1390
        return False
 
1391
    
 
1392
    def approve(self, value=True):
 
1393
        self.approved = value
 
1394
        gobject.timeout_add(int(self.approval_duration.total_seconds()
 
1395
                                * 1000), self._reset_approved)
 
1396
        self.send_changedstate()
 
1397
    
 
1398
    ## D-Bus methods, signals & properties
 
1399
    
 
1400
    ## Interfaces
 
1401
    
 
1402
    ## Signals
 
1403
    
 
1404
    # CheckerCompleted - signal
 
1405
    @dbus.service.signal(_interface, signature="nxs")
 
1406
    def CheckerCompleted(self, exitcode, waitstatus, command):
 
1407
        "D-Bus signal"
 
1408
        pass
 
1409
    
 
1410
    # CheckerStarted - signal
 
1411
    @dbus.service.signal(_interface, signature="s")
 
1412
    def CheckerStarted(self, command):
 
1413
        "D-Bus signal"
 
1414
        pass
 
1415
    
 
1416
    # PropertyChanged - signal
 
1417
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
 
1418
    @dbus.service.signal(_interface, signature="sv")
 
1419
    def PropertyChanged(self, property, value):
 
1420
        "D-Bus signal"
 
1421
        pass
 
1422
    
 
1423
    # GotSecret - signal
 
1424
    @dbus.service.signal(_interface)
 
1425
    def GotSecret(self):
 
1426
        """D-Bus signal
 
1427
        Is sent after a successful transfer of secret from the Mandos
 
1428
        server to mandos-client
 
1429
        """
 
1430
        pass
 
1431
    
 
1432
    # Rejected - signal
 
1433
    @dbus.service.signal(_interface, signature="s")
 
1434
    def Rejected(self, reason):
 
1435
        "D-Bus signal"
 
1436
        pass
 
1437
    
 
1438
    # NeedApproval - signal
 
1439
    @dbus.service.signal(_interface, signature="tb")
 
1440
    def NeedApproval(self, timeout, default):
 
1441
        "D-Bus signal"
 
1442
        return self.need_approval()
 
1443
    
 
1444
    ## Methods
 
1445
    
 
1446
    # Approve - method
 
1447
    @dbus.service.method(_interface, in_signature="b")
 
1448
    def Approve(self, value):
 
1449
        self.approve(value)
 
1450
    
 
1451
    # CheckedOK - method
 
1452
    @dbus.service.method(_interface)
 
1453
    def CheckedOK(self):
 
1454
        self.checked_ok()
 
1455
    
 
1456
    # Enable - method
 
1457
    @dbus.service.method(_interface)
 
1458
    def Enable(self):
 
1459
        "D-Bus method"
 
1460
        self.enable()
 
1461
    
 
1462
    # StartChecker - method
 
1463
    @dbus.service.method(_interface)
 
1464
    def StartChecker(self):
 
1465
        "D-Bus method"
 
1466
        self.start_checker()
 
1467
    
 
1468
    # Disable - method
 
1469
    @dbus.service.method(_interface)
 
1470
    def Disable(self):
 
1471
        "D-Bus method"
 
1472
        self.disable()
 
1473
    
 
1474
    # StopChecker - method
 
1475
    @dbus.service.method(_interface)
 
1476
    def StopChecker(self):
 
1477
        self.stop_checker()
 
1478
    
 
1479
    ## Properties
 
1480
    
 
1481
    # ApprovalPending - property
 
1482
    @dbus_service_property(_interface, signature="b", access="read")
 
1483
    def ApprovalPending_dbus_property(self):
 
1484
        return dbus.Boolean(bool(self.approvals_pending))
 
1485
    
 
1486
    # ApprovedByDefault - property
 
1487
    @dbus_service_property(_interface,
 
1488
                           signature="b",
 
1489
                           access="readwrite")
 
1490
    def ApprovedByDefault_dbus_property(self, value=None):
 
1491
        if value is None:       # get
 
1492
            return dbus.Boolean(self.approved_by_default)
 
1493
        self.approved_by_default = bool(value)
 
1494
    
 
1495
    # ApprovalDelay - property
 
1496
    @dbus_service_property(_interface,
 
1497
                           signature="t",
 
1498
                           access="readwrite")
 
1499
    def ApprovalDelay_dbus_property(self, value=None):
 
1500
        if value is None:       # get
 
1501
            return dbus.UInt64(self.approval_delay.total_seconds()
 
1502
                               * 1000)
 
1503
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
 
1504
    
 
1505
    # ApprovalDuration - property
 
1506
    @dbus_service_property(_interface,
 
1507
                           signature="t",
 
1508
                           access="readwrite")
 
1509
    def ApprovalDuration_dbus_property(self, value=None):
 
1510
        if value is None:       # get
 
1511
            return dbus.UInt64(self.approval_duration.total_seconds()
 
1512
                               * 1000)
 
1513
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
 
1514
    
 
1515
    # Name - property
 
1516
    @dbus_service_property(_interface, signature="s", access="read")
 
1517
    def Name_dbus_property(self):
 
1518
        return dbus.String(self.name)
 
1519
    
 
1520
    # Fingerprint - property
 
1521
    @dbus_service_property(_interface, signature="s", access="read")
 
1522
    def Fingerprint_dbus_property(self):
 
1523
        return dbus.String(self.fingerprint)
 
1524
    
 
1525
    # Host - property
 
1526
    @dbus_service_property(_interface,
 
1527
                           signature="s",
 
1528
                           access="readwrite")
 
1529
    def Host_dbus_property(self, value=None):
 
1530
        if value is None:       # get
 
1531
            return dbus.String(self.host)
 
1532
        self.host = str(value)
 
1533
    
 
1534
    # Created - property
 
1535
    @dbus_service_property(_interface, signature="s", access="read")
 
1536
    def Created_dbus_property(self):
 
1537
        return datetime_to_dbus(self.created)
 
1538
    
 
1539
    # LastEnabled - property
 
1540
    @dbus_service_property(_interface, signature="s", access="read")
 
1541
    def LastEnabled_dbus_property(self):
 
1542
        return datetime_to_dbus(self.last_enabled)
 
1543
    
 
1544
    # Enabled - property
 
1545
    @dbus_service_property(_interface,
 
1546
                           signature="b",
 
1547
                           access="readwrite")
 
1548
    def Enabled_dbus_property(self, value=None):
 
1549
        if value is None:       # get
 
1550
            return dbus.Boolean(self.enabled)
 
1551
        if value:
 
1552
            self.enable()
 
1553
        else:
 
1554
            self.disable()
 
1555
    
 
1556
    # LastCheckedOK - property
 
1557
    @dbus_service_property(_interface,
 
1558
                           signature="s",
 
1559
                           access="readwrite")
 
1560
    def LastCheckedOK_dbus_property(self, value=None):
 
1561
        if value is not None:
 
1562
            self.checked_ok()
 
1563
            return
 
1564
        return datetime_to_dbus(self.last_checked_ok)
 
1565
    
 
1566
    # LastCheckerStatus - property
 
1567
    @dbus_service_property(_interface, signature="n", access="read")
 
1568
    def LastCheckerStatus_dbus_property(self):
 
1569
        return dbus.Int16(self.last_checker_status)
 
1570
    
 
1571
    # Expires - property
 
1572
    @dbus_service_property(_interface, signature="s", access="read")
 
1573
    def Expires_dbus_property(self):
 
1574
        return datetime_to_dbus(self.expires)
 
1575
    
 
1576
    # LastApprovalRequest - property
 
1577
    @dbus_service_property(_interface, signature="s", access="read")
 
1578
    def LastApprovalRequest_dbus_property(self):
 
1579
        return datetime_to_dbus(self.last_approval_request)
 
1580
    
 
1581
    # Timeout - property
 
1582
    @dbus_service_property(_interface,
 
1583
                           signature="t",
 
1584
                           access="readwrite")
 
1585
    def Timeout_dbus_property(self, value=None):
 
1586
        if value is None:       # get
 
1587
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
 
1588
        old_timeout = self.timeout
 
1589
        self.timeout = datetime.timedelta(0, 0, 0, value)
 
1590
        # Reschedule disabling
 
1591
        if self.enabled:
 
1592
            now = datetime.datetime.utcnow()
 
1593
            self.expires += self.timeout - old_timeout
 
1594
            if self.expires <= now:
 
1595
                # The timeout has passed
 
1596
                self.disable()
 
1597
            else:
 
1598
                if (getattr(self, "disable_initiator_tag", None)
 
1599
                    is None):
 
1600
                    return
 
1601
                gobject.source_remove(self.disable_initiator_tag)
 
1602
                self.disable_initiator_tag = gobject.timeout_add(
 
1603
                    int((self.expires - now).total_seconds() * 1000),
 
1604
                    self.disable)
 
1605
    
 
1606
    # ExtendedTimeout - property
 
1607
    @dbus_service_property(_interface,
 
1608
                           signature="t",
 
1609
                           access="readwrite")
 
1610
    def ExtendedTimeout_dbus_property(self, value=None):
 
1611
        if value is None:       # get
 
1612
            return dbus.UInt64(self.extended_timeout.total_seconds()
 
1613
                               * 1000)
 
1614
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
 
1615
    
 
1616
    # Interval - property
 
1617
    @dbus_service_property(_interface,
 
1618
                           signature="t",
 
1619
                           access="readwrite")
 
1620
    def Interval_dbus_property(self, value=None):
 
1621
        if value is None:       # get
 
1622
            return dbus.UInt64(self.interval.total_seconds() * 1000)
 
1623
        self.interval = datetime.timedelta(0, 0, 0, value)
 
1624
        if getattr(self, "checker_initiator_tag", None) is None:
 
1625
            return
 
1626
        if self.enabled:
 
1627
            # Reschedule checker run
 
1628
            gobject.source_remove(self.checker_initiator_tag)
 
1629
            self.checker_initiator_tag = gobject.timeout_add(
 
1630
                value, self.start_checker)
 
1631
            self.start_checker() # Start one now, too
 
1632
    
 
1633
    # Checker - property
 
1634
    @dbus_service_property(_interface,
 
1635
                           signature="s",
 
1636
                           access="readwrite")
 
1637
    def Checker_dbus_property(self, value=None):
 
1638
        if value is None:       # get
 
1639
            return dbus.String(self.checker_command)
 
1640
        self.checker_command = str(value)
 
1641
    
 
1642
    # CheckerRunning - property
 
1643
    @dbus_service_property(_interface,
 
1644
                           signature="b",
 
1645
                           access="readwrite")
 
1646
    def CheckerRunning_dbus_property(self, value=None):
 
1647
        if value is None:       # get
 
1648
            return dbus.Boolean(self.checker is not None)
 
1649
        if value:
 
1650
            self.start_checker()
 
1651
        else:
 
1652
            self.stop_checker()
 
1653
    
 
1654
    # ObjectPath - property
 
1655
    @dbus_service_property(_interface, signature="o", access="read")
 
1656
    def ObjectPath_dbus_property(self):
 
1657
        return self.dbus_object_path # is already a dbus.ObjectPath
 
1658
    
 
1659
    # Secret = property
 
1660
    @dbus_service_property(_interface,
 
1661
                           signature="ay",
 
1662
                           access="write",
 
1663
                           byte_arrays=True)
 
1664
    def Secret_dbus_property(self, value):
 
1665
        self.secret = bytes(value)
 
1666
    
 
1667
    del _interface
 
1668
 
 
1669
 
 
1670
class ProxyClient(object):
 
1671
    def __init__(self, child_pipe, fpr, address):
 
1672
        self._pipe = child_pipe
 
1673
        self._pipe.send(('init', fpr, address))
 
1674
        if not self._pipe.recv():
 
1675
            raise KeyError(fpr)
 
1676
    
 
1677
    def __getattribute__(self, name):
 
1678
        if name == '_pipe':
 
1679
            return super(ProxyClient, self).__getattribute__(name)
 
1680
        self._pipe.send(('getattr', name))
 
1681
        data = self._pipe.recv()
 
1682
        if data[0] == 'data':
 
1683
            return data[1]
 
1684
        if data[0] == 'function':
 
1685
            
 
1686
            def func(*args, **kwargs):
 
1687
                self._pipe.send(('funcall', name, args, kwargs))
 
1688
                return self._pipe.recv()[1]
 
1689
            
 
1690
            return func
 
1691
    
 
1692
    def __setattr__(self, name, value):
 
1693
        if name == '_pipe':
 
1694
            return super(ProxyClient, self).__setattr__(name, value)
 
1695
        self._pipe.send(('setattr', name, value))
 
1696
 
 
1697
 
 
1698
class ClientHandler(socketserver.BaseRequestHandler, object):
 
1699
    """A class to handle client connections.
 
1700
    
 
1701
    Instantiated once for each connection to handle it.
438
1702
    Note: This will run in its own forked process."""
439
1703
    
440
1704
    def handle(self):
441
 
        logger.info(u"TCP connection from: %s",
442
 
                     unicode(self.client_address))
443
 
        session = gnutls.connection.ClientSession\
444
 
                  (self.request, gnutls.connection.X509Credentials())
445
 
        
446
 
        line = self.request.makefile().readline()
447
 
        logger.debug(u"Protocol version: %r", line)
448
 
        try:
449
 
            if int(line.strip().split()[0]) > 1:
450
 
                raise RuntimeError
451
 
        except (ValueError, IndexError, RuntimeError), error:
452
 
            logger.error(u"Unknown protocol version: %s", error)
453
 
            return
454
 
        
455
 
        # Note: gnutls.connection.X509Credentials is really a generic
456
 
        # GnuTLS certificate credentials object so long as no X.509
457
 
        # keys are added to it.  Therefore, we can use it here despite
458
 
        # using OpenPGP certificates.
459
 
        
460
 
        #priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
461
 
        #                "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
462
 
        #                "+DHE-DSS"))
463
 
        priority = "NORMAL"             # Fallback default, since this
464
 
                                        # MUST be set.
465
 
        if self.server.settings["priority"]:
466
 
            priority = self.server.settings["priority"]
467
 
        gnutls.library.functions.gnutls_priority_set_direct\
468
 
            (session._c_object, priority, None);
469
 
        
470
 
        try:
471
 
            session.handshake()
472
 
        except gnutls.errors.GNUTLSError, error:
473
 
            logger.warning(u"Handshake failed: %s", error)
474
 
            # Do not run session.bye() here: the session is not
475
 
            # established.  Just abandon the request.
476
 
            return
477
 
        try:
478
 
            fpr = fingerprint(peer_certificate(session))
479
 
        except (TypeError, gnutls.errors.GNUTLSError), error:
480
 
            logger.warning(u"Bad certificate: %s", error)
481
 
            session.bye()
482
 
            return
483
 
        logger.debug(u"Fingerprint: %s", fpr)
484
 
        client = None
485
 
        for c in self.server.clients:
486
 
            if c.fingerprint == fpr:
487
 
                client = c
488
 
                break
489
 
        if not client:
490
 
            logger.warning(u"Client not found for fingerprint: %s",
491
 
                           fpr)
492
 
            session.bye()
493
 
            return
494
 
        # Have to check if client.still_valid(), since it is possible
495
 
        # that the client timed out while establishing the GnuTLS
496
 
        # session.
497
 
        if not client.still_valid():
498
 
            logger.warning(u"Client %(name)s is invalid",
499
 
                           vars(client))
500
 
            session.bye()
501
 
            return
502
 
        sent_size = 0
503
 
        while sent_size < len(client.secret):
504
 
            sent = session.send(client.secret[sent_size:])
505
 
            logger.debug(u"Sent: %d, remaining: %d",
506
 
                         sent, len(client.secret)
507
 
                         - (sent_size + sent))
508
 
            sent_size += sent
509
 
        session.bye()
510
 
 
511
 
 
512
 
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
513
 
    """IPv6 TCP server.  Accepts 'None' as address and/or port.
 
1705
        with contextlib.closing(self.server.child_pipe) as child_pipe:
 
1706
            logger.info("TCP connection from: %s",
 
1707
                        str(self.client_address))
 
1708
            logger.debug("Pipe FD: %d",
 
1709
                         self.server.child_pipe.fileno())
 
1710
            
 
1711
            session = gnutls.connection.ClientSession(
 
1712
                self.request, gnutls.connection .X509Credentials())
 
1713
            
 
1714
            # Note: gnutls.connection.X509Credentials is really a
 
1715
            # generic GnuTLS certificate credentials object so long as
 
1716
            # no X.509 keys are added to it.  Therefore, we can use it
 
1717
            # here despite using OpenPGP certificates.
 
1718
            
 
1719
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
 
1720
            #                      "+AES-256-CBC", "+SHA1",
 
1721
            #                      "+COMP-NULL", "+CTYPE-OPENPGP",
 
1722
            #                      "+DHE-DSS"))
 
1723
            # Use a fallback default, since this MUST be set.
 
1724
            priority = self.server.gnutls_priority
 
1725
            if priority is None:
 
1726
                priority = "NORMAL"
 
1727
            gnutls.library.functions.gnutls_priority_set_direct(
 
1728
                session._c_object, priority, None)
 
1729
            
 
1730
            # Start communication using the Mandos protocol
 
1731
            # Get protocol number
 
1732
            line = self.request.makefile().readline()
 
1733
            logger.debug("Protocol version: %r", line)
 
1734
            try:
 
1735
                if int(line.strip().split()[0]) > 1:
 
1736
                    raise RuntimeError(line)
 
1737
            except (ValueError, IndexError, RuntimeError) as error:
 
1738
                logger.error("Unknown protocol version: %s", error)
 
1739
                return
 
1740
            
 
1741
            # Start GnuTLS connection
 
1742
            try:
 
1743
                session.handshake()
 
1744
            except gnutls.errors.GNUTLSError as error:
 
1745
                logger.warning("Handshake failed: %s", error)
 
1746
                # Do not run session.bye() here: the session is not
 
1747
                # established.  Just abandon the request.
 
1748
                return
 
1749
            logger.debug("Handshake succeeded")
 
1750
            
 
1751
            approval_required = False
 
1752
            try:
 
1753
                try:
 
1754
                    fpr = self.fingerprint(
 
1755
                        self.peer_certificate(session))
 
1756
                except (TypeError,
 
1757
                        gnutls.errors.GNUTLSError) as error:
 
1758
                    logger.warning("Bad certificate: %s", error)
 
1759
                    return
 
1760
                logger.debug("Fingerprint: %s", fpr)
 
1761
                
 
1762
                try:
 
1763
                    client = ProxyClient(child_pipe, fpr,
 
1764
                                         self.client_address)
 
1765
                except KeyError:
 
1766
                    return
 
1767
                
 
1768
                if client.approval_delay:
 
1769
                    delay = client.approval_delay
 
1770
                    client.approvals_pending += 1
 
1771
                    approval_required = True
 
1772
                
 
1773
                while True:
 
1774
                    if not client.enabled:
 
1775
                        logger.info("Client %s is disabled",
 
1776
                                    client.name)
 
1777
                        if self.server.use_dbus:
 
1778
                            # Emit D-Bus signal
 
1779
                            client.Rejected("Disabled")
 
1780
                        return
 
1781
                    
 
1782
                    if client.approved or not client.approval_delay:
 
1783
                        #We are approved or approval is disabled
 
1784
                        break
 
1785
                    elif client.approved is None:
 
1786
                        logger.info("Client %s needs approval",
 
1787
                                    client.name)
 
1788
                        if self.server.use_dbus:
 
1789
                            # Emit D-Bus signal
 
1790
                            client.NeedApproval(
 
1791
                                client.approval_delay.total_seconds()
 
1792
                                * 1000, client.approved_by_default)
 
1793
                    else:
 
1794
                        logger.warning("Client %s was not approved",
 
1795
                                       client.name)
 
1796
                        if self.server.use_dbus:
 
1797
                            # Emit D-Bus signal
 
1798
                            client.Rejected("Denied")
 
1799
                        return
 
1800
                    
 
1801
                    #wait until timeout or approved
 
1802
                    time = datetime.datetime.now()
 
1803
                    client.changedstate.acquire()
 
1804
                    client.changedstate.wait(delay.total_seconds())
 
1805
                    client.changedstate.release()
 
1806
                    time2 = datetime.datetime.now()
 
1807
                    if (time2 - time) >= delay:
 
1808
                        if not client.approved_by_default:
 
1809
                            logger.warning("Client %s timed out while"
 
1810
                                           " waiting for approval",
 
1811
                                           client.name)
 
1812
                            if self.server.use_dbus:
 
1813
                                # Emit D-Bus signal
 
1814
                                client.Rejected("Approval timed out")
 
1815
                            return
 
1816
                        else:
 
1817
                            break
 
1818
                    else:
 
1819
                        delay -= time2 - time
 
1820
                
 
1821
                sent_size = 0
 
1822
                while sent_size < len(client.secret):
 
1823
                    try:
 
1824
                        sent = session.send(client.secret[sent_size:])
 
1825
                    except gnutls.errors.GNUTLSError as error:
 
1826
                        logger.warning("gnutls send failed",
 
1827
                                       exc_info=error)
 
1828
                        return
 
1829
                    logger.debug("Sent: %d, remaining: %d", sent,
 
1830
                                 len(client.secret) - (sent_size
 
1831
                                                       + sent))
 
1832
                    sent_size += sent
 
1833
                
 
1834
                logger.info("Sending secret to %s", client.name)
 
1835
                # bump the timeout using extended_timeout
 
1836
                client.bump_timeout(client.extended_timeout)
 
1837
                if self.server.use_dbus:
 
1838
                    # Emit D-Bus signal
 
1839
                    client.GotSecret()
 
1840
            
 
1841
            finally:
 
1842
                if approval_required:
 
1843
                    client.approvals_pending -= 1
 
1844
                try:
 
1845
                    session.bye()
 
1846
                except gnutls.errors.GNUTLSError as error:
 
1847
                    logger.warning("GnuTLS bye failed",
 
1848
                                   exc_info=error)
 
1849
    
 
1850
    @staticmethod
 
1851
    def peer_certificate(session):
 
1852
        "Return the peer's OpenPGP certificate as a bytestring"
 
1853
        # If not an OpenPGP certificate...
 
1854
        if (gnutls.library.functions.gnutls_certificate_type_get(
 
1855
                session._c_object)
 
1856
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
 
1857
            # ...do the normal thing
 
1858
            return session.peer_certificate
 
1859
        list_size = ctypes.c_uint(1)
 
1860
        cert_list = (gnutls.library.functions
 
1861
                     .gnutls_certificate_get_peers
 
1862
                     (session._c_object, ctypes.byref(list_size)))
 
1863
        if not bool(cert_list) and list_size.value != 0:
 
1864
            raise gnutls.errors.GNUTLSError("error getting peer"
 
1865
                                            " certificate")
 
1866
        if list_size.value == 0:
 
1867
            return None
 
1868
        cert = cert_list[0]
 
1869
        return ctypes.string_at(cert.data, cert.size)
 
1870
    
 
1871
    @staticmethod
 
1872
    def fingerprint(openpgp):
 
1873
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
 
1874
        # New GnuTLS "datum" with the OpenPGP public key
 
1875
        datum = gnutls.library.types.gnutls_datum_t(
 
1876
            ctypes.cast(ctypes.c_char_p(openpgp),
 
1877
                        ctypes.POINTER(ctypes.c_ubyte)),
 
1878
            ctypes.c_uint(len(openpgp)))
 
1879
        # New empty GnuTLS certificate
 
1880
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
 
1881
        gnutls.library.functions.gnutls_openpgp_crt_init(
 
1882
            ctypes.byref(crt))
 
1883
        # Import the OpenPGP public key into the certificate
 
1884
        gnutls.library.functions.gnutls_openpgp_crt_import(
 
1885
            crt, ctypes.byref(datum),
 
1886
            gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
 
1887
        # Verify the self signature in the key
 
1888
        crtverify = ctypes.c_uint()
 
1889
        gnutls.library.functions.gnutls_openpgp_crt_verify_self(
 
1890
            crt, 0, ctypes.byref(crtverify))
 
1891
        if crtverify.value != 0:
 
1892
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
1893
            raise gnutls.errors.CertificateSecurityError(
 
1894
                "Verify failed")
 
1895
        # New buffer for the fingerprint
 
1896
        buf = ctypes.create_string_buffer(20)
 
1897
        buf_len = ctypes.c_size_t()
 
1898
        # Get the fingerprint from the certificate into the buffer
 
1899
        gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
 
1900
            crt, ctypes.byref(buf), ctypes.byref(buf_len))
 
1901
        # Deinit the certificate
 
1902
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
1903
        # Convert the buffer to a Python bytestring
 
1904
        fpr = ctypes.string_at(buf, buf_len.value)
 
1905
        # Convert the bytestring to hexadecimal notation
 
1906
        hex_fpr = binascii.hexlify(fpr).upper()
 
1907
        return hex_fpr
 
1908
 
 
1909
 
 
1910
class MultiprocessingMixIn(object):
 
1911
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
 
1912
    
 
1913
    def sub_process_main(self, request, address):
 
1914
        try:
 
1915
            self.finish_request(request, address)
 
1916
        except Exception:
 
1917
            self.handle_error(request, address)
 
1918
        self.close_request(request)
 
1919
    
 
1920
    def process_request(self, request, address):
 
1921
        """Start a new process to process the request."""
 
1922
        proc = multiprocessing.Process(target = self.sub_process_main,
 
1923
                                       args = (request, address))
 
1924
        proc.start()
 
1925
        return proc
 
1926
 
 
1927
 
 
1928
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
 
1929
    """ adds a pipe to the MixIn """
 
1930
    
 
1931
    def process_request(self, request, client_address):
 
1932
        """Overrides and wraps the original process_request().
 
1933
        
 
1934
        This function creates a new pipe in self.pipe
 
1935
        """
 
1936
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
 
1937
        
 
1938
        proc = MultiprocessingMixIn.process_request(self, request,
 
1939
                                                    client_address)
 
1940
        self.child_pipe.close()
 
1941
        self.add_pipe(parent_pipe, proc)
 
1942
    
 
1943
    def add_pipe(self, parent_pipe, proc):
 
1944
        """Dummy function; override as necessary"""
 
1945
        raise NotImplementedError()
 
1946
 
 
1947
 
 
1948
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
 
1949
                     socketserver.TCPServer, object):
 
1950
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
 
1951
    
514
1952
    Attributes:
515
 
        settings:       Server settings
516
 
        clients:        Set() of Client objects
 
1953
        enabled:        Boolean; whether this server is activated yet
 
1954
        interface:      None or a network interface name (string)
 
1955
        use_ipv6:       Boolean; to use IPv6 or not
517
1956
    """
518
 
    address_family = socket.AF_INET6
519
 
    def __init__(self, *args, **kwargs):
520
 
        if "settings" in kwargs:
521
 
            self.settings = kwargs["settings"]
522
 
            del kwargs["settings"]
523
 
        if "clients" in kwargs:
524
 
            self.clients = kwargs["clients"]
525
 
            del kwargs["clients"]
526
 
        return super(type(self), self).__init__(*args, **kwargs)
 
1957
    
 
1958
    def __init__(self, server_address, RequestHandlerClass,
 
1959
                 interface=None,
 
1960
                 use_ipv6=True,
 
1961
                 socketfd=None):
 
1962
        """If socketfd is set, use that file descriptor instead of
 
1963
        creating a new one with socket.socket().
 
1964
        """
 
1965
        self.interface = interface
 
1966
        if use_ipv6:
 
1967
            self.address_family = socket.AF_INET6
 
1968
        if socketfd is not None:
 
1969
            # Save the file descriptor
 
1970
            self.socketfd = socketfd
 
1971
            # Save the original socket.socket() function
 
1972
            self.socket_socket = socket.socket
 
1973
            # To implement --socket, we monkey patch socket.socket.
 
1974
            # 
 
1975
            # (When socketserver.TCPServer is a new-style class, we
 
1976
            # could make self.socket into a property instead of monkey
 
1977
            # patching socket.socket.)
 
1978
            # 
 
1979
            # Create a one-time-only replacement for socket.socket()
 
1980
            @functools.wraps(socket.socket)
 
1981
            def socket_wrapper(*args, **kwargs):
 
1982
                # Restore original function so subsequent calls are
 
1983
                # not affected.
 
1984
                socket.socket = self.socket_socket
 
1985
                del self.socket_socket
 
1986
                # This time only, return a new socket object from the
 
1987
                # saved file descriptor.
 
1988
                return socket.fromfd(self.socketfd, *args, **kwargs)
 
1989
            # Replace socket.socket() function with wrapper
 
1990
            socket.socket = socket_wrapper
 
1991
        # The socketserver.TCPServer.__init__ will call
 
1992
        # socket.socket(), which might be our replacement,
 
1993
        # socket_wrapper(), if socketfd was set.
 
1994
        socketserver.TCPServer.__init__(self, server_address,
 
1995
                                        RequestHandlerClass)
 
1996
    
527
1997
    def server_bind(self):
528
1998
        """This overrides the normal server_bind() function
529
1999
        to bind to an interface if one was specified, and also NOT to
530
2000
        bind to an address or port if they were not specified."""
531
 
        if self.settings["interface"]:
532
 
            # 25 is from /usr/include/asm-i486/socket.h
533
 
            SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
534
 
            try:
535
 
                self.socket.setsockopt(socket.SOL_SOCKET,
536
 
                                       SO_BINDTODEVICE,
537
 
                                       self.settings["interface"])
538
 
            except socket.error, error:
539
 
                if error[0] == errno.EPERM:
540
 
                    logger.error(u"No permission to"
541
 
                                 u" bind to interface %s",
542
 
                                 self.settings["interface"])
543
 
                else:
544
 
                    raise error
 
2001
        if self.interface is not None:
 
2002
            if SO_BINDTODEVICE is None:
 
2003
                logger.error("SO_BINDTODEVICE does not exist;"
 
2004
                             " cannot bind to interface %s",
 
2005
                             self.interface)
 
2006
            else:
 
2007
                try:
 
2008
                    self.socket.setsockopt(
 
2009
                        socket.SOL_SOCKET, SO_BINDTODEVICE,
 
2010
                        (self.interface + "\0").encode("utf-8"))
 
2011
                except socket.error as error:
 
2012
                    if error.errno == errno.EPERM:
 
2013
                        logger.error("No permission to bind to"
 
2014
                                     " interface %s", self.interface)
 
2015
                    elif error.errno == errno.ENOPROTOOPT:
 
2016
                        logger.error("SO_BINDTODEVICE not available;"
 
2017
                                     " cannot bind to interface %s",
 
2018
                                     self.interface)
 
2019
                    elif error.errno == errno.ENODEV:
 
2020
                        logger.error("Interface %s does not exist,"
 
2021
                                     " cannot bind", self.interface)
 
2022
                    else:
 
2023
                        raise
545
2024
        # Only bind(2) the socket if we really need to.
546
2025
        if self.server_address[0] or self.server_address[1]:
547
2026
            if not self.server_address[0]:
548
 
                in6addr_any = "::"
549
 
                self.server_address = (in6addr_any,
 
2027
                if self.address_family == socket.AF_INET6:
 
2028
                    any_address = "::" # in6addr_any
 
2029
                else:
 
2030
                    any_address = "0.0.0.0" # INADDR_ANY
 
2031
                self.server_address = (any_address,
550
2032
                                       self.server_address[1])
551
2033
            elif not self.server_address[1]:
552
 
                self.server_address = (self.server_address[0],
553
 
                                       0)
554
 
#                 if self.settings["interface"]:
 
2034
                self.server_address = (self.server_address[0], 0)
 
2035
#                 if self.interface:
555
2036
#                     self.server_address = (self.server_address[0],
556
2037
#                                            0, # port
557
2038
#                                            0, # flowinfo
558
2039
#                                            if_nametoindex
559
 
#                                            (self.settings
560
 
#                                             ["interface"]))
561
 
            return super(type(self), self).server_bind()
 
2040
#                                            (self.interface))
 
2041
            return socketserver.TCPServer.server_bind(self)
 
2042
 
 
2043
 
 
2044
class MandosServer(IPv6_TCPServer):
 
2045
    """Mandos server.
 
2046
    
 
2047
    Attributes:
 
2048
        clients:        set of Client objects
 
2049
        gnutls_priority GnuTLS priority string
 
2050
        use_dbus:       Boolean; to emit D-Bus signals or not
 
2051
    
 
2052
    Assumes a gobject.MainLoop event loop.
 
2053
    """
 
2054
    
 
2055
    def __init__(self, server_address, RequestHandlerClass,
 
2056
                 interface=None,
 
2057
                 use_ipv6=True,
 
2058
                 clients=None,
 
2059
                 gnutls_priority=None,
 
2060
                 use_dbus=True,
 
2061
                 socketfd=None):
 
2062
        self.enabled = False
 
2063
        self.clients = clients
 
2064
        if self.clients is None:
 
2065
            self.clients = {}
 
2066
        self.use_dbus = use_dbus
 
2067
        self.gnutls_priority = gnutls_priority
 
2068
        IPv6_TCPServer.__init__(self, server_address,
 
2069
                                RequestHandlerClass,
 
2070
                                interface = interface,
 
2071
                                use_ipv6 = use_ipv6,
 
2072
                                socketfd = socketfd)
 
2073
    
 
2074
    def server_activate(self):
 
2075
        if self.enabled:
 
2076
            return socketserver.TCPServer.server_activate(self)
 
2077
    
 
2078
    def enable(self):
 
2079
        self.enabled = True
 
2080
    
 
2081
    def add_pipe(self, parent_pipe, proc):
 
2082
        # Call "handle_ipc" for both data and EOF events
 
2083
        gobject.io_add_watch(
 
2084
            parent_pipe.fileno(),
 
2085
            gobject.IO_IN | gobject.IO_HUP,
 
2086
            functools.partial(self.handle_ipc,
 
2087
                              parent_pipe = parent_pipe,
 
2088
                              proc = proc))
 
2089
    
 
2090
    def handle_ipc(self, source, condition,
 
2091
                   parent_pipe=None,
 
2092
                   proc = None,
 
2093
                   client_object=None):
 
2094
        # error, or the other end of multiprocessing.Pipe has closed
 
2095
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
 
2096
            # Wait for other process to exit
 
2097
            proc.join()
 
2098
            return False
 
2099
        
 
2100
        # Read a request from the child
 
2101
        request = parent_pipe.recv()
 
2102
        command = request[0]
 
2103
        
 
2104
        if command == 'init':
 
2105
            fpr = request[1]
 
2106
            address = request[2]
 
2107
            
 
2108
            for c in self.clients.itervalues():
 
2109
                if c.fingerprint == fpr:
 
2110
                    client = c
 
2111
                    break
 
2112
            else:
 
2113
                logger.info("Client not found for fingerprint: %s, ad"
 
2114
                            "dress: %s", fpr, address)
 
2115
                if self.use_dbus:
 
2116
                    # Emit D-Bus signal
 
2117
                    mandos_dbus_service.ClientNotFound(fpr,
 
2118
                                                       address[0])
 
2119
                parent_pipe.send(False)
 
2120
                return False
 
2121
            
 
2122
            gobject.io_add_watch(
 
2123
                parent_pipe.fileno(),
 
2124
                gobject.IO_IN | gobject.IO_HUP,
 
2125
                functools.partial(self.handle_ipc,
 
2126
                                  parent_pipe = parent_pipe,
 
2127
                                  proc = proc,
 
2128
                                  client_object = client))
 
2129
            parent_pipe.send(True)
 
2130
            # remove the old hook in favor of the new above hook on
 
2131
            # same fileno
 
2132
            return False
 
2133
        if command == 'funcall':
 
2134
            funcname = request[1]
 
2135
            args = request[2]
 
2136
            kwargs = request[3]
 
2137
            
 
2138
            parent_pipe.send(('data', getattr(client_object,
 
2139
                                              funcname)(*args,
 
2140
                                                        **kwargs)))
 
2141
        
 
2142
        if command == 'getattr':
 
2143
            attrname = request[1]
 
2144
            if callable(client_object.__getattribute__(attrname)):
 
2145
                parent_pipe.send(('function', ))
 
2146
            else:
 
2147
                parent_pipe.send((
 
2148
                    'data', client_object.__getattribute__(attrname)))
 
2149
        
 
2150
        if command == 'setattr':
 
2151
            attrname = request[1]
 
2152
            value = request[2]
 
2153
            setattr(client_object, attrname, value)
 
2154
        
 
2155
        return True
 
2156
 
 
2157
 
 
2158
def rfc3339_duration_to_delta(duration):
 
2159
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
 
2160
    
 
2161
    >>> rfc3339_duration_to_delta("P7D")
 
2162
    datetime.timedelta(7)
 
2163
    >>> rfc3339_duration_to_delta("PT60S")
 
2164
    datetime.timedelta(0, 60)
 
2165
    >>> rfc3339_duration_to_delta("PT60M")
 
2166
    datetime.timedelta(0, 3600)
 
2167
    >>> rfc3339_duration_to_delta("PT24H")
 
2168
    datetime.timedelta(1)
 
2169
    >>> rfc3339_duration_to_delta("P1W")
 
2170
    datetime.timedelta(7)
 
2171
    >>> rfc3339_duration_to_delta("PT5M30S")
 
2172
    datetime.timedelta(0, 330)
 
2173
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
2174
    datetime.timedelta(1, 200)
 
2175
    """
 
2176
    
 
2177
    # Parsing an RFC 3339 duration with regular expressions is not
 
2178
    # possible - there would have to be multiple places for the same
 
2179
    # values, like seconds.  The current code, while more esoteric, is
 
2180
    # cleaner without depending on a parsing library.  If Python had a
 
2181
    # built-in library for parsing we would use it, but we'd like to
 
2182
    # avoid excessive use of external libraries.
 
2183
    
 
2184
    # New type for defining tokens, syntax, and semantics all-in-one
 
2185
    Token = collections.namedtuple("Token",
 
2186
                                   ("regexp", # To match token; if
 
2187
                                              # "value" is not None,
 
2188
                                              # must have a "group"
 
2189
                                              # containing digits
 
2190
                                    "value",  # datetime.timedelta or
 
2191
                                              # None
 
2192
                                    "followers")) # Tokens valid after
 
2193
                                                  # this token
 
2194
    Token = collections.namedtuple("Token", (
 
2195
        "regexp",  # To match token; if "value" is not None, must have
 
2196
                   # a "group" containing digits
 
2197
        "value",   # datetime.timedelta or None
 
2198
        "followers"))           # Tokens valid after this token
 
2199
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
 
2200
    # the "duration" ABNF definition in RFC 3339, Appendix A.
 
2201
    token_end = Token(re.compile(r"$"), None, frozenset())
 
2202
    token_second = Token(re.compile(r"(\d+)S"),
 
2203
                         datetime.timedelta(seconds=1),
 
2204
                         frozenset((token_end, )))
 
2205
    token_minute = Token(re.compile(r"(\d+)M"),
 
2206
                         datetime.timedelta(minutes=1),
 
2207
                         frozenset((token_second, token_end)))
 
2208
    token_hour = Token(re.compile(r"(\d+)H"),
 
2209
                       datetime.timedelta(hours=1),
 
2210
                       frozenset((token_minute, token_end)))
 
2211
    token_time = Token(re.compile(r"T"),
 
2212
                       None,
 
2213
                       frozenset((token_hour, token_minute,
 
2214
                                  token_second)))
 
2215
    token_day = Token(re.compile(r"(\d+)D"),
 
2216
                      datetime.timedelta(days=1),
 
2217
                      frozenset((token_time, token_end)))
 
2218
    token_month = Token(re.compile(r"(\d+)M"),
 
2219
                        datetime.timedelta(weeks=4),
 
2220
                        frozenset((token_day, token_end)))
 
2221
    token_year = Token(re.compile(r"(\d+)Y"),
 
2222
                       datetime.timedelta(weeks=52),
 
2223
                       frozenset((token_month, token_end)))
 
2224
    token_week = Token(re.compile(r"(\d+)W"),
 
2225
                       datetime.timedelta(weeks=1),
 
2226
                       frozenset((token_end, )))
 
2227
    token_duration = Token(re.compile(r"P"), None,
 
2228
                           frozenset((token_year, token_month,
 
2229
                                      token_day, token_time,
 
2230
                                      token_week)))
 
2231
    # Define starting values
 
2232
    value = datetime.timedelta() # Value so far
 
2233
    found_token = None
 
2234
    followers = frozenset((token_duration,)) # Following valid tokens
 
2235
    s = duration                # String left to parse
 
2236
    # Loop until end token is found
 
2237
    while found_token is not token_end:
 
2238
        # Search for any currently valid tokens
 
2239
        for token in followers:
 
2240
            match = token.regexp.match(s)
 
2241
            if match is not None:
 
2242
                # Token found
 
2243
                if token.value is not None:
 
2244
                    # Value found, parse digits
 
2245
                    factor = int(match.group(1), 10)
 
2246
                    # Add to value so far
 
2247
                    value += factor * token.value
 
2248
                # Strip token from string
 
2249
                s = token.regexp.sub("", s, 1)
 
2250
                # Go to found token
 
2251
                found_token = token
 
2252
                # Set valid next tokens
 
2253
                followers = found_token.followers
 
2254
                break
 
2255
        else:
 
2256
            # No currently valid tokens were found
 
2257
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
2258
                             .format(duration))
 
2259
    # End token found
 
2260
    return value
562
2261
 
563
2262
 
564
2263
def string_to_delta(interval):
565
2264
    """Parse a string and return a datetime.timedelta
566
 
 
 
2265
    
567
2266
    >>> string_to_delta('7d')
568
2267
    datetime.timedelta(7)
569
2268
    >>> string_to_delta('60s')
572
2271
    datetime.timedelta(0, 3600)
573
2272
    >>> string_to_delta('24h')
574
2273
    datetime.timedelta(1)
575
 
    >>> string_to_delta(u'1w')
 
2274
    >>> string_to_delta('1w')
576
2275
    datetime.timedelta(7)
577
2276
    >>> string_to_delta('5m 30s')
578
2277
    datetime.timedelta(0, 330)
579
2278
    """
 
2279
    
 
2280
    try:
 
2281
        return rfc3339_duration_to_delta(interval)
 
2282
    except ValueError:
 
2283
        pass
 
2284
    
580
2285
    timevalue = datetime.timedelta(0)
581
2286
    for s in interval.split():
582
2287
        try:
583
 
            suffix=unicode(s[-1])
584
 
            value=int(s[:-1])
585
 
            if suffix == u"d":
 
2288
            suffix = s[-1]
 
2289
            value = int(s[:-1])
 
2290
            if suffix == "d":
586
2291
                delta = datetime.timedelta(value)
587
 
            elif suffix == u"s":
 
2292
            elif suffix == "s":
588
2293
                delta = datetime.timedelta(0, value)
589
 
            elif suffix == u"m":
 
2294
            elif suffix == "m":
590
2295
                delta = datetime.timedelta(0, 0, 0, 0, value)
591
 
            elif suffix == u"h":
 
2296
            elif suffix == "h":
592
2297
                delta = datetime.timedelta(0, 0, 0, 0, 0, value)
593
 
            elif suffix == u"w":
 
2298
            elif suffix == "w":
594
2299
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
595
2300
            else:
596
 
                raise ValueError
597
 
        except (ValueError, IndexError):
598
 
            raise ValueError
 
2301
                raise ValueError("Unknown suffix {!r}".format(suffix))
 
2302
        except IndexError as e:
 
2303
            raise ValueError(*(e.args))
599
2304
        timevalue += delta
600
2305
    return timevalue
601
2306
 
602
2307
 
603
 
def server_state_changed(state):
604
 
    """Derived from the Avahi example code"""
605
 
    if state == avahi.SERVER_COLLISION:
606
 
        logger.error(u"Server name collision")
607
 
        service.remove()
608
 
    elif state == avahi.SERVER_RUNNING:
609
 
        service.add()
610
 
 
611
 
 
612
 
def entry_group_state_changed(state, error):
613
 
    """Derived from the Avahi example code"""
614
 
    logger.debug(u"state change: %i", state)
615
 
    
616
 
    if state == avahi.ENTRY_GROUP_ESTABLISHED:
617
 
        logger.debug(u"Service established.")
618
 
    elif state == avahi.ENTRY_GROUP_COLLISION:
619
 
        logger.warning(u"Service name collision.")
620
 
        service.rename()
621
 
    elif state == avahi.ENTRY_GROUP_FAILURE:
622
 
        logger.critical(u"Error in group state changed %s",
623
 
                        unicode(error))
624
 
        raise AvahiGroupError("State changed: %s", str(error))
625
 
 
626
 
def if_nametoindex(interface):
627
 
    """Call the C function if_nametoindex(), or equivalent"""
628
 
    global if_nametoindex
629
 
    try:
630
 
        if "ctypes.util" not in sys.modules:
631
 
            import ctypes.util
632
 
        if_nametoindex = ctypes.cdll.LoadLibrary\
633
 
            (ctypes.util.find_library("c")).if_nametoindex
634
 
    except (OSError, AttributeError):
635
 
        if "struct" not in sys.modules:
636
 
            import struct
637
 
        if "fcntl" not in sys.modules:
638
 
            import fcntl
639
 
        def if_nametoindex(interface):
640
 
            "Get an interface index the hard way, i.e. using fcntl()"
641
 
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
642
 
            s = socket.socket()
643
 
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
644
 
                                struct.pack("16s16x", interface))
645
 
            s.close()
646
 
            interface_index = struct.unpack("I", ifreq[16:20])[0]
647
 
            return interface_index
648
 
    return if_nametoindex(interface)
649
 
 
650
 
 
651
2308
def daemon(nochdir = False, noclose = False):
652
2309
    """See daemon(3).  Standard BSD Unix function.
 
2310
    
653
2311
    This should really exist as os.daemon, but it doesn't (yet)."""
654
2312
    if os.fork():
655
2313
        sys.exit()
660
2318
        sys.exit()
661
2319
    if not noclose:
662
2320
        # Close all standard open file descriptors
663
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2321
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
664
2322
        if not stat.S_ISCHR(os.fstat(null).st_mode):
665
2323
            raise OSError(errno.ENODEV,
666
 
                          "/dev/null not a character device")
 
2324
                          "{} not a character device"
 
2325
                          .format(os.devnull))
667
2326
        os.dup2(null, sys.stdin.fileno())
668
2327
        os.dup2(null, sys.stdout.fileno())
669
2328
        os.dup2(null, sys.stderr.fileno())
672
2331
 
673
2332
 
674
2333
def main():
675
 
    global main_loop_started
676
 
    main_loop_started = False
677
 
    
678
 
    parser = OptionParser(version = "%%prog %s" % version)
679
 
    parser.add_option("-i", "--interface", type="string",
680
 
                      metavar="IF", help="Bind to interface IF")
681
 
    parser.add_option("-a", "--address", type="string",
682
 
                      help="Address to listen for requests on")
683
 
    parser.add_option("-p", "--port", type="int",
684
 
                      help="Port number to receive requests on")
685
 
    parser.add_option("--check", action="store_true", default=False,
686
 
                      help="Run self-test")
687
 
    parser.add_option("--debug", action="store_true",
688
 
                      help="Debug mode; run in foreground and log to"
689
 
                      " terminal")
690
 
    parser.add_option("--priority", type="string", help="GnuTLS"
691
 
                      " priority string (see GnuTLS documentation)")
692
 
    parser.add_option("--servicename", type="string", metavar="NAME",
693
 
                      help="Zeroconf service name")
694
 
    parser.add_option("--configdir", type="string",
695
 
                      default="/etc/mandos", metavar="DIR",
696
 
                      help="Directory to search for configuration"
697
 
                      " files")
698
 
    (options, args) = parser.parse_args()
 
2334
    
 
2335
    ##################################################################
 
2336
    # Parsing of options, both command line and config file
 
2337
    
 
2338
    parser = argparse.ArgumentParser()
 
2339
    parser.add_argument("-v", "--version", action="version",
 
2340
                        version = "%(prog)s {}".format(version),
 
2341
                        help="show version number and exit")
 
2342
    parser.add_argument("-i", "--interface", metavar="IF",
 
2343
                        help="Bind to interface IF")
 
2344
    parser.add_argument("-a", "--address",
 
2345
                        help="Address to listen for requests on")
 
2346
    parser.add_argument("-p", "--port", type=int,
 
2347
                        help="Port number to receive requests on")
 
2348
    parser.add_argument("--check", action="store_true",
 
2349
                        help="Run self-test")
 
2350
    parser.add_argument("--debug", action="store_true",
 
2351
                        help="Debug mode; run in foreground and log"
 
2352
                        " to terminal", default=None)
 
2353
    parser.add_argument("--debuglevel", metavar="LEVEL",
 
2354
                        help="Debug level for stdout output")
 
2355
    parser.add_argument("--priority", help="GnuTLS"
 
2356
                        " priority string (see GnuTLS documentation)")
 
2357
    parser.add_argument("--servicename",
 
2358
                        metavar="NAME", help="Zeroconf service name")
 
2359
    parser.add_argument("--configdir",
 
2360
                        default="/etc/mandos", metavar="DIR",
 
2361
                        help="Directory to search for configuration"
 
2362
                        " files")
 
2363
    parser.add_argument("--no-dbus", action="store_false",
 
2364
                        dest="use_dbus", help="Do not provide D-Bus"
 
2365
                        " system bus interface", default=None)
 
2366
    parser.add_argument("--no-ipv6", action="store_false",
 
2367
                        dest="use_ipv6", help="Do not use IPv6",
 
2368
                        default=None)
 
2369
    parser.add_argument("--no-restore", action="store_false",
 
2370
                        dest="restore", help="Do not restore stored"
 
2371
                        " state", default=None)
 
2372
    parser.add_argument("--socket", type=int,
 
2373
                        help="Specify a file descriptor to a network"
 
2374
                        " socket to use instead of creating one")
 
2375
    parser.add_argument("--statedir", metavar="DIR",
 
2376
                        help="Directory to save/restore state in")
 
2377
    parser.add_argument("--foreground", action="store_true",
 
2378
                        help="Run in foreground", default=None)
 
2379
    parser.add_argument("--no-zeroconf", action="store_false",
 
2380
                        dest="zeroconf", help="Do not use Zeroconf",
 
2381
                        default=None)
 
2382
    
 
2383
    options = parser.parse_args()
699
2384
    
700
2385
    if options.check:
701
2386
        import doctest
702
 
        doctest.testmod()
703
 
        sys.exit()
 
2387
        fail_count, test_count = doctest.testmod()
 
2388
        sys.exit(os.EX_OK if fail_count == 0 else 1)
704
2389
    
705
2390
    # Default values for config file for server-global settings
706
2391
    server_defaults = { "interface": "",
708
2393
                        "port": "",
709
2394
                        "debug": "False",
710
2395
                        "priority":
711
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
2396
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
 
2397
                        ":+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
712
2398
                        "servicename": "Mandos",
713
 
                        }
 
2399
                        "use_dbus": "True",
 
2400
                        "use_ipv6": "True",
 
2401
                        "debuglevel": "",
 
2402
                        "restore": "True",
 
2403
                        "socket": "",
 
2404
                        "statedir": "/var/lib/mandos",
 
2405
                        "foreground": "False",
 
2406
                        "zeroconf": "True",
 
2407
                    }
714
2408
    
715
2409
    # Parse config file for server-global settings
716
 
    server_config = ConfigParser.SafeConfigParser(server_defaults)
 
2410
    server_config = configparser.SafeConfigParser(server_defaults)
717
2411
    del server_defaults
718
2412
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
719
2413
    # Convert the SafeConfigParser object to a dict
720
2414
    server_settings = server_config.defaults()
721
 
    # Use getboolean on the boolean config option
722
 
    server_settings["debug"] = server_config.getboolean\
723
 
                               ("DEFAULT", "debug")
 
2415
    # Use the appropriate methods on the non-string config options
 
2416
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
 
2417
        server_settings[option] = server_config.getboolean("DEFAULT",
 
2418
                                                           option)
 
2419
    if server_settings["port"]:
 
2420
        server_settings["port"] = server_config.getint("DEFAULT",
 
2421
                                                       "port")
 
2422
    if server_settings["socket"]:
 
2423
        server_settings["socket"] = server_config.getint("DEFAULT",
 
2424
                                                         "socket")
 
2425
        # Later, stdin will, and stdout and stderr might, be dup'ed
 
2426
        # over with an opened os.devnull.  But we don't want this to
 
2427
        # happen with a supplied network socket.
 
2428
        if 0 <= server_settings["socket"] <= 2:
 
2429
            server_settings["socket"] = os.dup(server_settings
 
2430
                                               ["socket"])
724
2431
    del server_config
725
2432
    
726
2433
    # Override the settings from the config file with command line
727
2434
    # options, if set.
728
2435
    for option in ("interface", "address", "port", "debug",
729
 
                   "priority", "servicename", "configdir"):
 
2436
                   "priority", "servicename", "configdir", "use_dbus",
 
2437
                   "use_ipv6", "debuglevel", "restore", "statedir",
 
2438
                   "socket", "foreground", "zeroconf"):
730
2439
        value = getattr(options, option)
731
2440
        if value is not None:
732
2441
            server_settings[option] = value
733
2442
    del options
 
2443
    # Force all strings to be unicode
 
2444
    for option in server_settings.keys():
 
2445
        if isinstance(server_settings[option], bytes):
 
2446
            server_settings[option] = (server_settings[option]
 
2447
                                       .decode("utf-8"))
 
2448
    # Force all boolean options to be boolean
 
2449
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
2450
                   "foreground", "zeroconf"):
 
2451
        server_settings[option] = bool(server_settings[option])
 
2452
    # Debug implies foreground
 
2453
    if server_settings["debug"]:
 
2454
        server_settings["foreground"] = True
734
2455
    # Now we have our good server settings in "server_settings"
735
2456
    
 
2457
    ##################################################################
 
2458
    
 
2459
    if (not server_settings["zeroconf"]
 
2460
        and not (server_settings["port"]
 
2461
                 or server_settings["socket"] != "")):
 
2462
        parser.error("Needs port or socket to work without Zeroconf")
 
2463
    
 
2464
    # For convenience
736
2465
    debug = server_settings["debug"]
 
2466
    debuglevel = server_settings["debuglevel"]
 
2467
    use_dbus = server_settings["use_dbus"]
 
2468
    use_ipv6 = server_settings["use_ipv6"]
 
2469
    stored_state_path = os.path.join(server_settings["statedir"],
 
2470
                                     stored_state_file)
 
2471
    foreground = server_settings["foreground"]
 
2472
    zeroconf = server_settings["zeroconf"]
737
2473
    
738
 
    if not debug:
739
 
        syslogger.setLevel(logging.WARNING)
740
 
        console.setLevel(logging.WARNING)
 
2474
    if debug:
 
2475
        initlogger(debug, logging.DEBUG)
 
2476
    else:
 
2477
        if not debuglevel:
 
2478
            initlogger(debug)
 
2479
        else:
 
2480
            level = getattr(logging, debuglevel.upper())
 
2481
            initlogger(debug, level)
741
2482
    
742
2483
    if server_settings["servicename"] != "Mandos":
743
 
        syslogger.setFormatter(logging.Formatter\
744
 
                               ('Mandos (%s): %%(levelname)s:'
745
 
                                ' %%(message)s'
746
 
                                % server_settings["servicename"]))
 
2484
        syslogger.setFormatter(
 
2485
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
2486
                              ' %(levelname)s: %(message)s'.format(
 
2487
                                  server_settings["servicename"])))
747
2488
    
748
2489
    # Parse config file with clients
749
 
    client_defaults = { "timeout": "1h",
750
 
                        "interval": "5m",
751
 
                        "checker": "fping -q -- %(host)s",
752
 
                        "host": "",
753
 
                        }
754
 
    client_config = ConfigParser.SafeConfigParser(client_defaults)
 
2490
    client_config = configparser.SafeConfigParser(Client
 
2491
                                                  .client_defaults)
755
2492
    client_config.read(os.path.join(server_settings["configdir"],
756
2493
                                    "clients.conf"))
757
2494
    
758
 
    global service
759
 
    service = AvahiService(name = server_settings["servicename"],
760
 
                           type = "_mandos._tcp", );
761
 
    if server_settings["interface"]:
762
 
        service.interface = if_nametoindex(server_settings["interface"])
 
2495
    global mandos_dbus_service
 
2496
    mandos_dbus_service = None
 
2497
    
 
2498
    socketfd = None
 
2499
    if server_settings["socket"] != "":
 
2500
        socketfd = server_settings["socket"]
 
2501
    tcp_server = MandosServer(
 
2502
        (server_settings["address"], server_settings["port"]),
 
2503
        ClientHandler,
 
2504
        interface=(server_settings["interface"] or None),
 
2505
        use_ipv6=use_ipv6,
 
2506
        gnutls_priority=server_settings["priority"],
 
2507
        use_dbus=use_dbus,
 
2508
        socketfd=socketfd)
 
2509
    if not foreground:
 
2510
        pidfilename = "/run/mandos.pid"
 
2511
        if not os.path.isdir("/run/."):
 
2512
            pidfilename = "/var/run/mandos.pid"
 
2513
        pidfile = None
 
2514
        try:
 
2515
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
 
2516
        except IOError as e:
 
2517
            logger.error("Could not open file %r", pidfilename,
 
2518
                         exc_info=e)
 
2519
    
 
2520
    for name in ("_mandos", "mandos", "nobody"):
 
2521
        try:
 
2522
            uid = pwd.getpwnam(name).pw_uid
 
2523
            gid = pwd.getpwnam(name).pw_gid
 
2524
            break
 
2525
        except KeyError:
 
2526
            continue
 
2527
    else:
 
2528
        uid = 65534
 
2529
        gid = 65534
 
2530
    try:
 
2531
        os.setgid(gid)
 
2532
        os.setuid(uid)
 
2533
    except OSError as error:
 
2534
        if error.errno != errno.EPERM:
 
2535
            raise
 
2536
    
 
2537
    if debug:
 
2538
        # Enable all possible GnuTLS debugging
 
2539
        
 
2540
        # "Use a log level over 10 to enable all debugging options."
 
2541
        # - GnuTLS manual
 
2542
        gnutls.library.functions.gnutls_global_set_log_level(11)
 
2543
        
 
2544
        @gnutls.library.types.gnutls_log_func
 
2545
        def debug_gnutls(level, string):
 
2546
            logger.debug("GnuTLS: %s", string[:-1])
 
2547
        
 
2548
        gnutls.library.functions.gnutls_global_set_log_function(
 
2549
            debug_gnutls)
 
2550
        
 
2551
        # Redirect stdin so all checkers get /dev/null
 
2552
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
2553
        os.dup2(null, sys.stdin.fileno())
 
2554
        if null > 2:
 
2555
            os.close(null)
 
2556
    
 
2557
    # Need to fork before connecting to D-Bus
 
2558
    if not foreground:
 
2559
        # Close all input and output, do double fork, etc.
 
2560
        daemon()
 
2561
    
 
2562
    # multiprocessing will use threads, so before we use gobject we
 
2563
    # need to inform gobject that threads will be used.
 
2564
    gobject.threads_init()
763
2565
    
764
2566
    global main_loop
765
 
    global bus
766
 
    global server
767
2567
    # From the Avahi example code
768
 
    DBusGMainLoop(set_as_default=True )
 
2568
    DBusGMainLoop(set_as_default=True)
769
2569
    main_loop = gobject.MainLoop()
770
2570
    bus = dbus.SystemBus()
771
 
    server = dbus.Interface(
772
 
            bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
773
 
            avahi.DBUS_INTERFACE_SERVER )
774
2571
    # End of Avahi example code
775
 
    
776
 
    clients = Set()
777
 
    def remove_from_clients(client):
778
 
        clients.remove(client)
779
 
        if not clients:
780
 
            logger.critical(u"No clients left, exiting")
781
 
            sys.exit()
782
 
    
783
 
    clients.update(Set(Client(name = section,
784
 
                              stop_hook = remove_from_clients,
785
 
                              config
786
 
                              = dict(client_config.items(section)))
787
 
                       for section in client_config.sections()))
788
 
    if not clients:
789
 
        logger.critical(u"No clients defined")
790
 
        sys.exit(1)
791
 
    
792
 
    if debug:
793
 
        # Redirect stdin so all checkers get /dev/null
794
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
795
 
        os.dup2(null, sys.stdin.fileno())
796
 
        if null > 2:
797
 
            os.close(null)
798
 
    else:
799
 
        # No console logging
800
 
        logger.removeHandler(console)
801
 
        # Close all input and output, do double fork, etc.
802
 
        daemon()
803
 
    
804
 
    pidfilename = "/var/run/mandos/mandos.pid"
805
 
    pid = os.getpid()
806
 
    try:
807
 
        pidfile = open(pidfilename, "w")
808
 
        pidfile.write(str(pid) + "\n")
809
 
        pidfile.close()
 
2572
    if use_dbus:
 
2573
        try:
 
2574
            bus_name = dbus.service.BusName("se.recompile.Mandos",
 
2575
                                            bus,
 
2576
                                            do_not_queue=True)
 
2577
            old_bus_name = dbus.service.BusName(
 
2578
                "se.bsnet.fukt.Mandos", bus,
 
2579
                do_not_queue=True)
 
2580
        except dbus.exceptions.DBusException as e:
 
2581
            logger.error("Disabling D-Bus:", exc_info=e)
 
2582
            use_dbus = False
 
2583
            server_settings["use_dbus"] = False
 
2584
            tcp_server.use_dbus = False
 
2585
    if zeroconf:
 
2586
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
2587
        service = AvahiServiceToSyslog(
 
2588
            name = server_settings["servicename"],
 
2589
            servicetype = "_mandos._tcp",
 
2590
            protocol = protocol,
 
2591
            bus = bus)
 
2592
        if server_settings["interface"]:
 
2593
            service.interface = if_nametoindex(
 
2594
                server_settings["interface"].encode("utf-8"))
 
2595
    
 
2596
    global multiprocessing_manager
 
2597
    multiprocessing_manager = multiprocessing.Manager()
 
2598
    
 
2599
    client_class = Client
 
2600
    if use_dbus:
 
2601
        client_class = functools.partial(ClientDBus, bus = bus)
 
2602
    
 
2603
    client_settings = Client.config_parser(client_config)
 
2604
    old_client_settings = {}
 
2605
    clients_data = {}
 
2606
    
 
2607
    # This is used to redirect stdout and stderr for checker processes
 
2608
    global wnull
 
2609
    wnull = open(os.devnull, "w") # A writable /dev/null
 
2610
    # Only used if server is running in foreground but not in debug
 
2611
    # mode
 
2612
    if debug or not foreground:
 
2613
        wnull.close()
 
2614
    
 
2615
    # Get client data and settings from last running state.
 
2616
    if server_settings["restore"]:
 
2617
        try:
 
2618
            with open(stored_state_path, "rb") as stored_state:
 
2619
                clients_data, old_client_settings = pickle.load(
 
2620
                    stored_state)
 
2621
            os.remove(stored_state_path)
 
2622
        except IOError as e:
 
2623
            if e.errno == errno.ENOENT:
 
2624
                logger.warning("Could not load persistent state:"
 
2625
                               " {}".format(os.strerror(e.errno)))
 
2626
            else:
 
2627
                logger.critical("Could not load persistent state:",
 
2628
                                exc_info=e)
 
2629
                raise
 
2630
        except EOFError as e:
 
2631
            logger.warning("Could not load persistent state: "
 
2632
                           "EOFError:",
 
2633
                           exc_info=e)
 
2634
    
 
2635
    with PGPEngine() as pgp:
 
2636
        for client_name, client in clients_data.items():
 
2637
            # Skip removed clients
 
2638
            if client_name not in client_settings:
 
2639
                continue
 
2640
            
 
2641
            # Decide which value to use after restoring saved state.
 
2642
            # We have three different values: Old config file,
 
2643
            # new config file, and saved state.
 
2644
            # New config value takes precedence if it differs from old
 
2645
            # config value, otherwise use saved state.
 
2646
            for name, value in client_settings[client_name].items():
 
2647
                try:
 
2648
                    # For each value in new config, check if it
 
2649
                    # differs from the old config value (Except for
 
2650
                    # the "secret" attribute)
 
2651
                    if (name != "secret"
 
2652
                        and (value !=
 
2653
                             old_client_settings[client_name][name])):
 
2654
                        client[name] = value
 
2655
                except KeyError:
 
2656
                    pass
 
2657
            
 
2658
            # Clients who has passed its expire date can still be
 
2659
            # enabled if its last checker was successful.  Clients
 
2660
            # whose checker succeeded before we stored its state is
 
2661
            # assumed to have successfully run all checkers during
 
2662
            # downtime.
 
2663
            if client["enabled"]:
 
2664
                if datetime.datetime.utcnow() >= client["expires"]:
 
2665
                    if not client["last_checked_ok"]:
 
2666
                        logger.warning(
 
2667
                            "disabling client {} - Client never "
 
2668
                            "performed a successful checker".format(
 
2669
                                client_name))
 
2670
                        client["enabled"] = False
 
2671
                    elif client["last_checker_status"] != 0:
 
2672
                        logger.warning(
 
2673
                            "disabling client {} - Client last"
 
2674
                            " checker failed with error code"
 
2675
                            " {}".format(
 
2676
                                client_name,
 
2677
                                client["last_checker_status"]))
 
2678
                        client["enabled"] = False
 
2679
                    else:
 
2680
                        client["expires"] = (
 
2681
                            datetime.datetime.utcnow()
 
2682
                            + client["timeout"])
 
2683
                        logger.debug("Last checker succeeded,"
 
2684
                                     " keeping {} enabled".format(
 
2685
                                         client_name))
 
2686
            try:
 
2687
                client["secret"] = pgp.decrypt(
 
2688
                    client["encrypted_secret"],
 
2689
                    client_settings[client_name]["secret"])
 
2690
            except PGPError:
 
2691
                # If decryption fails, we use secret from new settings
 
2692
                logger.debug("Failed to decrypt {} old secret".format(
 
2693
                    client_name))
 
2694
                client["secret"] = (client_settings[client_name]
 
2695
                                    ["secret"])
 
2696
    
 
2697
    # Add/remove clients based on new changes made to config
 
2698
    for client_name in (set(old_client_settings)
 
2699
                        - set(client_settings)):
 
2700
        del clients_data[client_name]
 
2701
    for client_name in (set(client_settings)
 
2702
                        - set(old_client_settings)):
 
2703
        clients_data[client_name] = client_settings[client_name]
 
2704
    
 
2705
    # Create all client objects
 
2706
    for client_name, client in clients_data.items():
 
2707
        tcp_server.clients[client_name] = client_class(
 
2708
            name = client_name,
 
2709
            settings = client,
 
2710
            server_settings = server_settings)
 
2711
    
 
2712
    if not tcp_server.clients:
 
2713
        logger.warning("No clients defined")
 
2714
    
 
2715
    if not foreground:
 
2716
        if pidfile is not None:
 
2717
            pid = os.getpid()
 
2718
            try:
 
2719
                with pidfile:
 
2720
                    print(pid, file=pidfile)
 
2721
            except IOError:
 
2722
                logger.error("Could not write to file %r with PID %d",
 
2723
                             pidfilename, pid)
810
2724
        del pidfile
811
 
    except IOError, err:
812
 
        logger.error(u"Could not write %s file with PID %d",
813
 
                     pidfilename, os.getpid())
 
2725
        del pidfilename
 
2726
    
 
2727
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
 
2728
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
 
2729
    
 
2730
    if use_dbus:
 
2731
        
 
2732
        @alternate_dbus_interfaces(
 
2733
            { "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
 
2734
        class MandosDBusService(DBusObjectWithProperties):
 
2735
            """A D-Bus proxy object"""
 
2736
            
 
2737
            def __init__(self):
 
2738
                dbus.service.Object.__init__(self, bus, "/")
 
2739
            
 
2740
            _interface = "se.recompile.Mandos"
 
2741
            
 
2742
            @dbus_interface_annotations(_interface)
 
2743
            def _foo(self):
 
2744
                return {
 
2745
                    "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
2746
                    "false" }
 
2747
            
 
2748
            @dbus.service.signal(_interface, signature="o")
 
2749
            def ClientAdded(self, objpath):
 
2750
                "D-Bus signal"
 
2751
                pass
 
2752
            
 
2753
            @dbus.service.signal(_interface, signature="ss")
 
2754
            def ClientNotFound(self, fingerprint, address):
 
2755
                "D-Bus signal"
 
2756
                pass
 
2757
            
 
2758
            @dbus.service.signal(_interface, signature="os")
 
2759
            def ClientRemoved(self, objpath, name):
 
2760
                "D-Bus signal"
 
2761
                pass
 
2762
            
 
2763
            @dbus.service.method(_interface, out_signature="ao")
 
2764
            def GetAllClients(self):
 
2765
                "D-Bus method"
 
2766
                return dbus.Array(c.dbus_object_path for c in
 
2767
                                  tcp_server.clients.itervalues())
 
2768
            
 
2769
            @dbus.service.method(_interface,
 
2770
                                 out_signature="a{oa{sv}}")
 
2771
            def GetAllClientsWithProperties(self):
 
2772
                "D-Bus method"
 
2773
                return dbus.Dictionary(
 
2774
                    { c.dbus_object_path: c.GetAll("")
 
2775
                      for c in tcp_server.clients.itervalues() },
 
2776
                    signature="oa{sv}")
 
2777
            
 
2778
            @dbus.service.method(_interface, in_signature="o")
 
2779
            def RemoveClient(self, object_path):
 
2780
                "D-Bus method"
 
2781
                for c in tcp_server.clients.itervalues():
 
2782
                    if c.dbus_object_path == object_path:
 
2783
                        del tcp_server.clients[c.name]
 
2784
                        c.remove_from_connection()
 
2785
                        # Don't signal anything except ClientRemoved
 
2786
                        c.disable(quiet=True)
 
2787
                        # Emit D-Bus signal
 
2788
                        self.ClientRemoved(object_path, c.name)
 
2789
                        return
 
2790
                raise KeyError(object_path)
 
2791
            
 
2792
            del _interface
 
2793
        
 
2794
        mandos_dbus_service = MandosDBusService()
814
2795
    
815
2796
    def cleanup():
816
2797
        "Cleanup function; run on exit"
817
 
        global group
818
 
        # From the Avahi example code
819
 
        if not group is None:
820
 
            group.Free()
821
 
            group = None
822
 
        # End of Avahi example code
823
 
        
824
 
        while clients:
825
 
            client = clients.pop()
826
 
            client.stop_hook = None
827
 
            client.stop()
 
2798
        if zeroconf:
 
2799
            service.cleanup()
 
2800
        
 
2801
        multiprocessing.active_children()
 
2802
        wnull.close()
 
2803
        if not (tcp_server.clients or client_settings):
 
2804
            return
 
2805
        
 
2806
        # Store client before exiting. Secrets are encrypted with key
 
2807
        # based on what config file has. If config file is
 
2808
        # removed/edited, old secret will thus be unrecovable.
 
2809
        clients = {}
 
2810
        with PGPEngine() as pgp:
 
2811
            for client in tcp_server.clients.itervalues():
 
2812
                key = client_settings[client.name]["secret"]
 
2813
                client.encrypted_secret = pgp.encrypt(client.secret,
 
2814
                                                      key)
 
2815
                client_dict = {}
 
2816
                
 
2817
                # A list of attributes that can not be pickled
 
2818
                # + secret.
 
2819
                exclude = { "bus", "changedstate", "secret",
 
2820
                            "checker", "server_settings" }
 
2821
                for name, typ in inspect.getmembers(dbus.service
 
2822
                                                    .Object):
 
2823
                    exclude.add(name)
 
2824
                
 
2825
                client_dict["encrypted_secret"] = (client
 
2826
                                                   .encrypted_secret)
 
2827
                for attr in client.client_structure:
 
2828
                    if attr not in exclude:
 
2829
                        client_dict[attr] = getattr(client, attr)
 
2830
                
 
2831
                clients[client.name] = client_dict
 
2832
                del client_settings[client.name]["secret"]
 
2833
        
 
2834
        try:
 
2835
            with tempfile.NamedTemporaryFile(
 
2836
                    mode='wb',
 
2837
                    suffix=".pickle",
 
2838
                    prefix='clients-',
 
2839
                    dir=os.path.dirname(stored_state_path),
 
2840
                    delete=False) as stored_state:
 
2841
                pickle.dump((clients, client_settings), stored_state)
 
2842
                tempname = stored_state.name
 
2843
            os.rename(tempname, stored_state_path)
 
2844
        except (IOError, OSError) as e:
 
2845
            if not debug:
 
2846
                try:
 
2847
                    os.remove(tempname)
 
2848
                except NameError:
 
2849
                    pass
 
2850
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
 
2851
                logger.warning("Could not save persistent state: {}"
 
2852
                               .format(os.strerror(e.errno)))
 
2853
            else:
 
2854
                logger.warning("Could not save persistent state:",
 
2855
                               exc_info=e)
 
2856
                raise
 
2857
        
 
2858
        # Delete all clients, and settings from config
 
2859
        while tcp_server.clients:
 
2860
            name, client = tcp_server.clients.popitem()
 
2861
            if use_dbus:
 
2862
                client.remove_from_connection()
 
2863
            # Don't signal anything except ClientRemoved
 
2864
            client.disable(quiet=True)
 
2865
            if use_dbus:
 
2866
                # Emit D-Bus signal
 
2867
                mandos_dbus_service.ClientRemoved(
 
2868
                    client.dbus_object_path, client.name)
 
2869
        client_settings.clear()
828
2870
    
829
2871
    atexit.register(cleanup)
830
2872
    
831
 
    if not debug:
832
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
833
 
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
834
 
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
835
 
    
836
 
    for client in clients:
837
 
        client.start()
838
 
    
839
 
    tcp_server = IPv6_TCPServer((server_settings["address"],
840
 
                                 server_settings["port"]),
841
 
                                tcp_handler,
842
 
                                settings=server_settings,
843
 
                                clients=clients)
 
2873
    for client in tcp_server.clients.itervalues():
 
2874
        if use_dbus:
 
2875
            # Emit D-Bus signal
 
2876
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
 
2877
        # Need to initiate checking of clients
 
2878
        if client.enabled:
 
2879
            client.init_checker()
 
2880
    
 
2881
    tcp_server.enable()
 
2882
    tcp_server.server_activate()
 
2883
    
844
2884
    # Find out what port we got
845
 
    service.port = tcp_server.socket.getsockname()[1]
846
 
    logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
847
 
                u" scope_id %d" % tcp_server.socket.getsockname())
 
2885
    if zeroconf:
 
2886
        service.port = tcp_server.socket.getsockname()[1]
 
2887
    if use_ipv6:
 
2888
        logger.info("Now listening on address %r, port %d,"
 
2889
                    " flowinfo %d, scope_id %d",
 
2890
                    *tcp_server.socket.getsockname())
 
2891
    else:                       # IPv4
 
2892
        logger.info("Now listening on address %r, port %d",
 
2893
                    *tcp_server.socket.getsockname())
848
2894
    
849
2895
    #service.interface = tcp_server.socket.getsockname()[3]
850
2896
    
851
2897
    try:
852
 
        # From the Avahi example code
853
 
        server.connect_to_signal("StateChanged", server_state_changed)
854
 
        try:
855
 
            server_state_changed(server.GetState())
856
 
        except dbus.exceptions.DBusException, error:
857
 
            logger.critical(u"DBusException: %s", error)
858
 
            sys.exit(1)
859
 
        # End of Avahi example code
 
2898
        if zeroconf:
 
2899
            # From the Avahi example code
 
2900
            try:
 
2901
                service.activate()
 
2902
            except dbus.exceptions.DBusException as error:
 
2903
                logger.critical("D-Bus Exception", exc_info=error)
 
2904
                cleanup()
 
2905
                sys.exit(1)
 
2906
            # End of Avahi example code
860
2907
        
861
2908
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
862
2909
                             lambda *args, **kwargs:
863
 
                             tcp_server.handle_request\
864
 
                             (*args[2:], **kwargs) or True)
 
2910
                             (tcp_server.handle_request
 
2911
                              (*args[2:], **kwargs) or True))
865
2912
        
866
 
        logger.debug(u"Starting main loop")
867
 
        main_loop_started = True
 
2913
        logger.debug("Starting main loop")
868
2914
        main_loop.run()
869
 
    except AvahiError, error:
870
 
        logger.critical(u"AvahiError: %s" + unicode(error))
 
2915
    except AvahiError as error:
 
2916
        logger.critical("Avahi Error", exc_info=error)
 
2917
        cleanup()
871
2918
        sys.exit(1)
872
2919
    except KeyboardInterrupt:
873
2920
        if debug:
874
 
            print
 
2921
            print("", file=sys.stderr)
 
2922
        logger.debug("Server received KeyboardInterrupt")
 
2923
    logger.debug("Server exiting")
 
2924
    # Must run before the D-Bus bus name gets deregistered
 
2925
    cleanup()
 
2926
 
875
2927
 
876
2928
if __name__ == '__main__':
877
2929
    main()