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 423
- compare with another revision
- download diff
- download tarball
- view history from revision 423
- Committer: Teddy Hogeborn
- Date: 2010-09-12 03:00:40 UTC
- Revision ID: teddy@fukt.bsnet.se-20100912030040-b0uopyennste9fdh
Documentation changes:
* DBUS-API: New file documenting the server D-Bus interface.
* clients.conf: Add examples of new approval settings.
* debian/mandos.docs: Added "DBUS-API".
* mandos-clients.conf.xml (OPTIONS): Added "approved_by_default",
"approval_delay", and
"approval_duration".
* mandos.xml (D-BUS INTERFACE): Refer to the "DBUS-API" file.
(BUGS): Remove mention of lack of a remote query interface.
* DBUS-API: New file documenting the server D-Bus interface.
* clients.conf: Add examples of new approval settings.
* debian/mandos.docs: Added "DBUS-API".
* mandos-clients.conf.xml (OPTIONS): Added "approved_by_default",
"approval_delay", and
"approval_duration".
* mandos.xml (D-BUS INTERFACE): Refer to the "DBUS-API" file.
(BUGS): Remove mention of lack of a remote query interface.
- files removed:
- debian/source
- network-hooks.d
- files modified:
- .bzrignore
added
removed
mandos
11
11
# "AvahiService" class, and some lines in "main".
12
12
#
13
13
# Everything else is
14
# Copyright © 2008-2012 Teddy Hogeborn
15
# Copyright © 2008-2012 Björn Påhlsson
14
# Copyright © 2008,2009 Teddy Hogeborn
15
# Copyright © 2008,2009 Björn Påhlsson
16
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
28
28
# along with this program. If not, see
29
29
# <http://www.gnu.org/licenses/>.
30
30
#
31
# Contact the authors at <mandos@recompile.se>.
31
# Contact the authors at <mandos@fukt.bsnet.se>.
32
32
#
33
33
34
from __future__ import (division, absolute_import, print_function,
35
unicode_literals)
34
from __future__ import division, with_statement, absolute_import
36
35
37
36
import SocketServer as socketserver
38
37
import socket
39
import argparse
38
import optparse
40
39
import datetime
41
40
import errno
42
41
import gnutls.crypto
62
61
import functools
63
62
import cPickle as pickle
64
63
import multiprocessing
65
import types
66
import binascii
67
import tempfile
68
import itertools
69
64
70
65
import dbus
71
66
import dbus.service
76
71
import ctypes.util
77
72
import xml.dom.minidom
78
73
import inspect
79
import GnuPGInterface
80
74
81
75
try:
82
76
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
86
80
except ImportError:
87
81
SO_BINDTODEVICE = None
88
82
89
version = "1.5.3"
90
stored_state_file = "clients.pickle"
91
92
logger = logging.getLogger()
83
84
version = "1.0.14"
85
86
#logger = logging.getLogger(u'mandos')
87
logger = logging.Logger(u'mandos')
93
88
syslogger = (logging.handlers.SysLogHandler
94
89
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
95
address = str("/dev/log")))
96
97
try:
98
if_nametoindex = (ctypes.cdll.LoadLibrary
99
(ctypes.util.find_library("c"))
100
.if_nametoindex)
101
except (OSError, AttributeError):
102
def if_nametoindex(interface):
103
"Get an interface index the hard way, i.e. using fcntl()"
104
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
105
with contextlib.closing(socket.socket()) as s:
106
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
107
struct.pack(str("16s16x"),
108
interface))
109
interface_index = struct.unpack(str("I"),
110
ifreq[16:20])[0]
111
return interface_index
112
113
114
def initlogger(debug, level=logging.WARNING):
115
"""init logger and add loglevel"""
116
117
syslogger.setFormatter(logging.Formatter
118
('Mandos [%(process)d]: %(levelname)s:'
119
' %(message)s'))
120
logger.addHandler(syslogger)
121
122
if debug:
123
console = logging.StreamHandler()
124
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
125
' [%(process)d]:'
126
' %(levelname)s:'
127
' %(message)s'))
128
logger.addHandler(console)
129
logger.setLevel(level)
130
131
132
class PGPError(Exception):
133
"""Exception if encryption/decryption fails"""
134
pass
135
136
137
class PGPEngine(object):
138
"""A simple class for OpenPGP symmetric encryption & decryption"""
139
def __init__(self):
140
self.gnupg = GnuPGInterface.GnuPG()
141
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
142
self.gnupg = GnuPGInterface.GnuPG()
143
self.gnupg.options.meta_interactive = False
144
self.gnupg.options.homedir = self.tempdir
145
self.gnupg.options.extra_args.extend(['--force-mdc',
146
'--quiet',
147
'--no-use-agent'])
148
149
def __enter__(self):
150
return self
151
152
def __exit__ (self, exc_type, exc_value, traceback):
153
self._cleanup()
154
return False
155
156
def __del__(self):
157
self._cleanup()
158
159
def _cleanup(self):
160
if self.tempdir is not None:
161
# Delete contents of tempdir
162
for root, dirs, files in os.walk(self.tempdir,
163
topdown = False):
164
for filename in files:
165
os.remove(os.path.join(root, filename))
166
for dirname in dirs:
167
os.rmdir(os.path.join(root, dirname))
168
# Remove tempdir
169
os.rmdir(self.tempdir)
170
self.tempdir = None
171
172
def password_encode(self, password):
173
# Passphrase can not be empty and can not contain newlines or
174
# NUL bytes. So we prefix it and hex encode it.
175
return b"mandos" + binascii.hexlify(password)
176
177
def encrypt(self, data, password):
178
self.gnupg.passphrase = self.password_encode(password)
179
with open(os.devnull, "w") as devnull:
180
try:
181
proc = self.gnupg.run(['--symmetric'],
182
create_fhs=['stdin', 'stdout'],
183
attach_fhs={'stderr': devnull})
184
with contextlib.closing(proc.handles['stdin']) as f:
185
f.write(data)
186
with contextlib.closing(proc.handles['stdout']) as f:
187
ciphertext = f.read()
188
proc.wait()
189
except IOError as e:
190
raise PGPError(e)
191
self.gnupg.passphrase = None
192
return ciphertext
193
194
def decrypt(self, data, password):
195
self.gnupg.passphrase = self.password_encode(password)
196
with open(os.devnull, "w") as devnull:
197
try:
198
proc = self.gnupg.run(['--decrypt'],
199
create_fhs=['stdin', 'stdout'],
200
attach_fhs={'stderr': devnull})
201
with contextlib.closing(proc.handles['stdin']) as f:
202
f.write(data)
203
with contextlib.closing(proc.handles['stdout']) as f:
204
decrypted_plaintext = f.read()
205
proc.wait()
206
except IOError as e:
207
raise PGPError(e)
208
self.gnupg.passphrase = None
209
return decrypted_plaintext
210
90
address = "/dev/log"))
91
syslogger.setFormatter(logging.Formatter
92
(u'Mandos [%(process)d]: %(levelname)s:'
93
u' %(message)s'))
94
logger.addHandler(syslogger)
95
96
console = logging.StreamHandler()
97
console.setFormatter(logging.Formatter(u'%(name)s [%(process)d]:'
98
u' %(levelname)s:'
99
u' %(message)s'))
100
logger.addHandler(console)
211
101
212
102
class AvahiError(Exception):
213
103
def __init__(self, value, *args, **kwargs):
229
119
Attributes:
230
120
interface: integer; avahi.IF_UNSPEC or an interface index.
231
121
Used to optionally bind to the specified interface.
232
name: string; Example: 'Mandos'
233
type: string; Example: '_mandos._tcp'.
122
name: string; Example: u'Mandos'
123
type: string; Example: u'_mandos._tcp'.
234
124
See <http://www.dns-sd.org/ServiceTypes.html>
235
125
port: integer; what port to announce
236
126
TXT: list of strings; TXT record for the service
243
133
server: D-Bus Server
244
134
bus: dbus.SystemBus()
245
135
"""
246
247
136
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
248
137
servicetype = None, port = None, TXT = None,
249
domain = "", host = "", max_renames = 32768,
138
domain = u"", host = u"", max_renames = 32768,
250
139
protocol = avahi.PROTO_UNSPEC, bus = None):
251
140
self.interface = interface
252
141
self.name = name
261
150
self.group = None # our entry group
262
151
self.server = None
263
152
self.bus = bus
264
self.entry_group_state_changed_match = None
265
266
153
def rename(self):
267
154
"""Derived from the Avahi example code"""
268
155
if self.rename_count >= self.max_renames:
269
logger.critical("No suitable Zeroconf service name found"
270
" after %i retries, exiting.",
156
logger.critical(u"No suitable Zeroconf service name found"
157
u" after %i retries, exiting.",
271
158
self.rename_count)
272
raise AvahiServiceError("Too many renames")
273
self.name = unicode(self.server
274
.GetAlternativeServiceName(self.name))
275
logger.info("Changing Zeroconf service name to %r ...",
159
raise AvahiServiceError(u"Too many renames")
160
self.name = unicode(self.server.GetAlternativeServiceName(self.name))
161
logger.info(u"Changing Zeroconf service name to %r ...",
276
162
self.name)
163
syslogger.setFormatter(logging.Formatter
164
(u'Mandos (%s) [%%(process)d]:'
165
u' %%(levelname)s: %%(message)s'
166
% self.name))
277
167
self.remove()
278
168
try:
279
169
self.add()
280
except dbus.exceptions.DBusException as error:
281
logger.critical("D-Bus Exception", exc_info=error)
170
except dbus.exceptions.DBusException, error:
171
logger.critical(u"DBusException: %s", error)
282
172
self.cleanup()
283
173
os._exit(1)
284
174
self.rename_count += 1
285
286
175
def remove(self):
287
176
"""Derived from the Avahi example code"""
288
if self.entry_group_state_changed_match is not None:
289
self.entry_group_state_changed_match.remove()
290
self.entry_group_state_changed_match = None
291
177
if self.group is not None:
292
178
self.group.Reset()
293
294
179
def add(self):
295
180
"""Derived from the Avahi example code"""
296
self.remove()
297
181
if self.group is None:
298
182
self.group = dbus.Interface(
299
183
self.bus.get_object(avahi.DBUS_NAME,
300
184
self.server.EntryGroupNew()),
301
185
avahi.DBUS_INTERFACE_ENTRY_GROUP)
302
self.entry_group_state_changed_match = (
303
self.group.connect_to_signal(
304
'StateChanged', self.entry_group_state_changed))
305
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
186
self.group.connect_to_signal('StateChanged',
187
self
188
.entry_group_state_changed)
189
logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
306
190
self.name, self.type)
307
191
self.group.AddService(
308
192
self.interface,
313
197
dbus.UInt16(self.port),
314
198
avahi.string_array_to_txt_array(self.TXT))
315
199
self.group.Commit()
316
317
200
def entry_group_state_changed(self, state, error):
318
201
"""Derived from the Avahi example code"""
319
logger.debug("Avahi entry group state change: %i", state)
202
logger.debug(u"Avahi entry group state change: %i", state)
320
203
321
204
if state == avahi.ENTRY_GROUP_ESTABLISHED:
322
logger.debug("Zeroconf service established.")
205
logger.debug(u"Zeroconf service established.")
323
206
elif state == avahi.ENTRY_GROUP_COLLISION:
324
logger.info("Zeroconf service name collision.")
207
logger.warning(u"Zeroconf service name collision.")
325
208
self.rename()
326
209
elif state == avahi.ENTRY_GROUP_FAILURE:
327
logger.critical("Avahi: Error in group state changed %s",
210
logger.critical(u"Avahi: Error in group state changed %s",
328
211
unicode(error))
329
raise AvahiGroupError("State changed: {0!s}"
330
.format(error))
331
212
raise AvahiGroupError(u"State changed: %s"
213
% unicode(error))
332
214
def cleanup(self):
333
215
"""Derived from the Avahi example code"""
334
216
if self.group is not None:
335
try:
336
self.group.Free()
337
except (dbus.exceptions.UnknownMethodException,
338
dbus.exceptions.DBusException):
339
pass
217
self.group.Free()
340
218
self.group = None
341
self.remove()
342
343
def server_state_changed(self, state, error=None):
219
def server_state_changed(self, state):
344
220
"""Derived from the Avahi example code"""
345
logger.debug("Avahi server state change: %i", state)
346
bad_states = { avahi.SERVER_INVALID:
347
"Zeroconf server invalid",
348
avahi.SERVER_REGISTERING: None,
349
avahi.SERVER_COLLISION:
350
"Zeroconf server name collision",
351
avahi.SERVER_FAILURE:
352
"Zeroconf server failure" }
353
if state in bad_states:
354
if bad_states[state] is not None:
355
if error is None:
356
logger.error(bad_states[state])
357
else:
358
logger.error(bad_states[state] + ": %r", error)
359
self.cleanup()
221
logger.debug(u"Avahi server state change: %i", state)
222
if state == avahi.SERVER_COLLISION:
223
logger.error(u"Zeroconf server name collision")
224
self.remove()
360
225
elif state == avahi.SERVER_RUNNING:
361
226
self.add()
362
else:
363
if error is None:
364
logger.debug("Unknown state: %r", state)
365
else:
366
logger.debug("Unknown state: %r: %r", state, error)
367
368
227
def activate(self):
369
228
"""Derived from the Avahi example code"""
370
229
if self.server is None:
371
230
self.server = dbus.Interface(
372
231
self.bus.get_object(avahi.DBUS_NAME,
373
avahi.DBUS_PATH_SERVER,
374
follow_name_owner_changes=True),
232
avahi.DBUS_PATH_SERVER),
375
233
avahi.DBUS_INTERFACE_SERVER)
376
self.server.connect_to_signal("StateChanged",
234
self.server.connect_to_signal(u"StateChanged",
377
235
self.server_state_changed)
378
236
self.server_state_changed(self.server.GetState())
379
237
380
class AvahiServiceToSyslog(AvahiService):
381
def rename(self):
382
"""Add the new name to the syslog messages"""
383
ret = AvahiService.rename(self)
384
syslogger.setFormatter(logging.Formatter
385
('Mandos ({0}) [%(process)d]:'
386
' %(levelname)s: %(message)s'
387
.format(self.name)))
388
return ret
389
390
def timedelta_to_milliseconds(td):
391
"Convert a datetime.timedelta() to milliseconds"
392
return ((td.days * 24 * 60 * 60 * 1000)
393
+ (td.seconds * 1000)
394
+ (td.microseconds // 1000))
395
238
396
239
class Client(object):
397
240
"""A representation of a client host served by this server.
398
241
399
242
Attributes:
400
approved: bool(); 'None' if not yet approved/disapproved
401
approval_delay: datetime.timedelta(); Time to wait for approval
402
approval_duration: datetime.timedelta(); Duration of one approval
243
name: string; from the config file, used in log messages and
244
D-Bus identifiers
245
fingerprint: string (40 or 32 hexadecimal digits); used to
246
uniquely identify the client
247
secret: bytestring; sent verbatim (over TLS) to client
248
host: string; available for use by the checker command
249
created: datetime.datetime(); (UTC) object creation
250
last_enabled: datetime.datetime(); (UTC)
251
enabled: bool()
252
last_checked_ok: datetime.datetime(); (UTC) or None
253
timeout: datetime.timedelta(); How long from last_checked_ok
254
until this client is disabled
255
interval: datetime.timedelta(); How often to start a new checker
256
disable_hook: If set, called by disable() as disable_hook(self)
403
257
checker: subprocess.Popen(); a running checker process used
404
258
to see if the client lives.
405
259
'None' if no process is running.
406
checker_callback_tag: a gobject event source tag, or None
407
checker_command: string; External command which is run to check
408
if client lives. %() expansions are done at
260
checker_initiator_tag: a gobject event source tag, or None
261
disable_initiator_tag: - '' -
262
checker_callback_tag: - '' -
263
checker_command: string; External command which is run to check if
264
client lives. %() expansions are done at
409
265
runtime with vars(self) as dict, so that for
410
266
instance %(name)s can be used in the command.
411
checker_initiator_tag: a gobject event source tag, or None
412
created: datetime.datetime(); (UTC) object creation
413
client_structure: Object describing what attributes a client has
414
and is used for storing the client at exit
415
267
current_checker_command: string; current running checker_command
416
disable_initiator_tag: a gobject event source tag, or None
417
enabled: bool()
418
fingerprint: string (40 or 32 hexadecimal digits); used to
419
uniquely identify the client
420
host: string; available for use by the checker command
421
interval: datetime.timedelta(); How often to start a new checker
422
last_approval_request: datetime.datetime(); (UTC) or None
423
last_checked_ok: datetime.datetime(); (UTC) or None
424
last_checker_status: integer between 0 and 255 reflecting exit
425
status of last checker. -1 reflects crashed
426
checker, -2 means no checker completed yet.
427
last_enabled: datetime.datetime(); (UTC) or None
428
name: string; from the config file, used in log messages and
429
D-Bus identifiers
430
secret: bytestring; sent verbatim (over TLS) to client
431
timeout: datetime.timedelta(); How long from last_checked_ok
432
until this client is disabled
433
extended_timeout: extra long timeout when secret has been sent
434
runtime_expansions: Allowed attributes for runtime expansion.
435
expires: datetime.datetime(); time (UTC) when a client will be
436
disabled, or None
268
approval_delay: datetime.timedelta(); Time to wait for approval
269
_approved: bool(); 'None' if not yet approved/disapproved
270
approval_duration: datetime.timedelta(); Duration of one approval
437
271
"""
438
272
439
runtime_expansions = ("approval_delay", "approval_duration",
440
"created", "enabled", "fingerprint",
441
"host", "interval", "last_checked_ok",
442
"last_enabled", "name", "timeout")
443
client_defaults = { "timeout": "5m",
444
"extended_timeout": "15m",
445
"interval": "2m",
446
"checker": "fping -q -- %%(host)s",
447
"host": "",
448
"approval_delay": "0s",
449
"approval_duration": "1s",
450
"approved_by_default": "True",
451
"enabled": "True",
452
}
273
@staticmethod
274
def _timedelta_to_milliseconds(td):
275
"Convert a datetime.timedelta() to milliseconds"
276
return ((td.days * 24 * 60 * 60 * 1000)
277
+ (td.seconds * 1000)
278
+ (td.microseconds // 1000))
453
279
454
280
def timeout_milliseconds(self):
455
281
"Return the 'timeout' attribute in milliseconds"
456
return timedelta_to_milliseconds(self.timeout)
457
458
def extended_timeout_milliseconds(self):
459
"Return the 'extended_timeout' attribute in milliseconds"
460
return timedelta_to_milliseconds(self.extended_timeout)
282
return self._timedelta_to_milliseconds(self.timeout)
461
283
462
284
def interval_milliseconds(self):
463
285
"Return the 'interval' attribute in milliseconds"
464
return timedelta_to_milliseconds(self.interval)
465
286
return self._timedelta_to_milliseconds(self.interval)
287
466
288
def approval_delay_milliseconds(self):
467
return timedelta_to_milliseconds(self.approval_delay)
468
469
@staticmethod
470
def config_parser(config):
471
"""Construct a new dict of client settings of this form:
472
{ client_name: {setting_name: value, ...}, ...}
473
with exceptions for any special settings as defined above.
474
NOTE: Must be a pure function. Must return the same result
475
value given the same arguments.
476
"""
477
settings = {}
478
for client_name in config.sections():
479
section = dict(config.items(client_name))
480
client = settings[client_name] = {}
481
482
client["host"] = section["host"]
483
# Reformat values from string types to Python types
484
client["approved_by_default"] = config.getboolean(
485
client_name, "approved_by_default")
486
client["enabled"] = config.getboolean(client_name,
487
"enabled")
488
489
client["fingerprint"] = (section["fingerprint"].upper()
490
.replace(" ", ""))
491
if "secret" in section:
492
client["secret"] = section["secret"].decode("base64")
493
elif "secfile" in section:
494
with open(os.path.expanduser(os.path.expandvars
495
(section["secfile"])),
496
"rb") as secfile:
497
client["secret"] = secfile.read()
498
else:
499
raise TypeError("No secret or secfile for section {0}"
500
.format(section))
501
client["timeout"] = string_to_delta(section["timeout"])
502
client["extended_timeout"] = string_to_delta(
503
section["extended_timeout"])
504
client["interval"] = string_to_delta(section["interval"])
505
client["approval_delay"] = string_to_delta(
506
section["approval_delay"])
507
client["approval_duration"] = string_to_delta(
508
section["approval_duration"])
509
client["checker_command"] = section["checker"]
510
client["last_approval_request"] = None
511
client["last_checked_ok"] = None
512
client["last_checker_status"] = -2
513
514
return settings
515
516
def __init__(self, settings, name = None):
289
return self._timedelta_to_milliseconds(self.approval_delay)
290
291
def __init__(self, name = None, disable_hook=None, config=None):
292
"""Note: the 'checker' key in 'config' sets the
293
'checker_command' attribute and *not* the 'checker'
294
attribute."""
517
295
self.name = name
518
# adding all client settings
519
for setting, value in settings.iteritems():
520
setattr(self, setting, value)
521
522
if self.enabled:
523
if not hasattr(self, "last_enabled"):
524
self.last_enabled = datetime.datetime.utcnow()
525
if not hasattr(self, "expires"):
526
self.expires = (datetime.datetime.utcnow()
527
+ self.timeout)
528
else:
529
self.last_enabled = None
530
self.expires = None
531
532
logger.debug("Creating client %r", self.name)
296
if config is None:
297
config = {}
298
logger.debug(u"Creating client %r", self.name)
533
299
# Uppercase and remove spaces from fingerprint for later
534
300
# comparison purposes with return value from the fingerprint()
535
301
# function
536
logger.debug(" Fingerprint: %s", self.fingerprint)
537
self.created = settings.get("created",
538
datetime.datetime.utcnow())
539
540
# attributes specific for this server instance
302
self.fingerprint = (config[u"fingerprint"].upper()
303
.replace(u" ", u""))
304
logger.debug(u" Fingerprint: %s", self.fingerprint)
305
if u"secret" in config:
306
self.secret = config[u"secret"].decode(u"base64")
307
elif u"secfile" in config:
308
with open(os.path.expanduser(os.path.expandvars
309
(config[u"secfile"])),
310
"rb") as secfile:
311
self.secret = secfile.read()
312
else:
313
raise TypeError(u"No secret or secfile for client %s"
314
% self.name)
315
self.host = config.get(u"host", u"")
316
self.created = datetime.datetime.utcnow()
317
self.enabled = False
318
self.last_enabled = None
319
self.last_checked_ok = None
320
self.timeout = string_to_delta(config[u"timeout"])
321
self.interval = string_to_delta(config[u"interval"])
322
self.disable_hook = disable_hook
541
323
self.checker = None
542
324
self.checker_initiator_tag = None
543
325
self.disable_initiator_tag = None
544
326
self.checker_callback_tag = None
327
self.checker_command = config[u"checker"]
545
328
self.current_checker_command = None
546
self.approved = None
329
self.last_connect = None
330
self._approved = None
331
self.approved_by_default = config.get(u"approved_by_default",
332
True)
547
333
self.approvals_pending = 0
548
self.changedstate = (multiprocessing_manager
549
.Condition(multiprocessing_manager
550
.Lock()))
551
self.client_structure = [attr for attr in
552
self.__dict__.iterkeys()
553
if not attr.startswith("_")]
554
self.client_structure.append("client_structure")
555
556
for name, t in inspect.getmembers(type(self),
557
lambda obj:
558
isinstance(obj,
559
property)):
560
if not name.startswith("_"):
561
self.client_structure.append(name)
334
self.approval_delay = string_to_delta(
335
config[u"approval_delay"])
336
self.approval_duration = string_to_delta(
337
config[u"approval_duration"])
338
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
562
339
563
# Send notice to process children that client state has changed
564
340
def send_changedstate(self):
565
with self.changedstate:
566
self.changedstate.notify_all()
567
341
self.changedstate.acquire()
342
self.changedstate.notify_all()
343
self.changedstate.release()
344
568
345
def enable(self):
569
346
"""Start this client's checker and timeout hooks"""
570
if getattr(self, "enabled", False):
347
if getattr(self, u"enabled", False):
571
348
# Already enabled
572
349
return
573
350
self.send_changedstate()
574
self.expires = datetime.datetime.utcnow() + self.timeout
575
self.enabled = True
576
351
self.last_enabled = datetime.datetime.utcnow()
577
self.init_checker()
578
579
def disable(self, quiet=True):
580
"""Disable this client."""
581
if not getattr(self, "enabled", False):
582
return False
583
if not quiet:
584
self.send_changedstate()
585
if not quiet:
586
logger.info("Disabling client %s", self.name)
587
if getattr(self, "disable_initiator_tag", False):
588
gobject.source_remove(self.disable_initiator_tag)
589
self.disable_initiator_tag = None
590
self.expires = None
591
if getattr(self, "checker_initiator_tag", False):
592
gobject.source_remove(self.checker_initiator_tag)
593
self.checker_initiator_tag = None
594
self.stop_checker()
595
self.enabled = False
596
# Do not run this again if called by a gobject.timeout_add
597
return False
598
599
def __del__(self):
600
self.disable()
601
602
def init_checker(self):
603
352
# Schedule a new checker to be started an 'interval' from now,
604
353
# and every interval from then on.
605
354
self.checker_initiator_tag = (gobject.timeout_add
609
358
self.disable_initiator_tag = (gobject.timeout_add
610
359
(self.timeout_milliseconds(),
611
360
self.disable))
361
self.enabled = True
612
362
# Also start a new checker *right now*.
613
363
self.start_checker()
614
364
365
def disable(self, quiet=True):
366
"""Disable this client."""
367
if not getattr(self, "enabled", False):
368
return False
369
if not quiet:
370
self.send_changedstate()
371
if not quiet:
372
logger.info(u"Disabling client %s", self.name)
373
if getattr(self, u"disable_initiator_tag", False):
374
gobject.source_remove(self.disable_initiator_tag)
375
self.disable_initiator_tag = None
376
if getattr(self, u"checker_initiator_tag", False):
377
gobject.source_remove(self.checker_initiator_tag)
378
self.checker_initiator_tag = None
379
self.stop_checker()
380
if self.disable_hook:
381
self.disable_hook(self)
382
self.enabled = False
383
# Do not run this again if called by a gobject.timeout_add
384
return False
385
386
def __del__(self):
387
self.disable_hook = None
388
self.disable()
389
615
390
def checker_callback(self, pid, condition, command):
616
391
"""The checker has completed, so take appropriate actions."""
617
392
self.checker_callback_tag = None
618
393
self.checker = None
619
394
if os.WIFEXITED(condition):
620
self.last_checker_status = os.WEXITSTATUS(condition)
621
if self.last_checker_status == 0:
622
logger.info("Checker for %(name)s succeeded",
395
exitstatus = os.WEXITSTATUS(condition)
396
if exitstatus == 0:
397
logger.info(u"Checker for %(name)s succeeded",
623
398
vars(self))
624
399
self.checked_ok()
625
400
else:
626
logger.info("Checker for %(name)s failed",
401
logger.info(u"Checker for %(name)s failed",
627
402
vars(self))
628
403
else:
629
self.last_checker_status = -1
630
logger.warning("Checker for %(name)s crashed?",
404
logger.warning(u"Checker for %(name)s crashed?",
631
405
vars(self))
632
406
633
407
def checked_ok(self):
634
"""Assert that the client has been seen, alive and well."""
408
"""Bump up the timeout for this client.
409
410
This should only be called when the client has been seen,
411
alive and well.
412
"""
635
413
self.last_checked_ok = datetime.datetime.utcnow()
636
self.last_checker_status = 0
637
self.bump_timeout()
638
639
def bump_timeout(self, timeout=None):
640
"""Bump up the timeout for this client."""
641
if timeout is None:
642
timeout = self.timeout
643
if self.disable_initiator_tag is not None:
644
gobject.source_remove(self.disable_initiator_tag)
645
if getattr(self, "enabled", False):
646
self.disable_initiator_tag = (gobject.timeout_add
647
(timedelta_to_milliseconds
648
(timeout), self.disable))
649
self.expires = datetime.datetime.utcnow() + timeout
650
651
def need_approval(self):
652
self.last_approval_request = datetime.datetime.utcnow()
414
gobject.source_remove(self.disable_initiator_tag)
415
self.disable_initiator_tag = (gobject.timeout_add
416
(self.timeout_milliseconds(),
417
self.disable))
653
418
654
419
def start_checker(self):
655
420
"""Start a new checker subprocess if one is not running.
668
433
# If a checker exists, make sure it is not a zombie
669
434
try:
670
435
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
671
except (AttributeError, OSError) as error:
436
except (AttributeError, OSError), error:
672
437
if (isinstance(error, OSError)
673
438
and error.errno != errno.ECHILD):
674
439
raise error
675
440
else:
676
441
if pid:
677
logger.warning("Checker was a zombie")
442
logger.warning(u"Checker was a zombie")
678
443
gobject.source_remove(self.checker_callback_tag)
679
444
self.checker_callback(pid, status,
680
445
self.current_checker_command)
685
450
command = self.checker_command % self.host
686
451
except TypeError:
687
452
# Escape attributes for the shell
688
escaped_attrs = dict(
689
(attr,
690
re.escape(unicode(str(getattr(self, attr, "")),
691
errors=
692
'replace')))
693
for attr in
694
self.runtime_expansions)
695
453
escaped_attrs = dict((key,
454
re.escape(unicode(str(val),
455
errors=
456
u'replace')))
457
for key, val in
458
vars(self).iteritems())
696
459
try:
697
460
command = self.checker_command % escaped_attrs
698
except TypeError as error:
699
logger.error('Could not format string "%s"',
700
self.checker_command, exc_info=error)
461
except TypeError, error:
462
logger.error(u'Could not format string "%s":'
463
u' %s', self.checker_command, error)
701
464
return True # Try again later
702
465
self.current_checker_command = command
703
466
try:
704
logger.info("Starting checker %r for %s",
467
logger.info(u"Starting checker %r for %s",
705
468
command, self.name)
706
469
# We don't need to redirect stdout and stderr, since
707
470
# in normal mode, that is already done by daemon(),
709
472
# always replaced by /dev/null.)
710
473
self.checker = subprocess.Popen(command,
711
474
close_fds=True,
712
shell=True, cwd="/")
475
shell=True, cwd=u"/")
713
476
self.checker_callback_tag = (gobject.child_watch_add
714
477
(self.checker.pid,
715
478
self.checker_callback,
720
483
if pid:
721
484
gobject.source_remove(self.checker_callback_tag)
722
485
self.checker_callback(pid, status, command)
723
except OSError as error:
724
logger.error("Failed to start subprocess",
725
exc_info=error)
486
except OSError, error:
487
logger.error(u"Failed to start subprocess: %s",
488
error)
726
489
# Re-run this periodically if run by gobject.timeout_add
727
490
return True
728
491
731
494
if self.checker_callback_tag:
732
495
gobject.source_remove(self.checker_callback_tag)
733
496
self.checker_callback_tag = None
734
if getattr(self, "checker", None) is None:
497
if getattr(self, u"checker", None) is None:
735
498
return
736
logger.debug("Stopping checker for %(name)s", vars(self))
499
logger.debug(u"Stopping checker for %(name)s", vars(self))
737
500
try:
738
self.checker.terminate()
501
os.kill(self.checker.pid, signal.SIGTERM)
739
502
#time.sleep(0.5)
740
503
#if self.checker.poll() is None:
741
# self.checker.kill()
742
except OSError as error:
504
# os.kill(self.checker.pid, signal.SIGKILL)
505
except OSError, error:
743
506
if error.errno != errno.ESRCH: # No such process
744
507
raise
745
508
self.checker = None
746
509
747
748
def dbus_service_property(dbus_interface, signature="v",
749
access="readwrite", byte_arrays=False):
510
def dbus_service_property(dbus_interface, signature=u"v",
511
access=u"readwrite", byte_arrays=False):
750
512
"""Decorators for marking methods of a DBusObjectWithProperties to
751
513
become properties on the D-Bus.
752
514
759
521
"""
760
522
# Encoding deeply encoded byte arrays is not supported yet by the
761
523
# "Set" method, so we fail early here:
762
if byte_arrays and signature != "ay":
763
raise ValueError("Byte arrays not supported for non-'ay'"
764
" signature {0!r}".format(signature))
524
if byte_arrays and signature != u"ay":
525
raise ValueError(u"Byte arrays not supported for non-'ay'"
526
u" signature %r" % signature)
765
527
def decorator(func):
766
528
func._dbus_is_property = True
767
529
func._dbus_interface = dbus_interface
768
530
func._dbus_signature = signature
769
531
func._dbus_access = access
770
532
func._dbus_name = func.__name__
771
if func._dbus_name.endswith("_dbus_property"):
533
if func._dbus_name.endswith(u"_dbus_property"):
772
534
func._dbus_name = func._dbus_name[:-14]
773
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
774
return func
775
return decorator
776
777
778
def dbus_interface_annotations(dbus_interface):
779
"""Decorator for marking functions returning interface annotations
780
781
Usage:
782
783
@dbus_interface_annotations("org.example.Interface")
784
def _foo(self): # Function name does not matter
785
return {"org.freedesktop.DBus.Deprecated": "true",
786
"org.freedesktop.DBus.Property.EmitsChangedSignal":
787
"false"}
788
"""
789
def decorator(func):
790
func._dbus_is_interface = True
791
func._dbus_interface = dbus_interface
792
func._dbus_name = dbus_interface
793
return func
794
return decorator
795
796
797
def dbus_annotations(annotations):
798
"""Decorator to annotate D-Bus methods, signals or properties
799
Usage:
800
801
@dbus_service_property("org.example.Interface", signature="b",
802
access="r")
803
@dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
804
"org.freedesktop.DBus.Property."
805
"EmitsChangedSignal": "false"})
806
def Property_dbus_property(self):
807
return dbus.Boolean(False)
808
"""
809
def decorator(func):
810
func._dbus_annotations = annotations
535
func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
811
536
return func
812
537
return decorator
813
538
833
558
834
559
class DBusObjectWithProperties(dbus.service.Object):
835
560
"""A D-Bus object with properties.
836
561
837
562
Classes inheriting from this can use the dbus_service_property
838
563
decorator to expose methods as D-Bus properties. It exposes the
839
564
standard Get(), Set(), and GetAll() methods on the D-Bus.
840
565
"""
841
566
842
567
@staticmethod
843
def _is_dbus_thing(thing):
844
"""Returns a function testing if an attribute is a D-Bus thing
845
846
If called like _is_dbus_thing("method") it returns a function
847
suitable for use as predicate to inspect.getmembers().
848
"""
849
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
850
False)
568
def _is_dbus_property(obj):
569
return getattr(obj, u"_dbus_is_property", False)
851
570
852
def _get_all_dbus_things(self, thing):
571
def _get_all_dbus_properties(self):
853
572
"""Returns a generator of (name, attribute) pairs
854
573
"""
855
return ((getattr(athing.__get__(self), "_dbus_name",
856
name),
857
athing.__get__(self))
858
for cls in self.__class__.__mro__
859
for name, athing in
860
inspect.getmembers(cls,
861
self._is_dbus_thing(thing)))
574
return ((prop._dbus_name, prop)
575
for name, prop in
576
inspect.getmembers(self, self._is_dbus_property))
862
577
863
578
def _get_dbus_property(self, interface_name, property_name):
864
579
"""Returns a bound method if one exists which is a D-Bus
865
580
property with the specified name and interface.
866
581
"""
867
for cls in self.__class__.__mro__:
868
for name, value in (inspect.getmembers
869
(cls,
870
self._is_dbus_thing("property"))):
871
if (value._dbus_name == property_name
872
and value._dbus_interface == interface_name):
873
return value.__get__(self)
874
582
for name in (property_name,
583
property_name + u"_dbus_property"):
584
prop = getattr(self, name, None)
585
if (prop is None
586
or not self._is_dbus_property(prop)
587
or prop._dbus_name != property_name
588
or (interface_name and prop._dbus_interface
589
and interface_name != prop._dbus_interface)):
590
continue
591
return prop
875
592
# No such property
876
raise DBusPropertyNotFound(self.dbus_object_path + ":"
877
+ interface_name + "."
593
raise DBusPropertyNotFound(self.dbus_object_path + u":"
594
+ interface_name + u"."
878
595
+ property_name)
879
596
880
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
881
out_signature="v")
597
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
598
out_signature=u"v")
882
599
def Get(self, interface_name, property_name):
883
600
"""Standard D-Bus property Get() method, see D-Bus standard.
884
601
"""
885
602
prop = self._get_dbus_property(interface_name, property_name)
886
if prop._dbus_access == "write":
603
if prop._dbus_access == u"write":
887
604
raise DBusPropertyAccessException(property_name)
888
605
value = prop()
889
if not hasattr(value, "variant_level"):
606
if not hasattr(value, u"variant_level"):
890
607
return value
891
608
return type(value)(value, variant_level=value.variant_level+1)
892
609
893
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
610
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
894
611
def Set(self, interface_name, property_name, value):
895
612
"""Standard D-Bus property Set() method, see D-Bus standard.
896
613
"""
897
614
prop = self._get_dbus_property(interface_name, property_name)
898
if prop._dbus_access == "read":
615
if prop._dbus_access == u"read":
899
616
raise DBusPropertyAccessException(property_name)
900
if prop._dbus_get_args_options["byte_arrays"]:
617
if prop._dbus_get_args_options[u"byte_arrays"]:
901
618
# The byte_arrays option is not supported yet on
902
619
# signatures other than "ay".
903
if prop._dbus_signature != "ay":
620
if prop._dbus_signature != u"ay":
904
621
raise ValueError
905
value = dbus.ByteArray(b''.join(chr(byte)
906
for byte in value))
622
value = dbus.ByteArray(''.join(unichr(byte)
623
for byte in value))
907
624
prop(value)
908
625
909
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
910
out_signature="a{sv}")
626
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
627
out_signature=u"a{sv}")
911
628
def GetAll(self, interface_name):
912
629
"""Standard D-Bus property GetAll() method, see D-Bus
913
630
standard.
914
631
915
632
Note: Will not include properties with access="write".
916
633
"""
917
properties = {}
918
for name, prop in self._get_all_dbus_things("property"):
634
all = {}
635
for name, prop in self._get_all_dbus_properties():
919
636
if (interface_name
920
637
and interface_name != prop._dbus_interface):
921
638
# Interface non-empty but did not match
922
639
continue
923
640
# Ignore write-only properties
924
if prop._dbus_access == "write":
641
if prop._dbus_access == u"write":
925
642
continue
926
643
value = prop()
927
if not hasattr(value, "variant_level"):
928
properties[name] = value
644
if not hasattr(value, u"variant_level"):
645
all[name] = value
929
646
continue
930
properties[name] = type(value)(value, variant_level=
931
value.variant_level+1)
932
return dbus.Dictionary(properties, signature="sv")
647
all[name] = type(value)(value, variant_level=
648
value.variant_level+1)
649
return dbus.Dictionary(all, signature=u"sv")
933
650
934
651
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
935
out_signature="s",
652
out_signature=u"s",
936
653
path_keyword='object_path',
937
654
connection_keyword='connection')
938
655
def Introspect(self, object_path, connection):
939
"""Overloading of standard D-Bus method.
940
941
Inserts property tags and interface annotation tags.
656
"""Standard D-Bus method, overloaded to insert property tags.
942
657
"""
943
658
xmlstring = dbus.service.Object.Introspect(self, object_path,
944
659
connection)
945
660
try:
946
661
document = xml.dom.minidom.parseString(xmlstring)
947
662
def make_tag(document, name, prop):
948
e = document.createElement("property")
949
e.setAttribute("name", name)
950
e.setAttribute("type", prop._dbus_signature)
951
e.setAttribute("access", prop._dbus_access)
663
e = document.createElement(u"property")
664
e.setAttribute(u"name", name)
665
e.setAttribute(u"type", prop._dbus_signature)
666
e.setAttribute(u"access", prop._dbus_access)
952
667
return e
953
for if_tag in document.getElementsByTagName("interface"):
954
# Add property tags
668
for if_tag in document.getElementsByTagName(u"interface"):
955
669
for tag in (make_tag(document, name, prop)
956
670
for name, prop
957
in self._get_all_dbus_things("property")
671
in self._get_all_dbus_properties()
958
672
if prop._dbus_interface
959
== if_tag.getAttribute("name")):
673
== if_tag.getAttribute(u"name")):
960
674
if_tag.appendChild(tag)
961
# Add annotation tags
962
for typ in ("method", "signal", "property"):
963
for tag in if_tag.getElementsByTagName(typ):
964
annots = dict()
965
for name, prop in (self.
966
_get_all_dbus_things(typ)):
967
if (name == tag.getAttribute("name")
968
and prop._dbus_interface
969
== if_tag.getAttribute("name")):
970
annots.update(getattr
971
(prop,
972
"_dbus_annotations",
973
{}))
974
for name, value in annots.iteritems():
975
ann_tag = document.createElement(
976
"annotation")
977
ann_tag.setAttribute("name", name)
978
ann_tag.setAttribute("value", value)
979
tag.appendChild(ann_tag)
980
# Add interface annotation tags
981
for annotation, value in dict(
982
itertools.chain(
983
*(annotations().iteritems()
984
for name, annotations in
985
self._get_all_dbus_things("interface")
986
if name == if_tag.getAttribute("name")
987
))).iteritems():
988
ann_tag = document.createElement("annotation")
989
ann_tag.setAttribute("name", annotation)
990
ann_tag.setAttribute("value", value)
991
if_tag.appendChild(ann_tag)
992
675
# Add the names to the return values for the
993
676
# "org.freedesktop.DBus.Properties" methods
994
if (if_tag.getAttribute("name")
995
== "org.freedesktop.DBus.Properties"):
996
for cn in if_tag.getElementsByTagName("method"):
997
if cn.getAttribute("name") == "Get":
998
for arg in cn.getElementsByTagName("arg"):
999
if (arg.getAttribute("direction")
1000
== "out"):
1001
arg.setAttribute("name", "value")
1002
elif cn.getAttribute("name") == "GetAll":
1003
for arg in cn.getElementsByTagName("arg"):
1004
if (arg.getAttribute("direction")
1005
== "out"):
1006
arg.setAttribute("name", "props")
1007
xmlstring = document.toxml("utf-8")
677
if (if_tag.getAttribute(u"name")
678
== u"org.freedesktop.DBus.Properties"):
679
for cn in if_tag.getElementsByTagName(u"method"):
680
if cn.getAttribute(u"name") == u"Get":
681
for arg in cn.getElementsByTagName(u"arg"):
682
if (arg.getAttribute(u"direction")
683
== u"out"):
684
arg.setAttribute(u"name", u"value")
685
elif cn.getAttribute(u"name") == u"GetAll":
686
for arg in cn.getElementsByTagName(u"arg"):
687
if (arg.getAttribute(u"direction")
688
== u"out"):
689
arg.setAttribute(u"name", u"props")
690
xmlstring = document.toxml(u"utf-8")
1008
691
document.unlink()
1009
692
except (AttributeError, xml.dom.DOMException,
1010
xml.parsers.expat.ExpatError) as error:
1011
logger.error("Failed to override Introspection method",
1012
exc_info=error)
693
xml.parsers.expat.ExpatError), error:
694
logger.error(u"Failed to override Introspection method",
695
error)
1013
696
return xmlstring
1014
697
1015
698
1016
def datetime_to_dbus (dt, variant_level=0):
1017
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1018
if dt is None:
1019
return dbus.String("", variant_level = variant_level)
1020
return dbus.String(dt.isoformat(),
1021
variant_level=variant_level)
1022
1023
1024
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
1025
.__metaclass__):
1026
"""Applied to an empty subclass of a D-Bus object, this metaclass
1027
will add additional D-Bus attributes matching a certain pattern.
1028
"""
1029
def __new__(mcs, name, bases, attr):
1030
# Go through all the base classes which could have D-Bus
1031
# methods, signals, or properties in them
1032
old_interface_names = []
1033
for base in (b for b in bases
1034
if issubclass(b, dbus.service.Object)):
1035
# Go though all attributes of the base class
1036
for attrname, attribute in inspect.getmembers(base):
1037
# Ignore non-D-Bus attributes, and D-Bus attributes
1038
# with the wrong interface name
1039
if (not hasattr(attribute, "_dbus_interface")
1040
or not attribute._dbus_interface
1041
.startswith("se.recompile.Mandos")):
1042
continue
1043
# Create an alternate D-Bus interface name based on
1044
# the current name
1045
alt_interface = (attribute._dbus_interface
1046
.replace("se.recompile.Mandos",
1047
"se.bsnet.fukt.Mandos"))
1048
if alt_interface != attribute._dbus_interface:
1049
old_interface_names.append(alt_interface)
1050
# Is this a D-Bus signal?
1051
if getattr(attribute, "_dbus_is_signal", False):
1052
# Extract the original non-method function by
1053
# black magic
1054
nonmethod_func = (dict(
1055
zip(attribute.func_code.co_freevars,
1056
attribute.__closure__))["func"]
1057
.cell_contents)
1058
# Create a new, but exactly alike, function
1059
# object, and decorate it to be a new D-Bus signal
1060
# with the alternate D-Bus interface name
1061
new_function = (dbus.service.signal
1062
(alt_interface,
1063
attribute._dbus_signature)
1064
(types.FunctionType(
1065
nonmethod_func.func_code,
1066
nonmethod_func.func_globals,
1067
nonmethod_func.func_name,
1068
nonmethod_func.func_defaults,
1069
nonmethod_func.func_closure)))
1070
# Copy annotations, if any
1071
try:
1072
new_function._dbus_annotations = (
1073
dict(attribute._dbus_annotations))
1074
except AttributeError:
1075
pass
1076
# Define a creator of a function to call both the
1077
# old and new functions, so both the old and new
1078
# signals gets sent when the function is called
1079
def fixscope(func1, func2):
1080
"""This function is a scope container to pass
1081
func1 and func2 to the "call_both" function
1082
outside of its arguments"""
1083
def call_both(*args, **kwargs):
1084
"""This function will emit two D-Bus
1085
signals by calling func1 and func2"""
1086
func1(*args, **kwargs)
1087
func2(*args, **kwargs)
1088
return call_both
1089
# Create the "call_both" function and add it to
1090
# the class
1091
attr[attrname] = fixscope(attribute,
1092
new_function)
1093
# Is this a D-Bus method?
1094
elif getattr(attribute, "_dbus_is_method", False):
1095
# Create a new, but exactly alike, function
1096
# object. Decorate it to be a new D-Bus method
1097
# with the alternate D-Bus interface name. Add it
1098
# to the class.
1099
attr[attrname] = (dbus.service.method
1100
(alt_interface,
1101
attribute._dbus_in_signature,
1102
attribute._dbus_out_signature)
1103
(types.FunctionType
1104
(attribute.func_code,
1105
attribute.func_globals,
1106
attribute.func_name,
1107
attribute.func_defaults,
1108
attribute.func_closure)))
1109
# Copy annotations, if any
1110
try:
1111
attr[attrname]._dbus_annotations = (
1112
dict(attribute._dbus_annotations))
1113
except AttributeError:
1114
pass
1115
# Is this a D-Bus property?
1116
elif getattr(attribute, "_dbus_is_property", False):
1117
# Create a new, but exactly alike, function
1118
# object, and decorate it to be a new D-Bus
1119
# property with the alternate D-Bus interface
1120
# name. Add it to the class.
1121
attr[attrname] = (dbus_service_property
1122
(alt_interface,
1123
attribute._dbus_signature,
1124
attribute._dbus_access,
1125
attribute
1126
._dbus_get_args_options
1127
["byte_arrays"])
1128
(types.FunctionType
1129
(attribute.func_code,
1130
attribute.func_globals,
1131
attribute.func_name,
1132
attribute.func_defaults,
1133
attribute.func_closure)))
1134
# Copy annotations, if any
1135
try:
1136
attr[attrname]._dbus_annotations = (
1137
dict(attribute._dbus_annotations))
1138
except AttributeError:
1139
pass
1140
# Is this a D-Bus interface?
1141
elif getattr(attribute, "_dbus_is_interface", False):
1142
# Create a new, but exactly alike, function
1143
# object. Decorate it to be a new D-Bus interface
1144
# with the alternate D-Bus interface name. Add it
1145
# to the class.
1146
attr[attrname] = (dbus_interface_annotations
1147
(alt_interface)
1148
(types.FunctionType
1149
(attribute.func_code,
1150
attribute.func_globals,
1151
attribute.func_name,
1152
attribute.func_defaults,
1153
attribute.func_closure)))
1154
# Deprecate all old interfaces
1155
iname="_AlternateDBusNamesMetaclass_interface_annotation{0}"
1156
for old_interface_name in old_interface_names:
1157
@dbus_interface_annotations(old_interface_name)
1158
def func(self):
1159
return { "org.freedesktop.DBus.Deprecated": "true" }
1160
# Find an unused name
1161
for aname in (iname.format(i) for i in itertools.count()):
1162
if aname not in attr:
1163
attr[aname] = func
1164
break
1165
return type.__new__(mcs, name, bases, attr)
1166
1167
1168
699
class ClientDBus(Client, DBusObjectWithProperties):
1169
700
"""A Client class using D-Bus
1170
701
1172
703
dbus_object_path: dbus.ObjectPath
1173
704
bus: dbus.SystemBus()
1174
705
"""
1175
1176
runtime_expansions = (Client.runtime_expansions
1177
+ ("dbus_object_path",))
1178
1179
706
# dbus.service.Object doesn't use super(), so we can't either.
1180
707
1181
708
def __init__(self, bus = None, *args, **kwargs):
709
self._approvals_pending = 0
1182
710
self.bus = bus
1183
711
Client.__init__(self, *args, **kwargs)
1184
712
# Only now, when this client is initialized, can it show up on
1185
713
# the D-Bus
1186
client_object_name = unicode(self.name).translate(
1187
{ord("."): ord("_"),
1188
ord("-"): ord("_")})
1189
714
self.dbus_object_path = (dbus.ObjectPath
1190
("/clients/" + client_object_name))
715
(u"/clients/"
716
+ self.name.replace(u".", u"_")))
1191
717
DBusObjectWithProperties.__init__(self, self.bus,
1192
718
self.dbus_object_path)
1193
1194
def notifychangeproperty(transform_func,
1195
dbus_name, type_func=lambda x: x,
1196
variant_level=1):
1197
""" Modify a variable so that it's a property which announces
1198
its changes to DBus.
1199
1200
transform_fun: Function that takes a value and a variant_level
1201
and transforms it to a D-Bus type.
1202
dbus_name: D-Bus name of the variable
1203
type_func: Function that transform the value before sending it
1204
to the D-Bus. Default: no transform
1205
variant_level: D-Bus variant level. Default: 1
1206
"""
1207
attrname = "_{0}".format(dbus_name)
1208
def setter(self, value):
1209
if hasattr(self, "dbus_object_path"):
1210
if (not hasattr(self, attrname) or
1211
type_func(getattr(self, attrname, None))
1212
!= type_func(value)):
1213
dbus_value = transform_func(type_func(value),
1214
variant_level
1215
=variant_level)
1216
self.PropertyChanged(dbus.String(dbus_name),
1217
dbus_value)
1218
setattr(self, attrname, value)
1219
1220
return property(lambda self: getattr(self, attrname), setter)
1221
1222
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1223
approvals_pending = notifychangeproperty(dbus.Boolean,
1224
"ApprovalPending",
1225
type_func = bool)
1226
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1227
last_enabled = notifychangeproperty(datetime_to_dbus,
1228
"LastEnabled")
1229
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1230
type_func = lambda checker:
1231
checker is not None)
1232
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1233
"LastCheckedOK")
1234
last_checker_status = notifychangeproperty(dbus.Int16,
1235
"LastCheckerStatus")
1236
last_approval_request = notifychangeproperty(
1237
datetime_to_dbus, "LastApprovalRequest")
1238
approved_by_default = notifychangeproperty(dbus.Boolean,
1239
"ApprovedByDefault")
1240
approval_delay = notifychangeproperty(dbus.UInt64,
1241
"ApprovalDelay",
1242
type_func =
1243
timedelta_to_milliseconds)
1244
approval_duration = notifychangeproperty(
1245
dbus.UInt64, "ApprovalDuration",
1246
type_func = timedelta_to_milliseconds)
1247
host = notifychangeproperty(dbus.String, "Host")
1248
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1249
type_func =
1250
timedelta_to_milliseconds)
1251
extended_timeout = notifychangeproperty(
1252
dbus.UInt64, "ExtendedTimeout",
1253
type_func = timedelta_to_milliseconds)
1254
interval = notifychangeproperty(dbus.UInt64,
1255
"Interval",
1256
type_func =
1257
timedelta_to_milliseconds)
1258
checker_command = notifychangeproperty(dbus.String, "Checker")
1259
1260
del notifychangeproperty
719
720
def _get_approvals_pending(self):
721
return self._approvals_pending
722
def _set_approvals_pending(self, value):
723
old_value = self._approvals_pending
724
self._approvals_pending = value
725
bval = bool(value)
726
if (hasattr(self, "dbus_object_path")
727
and bval is not bool(old_value)):
728
dbus_bool = dbus.Boolean(bval, variant_level=1)
729
self.PropertyChanged(dbus.String(u"ApprovalPending"),
730
dbus_bool)
731
732
approvals_pending = property(_get_approvals_pending,
733
_set_approvals_pending)
734
del _get_approvals_pending, _set_approvals_pending
735
736
@staticmethod
737
def _datetime_to_dbus(dt, variant_level=0):
738
"""Convert a UTC datetime.datetime() to a D-Bus type."""
739
return dbus.String(dt.isoformat(),
740
variant_level=variant_level)
741
742
def enable(self):
743
oldstate = getattr(self, u"enabled", False)
744
r = Client.enable(self)
745
if oldstate != self.enabled:
746
# Emit D-Bus signals
747
self.PropertyChanged(dbus.String(u"Enabled"),
748
dbus.Boolean(True, variant_level=1))
749
self.PropertyChanged(
750
dbus.String(u"LastEnabled"),
751
self._datetime_to_dbus(self.last_enabled,
752
variant_level=1))
753
return r
754
755
def disable(self, quiet = False):
756
oldstate = getattr(self, u"enabled", False)
757
r = Client.disable(self, quiet=quiet)
758
if not quiet and oldstate != self.enabled:
759
# Emit D-Bus signal
760
self.PropertyChanged(dbus.String(u"Enabled"),
761
dbus.Boolean(False, variant_level=1))
762
return r
1261
763
1262
764
def __del__(self, *args, **kwargs):
1263
765
try:
1264
766
self.remove_from_connection()
1265
767
except LookupError:
1266
768
pass
1267
if hasattr(DBusObjectWithProperties, "__del__"):
769
if hasattr(DBusObjectWithProperties, u"__del__"):
1268
770
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1269
771
Client.__del__(self, *args, **kwargs)
1270
772
1272
774
*args, **kwargs):
1273
775
self.checker_callback_tag = None
1274
776
self.checker = None
777
# Emit D-Bus signal
778
self.PropertyChanged(dbus.String(u"CheckerRunning"),
779
dbus.Boolean(False, variant_level=1))
1275
780
if os.WIFEXITED(condition):
1276
781
exitstatus = os.WEXITSTATUS(condition)
1277
782
# Emit D-Bus signal
1287
792
return Client.checker_callback(self, pid, condition, command,
1288
793
*args, **kwargs)
1289
794
795
def checked_ok(self, *args, **kwargs):
796
r = Client.checked_ok(self, *args, **kwargs)
797
# Emit D-Bus signal
798
self.PropertyChanged(
799
dbus.String(u"LastCheckedOK"),
800
(self._datetime_to_dbus(self.last_checked_ok,
801
variant_level=1)))
802
return r
803
1290
804
def start_checker(self, *args, **kwargs):
1291
805
old_checker = self.checker
1292
806
if self.checker is not None:
1299
813
and old_checker_pid != self.checker.pid):
1300
814
# Emit D-Bus signal
1301
815
self.CheckerStarted(self.current_checker_command)
816
self.PropertyChanged(
817
dbus.String(u"CheckerRunning"),
818
dbus.Boolean(True, variant_level=1))
1302
819
return r
1303
820
821
def stop_checker(self, *args, **kwargs):
822
old_checker = getattr(self, u"checker", None)
823
r = Client.stop_checker(self, *args, **kwargs)
824
if (old_checker is not None
825
and getattr(self, u"checker", None) is None):
826
self.PropertyChanged(dbus.String(u"CheckerRunning"),
827
dbus.Boolean(False, variant_level=1))
828
return r
829
1304
830
def _reset_approved(self):
1305
self.approved = None
831
self._approved = None
1306
832
return False
1307
833
1308
834
def approve(self, value=True):
1309
835
self.send_changedstate()
1310
self.approved = value
1311
gobject.timeout_add(timedelta_to_milliseconds
836
self._approved = value
837
gobject.timeout_add(self._timedelta_to_milliseconds
1312
838
(self.approval_duration),
1313
839
self._reset_approved)
1314
840
841
1315
842
## D-Bus methods, signals & properties
1316
_interface = "se.recompile.Mandos.Client"
1317
1318
## Interfaces
1319
1320
@dbus_interface_annotations(_interface)
1321
def _foo(self):
1322
return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1323
"false"}
843
_interface = u"se.bsnet.fukt.Mandos.Client"
1324
844
1325
845
## Signals
1326
846
1327
847
# CheckerCompleted - signal
1328
@dbus.service.signal(_interface, signature="nxs")
848
@dbus.service.signal(_interface, signature=u"nxs")
1329
849
def CheckerCompleted(self, exitcode, waitstatus, command):
1330
850
"D-Bus signal"
1331
851
pass
1332
852
1333
853
# CheckerStarted - signal
1334
@dbus.service.signal(_interface, signature="s")
854
@dbus.service.signal(_interface, signature=u"s")
1335
855
def CheckerStarted(self, command):
1336
856
"D-Bus signal"
1337
857
pass
1338
858
1339
859
# PropertyChanged - signal
1340
@dbus.service.signal(_interface, signature="sv")
860
@dbus.service.signal(_interface, signature=u"sv")
1341
861
def PropertyChanged(self, property, value):
1342
862
"D-Bus signal"
1343
863
pass
1352
872
pass
1353
873
1354
874
# Rejected - signal
1355
@dbus.service.signal(_interface, signature="s")
875
@dbus.service.signal(_interface, signature=u"s")
1356
876
def Rejected(self, reason):
1357
877
"D-Bus signal"
1358
878
pass
1359
879
1360
880
# NeedApproval - signal
1361
@dbus.service.signal(_interface, signature="tb")
881
@dbus.service.signal(_interface, signature=u"tb")
1362
882
def NeedApproval(self, timeout, default):
1363
883
"D-Bus signal"
1364
return self.need_approval()
884
pass
1365
885
1366
886
## Methods
1367
887
1368
888
# Approve - method
1369
@dbus.service.method(_interface, in_signature="b")
889
@dbus.service.method(_interface, in_signature=u"b")
1370
890
def Approve(self, value):
1371
891
self.approve(value)
1372
892
1373
893
# CheckedOK - method
1374
894
@dbus.service.method(_interface)
1375
895
def CheckedOK(self):
1376
self.checked_ok()
896
return self.checked_ok()
1377
897
1378
898
# Enable - method
1379
899
@dbus.service.method(_interface)
1401
921
## Properties
1402
922
1403
923
# ApprovalPending - property
1404
@dbus_service_property(_interface, signature="b", access="read")
924
@dbus_service_property(_interface, signature=u"b", access=u"read")
1405
925
def ApprovalPending_dbus_property(self):
1406
926
return dbus.Boolean(bool(self.approvals_pending))
1407
927
1408
928
# ApprovedByDefault - property
1409
@dbus_service_property(_interface, signature="b",
1410
access="readwrite")
929
@dbus_service_property(_interface, signature=u"b",
930
access=u"readwrite")
1411
931
def ApprovedByDefault_dbus_property(self, value=None):
1412
932
if value is None: # get
1413
933
return dbus.Boolean(self.approved_by_default)
1414
934
self.approved_by_default = bool(value)
935
# Emit D-Bus signal
936
self.PropertyChanged(dbus.String(u"ApprovedByDefault"),
937
dbus.Boolean(value, variant_level=1))
1415
938
1416
939
# ApprovalDelay - property
1417
@dbus_service_property(_interface, signature="t",
1418
access="readwrite")
940
@dbus_service_property(_interface, signature=u"t",
941
access=u"readwrite")
1419
942
def ApprovalDelay_dbus_property(self, value=None):
1420
943
if value is None: # get
1421
944
return dbus.UInt64(self.approval_delay_milliseconds())
1422
945
self.approval_delay = datetime.timedelta(0, 0, 0, value)
946
# Emit D-Bus signal
947
self.PropertyChanged(dbus.String(u"ApprovalDelay"),
948
dbus.UInt64(value, variant_level=1))
1423
949
1424
950
# ApprovalDuration - property
1425
@dbus_service_property(_interface, signature="t",
1426
access="readwrite")
951
@dbus_service_property(_interface, signature=u"t",
952
access=u"readwrite")
1427
953
def ApprovalDuration_dbus_property(self, value=None):
1428
954
if value is None: # get
1429
return dbus.UInt64(timedelta_to_milliseconds(
955
return dbus.UInt64(self._timedelta_to_milliseconds(
1430
956
self.approval_duration))
1431
957
self.approval_duration = datetime.timedelta(0, 0, 0, value)
958
# Emit D-Bus signal
959
self.PropertyChanged(dbus.String(u"ApprovalDuration"),
960
dbus.UInt64(value, variant_level=1))
1432
961
1433
962
# Name - property
1434
@dbus_service_property(_interface, signature="s", access="read")
963
@dbus_service_property(_interface, signature=u"s", access=u"read")
1435
964
def Name_dbus_property(self):
1436
965
return dbus.String(self.name)
1437
966
1438
967
# Fingerprint - property
1439
@dbus_service_property(_interface, signature="s", access="read")
968
@dbus_service_property(_interface, signature=u"s", access=u"read")
1440
969
def Fingerprint_dbus_property(self):
1441
970
return dbus.String(self.fingerprint)
1442
971
1443
972
# Host - property
1444
@dbus_service_property(_interface, signature="s",
1445
access="readwrite")
973
@dbus_service_property(_interface, signature=u"s",
974
access=u"readwrite")
1446
975
def Host_dbus_property(self, value=None):
1447
976
if value is None: # get
1448
977
return dbus.String(self.host)
1449
self.host = unicode(value)
978
self.host = value
979
# Emit D-Bus signal
980
self.PropertyChanged(dbus.String(u"Host"),
981
dbus.String(value, variant_level=1))
1450
982
1451
983
# Created - property
1452
@dbus_service_property(_interface, signature="s", access="read")
984
@dbus_service_property(_interface, signature=u"s", access=u"read")
1453
985
def Created_dbus_property(self):
1454
return datetime_to_dbus(self.created)
986
return dbus.String(self._datetime_to_dbus(self.created))
1455
987
1456
988
# LastEnabled - property
1457
@dbus_service_property(_interface, signature="s", access="read")
989
@dbus_service_property(_interface, signature=u"s", access=u"read")
1458
990
def LastEnabled_dbus_property(self):
1459
return datetime_to_dbus(self.last_enabled)
991
if self.last_enabled is None:
992
return dbus.String(u"")
993
return dbus.String(self._datetime_to_dbus(self.last_enabled))
1460
994
1461
995
# Enabled - property
1462
@dbus_service_property(_interface, signature="b",
1463
access="readwrite")
996
@dbus_service_property(_interface, signature=u"b",
997
access=u"readwrite")
1464
998
def Enabled_dbus_property(self, value=None):
1465
999
if value is None: # get
1466
1000
return dbus.Boolean(self.enabled)
1470
1004
self.disable()
1471
1005
1472
1006
# LastCheckedOK - property
1473
@dbus_service_property(_interface, signature="s",
1474
access="readwrite")
1007
@dbus_service_property(_interface, signature=u"s",
1008
access=u"readwrite")
1475
1009
def LastCheckedOK_dbus_property(self, value=None):
1476
1010
if value is not None:
1477
1011
self.checked_ok()
1478
1012
return
1479
return datetime_to_dbus(self.last_checked_ok)
1480
1481
# LastCheckerStatus - property
1482
@dbus_service_property(_interface, signature="n",
1483
access="read")
1484
def LastCheckerStatus_dbus_property(self):
1485
return dbus.Int16(self.last_checker_status)
1486
1487
# Expires - property
1488
@dbus_service_property(_interface, signature="s", access="read")
1489
def Expires_dbus_property(self):
1490
return datetime_to_dbus(self.expires)
1491
1492
# LastApprovalRequest - property
1493
@dbus_service_property(_interface, signature="s", access="read")
1494
def LastApprovalRequest_dbus_property(self):
1495
return datetime_to_dbus(self.last_approval_request)
1013
if self.last_checked_ok is None:
1014
return dbus.String(u"")
1015
return dbus.String(self._datetime_to_dbus(self
1016
.last_checked_ok))
1496
1017
1497
1018
# Timeout - property
1498
@dbus_service_property(_interface, signature="t",
1499
access="readwrite")
1019
@dbus_service_property(_interface, signature=u"t",
1020
access=u"readwrite")
1500
1021
def Timeout_dbus_property(self, value=None):
1501
1022
if value is None: # get
1502
1023
return dbus.UInt64(self.timeout_milliseconds())
1503
1024
self.timeout = datetime.timedelta(0, 0, 0, value)
1025
# Emit D-Bus signal
1026
self.PropertyChanged(dbus.String(u"Timeout"),
1027
dbus.UInt64(value, variant_level=1))
1028
if getattr(self, u"disable_initiator_tag", None) is None:
1029
return
1504
1030
# Reschedule timeout
1505
if self.enabled:
1506
now = datetime.datetime.utcnow()
1507
time_to_die = timedelta_to_milliseconds(
1508
(self.last_checked_ok + self.timeout) - now)
1509
if time_to_die <= 0:
1510
# The timeout has passed
1511
self.disable()
1512
else:
1513
self.expires = (now +
1514
datetime.timedelta(milliseconds =
1515
time_to_die))
1516
if (getattr(self, "disable_initiator_tag", None)
1517
is None):
1518
return
1519
gobject.source_remove(self.disable_initiator_tag)
1520
self.disable_initiator_tag = (gobject.timeout_add
1521
(time_to_die,
1522
self.disable))
1523
1524
# ExtendedTimeout - property
1525
@dbus_service_property(_interface, signature="t",
1526
access="readwrite")
1527
def ExtendedTimeout_dbus_property(self, value=None):
1528
if value is None: # get
1529
return dbus.UInt64(self.extended_timeout_milliseconds())
1530
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1031
gobject.source_remove(self.disable_initiator_tag)
1032
self.disable_initiator_tag = None
1033
time_to_die = (self.
1034
_timedelta_to_milliseconds((self
1035
.last_checked_ok
1036
+ self.timeout)
1037
- datetime.datetime
1038
.utcnow()))
1039
if time_to_die <= 0:
1040
# The timeout has passed
1041
self.disable()
1042
else:
1043
self.disable_initiator_tag = (gobject.timeout_add
1044
(time_to_die, self.disable))
1531
1045
1532
1046
# Interval - property
1533
@dbus_service_property(_interface, signature="t",
1534
access="readwrite")
1047
@dbus_service_property(_interface, signature=u"t",
1048
access=u"readwrite")
1535
1049
def Interval_dbus_property(self, value=None):
1536
1050
if value is None: # get
1537
1051
return dbus.UInt64(self.interval_milliseconds())
1538
1052
self.interval = datetime.timedelta(0, 0, 0, value)
1539
if getattr(self, "checker_initiator_tag", None) is None:
1053
# Emit D-Bus signal
1054
self.PropertyChanged(dbus.String(u"Interval"),
1055
dbus.UInt64(value, variant_level=1))
1056
if getattr(self, u"checker_initiator_tag", None) is None:
1540
1057
return
1541
if self.enabled:
1542
# Reschedule checker run
1543
gobject.source_remove(self.checker_initiator_tag)
1544
self.checker_initiator_tag = (gobject.timeout_add
1545
(value, self.start_checker))
1546
self.start_checker() # Start one now, too
1547
1058
# Reschedule checker run
1059
gobject.source_remove(self.checker_initiator_tag)
1060
self.checker_initiator_tag = (gobject.timeout_add
1061
(value, self.start_checker))
1062
self.start_checker() # Start one now, too
1063
1548
1064
# Checker - property
1549
@dbus_service_property(_interface, signature="s",
1550
access="readwrite")
1065
@dbus_service_property(_interface, signature=u"s",
1066
access=u"readwrite")
1551
1067
def Checker_dbus_property(self, value=None):
1552
1068
if value is None: # get
1553
1069
return dbus.String(self.checker_command)
1554
self.checker_command = unicode(value)
1070
self.checker_command = value
1071
# Emit D-Bus signal
1072
self.PropertyChanged(dbus.String(u"Checker"),
1073
dbus.String(self.checker_command,
1074
variant_level=1))
1555
1075
1556
1076
# CheckerRunning - property
1557
@dbus_service_property(_interface, signature="b",
1558
access="readwrite")
1077
@dbus_service_property(_interface, signature=u"b",
1078
access=u"readwrite")
1559
1079
def CheckerRunning_dbus_property(self, value=None):
1560
1080
if value is None: # get
1561
1081
return dbus.Boolean(self.checker is not None)
1565
1085
self.stop_checker()
1566
1086
1567
1087
# ObjectPath - property
1568
@dbus_service_property(_interface, signature="o", access="read")
1088
@dbus_service_property(_interface, signature=u"o", access=u"read")
1569
1089
def ObjectPath_dbus_property(self):
1570
1090
return self.dbus_object_path # is already a dbus.ObjectPath
1571
1091
1572
1092
# Secret = property
1573
@dbus_service_property(_interface, signature="ay",
1574
access="write", byte_arrays=True)
1093
@dbus_service_property(_interface, signature=u"ay",
1094
access=u"write", byte_arrays=True)
1575
1095
def Secret_dbus_property(self, value):
1576
1096
self.secret = str(value)
1577
1097
1584
1104
self._pipe.send(('init', fpr, address))
1585
1105
if not self._pipe.recv():
1586
1106
raise KeyError()
1587
1107
1588
1108
def __getattribute__(self, name):
1589
if name == '_pipe':
1109
if(name == '_pipe'):
1590
1110
return super(ProxyClient, self).__getattribute__(name)
1591
1111
self._pipe.send(('getattr', name))
1592
1112
data = self._pipe.recv()
1597
1117
self._pipe.send(('funcall', name, args, kwargs))
1598
1118
return self._pipe.recv()[1]
1599
1119
return func
1600
1120
1601
1121
def __setattr__(self, name, value):
1602
if name == '_pipe':
1122
if(name == '_pipe'):
1603
1123
return super(ProxyClient, self).__setattr__(name, value)
1604
1124
self._pipe.send(('setattr', name, value))
1605
1125
1606
1126
1607
class ClientDBusTransitional(ClientDBus):
1608
__metaclass__ = AlternateDBusNamesMetaclass
1609
1610
1611
1127
class ClientHandler(socketserver.BaseRequestHandler, object):
1612
1128
"""A class to handle client connections.
1613
1129
1616
1132
1617
1133
def handle(self):
1618
1134
with contextlib.closing(self.server.child_pipe) as child_pipe:
1619
logger.info("TCP connection from: %s",
1135
logger.info(u"TCP connection from: %s",
1620
1136
unicode(self.client_address))
1621
logger.debug("Pipe FD: %d",
1137
logger.debug(u"Pipe FD: %d",
1622
1138
self.server.child_pipe.fileno())
1623
1139
1624
1140
session = (gnutls.connection
1625
1141
.ClientSession(self.request,
1626
1142
gnutls.connection
1627
1143
.X509Credentials()))
1628
1144
1629
1145
# Note: gnutls.connection.X509Credentials is really a
1630
1146
# generic GnuTLS certificate credentials object so long as
1631
1147
# no X.509 keys are added to it. Therefore, we can use it
1632
1148
# here despite using OpenPGP certificates.
1633
1634
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1635
# "+AES-256-CBC", "+SHA1",
1636
# "+COMP-NULL", "+CTYPE-OPENPGP",
1637
# "+DHE-DSS"))
1149
1150
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1151
# u"+AES-256-CBC", u"+SHA1",
1152
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
1153
# u"+DHE-DSS"))
1638
1154
# Use a fallback default, since this MUST be set.
1639
1155
priority = self.server.gnutls_priority
1640
1156
if priority is None:
1641
priority = "NORMAL"
1157
priority = u"NORMAL"
1642
1158
(gnutls.library.functions
1643
1159
.gnutls_priority_set_direct(session._c_object,
1644
1160
priority, None))
1645
1161
1646
1162
# Start communication using the Mandos protocol
1647
1163
# Get protocol number
1648
1164
line = self.request.makefile().readline()
1649
logger.debug("Protocol version: %r", line)
1165
logger.debug(u"Protocol version: %r", line)
1650
1166
try:
1651
1167
if int(line.strip().split()[0]) > 1:
1652
1168
raise RuntimeError
1653
except (ValueError, IndexError, RuntimeError) as error:
1654
logger.error("Unknown protocol version: %s", error)
1169
except (ValueError, IndexError, RuntimeError), error:
1170
logger.error(u"Unknown protocol version: %s", error)
1655
1171
return
1656
1172
1657
1173
# Start GnuTLS connection
1658
1174
try:
1659
1175
session.handshake()
1660
except gnutls.errors.GNUTLSError as error:
1661
logger.warning("Handshake failed: %s", error)
1176
except gnutls.errors.GNUTLSError, error:
1177
logger.warning(u"Handshake failed: %s", error)
1662
1178
# Do not run session.bye() here: the session is not
1663
1179
# established. Just abandon the request.
1664
1180
return
1665
logger.debug("Handshake succeeded")
1666
1181
logger.debug(u"Handshake succeeded")
1182
1667
1183
approval_required = False
1668
1184
try:
1669
1185
try:
1670
1186
fpr = self.fingerprint(self.peer_certificate
1671
1187
(session))
1672
except (TypeError,
1673
gnutls.errors.GNUTLSError) as error:
1674
logger.warning("Bad certificate: %s", error)
1188
except (TypeError, gnutls.errors.GNUTLSError), error:
1189
logger.warning(u"Bad certificate: %s", error)
1675
1190
return
1676
logger.debug("Fingerprint: %s", fpr)
1677
1191
logger.debug(u"Fingerprint: %s", fpr)
1192
1678
1193
try:
1679
1194
client = ProxyClient(child_pipe, fpr,
1680
1195
self.client_address)
1688
1203
1689
1204
while True:
1690
1205
if not client.enabled:
1691
logger.info("Client %s is disabled",
1206
logger.warning(u"Client %s is disabled",
1692
1207
client.name)
1693
1208
if self.server.use_dbus:
1694
1209
# Emit D-Bus signal
1695
client.Rejected("Disabled")
1210
client.Rejected("Disabled")
1696
1211
return
1697
1212
1698
if client.approved or not client.approval_delay:
1213
if client._approved or not client.approval_delay:
1699
1214
#We are approved or approval is disabled
1700
1215
break
1701
elif client.approved is None:
1702
logger.info("Client %s needs approval",
1216
elif client._approved is None:
1217
logger.info(u"Client %s needs approval",
1703
1218
client.name)
1704
1219
if self.server.use_dbus:
1705
1220
# Emit D-Bus signal
1707
1222
client.approval_delay_milliseconds(),
1708
1223
client.approved_by_default)
1709
1224
else:
1710
logger.warning("Client %s was not approved",
1225
logger.warning(u"Client %s was not approved",
1711
1226
client.name)
1712
1227
if self.server.use_dbus:
1713
1228
# Emit D-Bus signal
1715
1230
return
1716
1231
1717
1232
#wait until timeout or approved
1233
#x = float(client._timedelta_to_milliseconds(delay))
1718
1234
time = datetime.datetime.now()
1719
1235
client.changedstate.acquire()
1720
(client.changedstate.wait
1721
(float(client.timedelta_to_milliseconds(delay)
1722
/ 1000)))
1236
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
1723
1237
client.changedstate.release()
1724
1238
time2 = datetime.datetime.now()
1725
1239
if (time2 - time) >= delay:
1729
1243
client.name)
1730
1244
if self.server.use_dbus:
1731
1245
# Emit D-Bus signal
1732
client.Rejected("Approval timed out")
1246
client.Rejected("Timed out")
1733
1247
return
1734
1248
else:
1735
1249
break
1740
1254
while sent_size < len(client.secret):
1741
1255
try:
1742
1256
sent = session.send(client.secret[sent_size:])
1743
except gnutls.errors.GNUTLSError as error:
1744
logger.warning("gnutls send failed",
1745
exc_info=error)
1257
except (gnutls.errors.GNUTLSError), error:
1258
logger.warning("gnutls send failed")
1746
1259
return
1747
logger.debug("Sent: %d, remaining: %d",
1260
logger.debug(u"Sent: %d, remaining: %d",
1748
1261
sent, len(client.secret)
1749
1262
- (sent_size + sent))
1750
1263
sent_size += sent
1751
1752
logger.info("Sending secret to %s", client.name)
1753
# bump the timeout using extended_timeout
1754
client.bump_timeout(client.extended_timeout)
1264
1265
logger.info(u"Sending secret to %s", client.name)
1266
# bump the timeout as if seen
1267
client.checked_ok()
1755
1268
if self.server.use_dbus:
1756
1269
# Emit D-Bus signal
1757
1270
client.GotSecret()
1761
1274
client.approvals_pending -= 1
1762
1275
try:
1763
1276
session.bye()
1764
except gnutls.errors.GNUTLSError as error:
1765
logger.warning("GnuTLS bye failed",
1766
exc_info=error)
1277
except (gnutls.errors.GNUTLSError), error:
1278
logger.warning("GnuTLS bye failed")
1767
1279
1768
1280
@staticmethod
1769
1281
def peer_certificate(session):
1779
1291
.gnutls_certificate_get_peers
1780
1292
(session._c_object, ctypes.byref(list_size)))
1781
1293
if not bool(cert_list) and list_size.value != 0:
1782
raise gnutls.errors.GNUTLSError("error getting peer"
1783
" certificate")
1294
raise gnutls.errors.GNUTLSError(u"error getting peer"
1295
u" certificate")
1784
1296
if list_size.value == 0:
1785
1297
return None
1786
1298
cert = cert_list[0]
1812
1324
if crtverify.value != 0:
1813
1325
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1814
1326
raise (gnutls.errors.CertificateSecurityError
1815
("Verify failed"))
1327
(u"Verify failed"))
1816
1328
# New buffer for the fingerprint
1817
1329
buf = ctypes.create_string_buffer(20)
1818
1330
buf_len = ctypes.c_size_t()
1825
1337
# Convert the buffer to a Python bytestring
1826
1338
fpr = ctypes.string_at(buf, buf_len.value)
1827
1339
# Convert the bytestring to hexadecimal notation
1828
hex_fpr = binascii.hexlify(fpr).upper()
1340
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
1829
1341
return hex_fpr
1830
1342
1831
1343
1834
1346
def sub_process_main(self, request, address):
1835
1347
try:
1836
1348
self.finish_request(request, address)
1837
except Exception:
1349
except:
1838
1350
self.handle_error(request, address)
1839
1351
self.close_request(request)
1840
1352
1841
1353
def process_request(self, request, address):
1842
1354
"""Start a new process to process the request."""
1843
proc = multiprocessing.Process(target = self.sub_process_main,
1844
args = (request,
1845
address))
1846
proc.start()
1847
return proc
1848
1355
multiprocessing.Process(target = self.sub_process_main,
1356
args = (request, address)).start()
1849
1357
1850
1358
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1851
1359
""" adds a pipe to the MixIn """
1855
1363
This function creates a new pipe in self.pipe
1856
1364
"""
1857
1365
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1858
1859
proc = MultiprocessingMixIn.process_request(self, request,
1860
client_address)
1366
1367
super(MultiprocessingMixInWithPipe,
1368
self).process_request(request, client_address)
1861
1369
self.child_pipe.close()
1862
self.add_pipe(parent_pipe, proc)
1863
1864
def add_pipe(self, parent_pipe, proc):
1370
self.add_pipe(parent_pipe)
1371
1372
def add_pipe(self, parent_pipe):
1865
1373
"""Dummy function; override as necessary"""
1866
raise NotImplementedError
1867
1374
pass
1868
1375
1869
1376
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1870
1377
socketserver.TCPServer, object):
1888
1395
bind to an address or port if they were not specified."""
1889
1396
if self.interface is not None:
1890
1397
if SO_BINDTODEVICE is None:
1891
logger.error("SO_BINDTODEVICE does not exist;"
1892
" cannot bind to interface %s",
1398
logger.error(u"SO_BINDTODEVICE does not exist;"
1399
u" cannot bind to interface %s",
1893
1400
self.interface)
1894
1401
else:
1895
1402
try:
1896
1403
self.socket.setsockopt(socket.SOL_SOCKET,
1897
1404
SO_BINDTODEVICE,
1898
1405
str(self.interface
1899
+ '\0'))
1900
except socket.error as error:
1406
+ u'\0'))
1407
except socket.error, error:
1901
1408
if error[0] == errno.EPERM:
1902
logger.error("No permission to"
1903
" bind to interface %s",
1409
logger.error(u"No permission to"
1410
u" bind to interface %s",
1904
1411
self.interface)
1905
1412
elif error[0] == errno.ENOPROTOOPT:
1906
logger.error("SO_BINDTODEVICE not available;"
1907
" cannot bind to interface %s",
1413
logger.error(u"SO_BINDTODEVICE not available;"
1414
u" cannot bind to interface %s",
1908
1415
self.interface)
1909
1416
else:
1910
1417
raise
1912
1419
if self.server_address[0] or self.server_address[1]:
1913
1420
if not self.server_address[0]:
1914
1421
if self.address_family == socket.AF_INET6:
1915
any_address = "::" # in6addr_any
1422
any_address = u"::" # in6addr_any
1916
1423
else:
1917
1424
any_address = socket.INADDR_ANY
1918
1425
self.server_address = (any_address,
1945
1452
self.enabled = False
1946
1453
self.clients = clients
1947
1454
if self.clients is None:
1948
self.clients = {}
1455
self.clients = set()
1949
1456
self.use_dbus = use_dbus
1950
1457
self.gnutls_priority = gnutls_priority
1951
1458
IPv6_TCPServer.__init__(self, server_address,
1955
1462
def server_activate(self):
1956
1463
if self.enabled:
1957
1464
return socketserver.TCPServer.server_activate(self)
1958
1959
1465
def enable(self):
1960
1466
self.enabled = True
1961
1962
def add_pipe(self, parent_pipe, proc):
1467
def add_pipe(self, parent_pipe):
1963
1468
# Call "handle_ipc" for both data and EOF events
1964
1469
gobject.io_add_watch(parent_pipe.fileno(),
1965
1470
gobject.IO_IN | gobject.IO_HUP,
1966
1471
functools.partial(self.handle_ipc,
1967
parent_pipe =
1968
parent_pipe,
1969
proc = proc))
1970
1472
parent_pipe = parent_pipe))
1473
1971
1474
def handle_ipc(self, source, condition, parent_pipe=None,
1972
proc = None, client_object=None):
1475
client_object=None):
1973
1476
condition_names = {
1974
gobject.IO_IN: "IN", # There is data to read.
1975
gobject.IO_OUT: "OUT", # Data can be written (without
1477
gobject.IO_IN: u"IN", # There is data to read.
1478
gobject.IO_OUT: u"OUT", # Data can be written (without
1976
1479
# blocking).
1977
gobject.IO_PRI: "PRI", # There is urgent data to read.
1978
gobject.IO_ERR: "ERR", # Error condition.
1979
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1480
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1481
gobject.IO_ERR: u"ERR", # Error condition.
1482
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1980
1483
# broken, usually for pipes and
1981
1484
# sockets).
1982
1485
}
1984
1487
for cond, name in
1985
1488
condition_names.iteritems()
1986
1489
if cond & condition)
1987
# error, or the other end of multiprocessing.Pipe has closed
1490
logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
1491
conditions_string)
1492
1493
# error or the other end of multiprocessing.Pipe has closed
1988
1494
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
1989
# Wait for other process to exit
1990
proc.join()
1991
1495
return False
1992
1496
1993
1497
# Read a request from the child
1994
1498
request = parent_pipe.recv()
1499
logger.debug(u"IPC request: %s", repr(request))
1995
1500
command = request[0]
1996
1501
1997
1502
if command == 'init':
1998
1503
fpr = request[1]
1999
1504
address = request[2]
2000
1505
2001
for c in self.clients.itervalues():
1506
for c in self.clients:
2002
1507
if c.fingerprint == fpr:
2003
1508
client = c
2004
1509
break
2005
1510
else:
2006
logger.info("Client not found for fingerprint: %s, ad"
2007
"dress: %s", fpr, address)
1511
logger.warning(u"Client not found for fingerprint: %s, ad"
1512
u"dress: %s", fpr, address)
2008
1513
if self.use_dbus:
2009
1514
# Emit D-Bus signal
2010
mandos_dbus_service.ClientNotFound(fpr,
2011
address[0])
1515
mandos_dbus_service.ClientNotFound(fpr, address)
2012
1516
parent_pipe.send(False)
2013
1517
return False
2014
1518
2015
1519
gobject.io_add_watch(parent_pipe.fileno(),
2016
1520
gobject.IO_IN | gobject.IO_HUP,
2017
1521
functools.partial(self.handle_ipc,
2018
parent_pipe =
2019
parent_pipe,
2020
proc = proc,
2021
client_object =
2022
client))
1522
parent_pipe = parent_pipe,
1523
client_object = client))
2023
1524
parent_pipe.send(True)
2024
# remove the old hook in favor of the new above hook on
2025
# same fileno
1525
# remove the old hook in favor of the new above hook on same fileno
2026
1526
return False
2027
1527
if command == 'funcall':
2028
1528
funcname = request[1]
2029
1529
args = request[2]
2030
1530
kwargs = request[3]
2031
1531
2032
parent_pipe.send(('data', getattr(client_object,
2033
funcname)(*args,
2034
**kwargs)))
2035
1532
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
1533
2036
1534
if command == 'getattr':
2037
1535
attrname = request[1]
2038
1536
if callable(client_object.__getattribute__(attrname)):
2039
1537
parent_pipe.send(('function',))
2040
1538
else:
2041
parent_pipe.send(('data', client_object
2042
.__getattribute__(attrname)))
1539
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
2043
1540
2044
1541
if command == 'setattr':
2045
1542
attrname = request[1]
2046
1543
value = request[2]
2047
1544
setattr(client_object, attrname, value)
2048
1545
2049
1546
return True
2050
1547
2051
1548
2052
1549
def string_to_delta(interval):
2053
1550
"""Parse a string and return a datetime.timedelta
2054
1551
2055
>>> string_to_delta('7d')
1552
>>> string_to_delta(u'7d')
2056
1553
datetime.timedelta(7)
2057
>>> string_to_delta('60s')
1554
>>> string_to_delta(u'60s')
2058
1555
datetime.timedelta(0, 60)
2059
>>> string_to_delta('60m')
1556
>>> string_to_delta(u'60m')
2060
1557
datetime.timedelta(0, 3600)
2061
>>> string_to_delta('24h')
1558
>>> string_to_delta(u'24h')
2062
1559
datetime.timedelta(1)
2063
>>> string_to_delta('1w')
1560
>>> string_to_delta(u'1w')
2064
1561
datetime.timedelta(7)
2065
>>> string_to_delta('5m 30s')
1562
>>> string_to_delta(u'5m 30s')
2066
1563
datetime.timedelta(0, 330)
2067
1564
"""
2068
1565
timevalue = datetime.timedelta(0)
2070
1567
try:
2071
1568
suffix = unicode(s[-1])
2072
1569
value = int(s[:-1])
2073
if suffix == "d":
1570
if suffix == u"d":
2074
1571
delta = datetime.timedelta(value)
2075
elif suffix == "s":
1572
elif suffix == u"s":
2076
1573
delta = datetime.timedelta(0, value)
2077
elif suffix == "m":
1574
elif suffix == u"m":
2078
1575
delta = datetime.timedelta(0, 0, 0, 0, value)
2079
elif suffix == "h":
1576
elif suffix == u"h":
2080
1577
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
2081
elif suffix == "w":
1578
elif suffix == u"w":
2082
1579
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2083
1580
else:
2084
raise ValueError("Unknown suffix {0!r}"
2085
.format(suffix))
2086
except (ValueError, IndexError) as e:
2087
raise ValueError(*(e.args))
1581
raise ValueError(u"Unknown suffix %r" % suffix)
1582
except (ValueError, IndexError), e:
1583
raise ValueError(e.message)
2088
1584
timevalue += delta
2089
1585
return timevalue
2090
1586
2091
1587
1588
def if_nametoindex(interface):
1589
"""Call the C function if_nametoindex(), or equivalent
1590
1591
Note: This function cannot accept a unicode string."""
1592
global if_nametoindex
1593
try:
1594
if_nametoindex = (ctypes.cdll.LoadLibrary
1595
(ctypes.util.find_library(u"c"))
1596
.if_nametoindex)
1597
except (OSError, AttributeError):
1598
logger.warning(u"Doing if_nametoindex the hard way")
1599
def if_nametoindex(interface):
1600
"Get an interface index the hard way, i.e. using fcntl()"
1601
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1602
with contextlib.closing(socket.socket()) as s:
1603
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1604
struct.pack(str(u"16s16x"),
1605
interface))
1606
interface_index = struct.unpack(str(u"I"),
1607
ifreq[16:20])[0]
1608
return interface_index
1609
return if_nametoindex(interface)
1610
1611
2092
1612
def daemon(nochdir = False, noclose = False):
2093
1613
"""See daemon(3). Standard BSD Unix function.
2094
1614
2097
1617
sys.exit()
2098
1618
os.setsid()
2099
1619
if not nochdir:
2100
os.chdir("/")
1620
os.chdir(u"/")
2101
1621
if os.fork():
2102
1622
sys.exit()
2103
1623
if not noclose:
2104
1624
# Close all standard open file descriptors
2105
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1625
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2106
1626
if not stat.S_ISCHR(os.fstat(null).st_mode):
2107
1627
raise OSError(errno.ENODEV,
2108
"{0} not a character device"
2109
.format(os.devnull))
1628
u"%s not a character device"
1629
% os.path.devnull)
2110
1630
os.dup2(null, sys.stdin.fileno())
2111
1631
os.dup2(null, sys.stdout.fileno())
2112
1632
os.dup2(null, sys.stderr.fileno())
2119
1639
##################################################################
2120
1640
# Parsing of options, both command line and config file
2121
1641
2122
parser = argparse.ArgumentParser()
2123
parser.add_argument("-v", "--version", action="version",
2124
version = "%(prog)s {0}".format(version),
2125
help="show version number and exit")
2126
parser.add_argument("-i", "--interface", metavar="IF",
2127
help="Bind to interface IF")
2128
parser.add_argument("-a", "--address",
2129
help="Address to listen for requests on")
2130
parser.add_argument("-p", "--port", type=int,
2131
help="Port number to receive requests on")
2132
parser.add_argument("--check", action="store_true",
2133
help="Run self-test")
2134
parser.add_argument("--debug", action="store_true",
2135
help="Debug mode; run in foreground and log"
2136
" to terminal")
2137
parser.add_argument("--debuglevel", metavar="LEVEL",
2138
help="Debug level for stdout output")
2139
parser.add_argument("--priority", help="GnuTLS"
2140
" priority string (see GnuTLS documentation)")
2141
parser.add_argument("--servicename",
2142
metavar="NAME", help="Zeroconf service name")
2143
parser.add_argument("--configdir",
2144
default="/etc/mandos", metavar="DIR",
2145
help="Directory to search for configuration"
2146
" files")
2147
parser.add_argument("--no-dbus", action="store_false",
2148
dest="use_dbus", help="Do not provide D-Bus"
2149
" system bus interface")
2150
parser.add_argument("--no-ipv6", action="store_false",
2151
dest="use_ipv6", help="Do not use IPv6")
2152
parser.add_argument("--no-restore", action="store_false",
2153
dest="restore", help="Do not restore stored"
2154
" state")
2155
parser.add_argument("--statedir", metavar="DIR",
2156
help="Directory to save/restore state in")
2157
2158
options = parser.parse_args()
1642
parser = optparse.OptionParser(version = "%%prog %s" % version)
1643
parser.add_option("-i", u"--interface", type=u"string",
1644
metavar="IF", help=u"Bind to interface IF")
1645
parser.add_option("-a", u"--address", type=u"string",
1646
help=u"Address to listen for requests on")
1647
parser.add_option("-p", u"--port", type=u"int",
1648
help=u"Port number to receive requests on")
1649
parser.add_option("--check", action=u"store_true",
1650
help=u"Run self-test")
1651
parser.add_option("--debug", action=u"store_true",
1652
help=u"Debug mode; run in foreground and log to"
1653
u" terminal")
1654
parser.add_option("--debuglevel", type=u"string", metavar="Level",
1655
help=u"Debug level for stdout output")
1656
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1657
u" priority string (see GnuTLS documentation)")
1658
parser.add_option("--servicename", type=u"string",
1659
metavar=u"NAME", help=u"Zeroconf service name")
1660
parser.add_option("--configdir", type=u"string",
1661
default=u"/etc/mandos", metavar=u"DIR",
1662
help=u"Directory to search for configuration"
1663
u" files")
1664
parser.add_option("--no-dbus", action=u"store_false",
1665
dest=u"use_dbus", help=u"Do not provide D-Bus"
1666
u" system bus interface")
1667
parser.add_option("--no-ipv6", action=u"store_false",
1668
dest=u"use_ipv6", help=u"Do not use IPv6")
1669
options = parser.parse_args()[0]
2159
1670
2160
1671
if options.check:
2161
1672
import doctest
2163
1674
sys.exit()
2164
1675
2165
1676
# Default values for config file for server-global settings
2166
server_defaults = { "interface": "",
2167
"address": "",
2168
"port": "",
2169
"debug": "False",
2170
"priority":
2171
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2172
"servicename": "Mandos",
2173
"use_dbus": "True",
2174
"use_ipv6": "True",
2175
"debuglevel": "",
2176
"restore": "True",
2177
"statedir": "/var/lib/mandos"
1677
server_defaults = { u"interface": u"",
1678
u"address": u"",
1679
u"port": u"",
1680
u"debug": u"False",
1681
u"priority":
1682
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1683
u"servicename": u"Mandos",
1684
u"use_dbus": u"True",
1685
u"use_ipv6": u"True",
1686
u"debuglevel": u"",
2178
1687
}
2179
1688
2180
1689
# Parse config file for server-global settings
2181
1690
server_config = configparser.SafeConfigParser(server_defaults)
2182
1691
del server_defaults
2183
1692
server_config.read(os.path.join(options.configdir,
2184
"mandos.conf"))
1693
u"mandos.conf"))
2185
1694
# Convert the SafeConfigParser object to a dict
2186
1695
server_settings = server_config.defaults()
2187
1696
# Use the appropriate methods on the non-string config options
2188
for option in ("debug", "use_dbus", "use_ipv6"):
2189
server_settings[option] = server_config.getboolean("DEFAULT",
1697
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1698
server_settings[option] = server_config.getboolean(u"DEFAULT",
2190
1699
option)
2191
1700
if server_settings["port"]:
2192
server_settings["port"] = server_config.getint("DEFAULT",
2193
"port")
1701
server_settings["port"] = server_config.getint(u"DEFAULT",
1702
u"port")
2194
1703
del server_config
2195
1704
2196
1705
# Override the settings from the config file with command line
2197
1706
# options, if set.
2198
for option in ("interface", "address", "port", "debug",
2199
"priority", "servicename", "configdir",
2200
"use_dbus", "use_ipv6", "debuglevel", "restore",
2201
"statedir"):
1707
for option in (u"interface", u"address", u"port", u"debug",
1708
u"priority", u"servicename", u"configdir",
1709
u"use_dbus", u"use_ipv6", u"debuglevel"):
2202
1710
value = getattr(options, option)
2203
1711
if value is not None:
2204
1712
server_settings[option] = value
2212
1720
##################################################################
2213
1721
2214
1722
# For convenience
2215
debug = server_settings["debug"]
2216
debuglevel = server_settings["debuglevel"]
2217
use_dbus = server_settings["use_dbus"]
2218
use_ipv6 = server_settings["use_ipv6"]
2219
stored_state_path = os.path.join(server_settings["statedir"],
2220
stored_state_file)
2221
2222
if debug:
2223
initlogger(debug, logging.DEBUG)
2224
else:
2225
if not debuglevel:
2226
initlogger(debug)
2227
else:
2228
level = getattr(logging, debuglevel.upper())
2229
initlogger(debug, level)
2230
2231
if server_settings["servicename"] != "Mandos":
1723
debug = server_settings[u"debug"]
1724
debuglevel = server_settings[u"debuglevel"]
1725
use_dbus = server_settings[u"use_dbus"]
1726
use_ipv6 = server_settings[u"use_ipv6"]
1727
1728
if server_settings[u"servicename"] != u"Mandos":
2232
1729
syslogger.setFormatter(logging.Formatter
2233
('Mandos ({0}) [%(process)d]:'
2234
' %(levelname)s: %(message)s'
2235
.format(server_settings
2236
["servicename"])))
1730
(u'Mandos (%s) [%%(process)d]:'
1731
u' %%(levelname)s: %%(message)s'
1732
% server_settings[u"servicename"]))
2237
1733
2238
1734
# Parse config file with clients
2239
client_config = configparser.SafeConfigParser(Client
2240
.client_defaults)
2241
client_config.read(os.path.join(server_settings["configdir"],
2242
"clients.conf"))
1735
client_defaults = { u"timeout": u"1h",
1736
u"interval": u"5m",
1737
u"checker": u"fping -q -- %%(host)s",
1738
u"host": u"",
1739
u"approval_delay": u"0s",
1740
u"approval_duration": u"1s",
1741
}
1742
client_config = configparser.SafeConfigParser(client_defaults)
1743
client_config.read(os.path.join(server_settings[u"configdir"],
1744
u"clients.conf"))
2243
1745
2244
1746
global mandos_dbus_service
2245
1747
mandos_dbus_service = None
2246
1748
2247
tcp_server = MandosServer((server_settings["address"],
2248
server_settings["port"]),
1749
tcp_server = MandosServer((server_settings[u"address"],
1750
server_settings[u"port"]),
2249
1751
ClientHandler,
2250
interface=(server_settings["interface"]
1752
interface=(server_settings[u"interface"]
2251
1753
or None),
2252
1754
use_ipv6=use_ipv6,
2253
1755
gnutls_priority=
2254
server_settings["priority"],
1756
server_settings[u"priority"],
2255
1757
use_dbus=use_dbus)
2256
if not debug:
2257
pidfilename = "/var/run/mandos.pid"
2258
try:
2259
pidfile = open(pidfilename, "w")
2260
except IOError as e:
2261
logger.error("Could not open file %r", pidfilename,
2262
exc_info=e)
1758
pidfilename = u"/var/run/mandos.pid"
1759
try:
1760
pidfile = open(pidfilename, u"w")
1761
except IOError:
1762
logger.error(u"Could not open file %r", pidfilename)
2263
1763
2264
for name in ("_mandos", "mandos", "nobody"):
1764
try:
1765
uid = pwd.getpwnam(u"_mandos").pw_uid
1766
gid = pwd.getpwnam(u"_mandos").pw_gid
1767
except KeyError:
2265
1768
try:
2266
uid = pwd.getpwnam(name).pw_uid
2267
gid = pwd.getpwnam(name).pw_gid
2268
break
1769
uid = pwd.getpwnam(u"mandos").pw_uid
1770
gid = pwd.getpwnam(u"mandos").pw_gid
2269
1771
except KeyError:
2270
continue
2271
else:
2272
uid = 65534
2273
gid = 65534
1772
try:
1773
uid = pwd.getpwnam(u"nobody").pw_uid
1774
gid = pwd.getpwnam(u"nobody").pw_gid
1775
except KeyError:
1776
uid = 65534
1777
gid = 65534
2274
1778
try:
2275
1779
os.setgid(gid)
2276
1780
os.setuid(uid)
2277
except OSError as error:
1781
except OSError, error:
2278
1782
if error[0] != errno.EPERM:
2279
1783
raise error
2280
1784
1785
if not debug and not debuglevel:
1786
syslogger.setLevel(logging.WARNING)
1787
console.setLevel(logging.WARNING)
1788
if debuglevel:
1789
level = getattr(logging, debuglevel.upper())
1790
syslogger.setLevel(level)
1791
console.setLevel(level)
1792
2281
1793
if debug:
2282
1794
# Enable all possible GnuTLS debugging
2283
1795
2287
1799
2288
1800
@gnutls.library.types.gnutls_log_func
2289
1801
def debug_gnutls(level, string):
2290
logger.debug("GnuTLS: %s", string[:-1])
1802
logger.debug(u"GnuTLS: %s", string[:-1])
2291
1803
2292
1804
(gnutls.library.functions
2293
1805
.gnutls_global_set_log_function(debug_gnutls))
2294
1806
2295
1807
# Redirect stdin so all checkers get /dev/null
2296
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1808
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2297
1809
os.dup2(null, sys.stdin.fileno())
2298
1810
if null > 2:
2299
1811
os.close(null)
2300
2301
# Need to fork before connecting to D-Bus
2302
if not debug:
2303
# Close all input and output, do double fork, etc.
2304
daemon()
2305
2306
gobject.threads_init()
1812
else:
1813
# No console logging
1814
logger.removeHandler(console)
1815
2307
1816
2308
1817
global main_loop
2309
1818
# From the Avahi example code
2310
DBusGMainLoop(set_as_default=True)
1819
DBusGMainLoop(set_as_default=True )
2311
1820
main_loop = gobject.MainLoop()
2312
1821
bus = dbus.SystemBus()
2313
1822
# End of Avahi example code
2314
1823
if use_dbus:
2315
1824
try:
2316
bus_name = dbus.service.BusName("se.recompile.Mandos",
1825
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
2317
1826
bus, do_not_queue=True)
2318
old_bus_name = (dbus.service.BusName
2319
("se.bsnet.fukt.Mandos", bus,
2320
do_not_queue=True))
2321
except dbus.exceptions.NameExistsException as e:
2322
logger.error("Disabling D-Bus:", exc_info=e)
1827
except dbus.exceptions.NameExistsException, e:
1828
logger.error(unicode(e) + u", disabling D-Bus")
2323
1829
use_dbus = False
2324
server_settings["use_dbus"] = False
1830
server_settings[u"use_dbus"] = False
2325
1831
tcp_server.use_dbus = False
2326
1832
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2327
service = AvahiServiceToSyslog(name =
2328
server_settings["servicename"],
2329
servicetype = "_mandos._tcp",
2330
protocol = protocol, bus = bus)
1833
service = AvahiService(name = server_settings[u"servicename"],
1834
servicetype = u"_mandos._tcp",
1835
protocol = protocol, bus = bus)
2331
1836
if server_settings["interface"]:
2332
1837
service.interface = (if_nametoindex
2333
(str(server_settings["interface"])))
2334
1838
(str(server_settings[u"interface"])))
1839
1840
if not debug:
1841
# Close all input and output, do double fork, etc.
1842
daemon()
1843
2335
1844
global multiprocessing_manager
2336
1845
multiprocessing_manager = multiprocessing.Manager()
2337
1846
2338
1847
client_class = Client
2339
1848
if use_dbus:
2340
client_class = functools.partial(ClientDBusTransitional,
2341
bus = bus)
2342
2343
client_settings = Client.config_parser(client_config)
2344
old_client_settings = {}
2345
clients_data = {}
2346
2347
# Get client data and settings from last running state.
2348
if server_settings["restore"]:
2349
try:
2350
with open(stored_state_path, "rb") as stored_state:
2351
clients_data, old_client_settings = (pickle.load
2352
(stored_state))
2353
os.remove(stored_state_path)
2354
except IOError as e:
2355
if e.errno == errno.ENOENT:
2356
logger.warning("Could not load persistent state: {0}"
2357
.format(os.strerror(e.errno)))
2358
else:
2359
logger.critical("Could not load persistent state:",
2360
exc_info=e)
2361
raise
2362
except EOFError as e:
2363
logger.warning("Could not load persistent state: "
2364
"EOFError:", exc_info=e)
2365
2366
with PGPEngine() as pgp:
2367
for client_name, client in clients_data.iteritems():
2368
# Decide which value to use after restoring saved state.
2369
# We have three different values: Old config file,
2370
# new config file, and saved state.
2371
# New config value takes precedence if it differs from old
2372
# config value, otherwise use saved state.
2373
for name, value in client_settings[client_name].items():
2374
try:
2375
# For each value in new config, check if it
2376
# differs from the old config value (Except for
2377
# the "secret" attribute)
2378
if (name != "secret" and
2379
value != old_client_settings[client_name]
2380
[name]):
2381
client[name] = value
2382
except KeyError:
2383
pass
2384
2385
# Clients who has passed its expire date can still be
2386
# enabled if its last checker was successful. Clients
2387
# whose checker succeeded before we stored its state is
2388
# assumed to have successfully run all checkers during
2389
# downtime.
2390
if client["enabled"]:
2391
if datetime.datetime.utcnow() >= client["expires"]:
2392
if not client["last_checked_ok"]:
2393
logger.warning(
2394
"disabling client {0} - Client never "
2395
"performed a successful checker"
2396
.format(client_name))
2397
client["enabled"] = False
2398
elif client["last_checker_status"] != 0:
2399
logger.warning(
2400
"disabling client {0} - Client "
2401
"last checker failed with error code {1}"
2402
.format(client_name,
2403
client["last_checker_status"]))
2404
client["enabled"] = False
2405
else:
2406
client["expires"] = (datetime.datetime
2407
.utcnow()
2408
+ client["timeout"])
2409
logger.debug("Last checker succeeded,"
2410
" keeping {0} enabled"
2411
.format(client_name))
1849
client_class = functools.partial(ClientDBus, bus = bus)
1850
def client_config_items(config, section):
1851
special_settings = {
1852
"approved_by_default":
1853
lambda: config.getboolean(section,
1854
"approved_by_default"),
1855
}
1856
for name, value in config.items(section):
2412
1857
try:
2413
client["secret"] = (
2414
pgp.decrypt(client["encrypted_secret"],
2415
client_settings[client_name]
2416
["secret"]))
2417
except PGPError:
2418
# If decryption fails, we use secret from new settings
2419
logger.debug("Failed to decrypt {0} old secret"
2420
.format(client_name))
2421
client["secret"] = (
2422
client_settings[client_name]["secret"])
2423
2424
# Add/remove clients based on new changes made to config
2425
for client_name in (set(old_client_settings)
2426
- set(client_settings)):
2427
del clients_data[client_name]
2428
for client_name in (set(client_settings)
2429
- set(old_client_settings)):
2430
clients_data[client_name] = client_settings[client_name]
2431
2432
# Create all client objects
2433
for client_name, client in clients_data.iteritems():
2434
tcp_server.clients[client_name] = client_class(
2435
name = client_name, settings = client)
2436
1858
yield (name, special_settings[name]())
1859
except KeyError:
1860
yield (name, value)
1861
1862
tcp_server.clients.update(set(
1863
client_class(name = section,
1864
config= dict(client_config_items(
1865
client_config, section)))
1866
for section in client_config.sections()))
2437
1867
if not tcp_server.clients:
2438
logger.warning("No clients defined")
1868
logger.warning(u"No clients defined")
1869
1870
try:
1871
with pidfile:
1872
pid = os.getpid()
1873
pidfile.write(str(pid) + "\n")
1874
del pidfile
1875
except IOError:
1876
logger.error(u"Could not write to file %r with PID %d",
1877
pidfilename, pid)
1878
except NameError:
1879
# "pidfile" was never created
1880
pass
1881
del pidfilename
2439
1882
2440
1883
if not debug:
2441
try:
2442
with pidfile:
2443
pid = os.getpid()
2444
pidfile.write(str(pid) + "\n".encode("utf-8"))
2445
del pidfile
2446
except IOError:
2447
logger.error("Could not write to file %r with PID %d",
2448
pidfilename, pid)
2449
except NameError:
2450
# "pidfile" was never created
2451
pass
2452
del pidfilename
2453
1884
signal.signal(signal.SIGINT, signal.SIG_IGN)
2454
2455
1885
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2456
1886
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2457
1887
2458
1888
if use_dbus:
2459
class MandosDBusService(DBusObjectWithProperties):
1889
class MandosDBusService(dbus.service.Object):
2460
1890
"""A D-Bus proxy object"""
2461
1891
def __init__(self):
2462
dbus.service.Object.__init__(self, bus, "/")
2463
_interface = "se.recompile.Mandos"
2464
2465
@dbus_interface_annotations(_interface)
2466
def _foo(self):
2467
return { "org.freedesktop.DBus.Property"
2468
".EmitsChangedSignal":
2469
"false"}
2470
2471
@dbus.service.signal(_interface, signature="o")
1892
dbus.service.Object.__init__(self, bus, u"/")
1893
_interface = u"se.bsnet.fukt.Mandos"
1894
1895
@dbus.service.signal(_interface, signature=u"o")
2472
1896
def ClientAdded(self, objpath):
2473
1897
"D-Bus signal"
2474
1898
pass
2475
1899
2476
@dbus.service.signal(_interface, signature="ss")
1900
@dbus.service.signal(_interface, signature=u"ss")
2477
1901
def ClientNotFound(self, fingerprint, address):
2478
1902
"D-Bus signal"
2479
1903
pass
2480
1904
2481
@dbus.service.signal(_interface, signature="os")
1905
@dbus.service.signal(_interface, signature=u"os")
2482
1906
def ClientRemoved(self, objpath, name):
2483
1907
"D-Bus signal"
2484
1908
pass
2485
1909
2486
@dbus.service.method(_interface, out_signature="ao")
1910
@dbus.service.method(_interface, out_signature=u"ao")
2487
1911
def GetAllClients(self):
2488
1912
"D-Bus method"
2489
1913
return dbus.Array(c.dbus_object_path
2490
for c in
2491
tcp_server.clients.itervalues())
1914
for c in tcp_server.clients)
2492
1915
2493
1916
@dbus.service.method(_interface,
2494
out_signature="a{oa{sv}}")
1917
out_signature=u"a{oa{sv}}")
2495
1918
def GetAllClientsWithProperties(self):
2496
1919
"D-Bus method"
2497
1920
return dbus.Dictionary(
2498
((c.dbus_object_path, c.GetAll(""))
2499
for c in tcp_server.clients.itervalues()),
2500
signature="oa{sv}")
1921
((c.dbus_object_path, c.GetAll(u""))
1922
for c in tcp_server.clients),
1923
signature=u"oa{sv}")
2501
1924
2502
@dbus.service.method(_interface, in_signature="o")
1925
@dbus.service.method(_interface, in_signature=u"o")
2503
1926
def RemoveClient(self, object_path):
2504
1927
"D-Bus method"
2505
for c in tcp_server.clients.itervalues():
1928
for c in tcp_server.clients:
2506
1929
if c.dbus_object_path == object_path:
2507
del tcp_server.clients[c.name]
1930
tcp_server.clients.remove(c)
2508
1931
c.remove_from_connection()
2509
1932
# Don't signal anything except ClientRemoved
2510
1933
c.disable(quiet=True)
2515
1938
2516
1939
del _interface
2517
1940
2518
class MandosDBusServiceTransitional(MandosDBusService):
2519
__metaclass__ = AlternateDBusNamesMetaclass
2520
mandos_dbus_service = MandosDBusServiceTransitional()
1941
mandos_dbus_service = MandosDBusService()
2521
1942
2522
1943
def cleanup():
2523
1944
"Cleanup function; run on exit"
2524
1945
service.cleanup()
2525
1946
2526
multiprocessing.active_children()
2527
if not (tcp_server.clients or client_settings):
2528
return
2529
2530
# Store client before exiting. Secrets are encrypted with key
2531
# based on what config file has. If config file is
2532
# removed/edited, old secret will thus be unrecovable.
2533
clients = {}
2534
with PGPEngine() as pgp:
2535
for client in tcp_server.clients.itervalues():
2536
key = client_settings[client.name]["secret"]
2537
client.encrypted_secret = pgp.encrypt(client.secret,
2538
key)
2539
client_dict = {}
2540
2541
# A list of attributes that can not be pickled
2542
# + secret.
2543
exclude = set(("bus", "changedstate", "secret",
2544
"checker"))
2545
for name, typ in (inspect.getmembers
2546
(dbus.service.Object)):
2547
exclude.add(name)
2548
2549
client_dict["encrypted_secret"] = (client
2550
.encrypted_secret)
2551
for attr in client.client_structure:
2552
if attr not in exclude:
2553
client_dict[attr] = getattr(client, attr)
2554
2555
clients[client.name] = client_dict
2556
del client_settings[client.name]["secret"]
2557
2558
try:
2559
tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2560
prefix="clients-",
2561
dir=os.path.dirname
2562
(stored_state_path))
2563
with os.fdopen(tempfd, "wb") as stored_state:
2564
pickle.dump((clients, client_settings), stored_state)
2565
os.rename(tempname, stored_state_path)
2566
except (IOError, OSError) as e:
2567
if not debug:
2568
try:
2569
os.remove(tempname)
2570
except NameError:
2571
pass
2572
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2573
logger.warning("Could not save persistent state: {0}"
2574
.format(os.strerror(e.errno)))
2575
else:
2576
logger.warning("Could not save persistent state:",
2577
exc_info=e)
2578
raise e
2579
2580
# Delete all clients, and settings from config
2581
1947
while tcp_server.clients:
2582
name, client = tcp_server.clients.popitem()
1948
client = tcp_server.clients.pop()
2583
1949
if use_dbus:
2584
1950
client.remove_from_connection()
1951
client.disable_hook = None
2585
1952
# Don't signal anything except ClientRemoved
2586
1953
client.disable(quiet=True)
2587
1954
if use_dbus:
2588
1955
# Emit D-Bus signal
2589
mandos_dbus_service.ClientRemoved(client
2590
.dbus_object_path,
1956
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
2591
1957
client.name)
2592
client_settings.clear()
2593
1958
2594
1959
atexit.register(cleanup)
2595
1960
2596
for client in tcp_server.clients.itervalues():
1961
for client in tcp_server.clients:
2597
1962
if use_dbus:
2598
1963
# Emit D-Bus signal
2599
1964
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2600
# Need to initiate checking of clients
2601
if client.enabled:
2602
client.init_checker()
1965
client.enable()
2603
1966
2604
1967
tcp_server.enable()
2605
1968
tcp_server.server_activate()
2607
1970
# Find out what port we got
2608
1971
service.port = tcp_server.socket.getsockname()[1]
2609
1972
if use_ipv6:
2610
logger.info("Now listening on address %r, port %d,"
2611
" flowinfo %d, scope_id %d",
2612
*tcp_server.socket.getsockname())
1973
logger.info(u"Now listening on address %r, port %d,"
1974
" flowinfo %d, scope_id %d"
1975
% tcp_server.socket.getsockname())
2613
1976
else: # IPv4
2614
logger.info("Now listening on address %r, port %d",
2615
*tcp_server.socket.getsockname())
1977
logger.info(u"Now listening on address %r, port %d"
1978
% tcp_server.socket.getsockname())
2616
1979
2617
1980
#service.interface = tcp_server.socket.getsockname()[3]
2618
1981
2620
1983
# From the Avahi example code
2621
1984
try:
2622
1985
service.activate()
2623
except dbus.exceptions.DBusException as error:
2624
logger.critical("D-Bus Exception", exc_info=error)
1986
except dbus.exceptions.DBusException, error:
1987
logger.critical(u"DBusException: %s", error)
2625
1988
cleanup()
2626
1989
sys.exit(1)
2627
1990
# End of Avahi example code
2631
1994
(tcp_server.handle_request
2632
1995
(*args[2:], **kwargs) or True))
2633
1996
2634
logger.debug("Starting main loop")
1997
logger.debug(u"Starting main loop")
2635
1998
main_loop.run()
2636
except AvahiError as error:
2637
logger.critical("Avahi Error", exc_info=error)
1999
except AvahiError, error:
2000
logger.critical(u"AvahiError: %s", error)
2638
2001
cleanup()
2639
2002
sys.exit(1)
2640
2003
except KeyboardInterrupt:
2641
2004
if debug:
2642
print("", file=sys.stderr)
2643
logger.debug("Server received KeyboardInterrupt")
2644
logger.debug("Server exiting")
2005
print >> sys.stderr
2006
logger.debug(u"Server received KeyboardInterrupt")
2007
logger.debug(u"Server exiting")
2645
2008
# Must run before the D-Bus bus name gets deregistered
2646
2009
cleanup()
2647
2010
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0