/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2019-06-20 18:54:10 UTC
  • Revision ID: teddy@recompile.se-20190620185410-pwi5fyzzz0bd9s2x
Doc fix: Use new style interface names instead of "eth0"

* debian/mandos-client.README.Debian: Also use "enp1s0" as an example
                                      interface name.
* mandos.conf.xml (EXAMPLE): Change "interface" to "enp1s0", and
                             update priority string to new default.

Show diffs side-by-side

added added

removed removed

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