106
239
max_renames: integer; maximum number of renames
107
240
rename_count: integer; counter so we only rename after collisions
108
241
a sensible number of times
242
group: D-Bus Entry Group
244
bus: dbus.SystemBus()
110
247
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
111
type = None, port = None, TXT = None, domain = "",
112
host = "", max_renames = 32768):
248
servicetype = None, port = None, TXT = None,
249
domain = "", host = "", max_renames = 32768,
250
protocol = avahi.PROTO_UNSPEC, bus = None):
113
251
self.interface = interface
253
self.type = servicetype
255
self.TXT = TXT if TXT is not None else []
121
256
self.domain = domain
123
258
self.rename_count = 0
124
259
self.max_renames = max_renames
260
self.protocol = protocol
261
self.group = None # our entry group
264
self.entry_group_state_changed_match = None
125
266
def rename(self):
126
267
"""Derived from the Avahi example code"""
127
268
if self.rename_count >= self.max_renames:
128
logger.critical(u"No suitable Zeroconf service name found"
129
u" after %i retries, exiting.",
269
logger.critical("No suitable Zeroconf service name found"
270
" after %i retries, exiting.",
131
272
raise AvahiServiceError("Too many renames")
132
self.name = server.GetAlternativeServiceName(self.name)
133
logger.info(u"Changing Zeroconf service name to %r ...",
135
syslogger.setFormatter(logging.Formatter\
136
('Mandos (%s): %%(levelname)s:'
137
' %%(message)s' % self.name))
273
self.name = unicode(self.server
274
.GetAlternativeServiceName(self.name))
275
logger.info("Changing Zeroconf service name to %r ...",
280
except dbus.exceptions.DBusException as error:
281
logger.critical("D-Bus Exception", exc_info=error)
140
284
self.rename_count += 1
141
286
def remove(self):
142
287
"""Derived from the Avahi example code"""
143
if group is not None:
288
if self.entry_group_state_changed_match is not None:
289
self.entry_group_state_changed_match.remove()
290
self.entry_group_state_changed_match = None
291
if self.group is not None:
146
295
"""Derived from the Avahi example code"""
149
group = dbus.Interface\
150
(bus.get_object(avahi.DBUS_NAME,
151
server.EntryGroupNew()),
152
avahi.DBUS_INTERFACE_ENTRY_GROUP)
153
group.connect_to_signal('StateChanged',
154
entry_group_state_changed)
155
logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
156
service.name, service.type)
158
self.interface, # interface
159
avahi.PROTO_INET6, # protocol
160
dbus.UInt32(0), # flags
161
self.name, self.type,
162
self.domain, self.host,
163
dbus.UInt16(self.port),
164
avahi.string_array_to_txt_array(self.TXT))
167
# From the Avahi example code:
168
group = None # our entry group
169
# End of Avahi example code
297
if self.group is None:
298
self.group = dbus.Interface(
299
self.bus.get_object(avahi.DBUS_NAME,
300
self.server.EntryGroupNew()),
301
avahi.DBUS_INTERFACE_ENTRY_GROUP)
302
self.entry_group_state_changed_match = (
303
self.group.connect_to_signal(
304
'StateChanged', self.entry_group_state_changed))
305
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
306
self.name, self.type)
307
self.group.AddService(
310
dbus.UInt32(0), # flags
311
self.name, self.type,
312
self.domain, self.host,
313
dbus.UInt16(self.port),
314
avahi.string_array_to_txt_array(self.TXT))
317
def entry_group_state_changed(self, state, error):
318
"""Derived from the Avahi example code"""
319
logger.debug("Avahi entry group state change: %i", state)
321
if state == avahi.ENTRY_GROUP_ESTABLISHED:
322
logger.debug("Zeroconf service established.")
323
elif state == avahi.ENTRY_GROUP_COLLISION:
324
logger.info("Zeroconf service name collision.")
326
elif state == avahi.ENTRY_GROUP_FAILURE:
327
logger.critical("Avahi: Error in group state changed %s",
329
raise AvahiGroupError("State changed: {0!s}"
333
"""Derived from the Avahi example code"""
334
if self.group is not None:
337
except (dbus.exceptions.UnknownMethodException,
338
dbus.exceptions.DBusException):
343
def server_state_changed(self, state, error=None):
344
"""Derived from the Avahi example code"""
345
logger.debug("Avahi server state change: %i", state)
346
bad_states = { avahi.SERVER_INVALID:
347
"Zeroconf server invalid",
348
avahi.SERVER_REGISTERING: None,
349
avahi.SERVER_COLLISION:
350
"Zeroconf server name collision",
351
avahi.SERVER_FAILURE:
352
"Zeroconf server failure" }
353
if state in bad_states:
354
if bad_states[state] is not None:
356
logger.error(bad_states[state])
358
logger.error(bad_states[state] + ": %r", error)
360
elif state == avahi.SERVER_RUNNING:
364
logger.debug("Unknown state: %r", state)
366
logger.debug("Unknown state: %r: %r", state, error)
369
"""Derived from the Avahi example code"""
370
if self.server is None:
371
self.server = dbus.Interface(
372
self.bus.get_object(avahi.DBUS_NAME,
373
avahi.DBUS_PATH_SERVER,
374
follow_name_owner_changes=True),
375
avahi.DBUS_INTERFACE_SERVER)
376
self.server.connect_to_signal("StateChanged",
377
self.server_state_changed)
378
self.server_state_changed(self.server.GetState())
380
class AvahiServiceToSyslog(AvahiService):
382
"""Add the new name to the syslog messages"""
383
ret = AvahiService.rename(self)
384
syslogger.setFormatter(logging.Formatter
385
('Mandos ({0}) [%(process)d]:'
386
' %(levelname)s: %(message)s'
390
def timedelta_to_milliseconds(td):
391
"Convert a datetime.timedelta() to milliseconds"
392
return ((td.days * 24 * 60 * 60 * 1000)
393
+ (td.seconds * 1000)
394
+ (td.microseconds // 1000))
172
396
class Client(object):
173
397
"""A representation of a client host served by this server.
175
name: string; from the config file, used in log messages
400
approved: bool(); 'None' if not yet approved/disapproved
401
approval_delay: datetime.timedelta(); Time to wait for approval
402
approval_duration: datetime.timedelta(); Duration of one approval
403
checker: subprocess.Popen(); a running checker process used
404
to see if the client lives.
405
'None' if no process is running.
406
checker_callback_tag: a gobject event source tag, or None
407
checker_command: string; External command which is run to check
408
if client lives. %() expansions are done at
409
runtime with vars(self) as dict, so that for
410
instance %(name)s can be used in the command.
411
checker_initiator_tag: a gobject event source tag, or None
412
created: datetime.datetime(); (UTC) object creation
413
client_structure: Object describing what attributes a client has
414
and is used for storing the client at exit
415
current_checker_command: string; current running checker_command
416
disable_initiator_tag: a gobject event source tag, or None
176
418
fingerprint: string (40 or 32 hexadecimal digits); used to
177
419
uniquely identify the client
178
secret: bytestring; sent verbatim (over TLS) to client
179
host: string; available for use by the checker command
180
created: datetime.datetime(); object creation, not client host
181
last_checked_ok: datetime.datetime() or None if not yet checked OK
182
timeout: datetime.timedelta(); How long from last_checked_ok
183
until this client is invalid
184
interval: datetime.timedelta(); How often to start a new checker
185
stop_hook: If set, called by stop() as stop_hook(self)
186
checker: subprocess.Popen(); a running checker process used
187
to see if the client lives.
188
'None' if no process is running.
189
checker_initiator_tag: a gobject event source tag, or None
190
stop_initiator_tag: - '' -
191
checker_callback_tag: - '' -
192
checker_command: string; External command which is run to check if
193
client lives. %() expansions are done at
194
runtime with vars(self) as dict, so that for
195
instance %(name)s can be used in the command.
197
_timeout: Real variable for 'timeout'
198
_interval: Real variable for 'interval'
199
_timeout_milliseconds: Used when calling gobject.timeout_add()
200
_interval_milliseconds: - '' -
420
host: string; available for use by the checker command
421
interval: datetime.timedelta(); How often to start a new checker
422
last_approval_request: datetime.datetime(); (UTC) or None
423
last_checked_ok: datetime.datetime(); (UTC) or None
424
last_checker_status: integer between 0 and 255 reflecting exit
425
status of last checker. -1 reflects crashed
426
checker, -2 means no checker completed yet.
427
last_enabled: datetime.datetime(); (UTC) or None
428
name: string; from the config file, used in log messages and
430
secret: bytestring; sent verbatim (over TLS) to client
431
timeout: datetime.timedelta(); How long from last_checked_ok
432
until this client is disabled
433
extended_timeout: extra long timeout when secret has been sent
434
runtime_expansions: Allowed attributes for runtime expansion.
435
expires: datetime.datetime(); time (UTC) when a client will be
202
def _set_timeout(self, timeout):
203
"Setter function for 'timeout' attribute"
204
self._timeout = timeout
205
self._timeout_milliseconds = ((self.timeout.days
206
* 24 * 60 * 60 * 1000)
207
+ (self.timeout.seconds * 1000)
208
+ (self.timeout.microseconds
210
timeout = property(lambda self: self._timeout,
213
def _set_interval(self, interval):
214
"Setter function for 'interval' attribute"
215
self._interval = interval
216
self._interval_milliseconds = ((self.interval.days
217
* 24 * 60 * 60 * 1000)
218
+ (self.interval.seconds
220
+ (self.interval.microseconds
222
interval = property(lambda self: self._interval,
225
def __init__(self, name = None, stop_hook=None, config={}):
226
"""Note: the 'checker' key in 'config' sets the
227
'checker_command' attribute and *not* the 'checker'
439
runtime_expansions = ("approval_delay", "approval_duration",
440
"created", "enabled", "fingerprint",
441
"host", "interval", "last_checked_ok",
442
"last_enabled", "name", "timeout")
443
client_defaults = { "timeout": "5m",
444
"extended_timeout": "15m",
446
"checker": "fping -q -- %%(host)s",
448
"approval_delay": "0s",
449
"approval_duration": "1s",
450
"approved_by_default": "True",
454
def timeout_milliseconds(self):
455
"Return the 'timeout' attribute in milliseconds"
456
return timedelta_to_milliseconds(self.timeout)
458
def extended_timeout_milliseconds(self):
459
"Return the 'extended_timeout' attribute in milliseconds"
460
return timedelta_to_milliseconds(self.extended_timeout)
462
def interval_milliseconds(self):
463
"Return the 'interval' attribute in milliseconds"
464
return timedelta_to_milliseconds(self.interval)
466
def approval_delay_milliseconds(self):
467
return timedelta_to_milliseconds(self.approval_delay)
470
def config_parser(config):
471
"""Construct a new dict of client settings of this form:
472
{ client_name: {setting_name: value, ...}, ...}
473
with exceptions for any special settings as defined above.
474
NOTE: Must be a pure function. Must return the same result
475
value given the same arguments.
478
for client_name in config.sections():
479
section = dict(config.items(client_name))
480
client = settings[client_name] = {}
482
client["host"] = section["host"]
483
# Reformat values from string types to Python types
484
client["approved_by_default"] = config.getboolean(
485
client_name, "approved_by_default")
486
client["enabled"] = config.getboolean(client_name,
489
client["fingerprint"] = (section["fingerprint"].upper()
491
if "secret" in section:
492
client["secret"] = section["secret"].decode("base64")
493
elif "secfile" in section:
494
with open(os.path.expanduser(os.path.expandvars
495
(section["secfile"])),
497
client["secret"] = secfile.read()
499
raise TypeError("No secret or secfile for section {0}"
501
client["timeout"] = string_to_delta(section["timeout"])
502
client["extended_timeout"] = string_to_delta(
503
section["extended_timeout"])
504
client["interval"] = string_to_delta(section["interval"])
505
client["approval_delay"] = string_to_delta(
506
section["approval_delay"])
507
client["approval_duration"] = string_to_delta(
508
section["approval_duration"])
509
client["checker_command"] = section["checker"]
510
client["last_approval_request"] = None
511
client["last_checked_ok"] = None
512
client["last_checker_status"] = -2
516
def __init__(self, settings, name = None):
230
logger.debug(u"Creating client %r", self.name)
518
# adding all client settings
519
for setting, value in settings.iteritems():
520
setattr(self, setting, value)
523
if not hasattr(self, "last_enabled"):
524
self.last_enabled = datetime.datetime.utcnow()
525
if not hasattr(self, "expires"):
526
self.expires = (datetime.datetime.utcnow()
529
self.last_enabled = None
532
logger.debug("Creating client %r", self.name)
231
533
# Uppercase and remove spaces from fingerprint for later
232
534
# comparison purposes with return value from the fingerprint()
234
self.fingerprint = config["fingerprint"].upper()\
236
logger.debug(u" Fingerprint: %s", self.fingerprint)
237
if "secret" in config:
238
self.secret = config["secret"].decode(u"base64")
239
elif "secfile" in config:
240
sf = open(config["secfile"])
241
self.secret = sf.read()
244
raise TypeError(u"No secret or secfile for client %s"
246
self.host = config.get("host", "")
247
self.created = datetime.datetime.now()
248
self.last_checked_ok = None
249
self.timeout = string_to_delta(config["timeout"])
250
self.interval = string_to_delta(config["interval"])
251
self.stop_hook = stop_hook
536
logger.debug(" Fingerprint: %s", self.fingerprint)
537
self.created = settings.get("created",
538
datetime.datetime.utcnow())
540
# attributes specific for this server instance
252
541
self.checker = None
253
542
self.checker_initiator_tag = None
254
self.stop_initiator_tag = None
543
self.disable_initiator_tag = None
255
544
self.checker_callback_tag = None
256
self.check_command = config["checker"]
545
self.current_checker_command = None
547
self.approvals_pending = 0
548
self.changedstate = (multiprocessing_manager
549
.Condition(multiprocessing_manager
551
self.client_structure = [attr for attr in
552
self.__dict__.iterkeys()
553
if not attr.startswith("_")]
554
self.client_structure.append("client_structure")
556
for name, t in inspect.getmembers(type(self),
560
if not name.startswith("_"):
561
self.client_structure.append(name)
563
# Send notice to process children that client state has changed
564
def send_changedstate(self):
565
with self.changedstate:
566
self.changedstate.notify_all()
258
569
"""Start this client's checker and timeout hooks"""
570
if getattr(self, "enabled", False):
573
self.send_changedstate()
574
self.expires = datetime.datetime.utcnow() + self.timeout
576
self.last_enabled = datetime.datetime.utcnow()
579
def disable(self, quiet=True):
580
"""Disable this client."""
581
if not getattr(self, "enabled", False):
584
self.send_changedstate()
586
logger.info("Disabling client %s", self.name)
587
if getattr(self, "disable_initiator_tag", False):
588
gobject.source_remove(self.disable_initiator_tag)
589
self.disable_initiator_tag = None
591
if getattr(self, "checker_initiator_tag", False):
592
gobject.source_remove(self.checker_initiator_tag)
593
self.checker_initiator_tag = None
596
# Do not run this again if called by a gobject.timeout_add
602
def init_checker(self):
259
603
# Schedule a new checker to be started an 'interval' from now,
260
604
# and every interval from then on.
261
self.checker_initiator_tag = gobject.timeout_add\
262
(self._interval_milliseconds,
605
self.checker_initiator_tag = (gobject.timeout_add
606
(self.interval_milliseconds(),
608
# Schedule a disable() when 'timeout' has passed
609
self.disable_initiator_tag = (gobject.timeout_add
610
(self.timeout_milliseconds(),
264
612
# Also start a new checker *right now*.
265
613
self.start_checker()
266
# Schedule a stop() when 'timeout' has passed
267
self.stop_initiator_tag = gobject.timeout_add\
268
(self._timeout_milliseconds,
272
The possibility that a client might be restarted is left open,
273
but not currently used."""
274
# If this client doesn't have a secret, it is already stopped.
275
if hasattr(self, "secret") and self.secret:
276
logger.info(u"Stopping client %s", self.name)
280
if getattr(self, "stop_initiator_tag", False):
281
gobject.source_remove(self.stop_initiator_tag)
282
self.stop_initiator_tag = None
283
if getattr(self, "checker_initiator_tag", False):
284
gobject.source_remove(self.checker_initiator_tag)
285
self.checker_initiator_tag = None
289
# Do not run this again if called by a gobject.timeout_add
292
self.stop_hook = None
294
def checker_callback(self, pid, condition):
615
def checker_callback(self, pid, condition, command):
295
616
"""The checker has completed, so take appropriate actions."""
296
now = datetime.datetime.now()
297
617
self.checker_callback_tag = None
298
618
self.checker = None
299
if os.WIFEXITED(condition) \
300
and (os.WEXITSTATUS(condition) == 0):
301
logger.info(u"Checker for %(name)s succeeded",
303
self.last_checked_ok = now
304
gobject.source_remove(self.stop_initiator_tag)
305
self.stop_initiator_tag = gobject.timeout_add\
306
(self._timeout_milliseconds,
308
elif not os.WIFEXITED(condition):
309
logger.warning(u"Checker for %(name)s crashed?",
619
if os.WIFEXITED(condition):
620
self.last_checker_status = os.WEXITSTATUS(condition)
621
if self.last_checker_status == 0:
622
logger.info("Checker for %(name)s succeeded",
626
logger.info("Checker for %(name)s failed",
629
self.last_checker_status = -1
630
logger.warning("Checker for %(name)s crashed?",
312
logger.info(u"Checker for %(name)s failed",
633
def checked_ok(self):
634
"""Assert that the client has been seen, alive and well."""
635
self.last_checked_ok = datetime.datetime.utcnow()
636
self.last_checker_status = 0
639
def bump_timeout(self, timeout=None):
640
"""Bump up the timeout for this client."""
642
timeout = self.timeout
643
if self.disable_initiator_tag is not None:
644
gobject.source_remove(self.disable_initiator_tag)
645
if getattr(self, "enabled", False):
646
self.disable_initiator_tag = (gobject.timeout_add
647
(timedelta_to_milliseconds
648
(timeout), self.disable))
649
self.expires = datetime.datetime.utcnow() + timeout
651
def need_approval(self):
652
self.last_approval_request = datetime.datetime.utcnow()
314
654
def start_checker(self):
315
655
"""Start a new checker subprocess if one is not running.
316
657
If a checker already exists, leave it running and do
318
659
# The reason for not killing a running checker is that if we
319
# did that, then if a checker (for some reason) started
320
# running slowly and taking more than 'interval' time, the
321
# client would inevitably timeout, since no checker would get
322
# a chance to run to completion. If we instead leave running
660
# did that, and if a checker (for some reason) started running
661
# slowly and taking more than 'interval' time, then the client
662
# would inevitably timeout, since no checker would get a
663
# chance to run to completion. If we instead leave running
323
664
# checkers alone, the checker would have to take more time
324
# than 'timeout' for the client to be declared invalid, which
325
# is as it should be.
665
# than 'timeout' for the client to be disabled, which is as it
668
# If a checker exists, make sure it is not a zombie
670
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
671
except (AttributeError, OSError) as error:
672
if (isinstance(error, OSError)
673
and error.errno != errno.ECHILD):
677
logger.warning("Checker was a zombie")
678
gobject.source_remove(self.checker_callback_tag)
679
self.checker_callback(pid, status,
680
self.current_checker_command)
681
# Start a new checker if needed
326
682
if self.checker is None:
328
# In case check_command has exactly one % operator
329
command = self.check_command % self.host
684
# In case checker_command has exactly one % operator
685
command = self.checker_command % self.host
330
686
except TypeError:
331
687
# Escape attributes for the shell
332
escaped_attrs = dict((key, re.escape(str(val)))
334
vars(self).iteritems())
688
escaped_attrs = dict(
690
re.escape(unicode(str(getattr(self, attr, "")),
694
self.runtime_expansions)
336
command = self.check_command % escaped_attrs
337
except TypeError, error:
338
logger.error(u'Could not format string "%s":'
339
u' %s', self.check_command, error)
697
command = self.checker_command % escaped_attrs
698
except TypeError as error:
699
logger.error('Could not format string "%s"',
700
self.checker_command, exc_info=error)
340
701
return True # Try again later
702
self.current_checker_command = command
342
logger.info(u"Starting checker %r for %s",
704
logger.info("Starting checker %r for %s",
343
705
command, self.name)
344
706
# We don't need to redirect stdout and stderr, since
345
707
# in normal mode, that is already done by daemon(),
363
733
self.checker_callback_tag = None
364
734
if getattr(self, "checker", None) is None:
366
logger.debug(u"Stopping checker for %(name)s", vars(self))
736
logger.debug("Stopping checker for %(name)s", vars(self))
368
os.kill(self.checker.pid, signal.SIGTERM)
738
self.checker.terminate()
370
740
#if self.checker.poll() is None:
371
# os.kill(self.checker.pid, signal.SIGKILL)
372
except OSError, error:
741
# self.checker.kill()
742
except OSError as error:
373
743
if error.errno != errno.ESRCH: # No such process
375
745
self.checker = None
376
def still_valid(self):
377
"""Has the timeout not yet passed for this client?"""
378
now = datetime.datetime.now()
379
if self.last_checked_ok is None:
380
return now < (self.created + self.timeout)
382
return now < (self.last_checked_ok + self.timeout)
385
def peer_certificate(session):
386
"Return the peer's OpenPGP certificate as a bytestring"
387
# If not an OpenPGP certificate...
388
if gnutls.library.functions.gnutls_certificate_type_get\
389
(session._c_object) \
390
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP:
391
# ...do the normal thing
392
return session.peer_certificate
393
list_size = ctypes.c_uint()
394
cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
395
(session._c_object, ctypes.byref(list_size))
396
if list_size.value == 0:
399
return ctypes.string_at(cert.data, cert.size)
402
def fingerprint(openpgp):
403
"Convert an OpenPGP bytestring to a hexdigit fingerprint string"
404
# New GnuTLS "datum" with the OpenPGP public key
405
datum = gnutls.library.types.gnutls_datum_t\
406
(ctypes.cast(ctypes.c_char_p(openpgp),
407
ctypes.POINTER(ctypes.c_ubyte)),
408
ctypes.c_uint(len(openpgp)))
409
# New empty GnuTLS certificate
410
crt = gnutls.library.types.gnutls_openpgp_crt_t()
411
gnutls.library.functions.gnutls_openpgp_crt_init\
413
# Import the OpenPGP public key into the certificate
414
gnutls.library.functions.gnutls_openpgp_crt_import\
415
(crt, ctypes.byref(datum),
416
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
417
# Verify the self signature in the key
418
crtverify = ctypes.c_uint();
419
gnutls.library.functions.gnutls_openpgp_crt_verify_self\
420
(crt, 0, ctypes.byref(crtverify))
421
if crtverify.value != 0:
422
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
423
raise gnutls.errors.CertificateSecurityError("Verify failed")
424
# New buffer for the fingerprint
425
buffer = ctypes.create_string_buffer(20)
426
buffer_length = ctypes.c_size_t()
427
# Get the fingerprint from the certificate into the buffer
428
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
429
(crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
430
# Deinit the certificate
431
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
432
# Convert the buffer to a Python bytestring
433
fpr = ctypes.string_at(buffer, buffer_length.value)
434
# Convert the bytestring to hexadecimal notation
435
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
439
class tcp_handler(SocketServer.BaseRequestHandler, object):
440
"""A TCP request handler class.
441
Instantiated by IPv6_TCPServer for each request to handle it.
748
def dbus_service_property(dbus_interface, signature="v",
749
access="readwrite", byte_arrays=False):
750
"""Decorators for marking methods of a DBusObjectWithProperties to
751
become properties on the D-Bus.
753
The decorated method will be called with no arguments by "Get"
754
and with one argument by "Set".
756
The parameters, where they are supported, are the same as
757
dbus.service.method, except there is only "signature", since the
758
type from Get() and the type sent to Set() is the same.
760
# Encoding deeply encoded byte arrays is not supported yet by the
761
# "Set" method, so we fail early here:
762
if byte_arrays and signature != "ay":
763
raise ValueError("Byte arrays not supported for non-'ay'"
764
" signature {0!r}".format(signature))
766
func._dbus_is_property = True
767
func._dbus_interface = dbus_interface
768
func._dbus_signature = signature
769
func._dbus_access = access
770
func._dbus_name = func.__name__
771
if func._dbus_name.endswith("_dbus_property"):
772
func._dbus_name = func._dbus_name[:-14]
773
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
778
def dbus_interface_annotations(dbus_interface):
779
"""Decorator for marking functions returning interface annotations
783
@dbus_interface_annotations("org.example.Interface")
784
def _foo(self): # Function name does not matter
785
return {"org.freedesktop.DBus.Deprecated": "true",
786
"org.freedesktop.DBus.Property.EmitsChangedSignal":
790
func._dbus_is_interface = True
791
func._dbus_interface = dbus_interface
792
func._dbus_name = dbus_interface
797
def dbus_annotations(annotations):
798
"""Decorator to annotate D-Bus methods, signals or properties
801
@dbus_service_property("org.example.Interface", signature="b",
803
@dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
804
"org.freedesktop.DBus.Property."
805
"EmitsChangedSignal": "false"})
806
def Property_dbus_property(self):
807
return dbus.Boolean(False)
810
func._dbus_annotations = annotations
815
class DBusPropertyException(dbus.exceptions.DBusException):
816
"""A base class for D-Bus property-related exceptions
818
def __unicode__(self):
819
return unicode(str(self))
822
class DBusPropertyAccessException(DBusPropertyException):
823
"""A property's access permissions disallows an operation.
828
class DBusPropertyNotFound(DBusPropertyException):
829
"""An attempt was made to access a non-existing property.
834
class DBusObjectWithProperties(dbus.service.Object):
835
"""A D-Bus object with properties.
837
Classes inheriting from this can use the dbus_service_property
838
decorator to expose methods as D-Bus properties. It exposes the
839
standard Get(), Set(), and GetAll() methods on the D-Bus.
843
def _is_dbus_thing(thing):
844
"""Returns a function testing if an attribute is a D-Bus thing
846
If called like _is_dbus_thing("method") it returns a function
847
suitable for use as predicate to inspect.getmembers().
849
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
852
def _get_all_dbus_things(self, thing):
853
"""Returns a generator of (name, attribute) pairs
855
return ((getattr(athing.__get__(self), "_dbus_name",
857
athing.__get__(self))
858
for cls in self.__class__.__mro__
860
inspect.getmembers(cls,
861
self._is_dbus_thing(thing)))
863
def _get_dbus_property(self, interface_name, property_name):
864
"""Returns a bound method if one exists which is a D-Bus
865
property with the specified name and interface.
867
for cls in self.__class__.__mro__:
868
for name, value in (inspect.getmembers
870
self._is_dbus_thing("property"))):
871
if (value._dbus_name == property_name
872
and value._dbus_interface == interface_name):
873
return value.__get__(self)
876
raise DBusPropertyNotFound(self.dbus_object_path + ":"
877
+ interface_name + "."
880
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
882
def Get(self, interface_name, property_name):
883
"""Standard D-Bus property Get() method, see D-Bus standard.
885
prop = self._get_dbus_property(interface_name, property_name)
886
if prop._dbus_access == "write":
887
raise DBusPropertyAccessException(property_name)
889
if not hasattr(value, "variant_level"):
891
return type(value)(value, variant_level=value.variant_level+1)
893
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
894
def Set(self, interface_name, property_name, value):
895
"""Standard D-Bus property Set() method, see D-Bus standard.
897
prop = self._get_dbus_property(interface_name, property_name)
898
if prop._dbus_access == "read":
899
raise DBusPropertyAccessException(property_name)
900
if prop._dbus_get_args_options["byte_arrays"]:
901
# The byte_arrays option is not supported yet on
902
# signatures other than "ay".
903
if prop._dbus_signature != "ay":
905
value = dbus.ByteArray(b''.join(chr(byte)
909
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
910
out_signature="a{sv}")
911
def GetAll(self, interface_name):
912
"""Standard D-Bus property GetAll() method, see D-Bus
915
Note: Will not include properties with access="write".
918
for name, prop in self._get_all_dbus_things("property"):
920
and interface_name != prop._dbus_interface):
921
# Interface non-empty but did not match
923
# Ignore write-only properties
924
if prop._dbus_access == "write":
927
if not hasattr(value, "variant_level"):
928
properties[name] = value
930
properties[name] = type(value)(value, variant_level=
931
value.variant_level+1)
932
return dbus.Dictionary(properties, signature="sv")
934
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
936
path_keyword='object_path',
937
connection_keyword='connection')
938
def Introspect(self, object_path, connection):
939
"""Overloading of standard D-Bus method.
941
Inserts property tags and interface annotation tags.
943
xmlstring = dbus.service.Object.Introspect(self, object_path,
946
document = xml.dom.minidom.parseString(xmlstring)
947
def make_tag(document, name, prop):
948
e = document.createElement("property")
949
e.setAttribute("name", name)
950
e.setAttribute("type", prop._dbus_signature)
951
e.setAttribute("access", prop._dbus_access)
953
for if_tag in document.getElementsByTagName("interface"):
955
for tag in (make_tag(document, name, prop)
957
in self._get_all_dbus_things("property")
958
if prop._dbus_interface
959
== if_tag.getAttribute("name")):
960
if_tag.appendChild(tag)
961
# Add annotation tags
962
for typ in ("method", "signal", "property"):
963
for tag in if_tag.getElementsByTagName(typ):
965
for name, prop in (self.
966
_get_all_dbus_things(typ)):
967
if (name == tag.getAttribute("name")
968
and prop._dbus_interface
969
== if_tag.getAttribute("name")):
970
annots.update(getattr
974
for name, value in annots.iteritems():
975
ann_tag = document.createElement(
977
ann_tag.setAttribute("name", name)
978
ann_tag.setAttribute("value", value)
979
tag.appendChild(ann_tag)
980
# Add interface annotation tags
981
for annotation, value in dict(
982
itertools.chain.from_iterable(
983
annotations().iteritems()
984
for name, annotations in
985
self._get_all_dbus_things("interface")
986
if name == if_tag.getAttribute("name")
988
ann_tag = document.createElement("annotation")
989
ann_tag.setAttribute("name", annotation)
990
ann_tag.setAttribute("value", value)
991
if_tag.appendChild(ann_tag)
992
# Add the names to the return values for the
993
# "org.freedesktop.DBus.Properties" methods
994
if (if_tag.getAttribute("name")
995
== "org.freedesktop.DBus.Properties"):
996
for cn in if_tag.getElementsByTagName("method"):
997
if cn.getAttribute("name") == "Get":
998
for arg in cn.getElementsByTagName("arg"):
999
if (arg.getAttribute("direction")
1001
arg.setAttribute("name", "value")
1002
elif cn.getAttribute("name") == "GetAll":
1003
for arg in cn.getElementsByTagName("arg"):
1004
if (arg.getAttribute("direction")
1006
arg.setAttribute("name", "props")
1007
xmlstring = document.toxml("utf-8")
1009
except (AttributeError, xml.dom.DOMException,
1010
xml.parsers.expat.ExpatError) as error:
1011
logger.error("Failed to override Introspection method",
1016
def datetime_to_dbus (dt, variant_level=0):
1017
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1019
return dbus.String("", variant_level = variant_level)
1020
return dbus.String(dt.isoformat(),
1021
variant_level=variant_level)
1024
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1025
"""A class decorator; applied to a subclass of
1026
dbus.service.Object, it will add alternate D-Bus attributes with
1027
interface names according to the "alt_interface_names" mapping.
1030
@alternate_dbus_names({"org.example.Interface":
1031
"net.example.AlternateInterface"})
1032
class SampleDBusObject(dbus.service.Object):
1033
@dbus.service.method("org.example.Interface")
1034
def SampleDBusMethod():
1037
The above "SampleDBusMethod" on "SampleDBusObject" will be
1038
reachable via two interfaces: "org.example.Interface" and
1039
"net.example.AlternateInterface", the latter of which will have
1040
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1041
"true", unless "deprecate" is passed with a False value.
1043
This works for methods and signals, and also for D-Bus properties
1044
(from DBusObjectWithProperties) and interfaces (from the
1045
dbus_interface_annotations decorator).
1048
for orig_interface_name, alt_interface_name in (
1049
alt_interface_names.iteritems()):
1051
interface_names = set()
1052
# Go though all attributes of the class
1053
for attrname, attribute in inspect.getmembers(cls):
1054
# Ignore non-D-Bus attributes, and D-Bus attributes
1055
# with the wrong interface name
1056
if (not hasattr(attribute, "_dbus_interface")
1057
or not attribute._dbus_interface
1058
.startswith(orig_interface_name)):
1060
# Create an alternate D-Bus interface name based on
1062
alt_interface = (attribute._dbus_interface
1063
.replace(orig_interface_name,
1064
alt_interface_name))
1065
interface_names.add(alt_interface)
1066
# Is this a D-Bus signal?
1067
if getattr(attribute, "_dbus_is_signal", False):
1068
# Extract the original non-method function by
1070
nonmethod_func = (dict(
1071
zip(attribute.func_code.co_freevars,
1072
attribute.__closure__))["func"]
1074
# Create a new, but exactly alike, function
1075
# object, and decorate it to be a new D-Bus signal
1076
# with the alternate D-Bus interface name
1077
new_function = (dbus.service.signal
1079
attribute._dbus_signature)
1080
(types.FunctionType(
1081
nonmethod_func.func_code,
1082
nonmethod_func.func_globals,
1083
nonmethod_func.func_name,
1084
nonmethod_func.func_defaults,
1085
nonmethod_func.func_closure)))
1086
# Copy annotations, if any
1088
new_function._dbus_annotations = (
1089
dict(attribute._dbus_annotations))
1090
except AttributeError:
1092
# Define a creator of a function to call both the
1093
# original and alternate functions, so both the
1094
# original and alternate signals gets sent when
1095
# the function is called
1096
def fixscope(func1, func2):
1097
"""This function is a scope container to pass
1098
func1 and func2 to the "call_both" function
1099
outside of its arguments"""
1100
def call_both(*args, **kwargs):
1101
"""This function will emit two D-Bus
1102
signals by calling func1 and func2"""
1103
func1(*args, **kwargs)
1104
func2(*args, **kwargs)
1106
# Create the "call_both" function and add it to
1108
attr[attrname] = fixscope(attribute, new_function)
1109
# Is this a D-Bus method?
1110
elif getattr(attribute, "_dbus_is_method", False):
1111
# Create a new, but exactly alike, function
1112
# object. Decorate it to be a new D-Bus method
1113
# with the alternate D-Bus interface name. Add it
1115
attr[attrname] = (dbus.service.method
1117
attribute._dbus_in_signature,
1118
attribute._dbus_out_signature)
1120
(attribute.func_code,
1121
attribute.func_globals,
1122
attribute.func_name,
1123
attribute.func_defaults,
1124
attribute.func_closure)))
1125
# Copy annotations, if any
1127
attr[attrname]._dbus_annotations = (
1128
dict(attribute._dbus_annotations))
1129
except AttributeError:
1131
# Is this a D-Bus property?
1132
elif getattr(attribute, "_dbus_is_property", False):
1133
# Create a new, but exactly alike, function
1134
# object, and decorate it to be a new D-Bus
1135
# property with the alternate D-Bus interface
1136
# name. Add it to the class.
1137
attr[attrname] = (dbus_service_property
1139
attribute._dbus_signature,
1140
attribute._dbus_access,
1142
._dbus_get_args_options
1145
(attribute.func_code,
1146
attribute.func_globals,
1147
attribute.func_name,
1148
attribute.func_defaults,
1149
attribute.func_closure)))
1150
# Copy annotations, if any
1152
attr[attrname]._dbus_annotations = (
1153
dict(attribute._dbus_annotations))
1154
except AttributeError:
1156
# Is this a D-Bus interface?
1157
elif getattr(attribute, "_dbus_is_interface", False):
1158
# Create a new, but exactly alike, function
1159
# object. Decorate it to be a new D-Bus interface
1160
# with the alternate D-Bus interface name. Add it
1162
attr[attrname] = (dbus_interface_annotations
1165
(attribute.func_code,
1166
attribute.func_globals,
1167
attribute.func_name,
1168
attribute.func_defaults,
1169
attribute.func_closure)))
1171
# Deprecate all alternate interfaces
1172
iname="_AlternateDBusNames_interface_annotation{0}"
1173
for interface_name in interface_names:
1174
@dbus_interface_annotations(interface_name)
1176
return { "org.freedesktop.DBus.Deprecated":
1178
# Find an unused name
1179
for aname in (iname.format(i)
1180
for i in itertools.count()):
1181
if aname not in attr:
1185
# Replace the class with a new subclass of it with
1186
# methods, signals, etc. as created above.
1187
cls = type(b"{0}Alternate".format(cls.__name__),
1193
@alternate_dbus_interfaces({"se.recompile.Mandos":
1194
"se.bsnet.fukt.Mandos"})
1195
class ClientDBus(Client, DBusObjectWithProperties):
1196
"""A Client class using D-Bus
1199
dbus_object_path: dbus.ObjectPath
1200
bus: dbus.SystemBus()
1203
runtime_expansions = (Client.runtime_expansions
1204
+ ("dbus_object_path",))
1206
# dbus.service.Object doesn't use super(), so we can't either.
1208
def __init__(self, bus = None, *args, **kwargs):
1210
Client.__init__(self, *args, **kwargs)
1211
# Only now, when this client is initialized, can it show up on
1213
client_object_name = unicode(self.name).translate(
1214
{ord("."): ord("_"),
1215
ord("-"): ord("_")})
1216
self.dbus_object_path = (dbus.ObjectPath
1217
("/clients/" + client_object_name))
1218
DBusObjectWithProperties.__init__(self, self.bus,
1219
self.dbus_object_path)
1221
def notifychangeproperty(transform_func,
1222
dbus_name, type_func=lambda x: x,
1224
""" Modify a variable so that it's a property which announces
1225
its changes to DBus.
1227
transform_fun: Function that takes a value and a variant_level
1228
and transforms it to a D-Bus type.
1229
dbus_name: D-Bus name of the variable
1230
type_func: Function that transform the value before sending it
1231
to the D-Bus. Default: no transform
1232
variant_level: D-Bus variant level. Default: 1
1234
attrname = "_{0}".format(dbus_name)
1235
def setter(self, value):
1236
if hasattr(self, "dbus_object_path"):
1237
if (not hasattr(self, attrname) or
1238
type_func(getattr(self, attrname, None))
1239
!= type_func(value)):
1240
dbus_value = transform_func(type_func(value),
1243
self.PropertyChanged(dbus.String(dbus_name),
1245
setattr(self, attrname, value)
1247
return property(lambda self: getattr(self, attrname), setter)
1249
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1250
approvals_pending = notifychangeproperty(dbus.Boolean,
1253
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1254
last_enabled = notifychangeproperty(datetime_to_dbus,
1256
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1257
type_func = lambda checker:
1258
checker is not None)
1259
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1261
last_checker_status = notifychangeproperty(dbus.Int16,
1262
"LastCheckerStatus")
1263
last_approval_request = notifychangeproperty(
1264
datetime_to_dbus, "LastApprovalRequest")
1265
approved_by_default = notifychangeproperty(dbus.Boolean,
1266
"ApprovedByDefault")
1267
approval_delay = notifychangeproperty(dbus.UInt64,
1270
timedelta_to_milliseconds)
1271
approval_duration = notifychangeproperty(
1272
dbus.UInt64, "ApprovalDuration",
1273
type_func = timedelta_to_milliseconds)
1274
host = notifychangeproperty(dbus.String, "Host")
1275
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1277
timedelta_to_milliseconds)
1278
extended_timeout = notifychangeproperty(
1279
dbus.UInt64, "ExtendedTimeout",
1280
type_func = timedelta_to_milliseconds)
1281
interval = notifychangeproperty(dbus.UInt64,
1284
timedelta_to_milliseconds)
1285
checker_command = notifychangeproperty(dbus.String, "Checker")
1287
del notifychangeproperty
1289
def __del__(self, *args, **kwargs):
1291
self.remove_from_connection()
1294
if hasattr(DBusObjectWithProperties, "__del__"):
1295
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1296
Client.__del__(self, *args, **kwargs)
1298
def checker_callback(self, pid, condition, command,
1300
self.checker_callback_tag = None
1302
if os.WIFEXITED(condition):
1303
exitstatus = os.WEXITSTATUS(condition)
1305
self.CheckerCompleted(dbus.Int16(exitstatus),
1306
dbus.Int64(condition),
1307
dbus.String(command))
1310
self.CheckerCompleted(dbus.Int16(-1),
1311
dbus.Int64(condition),
1312
dbus.String(command))
1314
return Client.checker_callback(self, pid, condition, command,
1317
def start_checker(self, *args, **kwargs):
1318
old_checker = self.checker
1319
if self.checker is not None:
1320
old_checker_pid = self.checker.pid
1322
old_checker_pid = None
1323
r = Client.start_checker(self, *args, **kwargs)
1324
# Only if new checker process was started
1325
if (self.checker is not None
1326
and old_checker_pid != self.checker.pid):
1328
self.CheckerStarted(self.current_checker_command)
1331
def _reset_approved(self):
1332
self.approved = None
1335
def approve(self, value=True):
1336
self.send_changedstate()
1337
self.approved = value
1338
gobject.timeout_add(timedelta_to_milliseconds
1339
(self.approval_duration),
1340
self._reset_approved)
1342
## D-Bus methods, signals & properties
1343
_interface = "se.recompile.Mandos.Client"
1347
@dbus_interface_annotations(_interface)
1349
return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1354
# CheckerCompleted - signal
1355
@dbus.service.signal(_interface, signature="nxs")
1356
def CheckerCompleted(self, exitcode, waitstatus, command):
1360
# CheckerStarted - signal
1361
@dbus.service.signal(_interface, signature="s")
1362
def CheckerStarted(self, command):
1366
# PropertyChanged - signal
1367
@dbus.service.signal(_interface, signature="sv")
1368
def PropertyChanged(self, property, value):
1372
# GotSecret - signal
1373
@dbus.service.signal(_interface)
1374
def GotSecret(self):
1376
Is sent after a successful transfer of secret from the Mandos
1377
server to mandos-client
1382
@dbus.service.signal(_interface, signature="s")
1383
def Rejected(self, reason):
1387
# NeedApproval - signal
1388
@dbus.service.signal(_interface, signature="tb")
1389
def NeedApproval(self, timeout, default):
1391
return self.need_approval()
1396
@dbus.service.method(_interface, in_signature="b")
1397
def Approve(self, value):
1400
# CheckedOK - method
1401
@dbus.service.method(_interface)
1402
def CheckedOK(self):
1406
@dbus.service.method(_interface)
1411
# StartChecker - method
1412
@dbus.service.method(_interface)
1413
def StartChecker(self):
1415
self.start_checker()
1418
@dbus.service.method(_interface)
1423
# StopChecker - method
1424
@dbus.service.method(_interface)
1425
def StopChecker(self):
1430
# ApprovalPending - property
1431
@dbus_service_property(_interface, signature="b", access="read")
1432
def ApprovalPending_dbus_property(self):
1433
return dbus.Boolean(bool(self.approvals_pending))
1435
# ApprovedByDefault - property
1436
@dbus_service_property(_interface, signature="b",
1438
def ApprovedByDefault_dbus_property(self, value=None):
1439
if value is None: # get
1440
return dbus.Boolean(self.approved_by_default)
1441
self.approved_by_default = bool(value)
1443
# ApprovalDelay - property
1444
@dbus_service_property(_interface, signature="t",
1446
def ApprovalDelay_dbus_property(self, value=None):
1447
if value is None: # get
1448
return dbus.UInt64(self.approval_delay_milliseconds())
1449
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1451
# ApprovalDuration - property
1452
@dbus_service_property(_interface, signature="t",
1454
def ApprovalDuration_dbus_property(self, value=None):
1455
if value is None: # get
1456
return dbus.UInt64(timedelta_to_milliseconds(
1457
self.approval_duration))
1458
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1461
@dbus_service_property(_interface, signature="s", access="read")
1462
def Name_dbus_property(self):
1463
return dbus.String(self.name)
1465
# Fingerprint - property
1466
@dbus_service_property(_interface, signature="s", access="read")
1467
def Fingerprint_dbus_property(self):
1468
return dbus.String(self.fingerprint)
1471
@dbus_service_property(_interface, signature="s",
1473
def Host_dbus_property(self, value=None):
1474
if value is None: # get
1475
return dbus.String(self.host)
1476
self.host = unicode(value)
1478
# Created - property
1479
@dbus_service_property(_interface, signature="s", access="read")
1480
def Created_dbus_property(self):
1481
return datetime_to_dbus(self.created)
1483
# LastEnabled - property
1484
@dbus_service_property(_interface, signature="s", access="read")
1485
def LastEnabled_dbus_property(self):
1486
return datetime_to_dbus(self.last_enabled)
1488
# Enabled - property
1489
@dbus_service_property(_interface, signature="b",
1491
def Enabled_dbus_property(self, value=None):
1492
if value is None: # get
1493
return dbus.Boolean(self.enabled)
1499
# LastCheckedOK - property
1500
@dbus_service_property(_interface, signature="s",
1502
def LastCheckedOK_dbus_property(self, value=None):
1503
if value is not None:
1506
return datetime_to_dbus(self.last_checked_ok)
1508
# LastCheckerStatus - property
1509
@dbus_service_property(_interface, signature="n",
1511
def LastCheckerStatus_dbus_property(self):
1512
return dbus.Int16(self.last_checker_status)
1514
# Expires - property
1515
@dbus_service_property(_interface, signature="s", access="read")
1516
def Expires_dbus_property(self):
1517
return datetime_to_dbus(self.expires)
1519
# LastApprovalRequest - property
1520
@dbus_service_property(_interface, signature="s", access="read")
1521
def LastApprovalRequest_dbus_property(self):
1522
return datetime_to_dbus(self.last_approval_request)
1524
# Timeout - property
1525
@dbus_service_property(_interface, signature="t",
1527
def Timeout_dbus_property(self, value=None):
1528
if value is None: # get
1529
return dbus.UInt64(self.timeout_milliseconds())
1530
self.timeout = datetime.timedelta(0, 0, 0, value)
1531
# Reschedule timeout
1533
now = datetime.datetime.utcnow()
1534
time_to_die = timedelta_to_milliseconds(
1535
(self.last_checked_ok + self.timeout) - now)
1536
if time_to_die <= 0:
1537
# The timeout has passed
1540
self.expires = (now +
1541
datetime.timedelta(milliseconds =
1543
if (getattr(self, "disable_initiator_tag", None)
1546
gobject.source_remove(self.disable_initiator_tag)
1547
self.disable_initiator_tag = (gobject.timeout_add
1551
# ExtendedTimeout - property
1552
@dbus_service_property(_interface, signature="t",
1554
def ExtendedTimeout_dbus_property(self, value=None):
1555
if value is None: # get
1556
return dbus.UInt64(self.extended_timeout_milliseconds())
1557
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1559
# Interval - property
1560
@dbus_service_property(_interface, signature="t",
1562
def Interval_dbus_property(self, value=None):
1563
if value is None: # get
1564
return dbus.UInt64(self.interval_milliseconds())
1565
self.interval = datetime.timedelta(0, 0, 0, value)
1566
if getattr(self, "checker_initiator_tag", None) is None:
1569
# Reschedule checker run
1570
gobject.source_remove(self.checker_initiator_tag)
1571
self.checker_initiator_tag = (gobject.timeout_add
1572
(value, self.start_checker))
1573
self.start_checker() # Start one now, too
1575
# Checker - property
1576
@dbus_service_property(_interface, signature="s",
1578
def Checker_dbus_property(self, value=None):
1579
if value is None: # get
1580
return dbus.String(self.checker_command)
1581
self.checker_command = unicode(value)
1583
# CheckerRunning - property
1584
@dbus_service_property(_interface, signature="b",
1586
def CheckerRunning_dbus_property(self, value=None):
1587
if value is None: # get
1588
return dbus.Boolean(self.checker is not None)
1590
self.start_checker()
1594
# ObjectPath - property
1595
@dbus_service_property(_interface, signature="o", access="read")
1596
def ObjectPath_dbus_property(self):
1597
return self.dbus_object_path # is already a dbus.ObjectPath
1600
@dbus_service_property(_interface, signature="ay",
1601
access="write", byte_arrays=True)
1602
def Secret_dbus_property(self, value):
1603
self.secret = str(value)
1608
class ProxyClient(object):
1609
def __init__(self, child_pipe, fpr, address):
1610
self._pipe = child_pipe
1611
self._pipe.send(('init', fpr, address))
1612
if not self._pipe.recv():
1615
def __getattribute__(self, name):
1617
return super(ProxyClient, self).__getattribute__(name)
1618
self._pipe.send(('getattr', name))
1619
data = self._pipe.recv()
1620
if data[0] == 'data':
1622
if data[0] == 'function':
1623
def func(*args, **kwargs):
1624
self._pipe.send(('funcall', name, args, kwargs))
1625
return self._pipe.recv()[1]
1628
def __setattr__(self, name, value):
1630
return super(ProxyClient, self).__setattr__(name, value)
1631
self._pipe.send(('setattr', name, value))
1634
class ClientHandler(socketserver.BaseRequestHandler, object):
1635
"""A class to handle client connections.
1637
Instantiated once for each connection to handle it.
442
1638
Note: This will run in its own forked process."""
444
1640
def handle(self):
445
logger.info(u"TCP connection from: %s",
446
unicode(self.client_address))
447
session = gnutls.connection.ClientSession\
448
(self.request, gnutls.connection.X509Credentials())
450
line = self.request.makefile().readline()
451
logger.debug(u"Protocol version: %r", line)
453
if int(line.strip().split()[0]) > 1:
455
except (ValueError, IndexError, RuntimeError), error:
456
logger.error(u"Unknown protocol version: %s", error)
459
# Note: gnutls.connection.X509Credentials is really a generic
460
# GnuTLS certificate credentials object so long as no X.509
461
# keys are added to it. Therefore, we can use it here despite
462
# using OpenPGP certificates.
464
#priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
465
# "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
467
priority = "NORMAL" # Fallback default, since this
469
if self.server.settings["priority"]:
470
priority = self.server.settings["priority"]
471
gnutls.library.functions.gnutls_priority_set_direct\
472
(session._c_object, priority, None);
476
except gnutls.errors.GNUTLSError, error:
477
logger.warning(u"Handshake failed: %s", error)
478
# Do not run session.bye() here: the session is not
479
# established. Just abandon the request.
482
fpr = fingerprint(peer_certificate(session))
483
except (TypeError, gnutls.errors.GNUTLSError), error:
484
logger.warning(u"Bad certificate: %s", error)
487
logger.debug(u"Fingerprint: %s", fpr)
489
for c in self.server.clients:
490
if c.fingerprint == fpr:
494
logger.warning(u"Client not found for fingerprint: %s",
498
# Have to check if client.still_valid(), since it is possible
499
# that the client timed out while establishing the GnuTLS
501
if not client.still_valid():
502
logger.warning(u"Client %(name)s is invalid",
507
while sent_size < len(client.secret):
508
sent = session.send(client.secret[sent_size:])
509
logger.debug(u"Sent: %d, remaining: %d",
510
sent, len(client.secret)
511
- (sent_size + sent))
516
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
517
"""IPv6 TCP server. Accepts 'None' as address and/or port.
1641
with contextlib.closing(self.server.child_pipe) as child_pipe:
1642
logger.info("TCP connection from: %s",
1643
unicode(self.client_address))
1644
logger.debug("Pipe FD: %d",
1645
self.server.child_pipe.fileno())
1647
session = (gnutls.connection
1648
.ClientSession(self.request,
1650
.X509Credentials()))
1652
# Note: gnutls.connection.X509Credentials is really a
1653
# generic GnuTLS certificate credentials object so long as
1654
# no X.509 keys are added to it. Therefore, we can use it
1655
# here despite using OpenPGP certificates.
1657
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1658
# "+AES-256-CBC", "+SHA1",
1659
# "+COMP-NULL", "+CTYPE-OPENPGP",
1661
# Use a fallback default, since this MUST be set.
1662
priority = self.server.gnutls_priority
1663
if priority is None:
1665
(gnutls.library.functions
1666
.gnutls_priority_set_direct(session._c_object,
1669
# Start communication using the Mandos protocol
1670
# Get protocol number
1671
line = self.request.makefile().readline()
1672
logger.debug("Protocol version: %r", line)
1674
if int(line.strip().split()[0]) > 1:
1676
except (ValueError, IndexError, RuntimeError) as error:
1677
logger.error("Unknown protocol version: %s", error)
1680
# Start GnuTLS connection
1683
except gnutls.errors.GNUTLSError as error:
1684
logger.warning("Handshake failed: %s", error)
1685
# Do not run session.bye() here: the session is not
1686
# established. Just abandon the request.
1688
logger.debug("Handshake succeeded")
1690
approval_required = False
1693
fpr = self.fingerprint(self.peer_certificate
1696
gnutls.errors.GNUTLSError) as error:
1697
logger.warning("Bad certificate: %s", error)
1699
logger.debug("Fingerprint: %s", fpr)
1702
client = ProxyClient(child_pipe, fpr,
1703
self.client_address)
1707
if client.approval_delay:
1708
delay = client.approval_delay
1709
client.approvals_pending += 1
1710
approval_required = True
1713
if not client.enabled:
1714
logger.info("Client %s is disabled",
1716
if self.server.use_dbus:
1718
client.Rejected("Disabled")
1721
if client.approved or not client.approval_delay:
1722
#We are approved or approval is disabled
1724
elif client.approved is None:
1725
logger.info("Client %s needs approval",
1727
if self.server.use_dbus:
1729
client.NeedApproval(
1730
client.approval_delay_milliseconds(),
1731
client.approved_by_default)
1733
logger.warning("Client %s was not approved",
1735
if self.server.use_dbus:
1737
client.Rejected("Denied")
1740
#wait until timeout or approved
1741
time = datetime.datetime.now()
1742
client.changedstate.acquire()
1743
(client.changedstate.wait
1744
(float(client.timedelta_to_milliseconds(delay)
1746
client.changedstate.release()
1747
time2 = datetime.datetime.now()
1748
if (time2 - time) >= delay:
1749
if not client.approved_by_default:
1750
logger.warning("Client %s timed out while"
1751
" waiting for approval",
1753
if self.server.use_dbus:
1755
client.Rejected("Approval timed out")
1760
delay -= time2 - time
1763
while sent_size < len(client.secret):
1765
sent = session.send(client.secret[sent_size:])
1766
except gnutls.errors.GNUTLSError as error:
1767
logger.warning("gnutls send failed",
1770
logger.debug("Sent: %d, remaining: %d",
1771
sent, len(client.secret)
1772
- (sent_size + sent))
1775
logger.info("Sending secret to %s", client.name)
1776
# bump the timeout using extended_timeout
1777
client.bump_timeout(client.extended_timeout)
1778
if self.server.use_dbus:
1783
if approval_required:
1784
client.approvals_pending -= 1
1787
except gnutls.errors.GNUTLSError as error:
1788
logger.warning("GnuTLS bye failed",
1792
def peer_certificate(session):
1793
"Return the peer's OpenPGP certificate as a bytestring"
1794
# If not an OpenPGP certificate...
1795
if (gnutls.library.functions
1796
.gnutls_certificate_type_get(session._c_object)
1797
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1798
# ...do the normal thing
1799
return session.peer_certificate
1800
list_size = ctypes.c_uint(1)
1801
cert_list = (gnutls.library.functions
1802
.gnutls_certificate_get_peers
1803
(session._c_object, ctypes.byref(list_size)))
1804
if not bool(cert_list) and list_size.value != 0:
1805
raise gnutls.errors.GNUTLSError("error getting peer"
1807
if list_size.value == 0:
1810
return ctypes.string_at(cert.data, cert.size)
1813
def fingerprint(openpgp):
1814
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1815
# New GnuTLS "datum" with the OpenPGP public key
1816
datum = (gnutls.library.types
1817
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1820
ctypes.c_uint(len(openpgp))))
1821
# New empty GnuTLS certificate
1822
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1823
(gnutls.library.functions
1824
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
1825
# Import the OpenPGP public key into the certificate
1826
(gnutls.library.functions
1827
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1828
gnutls.library.constants
1829
.GNUTLS_OPENPGP_FMT_RAW))
1830
# Verify the self signature in the key
1831
crtverify = ctypes.c_uint()
1832
(gnutls.library.functions
1833
.gnutls_openpgp_crt_verify_self(crt, 0,
1834
ctypes.byref(crtverify)))
1835
if crtverify.value != 0:
1836
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1837
raise (gnutls.errors.CertificateSecurityError
1839
# New buffer for the fingerprint
1840
buf = ctypes.create_string_buffer(20)
1841
buf_len = ctypes.c_size_t()
1842
# Get the fingerprint from the certificate into the buffer
1843
(gnutls.library.functions
1844
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1845
ctypes.byref(buf_len)))
1846
# Deinit the certificate
1847
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1848
# Convert the buffer to a Python bytestring
1849
fpr = ctypes.string_at(buf, buf_len.value)
1850
# Convert the bytestring to hexadecimal notation
1851
hex_fpr = binascii.hexlify(fpr).upper()
1855
class MultiprocessingMixIn(object):
1856
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1857
def sub_process_main(self, request, address):
1859
self.finish_request(request, address)
1861
self.handle_error(request, address)
1862
self.close_request(request)
1864
def process_request(self, request, address):
1865
"""Start a new process to process the request."""
1866
proc = multiprocessing.Process(target = self.sub_process_main,
1873
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1874
""" adds a pipe to the MixIn """
1875
def process_request(self, request, client_address):
1876
"""Overrides and wraps the original process_request().
1878
This function creates a new pipe in self.pipe
1880
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1882
proc = MultiprocessingMixIn.process_request(self, request,
1884
self.child_pipe.close()
1885
self.add_pipe(parent_pipe, proc)
1887
def add_pipe(self, parent_pipe, proc):
1888
"""Dummy function; override as necessary"""
1889
raise NotImplementedError
1892
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1893
socketserver.TCPServer, object):
1894
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
519
settings: Server settings
520
clients: Set() of Client objects
521
1897
enabled: Boolean; whether this server is activated yet
1898
interface: None or a network interface name (string)
1899
use_ipv6: Boolean; to use IPv6 or not
523
address_family = socket.AF_INET6
524
def __init__(self, *args, **kwargs):
525
if "settings" in kwargs:
526
self.settings = kwargs["settings"]
527
del kwargs["settings"]
528
if "clients" in kwargs:
529
self.clients = kwargs["clients"]
530
del kwargs["clients"]
532
return super(type(self), self).__init__(*args, **kwargs)
1901
def __init__(self, server_address, RequestHandlerClass,
1902
interface=None, use_ipv6=True):
1903
self.interface = interface
1905
self.address_family = socket.AF_INET6
1906
socketserver.TCPServer.__init__(self, server_address,
1907
RequestHandlerClass)
533
1908
def server_bind(self):
534
1909
"""This overrides the normal server_bind() function
535
1910
to bind to an interface if one was specified, and also NOT to
536
1911
bind to an address or port if they were not specified."""
537
if self.settings["interface"]:
538
# 25 is from /usr/include/asm-i486/socket.h
539
SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
541
self.socket.setsockopt(socket.SOL_SOCKET,
543
self.settings["interface"])
544
except socket.error, error:
545
if error[0] == errno.EPERM:
546
logger.error(u"No permission to"
547
u" bind to interface %s",
548
self.settings["interface"])
1912
if self.interface is not None:
1913
if SO_BINDTODEVICE is None:
1914
logger.error("SO_BINDTODEVICE does not exist;"
1915
" cannot bind to interface %s",
1919
self.socket.setsockopt(socket.SOL_SOCKET,
1923
except socket.error as error:
1924
if error[0] == errno.EPERM:
1925
logger.error("No permission to"
1926
" bind to interface %s",
1928
elif error[0] == errno.ENOPROTOOPT:
1929
logger.error("SO_BINDTODEVICE not available;"
1930
" cannot bind to interface %s",
551
1934
# Only bind(2) the socket if we really need to.
552
1935
if self.server_address[0] or self.server_address[1]:
553
1936
if not self.server_address[0]:
555
self.server_address = (in6addr_any,
1937
if self.address_family == socket.AF_INET6:
1938
any_address = "::" # in6addr_any
1940
any_address = socket.INADDR_ANY
1941
self.server_address = (any_address,
556
1942
self.server_address[1])
557
1943
elif not self.server_address[1]:
558
1944
self.server_address = (self.server_address[0],
560
# if self.settings["interface"]:
1946
# if self.interface:
561
1947
# self.server_address = (self.server_address[0],
564
1950
# if_nametoindex
567
return super(type(self), self).server_bind()
1952
return socketserver.TCPServer.server_bind(self)
1955
class MandosServer(IPv6_TCPServer):
1959
clients: set of Client objects
1960
gnutls_priority GnuTLS priority string
1961
use_dbus: Boolean; to emit D-Bus signals or not
1963
Assumes a gobject.MainLoop event loop.
1965
def __init__(self, server_address, RequestHandlerClass,
1966
interface=None, use_ipv6=True, clients=None,
1967
gnutls_priority=None, use_dbus=True):
1968
self.enabled = False
1969
self.clients = clients
1970
if self.clients is None:
1972
self.use_dbus = use_dbus
1973
self.gnutls_priority = gnutls_priority
1974
IPv6_TCPServer.__init__(self, server_address,
1975
RequestHandlerClass,
1976
interface = interface,
1977
use_ipv6 = use_ipv6)
568
1978
def server_activate(self):
569
1979
if self.enabled:
570
return super(type(self), self).server_activate()
1980
return socketserver.TCPServer.server_activate(self)
571
1982
def enable(self):
572
1983
self.enabled = True
1985
def add_pipe(self, parent_pipe, proc):
1986
# Call "handle_ipc" for both data and EOF events
1987
gobject.io_add_watch(parent_pipe.fileno(),
1988
gobject.IO_IN | gobject.IO_HUP,
1989
functools.partial(self.handle_ipc,
1994
def handle_ipc(self, source, condition, parent_pipe=None,
1995
proc = None, client_object=None):
1996
# error, or the other end of multiprocessing.Pipe has closed
1997
if condition & (gobject.IO_ERR | gobject.IO_HUP):
1998
# Wait for other process to exit
2002
# Read a request from the child
2003
request = parent_pipe.recv()
2004
command = request[0]
2006
if command == 'init':
2008
address = request[2]
2010
for c in self.clients.itervalues():
2011
if c.fingerprint == fpr:
2015
logger.info("Client not found for fingerprint: %s, ad"
2016
"dress: %s", fpr, address)
2019
mandos_dbus_service.ClientNotFound(fpr,
2021
parent_pipe.send(False)
2024
gobject.io_add_watch(parent_pipe.fileno(),
2025
gobject.IO_IN | gobject.IO_HUP,
2026
functools.partial(self.handle_ipc,
2032
parent_pipe.send(True)
2033
# remove the old hook in favor of the new above hook on
2036
if command == 'funcall':
2037
funcname = request[1]
2041
parent_pipe.send(('data', getattr(client_object,
2045
if command == 'getattr':
2046
attrname = request[1]
2047
if callable(client_object.__getattribute__(attrname)):
2048
parent_pipe.send(('function',))
2050
parent_pipe.send(('data', client_object
2051
.__getattribute__(attrname)))
2053
if command == 'setattr':
2054
attrname = request[1]
2056
setattr(client_object, attrname, value)
575
2061
def string_to_delta(interval):
576
2062
"""Parse a string and return a datetime.timedelta
578
2064
>>> string_to_delta('7d')
579
2065
datetime.timedelta(7)
580
2066
>>> string_to_delta('60s')
722
2180
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
723
2181
"servicename": "Mandos",
2186
"statedir": "/var/lib/mandos"
726
2189
# Parse config file for server-global settings
727
server_config = ConfigParser.SafeConfigParser(server_defaults)
2190
server_config = configparser.SafeConfigParser(server_defaults)
728
2191
del server_defaults
729
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2192
server_config.read(os.path.join(options.configdir,
730
2194
# Convert the SafeConfigParser object to a dict
731
2195
server_settings = server_config.defaults()
732
# Use getboolean on the boolean config option
733
server_settings["debug"] = server_config.getboolean\
2196
# Use the appropriate methods on the non-string config options
2197
for option in ("debug", "use_dbus", "use_ipv6"):
2198
server_settings[option] = server_config.getboolean("DEFAULT",
2200
if server_settings["port"]:
2201
server_settings["port"] = server_config.getint("DEFAULT",
735
2203
del server_config
737
2205
# Override the settings from the config file with command line
738
2206
# options, if set.
739
2207
for option in ("interface", "address", "port", "debug",
740
"priority", "servicename", "configdir"):
2208
"priority", "servicename", "configdir",
2209
"use_dbus", "use_ipv6", "debuglevel", "restore",
741
2211
value = getattr(options, option)
742
2212
if value is not None:
743
2213
server_settings[option] = value
2215
# Force all strings to be unicode
2216
for option in server_settings.keys():
2217
if type(server_settings[option]) is str:
2218
server_settings[option] = unicode(server_settings[option])
745
2219
# Now we have our good server settings in "server_settings"
2221
##################################################################
747
2224
debug = server_settings["debug"]
2225
debuglevel = server_settings["debuglevel"]
2226
use_dbus = server_settings["use_dbus"]
2227
use_ipv6 = server_settings["use_ipv6"]
2228
stored_state_path = os.path.join(server_settings["statedir"],
750
syslogger.setLevel(logging.WARNING)
751
console.setLevel(logging.WARNING)
2232
initlogger(debug, logging.DEBUG)
2237
level = getattr(logging, debuglevel.upper())
2238
initlogger(debug, level)
753
2240
if server_settings["servicename"] != "Mandos":
754
syslogger.setFormatter(logging.Formatter\
755
('Mandos (%s): %%(levelname)s:'
757
% server_settings["servicename"]))
2241
syslogger.setFormatter(logging.Formatter
2242
('Mandos ({0}) [%(process)d]:'
2243
' %(levelname)s: %(message)s'
2244
.format(server_settings
759
2247
# Parse config file with clients
760
client_defaults = { "timeout": "1h",
762
"checker": "fping -q -- %(host)s",
765
client_config = ConfigParser.SafeConfigParser(client_defaults)
2248
client_config = configparser.SafeConfigParser(Client
766
2250
client_config.read(os.path.join(server_settings["configdir"],
767
2251
"clients.conf"))
770
tcp_server = IPv6_TCPServer((server_settings["address"],
771
server_settings["port"]),
773
settings=server_settings,
775
pidfilename = "/var/run/mandos.pid"
777
pidfile = open(pidfilename, "w")
778
except IOError, error:
779
logger.error("Could not open file %r", pidfilename)
784
uid = pwd.getpwnam("mandos").pw_uid
787
uid = pwd.getpwnam("nobody").pw_uid
791
gid = pwd.getpwnam("mandos").pw_gid
794
gid = pwd.getpwnam("nogroup").pw_gid
2253
global mandos_dbus_service
2254
mandos_dbus_service = None
2256
tcp_server = MandosServer((server_settings["address"],
2257
server_settings["port"]),
2259
interface=(server_settings["interface"]
2263
server_settings["priority"],
2266
pidfilename = "/var/run/mandos.pid"
2268
pidfile = open(pidfilename, "w")
2269
except IOError as e:
2270
logger.error("Could not open file %r", pidfilename,
2273
for name in ("_mandos", "mandos", "nobody"):
2275
uid = pwd.getpwnam(name).pw_uid
2276
gid = pwd.getpwnam(name).pw_gid
800
except OSError, error:
2286
except OSError as error:
801
2287
if error[0] != errno.EPERM:
805
service = AvahiService(name = server_settings["servicename"],
806
type = "_mandos._tcp", );
807
if server_settings["interface"]:
808
service.interface = if_nametoindex\
809
(server_settings["interface"])
2291
# Enable all possible GnuTLS debugging
2293
# "Use a log level over 10 to enable all debugging options."
2295
gnutls.library.functions.gnutls_global_set_log_level(11)
2297
@gnutls.library.types.gnutls_log_func
2298
def debug_gnutls(level, string):
2299
logger.debug("GnuTLS: %s", string[:-1])
2301
(gnutls.library.functions
2302
.gnutls_global_set_log_function(debug_gnutls))
2304
# Redirect stdin so all checkers get /dev/null
2305
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2306
os.dup2(null, sys.stdin.fileno())
2310
# Need to fork before connecting to D-Bus
2312
# Close all input and output, do double fork, etc.
2315
gobject.threads_init()
811
2317
global main_loop
814
2318
# From the Avahi example code
815
DBusGMainLoop(set_as_default=True )
2319
DBusGMainLoop(set_as_default=True)
816
2320
main_loop = gobject.MainLoop()
817
2321
bus = dbus.SystemBus()
818
server = dbus.Interface(bus.get_object(avahi.DBUS_NAME,
819
avahi.DBUS_PATH_SERVER),
820
avahi.DBUS_INTERFACE_SERVER)
821
2322
# End of Avahi example code
823
def remove_from_clients(client):
824
clients.remove(client)
826
logger.critical(u"No clients left, exiting")
829
clients.update(Set(Client(name = section,
830
stop_hook = remove_from_clients,
832
= dict(client_config.items(section)))
833
for section in client_config.sections()))
835
logger.critical(u"No clients defined")
839
# Redirect stdin so all checkers get /dev/null
840
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
841
os.dup2(null, sys.stdin.fileno())
846
logger.removeHandler(console)
847
# Close all input and output, do double fork, etc.
852
pidfile.write(str(pid) + "\n")
856
logger.error(u"Could not write to file %r with PID %d",
859
# "pidfile" was never created
2325
bus_name = dbus.service.BusName("se.recompile.Mandos",
2326
bus, do_not_queue=True)
2327
old_bus_name = (dbus.service.BusName
2328
("se.bsnet.fukt.Mandos", bus,
2330
except dbus.exceptions.NameExistsException as e:
2331
logger.error("Disabling D-Bus:", exc_info=e)
2333
server_settings["use_dbus"] = False
2334
tcp_server.use_dbus = False
2335
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2336
service = AvahiServiceToSyslog(name =
2337
server_settings["servicename"],
2338
servicetype = "_mandos._tcp",
2339
protocol = protocol, bus = bus)
2340
if server_settings["interface"]:
2341
service.interface = (if_nametoindex
2342
(str(server_settings["interface"])))
2344
global multiprocessing_manager
2345
multiprocessing_manager = multiprocessing.Manager()
2347
client_class = Client
2349
client_class = functools.partial(ClientDBus, bus = bus)
2351
client_settings = Client.config_parser(client_config)
2352
old_client_settings = {}
2355
# Get client data and settings from last running state.
2356
if server_settings["restore"]:
2358
with open(stored_state_path, "rb") as stored_state:
2359
clients_data, old_client_settings = (pickle.load
2361
os.remove(stored_state_path)
2362
except IOError as e:
2363
if e.errno == errno.ENOENT:
2364
logger.warning("Could not load persistent state: {0}"
2365
.format(os.strerror(e.errno)))
2367
logger.critical("Could not load persistent state:",
2370
except EOFError as e:
2371
logger.warning("Could not load persistent state: "
2372
"EOFError:", exc_info=e)
2374
with PGPEngine() as pgp:
2375
for client_name, client in clients_data.iteritems():
2376
# Decide which value to use after restoring saved state.
2377
# We have three different values: Old config file,
2378
# new config file, and saved state.
2379
# New config value takes precedence if it differs from old
2380
# config value, otherwise use saved state.
2381
for name, value in client_settings[client_name].items():
2383
# For each value in new config, check if it
2384
# differs from the old config value (Except for
2385
# the "secret" attribute)
2386
if (name != "secret" and
2387
value != old_client_settings[client_name]
2389
client[name] = value
2393
# Clients who has passed its expire date can still be
2394
# enabled if its last checker was successful. Clients
2395
# whose checker succeeded before we stored its state is
2396
# assumed to have successfully run all checkers during
2398
if client["enabled"]:
2399
if datetime.datetime.utcnow() >= client["expires"]:
2400
if not client["last_checked_ok"]:
2402
"disabling client {0} - Client never "
2403
"performed a successful checker"
2404
.format(client_name))
2405
client["enabled"] = False
2406
elif client["last_checker_status"] != 0:
2408
"disabling client {0} - Client "
2409
"last checker failed with error code {1}"
2410
.format(client_name,
2411
client["last_checker_status"]))
2412
client["enabled"] = False
2414
client["expires"] = (datetime.datetime
2416
+ client["timeout"])
2417
logger.debug("Last checker succeeded,"
2418
" keeping {0} enabled"
2419
.format(client_name))
2421
client["secret"] = (
2422
pgp.decrypt(client["encrypted_secret"],
2423
client_settings[client_name]
2426
# If decryption fails, we use secret from new settings
2427
logger.debug("Failed to decrypt {0} old secret"
2428
.format(client_name))
2429
client["secret"] = (
2430
client_settings[client_name]["secret"])
2432
# Add/remove clients based on new changes made to config
2433
for client_name in (set(old_client_settings)
2434
- set(client_settings)):
2435
del clients_data[client_name]
2436
for client_name in (set(client_settings)
2437
- set(old_client_settings)):
2438
clients_data[client_name] = client_settings[client_name]
2440
# Create all client objects
2441
for client_name, client in clients_data.iteritems():
2442
tcp_server.clients[client_name] = client_class(
2443
name = client_name, settings = client)
2445
if not tcp_server.clients:
2446
logger.warning("No clients defined")
2452
pidfile.write(str(pid) + "\n".encode("utf-8"))
2455
logger.error("Could not write to file %r with PID %d",
2458
# "pidfile" was never created
2461
signal.signal(signal.SIGINT, signal.SIG_IGN)
2463
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2464
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2467
@alternate_dbus_interfaces({"se.recompile.Mandos":
2468
"se.bsnet.fukt.Mandos"})
2469
class MandosDBusService(DBusObjectWithProperties):
2470
"""A D-Bus proxy object"""
2472
dbus.service.Object.__init__(self, bus, "/")
2473
_interface = "se.recompile.Mandos"
2475
@dbus_interface_annotations(_interface)
2477
return { "org.freedesktop.DBus.Property"
2478
".EmitsChangedSignal":
2481
@dbus.service.signal(_interface, signature="o")
2482
def ClientAdded(self, objpath):
2486
@dbus.service.signal(_interface, signature="ss")
2487
def ClientNotFound(self, fingerprint, address):
2491
@dbus.service.signal(_interface, signature="os")
2492
def ClientRemoved(self, objpath, name):
2496
@dbus.service.method(_interface, out_signature="ao")
2497
def GetAllClients(self):
2499
return dbus.Array(c.dbus_object_path
2501
tcp_server.clients.itervalues())
2503
@dbus.service.method(_interface,
2504
out_signature="a{oa{sv}}")
2505
def GetAllClientsWithProperties(self):
2507
return dbus.Dictionary(
2508
((c.dbus_object_path, c.GetAll(""))
2509
for c in tcp_server.clients.itervalues()),
2512
@dbus.service.method(_interface, in_signature="o")
2513
def RemoveClient(self, object_path):
2515
for c in tcp_server.clients.itervalues():
2516
if c.dbus_object_path == object_path:
2517
del tcp_server.clients[c.name]
2518
c.remove_from_connection()
2519
# Don't signal anything except ClientRemoved
2520
c.disable(quiet=True)
2522
self.ClientRemoved(object_path, c.name)
2524
raise KeyError(object_path)
2528
mandos_dbus_service = MandosDBusService()
864
2531
"Cleanup function; run on exit"
866
# From the Avahi example code
867
if not group is None:
870
# End of Avahi example code
873
client = clients.pop()
874
client.stop_hook = None
2534
multiprocessing.active_children()
2535
if not (tcp_server.clients or client_settings):
2538
# Store client before exiting. Secrets are encrypted with key
2539
# based on what config file has. If config file is
2540
# removed/edited, old secret will thus be unrecovable.
2542
with PGPEngine() as pgp:
2543
for client in tcp_server.clients.itervalues():
2544
key = client_settings[client.name]["secret"]
2545
client.encrypted_secret = pgp.encrypt(client.secret,
2549
# A list of attributes that can not be pickled
2551
exclude = set(("bus", "changedstate", "secret",
2553
for name, typ in (inspect.getmembers
2554
(dbus.service.Object)):
2557
client_dict["encrypted_secret"] = (client
2559
for attr in client.client_structure:
2560
if attr not in exclude:
2561
client_dict[attr] = getattr(client, attr)
2563
clients[client.name] = client_dict
2564
del client_settings[client.name]["secret"]
2567
tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2570
(stored_state_path))
2571
with os.fdopen(tempfd, "wb") as stored_state:
2572
pickle.dump((clients, client_settings), stored_state)
2573
os.rename(tempname, stored_state_path)
2574
except (IOError, OSError) as e:
2580
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2581
logger.warning("Could not save persistent state: {0}"
2582
.format(os.strerror(e.errno)))
2584
logger.warning("Could not save persistent state:",
2588
# Delete all clients, and settings from config
2589
while tcp_server.clients:
2590
name, client = tcp_server.clients.popitem()
2592
client.remove_from_connection()
2593
# Don't signal anything except ClientRemoved
2594
client.disable(quiet=True)
2597
mandos_dbus_service.ClientRemoved(client
2600
client_settings.clear()
877
2602
atexit.register(cleanup)
880
signal.signal(signal.SIGINT, signal.SIG_IGN)
881
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
882
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
884
for client in clients:
2604
for client in tcp_server.clients.itervalues():
2607
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2608
# Need to initiate checking of clients
2610
client.init_checker()
887
2612
tcp_server.enable()
888
2613
tcp_server.server_activate()
890
2615
# Find out what port we got
891
2616
service.port = tcp_server.socket.getsockname()[1]
892
logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
893
u" scope_id %d" % tcp_server.socket.getsockname())
2618
logger.info("Now listening on address %r, port %d,"
2619
" flowinfo %d, scope_id %d",
2620
*tcp_server.socket.getsockname())
2622
logger.info("Now listening on address %r, port %d",
2623
*tcp_server.socket.getsockname())
895
2625
#service.interface = tcp_server.socket.getsockname()[3]
898
2628
# From the Avahi example code
899
server.connect_to_signal("StateChanged", server_state_changed)
901
server_state_changed(server.GetState())
902
except dbus.exceptions.DBusException, error:
903
logger.critical(u"DBusException: %s", error)
2631
except dbus.exceptions.DBusException as error:
2632
logger.critical("D-Bus Exception", exc_info=error)
905
2635
# End of Avahi example code
907
2637
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
908
2638
lambda *args, **kwargs:
909
tcp_server.handle_request\
910
(*args[2:], **kwargs) or True)
2639
(tcp_server.handle_request
2640
(*args[2:], **kwargs) or True))
912
logger.debug(u"Starting main loop")
913
main_loop_started = True
2642
logger.debug("Starting main loop")
915
except AvahiError, error:
916
logger.critical(u"AvahiError: %s" + unicode(error))
2644
except AvahiError as error:
2645
logger.critical("Avahi Error", exc_info=error)
918
2648
except KeyboardInterrupt:
2650
print("", file=sys.stderr)
2651
logger.debug("Server received KeyboardInterrupt")
2652
logger.debug("Server exiting")
2653
# Must run before the D-Bus bus name gets deregistered
922
2656
if __name__ == '__main__':