/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: 2021-03-21 19:51:15 UTC
  • Revision ID: teddy@recompile.se-20210321195115-qe6g0fyj1kabwlav
Fix theoretical GnuTLS bug

Fix "NameError: global name '_error_code' is not defined" error if
GNUTLS_E_INTERRUPTED or GNUTLS_E_AGAIN was ever returned from
gnutls_record_send().

* mandos (gnutls._retry_on_error): Import "_error_code" from outer
  class scope to local function scope via a keyword argument.

Show diffs side-by-side

added added

removed removed

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