/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-02 16:45:38 UTC
  • Revision ID: teddy@recompile.se-20160302164538-n9ocll4izthzw1ov
Ignore any error from initramfs-tools' "configure_networking".

* initramfs-tools-script: Wrap call to "configure_networking" with
  "set +e" and "set -e", since configure_networking was not designed
  to run in a "set -e" environment.

Closes: 816513
Thanks: Carlos Alberto Lopez Perez <clopez@igalia.com>
Thanks: Ben Hutchings <ben@decadent.org.uk>

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