/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: 2016-03-04 20:50:45 UTC
  • Revision ID: teddy@recompile.se-20160304205045-jksfb2qzv9erkf21
Only use -fsanitize=... options if they work.

* Makefile (ALL_SANITIZE_OPTIONS): New.
  (SANITIZE): Loop through all known sanitizing options and only use
              those which do not give an error.

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