/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2019-08-04 12:39:39 UTC
  • mto: This revision was merged to the branch mainline in revision 388.
  • Revision ID: teddy@recompile.se-20190804123939-vadn3y4ia18np40q
Add Debian DEP 12 upstream metadata file

See DEP 12: https://dep-team.pages.debian.net/deps/dep12/

* debian/upstream/metadata: New.

Show diffs side-by-side

added added

removed removed

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