/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2015-06-28 16:35:27 UTC
  • mto: This revision was merged to the branch mainline in revision 759.
  • Revision ID: teddy@recompile.se-20150628163527-cky0ec59zew7teua
Add a plugin helper directory, available to all plugins.

* Makefile (PLUGIN_HELPERS): New; list of plugin helpers.
  (CPROGS): Appended "$(PLUGIN_HELPERS)".
* initramfs-tools-hook: Create new plugin helper directory, and copy
                        plugin helpers provided by the system and/or
                        by the local administrator.
  (PLUGINHELPERDIR): New.
* plugin-runner.c: Take new --plugin-helper-dir option and provide
                   environment variable to all plugins.
  (PHDIR): New; set to "/lib/mandos/plugin-helpers".
  (main/pluginhelperdir): New.
  (main/options): New option "--plugin-helper-dir".
  (main/parse_opt, main/parse_opt_config_file): Accept new option.
  (main): Use new option to set MANDOSPLUGINHELPERDIR environment
          variable as if using --global-env MANDOSPLUGINHELPERDIR=...
* plugin-runner.xml: Document new --plugin-helper-dir option.
  (SYNOPSIS, OPTIONS): Add "--plugin-helper-dir" option.
  (PLUGINS/WRITING PLUGINS): Document new environment variable
                             available to plugins.
  (ENVIRONMENT): Document new environment variable
                 "MANDOSPLUGINHELPERDIR" affected by the new
                 --plugin-helper-dir option.

Show diffs side-by-side

added added

removed removed

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