/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: 2022-04-25 18:28:52 UTC
  • Revision ID: teddy@recompile.se-20220425182852-5y9a2b9oy9rm1ipf
From: Camaleón <noelamac@gmail.com>

Add Spanish debconf translation

* debian/po/es.po: New

Acked-by: Teddy Hogeborn <teddy@recompile.se>

Show diffs side-by-side

added added

removed removed

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