/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2016-06-21 19:49:01 UTC
  • mto: This revision was merged to the branch mainline in revision 855.
  • Revision ID: teddy@recompile.se-20160621194901-sd4jpyv08sxghdwi
Tags: version-1.7.8-1
* Makefile (version): Change to 1.7.8.
* NEWS (Version 1.7.8): Add new entry.
* debian/changelog (1.7.8-1): - '' -

Show diffs side-by-side

added added

removed removed

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