/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: 2018-02-06 20:03:50 UTC
  • Revision ID: teddy@recompile.se-20180206200350-jzvorueb731xkph3
Update Debian Debhelper compatibility version.

* (debian/compat): Change to "10".

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