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