99
265
max_renames: integer; maximum number of renames
100
266
rename_count: integer; counter so we only rename after collisions
101
267
a sensible number of times
268
group: D-Bus Entry Group
270
bus: dbus.SystemBus()
103
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
104
type = None, port = None, TXT = None, domain = "",
105
host = "", max_renames = 32768):
274
interface = avahi.IF_UNSPEC,
282
protocol = avahi.PROTO_UNSPEC,
106
284
self.interface = interface
286
self.type = servicetype
288
self.TXT = TXT if TXT is not None else []
114
289
self.domain = domain
116
291
self.rename_count = 0
292
self.max_renames = max_renames
293
self.protocol = protocol
294
self.group = None # our entry group
297
self.entry_group_state_changed_match = None
299
def rename(self, remove=True):
118
300
"""Derived from the Avahi example code"""
119
301
if self.rename_count >= self.max_renames:
120
logger.critical(u"No suitable service name found after %i"
121
u" retries, exiting.", rename_count)
302
logger.critical("No suitable Zeroconf service name found"
303
" after %i retries, exiting.",
122
305
raise AvahiServiceError("Too many renames")
123
name = server.GetAlternativeServiceName(name)
124
logger.error(u"Changing name to %r ...", name)
125
syslogger.setFormatter(logging.Formatter\
126
('Mandos (%s): %%(levelname)s:'
127
' %%(message)s' % name))
307
self.server.GetAlternativeServiceName(self.name))
130
308
self.rename_count += 1
309
logger.info("Changing Zeroconf service name to %r ...",
315
except dbus.exceptions.DBusException as error:
316
if (error.get_dbus_name()
317
== "org.freedesktop.Avahi.CollisionError"):
318
logger.info("Local Zeroconf service name collision.")
319
return self.rename(remove=False)
321
logger.critical("D-Bus Exception", exc_info=error)
131
325
def remove(self):
132
326
"""Derived from the Avahi example code"""
133
if group is not None:
327
if self.entry_group_state_changed_match is not None:
328
self.entry_group_state_changed_match.remove()
329
self.entry_group_state_changed_match = None
330
if self.group is not None:
136
334
"""Derived from the Avahi example code"""
139
group = dbus.Interface\
140
(bus.get_object(avahi.DBUS_NAME,
141
server.EntryGroupNew()),
142
avahi.DBUS_INTERFACE_ENTRY_GROUP)
143
group.connect_to_signal('StateChanged',
144
entry_group_state_changed)
145
logger.debug(u"Adding service '%s' of type '%s' ...",
146
service.name, service.type)
148
self.interface, # interface
149
avahi.PROTO_INET6, # protocol
150
dbus.UInt32(0), # flags
151
self.name, self.type,
152
self.domain, self.host,
153
dbus.UInt16(self.port),
154
avahi.string_array_to_txt_array(self.TXT))
157
# From the Avahi example code:
158
group = None # our entry group
159
# End of Avahi example code
336
if self.group is None:
337
self.group = dbus.Interface(
338
self.bus.get_object(avahi.DBUS_NAME,
339
self.server.EntryGroupNew()),
340
avahi.DBUS_INTERFACE_ENTRY_GROUP)
341
self.entry_group_state_changed_match = (
342
self.group.connect_to_signal(
343
'StateChanged', self.entry_group_state_changed))
344
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
345
self.name, self.type)
346
self.group.AddService(
349
dbus.UInt32(0), # flags
350
self.name, self.type,
351
self.domain, self.host,
352
dbus.UInt16(self.port),
353
avahi.string_array_to_txt_array(self.TXT))
356
def entry_group_state_changed(self, state, error):
357
"""Derived from the Avahi example code"""
358
logger.debug("Avahi entry group state change: %i", state)
360
if state == avahi.ENTRY_GROUP_ESTABLISHED:
361
logger.debug("Zeroconf service established.")
362
elif state == avahi.ENTRY_GROUP_COLLISION:
363
logger.info("Zeroconf service name collision.")
365
elif state == avahi.ENTRY_GROUP_FAILURE:
366
logger.critical("Avahi: Error in group state changed %s",
368
raise AvahiGroupError("State changed: {!s}".format(error))
371
"""Derived from the Avahi example code"""
372
if self.group is not None:
375
except (dbus.exceptions.UnknownMethodException,
376
dbus.exceptions.DBusException):
381
def server_state_changed(self, state, error=None):
382
"""Derived from the Avahi example code"""
383
logger.debug("Avahi server state change: %i", state)
385
avahi.SERVER_INVALID: "Zeroconf server invalid",
386
avahi.SERVER_REGISTERING: None,
387
avahi.SERVER_COLLISION: "Zeroconf server name collision",
388
avahi.SERVER_FAILURE: "Zeroconf server failure",
390
if state in bad_states:
391
if bad_states[state] is not None:
393
logger.error(bad_states[state])
395
logger.error(bad_states[state] + ": %r", error)
397
elif state == avahi.SERVER_RUNNING:
400
except dbus.exceptions.DBusException as error:
401
if (error.get_dbus_name()
402
== "org.freedesktop.Avahi.CollisionError"):
403
logger.info("Local Zeroconf service name"
405
return self.rename(remove=False)
407
logger.critical("D-Bus Exception", exc_info=error)
412
logger.debug("Unknown state: %r", state)
414
logger.debug("Unknown state: %r: %r", state, error)
417
"""Derived from the Avahi example code"""
418
if self.server is None:
419
self.server = dbus.Interface(
420
self.bus.get_object(avahi.DBUS_NAME,
421
avahi.DBUS_PATH_SERVER,
422
follow_name_owner_changes=True),
423
avahi.DBUS_INTERFACE_SERVER)
424
self.server.connect_to_signal("StateChanged",
425
self.server_state_changed)
426
self.server_state_changed(self.server.GetState())
429
class AvahiServiceToSyslog(AvahiService):
430
def rename(self, *args, **kwargs):
431
"""Add the new name to the syslog messages"""
432
ret = AvahiService.rename(self, *args, **kwargs)
433
syslogger.setFormatter(logging.Formatter(
434
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
438
def call_pipe(connection, # : multiprocessing.Connection
439
func, *args, **kwargs):
440
"""This function is meant to be called by multiprocessing.Process
442
This function runs func(*args, **kwargs), and writes the resulting
443
return value on the provided multiprocessing.Connection.
445
connection.send(func(*args, **kwargs))
162
448
class Client(object):
163
449
"""A representation of a client host served by this server.
165
name: string; from the config file, used in log messages
452
approved: bool(); 'None' if not yet approved/disapproved
453
approval_delay: datetime.timedelta(); Time to wait for approval
454
approval_duration: datetime.timedelta(); Duration of one approval
455
checker: subprocess.Popen(); a running checker process used
456
to see if the client lives.
457
'None' if no process is running.
458
checker_callback_tag: a gobject event source tag, or None
459
checker_command: string; External command which is run to check
460
if client lives. %() expansions are done at
461
runtime with vars(self) as dict, so that for
462
instance %(name)s can be used in the command.
463
checker_initiator_tag: a gobject event source tag, or None
464
created: datetime.datetime(); (UTC) object creation
465
client_structure: Object describing what attributes a client has
466
and is used for storing the client at exit
467
current_checker_command: string; current running checker_command
468
disable_initiator_tag: a gobject event source tag, or None
166
470
fingerprint: string (40 or 32 hexadecimal digits); used to
167
471
uniquely identify the client
168
secret: bytestring; sent verbatim (over TLS) to client
169
host: string; available for use by the checker command
170
created: datetime.datetime(); object creation, not client host
171
last_checked_ok: datetime.datetime() or None if not yet checked OK
172
timeout: datetime.timedelta(); How long from last_checked_ok
173
until this client is invalid
174
interval: datetime.timedelta(); How often to start a new checker
175
stop_hook: If set, called by stop() as stop_hook(self)
176
checker: subprocess.Popen(); a running checker process used
177
to see if the client lives.
178
'None' if no process is running.
179
checker_initiator_tag: a gobject event source tag, or None
180
stop_initiator_tag: - '' -
181
checker_callback_tag: - '' -
182
checker_command: string; External command which is run to check if
183
client lives. %() expansions are done at
184
runtime with vars(self) as dict, so that for
185
instance %(name)s can be used in the command.
187
_timeout: Real variable for 'timeout'
188
_interval: Real variable for 'interval'
189
_timeout_milliseconds: Used when calling gobject.timeout_add()
190
_interval_milliseconds: - '' -
472
host: string; available for use by the checker command
473
interval: datetime.timedelta(); How often to start a new checker
474
last_approval_request: datetime.datetime(); (UTC) or None
475
last_checked_ok: datetime.datetime(); (UTC) or None
476
last_checker_status: integer between 0 and 255 reflecting exit
477
status of last checker. -1 reflects crashed
478
checker, -2 means no checker completed yet.
479
last_checker_signal: The signal which killed the last checker, if
480
last_checker_status is -1
481
last_enabled: datetime.datetime(); (UTC) or None
482
name: string; from the config file, used in log messages and
484
secret: bytestring; sent verbatim (over TLS) to client
485
timeout: datetime.timedelta(); How long from last_checked_ok
486
until this client is disabled
487
extended_timeout: extra long timeout when secret has been sent
488
runtime_expansions: Allowed attributes for runtime expansion.
489
expires: datetime.datetime(); time (UTC) when a client will be
491
server_settings: The server_settings dict from main()
192
def _set_timeout(self, timeout):
193
"Setter function for 'timeout' attribute"
194
self._timeout = timeout
195
self._timeout_milliseconds = ((self.timeout.days
196
* 24 * 60 * 60 * 1000)
197
+ (self.timeout.seconds * 1000)
198
+ (self.timeout.microseconds
200
timeout = property(lambda self: self._timeout,
203
def _set_interval(self, interval):
204
"Setter function for 'interval' attribute"
205
self._interval = interval
206
self._interval_milliseconds = ((self.interval.days
207
* 24 * 60 * 60 * 1000)
208
+ (self.interval.seconds
210
+ (self.interval.microseconds
212
interval = property(lambda self: self._interval,
215
def __init__(self, name = None, stop_hook=None, config={}):
216
"""Note: the 'checker' key in 'config' sets the
217
'checker_command' attribute and *not* the 'checker'
494
runtime_expansions = ("approval_delay", "approval_duration",
495
"created", "enabled", "expires",
496
"fingerprint", "host", "interval",
497
"last_approval_request", "last_checked_ok",
498
"last_enabled", "name", "timeout")
501
"extended_timeout": "PT15M",
503
"checker": "fping -q -- %%(host)s",
505
"approval_delay": "PT0S",
506
"approval_duration": "PT1S",
507
"approved_by_default": "True",
512
def config_parser(config):
513
"""Construct a new dict of client settings of this form:
514
{ client_name: {setting_name: value, ...}, ...}
515
with exceptions for any special settings as defined above.
516
NOTE: Must be a pure function. Must return the same result
517
value given the same arguments.
520
for client_name in config.sections():
521
section = dict(config.items(client_name))
522
client = settings[client_name] = {}
524
client["host"] = section["host"]
525
# Reformat values from string types to Python types
526
client["approved_by_default"] = config.getboolean(
527
client_name, "approved_by_default")
528
client["enabled"] = config.getboolean(client_name,
531
# Uppercase and remove spaces from fingerprint for later
532
# comparison purposes with return value from the
533
# fingerprint() function
534
client["fingerprint"] = (section["fingerprint"].upper()
536
if "secret" in section:
537
client["secret"] = section["secret"].decode("base64")
538
elif "secfile" in section:
539
with open(os.path.expanduser(os.path.expandvars
540
(section["secfile"])),
542
client["secret"] = secfile.read()
544
raise TypeError("No secret or secfile for section {}"
546
client["timeout"] = string_to_delta(section["timeout"])
547
client["extended_timeout"] = string_to_delta(
548
section["extended_timeout"])
549
client["interval"] = string_to_delta(section["interval"])
550
client["approval_delay"] = string_to_delta(
551
section["approval_delay"])
552
client["approval_duration"] = string_to_delta(
553
section["approval_duration"])
554
client["checker_command"] = section["checker"]
555
client["last_approval_request"] = None
556
client["last_checked_ok"] = None
557
client["last_checker_status"] = -2
561
def __init__(self, settings, name = None, server_settings=None):
220
logger.debug(u"Creating client %r", self.name)
221
# Uppercase and remove spaces from fingerprint for later
222
# comparison purposes with return value from the fingerprint()
224
self.fingerprint = config["fingerprint"].upper()\
226
logger.debug(u" Fingerprint: %s", self.fingerprint)
227
if "secret" in config:
228
self.secret = config["secret"].decode(u"base64")
229
elif "secfile" in config:
230
sf = open(config["secfile"])
231
self.secret = sf.read()
563
if server_settings is None:
565
self.server_settings = server_settings
566
# adding all client settings
567
for setting, value in settings.items():
568
setattr(self, setting, value)
571
if not hasattr(self, "last_enabled"):
572
self.last_enabled = datetime.datetime.utcnow()
573
if not hasattr(self, "expires"):
574
self.expires = (datetime.datetime.utcnow()
234
raise TypeError(u"No secret or secfile for client %s"
236
self.host = config.get("host", "")
237
self.created = datetime.datetime.now()
238
self.last_checked_ok = None
239
self.timeout = string_to_delta(config["timeout"])
240
self.interval = string_to_delta(config["interval"])
241
self.stop_hook = stop_hook
577
self.last_enabled = None
580
logger.debug("Creating client %r", self.name)
581
logger.debug(" Fingerprint: %s", self.fingerprint)
582
self.created = settings.get("created",
583
datetime.datetime.utcnow())
585
# attributes specific for this server instance
242
586
self.checker = None
243
587
self.checker_initiator_tag = None
244
self.stop_initiator_tag = None
588
self.disable_initiator_tag = None
245
589
self.checker_callback_tag = None
246
self.check_command = config["checker"]
590
self.current_checker_command = None
592
self.approvals_pending = 0
593
self.changedstate = multiprocessing_manager.Condition(
594
multiprocessing_manager.Lock())
595
self.client_structure = [attr
596
for attr in self.__dict__.iterkeys()
597
if not attr.startswith("_")]
598
self.client_structure.append("client_structure")
600
for name, t in inspect.getmembers(
601
type(self), lambda obj: isinstance(obj, property)):
602
if not name.startswith("_"):
603
self.client_structure.append(name)
605
# Send notice to process children that client state has changed
606
def send_changedstate(self):
607
with self.changedstate:
608
self.changedstate.notify_all()
248
611
"""Start this client's checker and timeout hooks"""
612
if getattr(self, "enabled", False):
615
self.expires = datetime.datetime.utcnow() + self.timeout
617
self.last_enabled = datetime.datetime.utcnow()
619
self.send_changedstate()
621
def disable(self, quiet=True):
622
"""Disable this client."""
623
if not getattr(self, "enabled", False):
626
logger.info("Disabling client %s", self.name)
627
if getattr(self, "disable_initiator_tag", None) is not None:
628
gobject.source_remove(self.disable_initiator_tag)
629
self.disable_initiator_tag = None
631
if getattr(self, "checker_initiator_tag", None) is not None:
632
gobject.source_remove(self.checker_initiator_tag)
633
self.checker_initiator_tag = None
637
self.send_changedstate()
638
# Do not run this again if called by a gobject.timeout_add
644
def init_checker(self):
249
645
# Schedule a new checker to be started an 'interval' from now,
250
646
# and every interval from then on.
251
self.checker_initiator_tag = gobject.timeout_add\
252
(self._interval_milliseconds,
647
if self.checker_initiator_tag is not None:
648
gobject.source_remove(self.checker_initiator_tag)
649
self.checker_initiator_tag = gobject.timeout_add(
650
int(self.interval.total_seconds() * 1000),
652
# Schedule a disable() when 'timeout' has passed
653
if self.disable_initiator_tag is not None:
654
gobject.source_remove(self.disable_initiator_tag)
655
self.disable_initiator_tag = gobject.timeout_add(
656
int(self.timeout.total_seconds() * 1000), self.disable)
254
657
# Also start a new checker *right now*.
255
658
self.start_checker()
256
# Schedule a stop() when 'timeout' has passed
257
self.stop_initiator_tag = gobject.timeout_add\
258
(self._timeout_milliseconds,
262
The possibility that a client might be restarted is left open,
263
but not currently used."""
264
# If this client doesn't have a secret, it is already stopped.
265
if hasattr(self, "secret") and self.secret:
266
logger.info(u"Stopping client %s", self.name)
270
if getattr(self, "stop_initiator_tag", False):
271
gobject.source_remove(self.stop_initiator_tag)
272
self.stop_initiator_tag = None
273
if getattr(self, "checker_initiator_tag", False):
274
gobject.source_remove(self.checker_initiator_tag)
275
self.checker_initiator_tag = None
279
# Do not run this again if called by a gobject.timeout_add
282
self.stop_hook = None
284
def checker_callback(self, pid, condition):
660
def checker_callback(self, source, condition, connection,
285
662
"""The checker has completed, so take appropriate actions."""
286
now = datetime.datetime.now()
287
663
self.checker_callback_tag = None
288
664
self.checker = None
289
if os.WIFEXITED(condition) \
290
and (os.WEXITSTATUS(condition) == 0):
291
logger.info(u"Checker for %(name)s succeeded",
293
self.last_checked_ok = now
294
gobject.source_remove(self.stop_initiator_tag)
295
self.stop_initiator_tag = gobject.timeout_add\
296
(self._timeout_milliseconds,
298
elif not os.WIFEXITED(condition):
299
logger.warning(u"Checker for %(name)s crashed?",
665
# Read return code from connection (see call_pipe)
666
returncode = connection.recv()
670
self.last_checker_status = returncode
671
self.last_checker_signal = None
672
if self.last_checker_status == 0:
673
logger.info("Checker for %(name)s succeeded",
677
logger.info("Checker for %(name)s failed", vars(self))
679
self.last_checker_status = -1
680
self.last_checker_signal = -returncode
681
logger.warning("Checker for %(name)s crashed?",
302
logger.info(u"Checker for %(name)s failed",
685
def checked_ok(self):
686
"""Assert that the client has been seen, alive and well."""
687
self.last_checked_ok = datetime.datetime.utcnow()
688
self.last_checker_status = 0
689
self.last_checker_signal = None
692
def bump_timeout(self, timeout=None):
693
"""Bump up the timeout for this client."""
695
timeout = self.timeout
696
if self.disable_initiator_tag is not None:
697
gobject.source_remove(self.disable_initiator_tag)
698
self.disable_initiator_tag = None
699
if getattr(self, "enabled", False):
700
self.disable_initiator_tag = gobject.timeout_add(
701
int(timeout.total_seconds() * 1000), self.disable)
702
self.expires = datetime.datetime.utcnow() + timeout
704
def need_approval(self):
705
self.last_approval_request = datetime.datetime.utcnow()
304
707
def start_checker(self):
305
708
"""Start a new checker subprocess if one is not running.
306
710
If a checker already exists, leave it running and do
308
712
# The reason for not killing a running checker is that if we
309
# did that, then if a checker (for some reason) started
310
# running slowly and taking more than 'interval' time, the
311
# client would inevitably timeout, since no checker would get
312
# a chance to run to completion. If we instead leave running
713
# did that, and if a checker (for some reason) started running
714
# slowly and taking more than 'interval' time, then the client
715
# would inevitably timeout, since no checker would get a
716
# chance to run to completion. If we instead leave running
313
717
# checkers alone, the checker would have to take more time
314
# than 'timeout' for the client to be declared invalid, which
315
# is as it should be.
718
# than 'timeout' for the client to be disabled, which is as it
721
if self.checker is not None and not self.checker.is_alive():
722
logger.warning("Checker was not alive; joining")
725
# Start a new checker if needed
316
726
if self.checker is None:
318
# In case check_command has exactly one % operator
319
command = self.check_command % self.host
321
# Escape attributes for the shell
322
escaped_attrs = dict((key, re.escape(str(val)))
324
vars(self).iteritems())
326
command = self.check_command % escaped_attrs
327
except TypeError, error:
328
logger.error(u'Could not format string "%s":'
329
u' %s', self.check_command, error)
330
return True # Try again later
332
logger.info(u"Starting checker %r for %s",
334
self.checker = subprocess.Popen(command,
337
self.checker_callback_tag = gobject.child_watch_add\
339
self.checker_callback)
340
except subprocess.OSError, error:
341
logger.error(u"Failed to start subprocess: %s",
727
# Escape attributes for the shell
729
attr: re.escape(str(getattr(self, attr)))
730
for attr in self.runtime_expansions }
732
command = self.checker_command % escaped_attrs
733
except TypeError as error:
734
logger.error('Could not format string "%s"',
735
self.checker_command,
737
return True # Try again later
738
self.current_checker_command = command
739
logger.info("Starting checker %r for %s", command,
741
# We don't need to redirect stdout and stderr, since
742
# in normal mode, that is already done by daemon(),
743
# and in debug mode we don't want to. (Stdin is
744
# always replaced by /dev/null.)
745
# The exception is when not debugging but nevertheless
746
# running in the foreground; use the previously
748
popen_args = { "close_fds": True,
751
if (not self.server_settings["debug"]
752
and self.server_settings["foreground"]):
753
popen_args.update({"stdout": wnull,
755
pipe = multiprocessing.Pipe(duplex = False)
756
self.checker = multiprocessing.Process(
758
args = (pipe[1], subprocess.call, command),
761
self.checker_callback_tag = gobject.io_add_watch(
762
pipe[0].fileno(), gobject.IO_IN,
763
self.checker_callback, pipe[0], command)
343
764
# Re-run this periodically if run by gobject.timeout_add
345
767
def stop_checker(self):
346
768
"""Force the checker process, if any, to stop."""
347
769
if self.checker_callback_tag:
349
771
self.checker_callback_tag = None
350
772
if getattr(self, "checker", None) is None:
352
logger.debug(u"Stopping checker for %(name)s", vars(self))
354
os.kill(self.checker.pid, signal.SIGTERM)
356
#if self.checker.poll() is None:
357
# os.kill(self.checker.pid, signal.SIGKILL)
358
except OSError, error:
359
if error.errno != errno.ESRCH: # No such process
774
logger.debug("Stopping checker for %(name)s", vars(self))
775
self.checker.terminate()
361
776
self.checker = None
362
def still_valid(self):
363
"""Has the timeout not yet passed for this client?"""
364
now = datetime.datetime.now()
365
if self.last_checked_ok is None:
366
return now < (self.created + self.timeout)
368
return now < (self.last_checked_ok + self.timeout)
371
def peer_certificate(session):
372
"Return the peer's OpenPGP certificate as a bytestring"
373
# If not an OpenPGP certificate...
374
if gnutls.library.functions.gnutls_certificate_type_get\
375
(session._c_object) \
376
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP:
377
# ...do the normal thing
378
return session.peer_certificate
379
list_size = ctypes.c_uint()
380
cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
381
(session._c_object, ctypes.byref(list_size))
382
if list_size.value == 0:
385
return ctypes.string_at(cert.data, cert.size)
388
def fingerprint(openpgp):
389
"Convert an OpenPGP bytestring to a hexdigit fingerprint string"
390
# New GnuTLS "datum" with the OpenPGP public key
391
datum = gnutls.library.types.gnutls_datum_t\
392
(ctypes.cast(ctypes.c_char_p(openpgp),
393
ctypes.POINTER(ctypes.c_ubyte)),
394
ctypes.c_uint(len(openpgp)))
395
# New empty GnuTLS certificate
396
crt = gnutls.library.types.gnutls_openpgp_crt_t()
397
gnutls.library.functions.gnutls_openpgp_crt_init\
399
# Import the OpenPGP public key into the certificate
400
gnutls.library.functions.gnutls_openpgp_crt_import\
401
(crt, ctypes.byref(datum),
402
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
403
# New buffer for the fingerprint
404
buffer = ctypes.create_string_buffer(20)
405
buffer_length = ctypes.c_size_t()
406
# Get the fingerprint from the certificate into the buffer
407
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
408
(crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
409
# Deinit the certificate
410
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
411
# Convert the buffer to a Python bytestring
412
fpr = ctypes.string_at(buffer, buffer_length.value)
413
# Convert the bytestring to hexadecimal notation
414
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
418
class tcp_handler(SocketServer.BaseRequestHandler, object):
419
"""A TCP request handler class.
420
Instantiated by IPv6_TCPServer for each request to handle it.
779
def dbus_service_property(dbus_interface,
783
"""Decorators for marking methods of a DBusObjectWithProperties to
784
become properties on the D-Bus.
786
The decorated method will be called with no arguments by "Get"
787
and with one argument by "Set".
789
The parameters, where they are supported, are the same as
790
dbus.service.method, except there is only "signature", since the
791
type from Get() and the type sent to Set() is the same.
793
# Encoding deeply encoded byte arrays is not supported yet by the
794
# "Set" method, so we fail early here:
795
if byte_arrays and signature != "ay":
796
raise ValueError("Byte arrays not supported for non-'ay'"
797
" signature {!r}".format(signature))
800
func._dbus_is_property = True
801
func._dbus_interface = dbus_interface
802
func._dbus_signature = signature
803
func._dbus_access = access
804
func._dbus_name = func.__name__
805
if func._dbus_name.endswith("_dbus_property"):
806
func._dbus_name = func._dbus_name[:-14]
807
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
813
def dbus_interface_annotations(dbus_interface):
814
"""Decorator for marking functions returning interface annotations
818
@dbus_interface_annotations("org.example.Interface")
819
def _foo(self): # Function name does not matter
820
return {"org.freedesktop.DBus.Deprecated": "true",
821
"org.freedesktop.DBus.Property.EmitsChangedSignal":
826
func._dbus_is_interface = True
827
func._dbus_interface = dbus_interface
828
func._dbus_name = dbus_interface
834
def dbus_annotations(annotations):
835
"""Decorator to annotate D-Bus methods, signals or properties
838
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
839
"org.freedesktop.DBus.Property."
840
"EmitsChangedSignal": "false"})
841
@dbus_service_property("org.example.Interface", signature="b",
843
def Property_dbus_property(self):
844
return dbus.Boolean(False)
848
func._dbus_annotations = annotations
854
class DBusPropertyException(dbus.exceptions.DBusException):
855
"""A base class for D-Bus property-related exceptions
860
class DBusPropertyAccessException(DBusPropertyException):
861
"""A property's access permissions disallows an operation.
866
class DBusPropertyNotFound(DBusPropertyException):
867
"""An attempt was made to access a non-existing property.
872
class DBusObjectWithProperties(dbus.service.Object):
873
"""A D-Bus object with properties.
875
Classes inheriting from this can use the dbus_service_property
876
decorator to expose methods as D-Bus properties. It exposes the
877
standard Get(), Set(), and GetAll() methods on the D-Bus.
881
def _is_dbus_thing(thing):
882
"""Returns a function testing if an attribute is a D-Bus thing
884
If called like _is_dbus_thing("method") it returns a function
885
suitable for use as predicate to inspect.getmembers().
887
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
890
def _get_all_dbus_things(self, thing):
891
"""Returns a generator of (name, attribute) pairs
893
return ((getattr(athing.__get__(self), "_dbus_name", name),
894
athing.__get__(self))
895
for cls in self.__class__.__mro__
897
inspect.getmembers(cls, self._is_dbus_thing(thing)))
899
def _get_dbus_property(self, interface_name, property_name):
900
"""Returns a bound method if one exists which is a D-Bus
901
property with the specified name and interface.
903
for cls in self.__class__.__mro__:
904
for name, value in inspect.getmembers(
905
cls, self._is_dbus_thing("property")):
906
if (value._dbus_name == property_name
907
and value._dbus_interface == interface_name):
908
return value.__get__(self)
911
raise DBusPropertyNotFound("{}:{}.{}".format(
912
self.dbus_object_path, interface_name, property_name))
914
@dbus.service.method(dbus.PROPERTIES_IFACE,
917
def Get(self, interface_name, property_name):
918
"""Standard D-Bus property Get() method, see D-Bus standard.
920
prop = self._get_dbus_property(interface_name, property_name)
921
if prop._dbus_access == "write":
922
raise DBusPropertyAccessException(property_name)
924
if not hasattr(value, "variant_level"):
926
return type(value)(value, variant_level=value.variant_level+1)
928
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
929
def Set(self, interface_name, property_name, value):
930
"""Standard D-Bus property Set() method, see D-Bus standard.
932
prop = self._get_dbus_property(interface_name, property_name)
933
if prop._dbus_access == "read":
934
raise DBusPropertyAccessException(property_name)
935
if prop._dbus_get_args_options["byte_arrays"]:
936
# The byte_arrays option is not supported yet on
937
# signatures other than "ay".
938
if prop._dbus_signature != "ay":
939
raise ValueError("Byte arrays not supported for non-"
940
"'ay' signature {!r}"
941
.format(prop._dbus_signature))
942
value = dbus.ByteArray(b''.join(chr(byte)
946
@dbus.service.method(dbus.PROPERTIES_IFACE,
948
out_signature="a{sv}")
949
def GetAll(self, interface_name):
950
"""Standard D-Bus property GetAll() method, see D-Bus
953
Note: Will not include properties with access="write".
956
for name, prop in self._get_all_dbus_things("property"):
958
and interface_name != prop._dbus_interface):
959
# Interface non-empty but did not match
961
# Ignore write-only properties
962
if prop._dbus_access == "write":
965
if not hasattr(value, "variant_level"):
966
properties[name] = value
968
properties[name] = type(value)(
969
value, variant_level = value.variant_level + 1)
970
return dbus.Dictionary(properties, signature="sv")
972
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
973
def PropertiesChanged(self, interface_name, changed_properties,
974
invalidated_properties):
975
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
980
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
982
path_keyword='object_path',
983
connection_keyword='connection')
984
def Introspect(self, object_path, connection):
985
"""Overloading of standard D-Bus method.
987
Inserts property tags and interface annotation tags.
989
xmlstring = dbus.service.Object.Introspect(self, object_path,
992
document = xml.dom.minidom.parseString(xmlstring)
994
def make_tag(document, name, prop):
995
e = document.createElement("property")
996
e.setAttribute("name", name)
997
e.setAttribute("type", prop._dbus_signature)
998
e.setAttribute("access", prop._dbus_access)
1001
for if_tag in document.getElementsByTagName("interface"):
1003
for tag in (make_tag(document, name, prop)
1005
in self._get_all_dbus_things("property")
1006
if prop._dbus_interface
1007
== if_tag.getAttribute("name")):
1008
if_tag.appendChild(tag)
1009
# Add annotation tags
1010
for typ in ("method", "signal", "property"):
1011
for tag in if_tag.getElementsByTagName(typ):
1013
for name, prop in (self.
1014
_get_all_dbus_things(typ)):
1015
if (name == tag.getAttribute("name")
1016
and prop._dbus_interface
1017
== if_tag.getAttribute("name")):
1018
annots.update(getattr(
1019
prop, "_dbus_annotations", {}))
1020
for name, value in annots.items():
1021
ann_tag = document.createElement(
1023
ann_tag.setAttribute("name", name)
1024
ann_tag.setAttribute("value", value)
1025
tag.appendChild(ann_tag)
1026
# Add interface annotation tags
1027
for annotation, value in dict(
1028
itertools.chain.from_iterable(
1029
annotations().items()
1030
for name, annotations
1031
in self._get_all_dbus_things("interface")
1032
if name == if_tag.getAttribute("name")
1034
ann_tag = document.createElement("annotation")
1035
ann_tag.setAttribute("name", annotation)
1036
ann_tag.setAttribute("value", value)
1037
if_tag.appendChild(ann_tag)
1038
# Add the names to the return values for the
1039
# "org.freedesktop.DBus.Properties" methods
1040
if (if_tag.getAttribute("name")
1041
== "org.freedesktop.DBus.Properties"):
1042
for cn in if_tag.getElementsByTagName("method"):
1043
if cn.getAttribute("name") == "Get":
1044
for arg in cn.getElementsByTagName("arg"):
1045
if (arg.getAttribute("direction")
1047
arg.setAttribute("name", "value")
1048
elif cn.getAttribute("name") == "GetAll":
1049
for arg in cn.getElementsByTagName("arg"):
1050
if (arg.getAttribute("direction")
1052
arg.setAttribute("name", "props")
1053
xmlstring = document.toxml("utf-8")
1055
except (AttributeError, xml.dom.DOMException,
1056
xml.parsers.expat.ExpatError) as error:
1057
logger.error("Failed to override Introspection method",
1062
def datetime_to_dbus(dt, variant_level=0):
1063
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1065
return dbus.String("", variant_level = variant_level)
1066
return dbus.String(dt.isoformat(), variant_level=variant_level)
1069
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1070
"""A class decorator; applied to a subclass of
1071
dbus.service.Object, it will add alternate D-Bus attributes with
1072
interface names according to the "alt_interface_names" mapping.
1075
@alternate_dbus_interfaces({"org.example.Interface":
1076
"net.example.AlternateInterface"})
1077
class SampleDBusObject(dbus.service.Object):
1078
@dbus.service.method("org.example.Interface")
1079
def SampleDBusMethod():
1082
The above "SampleDBusMethod" on "SampleDBusObject" will be
1083
reachable via two interfaces: "org.example.Interface" and
1084
"net.example.AlternateInterface", the latter of which will have
1085
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1086
"true", unless "deprecate" is passed with a False value.
1088
This works for methods and signals, and also for D-Bus properties
1089
(from DBusObjectWithProperties) and interfaces (from the
1090
dbus_interface_annotations decorator).
1094
for orig_interface_name, alt_interface_name in (
1095
alt_interface_names.items()):
1097
interface_names = set()
1098
# Go though all attributes of the class
1099
for attrname, attribute in inspect.getmembers(cls):
1100
# Ignore non-D-Bus attributes, and D-Bus attributes
1101
# with the wrong interface name
1102
if (not hasattr(attribute, "_dbus_interface")
1103
or not attribute._dbus_interface.startswith(
1104
orig_interface_name)):
1106
# Create an alternate D-Bus interface name based on
1108
alt_interface = attribute._dbus_interface.replace(
1109
orig_interface_name, alt_interface_name)
1110
interface_names.add(alt_interface)
1111
# Is this a D-Bus signal?
1112
if getattr(attribute, "_dbus_is_signal", False):
1113
if sys.version_info.major == 2:
1114
# Extract the original non-method undecorated
1115
# function by black magic
1116
nonmethod_func = (dict(
1117
zip(attribute.func_code.co_freevars,
1118
attribute.__closure__))
1119
["func"].cell_contents)
1121
nonmethod_func = attribute
1122
# Create a new, but exactly alike, function
1123
# object, and decorate it to be a new D-Bus signal
1124
# with the alternate D-Bus interface name
1125
if sys.version_info.major == 2:
1126
new_function = types.FunctionType(
1127
nonmethod_func.func_code,
1128
nonmethod_func.func_globals,
1129
nonmethod_func.func_name,
1130
nonmethod_func.func_defaults,
1131
nonmethod_func.func_closure)
1133
new_function = types.FunctionType(
1134
nonmethod_func.__code__,
1135
nonmethod_func.__globals__,
1136
nonmethod_func.__name__,
1137
nonmethod_func.__defaults__,
1138
nonmethod_func.__closure__)
1139
new_function = (dbus.service.signal(
1141
attribute._dbus_signature)(new_function))
1142
# Copy annotations, if any
1144
new_function._dbus_annotations = dict(
1145
attribute._dbus_annotations)
1146
except AttributeError:
1148
# Define a creator of a function to call both the
1149
# original and alternate functions, so both the
1150
# original and alternate signals gets sent when
1151
# the function is called
1152
def fixscope(func1, func2):
1153
"""This function is a scope container to pass
1154
func1 and func2 to the "call_both" function
1155
outside of its arguments"""
1157
def call_both(*args, **kwargs):
1158
"""This function will emit two D-Bus
1159
signals by calling func1 and func2"""
1160
func1(*args, **kwargs)
1161
func2(*args, **kwargs)
1164
# Create the "call_both" function and add it to
1166
attr[attrname] = fixscope(attribute, new_function)
1167
# Is this a D-Bus method?
1168
elif getattr(attribute, "_dbus_is_method", False):
1169
# Create a new, but exactly alike, function
1170
# object. Decorate it to be a new D-Bus method
1171
# with the alternate D-Bus interface name. Add it
1174
dbus.service.method(
1176
attribute._dbus_in_signature,
1177
attribute._dbus_out_signature)
1178
(types.FunctionType(attribute.func_code,
1179
attribute.func_globals,
1180
attribute.func_name,
1181
attribute.func_defaults,
1182
attribute.func_closure)))
1183
# Copy annotations, if any
1185
attr[attrname]._dbus_annotations = dict(
1186
attribute._dbus_annotations)
1187
except AttributeError:
1189
# Is this a D-Bus property?
1190
elif getattr(attribute, "_dbus_is_property", False):
1191
# Create a new, but exactly alike, function
1192
# object, and decorate it to be a new D-Bus
1193
# property with the alternate D-Bus interface
1194
# name. Add it to the class.
1195
attr[attrname] = (dbus_service_property(
1196
alt_interface, attribute._dbus_signature,
1197
attribute._dbus_access,
1198
attribute._dbus_get_args_options
1200
(types.FunctionType(
1201
attribute.func_code,
1202
attribute.func_globals,
1203
attribute.func_name,
1204
attribute.func_defaults,
1205
attribute.func_closure)))
1206
# Copy annotations, if any
1208
attr[attrname]._dbus_annotations = dict(
1209
attribute._dbus_annotations)
1210
except AttributeError:
1212
# Is this a D-Bus interface?
1213
elif getattr(attribute, "_dbus_is_interface", False):
1214
# Create a new, but exactly alike, function
1215
# object. Decorate it to be a new D-Bus interface
1216
# with the alternate D-Bus interface name. Add it
1219
dbus_interface_annotations(alt_interface)
1220
(types.FunctionType(attribute.func_code,
1221
attribute.func_globals,
1222
attribute.func_name,
1223
attribute.func_defaults,
1224
attribute.func_closure)))
1226
# Deprecate all alternate interfaces
1227
iname="_AlternateDBusNames_interface_annotation{}"
1228
for interface_name in interface_names:
1230
@dbus_interface_annotations(interface_name)
1232
return { "org.freedesktop.DBus.Deprecated":
1234
# Find an unused name
1235
for aname in (iname.format(i)
1236
for i in itertools.count()):
1237
if aname not in attr:
1241
# Replace the class with a new subclass of it with
1242
# methods, signals, etc. as created above.
1243
cls = type(b"{}Alternate".format(cls.__name__),
1250
@alternate_dbus_interfaces({"se.recompile.Mandos":
1251
"se.bsnet.fukt.Mandos"})
1252
class ClientDBus(Client, DBusObjectWithProperties):
1253
"""A Client class using D-Bus
1256
dbus_object_path: dbus.ObjectPath
1257
bus: dbus.SystemBus()
1260
runtime_expansions = (Client.runtime_expansions
1261
+ ("dbus_object_path", ))
1263
_interface = "se.recompile.Mandos.Client"
1265
# dbus.service.Object doesn't use super(), so we can't either.
1267
def __init__(self, bus = None, *args, **kwargs):
1269
Client.__init__(self, *args, **kwargs)
1270
# Only now, when this client is initialized, can it show up on
1272
client_object_name = str(self.name).translate(
1273
{ord("."): ord("_"),
1274
ord("-"): ord("_")})
1275
self.dbus_object_path = dbus.ObjectPath(
1276
"/clients/" + client_object_name)
1277
DBusObjectWithProperties.__init__(self, self.bus,
1278
self.dbus_object_path)
1280
def notifychangeproperty(transform_func, dbus_name,
1281
type_func=lambda x: x,
1283
invalidate_only=False,
1284
_interface=_interface):
1285
""" Modify a variable so that it's a property which announces
1286
its changes to DBus.
1288
transform_fun: Function that takes a value and a variant_level
1289
and transforms it to a D-Bus type.
1290
dbus_name: D-Bus name of the variable
1291
type_func: Function that transform the value before sending it
1292
to the D-Bus. Default: no transform
1293
variant_level: D-Bus variant level. Default: 1
1295
attrname = "_{}".format(dbus_name)
1297
def setter(self, value):
1298
if hasattr(self, "dbus_object_path"):
1299
if (not hasattr(self, attrname) or
1300
type_func(getattr(self, attrname, None))
1301
!= type_func(value)):
1303
self.PropertiesChanged(
1304
_interface, dbus.Dictionary(),
1305
dbus.Array((dbus_name, )))
1307
dbus_value = transform_func(
1309
variant_level = variant_level)
1310
self.PropertyChanged(dbus.String(dbus_name),
1312
self.PropertiesChanged(
1314
dbus.Dictionary({ dbus.String(dbus_name):
1317
setattr(self, attrname, value)
1319
return property(lambda self: getattr(self, attrname), setter)
1321
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1322
approvals_pending = notifychangeproperty(dbus.Boolean,
1325
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1326
last_enabled = notifychangeproperty(datetime_to_dbus,
1328
checker = notifychangeproperty(
1329
dbus.Boolean, "CheckerRunning",
1330
type_func = lambda checker: checker is not None)
1331
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1333
last_checker_status = notifychangeproperty(dbus.Int16,
1334
"LastCheckerStatus")
1335
last_approval_request = notifychangeproperty(
1336
datetime_to_dbus, "LastApprovalRequest")
1337
approved_by_default = notifychangeproperty(dbus.Boolean,
1338
"ApprovedByDefault")
1339
approval_delay = notifychangeproperty(
1340
dbus.UInt64, "ApprovalDelay",
1341
type_func = lambda td: td.total_seconds() * 1000)
1342
approval_duration = notifychangeproperty(
1343
dbus.UInt64, "ApprovalDuration",
1344
type_func = lambda td: td.total_seconds() * 1000)
1345
host = notifychangeproperty(dbus.String, "Host")
1346
timeout = notifychangeproperty(
1347
dbus.UInt64, "Timeout",
1348
type_func = lambda td: td.total_seconds() * 1000)
1349
extended_timeout = notifychangeproperty(
1350
dbus.UInt64, "ExtendedTimeout",
1351
type_func = lambda td: td.total_seconds() * 1000)
1352
interval = notifychangeproperty(
1353
dbus.UInt64, "Interval",
1354
type_func = lambda td: td.total_seconds() * 1000)
1355
checker_command = notifychangeproperty(dbus.String, "Checker")
1356
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1357
invalidate_only=True)
1359
del notifychangeproperty
1361
def __del__(self, *args, **kwargs):
1363
self.remove_from_connection()
1366
if hasattr(DBusObjectWithProperties, "__del__"):
1367
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1368
Client.__del__(self, *args, **kwargs)
1370
def checker_callback(self, source, condition,
1371
connection, command, *args, **kwargs):
1372
ret = Client.checker_callback(self, source, condition,
1373
connection, command, *args,
1375
exitstatus = self.last_checker_status
1378
self.CheckerCompleted(dbus.Int16(exitstatus),
1379
# This is specific to GNU libC
1380
dbus.Int64(exitstatus << 8),
1381
dbus.String(command))
1384
self.CheckerCompleted(dbus.Int16(-1),
1386
# This is specific to GNU libC
1388
| self.last_checker_signal),
1389
dbus.String(command))
1392
def start_checker(self, *args, **kwargs):
1393
old_checker_pid = getattr(self.checker, "pid", None)
1394
r = Client.start_checker(self, *args, **kwargs)
1395
# Only if new checker process was started
1396
if (self.checker is not None
1397
and old_checker_pid != self.checker.pid):
1399
self.CheckerStarted(self.current_checker_command)
1402
def _reset_approved(self):
1403
self.approved = None
1406
def approve(self, value=True):
1407
self.approved = value
1408
gobject.timeout_add(int(self.approval_duration.total_seconds()
1409
* 1000), self._reset_approved)
1410
self.send_changedstate()
1412
## D-Bus methods, signals & properties
1418
# CheckerCompleted - signal
1419
@dbus.service.signal(_interface, signature="nxs")
1420
def CheckerCompleted(self, exitcode, waitstatus, command):
1424
# CheckerStarted - signal
1425
@dbus.service.signal(_interface, signature="s")
1426
def CheckerStarted(self, command):
1430
# PropertyChanged - signal
1431
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1432
@dbus.service.signal(_interface, signature="sv")
1433
def PropertyChanged(self, property, value):
1437
# GotSecret - signal
1438
@dbus.service.signal(_interface)
1439
def GotSecret(self):
1441
Is sent after a successful transfer of secret from the Mandos
1442
server to mandos-client
1447
@dbus.service.signal(_interface, signature="s")
1448
def Rejected(self, reason):
1452
# NeedApproval - signal
1453
@dbus.service.signal(_interface, signature="tb")
1454
def NeedApproval(self, timeout, default):
1456
return self.need_approval()
1461
@dbus.service.method(_interface, in_signature="b")
1462
def Approve(self, value):
1465
# CheckedOK - method
1466
@dbus.service.method(_interface)
1467
def CheckedOK(self):
1471
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1472
@dbus.service.method(_interface)
1477
# StartChecker - method
1478
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1479
@dbus.service.method(_interface)
1480
def StartChecker(self):
1482
self.start_checker()
1485
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1486
@dbus.service.method(_interface)
1491
# StopChecker - method
1492
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1493
@dbus.service.method(_interface)
1494
def StopChecker(self):
1499
# ApprovalPending - property
1500
@dbus_service_property(_interface, signature="b", access="read")
1501
def ApprovalPending_dbus_property(self):
1502
return dbus.Boolean(bool(self.approvals_pending))
1504
# ApprovedByDefault - property
1505
@dbus_service_property(_interface,
1508
def ApprovedByDefault_dbus_property(self, value=None):
1509
if value is None: # get
1510
return dbus.Boolean(self.approved_by_default)
1511
self.approved_by_default = bool(value)
1513
# ApprovalDelay - property
1514
@dbus_service_property(_interface,
1517
def ApprovalDelay_dbus_property(self, value=None):
1518
if value is None: # get
1519
return dbus.UInt64(self.approval_delay.total_seconds()
1521
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1523
# ApprovalDuration - property
1524
@dbus_service_property(_interface,
1527
def ApprovalDuration_dbus_property(self, value=None):
1528
if value is None: # get
1529
return dbus.UInt64(self.approval_duration.total_seconds()
1531
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1535
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1536
@dbus_service_property(_interface, signature="s", access="read")
1537
def Name_dbus_property(self):
1538
return dbus.String(self.name)
1540
# Fingerprint - property
1542
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1543
@dbus_service_property(_interface, signature="s", access="read")
1544
def Fingerprint_dbus_property(self):
1545
return dbus.String(self.fingerprint)
1548
@dbus_service_property(_interface,
1551
def Host_dbus_property(self, value=None):
1552
if value is None: # get
1553
return dbus.String(self.host)
1554
self.host = str(value)
1556
# Created - property
1558
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1559
@dbus_service_property(_interface, signature="s", access="read")
1560
def Created_dbus_property(self):
1561
return datetime_to_dbus(self.created)
1563
# LastEnabled - property
1564
@dbus_service_property(_interface, signature="s", access="read")
1565
def LastEnabled_dbus_property(self):
1566
return datetime_to_dbus(self.last_enabled)
1568
# Enabled - property
1569
@dbus_service_property(_interface,
1572
def Enabled_dbus_property(self, value=None):
1573
if value is None: # get
1574
return dbus.Boolean(self.enabled)
1580
# LastCheckedOK - property
1581
@dbus_service_property(_interface,
1584
def LastCheckedOK_dbus_property(self, value=None):
1585
if value is not None:
1588
return datetime_to_dbus(self.last_checked_ok)
1590
# LastCheckerStatus - property
1591
@dbus_service_property(_interface, signature="n", access="read")
1592
def LastCheckerStatus_dbus_property(self):
1593
return dbus.Int16(self.last_checker_status)
1595
# Expires - property
1596
@dbus_service_property(_interface, signature="s", access="read")
1597
def Expires_dbus_property(self):
1598
return datetime_to_dbus(self.expires)
1600
# LastApprovalRequest - property
1601
@dbus_service_property(_interface, signature="s", access="read")
1602
def LastApprovalRequest_dbus_property(self):
1603
return datetime_to_dbus(self.last_approval_request)
1605
# Timeout - property
1606
@dbus_service_property(_interface,
1609
def Timeout_dbus_property(self, value=None):
1610
if value is None: # get
1611
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1612
old_timeout = self.timeout
1613
self.timeout = datetime.timedelta(0, 0, 0, value)
1614
# Reschedule disabling
1616
now = datetime.datetime.utcnow()
1617
self.expires += self.timeout - old_timeout
1618
if self.expires <= now:
1619
# The timeout has passed
1622
if (getattr(self, "disable_initiator_tag", None)
1625
gobject.source_remove(self.disable_initiator_tag)
1626
self.disable_initiator_tag = gobject.timeout_add(
1627
int((self.expires - now).total_seconds() * 1000),
1630
# ExtendedTimeout - property
1631
@dbus_service_property(_interface,
1634
def ExtendedTimeout_dbus_property(self, value=None):
1635
if value is None: # get
1636
return dbus.UInt64(self.extended_timeout.total_seconds()
1638
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1640
# Interval - property
1641
@dbus_service_property(_interface,
1644
def Interval_dbus_property(self, value=None):
1645
if value is None: # get
1646
return dbus.UInt64(self.interval.total_seconds() * 1000)
1647
self.interval = datetime.timedelta(0, 0, 0, value)
1648
if getattr(self, "checker_initiator_tag", None) is None:
1651
# Reschedule checker run
1652
gobject.source_remove(self.checker_initiator_tag)
1653
self.checker_initiator_tag = gobject.timeout_add(
1654
value, self.start_checker)
1655
self.start_checker() # Start one now, too
1657
# Checker - property
1658
@dbus_service_property(_interface,
1661
def Checker_dbus_property(self, value=None):
1662
if value is None: # get
1663
return dbus.String(self.checker_command)
1664
self.checker_command = str(value)
1666
# CheckerRunning - property
1667
@dbus_service_property(_interface,
1670
def CheckerRunning_dbus_property(self, value=None):
1671
if value is None: # get
1672
return dbus.Boolean(self.checker is not None)
1674
self.start_checker()
1678
# ObjectPath - property
1680
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
1681
"org.freedesktop.DBus.Deprecated": "true"})
1682
@dbus_service_property(_interface, signature="o", access="read")
1683
def ObjectPath_dbus_property(self):
1684
return self.dbus_object_path # is already a dbus.ObjectPath
1688
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
1690
@dbus_service_property(_interface,
1694
def Secret_dbus_property(self, value):
1695
self.secret = bytes(value)
1700
class ProxyClient(object):
1701
def __init__(self, child_pipe, fpr, address):
1702
self._pipe = child_pipe
1703
self._pipe.send(('init', fpr, address))
1704
if not self._pipe.recv():
1707
def __getattribute__(self, name):
1709
return super(ProxyClient, self).__getattribute__(name)
1710
self._pipe.send(('getattr', name))
1711
data = self._pipe.recv()
1712
if data[0] == 'data':
1714
if data[0] == 'function':
1716
def func(*args, **kwargs):
1717
self._pipe.send(('funcall', name, args, kwargs))
1718
return self._pipe.recv()[1]
1722
def __setattr__(self, name, value):
1724
return super(ProxyClient, self).__setattr__(name, value)
1725
self._pipe.send(('setattr', name, value))
1728
class ClientHandler(socketserver.BaseRequestHandler, object):
1729
"""A class to handle client connections.
1731
Instantiated once for each connection to handle it.
421
1732
Note: This will run in its own forked process."""
423
1734
def handle(self):
424
logger.info(u"TCP connection from: %s",
425
unicode(self.client_address))
426
session = gnutls.connection.ClientSession\
427
(self.request, gnutls.connection.X509Credentials())
429
line = self.request.makefile().readline()
430
logger.debug(u"Protocol version: %r", line)
432
if int(line.strip().split()[0]) > 1:
434
except (ValueError, IndexError, RuntimeError), error:
435
logger.error(u"Unknown protocol version: %s", error)
438
# Note: gnutls.connection.X509Credentials is really a generic
439
# GnuTLS certificate credentials object so long as no X.509
440
# keys are added to it. Therefore, we can use it here despite
441
# using OpenPGP certificates.
443
#priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
444
# "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
446
priority = "NORMAL" # Fallback default, since this
448
if self.server.settings["priority"]:
449
priority = self.server.settings["priority"]
450
gnutls.library.functions.gnutls_priority_set_direct\
451
(session._c_object, priority, None);
455
except gnutls.errors.GNUTLSError, error:
456
logger.warning(u"Handshake failed: %s", error)
457
# Do not run session.bye() here: the session is not
458
# established. Just abandon the request.
461
fpr = fingerprint(peer_certificate(session))
462
except (TypeError, gnutls.errors.GNUTLSError), error:
463
logger.warning(u"Bad certificate: %s", error)
466
logger.debug(u"Fingerprint: %s", fpr)
468
for c in self.server.clients:
469
if c.fingerprint == fpr:
473
logger.warning(u"Client not found for fingerprint: %s",
477
# Have to check if client.still_valid(), since it is possible
478
# that the client timed out while establishing the GnuTLS
480
if not client.still_valid():
481
logger.warning(u"Client %(name)s is invalid",
486
while sent_size < len(client.secret):
487
sent = session.send(client.secret[sent_size:])
488
logger.debug(u"Sent: %d, remaining: %d",
489
sent, len(client.secret)
490
- (sent_size + sent))
495
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
496
"""IPv6 TCP server. Accepts 'None' as address and/or port.
1735
with contextlib.closing(self.server.child_pipe) as child_pipe:
1736
logger.info("TCP connection from: %s",
1737
str(self.client_address))
1738
logger.debug("Pipe FD: %d",
1739
self.server.child_pipe.fileno())
1741
session = gnutls.connection.ClientSession(
1742
self.request, gnutls.connection .X509Credentials())
1744
# Note: gnutls.connection.X509Credentials is really a
1745
# generic GnuTLS certificate credentials object so long as
1746
# no X.509 keys are added to it. Therefore, we can use it
1747
# here despite using OpenPGP certificates.
1749
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1750
# "+AES-256-CBC", "+SHA1",
1751
# "+COMP-NULL", "+CTYPE-OPENPGP",
1753
# Use a fallback default, since this MUST be set.
1754
priority = self.server.gnutls_priority
1755
if priority is None:
1757
gnutls.library.functions.gnutls_priority_set_direct(
1758
session._c_object, priority, None)
1760
# Start communication using the Mandos protocol
1761
# Get protocol number
1762
line = self.request.makefile().readline()
1763
logger.debug("Protocol version: %r", line)
1765
if int(line.strip().split()[0]) > 1:
1766
raise RuntimeError(line)
1767
except (ValueError, IndexError, RuntimeError) as error:
1768
logger.error("Unknown protocol version: %s", error)
1771
# Start GnuTLS connection
1774
except gnutls.errors.GNUTLSError as error:
1775
logger.warning("Handshake failed: %s", error)
1776
# Do not run session.bye() here: the session is not
1777
# established. Just abandon the request.
1779
logger.debug("Handshake succeeded")
1781
approval_required = False
1784
fpr = self.fingerprint(
1785
self.peer_certificate(session))
1787
gnutls.errors.GNUTLSError) as error:
1788
logger.warning("Bad certificate: %s", error)
1790
logger.debug("Fingerprint: %s", fpr)
1793
client = ProxyClient(child_pipe, fpr,
1794
self.client_address)
1798
if client.approval_delay:
1799
delay = client.approval_delay
1800
client.approvals_pending += 1
1801
approval_required = True
1804
if not client.enabled:
1805
logger.info("Client %s is disabled",
1807
if self.server.use_dbus:
1809
client.Rejected("Disabled")
1812
if client.approved or not client.approval_delay:
1813
#We are approved or approval is disabled
1815
elif client.approved is None:
1816
logger.info("Client %s needs approval",
1818
if self.server.use_dbus:
1820
client.NeedApproval(
1821
client.approval_delay.total_seconds()
1822
* 1000, client.approved_by_default)
1824
logger.warning("Client %s was not approved",
1826
if self.server.use_dbus:
1828
client.Rejected("Denied")
1831
#wait until timeout or approved
1832
time = datetime.datetime.now()
1833
client.changedstate.acquire()
1834
client.changedstate.wait(delay.total_seconds())
1835
client.changedstate.release()
1836
time2 = datetime.datetime.now()
1837
if (time2 - time) >= delay:
1838
if not client.approved_by_default:
1839
logger.warning("Client %s timed out while"
1840
" waiting for approval",
1842
if self.server.use_dbus:
1844
client.Rejected("Approval timed out")
1849
delay -= time2 - time
1852
while sent_size < len(client.secret):
1854
sent = session.send(client.secret[sent_size:])
1855
except gnutls.errors.GNUTLSError as error:
1856
logger.warning("gnutls send failed",
1859
logger.debug("Sent: %d, remaining: %d", sent,
1860
len(client.secret) - (sent_size
1864
logger.info("Sending secret to %s", client.name)
1865
# bump the timeout using extended_timeout
1866
client.bump_timeout(client.extended_timeout)
1867
if self.server.use_dbus:
1872
if approval_required:
1873
client.approvals_pending -= 1
1876
except gnutls.errors.GNUTLSError as error:
1877
logger.warning("GnuTLS bye failed",
1881
def peer_certificate(session):
1882
"Return the peer's OpenPGP certificate as a bytestring"
1883
# If not an OpenPGP certificate...
1884
if (gnutls.library.functions.gnutls_certificate_type_get(
1886
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1887
# ...do the normal thing
1888
return session.peer_certificate
1889
list_size = ctypes.c_uint(1)
1890
cert_list = (gnutls.library.functions
1891
.gnutls_certificate_get_peers
1892
(session._c_object, ctypes.byref(list_size)))
1893
if not bool(cert_list) and list_size.value != 0:
1894
raise gnutls.errors.GNUTLSError("error getting peer"
1896
if list_size.value == 0:
1899
return ctypes.string_at(cert.data, cert.size)
1902
def fingerprint(openpgp):
1903
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1904
# New GnuTLS "datum" with the OpenPGP public key
1905
datum = gnutls.library.types.gnutls_datum_t(
1906
ctypes.cast(ctypes.c_char_p(openpgp),
1907
ctypes.POINTER(ctypes.c_ubyte)),
1908
ctypes.c_uint(len(openpgp)))
1909
# New empty GnuTLS certificate
1910
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1911
gnutls.library.functions.gnutls_openpgp_crt_init(
1913
# Import the OpenPGP public key into the certificate
1914
gnutls.library.functions.gnutls_openpgp_crt_import(
1915
crt, ctypes.byref(datum),
1916
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
1917
# Verify the self signature in the key
1918
crtverify = ctypes.c_uint()
1919
gnutls.library.functions.gnutls_openpgp_crt_verify_self(
1920
crt, 0, ctypes.byref(crtverify))
1921
if crtverify.value != 0:
1922
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1923
raise gnutls.errors.CertificateSecurityError(
1925
# New buffer for the fingerprint
1926
buf = ctypes.create_string_buffer(20)
1927
buf_len = ctypes.c_size_t()
1928
# Get the fingerprint from the certificate into the buffer
1929
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
1930
crt, ctypes.byref(buf), ctypes.byref(buf_len))
1931
# Deinit the certificate
1932
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1933
# Convert the buffer to a Python bytestring
1934
fpr = ctypes.string_at(buf, buf_len.value)
1935
# Convert the bytestring to hexadecimal notation
1936
hex_fpr = binascii.hexlify(fpr).upper()
1940
class MultiprocessingMixIn(object):
1941
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1943
def sub_process_main(self, request, address):
1945
self.finish_request(request, address)
1947
self.handle_error(request, address)
1948
self.close_request(request)
1950
def process_request(self, request, address):
1951
"""Start a new process to process the request."""
1952
proc = multiprocessing.Process(target = self.sub_process_main,
1953
args = (request, address))
1958
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1959
""" adds a pipe to the MixIn """
1961
def process_request(self, request, client_address):
1962
"""Overrides and wraps the original process_request().
1964
This function creates a new pipe in self.pipe
1966
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1968
proc = MultiprocessingMixIn.process_request(self, request,
1970
self.child_pipe.close()
1971
self.add_pipe(parent_pipe, proc)
1973
def add_pipe(self, parent_pipe, proc):
1974
"""Dummy function; override as necessary"""
1975
raise NotImplementedError()
1978
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1979
socketserver.TCPServer, object):
1980
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
498
settings: Server settings
499
clients: Set() of Client objects
1983
enabled: Boolean; whether this server is activated yet
1984
interface: None or a network interface name (string)
1985
use_ipv6: Boolean; to use IPv6 or not
501
address_family = socket.AF_INET6
502
def __init__(self, *args, **kwargs):
503
if "settings" in kwargs:
504
self.settings = kwargs["settings"]
505
del kwargs["settings"]
506
if "clients" in kwargs:
507
self.clients = kwargs["clients"]
508
del kwargs["clients"]
509
return super(type(self), self).__init__(*args, **kwargs)
1988
def __init__(self, server_address, RequestHandlerClass,
1992
"""If socketfd is set, use that file descriptor instead of
1993
creating a new one with socket.socket().
1995
self.interface = interface
1997
self.address_family = socket.AF_INET6
1998
if socketfd is not None:
1999
# Save the file descriptor
2000
self.socketfd = socketfd
2001
# Save the original socket.socket() function
2002
self.socket_socket = socket.socket
2003
# To implement --socket, we monkey patch socket.socket.
2005
# (When socketserver.TCPServer is a new-style class, we
2006
# could make self.socket into a property instead of monkey
2007
# patching socket.socket.)
2009
# Create a one-time-only replacement for socket.socket()
2010
@functools.wraps(socket.socket)
2011
def socket_wrapper(*args, **kwargs):
2012
# Restore original function so subsequent calls are
2014
socket.socket = self.socket_socket
2015
del self.socket_socket
2016
# This time only, return a new socket object from the
2017
# saved file descriptor.
2018
return socket.fromfd(self.socketfd, *args, **kwargs)
2019
# Replace socket.socket() function with wrapper
2020
socket.socket = socket_wrapper
2021
# The socketserver.TCPServer.__init__ will call
2022
# socket.socket(), which might be our replacement,
2023
# socket_wrapper(), if socketfd was set.
2024
socketserver.TCPServer.__init__(self, server_address,
2025
RequestHandlerClass)
510
2027
def server_bind(self):
511
2028
"""This overrides the normal server_bind() function
512
2029
to bind to an interface if one was specified, and also NOT to
513
2030
bind to an address or port if they were not specified."""
514
if self.settings["interface"]:
515
# 25 is from /usr/include/asm-i486/socket.h
516
SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
518
self.socket.setsockopt(socket.SOL_SOCKET,
520
self.settings["interface"])
521
except socket.error, error:
522
if error[0] == errno.EPERM:
523
logger.error(u"No permission to"
524
u" bind to interface %s",
525
self.settings["interface"])
2031
if self.interface is not None:
2032
if SO_BINDTODEVICE is None:
2033
logger.error("SO_BINDTODEVICE does not exist;"
2034
" cannot bind to interface %s",
2038
self.socket.setsockopt(
2039
socket.SOL_SOCKET, SO_BINDTODEVICE,
2040
(self.interface + "\0").encode("utf-8"))
2041
except socket.error as error:
2042
if error.errno == errno.EPERM:
2043
logger.error("No permission to bind to"
2044
" interface %s", self.interface)
2045
elif error.errno == errno.ENOPROTOOPT:
2046
logger.error("SO_BINDTODEVICE not available;"
2047
" cannot bind to interface %s",
2049
elif error.errno == errno.ENODEV:
2050
logger.error("Interface %s does not exist,"
2051
" cannot bind", self.interface)
528
2054
# Only bind(2) the socket if we really need to.
529
2055
if self.server_address[0] or self.server_address[1]:
530
2056
if not self.server_address[0]:
532
self.server_address = (in6addr_any,
2057
if self.address_family == socket.AF_INET6:
2058
any_address = "::" # in6addr_any
2060
any_address = "0.0.0.0" # INADDR_ANY
2061
self.server_address = (any_address,
533
2062
self.server_address[1])
534
2063
elif not self.server_address[1]:
535
self.server_address = (self.server_address[0],
537
# if self.settings["interface"]:
2064
self.server_address = (self.server_address[0], 0)
2065
# if self.interface:
538
2066
# self.server_address = (self.server_address[0],
541
2069
# if_nametoindex
544
return super(type(self), self).server_bind()
2071
return socketserver.TCPServer.server_bind(self)
2074
class MandosServer(IPv6_TCPServer):
2078
clients: set of Client objects
2079
gnutls_priority GnuTLS priority string
2080
use_dbus: Boolean; to emit D-Bus signals or not
2082
Assumes a gobject.MainLoop event loop.
2085
def __init__(self, server_address, RequestHandlerClass,
2089
gnutls_priority=None,
2092
self.enabled = False
2093
self.clients = clients
2094
if self.clients is None:
2096
self.use_dbus = use_dbus
2097
self.gnutls_priority = gnutls_priority
2098
IPv6_TCPServer.__init__(self, server_address,
2099
RequestHandlerClass,
2100
interface = interface,
2101
use_ipv6 = use_ipv6,
2102
socketfd = socketfd)
2104
def server_activate(self):
2106
return socketserver.TCPServer.server_activate(self)
2111
def add_pipe(self, parent_pipe, proc):
2112
# Call "handle_ipc" for both data and EOF events
2113
gobject.io_add_watch(
2114
parent_pipe.fileno(),
2115
gobject.IO_IN | gobject.IO_HUP,
2116
functools.partial(self.handle_ipc,
2117
parent_pipe = parent_pipe,
2120
def handle_ipc(self, source, condition,
2123
client_object=None):
2124
# error, or the other end of multiprocessing.Pipe has closed
2125
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2126
# Wait for other process to exit
2130
# Read a request from the child
2131
request = parent_pipe.recv()
2132
command = request[0]
2134
if command == 'init':
2136
address = request[2]
2138
for c in self.clients.itervalues():
2139
if c.fingerprint == fpr:
2143
logger.info("Client not found for fingerprint: %s, ad"
2144
"dress: %s", fpr, address)
2147
mandos_dbus_service.ClientNotFound(fpr,
2149
parent_pipe.send(False)
2152
gobject.io_add_watch(
2153
parent_pipe.fileno(),
2154
gobject.IO_IN | gobject.IO_HUP,
2155
functools.partial(self.handle_ipc,
2156
parent_pipe = parent_pipe,
2158
client_object = client))
2159
parent_pipe.send(True)
2160
# remove the old hook in favor of the new above hook on
2163
if command == 'funcall':
2164
funcname = request[1]
2168
parent_pipe.send(('data', getattr(client_object,
2172
if command == 'getattr':
2173
attrname = request[1]
2174
if isinstance(client_object.__getattribute__(attrname),
2175
collections.Callable):
2176
parent_pipe.send(('function', ))
2179
'data', client_object.__getattribute__(attrname)))
2181
if command == 'setattr':
2182
attrname = request[1]
2184
setattr(client_object, attrname, value)
2189
def rfc3339_duration_to_delta(duration):
2190
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2192
>>> rfc3339_duration_to_delta("P7D")
2193
datetime.timedelta(7)
2194
>>> rfc3339_duration_to_delta("PT60S")
2195
datetime.timedelta(0, 60)
2196
>>> rfc3339_duration_to_delta("PT60M")
2197
datetime.timedelta(0, 3600)
2198
>>> rfc3339_duration_to_delta("PT24H")
2199
datetime.timedelta(1)
2200
>>> rfc3339_duration_to_delta("P1W")
2201
datetime.timedelta(7)
2202
>>> rfc3339_duration_to_delta("PT5M30S")
2203
datetime.timedelta(0, 330)
2204
>>> rfc3339_duration_to_delta("P1DT3M20S")
2205
datetime.timedelta(1, 200)
2208
# Parsing an RFC 3339 duration with regular expressions is not
2209
# possible - there would have to be multiple places for the same
2210
# values, like seconds. The current code, while more esoteric, is
2211
# cleaner without depending on a parsing library. If Python had a
2212
# built-in library for parsing we would use it, but we'd like to
2213
# avoid excessive use of external libraries.
2215
# New type for defining tokens, syntax, and semantics all-in-one
2216
Token = collections.namedtuple("Token", (
2217
"regexp", # To match token; if "value" is not None, must have
2218
# a "group" containing digits
2219
"value", # datetime.timedelta or None
2220
"followers")) # Tokens valid after this token
2221
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2222
# the "duration" ABNF definition in RFC 3339, Appendix A.
2223
token_end = Token(re.compile(r"$"), None, frozenset())
2224
token_second = Token(re.compile(r"(\d+)S"),
2225
datetime.timedelta(seconds=1),
2226
frozenset((token_end, )))
2227
token_minute = Token(re.compile(r"(\d+)M"),
2228
datetime.timedelta(minutes=1),
2229
frozenset((token_second, token_end)))
2230
token_hour = Token(re.compile(r"(\d+)H"),
2231
datetime.timedelta(hours=1),
2232
frozenset((token_minute, token_end)))
2233
token_time = Token(re.compile(r"T"),
2235
frozenset((token_hour, token_minute,
2237
token_day = Token(re.compile(r"(\d+)D"),
2238
datetime.timedelta(days=1),
2239
frozenset((token_time, token_end)))
2240
token_month = Token(re.compile(r"(\d+)M"),
2241
datetime.timedelta(weeks=4),
2242
frozenset((token_day, token_end)))
2243
token_year = Token(re.compile(r"(\d+)Y"),
2244
datetime.timedelta(weeks=52),
2245
frozenset((token_month, token_end)))
2246
token_week = Token(re.compile(r"(\d+)W"),
2247
datetime.timedelta(weeks=1),
2248
frozenset((token_end, )))
2249
token_duration = Token(re.compile(r"P"), None,
2250
frozenset((token_year, token_month,
2251
token_day, token_time,
2253
# Define starting values
2254
value = datetime.timedelta() # Value so far
2256
followers = frozenset((token_duration, )) # Following valid tokens
2257
s = duration # String left to parse
2258
# Loop until end token is found
2259
while found_token is not token_end:
2260
# Search for any currently valid tokens
2261
for token in followers:
2262
match = token.regexp.match(s)
2263
if match is not None:
2265
if token.value is not None:
2266
# Value found, parse digits
2267
factor = int(match.group(1), 10)
2268
# Add to value so far
2269
value += factor * token.value
2270
# Strip token from string
2271
s = token.regexp.sub("", s, 1)
2274
# Set valid next tokens
2275
followers = found_token.followers
2278
# No currently valid tokens were found
2279
raise ValueError("Invalid RFC 3339 duration: {!r}"
547
2285
def string_to_delta(interval):
548
2286
"""Parse a string and return a datetime.timedelta
550
2288
>>> string_to_delta('7d')
551
2289
datetime.timedelta(7)
552
2290
>>> string_to_delta('60s')
687
2416
"debug": "False",
689
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2418
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2419
":+SIGN-DSA-SHA256",
690
2420
"servicename": "Mandos",
2426
"statedir": "/var/lib/mandos",
2427
"foreground": "False",
693
2431
# Parse config file for server-global settings
694
server_config = ConfigParser.SafeConfigParser(server_defaults)
2432
server_config = configparser.SafeConfigParser(server_defaults)
695
2433
del server_defaults
696
2434
server_config.read(os.path.join(options.configdir, "mandos.conf"))
697
server_section = "server"
698
2435
# Convert the SafeConfigParser object to a dict
699
server_settings = dict(server_config.items(server_section))
700
# Use getboolean on the boolean config option
701
server_settings["debug"] = server_config.getboolean\
702
(server_section, "debug")
2436
server_settings = server_config.defaults()
2437
# Use the appropriate methods on the non-string config options
2438
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2439
server_settings[option] = server_config.getboolean("DEFAULT",
2441
if server_settings["port"]:
2442
server_settings["port"] = server_config.getint("DEFAULT",
2444
if server_settings["socket"]:
2445
server_settings["socket"] = server_config.getint("DEFAULT",
2447
# Later, stdin will, and stdout and stderr might, be dup'ed
2448
# over with an opened os.devnull. But we don't want this to
2449
# happen with a supplied network socket.
2450
if 0 <= server_settings["socket"] <= 2:
2451
server_settings["socket"] = os.dup(server_settings
703
2453
del server_config
705
2455
# Override the settings from the config file with command line
706
2456
# options, if set.
707
2457
for option in ("interface", "address", "port", "debug",
708
"priority", "servicename", "configdir"):
2458
"priority", "servicename", "configdir", "use_dbus",
2459
"use_ipv6", "debuglevel", "restore", "statedir",
2460
"socket", "foreground", "zeroconf"):
709
2461
value = getattr(options, option)
710
2462
if value is not None:
711
2463
server_settings[option] = value
2465
# Force all strings to be unicode
2466
for option in server_settings.keys():
2467
if isinstance(server_settings[option], bytes):
2468
server_settings[option] = (server_settings[option]
2470
# Force all boolean options to be boolean
2471
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2472
"foreground", "zeroconf"):
2473
server_settings[option] = bool(server_settings[option])
2474
# Debug implies foreground
2475
if server_settings["debug"]:
2476
server_settings["foreground"] = True
713
2477
# Now we have our good server settings in "server_settings"
2479
##################################################################
2481
if (not server_settings["zeroconf"]
2482
and not (server_settings["port"]
2483
or server_settings["socket"] != "")):
2484
parser.error("Needs port or socket to work without Zeroconf")
715
2487
debug = server_settings["debug"]
2488
debuglevel = server_settings["debuglevel"]
2489
use_dbus = server_settings["use_dbus"]
2490
use_ipv6 = server_settings["use_ipv6"]
2491
stored_state_path = os.path.join(server_settings["statedir"],
2493
foreground = server_settings["foreground"]
2494
zeroconf = server_settings["zeroconf"]
718
syslogger.setLevel(logging.WARNING)
2497
initlogger(debug, logging.DEBUG)
2502
level = getattr(logging, debuglevel.upper())
2503
initlogger(debug, level)
720
2505
if server_settings["servicename"] != "Mandos":
721
syslogger.setFormatter(logging.Formatter\
722
('Mandos (%s): %%(levelname)s:'
724
% server_settings["servicename"]))
2506
syslogger.setFormatter(
2507
logging.Formatter('Mandos ({}) [%(process)d]:'
2508
' %(levelname)s: %(message)s'.format(
2509
server_settings["servicename"])))
726
2511
# Parse config file with clients
727
client_defaults = { "timeout": "1h",
729
"checker": "fping -q -- %%(host)s",
731
client_config = ConfigParser.SafeConfigParser(client_defaults)
2512
client_config = configparser.SafeConfigParser(Client
732
2514
client_config.read(os.path.join(server_settings["configdir"],
733
2515
"clients.conf"))
736
service = AvahiService(name = server_settings["servicename"],
737
type = "_mandos._tcp", );
738
if server_settings["interface"]:
739
service.interface = if_nametoindex(server_settings["interface"])
2517
global mandos_dbus_service
2518
mandos_dbus_service = None
2521
if server_settings["socket"] != "":
2522
socketfd = server_settings["socket"]
2523
tcp_server = MandosServer(
2524
(server_settings["address"], server_settings["port"]),
2526
interface=(server_settings["interface"] or None),
2528
gnutls_priority=server_settings["priority"],
2532
pidfilename = "/run/mandos.pid"
2533
if not os.path.isdir("/run/."):
2534
pidfilename = "/var/run/mandos.pid"
2537
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2538
except IOError as e:
2539
logger.error("Could not open file %r", pidfilename,
2542
for name in ("_mandos", "mandos", "nobody"):
2544
uid = pwd.getpwnam(name).pw_uid
2545
gid = pwd.getpwnam(name).pw_gid
2555
except OSError as error:
2556
if error.errno != errno.EPERM:
2560
# Enable all possible GnuTLS debugging
2562
# "Use a log level over 10 to enable all debugging options."
2564
gnutls.library.functions.gnutls_global_set_log_level(11)
2566
@gnutls.library.types.gnutls_log_func
2567
def debug_gnutls(level, string):
2568
logger.debug("GnuTLS: %s", string[:-1])
2570
gnutls.library.functions.gnutls_global_set_log_function(
2573
# Redirect stdin so all checkers get /dev/null
2574
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2575
os.dup2(null, sys.stdin.fileno())
2579
# Need to fork before connecting to D-Bus
2581
# Close all input and output, do double fork, etc.
2584
# multiprocessing will use threads, so before we use gobject we
2585
# need to inform gobject that threads will be used.
2586
gobject.threads_init()
741
2588
global main_loop
744
2589
# From the Avahi example code
745
DBusGMainLoop(set_as_default=True )
2590
DBusGMainLoop(set_as_default=True)
746
2591
main_loop = gobject.MainLoop()
747
2592
bus = dbus.SystemBus()
748
server = dbus.Interface(
749
bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
750
avahi.DBUS_INTERFACE_SERVER )
751
2593
# End of Avahi example code
754
console = logging.StreamHandler()
755
# console.setLevel(logging.DEBUG)
756
console.setFormatter(logging.Formatter\
757
('%(levelname)s: %(message)s'))
758
logger.addHandler(console)
762
def remove_from_clients(client):
763
clients.remove(client)
765
logger.critical(u"No clients left, exiting")
768
clients.update(Set(Client(name = section,
769
stop_hook = remove_from_clients,
771
= dict(client_config.items(section)))
772
for section in client_config.sections()))
774
logger.critical(u"No clients defined")
780
pidfilename = "/var/run/mandos/mandos.pid"
783
pidfile = open(pidfilename, "w")
784
pidfile.write(str(pid) + "\n")
2596
bus_name = dbus.service.BusName("se.recompile.Mandos",
2599
old_bus_name = dbus.service.BusName(
2600
"se.bsnet.fukt.Mandos", bus,
2602
except dbus.exceptions.DBusException as e:
2603
logger.error("Disabling D-Bus:", exc_info=e)
2605
server_settings["use_dbus"] = False
2606
tcp_server.use_dbus = False
2608
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2609
service = AvahiServiceToSyslog(
2610
name = server_settings["servicename"],
2611
servicetype = "_mandos._tcp",
2612
protocol = protocol,
2614
if server_settings["interface"]:
2615
service.interface = if_nametoindex(
2616
server_settings["interface"].encode("utf-8"))
2618
global multiprocessing_manager
2619
multiprocessing_manager = multiprocessing.Manager()
2621
client_class = Client
2623
client_class = functools.partial(ClientDBus, bus = bus)
2625
client_settings = Client.config_parser(client_config)
2626
old_client_settings = {}
2629
# This is used to redirect stdout and stderr for checker processes
2631
wnull = open(os.devnull, "w") # A writable /dev/null
2632
# Only used if server is running in foreground but not in debug
2634
if debug or not foreground:
2637
# Get client data and settings from last running state.
2638
if server_settings["restore"]:
2640
with open(stored_state_path, "rb") as stored_state:
2641
clients_data, old_client_settings = pickle.load(
2643
os.remove(stored_state_path)
2644
except IOError as e:
2645
if e.errno == errno.ENOENT:
2646
logger.warning("Could not load persistent state:"
2647
" {}".format(os.strerror(e.errno)))
2649
logger.critical("Could not load persistent state:",
2652
except EOFError as e:
2653
logger.warning("Could not load persistent state: "
2657
with PGPEngine() as pgp:
2658
for client_name, client in clients_data.items():
2659
# Skip removed clients
2660
if client_name not in client_settings:
2663
# Decide which value to use after restoring saved state.
2664
# We have three different values: Old config file,
2665
# new config file, and saved state.
2666
# New config value takes precedence if it differs from old
2667
# config value, otherwise use saved state.
2668
for name, value in client_settings[client_name].items():
2670
# For each value in new config, check if it
2671
# differs from the old config value (Except for
2672
# the "secret" attribute)
2673
if (name != "secret"
2675
old_client_settings[client_name][name])):
2676
client[name] = value
2680
# Clients who has passed its expire date can still be
2681
# enabled if its last checker was successful. A Client
2682
# whose checker succeeded before we stored its state is
2683
# assumed to have successfully run all checkers during
2685
if client["enabled"]:
2686
if datetime.datetime.utcnow() >= client["expires"]:
2687
if not client["last_checked_ok"]:
2689
"disabling client {} - Client never "
2690
"performed a successful checker".format(
2692
client["enabled"] = False
2693
elif client["last_checker_status"] != 0:
2695
"disabling client {} - Client last"
2696
" checker failed with error code"
2699
client["last_checker_status"]))
2700
client["enabled"] = False
2702
client["expires"] = (
2703
datetime.datetime.utcnow()
2704
+ client["timeout"])
2705
logger.debug("Last checker succeeded,"
2706
" keeping {} enabled".format(
2709
client["secret"] = pgp.decrypt(
2710
client["encrypted_secret"],
2711
client_settings[client_name]["secret"])
2713
# If decryption fails, we use secret from new settings
2714
logger.debug("Failed to decrypt {} old secret".format(
2716
client["secret"] = (client_settings[client_name]
2719
# Add/remove clients based on new changes made to config
2720
for client_name in (set(old_client_settings)
2721
- set(client_settings)):
2722
del clients_data[client_name]
2723
for client_name in (set(client_settings)
2724
- set(old_client_settings)):
2725
clients_data[client_name] = client_settings[client_name]
2727
# Create all client objects
2728
for client_name, client in clients_data.items():
2729
tcp_server.clients[client_name] = client_class(
2732
server_settings = server_settings)
2734
if not tcp_server.clients:
2735
logger.warning("No clients defined")
2738
if pidfile is not None:
2742
print(pid, file=pidfile)
2744
logger.error("Could not write to file %r with PID %d",
788
logger.error(u"Could not write %s file with PID %d",
789
pidfilename, os.getpid())
2749
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2750
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2754
@alternate_dbus_interfaces(
2755
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
2756
class MandosDBusService(DBusObjectWithProperties):
2757
"""A D-Bus proxy object"""
2760
dbus.service.Object.__init__(self, bus, "/")
2762
_interface = "se.recompile.Mandos"
2764
@dbus_interface_annotations(_interface)
2767
"org.freedesktop.DBus.Property.EmitsChangedSignal":
2770
@dbus.service.signal(_interface, signature="o")
2771
def ClientAdded(self, objpath):
2775
@dbus.service.signal(_interface, signature="ss")
2776
def ClientNotFound(self, fingerprint, address):
2780
@dbus.service.signal(_interface, signature="os")
2781
def ClientRemoved(self, objpath, name):
2785
@dbus.service.method(_interface, out_signature="ao")
2786
def GetAllClients(self):
2788
return dbus.Array(c.dbus_object_path for c in
2789
tcp_server.clients.itervalues())
2791
@dbus.service.method(_interface,
2792
out_signature="a{oa{sv}}")
2793
def GetAllClientsWithProperties(self):
2795
return dbus.Dictionary(
2796
{ c.dbus_object_path: c.GetAll("")
2797
for c in tcp_server.clients.itervalues() },
2800
@dbus.service.method(_interface, in_signature="o")
2801
def RemoveClient(self, object_path):
2803
for c in tcp_server.clients.itervalues():
2804
if c.dbus_object_path == object_path:
2805
del tcp_server.clients[c.name]
2806
c.remove_from_connection()
2807
# Don't signal anything except ClientRemoved
2808
c.disable(quiet=True)
2810
self.ClientRemoved(object_path, c.name)
2812
raise KeyError(object_path)
2816
mandos_dbus_service = MandosDBusService()
792
2819
"Cleanup function; run on exit"
794
# From the Avahi example code
795
if not group is None:
798
# End of Avahi example code
801
client = clients.pop()
802
client.stop_hook = None
2823
multiprocessing.active_children()
2825
if not (tcp_server.clients or client_settings):
2828
# Store client before exiting. Secrets are encrypted with key
2829
# based on what config file has. If config file is
2830
# removed/edited, old secret will thus be unrecovable.
2832
with PGPEngine() as pgp:
2833
for client in tcp_server.clients.itervalues():
2834
key = client_settings[client.name]["secret"]
2835
client.encrypted_secret = pgp.encrypt(client.secret,
2839
# A list of attributes that can not be pickled
2841
exclude = { "bus", "changedstate", "secret",
2842
"checker", "server_settings" }
2843
for name, typ in inspect.getmembers(dbus.service
2847
client_dict["encrypted_secret"] = (client
2849
for attr in client.client_structure:
2850
if attr not in exclude:
2851
client_dict[attr] = getattr(client, attr)
2853
clients[client.name] = client_dict
2854
del client_settings[client.name]["secret"]
2857
with tempfile.NamedTemporaryFile(
2861
dir=os.path.dirname(stored_state_path),
2862
delete=False) as stored_state:
2863
pickle.dump((clients, client_settings), stored_state)
2864
tempname = stored_state.name
2865
os.rename(tempname, stored_state_path)
2866
except (IOError, OSError) as e:
2872
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2873
logger.warning("Could not save persistent state: {}"
2874
.format(os.strerror(e.errno)))
2876
logger.warning("Could not save persistent state:",
2880
# Delete all clients, and settings from config
2881
while tcp_server.clients:
2882
name, client = tcp_server.clients.popitem()
2884
client.remove_from_connection()
2885
# Don't signal anything except ClientRemoved
2886
client.disable(quiet=True)
2889
mandos_dbus_service.ClientRemoved(
2890
client.dbus_object_path, client.name)
2891
client_settings.clear()
805
2893
atexit.register(cleanup)
808
signal.signal(signal.SIGINT, signal.SIG_IGN)
809
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
810
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
812
for client in clients:
815
tcp_server = IPv6_TCPServer((server_settings["address"],
816
server_settings["port"]),
818
settings=server_settings,
2895
for client in tcp_server.clients.itervalues():
2898
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2899
# Need to initiate checking of clients
2901
client.init_checker()
2904
tcp_server.server_activate()
820
2906
# Find out what port we got
821
service.port = tcp_server.socket.getsockname()[1]
822
logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
823
u" scope_id %d" % tcp_server.socket.getsockname())
2908
service.port = tcp_server.socket.getsockname()[1]
2910
logger.info("Now listening on address %r, port %d,"
2911
" flowinfo %d, scope_id %d",
2912
*tcp_server.socket.getsockname())
2914
logger.info("Now listening on address %r, port %d",
2915
*tcp_server.socket.getsockname())
825
2917
#service.interface = tcp_server.socket.getsockname()[3]
828
# From the Avahi example code
829
server.connect_to_signal("StateChanged", server_state_changed)
831
server_state_changed(server.GetState())
832
except dbus.exceptions.DBusException, error:
833
logger.critical(u"DBusException: %s", error)
835
# End of Avahi example code
2921
# From the Avahi example code
2924
except dbus.exceptions.DBusException as error:
2925
logger.critical("D-Bus Exception", exc_info=error)
2928
# End of Avahi example code
837
2930
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
838
2931
lambda *args, **kwargs:
839
tcp_server.handle_request\
840
(*args[2:], **kwargs) or True)
2932
(tcp_server.handle_request
2933
(*args[2:], **kwargs) or True))
842
logger.debug(u"Starting main loop")
843
main_loop_started = True
2935
logger.debug("Starting main loop")
845
except AvahiError, error:
846
logger.critical(u"AvahiError: %s" + unicode(error))
2937
except AvahiError as error:
2938
logger.critical("Avahi Error", exc_info=error)
848
2941
except KeyboardInterrupt:
2943
print("", file=sys.stderr)
2944
logger.debug("Server received KeyboardInterrupt")
2945
logger.debug("Server exiting")
2946
# Must run before the D-Bus bus name gets deregistered
852
2950
if __name__ == '__main__':