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 416.1.1
- compare with another revision
- download diff
- download tarball
- view history from revision 416.1.1
- Committer: Teddy Hogeborn
- Date: 2010-04-14 06:36:36 UTC
- mto: (24.1.149 mandos)
- mto: This revision was merged to the branch mainline in revision 417.
- Revision ID: teddy@fukt.bsnet.se-20100414063636-v93vjajwrnlsqj9u
Initial design on approval system.
- files removed:
- DBUS-API
- 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
61
60
import fcntl
62
61
import functools
63
62
import cPickle as pickle
64
import multiprocessing
65
import types
66
import binascii
67
import tempfile
68
import itertools
69
63
70
64
import dbus
71
65
import dbus.service
76
70
import ctypes.util
77
71
import xml.dom.minidom
78
72
import inspect
79
import GnuPGInterface
80
73
81
74
try:
82
75
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
86
79
except ImportError:
87
80
SO_BINDTODEVICE = None
88
81
89
version = "1.5.3"
90
stored_state_file = "clients.pickle"
91
92
logger = logging.getLogger()
82
83
version = "1.0.14"
84
85
logger = logging.Logger(u'mandos')
93
86
syslogger = (logging.handlers.SysLogHandler
94
87
(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
88
address = "/dev/log"))
89
syslogger.setFormatter(logging.Formatter
90
(u'Mandos [%(process)d]: %(levelname)s:'
91
u' %(message)s'))
92
logger.addHandler(syslogger)
93
94
console = logging.StreamHandler()
95
console.setFormatter(logging.Formatter(u'%(name)s [%(process)d]:'
96
u' %(levelname)s:'
97
u' %(message)s'))
98
logger.addHandler(console)
212
99
213
100
class AvahiError(Exception):
214
101
def __init__(self, value, *args, **kwargs):
230
117
Attributes:
231
118
interface: integer; avahi.IF_UNSPEC or an interface index.
232
119
Used to optionally bind to the specified interface.
233
name: string; Example: 'Mandos'
234
type: string; Example: '_mandos._tcp'.
120
name: string; Example: u'Mandos'
121
type: string; Example: u'_mandos._tcp'.
235
122
See <http://www.dns-sd.org/ServiceTypes.html>
236
123
port: integer; what port to announce
237
124
TXT: list of strings; TXT record for the service
246
133
"""
247
134
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
248
135
servicetype = None, port = None, TXT = None,
249
domain = "", host = "", max_renames = 32768,
136
domain = u"", host = u"", max_renames = 32768,
250
137
protocol = avahi.PROTO_UNSPEC, bus = None):
251
138
self.interface = interface
252
139
self.name = name
261
148
self.group = None # our entry group
262
149
self.server = None
263
150
self.bus = bus
264
self.entry_group_state_changed_match = None
265
151
def rename(self):
266
152
"""Derived from the Avahi example code"""
267
153
if self.rename_count >= self.max_renames:
268
logger.critical("No suitable Zeroconf service name found"
269
" after %i retries, exiting.",
154
logger.critical(u"No suitable Zeroconf service name found"
155
u" after %i retries, exiting.",
270
156
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 ...",
275
self.name)
157
raise AvahiServiceError(u"Too many renames")
158
self.name = self.server.GetAlternativeServiceName(self.name)
159
logger.info(u"Changing Zeroconf service name to %r ...",
160
unicode(self.name))
161
syslogger.setFormatter(logging.Formatter
162
(u'Mandos (%s) [%%(process)d]:'
163
u' %%(levelname)s: %%(message)s'
164
% self.name))
276
165
self.remove()
277
try:
278
self.add()
279
except dbus.exceptions.DBusException as error:
280
logger.critical("D-Bus Exception", exc_info=error)
281
self.cleanup()
282
os._exit(1)
166
self.add()
283
167
self.rename_count += 1
284
168
def remove(self):
285
169
"""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
170
if self.group is not None:
290
171
self.group.Reset()
291
172
def add(self):
292
173
"""Derived from the Avahi example code"""
293
self.remove()
294
174
if self.group is None:
295
175
self.group = dbus.Interface(
296
176
self.bus.get_object(avahi.DBUS_NAME,
297
177
self.server.EntryGroupNew()),
298
178
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' ...",
179
self.group.connect_to_signal('StateChanged',
180
self
181
.entry_group_state_changed)
182
logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
303
183
self.name, self.type)
304
184
self.group.AddService(
305
185
self.interface,
312
192
self.group.Commit()
313
193
def entry_group_state_changed(self, state, error):
314
194
"""Derived from the Avahi example code"""
315
logger.debug("Avahi entry group state change: %i", state)
195
logger.debug(u"Avahi state change: %i", state)
316
196
317
197
if state == avahi.ENTRY_GROUP_ESTABLISHED:
318
logger.debug("Zeroconf service established.")
198
logger.debug(u"Zeroconf service established.")
319
199
elif state == avahi.ENTRY_GROUP_COLLISION:
320
logger.info("Zeroconf service name collision.")
200
logger.warning(u"Zeroconf service name collision.")
321
201
self.rename()
322
202
elif state == avahi.ENTRY_GROUP_FAILURE:
323
logger.critical("Avahi: Error in group state changed %s",
203
logger.critical(u"Avahi: Error in group state changed %s",
324
204
unicode(error))
325
raise AvahiGroupError("State changed: {0!s}"
326
.format(error))
205
raise AvahiGroupError(u"State changed: %s"
206
% unicode(error))
327
207
def cleanup(self):
328
208
"""Derived from the Avahi example code"""
329
209
if self.group is not None:
330
try:
331
self.group.Free()
332
except (dbus.exceptions.UnknownMethodException,
333
dbus.exceptions.DBusException):
334
pass
210
self.group.Free()
335
211
self.group = None
336
self.remove()
337
def server_state_changed(self, state, error=None):
212
def server_state_changed(self, state):
338
213
"""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()
214
if state == avahi.SERVER_COLLISION:
215
logger.error(u"Zeroconf server name collision")
216
self.remove()
354
217
elif state == avahi.SERVER_RUNNING:
355
218
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
219
def activate(self):
362
220
"""Derived from the Avahi example code"""
363
221
if self.server is None:
364
222
self.server = dbus.Interface(
365
223
self.bus.get_object(avahi.DBUS_NAME,
366
avahi.DBUS_PATH_SERVER,
367
follow_name_owner_changes=True),
224
avahi.DBUS_PATH_SERVER),
368
225
avahi.DBUS_INTERFACE_SERVER)
369
self.server.connect_to_signal("StateChanged",
226
self.server.connect_to_signal(u"StateChanged",
370
227
self.server_state_changed)
371
228
self.server_state_changed(self.server.GetState())
372
229
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
230
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
231
class Client(object):
390
232
"""A representation of a client host served by this server.
391
233
392
234
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
235
name: string; from the config file, used in log messages and
236
D-Bus identifiers
237
fingerprint: string (40 or 32 hexadecimal digits); used to
238
uniquely identify the client
239
secret: bytestring; sent verbatim (over TLS) to client
240
host: string; available for use by the checker command
241
created: datetime.datetime(); (UTC) object creation
242
last_enabled: datetime.datetime(); (UTC)
243
enabled: bool()
244
last_checked_ok: datetime.datetime(); (UTC) or None
245
timeout: datetime.timedelta(); How long from last_checked_ok
246
until this client is disabled
247
interval: datetime.timedelta(); How often to start a new checker
248
disable_hook: If set, called by disable() as disable_hook(self)
396
249
checker: subprocess.Popen(); a running checker process used
397
250
to see if the client lives.
398
251
'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
252
checker_initiator_tag: a gobject event source tag, or None
253
disable_initiator_tag: - '' -
254
checker_callback_tag: - '' -
255
checker_command: string; External command which is run to check if
256
client lives. %() expansions are done at
402
257
runtime with vars(self) as dict, so that for
403
258
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
259
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
430
260
"""
431
261
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
}
262
@staticmethod
263
def _timedelta_to_milliseconds(td):
264
"Convert a datetime.timedelta() to milliseconds"
265
return ((td.days * 24 * 60 * 60 * 1000)
266
+ (td.seconds * 1000)
267
+ (td.microseconds // 1000))
446
268
447
269
def timeout_milliseconds(self):
448
270
"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)
271
return self._timedelta_to_milliseconds(self.timeout)
454
272
455
273
def interval_milliseconds(self):
456
274
"Return the 'interval' attribute in milliseconds"
457
return timedelta_to_milliseconds(self.interval)
275
return self._timedelta_to_milliseconds(self.interval)
458
276
459
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):
277
def __init__(self, name = None, disable_hook=None, config=None):
511
278
"""Note: the 'checker' key in 'config' sets the
512
279
'checker_command' attribute and *not* the 'checker'
513
280
attribute."""
514
281
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)
282
if config is None:
283
config = {}
284
logger.debug(u"Creating client %r", self.name)
530
285
# Uppercase and remove spaces from fingerprint for later
531
286
# comparison purposes with return value from the fingerprint()
532
287
# 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
288
self.fingerprint = (config[u"fingerprint"].upper()
289
.replace(u" ", u""))
290
logger.debug(u" Fingerprint: %s", self.fingerprint)
291
if u"secret" in config:
292
self.secret = config[u"secret"].decode(u"base64")
293
elif u"secfile" in config:
294
with open(os.path.expanduser(os.path.expandvars
295
(config[u"secfile"])),
296
"rb") as secfile:
297
self.secret = secfile.read()
298
else:
299
raise TypeError(u"No secret or secfile for client %s"
300
% self.name)
301
self.host = config.get(u"host", u"")
302
self.created = datetime.datetime.utcnow()
303
self.enabled = False
304
self.last_enabled = None
305
self.last_checked_ok = None
306
self.timeout = string_to_delta(config[u"timeout"])
307
self.interval = string_to_delta(config[u"interval"])
308
self.disable_hook = disable_hook
538
309
self.checker = None
539
310
self.checker_initiator_tag = None
540
311
self.disable_initiator_tag = None
541
312
self.checker_callback_tag = None
313
self.checker_command = config[u"checker"]
542
314
self.current_checker_command = None
543
self.approved = None
544
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)
559
560
# Send notice to process children that client state has changed
561
def send_changedstate(self):
562
with self.changedstate:
563
self.changedstate.notify_all()
315
self.last_connect = None
564
316
565
317
def enable(self):
566
318
"""Start this client's checker and timeout hooks"""
567
if getattr(self, "enabled", False):
319
if getattr(self, u"enabled", False):
568
320
# Already enabled
569
321
return
570
self.send_changedstate()
571
self.expires = datetime.datetime.utcnow() + self.timeout
572
self.enabled = True
573
322
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
323
# Schedule a new checker to be started an 'interval' from now,
601
324
# and every interval from then on.
602
325
self.checker_initiator_tag = (gobject.timeout_add
606
329
self.disable_initiator_tag = (gobject.timeout_add
607
330
(self.timeout_milliseconds(),
608
331
self.disable))
332
self.enabled = True
609
333
# Also start a new checker *right now*.
610
334
self.start_checker()
611
335
336
def disable(self, quiet=True):
337
"""Disable this client."""
338
if not getattr(self, "enabled", False):
339
return False
340
if not quiet:
341
logger.info(u"Disabling client %s", self.name)
342
if getattr(self, u"disable_initiator_tag", False):
343
gobject.source_remove(self.disable_initiator_tag)
344
self.disable_initiator_tag = None
345
if getattr(self, u"checker_initiator_tag", False):
346
gobject.source_remove(self.checker_initiator_tag)
347
self.checker_initiator_tag = None
348
self.stop_checker()
349
if self.disable_hook:
350
self.disable_hook(self)
351
self.enabled = False
352
# Do not run this again if called by a gobject.timeout_add
353
return False
354
355
def __del__(self):
356
self.disable_hook = None
357
self.disable()
358
612
359
def checker_callback(self, pid, condition, command):
613
360
"""The checker has completed, so take appropriate actions."""
614
361
self.checker_callback_tag = None
615
362
self.checker = None
616
363
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",
364
exitstatus = os.WEXITSTATUS(condition)
365
if exitstatus == 0:
366
logger.info(u"Checker for %(name)s succeeded",
620
367
vars(self))
621
368
self.checked_ok()
622
369
else:
623
logger.info("Checker for %(name)s failed",
370
logger.info(u"Checker for %(name)s failed",
624
371
vars(self))
625
372
else:
626
self.last_checker_status = -1
627
logger.warning("Checker for %(name)s crashed?",
373
logger.warning(u"Checker for %(name)s crashed?",
628
374
vars(self))
629
375
630
376
def checked_ok(self):
631
"""Assert that the client has been seen, alive and well."""
377
"""Bump up the timeout for this client.
378
379
This should only be called when the client has been seen,
380
alive and well.
381
"""
632
382
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()
383
gobject.source_remove(self.disable_initiator_tag)
384
self.disable_initiator_tag = (gobject.timeout_add
385
(self.timeout_milliseconds(),
386
self.disable))
650
387
651
388
def start_checker(self):
652
389
"""Start a new checker subprocess if one is not running.
665
402
# If a checker exists, make sure it is not a zombie
666
403
try:
667
404
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
668
except (AttributeError, OSError) as error:
405
except (AttributeError, OSError), error:
669
406
if (isinstance(error, OSError)
670
407
and error.errno != errno.ECHILD):
671
408
raise error
672
409
else:
673
410
if pid:
674
logger.warning("Checker was a zombie")
411
logger.warning(u"Checker was a zombie")
675
412
gobject.source_remove(self.checker_callback_tag)
676
413
self.checker_callback(pid, status,
677
414
self.current_checker_command)
682
419
command = self.checker_command % self.host
683
420
except TypeError:
684
421
# 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
422
escaped_attrs = dict((key,
423
re.escape(unicode(str(val),
424
errors=
425
u'replace')))
426
for key, val in
427
vars(self).iteritems())
693
428
try:
694
429
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)
430
except TypeError, error:
431
logger.error(u'Could not format string "%s":'
432
u' %s', self.checker_command, error)
698
433
return True # Try again later
699
434
self.current_checker_command = command
700
435
try:
701
logger.info("Starting checker %r for %s",
436
logger.info(u"Starting checker %r for %s",
702
437
command, self.name)
703
438
# We don't need to redirect stdout and stderr, since
704
439
# in normal mode, that is already done by daemon(),
706
441
# always replaced by /dev/null.)
707
442
self.checker = subprocess.Popen(command,
708
443
close_fds=True,
709
shell=True, cwd="/")
444
shell=True, cwd=u"/")
710
445
self.checker_callback_tag = (gobject.child_watch_add
711
446
(self.checker.pid,
712
447
self.checker_callback,
717
452
if pid:
718
453
gobject.source_remove(self.checker_callback_tag)
719
454
self.checker_callback(pid, status, command)
720
except OSError as error:
721
logger.error("Failed to start subprocess",
722
exc_info=error)
455
except OSError, error:
456
logger.error(u"Failed to start subprocess: %s",
457
error)
723
458
# Re-run this periodically if run by gobject.timeout_add
724
459
return True
725
460
728
463
if self.checker_callback_tag:
729
464
gobject.source_remove(self.checker_callback_tag)
730
465
self.checker_callback_tag = None
731
if getattr(self, "checker", None) is None:
466
if getattr(self, u"checker", None) is None:
732
467
return
733
logger.debug("Stopping checker for %(name)s", vars(self))
468
logger.debug(u"Stopping checker for %(name)s", vars(self))
734
469
try:
735
self.checker.terminate()
470
os.kill(self.checker.pid, signal.SIGTERM)
736
471
#time.sleep(0.5)
737
472
#if self.checker.poll() is None:
738
# self.checker.kill()
739
except OSError as error:
473
# os.kill(self.checker.pid, signal.SIGKILL)
474
except OSError, error:
740
475
if error.errno != errno.ESRCH: # No such process
741
476
raise
742
477
self.checker = None
743
478
744
479
745
def dbus_service_property(dbus_interface, signature="v",
746
access="readwrite", byte_arrays=False):
480
def dbus_service_property(dbus_interface, signature=u"v",
481
access=u"readwrite", byte_arrays=False):
747
482
"""Decorators for marking methods of a DBusObjectWithProperties to
748
483
become properties on the D-Bus.
749
484
756
491
"""
757
492
# Encoding deeply encoded byte arrays is not supported yet by the
758
493
# "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))
494
if byte_arrays and signature != u"ay":
495
raise ValueError(u"Byte arrays not supported for non-'ay'"
496
u" signature %r" % signature)
762
497
def decorator(func):
763
498
func._dbus_is_property = True
764
499
func._dbus_interface = dbus_interface
765
500
func._dbus_signature = signature
766
501
func._dbus_access = access
767
502
func._dbus_name = func.__name__
768
if func._dbus_name.endswith("_dbus_property"):
503
if func._dbus_name.endswith(u"_dbus_property"):
769
504
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
505
func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
808
506
return func
809
507
return decorator
810
508
830
528
831
529
class DBusObjectWithProperties(dbus.service.Object):
832
530
"""A D-Bus object with properties.
833
531
834
532
Classes inheriting from this can use the dbus_service_property
835
533
decorator to expose methods as D-Bus properties. It exposes the
836
534
standard Get(), Set(), and GetAll() methods on the D-Bus.
837
535
"""
838
536
839
537
@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)
538
def _is_dbus_property(obj):
539
return getattr(obj, u"_dbus_is_property", False)
848
540
849
def _get_all_dbus_things(self, thing):
541
def _get_all_dbus_properties(self):
850
542
"""Returns a generator of (name, attribute) pairs
851
543
"""
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)))
544
return ((prop._dbus_name, prop)
545
for name, prop in
546
inspect.getmembers(self, self._is_dbus_property))
859
547
860
548
def _get_dbus_property(self, interface_name, property_name):
861
549
"""Returns a bound method if one exists which is a D-Bus
862
550
property with the specified name and interface.
863
551
"""
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
552
for name in (property_name,
553
property_name + u"_dbus_property"):
554
prop = getattr(self, name, None)
555
if (prop is None
556
or not self._is_dbus_property(prop)
557
or prop._dbus_name != property_name
558
or (interface_name and prop._dbus_interface
559
and interface_name != prop._dbus_interface)):
560
continue
561
return prop
872
562
# No such property
873
raise DBusPropertyNotFound(self.dbus_object_path + ":"
874
+ interface_name + "."
563
raise DBusPropertyNotFound(self.dbus_object_path + u":"
564
+ interface_name + u"."
875
565
+ property_name)
876
566
877
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
878
out_signature="v")
567
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
568
out_signature=u"v")
879
569
def Get(self, interface_name, property_name):
880
570
"""Standard D-Bus property Get() method, see D-Bus standard.
881
571
"""
882
572
prop = self._get_dbus_property(interface_name, property_name)
883
if prop._dbus_access == "write":
573
if prop._dbus_access == u"write":
884
574
raise DBusPropertyAccessException(property_name)
885
575
value = prop()
886
if not hasattr(value, "variant_level"):
576
if not hasattr(value, u"variant_level"):
887
577
return value
888
578
return type(value)(value, variant_level=value.variant_level+1)
889
579
890
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
580
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
891
581
def Set(self, interface_name, property_name, value):
892
582
"""Standard D-Bus property Set() method, see D-Bus standard.
893
583
"""
894
584
prop = self._get_dbus_property(interface_name, property_name)
895
if prop._dbus_access == "read":
585
if prop._dbus_access == u"read":
896
586
raise DBusPropertyAccessException(property_name)
897
if prop._dbus_get_args_options["byte_arrays"]:
587
if prop._dbus_get_args_options[u"byte_arrays"]:
898
588
# The byte_arrays option is not supported yet on
899
589
# signatures other than "ay".
900
if prop._dbus_signature != "ay":
590
if prop._dbus_signature != u"ay":
901
591
raise ValueError
902
value = dbus.ByteArray(b''.join(chr(byte)
903
for byte in value))
592
value = dbus.ByteArray(''.join(unichr(byte)
593
for byte in value))
904
594
prop(value)
905
595
906
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
907
out_signature="a{sv}")
596
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
597
out_signature=u"a{sv}")
908
598
def GetAll(self, interface_name):
909
599
"""Standard D-Bus property GetAll() method, see D-Bus
910
600
standard.
911
601
912
602
Note: Will not include properties with access="write".
913
603
"""
914
properties = {}
915
for name, prop in self._get_all_dbus_things("property"):
604
all = {}
605
for name, prop in self._get_all_dbus_properties():
916
606
if (interface_name
917
607
and interface_name != prop._dbus_interface):
918
608
# Interface non-empty but did not match
919
609
continue
920
610
# Ignore write-only properties
921
if prop._dbus_access == "write":
611
if prop._dbus_access == u"write":
922
612
continue
923
613
value = prop()
924
if not hasattr(value, "variant_level"):
925
properties[name] = value
614
if not hasattr(value, u"variant_level"):
615
all[name] = value
926
616
continue
927
properties[name] = type(value)(value, variant_level=
928
value.variant_level+1)
929
return dbus.Dictionary(properties, signature="sv")
617
all[name] = type(value)(value, variant_level=
618
value.variant_level+1)
619
return dbus.Dictionary(all, signature=u"sv")
930
620
931
621
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
932
out_signature="s",
622
out_signature=u"s",
933
623
path_keyword='object_path',
934
624
connection_keyword='connection')
935
625
def Introspect(self, object_path, connection):
936
"""Overloading of standard D-Bus method.
937
938
Inserts property tags and interface annotation tags.
626
"""Standard D-Bus method, overloaded to insert property tags.
939
627
"""
940
628
xmlstring = dbus.service.Object.Introspect(self, object_path,
941
629
connection)
942
630
try:
943
631
document = xml.dom.minidom.parseString(xmlstring)
944
632
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)
633
e = document.createElement(u"property")
634
e.setAttribute(u"name", name)
635
e.setAttribute(u"type", prop._dbus_signature)
636
e.setAttribute(u"access", prop._dbus_access)
949
637
return e
950
for if_tag in document.getElementsByTagName("interface"):
951
# Add property tags
638
for if_tag in document.getElementsByTagName(u"interface"):
952
639
for tag in (make_tag(document, name, prop)
953
640
for name, prop
954
in self._get_all_dbus_things("property")
641
in self._get_all_dbus_properties()
955
642
if prop._dbus_interface
956
== if_tag.getAttribute("name")):
643
== if_tag.getAttribute(u"name")):
957
644
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
645
# Add the names to the return values for the
990
646
# "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")
647
if (if_tag.getAttribute(u"name")
648
== u"org.freedesktop.DBus.Properties"):
649
for cn in if_tag.getElementsByTagName(u"method"):
650
if cn.getAttribute(u"name") == u"Get":
651
for arg in cn.getElementsByTagName(u"arg"):
652
if (arg.getAttribute(u"direction")
653
== u"out"):
654
arg.setAttribute(u"name", u"value")
655
elif cn.getAttribute(u"name") == u"GetAll":
656
for arg in cn.getElementsByTagName(u"arg"):
657
if (arg.getAttribute(u"direction")
658
== u"out"):
659
arg.setAttribute(u"name", u"props")
660
xmlstring = document.toxml(u"utf-8")
1005
661
document.unlink()
1006
662
except (AttributeError, xml.dom.DOMException,
1007
xml.parsers.expat.ExpatError) as error:
1008
logger.error("Failed to override Introspection method",
1009
exc_info=error)
663
xml.parsers.expat.ExpatError), error:
664
logger.error(u"Failed to override Introspection method",
665
error)
1010
666
return xmlstring
1011
667
1012
668
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
669
class ClientDBus(Client, DBusObjectWithProperties):
1167
670
"""A Client class using D-Bus
1168
671
1170
673
dbus_object_path: dbus.ObjectPath
1171
674
bus: dbus.SystemBus()
1172
675
"""
1173
1174
runtime_expansions = (Client.runtime_expansions
1175
+ ("dbus_object_path",))
1176
1177
676
# dbus.service.Object doesn't use super(), so we can't either.
1178
677
1179
678
def __init__(self, bus = None, *args, **kwargs):
1181
680
Client.__init__(self, *args, **kwargs)
1182
681
# Only now, when this client is initialized, can it show up on
1183
682
# the D-Bus
1184
client_object_name = unicode(self.name).translate(
1185
{ord("."): ord("_"),
1186
ord("-"): ord("_")})
1187
683
self.dbus_object_path = (dbus.ObjectPath
1188
("/clients/" + client_object_name))
684
(u"/clients/"
685
+ self.name.replace(u".", u"_")))
1189
686
DBusObjectWithProperties.__init__(self, self.bus,
1190
687
self.dbus_object_path)
1191
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
688
689
@staticmethod
690
def _datetime_to_dbus(dt, variant_level=0):
691
"""Convert a UTC datetime.datetime() to a D-Bus type."""
692
return dbus.String(dt.isoformat(),
693
variant_level=variant_level)
694
695
def enable(self):
696
oldstate = getattr(self, u"enabled", False)
697
r = Client.enable(self)
698
if oldstate != self.enabled:
699
# Emit D-Bus signals
700
self.PropertyChanged(dbus.String(u"enabled"),
701
dbus.Boolean(True, variant_level=1))
702
self.PropertyChanged(
703
dbus.String(u"last_enabled"),
704
self._datetime_to_dbus(self.last_enabled,
705
variant_level=1))
706
return r
707
708
def disable(self, quiet = False):
709
oldstate = getattr(self, u"enabled", False)
710
r = Client.disable(self, quiet=quiet)
711
if not quiet and oldstate != self.enabled:
712
# Emit D-Bus signal
713
self.PropertyChanged(dbus.String(u"enabled"),
714
dbus.Boolean(False, variant_level=1))
715
return r
1260
716
1261
717
def __del__(self, *args, **kwargs):
1262
718
try:
1263
719
self.remove_from_connection()
1264
720
except LookupError:
1265
721
pass
1266
if hasattr(DBusObjectWithProperties, "__del__"):
722
if hasattr(DBusObjectWithProperties, u"__del__"):
1267
723
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1268
724
Client.__del__(self, *args, **kwargs)
1269
725
1271
727
*args, **kwargs):
1272
728
self.checker_callback_tag = None
1273
729
self.checker = None
730
# Emit D-Bus signal
731
self.PropertyChanged(dbus.String(u"checker_running"),
732
dbus.Boolean(False, variant_level=1))
1274
733
if os.WIFEXITED(condition):
1275
734
exitstatus = os.WEXITSTATUS(condition)
1276
735
# Emit D-Bus signal
1286
745
return Client.checker_callback(self, pid, condition, command,
1287
746
*args, **kwargs)
1288
747
748
def checked_ok(self, *args, **kwargs):
749
r = Client.checked_ok(self, *args, **kwargs)
750
# Emit D-Bus signal
751
self.PropertyChanged(
752
dbus.String(u"last_checked_ok"),
753
(self._datetime_to_dbus(self.last_checked_ok,
754
variant_level=1)))
755
return r
756
1289
757
def start_checker(self, *args, **kwargs):
1290
758
old_checker = self.checker
1291
759
if self.checker is not None:
1298
766
and old_checker_pid != self.checker.pid):
1299
767
# Emit D-Bus signal
1300
768
self.CheckerStarted(self.current_checker_command)
1301
return r
1302
1303
def _reset_approved(self):
1304
self.approved = None
1305
return False
1306
1307
def approve(self, value=True):
1308
self.send_changedstate()
1309
self.approved = value
1310
gobject.timeout_add(timedelta_to_milliseconds
1311
(self.approval_duration),
1312
self._reset_approved)
1313
769
self.PropertyChanged(
770
dbus.String(u"checker_running"),
771
dbus.Boolean(True, variant_level=1))
772
return r
773
774
def stop_checker(self, *args, **kwargs):
775
old_checker = getattr(self, u"checker", None)
776
r = Client.stop_checker(self, *args, **kwargs)
777
if (old_checker is not None
778
and getattr(self, u"checker", None) is None):
779
self.PropertyChanged(dbus.String(u"checker_running"),
780
dbus.Boolean(False, variant_level=1))
781
return r
1314
782
1315
783
## 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"}
784
_interface = u"se.bsnet.fukt.Mandos.Client"
1324
785
1325
786
## Signals
1326
787
1327
788
# CheckerCompleted - signal
1328
@dbus.service.signal(_interface, signature="nxs")
789
@dbus.service.signal(_interface, signature=u"nxs")
1329
790
def CheckerCompleted(self, exitcode, waitstatus, command):
1330
791
"D-Bus signal"
1331
792
pass
1332
793
1333
794
# CheckerStarted - signal
1334
@dbus.service.signal(_interface, signature="s")
795
@dbus.service.signal(_interface, signature=u"s")
1335
796
def CheckerStarted(self, command):
1336
797
"D-Bus signal"
1337
798
pass
1338
799
1339
800
# PropertyChanged - signal
1340
@dbus.service.signal(_interface, signature="sv")
801
@dbus.service.signal(_interface, signature=u"sv")
1341
802
def PropertyChanged(self, property, value):
1342
803
"D-Bus signal"
1343
804
pass
1345
806
# GotSecret - signal
1346
807
@dbus.service.signal(_interface)
1347
808
def GotSecret(self):
1348
"""D-Bus signal
1349
Is sent after a successful transfer of secret from the Mandos
1350
server to mandos-client
1351
"""
809
"D-Bus signal"
1352
810
pass
1353
811
1354
812
# Rejected - signal
1355
@dbus.service.signal(_interface, signature="s")
1356
def Rejected(self, reason):
813
@dbus.service.signal(_interface)
814
def Rejected(self):
1357
815
"D-Bus signal"
1358
816
pass
1359
817
1360
# NeedApproval - signal
1361
@dbus.service.signal(_interface, signature="tb")
1362
def NeedApproval(self, timeout, default):
1363
"D-Bus signal"
1364
return self.need_approval()
1365
1366
818
## Methods
1367
819
1368
# Approve - method
1369
@dbus.service.method(_interface, in_signature="b")
1370
def Approve(self, value):
1371
self.approve(value)
1372
1373
820
# CheckedOK - method
1374
821
@dbus.service.method(_interface)
1375
822
def CheckedOK(self):
1376
self.checked_ok()
823
return self.checked_ok()
1377
824
1378
825
# Enable - method
1379
826
@dbus.service.method(_interface)
1400
847
1401
848
## Properties
1402
849
1403
# ApprovalPending - property
1404
@dbus_service_property(_interface, signature="b", access="read")
1405
def ApprovalPending_dbus_property(self):
1406
return dbus.Boolean(bool(self.approvals_pending))
1407
1408
# ApprovedByDefault - property
1409
@dbus_service_property(_interface, signature="b",
1410
access="readwrite")
1411
def ApprovedByDefault_dbus_property(self, value=None):
1412
if value is None: # get
1413
return dbus.Boolean(self.approved_by_default)
1414
self.approved_by_default = bool(value)
1415
1416
# ApprovalDelay - property
1417
@dbus_service_property(_interface, signature="t",
1418
access="readwrite")
1419
def ApprovalDelay_dbus_property(self, value=None):
1420
if value is None: # get
1421
return dbus.UInt64(self.approval_delay_milliseconds())
1422
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1423
1424
# ApprovalDuration - property
1425
@dbus_service_property(_interface, signature="t",
1426
access="readwrite")
1427
def ApprovalDuration_dbus_property(self, value=None):
1428
if value is None: # get
1429
return dbus.UInt64(timedelta_to_milliseconds(
1430
self.approval_duration))
1431
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1432
1433
# Name - property
1434
@dbus_service_property(_interface, signature="s", access="read")
1435
def Name_dbus_property(self):
850
# name - property
851
@dbus_service_property(_interface, signature=u"s", access=u"read")
852
def name_dbus_property(self):
1436
853
return dbus.String(self.name)
1437
854
1438
# Fingerprint - property
1439
@dbus_service_property(_interface, signature="s", access="read")
1440
def Fingerprint_dbus_property(self):
855
# fingerprint - property
856
@dbus_service_property(_interface, signature=u"s", access=u"read")
857
def fingerprint_dbus_property(self):
1441
858
return dbus.String(self.fingerprint)
1442
859
1443
# Host - property
1444
@dbus_service_property(_interface, signature="s",
1445
access="readwrite")
1446
def Host_dbus_property(self, value=None):
860
# host - property
861
@dbus_service_property(_interface, signature=u"s",
862
access=u"readwrite")
863
def host_dbus_property(self, value=None):
1447
864
if value is None: # get
1448
865
return dbus.String(self.host)
1449
self.host = unicode(value)
1450
1451
# Created - property
1452
@dbus_service_property(_interface, signature="s", access="read")
1453
def Created_dbus_property(self):
1454
return datetime_to_dbus(self.created)
1455
1456
# LastEnabled - property
1457
@dbus_service_property(_interface, signature="s", access="read")
1458
def LastEnabled_dbus_property(self):
1459
return datetime_to_dbus(self.last_enabled)
1460
1461
# Enabled - property
1462
@dbus_service_property(_interface, signature="b",
1463
access="readwrite")
1464
def Enabled_dbus_property(self, value=None):
866
self.host = value
867
# Emit D-Bus signal
868
self.PropertyChanged(dbus.String(u"host"),
869
dbus.String(value, variant_level=1))
870
871
# created - property
872
@dbus_service_property(_interface, signature=u"s", access=u"read")
873
def created_dbus_property(self):
874
return dbus.String(self._datetime_to_dbus(self.created))
875
876
# last_enabled - property
877
@dbus_service_property(_interface, signature=u"s", access=u"read")
878
def last_enabled_dbus_property(self):
879
if self.last_enabled is None:
880
return dbus.String(u"")
881
return dbus.String(self._datetime_to_dbus(self.last_enabled))
882
883
# enabled - property
884
@dbus_service_property(_interface, signature=u"b",
885
access=u"readwrite")
886
def enabled_dbus_property(self, value=None):
1465
887
if value is None: # get
1466
888
return dbus.Boolean(self.enabled)
1467
889
if value:
1469
891
else:
1470
892
self.disable()
1471
893
1472
# LastCheckedOK - property
1473
@dbus_service_property(_interface, signature="s",
1474
access="readwrite")
1475
def LastCheckedOK_dbus_property(self, value=None):
894
# last_checked_ok - property
895
@dbus_service_property(_interface, signature=u"s",
896
access=u"readwrite")
897
def last_checked_ok_dbus_property(self, value=None):
1476
898
if value is not None:
1477
899
self.checked_ok()
1478
900
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)
1496
1497
# Timeout - property
1498
@dbus_service_property(_interface, signature="t",
1499
access="readwrite")
1500
def Timeout_dbus_property(self, value=None):
901
if self.last_checked_ok is None:
902
return dbus.String(u"")
903
return dbus.String(self._datetime_to_dbus(self
904
.last_checked_ok))
905
906
# timeout - property
907
@dbus_service_property(_interface, signature=u"t",
908
access=u"readwrite")
909
def timeout_dbus_property(self, value=None):
1501
910
if value is None: # get
1502
911
return dbus.UInt64(self.timeout_milliseconds())
1503
912
self.timeout = datetime.timedelta(0, 0, 0, value)
913
# Emit D-Bus signal
914
self.PropertyChanged(dbus.String(u"timeout"),
915
dbus.UInt64(value, variant_level=1))
916
if getattr(self, u"disable_initiator_tag", None) is None:
917
return
1504
918
# 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)
1531
1532
# Interval - property
1533
@dbus_service_property(_interface, signature="t",
1534
access="readwrite")
1535
def Interval_dbus_property(self, value=None):
919
gobject.source_remove(self.disable_initiator_tag)
920
self.disable_initiator_tag = None
921
time_to_die = (self.
922
_timedelta_to_milliseconds((self
923
.last_checked_ok
924
+ self.timeout)
925
- datetime.datetime
926
.utcnow()))
927
if time_to_die <= 0:
928
# The timeout has passed
929
self.disable()
930
else:
931
self.disable_initiator_tag = (gobject.timeout_add
932
(time_to_die, self.disable))
933
934
# interval - property
935
@dbus_service_property(_interface, signature=u"t",
936
access=u"readwrite")
937
def interval_dbus_property(self, value=None):
1536
938
if value is None: # get
1537
939
return dbus.UInt64(self.interval_milliseconds())
1538
940
self.interval = datetime.timedelta(0, 0, 0, value)
1539
if getattr(self, "checker_initiator_tag", None) is None:
941
# Emit D-Bus signal
942
self.PropertyChanged(dbus.String(u"interval"),
943
dbus.UInt64(value, variant_level=1))
944
if getattr(self, u"checker_initiator_tag", None) is None:
1540
945
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
1548
# Checker - property
1549
@dbus_service_property(_interface, signature="s",
1550
access="readwrite")
1551
def Checker_dbus_property(self, value=None):
946
# Reschedule checker run
947
gobject.source_remove(self.checker_initiator_tag)
948
self.checker_initiator_tag = (gobject.timeout_add
949
(value, self.start_checker))
950
self.start_checker() # Start one now, too
951
952
# checker - property
953
@dbus_service_property(_interface, signature=u"s",
954
access=u"readwrite")
955
def checker_dbus_property(self, value=None):
1552
956
if value is None: # get
1553
957
return dbus.String(self.checker_command)
1554
self.checker_command = unicode(value)
958
self.checker_command = value
959
# Emit D-Bus signal
960
self.PropertyChanged(dbus.String(u"checker"),
961
dbus.String(self.checker_command,
962
variant_level=1))
1555
963
1556
# CheckerRunning - property
1557
@dbus_service_property(_interface, signature="b",
1558
access="readwrite")
1559
def CheckerRunning_dbus_property(self, value=None):
964
# checker_running - property
965
@dbus_service_property(_interface, signature=u"b",
966
access=u"readwrite")
967
def checker_running_dbus_property(self, value=None):
1560
968
if value is None: # get
1561
969
return dbus.Boolean(self.checker is not None)
1562
970
if value:
1564
972
else:
1565
973
self.stop_checker()
1566
974
1567
# ObjectPath - property
1568
@dbus_service_property(_interface, signature="o", access="read")
1569
def ObjectPath_dbus_property(self):
975
# object_path - property
976
@dbus_service_property(_interface, signature=u"o", access=u"read")
977
def object_path_dbus_property(self):
1570
978
return self.dbus_object_path # is already a dbus.ObjectPath
1571
979
1572
# Secret = property
1573
@dbus_service_property(_interface, signature="ay",
1574
access="write", byte_arrays=True)
1575
def Secret_dbus_property(self, value):
980
# secret = property
981
@dbus_service_property(_interface, signature=u"ay",
982
access=u"write", byte_arrays=True)
983
def secret_dbus_property(self, value):
1576
984
self.secret = str(value)
1577
985
1578
986
del _interface
1579
987
1580
988
1581
class ProxyClient(object):
1582
def __init__(self, child_pipe, fpr, address):
1583
self._pipe = child_pipe
1584
self._pipe.send(('init', fpr, address))
1585
if not self._pipe.recv():
1586
raise KeyError()
1587
1588
def __getattribute__(self, name):
1589
if name == '_pipe':
1590
return super(ProxyClient, self).__getattribute__(name)
1591
self._pipe.send(('getattr', name))
1592
data = self._pipe.recv()
1593
if data[0] == 'data':
1594
return data[1]
1595
if data[0] == 'function':
1596
def func(*args, **kwargs):
1597
self._pipe.send(('funcall', name, args, kwargs))
1598
return self._pipe.recv()[1]
1599
return func
1600
1601
def __setattr__(self, name, value):
1602
if name == '_pipe':
1603
return super(ProxyClient, self).__setattr__(name, value)
1604
self._pipe.send(('setattr', name, value))
1605
1606
1607
class ClientDBusTransitional(ClientDBus):
1608
__metaclass__ = AlternateDBusNamesMetaclass
1609
1610
1611
989
class ClientHandler(socketserver.BaseRequestHandler, object):
1612
990
"""A class to handle client connections.
1613
991
1615
993
Note: This will run in its own forked process."""
1616
994
1617
995
def handle(self):
1618
with contextlib.closing(self.server.child_pipe) as child_pipe:
1619
logger.info("TCP connection from: %s",
1620
unicode(self.client_address))
1621
logger.debug("Pipe FD: %d",
1622
self.server.child_pipe.fileno())
1623
996
logger.info(u"TCP connection from: %s",
997
unicode(self.client_address))
998
logger.debug(u"IPC Pipe FD: %d",
999
self.server.child_pipe[1].fileno())
1000
# Open IPC pipe to parent process
1001
with contextlib.nested(self.server.child_pipe[1],
1002
self.server.parent_pipe[0]
1003
) as (ipc, ipc_return):
1624
1004
session = (gnutls.connection
1625
1005
.ClientSession(self.request,
1626
1006
gnutls.connection
1627
1007
.X509Credentials()))
1628
1008
1009
line = self.request.makefile().readline()
1010
logger.debug(u"Protocol version: %r", line)
1011
try:
1012
if int(line.strip().split()[0]) > 1:
1013
raise RuntimeError
1014
except (ValueError, IndexError, RuntimeError), error:
1015
logger.error(u"Unknown protocol version: %s", error)
1016
return
1017
1629
1018
# Note: gnutls.connection.X509Credentials is really a
1630
1019
# generic GnuTLS certificate credentials object so long as
1631
1020
# no X.509 keys are added to it. Therefore, we can use it
1632
1021
# here despite using OpenPGP certificates.
1633
1022
1634
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1635
# "+AES-256-CBC", "+SHA1",
1636
# "+COMP-NULL", "+CTYPE-OPENPGP",
1637
# "+DHE-DSS"))
1023
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1024
# u"+AES-256-CBC", u"+SHA1",
1025
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
1026
# u"+DHE-DSS"))
1638
1027
# Use a fallback default, since this MUST be set.
1639
1028
priority = self.server.gnutls_priority
1640
1029
if priority is None:
1641
priority = "NORMAL"
1030
priority = u"NORMAL"
1642
1031
(gnutls.library.functions
1643
1032
.gnutls_priority_set_direct(session._c_object,
1644
1033
priority, None))
1645
1034
1646
# Start communication using the Mandos protocol
1647
# Get protocol number
1648
line = self.request.makefile().readline()
1649
logger.debug("Protocol version: %r", line)
1650
try:
1651
if int(line.strip().split()[0]) > 1:
1652
raise RuntimeError
1653
except (ValueError, IndexError, RuntimeError) as error:
1654
logger.error("Unknown protocol version: %s", error)
1655
return
1656
1657
# Start GnuTLS connection
1658
1035
try:
1659
1036
session.handshake()
1660
except gnutls.errors.GNUTLSError as error:
1661
logger.warning("Handshake failed: %s", error)
1037
except gnutls.errors.GNUTLSError, error:
1038
logger.warning(u"Handshake failed: %s", error)
1662
1039
# Do not run session.bye() here: the session is not
1663
1040
# established. Just abandon the request.
1664
1041
return
1665
logger.debug("Handshake succeeded")
1666
1667
approval_required = False
1042
logger.debug(u"Handshake succeeded")
1668
1043
try:
1669
1044
try:
1670
1045
fpr = self.fingerprint(self.peer_certificate
1671
1046
(session))
1672
except (TypeError,
1673
gnutls.errors.GNUTLSError) as error:
1674
logger.warning("Bad certificate: %s", error)
1675
return
1676
logger.debug("Fingerprint: %s", fpr)
1677
1678
try:
1679
client = ProxyClient(child_pipe, fpr,
1680
self.client_address)
1681
except KeyError:
1682
return
1683
1684
if client.approval_delay:
1685
delay = client.approval_delay
1686
client.approvals_pending += 1
1687
approval_required = True
1688
1689
while True:
1690
if not client.enabled:
1691
logger.info("Client %s is disabled",
1692
client.name)
1693
if self.server.use_dbus:
1694
# Emit D-Bus signal
1695
client.Rejected("Disabled")
1696
return
1697
1698
if client.approved or not client.approval_delay:
1699
#We are approved or approval is disabled
1047
except (TypeError, gnutls.errors.GNUTLSError), error:
1048
logger.warning(u"Bad certificate: %s", error)
1049
return
1050
logger.debug(u"Fingerprint: %s", fpr)
1051
1052
for c in self.server.clients:
1053
if c.fingerprint == fpr:
1054
client = c
1700
1055
break
1701
elif client.approved is None:
1702
logger.info("Client %s needs approval",
1703
client.name)
1704
if self.server.use_dbus:
1705
# Emit D-Bus signal
1706
client.NeedApproval(
1707
client.approval_delay_milliseconds(),
1708
client.approved_by_default)
1709
else:
1710
logger.warning("Client %s was not approved",
1711
client.name)
1712
if self.server.use_dbus:
1713
# Emit D-Bus signal
1714
client.Rejected("Denied")
1715
return
1716
1717
#wait until timeout or approved
1718
time = datetime.datetime.now()
1719
client.changedstate.acquire()
1720
(client.changedstate.wait
1721
(float(client.timedelta_to_milliseconds(delay)
1722
/ 1000)))
1723
client.changedstate.release()
1724
time2 = datetime.datetime.now()
1725
if (time2 - time) >= delay:
1726
if not client.approved_by_default:
1727
logger.warning("Client %s timed out while"
1728
" waiting for approval",
1729
client.name)
1730
if self.server.use_dbus:
1731
# Emit D-Bus signal
1732
client.Rejected("Approval timed out")
1733
return
1734
else:
1735
break
1736
else:
1737
delay -= time2 - time
1738
1056
else:
1057
ipc.write(u"NOTFOUND %s %s\n"
1058
% (fpr, unicode(self.client_address)))
1059
return
1060
# Have to check if client.enabled, since it is
1061
# possible that the client was disabled since the
1062
# GnuTLS session was established.
1063
ipc.write(u"GETATTR enabled %s\n" % fpr)
1064
enabled = pickle.load(ipc_return)
1065
if not enabled:
1066
ipc.write(u"DISABLED %s\n" % client.name)
1067
return
1068
# Send "NEED_APPROVAL" here and hang waiting
1069
# for response? Leave timeout to parent process?
1070
ipc.write(u"SENDING %s\n" % client.name)
1739
1071
sent_size = 0
1740
1072
while sent_size < len(client.secret):
1741
try:
1742
sent = session.send(client.secret[sent_size:])
1743
except gnutls.errors.GNUTLSError as error:
1744
logger.warning("gnutls send failed")
1745
return
1746
logger.debug("Sent: %d, remaining: %d",
1073
sent = session.send(client.secret[sent_size:])
1074
logger.debug(u"Sent: %d, remaining: %d",
1747
1075
sent, len(client.secret)
1748
1076
- (sent_size + sent))
1749
1077
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)
1754
if self.server.use_dbus:
1755
# Emit D-Bus signal
1756
client.GotSecret()
1757
1758
1078
finally:
1759
if approval_required:
1760
client.approvals_pending -= 1
1761
try:
1762
session.bye()
1763
except gnutls.errors.GNUTLSError as error:
1764
logger.warning("GnuTLS bye failed")
1079
session.bye()
1765
1080
1766
1081
@staticmethod
1767
1082
def peer_certificate(session):
1777
1092
.gnutls_certificate_get_peers
1778
1093
(session._c_object, ctypes.byref(list_size)))
1779
1094
if not bool(cert_list) and list_size.value != 0:
1780
raise gnutls.errors.GNUTLSError("error getting peer"
1781
" certificate")
1095
raise gnutls.errors.GNUTLSError(u"error getting peer"
1096
u" certificate")
1782
1097
if list_size.value == 0:
1783
1098
return None
1784
1099
cert = cert_list[0]
1810
1125
if crtverify.value != 0:
1811
1126
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1812
1127
raise (gnutls.errors.CertificateSecurityError
1813
("Verify failed"))
1128
(u"Verify failed"))
1814
1129
# New buffer for the fingerprint
1815
1130
buf = ctypes.create_string_buffer(20)
1816
1131
buf_len = ctypes.c_size_t()
1823
1138
# Convert the buffer to a Python bytestring
1824
1139
fpr = ctypes.string_at(buf, buf_len.value)
1825
1140
# Convert the bytestring to hexadecimal notation
1826
hex_fpr = binascii.hexlify(fpr).upper()
1141
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
1827
1142
return hex_fpr
1828
1143
1829
1144
1830
class MultiprocessingMixIn(object):
1831
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1832
def sub_process_main(self, request, address):
1833
try:
1834
self.finish_request(request, address)
1835
except Exception:
1836
self.handle_error(request, address)
1837
self.close_request(request)
1838
1839
def process_request(self, request, address):
1840
"""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
1847
1848
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1849
""" adds a pipe to the MixIn """
1145
class ForkingMixInWithPipes(socketserver.ForkingMixIn, object):
1146
"""Like socketserver.ForkingMixIn, but also pass a pipe pair."""
1850
1147
def process_request(self, request, client_address):
1851
1148
"""Overrides and wraps the original process_request().
1852
1149
1853
1150
This function creates a new pipe in self.pipe
1854
1151
"""
1855
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1856
1857
proc = MultiprocessingMixIn.process_request(self, request,
1858
client_address)
1859
self.child_pipe.close()
1860
self.add_pipe(parent_pipe, proc)
1861
1862
def add_pipe(self, parent_pipe, proc):
1152
# Child writes to child_pipe
1153
self.child_pipe = map(os.fdopen, os.pipe(), u"rw", (1, 0))
1154
# Parent writes to parent_pipe
1155
self.parent_pipe = map(os.fdopen, os.pipe(), u"rw", (1, 0))
1156
super(ForkingMixInWithPipes,
1157
self).process_request(request, client_address)
1158
# Close unused ends for parent
1159
self.parent_pipe[0].close() # close read end
1160
self.child_pipe[1].close() # close write end
1161
self.add_pipe_fds(self.child_pipe[0], self.parent_pipe[1])
1162
def add_pipe_fds(self, child_pipe_fd, parent_pipe_fd):
1863
1163
"""Dummy function; override as necessary"""
1864
raise NotImplementedError
1865
1866
1867
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1164
child_pipe_fd.close()
1165
parent_pipe_fd.close()
1166
1167
1168
class IPv6_TCPServer(ForkingMixInWithPipes,
1868
1169
socketserver.TCPServer, object):
1869
1170
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1870
1171
1886
1187
bind to an address or port if they were not specified."""
1887
1188
if self.interface is not None:
1888
1189
if SO_BINDTODEVICE is None:
1889
logger.error("SO_BINDTODEVICE does not exist;"
1890
" cannot bind to interface %s",
1190
logger.error(u"SO_BINDTODEVICE does not exist;"
1191
u" cannot bind to interface %s",
1891
1192
self.interface)
1892
1193
else:
1893
1194
try:
1894
1195
self.socket.setsockopt(socket.SOL_SOCKET,
1895
1196
SO_BINDTODEVICE,
1896
1197
str(self.interface
1897
+ '\0'))
1898
except socket.error as error:
1198
+ u'\0'))
1199
except socket.error, error:
1899
1200
if error[0] == errno.EPERM:
1900
logger.error("No permission to"
1901
" bind to interface %s",
1201
logger.error(u"No permission to"
1202
u" bind to interface %s",
1902
1203
self.interface)
1903
1204
elif error[0] == errno.ENOPROTOOPT:
1904
logger.error("SO_BINDTODEVICE not available;"
1905
" cannot bind to interface %s",
1205
logger.error(u"SO_BINDTODEVICE not available;"
1206
u" cannot bind to interface %s",
1906
1207
self.interface)
1907
1208
else:
1908
1209
raise
1910
1211
if self.server_address[0] or self.server_address[1]:
1911
1212
if not self.server_address[0]:
1912
1213
if self.address_family == socket.AF_INET6:
1913
any_address = "::" # in6addr_any
1214
any_address = u"::" # in6addr_any
1914
1215
else:
1915
1216
any_address = socket.INADDR_ANY
1916
1217
self.server_address = (any_address,
1943
1244
self.enabled = False
1944
1245
self.clients = clients
1945
1246
if self.clients is None:
1946
self.clients = {}
1247
self.clients = set()
1947
1248
self.use_dbus = use_dbus
1948
1249
self.gnutls_priority = gnutls_priority
1949
1250
IPv6_TCPServer.__init__(self, server_address,
1953
1254
def server_activate(self):
1954
1255
if self.enabled:
1955
1256
return socketserver.TCPServer.server_activate(self)
1956
1957
1257
def enable(self):
1958
1258
self.enabled = True
1959
1960
def add_pipe(self, parent_pipe, proc):
1259
def add_pipe_fds(self, child_pipe_fd, parent_pipe_fd):
1961
1260
# Call "handle_ipc" for both data and EOF events
1962
gobject.io_add_watch(parent_pipe.fileno(),
1261
gobject.io_add_watch(child_pipe_fd.fileno(),
1963
1262
gobject.IO_IN | gobject.IO_HUP,
1964
1263
functools.partial(self.handle_ipc,
1965
parent_pipe =
1966
parent_pipe,
1967
proc = proc))
1968
1969
def handle_ipc(self, source, condition, parent_pipe=None,
1970
proc = None, client_object=None):
1264
reply = parent_pipe_fd,
1265
sender= child_pipe_fd))
1266
def handle_ipc(self, source, condition, reply=None, sender=None):
1971
1267
condition_names = {
1972
gobject.IO_IN: "IN", # There is data to read.
1973
gobject.IO_OUT: "OUT", # Data can be written (without
1268
gobject.IO_IN: u"IN", # There is data to read.
1269
gobject.IO_OUT: u"OUT", # Data can be written (without
1974
1270
# 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
1271
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1272
gobject.IO_ERR: u"ERR", # Error condition.
1273
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1978
1274
# broken, usually for pipes and
1979
1275
# sockets).
1980
1276
}
1982
1278
for cond, name in
1983
1279
condition_names.iteritems()
1984
1280
if cond & condition)
1985
# error, or the other end of multiprocessing.Pipe has closed
1986
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
1987
# Wait for other process to exit
1988
proc.join()
1989
return False
1990
1991
# Read a request from the child
1992
request = parent_pipe.recv()
1993
command = request[0]
1994
1995
if command == 'init':
1996
fpr = request[1]
1997
address = request[2]
1998
1999
for c in self.clients.itervalues():
2000
if c.fingerprint == fpr:
2001
client = c
2002
break
2003
else:
2004
logger.info("Client not found for fingerprint: %s, ad"
2005
"dress: %s", fpr, address)
2006
if self.use_dbus:
2007
# Emit D-Bus signal
2008
mandos_dbus_service.ClientNotFound(fpr,
2009
address[0])
2010
parent_pipe.send(False)
2011
return False
2012
2013
gobject.io_add_watch(parent_pipe.fileno(),
2014
gobject.IO_IN | gobject.IO_HUP,
2015
functools.partial(self.handle_ipc,
2016
parent_pipe =
2017
parent_pipe,
2018
proc = proc,
2019
client_object =
2020
client))
2021
parent_pipe.send(True)
2022
# remove the old hook in favor of the new above hook on
2023
# same fileno
2024
return False
2025
if command == 'funcall':
2026
funcname = request[1]
2027
args = request[2]
2028
kwargs = request[3]
2029
2030
parent_pipe.send(('data', getattr(client_object,
2031
funcname)(*args,
2032
**kwargs)))
2033
2034
if command == 'getattr':
2035
attrname = request[1]
2036
if callable(client_object.__getattribute__(attrname)):
2037
parent_pipe.send(('function',))
2038
else:
2039
parent_pipe.send(('data', client_object
2040
.__getattribute__(attrname)))
2041
2042
if command == 'setattr':
2043
attrname = request[1]
2044
value = request[2]
2045
setattr(client_object, attrname, value)
2046
1281
logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
1282
conditions_string)
1283
1284
# Read a line from the file object
1285
cmdline = sender.readline()
1286
if not cmdline: # Empty line means end of file
1287
# close the IPC pipes
1288
sender.close()
1289
reply.close()
1290
1291
# Stop calling this function
1292
return False
1293
1294
logger.debug(u"IPC command: %r", cmdline)
1295
1296
# Parse and act on command
1297
cmd, args = cmdline.rstrip(u"\r\n").split(None, 1)
1298
1299
if cmd == u"NOTFOUND":
1300
fpr, address = args.split(None, 1)
1301
logger.warning(u"Client not found for fingerprint: %s, ad"
1302
u"dress: %s", fpr, address)
1303
if self.use_dbus:
1304
# Emit D-Bus signal
1305
mandos_dbus_service.ClientNotFound(fpr, address)
1306
elif cmd == u"DISABLED":
1307
for client in self.clients:
1308
if client.name == args:
1309
logger.warning(u"Client %s is disabled", args)
1310
if self.use_dbus:
1311
# Emit D-Bus signal
1312
client.Rejected()
1313
break
1314
else:
1315
logger.error(u"Unknown client %s is disabled", args)
1316
elif cmd == u"SENDING":
1317
for client in self.clients:
1318
if client.name == args:
1319
logger.info(u"Sending secret to %s", client.name)
1320
client.checked_ok()
1321
if self.use_dbus:
1322
# Emit D-Bus signal
1323
client.GotSecret()
1324
break
1325
else:
1326
logger.error(u"Sending secret to unknown client %s",
1327
args)
1328
elif cmd == u"GETATTR":
1329
attr_name, fpr = args.split(None, 1)
1330
for client in self.clients:
1331
if client.fingerprint == fpr:
1332
attr_value = getattr(client, attr_name, None)
1333
logger.debug("IPC reply: %r", attr_value)
1334
pickle.dump(attr_value, reply)
1335
break
1336
else:
1337
logger.error(u"Client %s on address %s requesting "
1338
u"attribute %s not found", fpr, address,
1339
attr_name)
1340
pickle.dump(None, reply)
1341
else:
1342
logger.error(u"Unknown IPC command: %r", cmdline)
1343
1344
# Keep calling this function
2047
1345
return True
2048
1346
2049
1347
2050
1348
def string_to_delta(interval):
2051
1349
"""Parse a string and return a datetime.timedelta
2052
1350
2053
>>> string_to_delta('7d')
1351
>>> string_to_delta(u'7d')
2054
1352
datetime.timedelta(7)
2055
>>> string_to_delta('60s')
1353
>>> string_to_delta(u'60s')
2056
1354
datetime.timedelta(0, 60)
2057
>>> string_to_delta('60m')
1355
>>> string_to_delta(u'60m')
2058
1356
datetime.timedelta(0, 3600)
2059
>>> string_to_delta('24h')
1357
>>> string_to_delta(u'24h')
2060
1358
datetime.timedelta(1)
2061
>>> string_to_delta('1w')
1359
>>> string_to_delta(u'1w')
2062
1360
datetime.timedelta(7)
2063
>>> string_to_delta('5m 30s')
1361
>>> string_to_delta(u'5m 30s')
2064
1362
datetime.timedelta(0, 330)
2065
1363
"""
2066
1364
timevalue = datetime.timedelta(0)
2068
1366
try:
2069
1367
suffix = unicode(s[-1])
2070
1368
value = int(s[:-1])
2071
if suffix == "d":
1369
if suffix == u"d":
2072
1370
delta = datetime.timedelta(value)
2073
elif suffix == "s":
1371
elif suffix == u"s":
2074
1372
delta = datetime.timedelta(0, value)
2075
elif suffix == "m":
1373
elif suffix == u"m":
2076
1374
delta = datetime.timedelta(0, 0, 0, 0, value)
2077
elif suffix == "h":
1375
elif suffix == u"h":
2078
1376
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
2079
elif suffix == "w":
1377
elif suffix == u"w":
2080
1378
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2081
1379
else:
2082
raise ValueError("Unknown suffix {0!r}"
2083
.format(suffix))
2084
except (ValueError, IndexError) as e:
2085
raise ValueError(*(e.args))
1380
raise ValueError(u"Unknown suffix %r" % suffix)
1381
except (ValueError, IndexError), e:
1382
raise ValueError(e.message)
2086
1383
timevalue += delta
2087
1384
return timevalue
2088
1385
2089
1386
1387
def if_nametoindex(interface):
1388
"""Call the C function if_nametoindex(), or equivalent
1389
1390
Note: This function cannot accept a unicode string."""
1391
global if_nametoindex
1392
try:
1393
if_nametoindex = (ctypes.cdll.LoadLibrary
1394
(ctypes.util.find_library(u"c"))
1395
.if_nametoindex)
1396
except (OSError, AttributeError):
1397
logger.warning(u"Doing if_nametoindex the hard way")
1398
def if_nametoindex(interface):
1399
"Get an interface index the hard way, i.e. using fcntl()"
1400
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1401
with contextlib.closing(socket.socket()) as s:
1402
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1403
struct.pack(str(u"16s16x"),
1404
interface))
1405
interface_index = struct.unpack(str(u"I"),
1406
ifreq[16:20])[0]
1407
return interface_index
1408
return if_nametoindex(interface)
1409
1410
2090
1411
def daemon(nochdir = False, noclose = False):
2091
1412
"""See daemon(3). Standard BSD Unix function.
2092
1413
2095
1416
sys.exit()
2096
1417
os.setsid()
2097
1418
if not nochdir:
2098
os.chdir("/")
1419
os.chdir(u"/")
2099
1420
if os.fork():
2100
1421
sys.exit()
2101
1422
if not noclose:
2102
1423
# Close all standard open file descriptors
2103
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1424
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2104
1425
if not stat.S_ISCHR(os.fstat(null).st_mode):
2105
1426
raise OSError(errno.ENODEV,
2106
"{0} not a character device"
2107
.format(os.devnull))
1427
u"%s not a character device"
1428
% os.path.devnull)
2108
1429
os.dup2(null, sys.stdin.fileno())
2109
1430
os.dup2(null, sys.stdout.fileno())
2110
1431
os.dup2(null, sys.stderr.fileno())
2117
1438
##################################################################
2118
1439
# Parsing of options, both command line and config file
2119
1440
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()
1441
parser = optparse.OptionParser(version = "%%prog %s" % version)
1442
parser.add_option("-i", u"--interface", type=u"string",
1443
metavar="IF", help=u"Bind to interface IF")
1444
parser.add_option("-a", u"--address", type=u"string",
1445
help=u"Address to listen for requests on")
1446
parser.add_option("-p", u"--port", type=u"int",
1447
help=u"Port number to receive requests on")
1448
parser.add_option("--check", action=u"store_true",
1449
help=u"Run self-test")
1450
parser.add_option("--debug", action=u"store_true",
1451
help=u"Debug mode; run in foreground and log to"
1452
u" terminal")
1453
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1454
u" priority string (see GnuTLS documentation)")
1455
parser.add_option("--servicename", type=u"string",
1456
metavar=u"NAME", help=u"Zeroconf service name")
1457
parser.add_option("--configdir", type=u"string",
1458
default=u"/etc/mandos", metavar=u"DIR",
1459
help=u"Directory to search for configuration"
1460
u" files")
1461
parser.add_option("--no-dbus", action=u"store_false",
1462
dest=u"use_dbus", help=u"Do not provide D-Bus"
1463
u" system bus interface")
1464
parser.add_option("--no-ipv6", action=u"store_false",
1465
dest=u"use_ipv6", help=u"Do not use IPv6")
1466
options = parser.parse_args()[0]
2157
1467
2158
1468
if options.check:
2159
1469
import doctest
2161
1471
sys.exit()
2162
1472
2163
1473
# 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"
1474
server_defaults = { u"interface": u"",
1475
u"address": u"",
1476
u"port": u"",
1477
u"debug": u"False",
1478
u"priority":
1479
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1480
u"servicename": u"Mandos",
1481
u"use_dbus": u"True",
1482
u"use_ipv6": u"True",
2176
1483
}
2177
1484
2178
1485
# Parse config file for server-global settings
2179
1486
server_config = configparser.SafeConfigParser(server_defaults)
2180
1487
del server_defaults
2181
1488
server_config.read(os.path.join(options.configdir,
2182
"mandos.conf"))
1489
u"mandos.conf"))
2183
1490
# Convert the SafeConfigParser object to a dict
2184
1491
server_settings = server_config.defaults()
2185
1492
# 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",
1493
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1494
server_settings[option] = server_config.getboolean(u"DEFAULT",
2188
1495
option)
2189
1496
if server_settings["port"]:
2190
server_settings["port"] = server_config.getint("DEFAULT",
2191
"port")
1497
server_settings["port"] = server_config.getint(u"DEFAULT",
1498
u"port")
2192
1499
del server_config
2193
1500
2194
1501
# Override the settings from the config file with command line
2195
1502
# options, if set.
2196
for option in ("interface", "address", "port", "debug",
2197
"priority", "servicename", "configdir",
2198
"use_dbus", "use_ipv6", "debuglevel", "restore",
2199
"statedir"):
1503
for option in (u"interface", u"address", u"port", u"debug",
1504
u"priority", u"servicename", u"configdir",
1505
u"use_dbus", u"use_ipv6"):
2200
1506
value = getattr(options, option)
2201
1507
if value is not None:
2202
1508
server_settings[option] = value
2210
1516
##################################################################
2211
1517
2212
1518
# 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":
1519
debug = server_settings[u"debug"]
1520
use_dbus = server_settings[u"use_dbus"]
1521
use_ipv6 = server_settings[u"use_ipv6"]
1522
1523
if not debug:
1524
syslogger.setLevel(logging.WARNING)
1525
console.setLevel(logging.WARNING)
1526
1527
if server_settings[u"servicename"] != u"Mandos":
2230
1528
syslogger.setFormatter(logging.Formatter
2231
('Mandos ({0}) [%(process)d]:'
2232
' %(levelname)s: %(message)s'
2233
.format(server_settings
2234
["servicename"])))
1529
(u'Mandos (%s) [%%(process)d]:'
1530
u' %%(levelname)s: %%(message)s'
1531
% server_settings[u"servicename"]))
2235
1532
2236
1533
# 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"))
1534
client_defaults = { u"timeout": u"1h",
1535
u"interval": u"5m",
1536
u"checker": u"fping -q -- %%(host)s",
1537
u"host": u"",
1538
}
1539
client_config = configparser.SafeConfigParser(client_defaults)
1540
client_config.read(os.path.join(server_settings[u"configdir"],
1541
u"clients.conf"))
2241
1542
2242
1543
global mandos_dbus_service
2243
1544
mandos_dbus_service = None
2244
1545
2245
tcp_server = MandosServer((server_settings["address"],
2246
server_settings["port"]),
1546
tcp_server = MandosServer((server_settings[u"address"],
1547
server_settings[u"port"]),
2247
1548
ClientHandler,
2248
interface=(server_settings["interface"]
2249
or None),
1549
interface=server_settings[u"interface"],
2250
1550
use_ipv6=use_ipv6,
2251
1551
gnutls_priority=
2252
server_settings["priority"],
1552
server_settings[u"priority"],
2253
1553
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)
1554
pidfilename = u"/var/run/mandos.pid"
1555
try:
1556
pidfile = open(pidfilename, u"w")
1557
except IOError:
1558
logger.error(u"Could not open file %r", pidfilename)
2260
1559
2261
for name in ("_mandos", "mandos", "nobody"):
1560
try:
1561
uid = pwd.getpwnam(u"_mandos").pw_uid
1562
gid = pwd.getpwnam(u"_mandos").pw_gid
1563
except KeyError:
2262
1564
try:
2263
uid = pwd.getpwnam(name).pw_uid
2264
gid = pwd.getpwnam(name).pw_gid
2265
break
1565
uid = pwd.getpwnam(u"mandos").pw_uid
1566
gid = pwd.getpwnam(u"mandos").pw_gid
2266
1567
except KeyError:
2267
continue
2268
else:
2269
uid = 65534
2270
gid = 65534
1568
try:
1569
uid = pwd.getpwnam(u"nobody").pw_uid
1570
gid = pwd.getpwnam(u"nobody").pw_gid
1571
except KeyError:
1572
uid = 65534
1573
gid = 65534
2271
1574
try:
2272
1575
os.setgid(gid)
2273
1576
os.setuid(uid)
2274
except OSError as error:
1577
except OSError, error:
2275
1578
if error[0] != errno.EPERM:
2276
1579
raise error
2277
1580
1581
# Enable all possible GnuTLS debugging
2278
1582
if debug:
2279
# Enable all possible GnuTLS debugging
2280
2281
1583
# "Use a log level over 10 to enable all debugging options."
2282
1584
# - GnuTLS manual
2283
1585
gnutls.library.functions.gnutls_global_set_log_level(11)
2284
1586
2285
1587
@gnutls.library.types.gnutls_log_func
2286
1588
def debug_gnutls(level, string):
2287
logger.debug("GnuTLS: %s", string[:-1])
1589
logger.debug(u"GnuTLS: %s", string[:-1])
2288
1590
2289
1591
(gnutls.library.functions
2290
1592
.gnutls_global_set_log_function(debug_gnutls))
2291
2292
# Redirect stdin so all checkers get /dev/null
2293
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2294
os.dup2(null, sys.stdin.fileno())
2295
if null > 2:
2296
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()
2304
1593
2305
1594
global main_loop
2306
1595
# From the Avahi example code
2307
DBusGMainLoop(set_as_default=True)
1596
DBusGMainLoop(set_as_default=True )
2308
1597
main_loop = gobject.MainLoop()
2309
1598
bus = dbus.SystemBus()
2310
1599
# End of Avahi example code
2311
1600
if use_dbus:
2312
1601
try:
2313
bus_name = dbus.service.BusName("se.recompile.Mandos",
1602
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
2314
1603
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")
1604
except dbus.exceptions.NameExistsException, e:
1605
logger.error(unicode(e) + u", disabling D-Bus")
2320
1606
use_dbus = False
2321
server_settings["use_dbus"] = False
1607
server_settings[u"use_dbus"] = False
2322
1608
tcp_server.use_dbus = False
2323
1609
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)
1610
service = AvahiService(name = server_settings[u"servicename"],
1611
servicetype = u"_mandos._tcp",
1612
protocol = protocol, bus = bus)
2328
1613
if server_settings["interface"]:
2329
1614
service.interface = (if_nametoindex
2330
(str(server_settings["interface"])))
2331
2332
global multiprocessing_manager
2333
multiprocessing_manager = multiprocessing.Manager()
1615
(str(server_settings[u"interface"])))
2334
1616
2335
1617
client_class = Client
2336
1618
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))
2406
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
1619
client_class = functools.partial(ClientDBus, bus = bus)
1620
tcp_server.clients.update(set(
1621
client_class(name = section,
1622
config= dict(client_config.items(section)))
1623
for section in client_config.sections()))
2432
1624
if not tcp_server.clients:
2433
logger.warning("No clients defined")
2434
1625
logger.warning(u"No clients defined")
1626
1627
if debug:
1628
# Redirect stdin so all checkers get /dev/null
1629
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1630
os.dup2(null, sys.stdin.fileno())
1631
if null > 2:
1632
os.close(null)
1633
else:
1634
# No console logging
1635
logger.removeHandler(console)
1636
# Close all input and output, do double fork, etc.
1637
daemon()
1638
1639
try:
1640
with pidfile:
1641
pid = os.getpid()
1642
pidfile.write(str(pid) + "\n")
1643
del pidfile
1644
except IOError:
1645
logger.error(u"Could not write to file %r with PID %d",
1646
pidfilename, pid)
1647
except NameError:
1648
# "pidfile" was never created
1649
pass
1650
del pidfilename
1651
2435
1652
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
1653
signal.signal(signal.SIGINT, signal.SIG_IGN)
2449
2450
1654
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2451
1655
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2452
1656
2453
1657
if use_dbus:
2454
class MandosDBusService(DBusObjectWithProperties):
1658
class MandosDBusService(dbus.service.Object):
2455
1659
"""A D-Bus proxy object"""
2456
1660
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")
1661
dbus.service.Object.__init__(self, bus, u"/")
1662
_interface = u"se.bsnet.fukt.Mandos"
1663
1664
@dbus.service.signal(_interface, signature=u"o")
2467
1665
def ClientAdded(self, objpath):
2468
1666
"D-Bus signal"
2469
1667
pass
2470
1668
2471
@dbus.service.signal(_interface, signature="ss")
1669
@dbus.service.signal(_interface, signature=u"ss")
2472
1670
def ClientNotFound(self, fingerprint, address):
2473
1671
"D-Bus signal"
2474
1672
pass
2475
1673
2476
@dbus.service.signal(_interface, signature="os")
1674
@dbus.service.signal(_interface, signature=u"os")
2477
1675
def ClientRemoved(self, objpath, name):
2478
1676
"D-Bus signal"
2479
1677
pass
2480
1678
2481
@dbus.service.method(_interface, out_signature="ao")
1679
@dbus.service.method(_interface, out_signature=u"ao")
2482
1680
def GetAllClients(self):
2483
1681
"D-Bus method"
2484
1682
return dbus.Array(c.dbus_object_path
2485
for c in
2486
tcp_server.clients.itervalues())
1683
for c in tcp_server.clients)
2487
1684
2488
1685
@dbus.service.method(_interface,
2489
out_signature="a{oa{sv}}")
1686
out_signature=u"a{oa{sv}}")
2490
1687
def GetAllClientsWithProperties(self):
2491
1688
"D-Bus method"
2492
1689
return dbus.Dictionary(
2493
((c.dbus_object_path, c.GetAll(""))
2494
for c in tcp_server.clients.itervalues()),
2495
signature="oa{sv}")
1690
((c.dbus_object_path, c.GetAll(u""))
1691
for c in tcp_server.clients),
1692
signature=u"oa{sv}")
2496
1693
2497
@dbus.service.method(_interface, in_signature="o")
1694
@dbus.service.method(_interface, in_signature=u"o")
2498
1695
def RemoveClient(self, object_path):
2499
1696
"D-Bus method"
2500
for c in tcp_server.clients.itervalues():
1697
for c in tcp_server.clients:
2501
1698
if c.dbus_object_path == object_path:
2502
del tcp_server.clients[c.name]
1699
tcp_server.clients.remove(c)
2503
1700
c.remove_from_connection()
2504
1701
# Don't signal anything except ClientRemoved
2505
1702
c.disable(quiet=True)
2510
1707
2511
1708
del _interface
2512
1709
2513
class MandosDBusServiceTransitional(MandosDBusService):
2514
__metaclass__ = AlternateDBusNamesMetaclass
2515
mandos_dbus_service = MandosDBusServiceTransitional()
1710
mandos_dbus_service = MandosDBusService()
2516
1711
2517
1712
def cleanup():
2518
1713
"Cleanup function; run on exit"
2519
1714
service.cleanup()
2520
1715
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
1716
while tcp_server.clients:
2575
name, client = tcp_server.clients.popitem()
1717
client = tcp_server.clients.pop()
2576
1718
if use_dbus:
2577
1719
client.remove_from_connection()
1720
client.disable_hook = None
2578
1721
# Don't signal anything except ClientRemoved
2579
1722
client.disable(quiet=True)
2580
1723
if use_dbus:
2581
1724
# Emit D-Bus signal
2582
mandos_dbus_service.ClientRemoved(client
2583
.dbus_object_path,
1725
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
2584
1726
client.name)
2585
client_settings.clear()
2586
1727
2587
1728
atexit.register(cleanup)
2588
1729
2589
for client in tcp_server.clients.itervalues():
1730
for client in tcp_server.clients:
2590
1731
if use_dbus:
2591
1732
# Emit D-Bus signal
2592
1733
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2593
# Need to initiate checking of clients
2594
if client.enabled:
2595
client.init_checker()
1734
client.enable()
2596
1735
2597
1736
tcp_server.enable()
2598
1737
tcp_server.server_activate()
2600
1739
# Find out what port we got
2601
1740
service.port = tcp_server.socket.getsockname()[1]
2602
1741
if use_ipv6:
2603
logger.info("Now listening on address %r, port %d,"
2604
" flowinfo %d, scope_id %d",
2605
*tcp_server.socket.getsockname())
1742
logger.info(u"Now listening on address %r, port %d,"
1743
" flowinfo %d, scope_id %d"
1744
% tcp_server.socket.getsockname())
2606
1745
else: # IPv4
2607
logger.info("Now listening on address %r, port %d",
2608
*tcp_server.socket.getsockname())
1746
logger.info(u"Now listening on address %r, port %d"
1747
% tcp_server.socket.getsockname())
2609
1748
2610
1749
#service.interface = tcp_server.socket.getsockname()[3]
2611
1750
2613
1752
# From the Avahi example code
2614
1753
try:
2615
1754
service.activate()
2616
except dbus.exceptions.DBusException as error:
2617
logger.critical("D-Bus Exception", exc_info=error)
1755
except dbus.exceptions.DBusException, error:
1756
logger.critical(u"DBusException: %s", error)
2618
1757
cleanup()
2619
1758
sys.exit(1)
2620
1759
# End of Avahi example code
2624
1763
(tcp_server.handle_request
2625
1764
(*args[2:], **kwargs) or True))
2626
1765
2627
logger.debug("Starting main loop")
1766
logger.debug(u"Starting main loop")
2628
1767
main_loop.run()
2629
except AvahiError as error:
2630
logger.critical("Avahi Error", exc_info=error)
1768
except AvahiError, error:
1769
logger.critical(u"AvahiError: %s", error)
2631
1770
cleanup()
2632
1771
sys.exit(1)
2633
1772
except KeyboardInterrupt:
2634
1773
if debug:
2635
print("", file=sys.stderr)
2636
logger.debug("Server received KeyboardInterrupt")
2637
logger.debug("Server exiting")
1774
print >> sys.stderr
1775
logger.debug(u"Server received KeyboardInterrupt")
1776
logger.debug(u"Server exiting")
2638
1777
# Must run before the D-Bus bus name gets deregistered
2639
1778
cleanup()
2640
1779
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0