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