/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 20:23:15 UTC
  • Revision ID: teddy@recompile.se-20160312202315-hu7b87ivetlxqbw3
Server: Fix minor thing with Python 3 compatibility

Fix another small thing with unpickling string values.

* mandos (main): When restoring pickled client data, only decode byte
                 string for "host" key if it really is a byte string.

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