/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2016-03-12 23:42:38 UTC
  • Revision ID: teddy@recompile.se-20160312234238-xdszntu18cfwife9
Server: Use python-gi instead of old python-gobject

The python-gobject module is old, deprecated, and replaced with the
python-gi (GObject Introspection) module; use that instead.

* debian/control (Source: mandos/Build-Depends-Indep): Change
  "python-gi | python-gobject" to "python-gi".
* mandos: Import "GLib" instead of "GObject"; change all users.
* mandos-monitor: - '' -

Show diffs side-by-side

added added

removed removed

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