/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 at recompile
  • Date: 2020-11-29 21:54:00 UTC
  • Revision ID: teddy@recompile.se-20201129215400-1zkzmiadisa8whx2
Change URL of systemd "Password Agents" specification

The URL of the systemd "Password Agents" specification changed from
<https://www.freedesktop.org/wiki/Software/systemd/PasswordAgents> to
<https://systemd.io/PASSWORD_AGENTS/>.

* dracut-module/password-agent.c: Change URL in code comments.
* dracut-module/password-agent.xml: Change URL.
* intro.xml (SYSTEMD): - '' -

Show diffs side-by-side

added added

removed removed

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