To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/release
« back to all changes in this revision
Viewing changes to mandos
- browse files at revision 237.7.110
- compare with another revision
- download diff
- download tarball
- view history from revision 237.7.110
- Committer: Teddy Hogeborn
- Date: 2012-03-08 22:04:44 UTC
- mfrom: (237.19.1 dbus-annotations)
- mto: (237.7.118 trunk) (299.1.1 release) (300.1.1 release) (301.1.1 release)
- mto: This revision was merged to the branch mainline in revision 300.
- Revision ID: teddy@recompile.se-20120308220444-8jjcgoxka6xz1tss
Merge general D-Bus annotations support.
- files added:
- 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,2009 Teddy Hogeborn
15
# Copyright © 2008,2009 Björn Påhlsson
14
# Copyright © 2008-2012 Teddy Hogeborn
15
# Copyright © 2008-2012 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@fukt.bsnet.se>.
31
# Contact the authors at <mandos@recompile.se>.
32
32
#
33
33
34
from __future__ import division, with_statement, absolute_import
34
from __future__ import (division, absolute_import, print_function,
35
unicode_literals)
35
36
36
37
import SocketServer as socketserver
37
38
import socket
38
import optparse
39
import argparse
39
40
import datetime
40
41
import errno
41
42
import gnutls.crypto
55
56
import logging
56
57
import logging.handlers
57
58
import pwd
58
from contextlib import closing
59
import contextlib
59
60
import struct
60
61
import fcntl
61
62
import functools
63
import cPickle as pickle
64
import multiprocessing
65
import types
66
import binascii
67
import tempfile
68
import itertools
62
69
63
70
import dbus
64
71
import dbus.service
69
76
import ctypes.util
70
77
import xml.dom.minidom
71
78
import inspect
79
import GnuPGInterface
72
80
73
81
try:
74
82
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
78
86
except ImportError:
79
87
SO_BINDTODEVICE = None
80
88
81
82
version = "1.0.13"
83
84
logger = logging.Logger(u'mandos')
89
version = "1.5.3"
90
stored_state_file = "clients.pickle"
91
92
logger = logging.getLogger()
85
93
syslogger = (logging.handlers.SysLogHandler
86
94
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
87
address = "/dev/log"))
88
syslogger.setFormatter(logging.Formatter
89
(u'Mandos [%(process)d]: %(levelname)s:'
90
u' %(message)s'))
91
logger.addHandler(syslogger)
92
93
console = logging.StreamHandler()
94
console.setFormatter(logging.Formatter(u'%(name)s [%(process)d]:'
95
u' %(levelname)s:'
96
u' %(message)s'))
97
logger.addHandler(console)
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
98
212
99
213
class AvahiError(Exception):
100
214
def __init__(self, value, *args, **kwargs):
116
230
Attributes:
117
231
interface: integer; avahi.IF_UNSPEC or an interface index.
118
232
Used to optionally bind to the specified interface.
119
name: string; Example: u'Mandos'
120
type: string; Example: u'_mandos._tcp'.
233
name: string; Example: 'Mandos'
234
type: string; Example: '_mandos._tcp'.
121
235
See <http://www.dns-sd.org/ServiceTypes.html>
122
236
port: integer; what port to announce
123
237
TXT: list of strings; TXT record for the service
132
246
"""
133
247
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
134
248
servicetype = None, port = None, TXT = None,
135
domain = u"", host = u"", max_renames = 32768,
249
domain = "", host = "", max_renames = 32768,
136
250
protocol = avahi.PROTO_UNSPEC, bus = None):
137
251
self.interface = interface
138
252
self.name = name
147
261
self.group = None # our entry group
148
262
self.server = None
149
263
self.bus = bus
264
self.entry_group_state_changed_match = None
150
265
def rename(self):
151
266
"""Derived from the Avahi example code"""
152
267
if self.rename_count >= self.max_renames:
153
logger.critical(u"No suitable Zeroconf service name found"
154
u" after %i retries, exiting.",
268
logger.critical("No suitable Zeroconf service name found"
269
" after %i retries, exiting.",
155
270
self.rename_count)
156
raise AvahiServiceError(u"Too many renames")
157
self.name = self.server.GetAlternativeServiceName(self.name)
158
logger.info(u"Changing Zeroconf service name to %r ...",
159
unicode(self.name))
160
syslogger.setFormatter(logging.Formatter
161
(u'Mandos (%s) [%%(process)d]:'
162
u' %%(levelname)s: %%(message)s'
163
% self.name))
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)
164
276
self.remove()
165
self.add()
277
try:
278
self.add()
279
except dbus.exceptions.DBusException as error:
280
logger.critical("DBusException: %s", error)
281
self.cleanup()
282
os._exit(1)
166
283
self.rename_count += 1
167
284
def remove(self):
168
285
"""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
169
289
if self.group is not None:
170
290
self.group.Reset()
171
291
def add(self):
172
292
"""Derived from the Avahi example code"""
293
self.remove()
173
294
if self.group is None:
174
295
self.group = dbus.Interface(
175
296
self.bus.get_object(avahi.DBUS_NAME,
176
297
self.server.EntryGroupNew()),
177
298
avahi.DBUS_INTERFACE_ENTRY_GROUP)
178
self.group.connect_to_signal('StateChanged',
179
self
180
.entry_group_state_changed)
181
logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
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' ...",
182
303
self.name, self.type)
183
304
self.group.AddService(
184
305
self.interface,
191
312
self.group.Commit()
192
313
def entry_group_state_changed(self, state, error):
193
314
"""Derived from the Avahi example code"""
194
logger.debug(u"Avahi state change: %i", state)
315
logger.debug("Avahi entry group state change: %i", state)
195
316
196
317
if state == avahi.ENTRY_GROUP_ESTABLISHED:
197
logger.debug(u"Zeroconf service established.")
318
logger.debug("Zeroconf service established.")
198
319
elif state == avahi.ENTRY_GROUP_COLLISION:
199
logger.warning(u"Zeroconf service name collision.")
320
logger.info("Zeroconf service name collision.")
200
321
self.rename()
201
322
elif state == avahi.ENTRY_GROUP_FAILURE:
202
logger.critical(u"Avahi: Error in group state changed %s",
323
logger.critical("Avahi: Error in group state changed %s",
203
324
unicode(error))
204
raise AvahiGroupError(u"State changed: %s"
325
raise AvahiGroupError("State changed: %s"
205
326
% unicode(error))
206
327
def cleanup(self):
207
328
"""Derived from the Avahi example code"""
208
329
if self.group is not None:
209
self.group.Free()
330
try:
331
self.group.Free()
332
except (dbus.exceptions.UnknownMethodException,
333
dbus.exceptions.DBusException):
334
pass
210
335
self.group = None
211
def server_state_changed(self, state):
336
self.remove()
337
def server_state_changed(self, state, error=None):
212
338
"""Derived from the Avahi example code"""
213
if state == avahi.SERVER_COLLISION:
214
logger.error(u"Zeroconf server name collision")
215
self.remove()
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()
216
354
elif state == avahi.SERVER_RUNNING:
217
355
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)
218
361
def activate(self):
219
362
"""Derived from the Avahi example code"""
220
363
if self.server is None:
221
364
self.server = dbus.Interface(
222
365
self.bus.get_object(avahi.DBUS_NAME,
223
avahi.DBUS_PATH_SERVER),
366
avahi.DBUS_PATH_SERVER,
367
follow_name_owner_changes=True),
224
368
avahi.DBUS_INTERFACE_SERVER)
225
self.server.connect_to_signal(u"StateChanged",
369
self.server.connect_to_signal("StateChanged",
226
370
self.server_state_changed)
227
371
self.server_state_changed(self.server.GetState())
228
372
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 (%s) [%%(process)d]:'
379
' %%(levelname)s: %%(message)s'
380
% self.name))
381
return ret
229
382
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
230
389
class Client(object):
231
390
"""A representation of a client host served by this server.
232
391
233
392
Attributes:
234
name: string; from the config file, used in log messages and
235
D-Bus identifiers
236
fingerprint: string (40 or 32 hexadecimal digits); used to
237
uniquely identify the client
238
secret: bytestring; sent verbatim (over TLS) to client
239
host: string; available for use by the checker command
240
created: datetime.datetime(); (UTC) object creation
241
last_enabled: datetime.datetime(); (UTC)
242
enabled: bool()
243
last_checked_ok: datetime.datetime(); (UTC) or None
244
timeout: datetime.timedelta(); How long from last_checked_ok
245
until this client is invalid
246
interval: datetime.timedelta(); How often to start a new checker
247
disable_hook: If set, called by disable() as disable_hook(self)
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
248
396
checker: subprocess.Popen(); a running checker process used
249
397
to see if the client lives.
250
398
'None' if no process is running.
251
checker_initiator_tag: a gobject event source tag, or None
252
disable_initiator_tag: - '' -
253
checker_callback_tag: - '' -
254
checker_command: string; External command which is run to check if
255
client lives. %() expansions are done at
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
256
402
runtime with vars(self) as dict, so that for
257
403
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
258
408
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
259
430
"""
260
431
261
@staticmethod
262
def _timedelta_to_milliseconds(td):
263
"Convert a datetime.timedelta() to milliseconds"
264
return ((td.days * 24 * 60 * 60 * 1000)
265
+ (td.seconds * 1000)
266
+ (td.microseconds // 1000))
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
}
267
446
268
447
def timeout_milliseconds(self):
269
448
"Return the 'timeout' attribute in milliseconds"
270
return self._timedelta_to_milliseconds(self.timeout)
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
454
272
455
def interval_milliseconds(self):
273
456
"Return the 'interval' attribute in milliseconds"
274
return self._timedelta_to_milliseconds(self.interval)
457
return timedelta_to_milliseconds(self.interval)
275
458
276
def __init__(self, name = None, disable_hook=None, config=None):
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 %s"
493
% 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
511
"""Note: the 'checker' key in 'config' sets the
278
512
'checker_command' attribute and *not* the 'checker'
279
513
attribute."""
280
514
self.name = name
281
if config is None:
282
config = {}
283
logger.debug(u"Creating client %r", self.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)
284
530
# Uppercase and remove spaces from fingerprint for later
285
531
# comparison purposes with return value from the fingerprint()
286
532
# function
287
self.fingerprint = (config[u"fingerprint"].upper()
288
.replace(u" ", u""))
289
logger.debug(u" Fingerprint: %s", self.fingerprint)
290
if u"secret" in config:
291
self.secret = config[u"secret"].decode(u"base64")
292
elif u"secfile" in config:
293
with closing(open(os.path.expanduser
294
(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
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
309
538
self.checker = None
310
539
self.checker_initiator_tag = None
311
540
self.disable_initiator_tag = None
312
541
self.checker_callback_tag = None
313
self.checker_command = config[u"checker"]
314
542
self.current_checker_command = None
315
self.last_connect = 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()
316
564
317
565
def enable(self):
318
566
"""Start this client's checker and timeout hooks"""
319
if getattr(self, u"enabled", False):
567
if getattr(self, "enabled", False):
320
568
# Already enabled
321
569
return
570
self.send_changedstate()
571
self.expires = datetime.datetime.utcnow() + self.timeout
572
self.enabled = True
322
573
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):
323
600
# Schedule a new checker to be started an 'interval' from now,
324
601
# and every interval from then on.
325
602
self.checker_initiator_tag = (gobject.timeout_add
326
603
(self.interval_milliseconds(),
327
604
self.start_checker))
328
# Also start a new checker *right now*.
329
self.start_checker()
330
605
# Schedule a disable() when 'timeout' has passed
331
606
self.disable_initiator_tag = (gobject.timeout_add
332
607
(self.timeout_milliseconds(),
333
608
self.disable))
334
self.enabled = True
335
336
def disable(self):
337
"""Disable this client."""
338
if not getattr(self, "enabled", False):
339
return False
340
logger.info(u"Disabling client %s", self.name)
341
if getattr(self, u"disable_initiator_tag", False):
342
gobject.source_remove(self.disable_initiator_tag)
343
self.disable_initiator_tag = None
344
if getattr(self, u"checker_initiator_tag", False):
345
gobject.source_remove(self.checker_initiator_tag)
346
self.checker_initiator_tag = None
347
self.stop_checker()
348
if self.disable_hook:
349
self.disable_hook(self)
350
self.enabled = False
351
# Do not run this again if called by a gobject.timeout_add
352
return False
353
354
def __del__(self):
355
self.disable_hook = None
356
self.disable()
609
# Also start a new checker *right now*.
610
self.start_checker()
357
611
358
612
def checker_callback(self, pid, condition, command):
359
613
"""The checker has completed, so take appropriate actions."""
360
614
self.checker_callback_tag = None
361
615
self.checker = None
362
616
if os.WIFEXITED(condition):
363
exitstatus = os.WEXITSTATUS(condition)
364
if exitstatus == 0:
365
logger.info(u"Checker for %(name)s succeeded",
617
self.last_checker_status = os.WEXITSTATUS(condition)
618
if self.last_checker_status == 0:
619
logger.info("Checker for %(name)s succeeded",
366
620
vars(self))
367
621
self.checked_ok()
368
622
else:
369
logger.info(u"Checker for %(name)s failed",
623
logger.info("Checker for %(name)s failed",
370
624
vars(self))
371
625
else:
372
logger.warning(u"Checker for %(name)s crashed?",
626
self.last_checker_status = -1
627
logger.warning("Checker for %(name)s crashed?",
373
628
vars(self))
374
629
375
630
def checked_ok(self):
376
"""Bump up the timeout for this client.
377
378
This should only be called when the client has been seen,
379
alive and well.
380
"""
631
"""Assert that the client has been seen, alive and well."""
381
632
self.last_checked_ok = datetime.datetime.utcnow()
382
gobject.source_remove(self.disable_initiator_tag)
383
self.disable_initiator_tag = (gobject.timeout_add
384
(self.timeout_milliseconds(),
385
self.disable))
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()
386
650
387
651
def start_checker(self):
388
652
"""Start a new checker subprocess if one is not running.
395
659
# client would inevitably timeout, since no checker would get
396
660
# a chance to run to completion. If we instead leave running
397
661
# checkers alone, the checker would have to take more time
398
# than 'timeout' for the client to be declared invalid, which
399
# is as it should be.
662
# than 'timeout' for the client to be disabled, which is as it
663
# should be.
400
664
401
665
# If a checker exists, make sure it is not a zombie
402
666
try:
403
667
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
404
except (AttributeError, OSError), error:
668
except (AttributeError, OSError) as error:
405
669
if (isinstance(error, OSError)
406
670
and error.errno != errno.ECHILD):
407
671
raise error
408
672
else:
409
673
if pid:
410
logger.warning(u"Checker was a zombie")
674
logger.warning("Checker was a zombie")
411
675
gobject.source_remove(self.checker_callback_tag)
412
676
self.checker_callback(pid, status,
413
677
self.current_checker_command)
418
682
command = self.checker_command % self.host
419
683
except TypeError:
420
684
# Escape attributes for the shell
421
escaped_attrs = dict((key,
422
re.escape(unicode(str(val),
423
errors=
424
u'replace')))
425
for key, val in
426
vars(self).iteritems())
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
427
693
try:
428
694
command = self.checker_command % escaped_attrs
429
except TypeError, error:
430
logger.error(u'Could not format string "%s":'
431
u' %s', self.checker_command, error)
695
except TypeError as error:
696
logger.error('Could not format string "%s":'
697
' %s', self.checker_command, error)
432
698
return True # Try again later
433
699
self.current_checker_command = command
434
700
try:
435
logger.info(u"Starting checker %r for %s",
701
logger.info("Starting checker %r for %s",
436
702
command, self.name)
437
703
# We don't need to redirect stdout and stderr, since
438
704
# in normal mode, that is already done by daemon(),
440
706
# always replaced by /dev/null.)
441
707
self.checker = subprocess.Popen(command,
442
708
close_fds=True,
443
shell=True, cwd=u"/")
709
shell=True, cwd="/")
444
710
self.checker_callback_tag = (gobject.child_watch_add
445
711
(self.checker.pid,
446
712
self.checker_callback,
451
717
if pid:
452
718
gobject.source_remove(self.checker_callback_tag)
453
719
self.checker_callback(pid, status, command)
454
except OSError, error:
455
logger.error(u"Failed to start subprocess: %s",
720
except OSError as error:
721
logger.error("Failed to start subprocess: %s",
456
722
error)
457
723
# Re-run this periodically if run by gobject.timeout_add
458
724
return True
462
728
if self.checker_callback_tag:
463
729
gobject.source_remove(self.checker_callback_tag)
464
730
self.checker_callback_tag = None
465
if getattr(self, u"checker", None) is None:
731
if getattr(self, "checker", None) is None:
466
732
return
467
logger.debug(u"Stopping checker for %(name)s", vars(self))
733
logger.debug("Stopping checker for %(name)s", vars(self))
468
734
try:
469
735
os.kill(self.checker.pid, signal.SIGTERM)
470
#os.sleep(0.5)
736
#time.sleep(0.5)
471
737
#if self.checker.poll() is None:
472
738
# os.kill(self.checker.pid, signal.SIGKILL)
473
except OSError, error:
739
except OSError as error:
474
740
if error.errno != errno.ESRCH: # No such process
475
741
raise
476
742
self.checker = None
477
478
def still_valid(self):
479
"""Has the timeout not yet passed for this client?"""
480
if not getattr(self, u"enabled", False):
481
return False
482
now = datetime.datetime.utcnow()
483
if self.last_checked_ok is None:
484
return now < (self.created + self.timeout)
485
else:
486
return now < (self.last_checked_ok + self.timeout)
487
488
489
def dbus_service_property(dbus_interface, signature=u"v",
490
access=u"readwrite", byte_arrays=False):
743
744
745
def dbus_service_property(dbus_interface, signature="v",
746
access="readwrite", byte_arrays=False):
491
747
"""Decorators for marking methods of a DBusObjectWithProperties to
492
748
become properties on the D-Bus.
493
749
498
754
dbus.service.method, except there is only "signature", since the
499
755
type from Get() and the type sent to Set() is the same.
500
756
"""
757
# Encoding deeply encoded byte arrays is not supported yet by the
758
# "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 %r" % signature)
501
762
def decorator(func):
502
763
func._dbus_is_property = True
503
764
func._dbus_interface = dbus_interface
504
765
func._dbus_signature = signature
505
766
func._dbus_access = access
506
767
func._dbus_name = func.__name__
507
if func._dbus_name.endswith(u"_dbus_property"):
768
if func._dbus_name.endswith("_dbus_property"):
508
769
func._dbus_name = func._dbus_name[:-14]
509
func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
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
510
808
return func
511
809
return decorator
512
810
532
830
533
831
class DBusObjectWithProperties(dbus.service.Object):
534
832
"""A D-Bus object with properties.
535
833
536
834
Classes inheriting from this can use the dbus_service_property
537
835
decorator to expose methods as D-Bus properties. It exposes the
538
836
standard Get(), Set(), and GetAll() methods on the D-Bus.
539
837
"""
540
838
541
839
@staticmethod
542
def _is_dbus_property(obj):
543
return getattr(obj, u"_dbus_is_property", False)
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)
544
848
545
def _get_all_dbus_properties(self):
849
def _get_all_dbus_things(self, thing):
546
850
"""Returns a generator of (name, attribute) pairs
547
851
"""
548
return ((prop._dbus_name, prop)
549
for name, prop in
550
inspect.getmembers(self, self._is_dbus_property))
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)))
551
859
552
860
def _get_dbus_property(self, interface_name, property_name):
553
861
"""Returns a bound method if one exists which is a D-Bus
554
862
property with the specified name and interface.
555
863
"""
556
for name in (property_name,
557
property_name + u"_dbus_property"):
558
prop = getattr(self, name, None)
559
if (prop is None
560
or not self._is_dbus_property(prop)
561
or prop._dbus_name != property_name
562
or (interface_name and prop._dbus_interface
563
and interface_name != prop._dbus_interface)):
564
continue
565
return prop
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
566
872
# No such property
567
raise DBusPropertyNotFound(self.dbus_object_path + u":"
568
+ interface_name + u"."
873
raise DBusPropertyNotFound(self.dbus_object_path + ":"
874
+ interface_name + "."
569
875
+ property_name)
570
876
571
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
572
out_signature=u"v")
877
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
878
out_signature="v")
573
879
def Get(self, interface_name, property_name):
574
880
"""Standard D-Bus property Get() method, see D-Bus standard.
575
881
"""
576
882
prop = self._get_dbus_property(interface_name, property_name)
577
if prop._dbus_access == u"write":
883
if prop._dbus_access == "write":
578
884
raise DBusPropertyAccessException(property_name)
579
885
value = prop()
580
if not hasattr(value, u"variant_level"):
886
if not hasattr(value, "variant_level"):
581
887
return value
582
888
return type(value)(value, variant_level=value.variant_level+1)
583
889
584
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
890
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
585
891
def Set(self, interface_name, property_name, value):
586
892
"""Standard D-Bus property Set() method, see D-Bus standard.
587
893
"""
588
894
prop = self._get_dbus_property(interface_name, property_name)
589
if prop._dbus_access == u"read":
895
if prop._dbus_access == "read":
590
896
raise DBusPropertyAccessException(property_name)
591
if prop._dbus_get_args_options[u"byte_arrays"]:
592
value = dbus.ByteArray(''.join(unichr(byte)
593
for byte in value))
897
if prop._dbus_get_args_options["byte_arrays"]:
898
# The byte_arrays option is not supported yet on
899
# signatures other than "ay".
900
if prop._dbus_signature != "ay":
901
raise ValueError
902
value = dbus.ByteArray(b''.join(chr(byte)
903
for byte in value))
594
904
prop(value)
595
905
596
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
597
out_signature=u"a{sv}")
906
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
907
out_signature="a{sv}")
598
908
def GetAll(self, interface_name):
599
909
"""Standard D-Bus property GetAll() method, see D-Bus
600
910
standard.
601
911
602
912
Note: Will not include properties with access="write".
603
913
"""
604
all = {}
605
for name, prop in self._get_all_dbus_properties():
914
properties = {}
915
for name, prop in self._get_all_dbus_things("property"):
606
916
if (interface_name
607
917
and interface_name != prop._dbus_interface):
608
918
# Interface non-empty but did not match
609
919
continue
610
920
# Ignore write-only properties
611
if prop._dbus_access == u"write":
921
if prop._dbus_access == "write":
612
922
continue
613
923
value = prop()
614
if not hasattr(value, u"variant_level"):
615
all[name] = value
924
if not hasattr(value, "variant_level"):
925
properties[name] = value
616
926
continue
617
all[name] = type(value)(value, variant_level=
618
value.variant_level+1)
619
return dbus.Dictionary(all, signature=u"sv")
927
properties[name] = type(value)(value, variant_level=
928
value.variant_level+1)
929
return dbus.Dictionary(properties, signature="sv")
620
930
621
931
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
622
out_signature=u"s",
932
out_signature="s",
623
933
path_keyword='object_path',
624
934
connection_keyword='connection')
625
935
def Introspect(self, object_path, connection):
626
"""Standard D-Bus method, overloaded to insert property tags.
936
"""Overloading of standard D-Bus method.
937
938
Inserts property tags and interface annotation tags.
627
939
"""
628
940
xmlstring = dbus.service.Object.Introspect(self, object_path,
629
941
connection)
630
942
try:
631
943
document = xml.dom.minidom.parseString(xmlstring)
632
944
def make_tag(document, name, prop):
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)
945
e = document.createElement("property")
946
e.setAttribute("name", name)
947
e.setAttribute("type", prop._dbus_signature)
948
e.setAttribute("access", prop._dbus_access)
637
949
return e
638
for if_tag in document.getElementsByTagName(u"interface"):
950
for if_tag in document.getElementsByTagName("interface"):
951
# Add property tags
639
952
for tag in (make_tag(document, name, prop)
640
953
for name, prop
641
in self._get_all_dbus_properties()
954
in self._get_all_dbus_things("property")
642
955
if prop._dbus_interface
643
== if_tag.getAttribute(u"name")):
956
== if_tag.getAttribute("name")):
644
957
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)
645
989
# Add the names to the return values for the
646
990
# "org.freedesktop.DBus.Properties" methods
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")
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")
661
1005
document.unlink()
662
1006
except (AttributeError, xml.dom.DOMException,
663
xml.parsers.expat.ExpatError), error:
664
logger.error(u"Failed to override Introspection method",
1007
xml.parsers.expat.ExpatError) as error:
1008
logger.error("Failed to override Introspection method",
665
1009
error)
666
1010
return xmlstring
667
1011
668
1012
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
669
1166
class ClientDBus(Client, DBusObjectWithProperties):
670
1167
"""A Client class using D-Bus
671
1168
673
1170
dbus_object_path: dbus.ObjectPath
674
1171
bus: dbus.SystemBus()
675
1172
"""
1173
1174
runtime_expansions = (Client.runtime_expansions
1175
+ ("dbus_object_path",))
1176
676
1177
# dbus.service.Object doesn't use super(), so we can't either.
677
1178
678
1179
def __init__(self, bus = None, *args, **kwargs):
680
1181
Client.__init__(self, *args, **kwargs)
681
1182
# Only now, when this client is initialized, can it show up on
682
1183
# the D-Bus
1184
client_object_name = unicode(self.name).translate(
1185
{ord("."): ord("_"),
1186
ord("-"): ord("_")})
683
1187
self.dbus_object_path = (dbus.ObjectPath
684
(u"/clients/"
685
+ self.name.replace(u".", u"_")))
1188
("/clients/" + client_object_name))
686
1189
DBusObjectWithProperties.__init__(self, self.bus,
687
1190
self.dbus_object_path)
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, signal = True):
709
oldstate = getattr(self, u"enabled", False)
710
r = Client.disable(self)
711
if signal 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
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
716
1260
717
1261
def __del__(self, *args, **kwargs):
718
1262
try:
719
1263
self.remove_from_connection()
720
1264
except LookupError:
721
1265
pass
722
if hasattr(DBusObjectWithProperties, u"__del__"):
1266
if hasattr(DBusObjectWithProperties, "__del__"):
723
1267
DBusObjectWithProperties.__del__(self, *args, **kwargs)
724
1268
Client.__del__(self, *args, **kwargs)
725
1269
727
1271
*args, **kwargs):
728
1272
self.checker_callback_tag = None
729
1273
self.checker = None
730
# Emit D-Bus signal
731
self.PropertyChanged(dbus.String(u"checker_running"),
732
dbus.Boolean(False, variant_level=1))
733
1274
if os.WIFEXITED(condition):
734
1275
exitstatus = os.WEXITSTATUS(condition)
735
1276
# Emit D-Bus signal
745
1286
return Client.checker_callback(self, pid, condition, command,
746
1287
*args, **kwargs)
747
1288
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
757
1289
def start_checker(self, *args, **kwargs):
758
1290
old_checker = self.checker
759
1291
if self.checker is not None:
766
1298
and old_checker_pid != self.checker.pid):
767
1299
# Emit D-Bus signal
768
1300
self.CheckerStarted(self.current_checker_command)
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
782
783
## D-Bus methods & signals
784
_interface = u"se.bsnet.fukt.Mandos.Client"
785
786
# CheckedOK - method
787
@dbus.service.method(_interface)
788
def CheckedOK(self):
789
return self.checked_ok()
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
1314
1315
## 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"}
1324
1325
## Signals
790
1326
791
1327
# CheckerCompleted - signal
792
@dbus.service.signal(_interface, signature=u"nxs")
1328
@dbus.service.signal(_interface, signature="nxs")
793
1329
def CheckerCompleted(self, exitcode, waitstatus, command):
794
1330
"D-Bus signal"
795
1331
pass
796
1332
797
1333
# CheckerStarted - signal
798
@dbus.service.signal(_interface, signature=u"s")
1334
@dbus.service.signal(_interface, signature="s")
799
1335
def CheckerStarted(self, command):
800
1336
"D-Bus signal"
801
1337
pass
802
1338
803
1339
# PropertyChanged - signal
804
@dbus.service.signal(_interface, signature=u"sv")
1340
@dbus.service.signal(_interface, signature="sv")
805
1341
def PropertyChanged(self, property, value):
806
1342
"D-Bus signal"
807
1343
pass
809
1345
# GotSecret - signal
810
1346
@dbus.service.signal(_interface)
811
1347
def GotSecret(self):
812
"D-Bus signal"
1348
"""D-Bus signal
1349
Is sent after a successful transfer of secret from the Mandos
1350
server to mandos-client
1351
"""
813
1352
pass
814
1353
815
1354
# Rejected - signal
816
@dbus.service.signal(_interface)
817
def Rejected(self):
1355
@dbus.service.signal(_interface, signature="s")
1356
def Rejected(self, reason):
818
1357
"D-Bus signal"
819
1358
pass
820
1359
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
## Methods
1367
1368
# Approve - method
1369
@dbus.service.method(_interface, in_signature="b")
1370
def Approve(self, value):
1371
self.approve(value)
1372
1373
# CheckedOK - method
1374
@dbus.service.method(_interface)
1375
def CheckedOK(self):
1376
self.checked_ok()
1377
821
1378
# Enable - method
822
1379
@dbus.service.method(_interface)
823
1380
def Enable(self):
841
1398
def StopChecker(self):
842
1399
self.stop_checker()
843
1400
844
# name - property
845
@dbus_service_property(_interface, signature=u"s", access=u"read")
846
def name_dbus_property(self):
1401
## Properties
1402
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):
847
1436
return dbus.String(self.name)
848
1437
849
# fingerprint - property
850
@dbus_service_property(_interface, signature=u"s", access=u"read")
851
def fingerprint_dbus_property(self):
1438
# Fingerprint - property
1439
@dbus_service_property(_interface, signature="s", access="read")
1440
def Fingerprint_dbus_property(self):
852
1441
return dbus.String(self.fingerprint)
853
1442
854
# host - property
855
@dbus_service_property(_interface, signature=u"s",
856
access=u"readwrite")
857
def host_dbus_property(self, value=None):
1443
# Host - property
1444
@dbus_service_property(_interface, signature="s",
1445
access="readwrite")
1446
def Host_dbus_property(self, value=None):
858
1447
if value is None: # get
859
1448
return dbus.String(self.host)
860
self.host = value
861
# Emit D-Bus signal
862
self.PropertyChanged(dbus.String(u"host"),
863
dbus.String(value, variant_level=1))
864
865
# created - property
866
@dbus_service_property(_interface, signature=u"s", access=u"read")
867
def created_dbus_property(self):
868
return dbus.String(self._datetime_to_dbus(self.created))
869
870
# last_enabled - property
871
@dbus_service_property(_interface, signature=u"s", access=u"read")
872
def last_enabled_dbus_property(self):
873
if self.last_enabled is None:
874
return dbus.String(u"")
875
return dbus.String(self._datetime_to_dbus(self.last_enabled))
876
877
# enabled - property
878
@dbus_service_property(_interface, signature=u"b",
879
access=u"readwrite")
880
def enabled_dbus_property(self, value=None):
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):
881
1465
if value is None: # get
882
1466
return dbus.Boolean(self.enabled)
883
1467
if value:
885
1469
else:
886
1470
self.disable()
887
1471
888
# last_checked_ok - property
889
@dbus_service_property(_interface, signature=u"s",
890
access=u"readwrite")
891
def last_checked_ok_dbus_property(self, value=None):
1472
# LastCheckedOK - property
1473
@dbus_service_property(_interface, signature="s",
1474
access="readwrite")
1475
def LastCheckedOK_dbus_property(self, value=None):
892
1476
if value is not None:
893
1477
self.checked_ok()
894
1478
return
895
if self.last_checked_ok is None:
896
return dbus.String(u"")
897
return dbus.String(self._datetime_to_dbus(self
898
.last_checked_ok))
899
900
# timeout - property
901
@dbus_service_property(_interface, signature=u"t",
902
access=u"readwrite")
903
def timeout_dbus_property(self, value=None):
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):
904
1501
if value is None: # get
905
1502
return dbus.UInt64(self.timeout_milliseconds())
906
1503
self.timeout = datetime.timedelta(0, 0, 0, value)
907
# Emit D-Bus signal
908
self.PropertyChanged(dbus.String(u"timeout"),
909
dbus.UInt64(value, variant_level=1))
910
if getattr(self, u"disable_initiator_tag", None) is None:
911
return
912
1504
# Reschedule timeout
913
gobject.source_remove(self.disable_initiator_tag)
914
self.disable_initiator_tag = None
915
time_to_die = (self.
916
_timedelta_to_milliseconds((self
917
.last_checked_ok
918
+ self.timeout)
919
- datetime.datetime
920
.utcnow()))
921
if time_to_die <= 0:
922
# The timeout has passed
923
self.disable()
924
else:
925
self.disable_initiator_tag = (gobject.timeout_add
926
(time_to_die, self.disable))
927
928
# interval - property
929
@dbus_service_property(_interface, signature=u"t",
930
access=u"readwrite")
931
def interval_dbus_property(self, value=None):
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):
932
1536
if value is None: # get
933
1537
return dbus.UInt64(self.interval_milliseconds())
934
1538
self.interval = datetime.timedelta(0, 0, 0, value)
935
# Emit D-Bus signal
936
self.PropertyChanged(dbus.String(u"interval"),
937
dbus.UInt64(value, variant_level=1))
938
if getattr(self, u"checker_initiator_tag", None) is None:
1539
if getattr(self, "checker_initiator_tag", None) is None:
939
1540
return
940
# Reschedule checker run
941
gobject.source_remove(self.checker_initiator_tag)
942
self.checker_initiator_tag = (gobject.timeout_add
943
(value, self.start_checker))
944
self.start_checker() # Start one now, too
945
946
# checker - property
947
@dbus_service_property(_interface, signature=u"s",
948
access=u"readwrite")
949
def checker_dbus_property(self, value=None):
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):
950
1552
if value is None: # get
951
1553
return dbus.String(self.checker_command)
952
self.checker_command = value
953
# Emit D-Bus signal
954
self.PropertyChanged(dbus.String(u"checker"),
955
dbus.String(self.checker_command,
956
variant_level=1))
1554
self.checker_command = unicode(value)
957
1555
958
# checker_running - property
959
@dbus_service_property(_interface, signature=u"b",
960
access=u"readwrite")
961
def checker_running_dbus_property(self, value=None):
1556
# CheckerRunning - property
1557
@dbus_service_property(_interface, signature="b",
1558
access="readwrite")
1559
def CheckerRunning_dbus_property(self, value=None):
962
1560
if value is None: # get
963
1561
return dbus.Boolean(self.checker is not None)
964
1562
if value:
966
1564
else:
967
1565
self.stop_checker()
968
1566
969
# object_path - property
970
@dbus_service_property(_interface, signature=u"o", access=u"read")
971
def object_path_dbus_property(self):
1567
# ObjectPath - property
1568
@dbus_service_property(_interface, signature="o", access="read")
1569
def ObjectPath_dbus_property(self):
972
1570
return self.dbus_object_path # is already a dbus.ObjectPath
973
1571
974
# secret = property
975
@dbus_service_property(_interface, signature=u"ay",
976
access=u"write", byte_arrays=True)
977
def secret_dbus_property(self, value):
1572
# Secret = property
1573
@dbus_service_property(_interface, signature="ay",
1574
access="write", byte_arrays=True)
1575
def Secret_dbus_property(self, value):
978
1576
self.secret = str(value)
979
1577
980
1578
del _interface
981
1579
982
1580
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
983
1611
class ClientHandler(socketserver.BaseRequestHandler, object):
984
1612
"""A class to handle client connections.
985
1613
987
1615
Note: This will run in its own forked process."""
988
1616
989
1617
def handle(self):
990
logger.info(u"TCP connection from: %s",
991
unicode(self.client_address))
992
logger.debug(u"IPC Pipe FD: %d", self.server.pipe[1])
993
# Open IPC pipe to parent process
994
with closing(os.fdopen(self.server.pipe[1], u"w", 1)) as ipc:
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
995
1624
session = (gnutls.connection
996
1625
.ClientSession(self.request,
997
1626
gnutls.connection
998
1627
.X509Credentials()))
999
1628
1000
line = self.request.makefile().readline()
1001
logger.debug(u"Protocol version: %r", line)
1002
try:
1003
if int(line.strip().split()[0]) > 1:
1004
raise RuntimeError
1005
except (ValueError, IndexError, RuntimeError), error:
1006
logger.error(u"Unknown protocol version: %s", error)
1007
return
1008
1009
1629
# Note: gnutls.connection.X509Credentials is really a
1010
1630
# generic GnuTLS certificate credentials object so long as
1011
1631
# no X.509 keys are added to it. Therefore, we can use it
1012
1632
# here despite using OpenPGP certificates.
1013
1633
1014
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1015
# u"+AES-256-CBC", u"+SHA1",
1016
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
1017
# u"+DHE-DSS"))
1634
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1635
# "+AES-256-CBC", "+SHA1",
1636
# "+COMP-NULL", "+CTYPE-OPENPGP",
1637
# "+DHE-DSS"))
1018
1638
# Use a fallback default, since this MUST be set.
1019
1639
priority = self.server.gnutls_priority
1020
1640
if priority is None:
1021
priority = u"NORMAL"
1641
priority = "NORMAL"
1022
1642
(gnutls.library.functions
1023
1643
.gnutls_priority_set_direct(session._c_object,
1024
1644
priority, None))
1025
1645
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
1026
1658
try:
1027
1659
session.handshake()
1028
except gnutls.errors.GNUTLSError, error:
1029
logger.warning(u"Handshake failed: %s", error)
1660
except gnutls.errors.GNUTLSError as error:
1661
logger.warning("Handshake failed: %s", error)
1030
1662
# Do not run session.bye() here: the session is not
1031
1663
# established. Just abandon the request.
1032
1664
return
1033
logger.debug(u"Handshake succeeded")
1665
logger.debug("Handshake succeeded")
1666
1667
approval_required = False
1034
1668
try:
1035
fpr = self.fingerprint(self.peer_certificate(session))
1036
except (TypeError, gnutls.errors.GNUTLSError), error:
1037
logger.warning(u"Bad certificate: %s", error)
1038
session.bye()
1039
return
1040
logger.debug(u"Fingerprint: %s", fpr)
1669
try:
1670
fpr = self.fingerprint(self.peer_certificate
1671
(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
1700
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
1739
sent_size = 0
1740
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",
1747
sent, len(client.secret)
1748
- (sent_size + sent))
1749
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()
1041
1757
1042
for c in self.server.clients:
1043
if c.fingerprint == fpr:
1044
client = c
1045
break
1046
else:
1047
ipc.write(u"NOTFOUND %s %s\n"
1048
% (fpr, unicode(self.client_address)))
1049
session.bye()
1050
return
1051
# Have to check if client.still_valid(), since it is
1052
# possible that the client timed out while establishing
1053
# the GnuTLS session.
1054
if not client.still_valid():
1055
ipc.write(u"INVALID %s\n" % client.name)
1056
session.bye()
1057
return
1058
ipc.write(u"SENDING %s\n" % client.name)
1059
sent_size = 0
1060
while sent_size < len(client.secret):
1061
sent = session.send(client.secret[sent_size:])
1062
logger.debug(u"Sent: %d, remaining: %d",
1063
sent, len(client.secret)
1064
- (sent_size + sent))
1065
sent_size += sent
1066
session.bye()
1758
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")
1067
1765
1068
1766
@staticmethod
1069
1767
def peer_certificate(session):
1079
1777
.gnutls_certificate_get_peers
1080
1778
(session._c_object, ctypes.byref(list_size)))
1081
1779
if not bool(cert_list) and list_size.value != 0:
1082
raise gnutls.errors.GNUTLSError(u"error getting peer"
1083
u" certificate")
1780
raise gnutls.errors.GNUTLSError("error getting peer"
1781
" certificate")
1084
1782
if list_size.value == 0:
1085
1783
return None
1086
1784
cert = cert_list[0]
1112
1810
if crtverify.value != 0:
1113
1811
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1114
1812
raise (gnutls.errors.CertificateSecurityError
1115
(u"Verify failed"))
1813
("Verify failed"))
1116
1814
# New buffer for the fingerprint
1117
1815
buf = ctypes.create_string_buffer(20)
1118
1816
buf_len = ctypes.c_size_t()
1125
1823
# Convert the buffer to a Python bytestring
1126
1824
fpr = ctypes.string_at(buf, buf_len.value)
1127
1825
# Convert the bytestring to hexadecimal notation
1128
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
1826
hex_fpr = binascii.hexlify(fpr).upper()
1129
1827
return hex_fpr
1130
1828
1131
1829
1132
class ForkingMixInWithPipe(socketserver.ForkingMixIn, object):
1133
"""Like socketserver.ForkingMixIn, but also pass a pipe."""
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 """
1134
1850
def process_request(self, request, client_address):
1135
1851
"""Overrides and wraps the original process_request().
1136
1852
1137
1853
This function creates a new pipe in self.pipe
1138
1854
"""
1139
self.pipe = os.pipe()
1140
super(ForkingMixInWithPipe,
1141
self).process_request(request, client_address)
1142
os.close(self.pipe[1]) # close write end
1143
self.add_pipe(self.pipe[0])
1144
def add_pipe(self, pipe):
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):
1145
1863
"""Dummy function; override as necessary"""
1146
os.close(pipe)
1147
1148
1149
class IPv6_TCPServer(ForkingMixInWithPipe,
1864
raise NotImplementedError
1865
1866
1867
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1150
1868
socketserver.TCPServer, object):
1151
1869
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1152
1870
1168
1886
bind to an address or port if they were not specified."""
1169
1887
if self.interface is not None:
1170
1888
if SO_BINDTODEVICE is None:
1171
logger.error(u"SO_BINDTODEVICE does not exist;"
1172
u" cannot bind to interface %s",
1889
logger.error("SO_BINDTODEVICE does not exist;"
1890
" cannot bind to interface %s",
1173
1891
self.interface)
1174
1892
else:
1175
1893
try:
1176
1894
self.socket.setsockopt(socket.SOL_SOCKET,
1177
1895
SO_BINDTODEVICE,
1178
1896
str(self.interface
1179
+ u'\0'))
1180
except socket.error, error:
1897
+ '\0'))
1898
except socket.error as error:
1181
1899
if error[0] == errno.EPERM:
1182
logger.error(u"No permission to"
1183
u" bind to interface %s",
1900
logger.error("No permission to"
1901
" bind to interface %s",
1184
1902
self.interface)
1185
1903
elif error[0] == errno.ENOPROTOOPT:
1186
logger.error(u"SO_BINDTODEVICE not available;"
1187
u" cannot bind to interface %s",
1904
logger.error("SO_BINDTODEVICE not available;"
1905
" cannot bind to interface %s",
1188
1906
self.interface)
1189
1907
else:
1190
1908
raise
1192
1910
if self.server_address[0] or self.server_address[1]:
1193
1911
if not self.server_address[0]:
1194
1912
if self.address_family == socket.AF_INET6:
1195
any_address = u"::" # in6addr_any
1913
any_address = "::" # in6addr_any
1196
1914
else:
1197
1915
any_address = socket.INADDR_ANY
1198
1916
self.server_address = (any_address,
1225
1943
self.enabled = False
1226
1944
self.clients = clients
1227
1945
if self.clients is None:
1228
self.clients = set()
1946
self.clients = {}
1229
1947
self.use_dbus = use_dbus
1230
1948
self.gnutls_priority = gnutls_priority
1231
1949
IPv6_TCPServer.__init__(self, server_address,
1235
1953
def server_activate(self):
1236
1954
if self.enabled:
1237
1955
return socketserver.TCPServer.server_activate(self)
1956
1238
1957
def enable(self):
1239
1958
self.enabled = True
1240
def add_pipe(self, pipe):
1959
1960
def add_pipe(self, parent_pipe, proc):
1241
1961
# Call "handle_ipc" for both data and EOF events
1242
gobject.io_add_watch(pipe, gobject.IO_IN | gobject.IO_HUP,
1243
self.handle_ipc)
1244
def handle_ipc(self, source, condition, file_objects={}):
1962
gobject.io_add_watch(parent_pipe.fileno(),
1963
gobject.IO_IN | gobject.IO_HUP,
1964
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):
1245
1971
condition_names = {
1246
gobject.IO_IN: u"IN", # There is data to read.
1247
gobject.IO_OUT: u"OUT", # Data can be written (without
1972
gobject.IO_IN: "IN", # There is data to read.
1973
gobject.IO_OUT: "OUT", # Data can be written (without
1248
1974
# blocking).
1249
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1250
gobject.IO_ERR: u"ERR", # Error condition.
1251
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
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
1252
1978
# broken, usually for pipes and
1253
1979
# sockets).
1254
1980
}
1256
1982
for cond, name in
1257
1983
condition_names.iteritems()
1258
1984
if cond & condition)
1259
logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
1260
conditions_string)
1261
1262
# Turn the pipe file descriptor into a Python file object
1263
if source not in file_objects:
1264
file_objects[source] = os.fdopen(source, u"r", 1)
1265
1266
# Read a line from the file object
1267
cmdline = file_objects[source].readline()
1268
if not cmdline: # Empty line means end of file
1269
# close the IPC pipe
1270
file_objects[source].close()
1271
del file_objects[source]
1272
1273
# Stop calling this function
1274
return False
1275
1276
logger.debug(u"IPC command: %r", cmdline)
1277
1278
# Parse and act on command
1279
cmd, args = cmdline.rstrip(u"\r\n").split(None, 1)
1280
1281
if cmd == u"NOTFOUND":
1282
logger.warning(u"Client not found for fingerprint: %s",
1283
args)
1284
if self.use_dbus:
1285
# Emit D-Bus signal
1286
mandos_dbus_service.ClientNotFound(args)
1287
elif cmd == u"INVALID":
1288
for client in self.clients:
1289
if client.name == args:
1290
logger.warning(u"Client %s is invalid", args)
1291
if self.use_dbus:
1292
# Emit D-Bus signal
1293
client.Rejected()
1294
break
1295
else:
1296
logger.error(u"Unknown client %s is invalid", args)
1297
elif cmd == u"SENDING":
1298
for client in self.clients:
1299
if client.name == args:
1300
logger.info(u"Sending secret to %s", client.name)
1301
client.checked_ok()
1302
if self.use_dbus:
1303
# Emit D-Bus signal
1304
client.GotSecret()
1305
break
1306
else:
1307
logger.error(u"Sending secret to unknown client %s",
1308
args)
1309
else:
1310
logger.error(u"Unknown IPC command: %r", cmdline)
1311
1312
# Keep calling this function
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
1313
2047
return True
1314
2048
1315
2049
1316
2050
def string_to_delta(interval):
1317
2051
"""Parse a string and return a datetime.timedelta
1318
2052
1319
>>> string_to_delta(u'7d')
2053
>>> string_to_delta('7d')
1320
2054
datetime.timedelta(7)
1321
>>> string_to_delta(u'60s')
2055
>>> string_to_delta('60s')
1322
2056
datetime.timedelta(0, 60)
1323
>>> string_to_delta(u'60m')
2057
>>> string_to_delta('60m')
1324
2058
datetime.timedelta(0, 3600)
1325
>>> string_to_delta(u'24h')
2059
>>> string_to_delta('24h')
1326
2060
datetime.timedelta(1)
1327
>>> string_to_delta(u'1w')
2061
>>> string_to_delta('1w')
1328
2062
datetime.timedelta(7)
1329
>>> string_to_delta(u'5m 30s')
2063
>>> string_to_delta('5m 30s')
1330
2064
datetime.timedelta(0, 330)
1331
2065
"""
1332
2066
timevalue = datetime.timedelta(0)
1334
2068
try:
1335
2069
suffix = unicode(s[-1])
1336
2070
value = int(s[:-1])
1337
if suffix == u"d":
2071
if suffix == "d":
1338
2072
delta = datetime.timedelta(value)
1339
elif suffix == u"s":
2073
elif suffix == "s":
1340
2074
delta = datetime.timedelta(0, value)
1341
elif suffix == u"m":
2075
elif suffix == "m":
1342
2076
delta = datetime.timedelta(0, 0, 0, 0, value)
1343
elif suffix == u"h":
2077
elif suffix == "h":
1344
2078
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1345
elif suffix == u"w":
2079
elif suffix == "w":
1346
2080
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1347
2081
else:
1348
raise ValueError
1349
except (ValueError, IndexError):
1350
raise ValueError
2082
raise ValueError("Unknown suffix %r" % suffix)
2083
except (ValueError, IndexError) as e:
2084
raise ValueError(*(e.args))
1351
2085
timevalue += delta
1352
2086
return timevalue
1353
2087
1354
2088
1355
def if_nametoindex(interface):
1356
"""Call the C function if_nametoindex(), or equivalent
1357
1358
Note: This function cannot accept a unicode string."""
1359
global if_nametoindex
1360
try:
1361
if_nametoindex = (ctypes.cdll.LoadLibrary
1362
(ctypes.util.find_library(u"c"))
1363
.if_nametoindex)
1364
except (OSError, AttributeError):
1365
logger.warning(u"Doing if_nametoindex the hard way")
1366
def if_nametoindex(interface):
1367
"Get an interface index the hard way, i.e. using fcntl()"
1368
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1369
with closing(socket.socket()) as s:
1370
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1371
struct.pack(str(u"16s16x"),
1372
interface))
1373
interface_index = struct.unpack(str(u"I"),
1374
ifreq[16:20])[0]
1375
return interface_index
1376
return if_nametoindex(interface)
1377
1378
1379
2089
def daemon(nochdir = False, noclose = False):
1380
2090
"""See daemon(3). Standard BSD Unix function.
1381
2091
1384
2094
sys.exit()
1385
2095
os.setsid()
1386
2096
if not nochdir:
1387
os.chdir(u"/")
2097
os.chdir("/")
1388
2098
if os.fork():
1389
2099
sys.exit()
1390
2100
if not noclose:
1391
2101
# Close all standard open file descriptors
1392
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2102
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1393
2103
if not stat.S_ISCHR(os.fstat(null).st_mode):
1394
2104
raise OSError(errno.ENODEV,
1395
u"%s not a character device"
1396
% os.path.devnull)
2105
"%s not a character device"
2106
% os.devnull)
1397
2107
os.dup2(null, sys.stdin.fileno())
1398
2108
os.dup2(null, sys.stdout.fileno())
1399
2109
os.dup2(null, sys.stderr.fileno())
1406
2116
##################################################################
1407
2117
# Parsing of options, both command line and config file
1408
2118
1409
parser = optparse.OptionParser(version = "%%prog %s" % version)
1410
parser.add_option("-i", u"--interface", type=u"string",
1411
metavar="IF", help=u"Bind to interface IF")
1412
parser.add_option("-a", u"--address", type=u"string",
1413
help=u"Address to listen for requests on")
1414
parser.add_option("-p", u"--port", type=u"int",
1415
help=u"Port number to receive requests on")
1416
parser.add_option("--check", action=u"store_true",
1417
help=u"Run self-test")
1418
parser.add_option("--debug", action=u"store_true",
1419
help=u"Debug mode; run in foreground and log to"
1420
u" terminal")
1421
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1422
u" priority string (see GnuTLS documentation)")
1423
parser.add_option("--servicename", type=u"string",
1424
metavar=u"NAME", help=u"Zeroconf service name")
1425
parser.add_option("--configdir", type=u"string",
1426
default=u"/etc/mandos", metavar=u"DIR",
1427
help=u"Directory to search for configuration"
1428
u" files")
1429
parser.add_option("--no-dbus", action=u"store_false",
1430
dest=u"use_dbus", help=u"Do not provide D-Bus"
1431
u" system bus interface")
1432
parser.add_option("--no-ipv6", action=u"store_false",
1433
dest=u"use_ipv6", help=u"Do not use IPv6")
1434
options = parser.parse_args()[0]
2119
parser = argparse.ArgumentParser()
2120
parser.add_argument("-v", "--version", action="version",
2121
version = "%%(prog)s %s" % version,
2122
help="show version number and exit")
2123
parser.add_argument("-i", "--interface", metavar="IF",
2124
help="Bind to interface IF")
2125
parser.add_argument("-a", "--address",
2126
help="Address to listen for requests on")
2127
parser.add_argument("-p", "--port", type=int,
2128
help="Port number to receive requests on")
2129
parser.add_argument("--check", action="store_true",
2130
help="Run self-test")
2131
parser.add_argument("--debug", action="store_true",
2132
help="Debug mode; run in foreground and log"
2133
" to terminal")
2134
parser.add_argument("--debuglevel", metavar="LEVEL",
2135
help="Debug level for stdout output")
2136
parser.add_argument("--priority", help="GnuTLS"
2137
" priority string (see GnuTLS documentation)")
2138
parser.add_argument("--servicename",
2139
metavar="NAME", help="Zeroconf service name")
2140
parser.add_argument("--configdir",
2141
default="/etc/mandos", metavar="DIR",
2142
help="Directory to search for configuration"
2143
" files")
2144
parser.add_argument("--no-dbus", action="store_false",
2145
dest="use_dbus", help="Do not provide D-Bus"
2146
" system bus interface")
2147
parser.add_argument("--no-ipv6", action="store_false",
2148
dest="use_ipv6", help="Do not use IPv6")
2149
parser.add_argument("--no-restore", action="store_false",
2150
dest="restore", help="Do not restore stored"
2151
" state")
2152
parser.add_argument("--statedir", metavar="DIR",
2153
help="Directory to save/restore state in")
2154
2155
options = parser.parse_args()
1435
2156
1436
2157
if options.check:
1437
2158
import doctest
1439
2160
sys.exit()
1440
2161
1441
2162
# Default values for config file for server-global settings
1442
server_defaults = { u"interface": u"",
1443
u"address": u"",
1444
u"port": u"",
1445
u"debug": u"False",
1446
u"priority":
1447
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1448
u"servicename": u"Mandos",
1449
u"use_dbus": u"True",
1450
u"use_ipv6": u"True",
2163
server_defaults = { "interface": "",
2164
"address": "",
2165
"port": "",
2166
"debug": "False",
2167
"priority":
2168
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2169
"servicename": "Mandos",
2170
"use_dbus": "True",
2171
"use_ipv6": "True",
2172
"debuglevel": "",
2173
"restore": "True",
2174
"statedir": "/var/lib/mandos"
1451
2175
}
1452
2176
1453
2177
# Parse config file for server-global settings
1454
2178
server_config = configparser.SafeConfigParser(server_defaults)
1455
2179
del server_defaults
1456
2180
server_config.read(os.path.join(options.configdir,
1457
u"mandos.conf"))
2181
"mandos.conf"))
1458
2182
# Convert the SafeConfigParser object to a dict
1459
2183
server_settings = server_config.defaults()
1460
2184
# Use the appropriate methods on the non-string config options
1461
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1462
server_settings[option] = server_config.getboolean(u"DEFAULT",
2185
for option in ("debug", "use_dbus", "use_ipv6"):
2186
server_settings[option] = server_config.getboolean("DEFAULT",
1463
2187
option)
1464
2188
if server_settings["port"]:
1465
server_settings["port"] = server_config.getint(u"DEFAULT",
1466
u"port")
2189
server_settings["port"] = server_config.getint("DEFAULT",
2190
"port")
1467
2191
del server_config
1468
2192
1469
2193
# Override the settings from the config file with command line
1470
2194
# options, if set.
1471
for option in (u"interface", u"address", u"port", u"debug",
1472
u"priority", u"servicename", u"configdir",
1473
u"use_dbus", u"use_ipv6"):
2195
for option in ("interface", "address", "port", "debug",
2196
"priority", "servicename", "configdir",
2197
"use_dbus", "use_ipv6", "debuglevel", "restore",
2198
"statedir"):
1474
2199
value = getattr(options, option)
1475
2200
if value is not None:
1476
2201
server_settings[option] = value
1484
2209
##################################################################
1485
2210
1486
2211
# For convenience
1487
debug = server_settings[u"debug"]
1488
use_dbus = server_settings[u"use_dbus"]
1489
use_ipv6 = server_settings[u"use_ipv6"]
1490
1491
if not debug:
1492
syslogger.setLevel(logging.WARNING)
1493
console.setLevel(logging.WARNING)
1494
1495
if server_settings[u"servicename"] != u"Mandos":
2212
debug = server_settings["debug"]
2213
debuglevel = server_settings["debuglevel"]
2214
use_dbus = server_settings["use_dbus"]
2215
use_ipv6 = server_settings["use_ipv6"]
2216
stored_state_path = os.path.join(server_settings["statedir"],
2217
stored_state_file)
2218
2219
if debug:
2220
initlogger(debug, logging.DEBUG)
2221
else:
2222
if not debuglevel:
2223
initlogger(debug)
2224
else:
2225
level = getattr(logging, debuglevel.upper())
2226
initlogger(debug, level)
2227
2228
if server_settings["servicename"] != "Mandos":
1496
2229
syslogger.setFormatter(logging.Formatter
1497
(u'Mandos (%s) [%%(process)d]:'
1498
u' %%(levelname)s: %%(message)s'
1499
% server_settings[u"servicename"]))
2230
('Mandos (%s) [%%(process)d]:'
2231
' %%(levelname)s: %%(message)s'
2232
% server_settings["servicename"]))
1500
2233
1501
2234
# Parse config file with clients
1502
client_defaults = { u"timeout": u"1h",
1503
u"interval": u"5m",
1504
u"checker": u"fping -q -- %%(host)s",
1505
u"host": u"",
1506
}
1507
client_config = configparser.SafeConfigParser(client_defaults)
1508
client_config.read(os.path.join(server_settings[u"configdir"],
1509
u"clients.conf"))
2235
client_config = configparser.SafeConfigParser(Client
2236
.client_defaults)
2237
client_config.read(os.path.join(server_settings["configdir"],
2238
"clients.conf"))
1510
2239
1511
2240
global mandos_dbus_service
1512
2241
mandos_dbus_service = None
1513
2242
1514
tcp_server = MandosServer((server_settings[u"address"],
1515
server_settings[u"port"]),
2243
tcp_server = MandosServer((server_settings["address"],
2244
server_settings["port"]),
1516
2245
ClientHandler,
1517
interface=server_settings[u"interface"],
2246
interface=(server_settings["interface"]
2247
or None),
1518
2248
use_ipv6=use_ipv6,
1519
2249
gnutls_priority=
1520
server_settings[u"priority"],
2250
server_settings["priority"],
1521
2251
use_dbus=use_dbus)
1522
pidfilename = u"/var/run/mandos.pid"
1523
try:
1524
pidfile = open(pidfilename, u"w")
1525
except IOError:
1526
logger.error(u"Could not open file %r", pidfilename)
2252
if not debug:
2253
pidfilename = "/var/run/mandos.pid"
2254
try:
2255
pidfile = open(pidfilename, "w")
2256
except IOError:
2257
logger.error("Could not open file %r", pidfilename)
1527
2258
1528
2259
try:
1529
uid = pwd.getpwnam(u"_mandos").pw_uid
1530
gid = pwd.getpwnam(u"_mandos").pw_gid
2260
uid = pwd.getpwnam("_mandos").pw_uid
2261
gid = pwd.getpwnam("_mandos").pw_gid
1531
2262
except KeyError:
1532
2263
try:
1533
uid = pwd.getpwnam(u"mandos").pw_uid
1534
gid = pwd.getpwnam(u"mandos").pw_gid
2264
uid = pwd.getpwnam("mandos").pw_uid
2265
gid = pwd.getpwnam("mandos").pw_gid
1535
2266
except KeyError:
1536
2267
try:
1537
uid = pwd.getpwnam(u"nobody").pw_uid
1538
gid = pwd.getpwnam(u"nobody").pw_gid
2268
uid = pwd.getpwnam("nobody").pw_uid
2269
gid = pwd.getpwnam("nobody").pw_gid
1539
2270
except KeyError:
1540
2271
uid = 65534
1541
2272
gid = 65534
1542
2273
try:
1543
2274
os.setgid(gid)
1544
2275
os.setuid(uid)
1545
except OSError, error:
2276
except OSError as error:
1546
2277
if error[0] != errno.EPERM:
1547
2278
raise error
1548
2279
1549
# Enable all possible GnuTLS debugging
1550
2280
if debug:
2281
# Enable all possible GnuTLS debugging
2282
1551
2283
# "Use a log level over 10 to enable all debugging options."
1552
2284
# - GnuTLS manual
1553
2285
gnutls.library.functions.gnutls_global_set_log_level(11)
1554
2286
1555
2287
@gnutls.library.types.gnutls_log_func
1556
2288
def debug_gnutls(level, string):
1557
logger.debug(u"GnuTLS: %s", string[:-1])
2289
logger.debug("GnuTLS: %s", string[:-1])
1558
2290
1559
2291
(gnutls.library.functions
1560
2292
.gnutls_global_set_log_function(debug_gnutls))
2293
2294
# Redirect stdin so all checkers get /dev/null
2295
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2296
os.dup2(null, sys.stdin.fileno())
2297
if null > 2:
2298
os.close(null)
2299
2300
# Need to fork before connecting to D-Bus
2301
if not debug:
2302
# Close all input and output, do double fork, etc.
2303
daemon()
2304
2305
gobject.threads_init()
1561
2306
1562
2307
global main_loop
1563
2308
# From the Avahi example code
1564
DBusGMainLoop(set_as_default=True )
2309
DBusGMainLoop(set_as_default=True)
1565
2310
main_loop = gobject.MainLoop()
1566
2311
bus = dbus.SystemBus()
1567
2312
# End of Avahi example code
1568
2313
if use_dbus:
1569
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos", bus)
2314
try:
2315
bus_name = dbus.service.BusName("se.recompile.Mandos",
2316
bus, do_not_queue=True)
2317
old_bus_name = (dbus.service.BusName
2318
("se.bsnet.fukt.Mandos", bus,
2319
do_not_queue=True))
2320
except dbus.exceptions.NameExistsException as e:
2321
logger.error(unicode(e) + ", disabling D-Bus")
2322
use_dbus = False
2323
server_settings["use_dbus"] = False
2324
tcp_server.use_dbus = False
1570
2325
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1571
service = AvahiService(name = server_settings[u"servicename"],
1572
servicetype = u"_mandos._tcp",
1573
protocol = protocol, bus = bus)
2326
service = AvahiServiceToSyslog(name =
2327
server_settings["servicename"],
2328
servicetype = "_mandos._tcp",
2329
protocol = protocol, bus = bus)
1574
2330
if server_settings["interface"]:
1575
2331
service.interface = (if_nametoindex
1576
(str(server_settings[u"interface"])))
2332
(str(server_settings["interface"])))
2333
2334
global multiprocessing_manager
2335
multiprocessing_manager = multiprocessing.Manager()
1577
2336
1578
2337
client_class = Client
1579
2338
if use_dbus:
1580
client_class = functools.partial(ClientDBus, bus = bus)
1581
tcp_server.clients.update(set(
1582
client_class(name = section,
1583
config= dict(client_config.items(section)))
1584
for section in client_config.sections()))
2339
client_class = functools.partial(ClientDBusTransitional,
2340
bus = bus)
2341
2342
client_settings = Client.config_parser(client_config)
2343
old_client_settings = {}
2344
clients_data = {}
2345
2346
# Get client data and settings from last running state.
2347
if server_settings["restore"]:
2348
try:
2349
with open(stored_state_path, "rb") as stored_state:
2350
clients_data, old_client_settings = (pickle.load
2351
(stored_state))
2352
os.remove(stored_state_path)
2353
except IOError as e:
2354
logger.warning("Could not load persistent state: {0}"
2355
.format(e))
2356
if e.errno != errno.ENOENT:
2357
raise
2358
except EOFError as e:
2359
logger.warning("Could not load persistent state: "
2360
"EOFError: {0}".format(e))
2361
2362
with PGPEngine() as pgp:
2363
for client_name, client in clients_data.iteritems():
2364
# Decide which value to use after restoring saved state.
2365
# We have three different values: Old config file,
2366
# new config file, and saved state.
2367
# New config value takes precedence if it differs from old
2368
# config value, otherwise use saved state.
2369
for name, value in client_settings[client_name].items():
2370
try:
2371
# For each value in new config, check if it
2372
# differs from the old config value (Except for
2373
# the "secret" attribute)
2374
if (name != "secret" and
2375
value != old_client_settings[client_name]
2376
[name]):
2377
client[name] = value
2378
except KeyError:
2379
pass
2380
2381
# Clients who has passed its expire date can still be
2382
# enabled if its last checker was successful. Clients
2383
# whose checker succeeded before we stored its state is
2384
# assumed to have successfully run all checkers during
2385
# downtime.
2386
if client["enabled"]:
2387
if datetime.datetime.utcnow() >= client["expires"]:
2388
if not client["last_checked_ok"]:
2389
logger.warning(
2390
"disabling client {0} - Client never "
2391
"performed a successful checker"
2392
.format(client_name))
2393
client["enabled"] = False
2394
elif client["last_checker_status"] != 0:
2395
logger.warning(
2396
"disabling client {0} - Client "
2397
"last checker failed with error code {1}"
2398
.format(client_name,
2399
client["last_checker_status"]))
2400
client["enabled"] = False
2401
else:
2402
client["expires"] = (datetime.datetime
2403
.utcnow()
2404
+ client["timeout"])
2405
logger.debug("Last checker succeeded,"
2406
" keeping {0} enabled"
2407
.format(client_name))
2408
try:
2409
client["secret"] = (
2410
pgp.decrypt(client["encrypted_secret"],
2411
client_settings[client_name]
2412
["secret"]))
2413
except PGPError:
2414
# If decryption fails, we use secret from new settings
2415
logger.debug("Failed to decrypt {0} old secret"
2416
.format(client_name))
2417
client["secret"] = (
2418
client_settings[client_name]["secret"])
2419
2420
2421
# Add/remove clients based on new changes made to config
2422
for client_name in (set(old_client_settings)
2423
- set(client_settings)):
2424
del clients_data[client_name]
2425
for client_name in (set(client_settings)
2426
- set(old_client_settings)):
2427
clients_data[client_name] = client_settings[client_name]
2428
2429
# Create all client objects
2430
for client_name, client in clients_data.iteritems():
2431
tcp_server.clients[client_name] = client_class(
2432
name = client_name, settings = client)
2433
1585
2434
if not tcp_server.clients:
1586
logger.warning(u"No clients defined")
1587
1588
if debug:
1589
# Redirect stdin so all checkers get /dev/null
1590
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1591
os.dup2(null, sys.stdin.fileno())
1592
if null > 2:
1593
os.close(null)
1594
else:
1595
# No console logging
1596
logger.removeHandler(console)
1597
# Close all input and output, do double fork, etc.
1598
daemon()
1599
1600
try:
1601
with closing(pidfile):
1602
pid = os.getpid()
1603
pidfile.write(str(pid) + "\n")
1604
del pidfile
1605
except IOError:
1606
logger.error(u"Could not write to file %r with PID %d",
1607
pidfilename, pid)
1608
except NameError:
1609
# "pidfile" was never created
1610
pass
1611
del pidfilename
1612
1613
def cleanup():
1614
"Cleanup function; run on exit"
1615
service.cleanup()
2435
logger.warning("No clients defined")
1616
2436
1617
while tcp_server.clients:
1618
client = tcp_server.clients.pop()
1619
client.disable_hook = None
1620
client.disable()
1621
1622
atexit.register(cleanup)
1623
1624
2437
if not debug:
2438
try:
2439
with pidfile:
2440
pid = os.getpid()
2441
pidfile.write(str(pid) + "\n".encode("utf-8"))
2442
del pidfile
2443
except IOError:
2444
logger.error("Could not write to file %r with PID %d",
2445
pidfilename, pid)
2446
except NameError:
2447
# "pidfile" was never created
2448
pass
2449
del pidfilename
1625
2450
signal.signal(signal.SIGINT, signal.SIG_IGN)
2451
1626
2452
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1627
2453
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1628
2454
1629
2455
if use_dbus:
1630
class MandosDBusService(dbus.service.Object):
2456
class MandosDBusService(DBusObjectWithProperties):
1631
2457
"""A D-Bus proxy object"""
1632
2458
def __init__(self):
1633
dbus.service.Object.__init__(self, bus, u"/")
1634
_interface = u"se.bsnet.fukt.Mandos"
1635
1636
@dbus.service.signal(_interface, signature=u"oa{sv}")
1637
def ClientAdded(self, objpath, properties):
1638
"D-Bus signal"
1639
pass
1640
1641
@dbus.service.signal(_interface, signature=u"s")
1642
def ClientNotFound(self, fingerprint):
1643
"D-Bus signal"
1644
pass
1645
1646
@dbus.service.signal(_interface, signature=u"os")
2459
dbus.service.Object.__init__(self, bus, "/")
2460
_interface = "se.recompile.Mandos"
2461
2462
@dbus_interface_annotations(_interface)
2463
def _foo(self):
2464
return { "org.freedesktop.DBus.Property"
2465
".EmitsChangedSignal":
2466
"false"}
2467
2468
@dbus.service.signal(_interface, signature="o")
2469
def ClientAdded(self, objpath):
2470
"D-Bus signal"
2471
pass
2472
2473
@dbus.service.signal(_interface, signature="ss")
2474
def ClientNotFound(self, fingerprint, address):
2475
"D-Bus signal"
2476
pass
2477
2478
@dbus.service.signal(_interface, signature="os")
1647
2479
def ClientRemoved(self, objpath, name):
1648
2480
"D-Bus signal"
1649
2481
pass
1650
2482
1651
@dbus.service.method(_interface, out_signature=u"ao")
2483
@dbus.service.method(_interface, out_signature="ao")
1652
2484
def GetAllClients(self):
1653
2485
"D-Bus method"
1654
2486
return dbus.Array(c.dbus_object_path
1655
for c in tcp_server.clients)
2487
for c in
2488
tcp_server.clients.itervalues())
1656
2489
1657
2490
@dbus.service.method(_interface,
1658
out_signature=u"a{oa{sv}}")
2491
out_signature="a{oa{sv}}")
1659
2492
def GetAllClientsWithProperties(self):
1660
2493
"D-Bus method"
1661
2494
return dbus.Dictionary(
1662
((c.dbus_object_path, c.GetAll(u""))
1663
for c in tcp_server.clients),
1664
signature=u"oa{sv}")
2495
((c.dbus_object_path, c.GetAll(""))
2496
for c in tcp_server.clients.itervalues()),
2497
signature="oa{sv}")
1665
2498
1666
@dbus.service.method(_interface, in_signature=u"o")
2499
@dbus.service.method(_interface, in_signature="o")
1667
2500
def RemoveClient(self, object_path):
1668
2501
"D-Bus method"
1669
for c in tcp_server.clients:
2502
for c in tcp_server.clients.itervalues():
1670
2503
if c.dbus_object_path == object_path:
1671
tcp_server.clients.remove(c)
2504
del tcp_server.clients[c.name]
1672
2505
c.remove_from_connection()
1673
2506
# Don't signal anything except ClientRemoved
1674
c.disable(signal=False)
2507
c.disable(quiet=True)
1675
2508
# Emit D-Bus signal
1676
2509
self.ClientRemoved(object_path, c.name)
1677
2510
return
1678
raise KeyError
2511
raise KeyError(object_path)
1679
2512
1680
2513
del _interface
1681
2514
1682
mandos_dbus_service = MandosDBusService()
1683
1684
for client in tcp_server.clients:
2515
class MandosDBusServiceTransitional(MandosDBusService):
2516
__metaclass__ = AlternateDBusNamesMetaclass
2517
mandos_dbus_service = MandosDBusServiceTransitional()
2518
2519
def cleanup():
2520
"Cleanup function; run on exit"
2521
service.cleanup()
2522
2523
multiprocessing.active_children()
2524
if not (tcp_server.clients or client_settings):
2525
return
2526
2527
# Store client before exiting. Secrets are encrypted with key
2528
# based on what config file has. If config file is
2529
# removed/edited, old secret will thus be unrecovable.
2530
clients = {}
2531
with PGPEngine() as pgp:
2532
for client in tcp_server.clients.itervalues():
2533
key = client_settings[client.name]["secret"]
2534
client.encrypted_secret = pgp.encrypt(client.secret,
2535
key)
2536
client_dict = {}
2537
2538
# A list of attributes that can not be pickled
2539
# + secret.
2540
exclude = set(("bus", "changedstate", "secret",
2541
"checker"))
2542
for name, typ in (inspect.getmembers
2543
(dbus.service.Object)):
2544
exclude.add(name)
2545
2546
client_dict["encrypted_secret"] = (client
2547
.encrypted_secret)
2548
for attr in client.client_structure:
2549
if attr not in exclude:
2550
client_dict[attr] = getattr(client, attr)
2551
2552
clients[client.name] = client_dict
2553
del client_settings[client.name]["secret"]
2554
2555
try:
2556
tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2557
prefix="clients-",
2558
dir=os.path.dirname
2559
(stored_state_path))
2560
with os.fdopen(tempfd, "wb") as stored_state:
2561
pickle.dump((clients, client_settings), stored_state)
2562
os.rename(tempname, stored_state_path)
2563
except (IOError, OSError) as e:
2564
logger.warning("Could not save persistent state: {0}"
2565
.format(e))
2566
if not debug:
2567
try:
2568
os.remove(tempname)
2569
except NameError:
2570
pass
2571
if e.errno not in set((errno.ENOENT, errno.EACCES,
2572
errno.EEXIST)):
2573
raise e
2574
2575
# Delete all clients, and settings from config
2576
while tcp_server.clients:
2577
name, client = tcp_server.clients.popitem()
2578
if use_dbus:
2579
client.remove_from_connection()
2580
# Don't signal anything except ClientRemoved
2581
client.disable(quiet=True)
2582
if use_dbus:
2583
# Emit D-Bus signal
2584
mandos_dbus_service.ClientRemoved(client
2585
.dbus_object_path,
2586
client.name)
2587
client_settings.clear()
2588
2589
atexit.register(cleanup)
2590
2591
for client in tcp_server.clients.itervalues():
1685
2592
if use_dbus:
1686
2593
# Emit D-Bus signal
1687
mandos_dbus_service.ClientAdded(client.dbus_object_path,
1688
client.GetAll(u""))
1689
client.enable()
2594
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2595
# Need to initiate checking of clients
2596
if client.enabled:
2597
client.init_checker()
1690
2598
1691
2599
tcp_server.enable()
1692
2600
tcp_server.server_activate()
1694
2602
# Find out what port we got
1695
2603
service.port = tcp_server.socket.getsockname()[1]
1696
2604
if use_ipv6:
1697
logger.info(u"Now listening on address %r, port %d,"
2605
logger.info("Now listening on address %r, port %d,"
1698
2606
" flowinfo %d, scope_id %d"
1699
2607
% tcp_server.socket.getsockname())
1700
2608
else: # IPv4
1701
logger.info(u"Now listening on address %r, port %d"
2609
logger.info("Now listening on address %r, port %d"
1702
2610
% tcp_server.socket.getsockname())
1703
2611
1704
2612
#service.interface = tcp_server.socket.getsockname()[3]
1707
2615
# From the Avahi example code
1708
2616
try:
1709
2617
service.activate()
1710
except dbus.exceptions.DBusException, error:
1711
logger.critical(u"DBusException: %s", error)
2618
except dbus.exceptions.DBusException as error:
2619
logger.critical("DBusException: %s", error)
2620
cleanup()
1712
2621
sys.exit(1)
1713
2622
# End of Avahi example code
1714
2623
1717
2626
(tcp_server.handle_request
1718
2627
(*args[2:], **kwargs) or True))
1719
2628
1720
logger.debug(u"Starting main loop")
2629
logger.debug("Starting main loop")
1721
2630
main_loop.run()
1722
except AvahiError, error:
1723
logger.critical(u"AvahiError: %s", error)
2631
except AvahiError as error:
2632
logger.critical("AvahiError: %s", error)
2633
cleanup()
1724
2634
sys.exit(1)
1725
2635
except KeyboardInterrupt:
1726
2636
if debug:
1727
print >> sys.stderr
1728
logger.debug(u"Server received KeyboardInterrupt")
1729
logger.debug(u"Server exiting")
2637
print("", file=sys.stderr)
2638
logger.debug("Server received KeyboardInterrupt")
2639
logger.debug("Server exiting")
2640
# Must run before the D-Bus bus name gets deregistered
2641
cleanup()
1730
2642
1731
2643
if __name__ == '__main__':
1732
2644
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0