/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: teddy at recompile
  • Date: 2020-02-07 20:53:34 UTC
  • mto: This revision was merged to the branch mainline in revision 396.
  • Revision ID: teddy@recompile.se-20200207205334-dp41p8c8vw0ytik5
Allow users to more easily alter mandos.service

The sysvinit script uses /etc/default/mandos as an environment file,
and supports adding additional server options to a DAEMON_ARGS
environment variable.  This should be supported by the systemd
service, too.

* mandos.service ([Service]/EnvironmentFile): New; set to
  "/etc/default/mandos ".
  ([Service]/ExecStart): Append "$DAEMON_ARGS".

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