/mandos/trunk

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