/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-19 03:48:56 UTC
  • Revision ID: teddy@recompile.se-20160319034856-d8rox0kdxekgr03g
Server: Make persistent state directory mode u=rwx,go=

The Makefile target "install-server" creates the server persistent
state directory /var/lib/mandos as mode u=rwx,go= (0700).  Make this
also the case for the Debian package (unless overridden by
dpkg-statoverride).

* debian/mandos.postinst (configure): Fix state directory permissions,
  but only if not listed by "dpkg-statoverride".

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