/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2023-02-11 06:58:15 UTC
  • Revision ID: teddy@recompile.se-20230211065815-jtffi61tbdrgr875
Suppress warnings

Suppress warnings about mlock()ing uninitialized memory and reading an
ievent struct.

* dracut-module/password-agent.c (send_password_to_socket): Suppress
  "-Wmaybe-uninitialized" when mlock()ing password send buffer.
  (test_read_inotify_event_IN_DELETE_badname): When reading from
    a struct ievent, suppress "-Wstringop-overread".

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