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