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