/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2015-05-30 16:47:00 UTC
  • Revision ID: teddy@recompile.se-20150530164700-77zrd7964gdhbk1f
mandos: Disable D-Bus if any DBusException is raised when connecting.

Show diffs side-by-side

added added

removed removed

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