/mandos/trunk

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

« back to all changes in this revision

Viewing changes to server.py

  • Committer: Teddy Hogeborn
  • Date: 2008-07-19 18:43:24 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080719184324-iwhoa5in75xa0u2u
* mandos-clients.conf ([foo]/dn, [foo]/password, [braxen_client]/dn,
                       [braxen_client]/password): Removed.
  ([foo]/fingerprint, [braxen_client]/fingerprint): New.
  ([foo]/checker): New.
  ([foo]/secfile): New.
  ([braxen_client]/secret): New.

* server.py: New "--debug" option to set debug flag.  Removed "cert",
             "key", "ca", "crl", and "cred" variables.  Added default
             value for "checker" config file setting.  Do not pass
             credentials to IPv6_TCPServer constructor.
  (debug): New global debug flag.  Used by most debugging output code.
  (Client.__init__): Keyword argument "dn" replaced by "fingerprint",
                     "password" renamed to "secret", and "passfile"
                     renamed to "secfile".  New keyword argument
                     "checker". All callers changed.
  (Client.dn): Removed.
  (Client.fingerprint): New.
  (Client.password): Renamed to "secret"; all users changed.
  (Client.passfile): Renamed to "secfile"; all users changed.
  (Client.timeout, Client.interval): Changed to be properties; now
                                     automatically updates the
                                     "_timeout_milliseconds" and
                                     "_interval_milliseconds" values.
  (Client.timeout_milliseconds): Renamed to "_timeout_milliseconds".
  (Client.interval_milliseconds): Renamed to "_interval_milliseconds".
  (Client.check_command): New.
  (Client.start_checker): Use the new "check_command" attribute.
  (peer_certificate, fingerprint): New functions.

  (tcp_handler.handle): Use ClientSession with empty credentials
                        object instead of ServerSession.  Set gnutls
                        priority string.  Do not verify peer.  Use
                        fingerprint instead of DN when searching for
                        clients.  Bug fix: Loop sending data so even large
                        secret data strings are sent.
  (IPv6_TCPServer.credentials): Removed.
  (if_nametoindex): Do not import ctypes since that is now imported
                    globally.

Show diffs side-by-side

added added

removed removed

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