/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2019-07-30 18:44:31 UTC
  • mto: This revision was merged to the branch mainline in revision 1134.
  • Revision ID: teddy@recompile.se-20190730184431-nqlgghaw2aqe6if6
Tags: version-1.8.5-1
* Makefile (version): Change to 1.8.5.
* NEWS (Version 1.8.5): Add new entry.
* debian/changelog (1.8.5-1): - '' -

Show diffs side-by-side

added added

removed removed

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