/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2015-03-10 18:03:38 UTC
  • Revision ID: teddy@recompile.se-20150310180338-pcxw6r2qmw9k6br9
Add ":!RSA" to GnuTLS priority string, to disallow non-DHE kx.

If Mandos was somehow made to use a non-ephemeral Diffie-Hellman key
exchange algorithm in the TLS handshake, any saved network traffic
could then be decrypted later if the Mandos client key was obtained.
By default, Mandos uses ephemeral DH key exchanges which does not have
this problem, but a non-ephemeral key exchange algorithm was still
enabled by default.  The simplest solution is to simply turn that off,
which ensures that Mandos will always use ephemeral DH key exchanges.

There is a "PFS" priority string specifier, but we can't use it because:

1. Security-wise, it is a mix between "NORMAL" and "SECURE128" - it
   enables a lot more algorithms than "SECURE256".

2. It is only available since GnuTLS 3.2.4.

Thanks to Andreas Fischer <af@bantuX.org> for reporting this issue.

Show diffs side-by-side

added added

removed removed

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