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