/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: teddy at recompile
  • Date: 2020-07-04 11:58:52 UTC
  • Revision ID: teddy@recompile.se-20200704115852-oquhnmng3zom4ldl
Update copyright year

* DBUS-API: Update copyright year to 2020
* debian/copyright: - '' -
* dracut-module/ask-password-mandos.service: - '' -
* dracut-module/password-agent.c: - '' -
* mandos: - '' -
* mandos-ctl: - '' -
* plugin-runner.c: - '' -
* plugins.d/mandos-client.c: - '' -
* plugins.d/plymouth.c: - '' -
* mandos-to-cryptroot-unlock: Update copyright year to 2019.

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