/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2009-11-05 02:12:57 UTC
  • Revision ID: teddy@fukt.bsnet.se-20091105021257-l2b5nb1v4pc2tupw
* mandos (ClientDBus.disable): Bug fix: complete rename of "log" and
                               "signal" to "quiet".

Show diffs side-by-side

added added

removed removed

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