/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2019-03-31 04:47:26 UTC
  • mto: This revision was merged to the branch mainline in revision 382.
  • Revision ID: teddy@recompile.se-20190331044726-po11kmjmug07mw00
mandos-ctl: Remove import of unused module

* mandos-ctl: Remove "import abc".

Show diffs side-by-side

added added

removed removed

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