/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2019-08-05 14:31:51 UTC
  • Revision ID: teddy@recompile.se-20190805143151-lt5d97wqif3t8250
Client: Debian package fix: Make uninstall when using dracut(8) work

Use the same logic to rebuild the initramfs image when uninstalling as
when installing the package.

* debian/mandos-client.postrm (update_initramfs): Use the same logic
  as the update_initramfs function in debian/mandos-client.postinst.

Show diffs side-by-side

added added

removed removed

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