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