/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2016-07-10 03:43:48 UTC
  • Revision ID: teddy@recompile.se-20160710034348-5qc50yeyyn7peirm
Update RFC references to their modern equivalents.

* plugins.d/mandos-client.xml (SEE ALSO): Replace RFC 4346 (TLS 1.1)
  with RFC 5246 (TLS 1.2), and replace RFC 5081 (TLS OpenPGP) with its
  replacement RFC 6091.

Show diffs side-by-side

added added

removed removed

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